interface CfnIntegrationProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.RDS.CfnIntegrationProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsrds#CfnIntegrationProps |
Java | software.amazon.awscdk.services.rds.CfnIntegrationProps |
Python | aws_cdk.aws_rds.CfnIntegrationProps |
TypeScript | aws-cdk-lib » aws_rds » CfnIntegrationProps |
Properties for defining a CfnIntegration
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-integration.html
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
Name | Type | Description |
---|---|---|
source | string | The Amazon Resource Name (ARN) of the database to use as the source for replication. |
target | string | The ARN of the Redshift data warehouse to use as the target for replication. |
additional | IResolvable | { [string]: string } | An optional set of non-secret key–value pairs that contains additional contextual information about the data. |
data | string | Data filters for the integration. |
description? | string | A description of the integration. |
integration | string | The name of the integration. |
kms | string | The AWS Key Management System ( AWS KMS) key identifier for the key to use to encrypt the integration. |
tags? | Cfn [] | A list of tags. |
sourceArn
Type:
string
The Amazon Resource Name (ARN) of the database to use as the source for replication.
targetArn
Type:
string
The ARN of the Redshift data warehouse to use as the target for replication.
additionalEncryptionContext?
Type:
IResolvable
| { [string]: string }
(optional)
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.
dataFilter?
Type:
string
(optional)
Data filters for the integration.
These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse.
description?
Type:
string
(optional)
A description of the integration.
integrationName?
Type:
string
(optional)
The name of the integration.
kmsKeyId?
Type:
string
(optional)
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?
Type:
Cfn
[]
(optional)
A list of tags.
For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. .