Package software.amazon.awscdk.services.rds

Interface CfnIntegrationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIntegrationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:22.402Z")
@Stability(Stable)
public interface CfnIntegrationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnIntegration.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.rds.*;
 CfnIntegrationProps cfnIntegrationProps = CfnIntegrationProps.builder()
         .sourceArn("sourceArn")
         .targetArn("targetArn")
         // the properties below are optional
         .additionalEncryptionContext(Map.of(
                 "additionalEncryptionContextKey", "additionalEncryptionContext"))
         .dataFilter("dataFilter")
         .description("description")
         .integrationName("integrationName")
         .kmsKeyId("kmsKeyId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-integration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnIntegrationProps.Builder	A builder for CfnIntegrationProps
static final class	CfnIntegrationProps.Jsii$Proxy	An implementation for CfnIntegrationProps

Method Summary

Modifier and Type	Method	Description
static CfnIntegrationProps.Builder	builder()
default Object	getAdditionalEncryptionContext()	An optional set of non-secret key–value pairs that contains additional contextual information about the data.
default String	getDataFilter()	Data filters for the integration.
default String	getDescription()	A description of the integration.
default String	getIntegrationName()	The name of the integration.
default String	getKmsKeyId()	The AWS Key Management System ( AWS KMS) key identifier for the key to use to encrypt the integration.
String	getSourceArn()	The Amazon Resource Name (ARN) of the database to use as the source for replication.
default List<CfnTag>	getTags()	An optional array of key-value pairs to apply to this integration.
String	getTargetArn()	The ARN of the Redshift data warehouse to use as the target for replication.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSourceArn

@Stability(Stable)
@NotNull
String getSourceArn()

The Amazon Resource Name (ARN) of the database to use as the source for replication.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-integration.html#cfn-rds-integration-sourcearn

getTargetArn

@Stability(Stable)
@NotNull
String getTargetArn()

The ARN of the Redshift data warehouse to use as the target for replication.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-integration.html#cfn-rds-integration-targetarn

getAdditionalEncryptionContext

@Stability(Stable)
@Nullable
default Object getAdditionalEncryptionContext()

An optional set of non-secret key–value pairs that contains additional contextual information about the data.

For more information, see Encryption context in the AWS Key Management Service Developer Guide .

You can only include this parameter if you specify the KMSKeyId parameter.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-integration.html#cfn-rds-integration-additionalencryptioncontext

getDataFilter

@Stability(Stable)
@Nullable
default String getDataFilter()

Data filters for the integration.

These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-integration.html#cfn-rds-integration-datafilter

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the integration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-integration.html#cfn-rds-integration-description

getIntegrationName

@Stability(Stable)
@Nullable
default String getIntegrationName()

The name of the integration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-integration.html#cfn-rds-integration-integrationname

getKmsKeyId

@Stability(Stable)
@Nullable
default String getKmsKeyId()

The AWS Key Management System ( AWS KMS) key identifier for the key to use to encrypt the integration.

If you don't specify an encryption key, RDS uses a default AWS owned key.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-integration.html#cfn-rds-integration-kmskeyid

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An optional array of key-value pairs to apply to this integration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-integration.html#cfn-rds-integration-tags

builder

@Stability(Stable)
static CfnIntegrationProps.Builder builder()

Returns:

a CfnIntegrationProps.Builder of CfnIntegrationProps