Interface ICfnIntegrationProps

Properties for defining a CfnIntegration.

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnIntegrationProps

Syntax (vb)

Public Interface ICfnIntegrationProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.RDS;

             var cfnIntegrationProps = new CfnIntegrationProps {
                 SourceArn = "sourceArn",
                 TargetArn = "targetArn",

                 // the properties below are optional
                 AdditionalEncryptionContext = new Dictionary<string, string> {
                     { "additionalEncryptionContextKey", "additionalEncryptionContext" }
                 },
                 DataFilter = "dataFilter",
                 Description = "description",
                 IntegrationName = "integrationName",
                 KmsKeyId = "kmsKeyId",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Properties

AdditionalEncryptionContext	An optional set of non-secret key–value pairs that contains additional contextual information about the data.
DataFilter	Data filters for the integration.
Description	A description of the integration.
IntegrationName	The name of the integration.
KmsKeyId	The AWS Key Management System ( AWS KMS) key identifier for the key to use to encrypt the integration.
SourceArn	The Amazon Resource Name (ARN) of the database to use as the source for replication.
Tags	An optional array of key-value pairs to apply to this integration.
TargetArn	The ARN of the Redshift data warehouse to use as the target for replication.

Properties

AdditionalEncryptionContext

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

object? AdditionalEncryptionContext { get; }

Property Value

object

Remarks

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

Type union: either Dictionary<string, string> or IResolvable

DataFilter

Data filters for the integration.

string? DataFilter { get; }

Property Value

string

Remarks

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.

string? Description { get; }

Property Value

string

Remarks

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

IntegrationName

The name of the integration.

string? IntegrationName { get; }

Property Value

string

Remarks

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

KmsKeyId

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

string? KmsKeyId { get; }

Property Value

string

Remarks

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

SourceArn

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

string SourceArn { get; }

Property Value

string

Remarks

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

TargetArn

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

string TargetArn { get; }

Property Value

string

Remarks

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