aws-cdk-lib.aws_rds.CfnIntegrationProps

CfnIntegrationProps Struct

Properties for defining a CfnIntegration.

Source

Generated code

Type last changed

v2.135.0 · 2 Apr 2024

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_rds as rds } from 'aws-cdk-lib';
const cfnIntegrationProps: rds.CfnIntegrationProps = {
  sourceArn: 'sourceArn',
  targetArn: 'targetArn',

  // the properties below are optional
  additionalEncryptionContext: {
    additionalEncryptionContextKey: 'additionalEncryptionContext',
  },
  dataFilter: 'dataFilter',
  description: 'description',
  integrationName: 'integrationName',
  kmsKeyId: 'kmsKeyId',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

additionalEncryptionContextIResolvable | { [key: string]: string }additional_encryption_contexttyping.Union[IResolvable, typing.Mapping[str, str]]additionalEncryptionContextIResolvableAdditionalEncryptionContextIResolvableAdditionalEncryptionContextinterface{}#

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

notes

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.

dataFilterstringdata_filterstrdataFilterStringDataFilterstringDataFilter*string#

Data filters for the integration.

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

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#

A description of the integration.

integrationNamestringintegration_namestrintegrationNameStringIntegrationNamestringIntegrationName*string#

The name of the integration.

kmsKeyIdstringkms_key_idstrkmsKeyIdStringKmsKeyIdstringKmsKeyId*string#

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.

sourceArnstringsource_arnstrsourceArnStringSourceArnstringSourceArn*stringrequired#

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

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#

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

targetArnstringtarget_arnstrtargetArnStringTargetArnstringTargetArn*stringrequired#

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

Used as props by

• CfnIntegration