CfnIntegrationProps

class aws_cdk.aws_rds.CfnIntegrationProps(*, source_arn, target_arn, additional_encryption_context=None, data_filter=None, description=None, integration_name=None, kms_key_id=None, tags=None)

Bases: object

Properties for defining a CfnIntegration.

Parameters:
  • source_arn (str) – The Amazon Resource Name (ARN) of the database to use as the source for replication.

  • target_arn (str) – The ARN of the Redshift data warehouse to use as the target for replication.

  • additional_encryption_context (Union[IResolvable, Mapping[str, str], None]) – 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.

  • data_filter (Optional[str]) – Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse.

  • description (Optional[str]) – A description of the integration.

  • integration_name (Optional[str]) – The name of the integration.

  • kms_key_id (Optional[str]) – 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.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An optional array of key-value pairs to apply to this integration.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_rds as rds

cfn_integration_props = rds.CfnIntegrationProps(
    source_arn="sourceArn",
    target_arn="targetArn",

    # the properties below are optional
    additional_encryption_context={
        "additional_encryption_context_key": "additionalEncryptionContext"
    },
    data_filter="dataFilter",
    description="description",
    integration_name="integrationName",
    kms_key_id="kmsKeyId",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

additional_encryption_context

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:

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

data_filter

Data filters for the integration.

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

See:

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

description

A description of the integration.

See:

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

integration_name

The name of the integration.

See:

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

kms_key_id

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:

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

source_arn

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

See:

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

tags

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

See:

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

target_arn

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

See:

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