Documentation
¶
Index ¶
- func CfnCertificate_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCertificate_IsCfnElement(x interface{}) *bool
- func CfnCertificate_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnCertificate_IsConstruct(x interface{}) *bool
- func CfnEndpoint_CFN_RESOURCE_TYPE_NAME() *string
- func CfnEndpoint_IsCfnElement(x interface{}) *bool
- func CfnEndpoint_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnEndpoint_IsConstruct(x interface{}) *bool
- func CfnEventSubscription_CFN_RESOURCE_TYPE_NAME() *string
- func CfnEventSubscription_IsCfnElement(x interface{}) *bool
- func CfnEventSubscription_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnEventSubscription_IsConstruct(x interface{}) *bool
- func CfnReplicationInstance_CFN_RESOURCE_TYPE_NAME() *string
- func CfnReplicationInstance_IsCfnElement(x interface{}) *bool
- func CfnReplicationInstance_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnReplicationInstance_IsConstruct(x interface{}) *bool
- func CfnReplicationSubnetGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnReplicationSubnetGroup_IsCfnElement(x interface{}) *bool
- func CfnReplicationSubnetGroup_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnReplicationSubnetGroup_IsConstruct(x interface{}) *bool
- func CfnReplicationTask_CFN_RESOURCE_TYPE_NAME() *string
- func CfnReplicationTask_IsCfnElement(x interface{}) *bool
- func CfnReplicationTask_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnReplicationTask_IsConstruct(x interface{}) *bool
- func NewCfnCertificate_Override(c CfnCertificate, scope constructs.Construct, id *string, ...)
- func NewCfnEndpoint_Override(c CfnEndpoint, scope constructs.Construct, id *string, props *CfnEndpointProps)
- func NewCfnEventSubscription_Override(c CfnEventSubscription, scope constructs.Construct, id *string, ...)
- func NewCfnReplicationInstance_Override(c CfnReplicationInstance, scope constructs.Construct, id *string, ...)
- func NewCfnReplicationSubnetGroup_Override(c CfnReplicationSubnetGroup, scope constructs.Construct, id *string, ...)
- func NewCfnReplicationTask_Override(c CfnReplicationTask, scope constructs.Construct, id *string, ...)
- type CfnCertificate
- type CfnCertificateProps
- type CfnEndpoint
- type CfnEndpointProps
- type CfnEndpoint_DocDbSettingsProperty
- type CfnEndpoint_DynamoDbSettingsProperty
- type CfnEndpoint_ElasticsearchSettingsProperty
- type CfnEndpoint_GcpMySQLSettingsProperty
- type CfnEndpoint_IbmDb2SettingsProperty
- type CfnEndpoint_KafkaSettingsProperty
- type CfnEndpoint_KinesisSettingsProperty
- type CfnEndpoint_MicrosoftSqlServerSettingsProperty
- type CfnEndpoint_MongoDbSettingsProperty
- type CfnEndpoint_MySqlSettingsProperty
- type CfnEndpoint_NeptuneSettingsProperty
- type CfnEndpoint_OracleSettingsProperty
- type CfnEndpoint_PostgreSqlSettingsProperty
- type CfnEndpoint_RedisSettingsProperty
- type CfnEndpoint_RedshiftSettingsProperty
- type CfnEndpoint_S3SettingsProperty
- type CfnEndpoint_SybaseSettingsProperty
- type CfnEventSubscription
- type CfnEventSubscriptionProps
- type CfnReplicationInstance
- type CfnReplicationInstanceProps
- type CfnReplicationSubnetGroup
- type CfnReplicationSubnetGroupProps
- type CfnReplicationTask
- type CfnReplicationTaskProps
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnCertificate_CFN_RESOURCE_TYPE_NAME ¶
func CfnCertificate_CFN_RESOURCE_TYPE_NAME() *string
func CfnCertificate_IsCfnElement ¶
func CfnCertificate_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnCertificate_IsCfnResource ¶
func CfnCertificate_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnCertificate_IsConstruct ¶
func CfnCertificate_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnEndpoint_CFN_RESOURCE_TYPE_NAME ¶
func CfnEndpoint_CFN_RESOURCE_TYPE_NAME() *string
func CfnEndpoint_IsCfnElement ¶
func CfnEndpoint_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnEndpoint_IsCfnResource ¶
func CfnEndpoint_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnEndpoint_IsConstruct ¶
func CfnEndpoint_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnEventSubscription_CFN_RESOURCE_TYPE_NAME ¶
func CfnEventSubscription_CFN_RESOURCE_TYPE_NAME() *string
func CfnEventSubscription_IsCfnElement ¶
func CfnEventSubscription_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnEventSubscription_IsCfnResource ¶
func CfnEventSubscription_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnEventSubscription_IsConstruct ¶
func CfnEventSubscription_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnReplicationInstance_CFN_RESOURCE_TYPE_NAME ¶
func CfnReplicationInstance_CFN_RESOURCE_TYPE_NAME() *string
func CfnReplicationInstance_IsCfnElement ¶
func CfnReplicationInstance_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnReplicationInstance_IsCfnResource ¶
func CfnReplicationInstance_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnReplicationInstance_IsConstruct ¶
func CfnReplicationInstance_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnReplicationSubnetGroup_CFN_RESOURCE_TYPE_NAME ¶
func CfnReplicationSubnetGroup_CFN_RESOURCE_TYPE_NAME() *string
func CfnReplicationSubnetGroup_IsCfnElement ¶
func CfnReplicationSubnetGroup_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnReplicationSubnetGroup_IsCfnResource ¶
func CfnReplicationSubnetGroup_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnReplicationSubnetGroup_IsConstruct ¶
func CfnReplicationSubnetGroup_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnReplicationTask_CFN_RESOURCE_TYPE_NAME ¶
func CfnReplicationTask_CFN_RESOURCE_TYPE_NAME() *string
func CfnReplicationTask_IsCfnElement ¶
func CfnReplicationTask_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnReplicationTask_IsCfnResource ¶
func CfnReplicationTask_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnReplicationTask_IsConstruct ¶
func CfnReplicationTask_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func NewCfnCertificate_Override ¶
func NewCfnCertificate_Override(c CfnCertificate, scope constructs.Construct, id *string, props *CfnCertificateProps)
Create a new `AWS::DMS::Certificate`.
func NewCfnEndpoint_Override ¶
func NewCfnEndpoint_Override(c CfnEndpoint, scope constructs.Construct, id *string, props *CfnEndpointProps)
Create a new `AWS::DMS::Endpoint`.
func NewCfnEventSubscription_Override ¶
func NewCfnEventSubscription_Override(c CfnEventSubscription, scope constructs.Construct, id *string, props *CfnEventSubscriptionProps)
Create a new `AWS::DMS::EventSubscription`.
func NewCfnReplicationInstance_Override ¶
func NewCfnReplicationInstance_Override(c CfnReplicationInstance, scope constructs.Construct, id *string, props *CfnReplicationInstanceProps)
Create a new `AWS::DMS::ReplicationInstance`.
func NewCfnReplicationSubnetGroup_Override ¶
func NewCfnReplicationSubnetGroup_Override(c CfnReplicationSubnetGroup, scope constructs.Construct, id *string, props *CfnReplicationSubnetGroupProps)
Create a new `AWS::DMS::ReplicationSubnetGroup`.
func NewCfnReplicationTask_Override ¶
func NewCfnReplicationTask_Override(c CfnReplicationTask, scope constructs.Construct, id *string, props *CfnReplicationTaskProps)
Create a new `AWS::DMS::ReplicationTask`.
Types ¶
type CfnCertificate ¶
type CfnCertificate interface { awscdk.CfnResource awscdk.IInspectable CertificateIdentifier() *string SetCertificateIdentifier(val *string) CertificatePem() *string SetCertificatePem(val *string) CertificateWallet() *string SetCertificateWallet(val *string) CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string CreationStack() *[]*string LogicalId() *string Node() constructs.Node Ref() *string Stack() awscdk.Stack UpdatedProperites() *map[string]interface{} AddDeletionOverride(path *string) AddDependsOn(target awscdk.CfnResource) AddMetadata(key *string, value interface{}) AddOverride(path *string, value interface{}) AddPropertyDeletionOverride(propertyPath *string) AddPropertyOverride(propertyPath *string, value interface{}) ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) GetAtt(attributeName *string) awscdk.Reference GetMetadata(key *string) interface{} Inspect(inspector awscdk.TreeInspector) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::DMS::Certificate`.
The `AWS::DMS::Certificate` resource creates an SSL certificate that encrypts connections between AWS DMS endpoints and the replication instance.
TODO: EXAMPLE
func NewCfnCertificate ¶
func NewCfnCertificate(scope constructs.Construct, id *string, props *CfnCertificateProps) CfnCertificate
Create a new `AWS::DMS::Certificate`.
type CfnCertificateProps ¶
type CfnCertificateProps struct { // A customer-assigned name for the certificate. // // Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens. CertificateIdentifier *string `json:"certificateIdentifier" yaml:"certificateIdentifier"` // The contents of a `.pem` file, which contains an X.509 certificate. CertificatePem *string `json:"certificatePem" yaml:"certificatePem"` // The location of an imported Oracle Wallet certificate for use with SSL. // // Example: `filebase64("${path.root}/rds-ca-2019-root.sso")` CertificateWallet *string `json:"certificateWallet" yaml:"certificateWallet"` }
Properties for defining a `CfnCertificate`.
TODO: EXAMPLE
type CfnEndpoint ¶
type CfnEndpoint interface { awscdk.CfnResource awscdk.IInspectable AttrExternalId() *string CertificateArn() *string SetCertificateArn(val *string) CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string CreationStack() *[]*string DatabaseName() *string SetDatabaseName(val *string) DocDbSettings() interface{} SetDocDbSettings(val interface{}) DynamoDbSettings() interface{} SetDynamoDbSettings(val interface{}) ElasticsearchSettings() interface{} SetElasticsearchSettings(val interface{}) EndpointIdentifier() *string SetEndpointIdentifier(val *string) EndpointType() *string SetEndpointType(val *string) EngineName() *string SetEngineName(val *string) ExtraConnectionAttributes() *string SetExtraConnectionAttributes(val *string) GcpMySqlSettings() interface{} SetGcpMySqlSettings(val interface{}) IbmDb2Settings() interface{} SetIbmDb2Settings(val interface{}) KafkaSettings() interface{} SetKafkaSettings(val interface{}) KinesisSettings() interface{} SetKinesisSettings(val interface{}) KmsKeyId() *string SetKmsKeyId(val *string) LogicalId() *string MicrosoftSqlServerSettings() interface{} SetMicrosoftSqlServerSettings(val interface{}) MongoDbSettings() interface{} SetMongoDbSettings(val interface{}) MySqlSettings() interface{} SetMySqlSettings(val interface{}) NeptuneSettings() interface{} SetNeptuneSettings(val interface{}) Node() constructs.Node OracleSettings() interface{} SetOracleSettings(val interface{}) Password() *string SetPassword(val *string) Port() *float64 SetPort(val *float64) PostgreSqlSettings() interface{} SetPostgreSqlSettings(val interface{}) RedisSettings() interface{} SetRedisSettings(val interface{}) RedshiftSettings() interface{} SetRedshiftSettings(val interface{}) Ref() *string ResourceIdentifier() *string SetResourceIdentifier(val *string) S3Settings() interface{} SetS3Settings(val interface{}) ServerName() *string SetServerName(val *string) SslMode() *string SetSslMode(val *string) Stack() awscdk.Stack SybaseSettings() interface{} SetSybaseSettings(val interface{}) Tags() awscdk.TagManager UpdatedProperites() *map[string]interface{} Username() *string SetUsername(val *string) AddDeletionOverride(path *string) AddDependsOn(target awscdk.CfnResource) AddMetadata(key *string, value interface{}) AddOverride(path *string, value interface{}) AddPropertyDeletionOverride(propertyPath *string) AddPropertyOverride(propertyPath *string, value interface{}) ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) GetAtt(attributeName *string) awscdk.Reference GetMetadata(key *string) interface{} Inspect(inspector awscdk.TreeInspector) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::DMS::Endpoint`.
The `AWS::DMS::Endpoint` resource creates an AWS DMS endpoint.
Currently, the only endpoint setting types that AWS CloudFormation supports are *DynamoDBSettings* , *ElasticSearchSettings* , and *NeptuneSettings* .
TODO: EXAMPLE
func NewCfnEndpoint ¶
func NewCfnEndpoint(scope constructs.Construct, id *string, props *CfnEndpointProps) CfnEndpoint
Create a new `AWS::DMS::Endpoint`.
type CfnEndpointProps ¶
type CfnEndpointProps struct { // The type of endpoint. // // Valid values are `source` and `target` . EndpointType *string `json:"endpointType" yaml:"endpointType"` // The type of engine for the endpoint. // // Valid values, depending on the `EndpointType` value, include `"mysql"` , `"oracle"` , `"postgres"` , `"mariadb"` , `"aurora"` , `"aurora-postgresql"` , `"opensearch"` , `"redshift"` , `"s3"` , `"db2"` , `"azuredb"` , `"sybase"` , `"dynamodb"` , `"mongodb"` , `"kinesis"` , `"kafka"` , `"elasticsearch"` , `"docdb"` , `"sqlserver"` , and `"neptune"` . EngineName *string `json:"engineName" yaml:"engineName"` // The Amazon Resource Name (ARN) for the certificate. CertificateArn *string `json:"certificateArn" yaml:"certificateArn"` // The name of the endpoint database. // // For a MySQL source or target endpoint, do not specify DatabaseName. To migrate to a specific database, use this setting and `targetDbType` . DatabaseName *string `json:"databaseName" yaml:"databaseName"` // Settings in JSON format for the source DocumentDB endpoint. // // For more information about the available settings, see the configuration properties section in [Using DocumentDB as a Target for AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DocumentDB.html) in the *AWS Database Migration Service User Guide.* DocDbSettings interface{} `json:"docDbSettings" yaml:"docDbSettings"` // Settings in JSON format for the target Amazon DynamoDB endpoint. // // For information about other available settings, see [Using Object Mapping to Migrate Data to DynamoDB](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html#CHAP_Target.DynamoDB.ObjectMapping) in the *AWS Database Migration Service User Guide.* DynamoDbSettings interface{} `json:"dynamoDbSettings" yaml:"dynamoDbSettings"` // Settings in JSON format for the target OpenSearch endpoint. // // For more information about the available settings, see [Extra Connection Attributes When Using OpenSearch as a Target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Elasticsearch.html#CHAP_Target.Elasticsearch.Configuration) in the *AWS Database Migration Service User Guide* . ElasticsearchSettings interface{} `json:"elasticsearchSettings" yaml:"elasticsearchSettings"` // The database endpoint identifier. // // Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens. EndpointIdentifier *string `json:"endpointIdentifier" yaml:"endpointIdentifier"` // Additional attributes associated with the connection. // // Each attribute is specified as a name-value pair associated by an equal sign (=). Multiple attributes are separated by a semicolon (;) with no additional white space. For information on the attributes available for connecting your source or target endpoint, see [Working with AWS DMS Endpoints](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html) in the *AWS Database Migration Service User Guide.* ExtraConnectionAttributes *string `json:"extraConnectionAttributes" yaml:"extraConnectionAttributes"` // Settings in JSON format for the source GCP MySQL endpoint. GcpMySqlSettings interface{} `json:"gcpMySqlSettings" yaml:"gcpMySqlSettings"` // Not currently supported by AWS CloudFormation . IbmDb2Settings interface{} `json:"ibmDb2Settings" yaml:"ibmDb2Settings"` // Settings in JSON format for the target Apache Kafka endpoint. // // For more information about the available settings, see [Using object mapping to migrate data to a Kafka topic](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html#CHAP_Target.Kafka.ObjectMapping) in the *AWS Database Migration Service User Guide.* KafkaSettings interface{} `json:"kafkaSettings" yaml:"kafkaSettings"` // Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. // // For more information about the available settings, see [Using Amazon Kinesis Data Streams as a Target for AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html) in the *AWS Database Migration Service User Guide.* KinesisSettings interface{} `json:"kinesisSettings" yaml:"kinesisSettings"` // An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint. // // If you don't specify a value for the `KmsKeyId` parameter, then AWS DMS uses your default encryption key. // // AWS KMS creates the default encryption key for your AWS account . Your AWS account has a different default encryption key for each AWS Region . KmsKeyId *string `json:"kmsKeyId" yaml:"kmsKeyId"` // Not currently supported by AWS CloudFormation . MicrosoftSqlServerSettings interface{} `json:"microsoftSqlServerSettings" yaml:"microsoftSqlServerSettings"` // Not currently supported by AWS CloudFormation . MongoDbSettings interface{} `json:"mongoDbSettings" yaml:"mongoDbSettings"` // Settings in JSON format for the source and target MySQL endpoint. // // For information about other available settings, see [Extra connection attributes when using MySQL as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html#CHAP_Source.MySQL.ConnectionAttrib) and [Extra connection attributes when using a MySQL-compatible database as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.MySQL.html#CHAP_Target.MySQL.ConnectionAttrib) in the *AWS Database Migration Service User Guide.* MySqlSettings interface{} `json:"mySqlSettings" yaml:"mySqlSettings"` // `AWS::DMS::Endpoint.NeptuneSettings`. NeptuneSettings interface{} `json:"neptuneSettings" yaml:"neptuneSettings"` // Settings in JSON format for the source and target Oracle endpoint. // // For information about other available settings, see [Extra connection attributes when using Oracle as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.ConnectionAttrib) and [Extra connection attributes when using Oracle as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Oracle.html#CHAP_Target.Oracle.ConnectionAttrib) in the *AWS Database Migration Service User Guide.* OracleSettings interface{} `json:"oracleSettings" yaml:"oracleSettings"` // The password to be used to log in to the endpoint database. Password *string `json:"password" yaml:"password"` // The port used by the endpoint database. Port *float64 `json:"port" yaml:"port"` // Not currently supported by AWS CloudFormation . PostgreSqlSettings interface{} `json:"postgreSqlSettings" yaml:"postgreSqlSettings"` // Settings in JSON format for the target Redis endpoint. RedisSettings interface{} `json:"redisSettings" yaml:"redisSettings"` // Not currently supported by AWS CloudFormation . RedshiftSettings interface{} `json:"redshiftSettings" yaml:"redshiftSettings"` // A friendly name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object. // // The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as `Example-App-ARN1` . For example, this value might result in the `EndpointArn` value `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1` . If you don't specify a `ResourceIdentifier` value, AWS DMS generates a default identifier value for the end of `EndpointArn` . ResourceIdentifier *string `json:"resourceIdentifier" yaml:"resourceIdentifier"` // Settings in JSON format for the target Amazon S3 endpoint. // // For more information about the available settings, see [Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring) in the *AWS Database Migration Service User Guide.* S3Settings interface{} `json:"s3Settings" yaml:"s3Settings"` // The name of the server where the endpoint database resides. ServerName *string `json:"serverName" yaml:"serverName"` // The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is `none` . // // > When `engine_name` is set to S3, then the only allowed value is `none` . SslMode *string `json:"sslMode" yaml:"sslMode"` // Settings in JSON format for the source and target SAP ASE endpoint. // // For information about other available settings, see [Extra connection attributes when using SAP ASE as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.html#CHAP_Source.SAP.ConnectionAttrib) and [Extra connection attributes when using SAP ASE as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SAP.html#CHAP_Target.SAP.ConnectionAttrib) in the *AWS Database Migration Service User Guide.* SybaseSettings interface{} `json:"sybaseSettings" yaml:"sybaseSettings"` // One or more tags to be assigned to the endpoint. Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"` // The user name to be used to log in to the endpoint database. Username *string `json:"username" yaml:"username"` }
Properties for defining a `CfnEndpoint`.
TODO: EXAMPLE
type CfnEndpoint_DocDbSettingsProperty ¶
type CfnEndpoint_DocDbSettingsProperty struct { // Not currently supported by AWS CloudFormation . SecretsManagerAccessRoleArn *string `json:"secretsManagerAccessRoleArn" yaml:"secretsManagerAccessRoleArn"` // Not currently supported by AWS CloudFormation . SecretsManagerSecretId *string `json:"secretsManagerSecretId" yaml:"secretsManagerSecretId"` }
Not currently supported by AWS CloudFormation .
TODO: EXAMPLE
type CfnEndpoint_DynamoDbSettingsProperty ¶
type CfnEndpoint_DynamoDbSettingsProperty struct { // The Amazon Resource Name (ARN) used by the service to access the IAM role. // // The role must allow the `iam:PassRole` action. ServiceAccessRoleArn *string `json:"serviceAccessRoleArn" yaml:"serviceAccessRoleArn"` }
Provides the Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role used to define an Amazon DynamoDB target endpoint.
TODO: EXAMPLE
type CfnEndpoint_ElasticsearchSettingsProperty ¶
type CfnEndpoint_ElasticsearchSettingsProperty struct { // The endpoint for the OpenSearch cluster. // // AWS DMS uses HTTPS if a transport protocol (http/https) is not specified. EndpointUri *string `json:"endpointUri" yaml:"endpointUri"` // The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster. ErrorRetryDuration *float64 `json:"errorRetryDuration" yaml:"errorRetryDuration"` // The maximum percentage of records that can fail to be written before a full load operation stops. // // To avoid early failure, this counter is only effective after 1000 records are transferred. OpenSearch also has the concept of error monitoring during the last 10 minutes of an Observation Window. If transfer of all records fail in the last 10 minutes, the full load operation stops. FullLoadErrorPercentage *float64 `json:"fullLoadErrorPercentage" yaml:"fullLoadErrorPercentage"` // The Amazon Resource Name (ARN) used by the service to access the IAM role. // // The role must allow the `iam:PassRole` action. ServiceAccessRoleArn *string `json:"serviceAccessRoleArn" yaml:"serviceAccessRoleArn"` }
Provides information that defines an OpenSearch endpoint.
TODO: EXAMPLE
type CfnEndpoint_GcpMySQLSettingsProperty ¶ added in v2.10.0
type CfnEndpoint_GcpMySQLSettingsProperty struct { // Specifies a script to run immediately after AWS DMS connects to the endpoint. // // The migration task continues running regardless if the SQL statement succeeds or fails. // // For this parameter, provide the code of the script itself, not the name of a file containing the script. AfterConnectScript *string `json:"afterConnectScript" yaml:"afterConnectScript"` // Adjusts the behavior of AWS DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster. // // If you need AWS DMS to poll all the nodes in the Always On cluster for transaction backups, set this attribute to `false` . CleanSourceMetadataOnMismatch interface{} `json:"cleanSourceMetadataOnMismatch" yaml:"cleanSourceMetadataOnMismatch"` // Database name for the endpoint. // // For a MySQL source or target endpoint, don't explicitly specify the database using the `DatabaseName` request parameter on either the `CreateEndpoint` or `ModifyEndpoint` API call. Specifying `DatabaseName` when you create or modify a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the AWS DMS task. DatabaseName *string `json:"databaseName" yaml:"databaseName"` // Specifies how often to check the binary log for new changes/events when the database is idle. // // The default is five seconds. // // Example: `eventsPollInterval=5;` // // In the example, AWS DMS checks for changes in the binary logs every five seconds. EventsPollInterval *float64 `json:"eventsPollInterval" yaml:"eventsPollInterval"` // Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database. // // Example: `maxFileSize=512` MaxFileSize *float64 `json:"maxFileSize" yaml:"maxFileSize"` // Improves performance when loading data into the MySQL-compatible target database. // // Specifies how many threads to use to load the data into the MySQL-compatible target database. Setting a large number of threads can have an adverse effect on database performance, because a separate connection is required for each thread. The default is one. // // Example: `parallelLoadThreads=1` ParallelLoadThreads *float64 `json:"parallelLoadThreads" yaml:"parallelLoadThreads"` // Endpoint connection password. Password *string `json:"password" yaml:"password"` // `CfnEndpoint.GcpMySQLSettingsProperty.Port`. Port *float64 `json:"port" yaml:"port"` // The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret.` The role must allow the `iam:PassRole` action. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the MySQL endpoint. // // > You can specify one of two sets of values for these permissions. You can specify the values for this setting and `SecretsManagerSecretId` . Or you can specify clear-text values for `UserName` , `Password` , `ServerName` , and `Port` . You can't specify both. For more information on creating this `SecretsManagerSecret` and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId` required to access it, see [Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the AWS Database Migration Service User Guide. SecretsManagerAccessRoleArn *string `json:"secretsManagerAccessRoleArn" yaml:"secretsManagerAccessRoleArn"` // The full ARN, partial ARN, or friendly name of the `SecretsManagerSecret` that contains the MySQL endpoint connection details. SecretsManagerSecretId *string `json:"secretsManagerSecretId" yaml:"secretsManagerSecretId"` // Endpoint TCP port. ServerName *string `json:"serverName" yaml:"serverName"` // Specifies the time zone for the source MySQL database. // // Example: `serverTimezone=US/Pacific;` // // Note: Do not enclose time zones in single quotes. ServerTimezone *string `json:"serverTimezone" yaml:"serverTimezone"` // Endpoint connection user name. Username *string `json:"username" yaml:"username"` }
Settings in JSON format for the source GCP MySQL endpoint.
TODO: EXAMPLE
type CfnEndpoint_IbmDb2SettingsProperty ¶
type CfnEndpoint_IbmDb2SettingsProperty struct { // Not currently supported by AWS CloudFormation . SecretsManagerAccessRoleArn *string `json:"secretsManagerAccessRoleArn" yaml:"secretsManagerAccessRoleArn"` // Not currently supported by AWS CloudFormation . SecretsManagerSecretId *string `json:"secretsManagerSecretId" yaml:"secretsManagerSecretId"` }
Not currently supported by AWS CloudFormation .
TODO: EXAMPLE
type CfnEndpoint_KafkaSettingsProperty ¶
type CfnEndpoint_KafkaSettingsProperty struct { // Not currently supported by AWS CloudFormation . Broker *string `json:"broker" yaml:"broker"` // Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. // // The default is `false` . IncludeControlDetails interface{} `json:"includeControlDetails" yaml:"includeControlDetails"` // Include NULL and empty columns for records migrated to the endpoint. // // The default is `false` . IncludeNullAndEmpty interface{} `json:"includeNullAndEmpty" yaml:"includeNullAndEmpty"` // Includes any data definition language (DDL) operations that change the table in the control data, such as `rename-table` , `drop-table` , `add-column` , `drop-column` , and `rename-column` . // // The default is `false` . IncludeTableAlterOperations interface{} `json:"includeTableAlterOperations" yaml:"includeTableAlterOperations"` // Provides detailed transaction information from the source database. // // This information includes a commit timestamp, a log position, and values for `transaction_id` , previous `transaction_id` , and `transaction_record_id` (the record offset within a transaction). The default is `false` . IncludeTransactionDetails interface{} `json:"includeTransactionDetails" yaml:"includeTransactionDetails"` // Set this optional parameter to `true` to avoid adding a '0x' prefix to raw data in hexadecimal format. // // For example, by default, AWS DMS adds a '0x' prefix to the LOB column type in hexadecimal format moving from an Oracle source to a Kafka target. Use the `NoHexPrefix` endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix. NoHexPrefix interface{} `json:"noHexPrefix" yaml:"noHexPrefix"` // Prefixes schema and table names to partition values, when the partition type is `primary-key-type` . // // Doing this increases data distribution among Kafka partitions. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same partition, which causes throttling. The default is `false` . PartitionIncludeSchemaTable interface{} `json:"partitionIncludeSchemaTable" yaml:"partitionIncludeSchemaTable"` // The secure password you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication. SaslPassword *string `json:"saslPassword" yaml:"saslPassword"` // The secure user name you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication. SaslUserName *string `json:"saslUserName" yaml:"saslUserName"` // Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS). // // Options include `ssl-encryption` , `ssl-authentication` , and `sasl-ssl` . `sasl-ssl` requires `SaslUsername` and `SaslPassword` . SecurityProtocol *string `json:"securityProtocol" yaml:"securityProtocol"` // The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that AWS DMS uses to securely connect to your Kafka target endpoint. SslCaCertificateArn *string `json:"sslCaCertificateArn" yaml:"sslCaCertificateArn"` // The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint. SslClientCertificateArn *string `json:"sslClientCertificateArn" yaml:"sslClientCertificateArn"` // The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint. SslClientKeyArn *string `json:"sslClientKeyArn" yaml:"sslClientKeyArn"` // The password for the client private key used to securely connect to a Kafka target endpoint. SslClientKeyPassword *string `json:"sslClientKeyPassword" yaml:"sslClientKeyPassword"` // Not currently supported by AWS CloudFormation . Topic *string `json:"topic" yaml:"topic"` }
Not currently supported by AWS CloudFormation .
TODO: EXAMPLE
type CfnEndpoint_KinesisSettingsProperty ¶
type CfnEndpoint_KinesisSettingsProperty struct { // Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output. // // The default is `false` . IncludeControlDetails interface{} `json:"includeControlDetails" yaml:"includeControlDetails"` // Include NULL and empty columns for records migrated to the endpoint. // // The default is `false` . IncludeNullAndEmpty interface{} `json:"includeNullAndEmpty" yaml:"includeNullAndEmpty"` // Includes any data definition language (DDL) operations that change the table in the control data, such as `rename-table` , `drop-table` , `add-column` , `drop-column` , and `rename-column` . // // The default is `false` . IncludeTableAlterOperations interface{} `json:"includeTableAlterOperations" yaml:"includeTableAlterOperations"` // Provides detailed transaction information from the source database. // // This information includes a commit timestamp, a log position, and values for `transaction_id` , previous `transaction_id` , and `transaction_record_id` (the record offset within a transaction). The default is `false` . IncludeTransactionDetails interface{} `json:"includeTransactionDetails" yaml:"includeTransactionDetails"` // Not currently supported by AWS CloudFormation . MessageFormat *string `json:"messageFormat" yaml:"messageFormat"` // Set this optional parameter to `true` to avoid adding a '0x' prefix to raw data in hexadecimal format. // // For example, by default, AWS DMS adds a '0x' prefix to the LOB column type in hexadecimal format moving from an Oracle source to an Amazon Kinesis target. Use the `NoHexPrefix` endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix. NoHexPrefix interface{} `json:"noHexPrefix" yaml:"noHexPrefix"` // Prefixes schema and table names to partition values, when the partition type is `primary-key-type` . // // Doing this increases data distribution among Kinesis shards. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same shard, which causes throttling. The default is `false` . PartitionIncludeSchemaTable interface{} `json:"partitionIncludeSchemaTable" yaml:"partitionIncludeSchemaTable"` // Not currently supported by AWS CloudFormation . ServiceAccessRoleArn *string `json:"serviceAccessRoleArn" yaml:"serviceAccessRoleArn"` // Not currently supported by AWS CloudFormation . StreamArn *string `json:"streamArn" yaml:"streamArn"` }
Not currently supported by AWS CloudFormation ..
TODO: EXAMPLE
type CfnEndpoint_MicrosoftSqlServerSettingsProperty ¶
type CfnEndpoint_MicrosoftSqlServerSettingsProperty struct { // Not currently supported by AWS CloudFormation . SecretsManagerAccessRoleArn *string `json:"secretsManagerAccessRoleArn" yaml:"secretsManagerAccessRoleArn"` // Not currently supported by AWS CloudFormation . SecretsManagerSecretId *string `json:"secretsManagerSecretId" yaml:"secretsManagerSecretId"` }
Not currently supported by AWS CloudFormation .
TODO: EXAMPLE
type CfnEndpoint_MongoDbSettingsProperty ¶
type CfnEndpoint_MongoDbSettingsProperty struct { // Not currently supported by AWS CloudFormation . AuthMechanism *string `json:"authMechanism" yaml:"authMechanism"` // Not currently supported by AWS CloudFormation . AuthSource *string `json:"authSource" yaml:"authSource"` // Not currently supported by AWS CloudFormation . AuthType *string `json:"authType" yaml:"authType"` // Not currently supported by AWS CloudFormation . DatabaseName *string `json:"databaseName" yaml:"databaseName"` // Not currently supported by AWS CloudFormation . DocsToInvestigate *string `json:"docsToInvestigate" yaml:"docsToInvestigate"` // Not currently supported by AWS CloudFormation . ExtractDocId *string `json:"extractDocId" yaml:"extractDocId"` // Not currently supported by AWS CloudFormation . NestingLevel *string `json:"nestingLevel" yaml:"nestingLevel"` // Not currently supported by AWS CloudFormation . Password *string `json:"password" yaml:"password"` // Not currently supported by AWS CloudFormation . Port *float64 `json:"port" yaml:"port"` // Not currently supported by AWS CloudFormation . SecretsManagerAccessRoleArn *string `json:"secretsManagerAccessRoleArn" yaml:"secretsManagerAccessRoleArn"` // Not currently supported by AWS CloudFormation . SecretsManagerSecretId *string `json:"secretsManagerSecretId" yaml:"secretsManagerSecretId"` // Not currently supported by AWS CloudFormation . ServerName *string `json:"serverName" yaml:"serverName"` // Not currently supported by AWS CloudFormation . Username *string `json:"username" yaml:"username"` }
Not currently supported by AWS CloudFormation .
TODO: EXAMPLE
type CfnEndpoint_MySqlSettingsProperty ¶
type CfnEndpoint_MySqlSettingsProperty struct { // Not currently supported by AWS CloudFormation . SecretsManagerAccessRoleArn *string `json:"secretsManagerAccessRoleArn" yaml:"secretsManagerAccessRoleArn"` // Not currently supported by AWS CloudFormation . SecretsManagerSecretId *string `json:"secretsManagerSecretId" yaml:"secretsManagerSecretId"` }
Not currently supported by AWS CloudFormation .
TODO: EXAMPLE
type CfnEndpoint_NeptuneSettingsProperty ¶
type CfnEndpoint_NeptuneSettingsProperty struct { // The number of milliseconds for AWS DMS to wait to retry a bulk-load of migrated graph data to the Neptune target database before raising an error. // // The default is 250. ErrorRetryDuration *float64 `json:"errorRetryDuration" yaml:"errorRetryDuration"` // If you want AWS Identity and Access Management (IAM) authorization enabled for this endpoint, set this parameter to `true` . // // Then attach the appropriate IAM policy document to your service role specified by `ServiceAccessRoleArn` . The default is `false` . IamAuthEnabled interface{} `json:"iamAuthEnabled" yaml:"iamAuthEnabled"` // The maximum size in kilobytes of migrated graph data stored in a .csv file before AWS DMS bulk-loads the data to the Neptune target database. The default is 1,048,576 KB. If the bulk load is successful, AWS DMS clears the bucket, ready to store the next batch of migrated graph data. MaxFileSize *float64 `json:"maxFileSize" yaml:"maxFileSize"` // The number of times for AWS DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error. // // The default is 5. MaxRetryCount *float64 `json:"maxRetryCount" yaml:"maxRetryCount"` // A folder path where you want AWS DMS to store migrated graph data in the S3 bucket specified by `S3BucketName`. S3BucketFolder *string `json:"s3BucketFolder" yaml:"s3BucketFolder"` // The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database. AWS DMS maps the SQL source data to graph data before storing it in these .csv files. S3BucketName *string `json:"s3BucketName" yaml:"s3BucketName"` // The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint. // // The role must allow the `iam:PassRole` action. For more information, see [Creating an IAM Service Role for Accessing Amazon Neptune as a Target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.ServiceRole) in the *AWS Database Migration Service User Guide.* ServiceAccessRoleArn *string `json:"serviceAccessRoleArn" yaml:"serviceAccessRoleArn"` }
Provides information that defines an Amazon Neptune endpoint.
TODO: EXAMPLE
type CfnEndpoint_OracleSettingsProperty ¶
type CfnEndpoint_OracleSettingsProperty struct { // Not currently supported by AWS CloudFormation . SecretsManagerAccessRoleArn *string `json:"secretsManagerAccessRoleArn" yaml:"secretsManagerAccessRoleArn"` // Not currently supported by AWS CloudFormation . SecretsManagerOracleAsmAccessRoleArn *string `json:"secretsManagerOracleAsmAccessRoleArn" yaml:"secretsManagerOracleAsmAccessRoleArn"` // Not currently supported by AWS CloudFormation . SecretsManagerOracleAsmSecretId *string `json:"secretsManagerOracleAsmSecretId" yaml:"secretsManagerOracleAsmSecretId"` // Not currently supported by AWS CloudFormation . SecretsManagerSecretId *string `json:"secretsManagerSecretId" yaml:"secretsManagerSecretId"` }
Not currently supported by AWS CloudFormation .
TODO: EXAMPLE
type CfnEndpoint_PostgreSqlSettingsProperty ¶
type CfnEndpoint_PostgreSqlSettingsProperty struct { // Not currently supported by AWS CloudFormation . SecretsManagerAccessRoleArn *string `json:"secretsManagerAccessRoleArn" yaml:"secretsManagerAccessRoleArn"` // Not currently supported by AWS CloudFormation . SecretsManagerSecretId *string `json:"secretsManagerSecretId" yaml:"secretsManagerSecretId"` }
Not currently supported by AWS CloudFormation .
TODO: EXAMPLE
type CfnEndpoint_RedisSettingsProperty ¶
type CfnEndpoint_RedisSettingsProperty struct { // The password provided with the `auth-role` and `auth-token` options of the `AuthType` setting for a Redis target endpoint. AuthPassword *string `json:"authPassword" yaml:"authPassword"` // The type of authentication to perform when connecting to a Redis target. // // Options include `none` , `auth-token` , and `auth-role` . The `auth-token` option requires an `AuthPassword` value to be provided. The `auth-role` option requires `AuthUserName` and `AuthPassword` values to be provided. AuthType *string `json:"authType" yaml:"authType"` // The user name provided with the `auth-role` option of the `AuthType` setting for a Redis target endpoint. AuthUserName *string `json:"authUserName" yaml:"authUserName"` // Transmission Control Protocol (TCP) port for the endpoint. Port *float64 `json:"port" yaml:"port"` // Fully qualified domain name of the endpoint. ServerName *string `json:"serverName" yaml:"serverName"` // The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint. SslCaCertificateArn *string `json:"sslCaCertificateArn" yaml:"sslCaCertificateArn"` // The connection to a Redis target endpoint using Transport Layer Security (TLS). // // Valid values include `plaintext` and `ssl-encryption` . The default is `ssl-encryption` . The `ssl-encryption` option makes an encrypted connection. Optionally, you can identify an Amazon Resource Name (ARN) for an SSL certificate authority (CA) using the `SslCaCertificateArn` setting. If an ARN isn't given for a CA, DMS uses the Amazon root CA. // // The `plaintext` option doesn't provide Transport Layer Security (TLS) encryption for traffic between endpoint and database. SslSecurityProtocol *string `json:"sslSecurityProtocol" yaml:"sslSecurityProtocol"` }
Provides information that defines a Redis target endpoint.
TODO: EXAMPLE
type CfnEndpoint_RedshiftSettingsProperty ¶
type CfnEndpoint_RedshiftSettingsProperty struct { // Not currently supported by AWS CloudFormation . SecretsManagerAccessRoleArn *string `json:"secretsManagerAccessRoleArn" yaml:"secretsManagerAccessRoleArn"` // Not currently supported by AWS CloudFormation . SecretsManagerSecretId *string `json:"secretsManagerSecretId" yaml:"secretsManagerSecretId"` }
Not currently supported by AWS CloudFormation .
TODO: EXAMPLE
type CfnEndpoint_S3SettingsProperty ¶
type CfnEndpoint_S3SettingsProperty struct { // An optional parameter that, when set to `true` or `y` , you can use to add column name information to the .csv output file. // // The default value is `false` . Valid values are `true` , `false` , `y` , and `n` . AddColumnName interface{} `json:"addColumnName" yaml:"addColumnName"` // Not currently supported by AWS CloudFormation . BucketFolder *string `json:"bucketFolder" yaml:"bucketFolder"` // Not currently supported by AWS CloudFormation . BucketName *string `json:"bucketName" yaml:"bucketName"` // A value that enables AWS DMS to specify a predefined (canned) access control list for objects created in an Amazon S3 bucket as .csv or .parquet files. For more information about Amazon S3 canned ACLs, see [Canned ACL](https://docs.aws.amazon.com/http://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the *Amazon S3 Developer Guide.*. // // The default value is NONE. Valid values include NONE, PRIVATE, PUBLIC_READ, PUBLIC_READ_WRITE, AUTHENTICATED_READ, AWS_EXEC_READ, BUCKET_OWNER_READ, and BUCKET_OWNER_FULL_CONTROL. CannedAclForObjects *string `json:"cannedAclForObjects" yaml:"cannedAclForObjects"` // A value that enables a change data capture (CDC) load to write INSERT and UPDATE operations to .csv or .parquet (columnar storage) output files. The default setting is `false` , but when `CdcInsertsAndUpdates` is set to `true` or `y` , only INSERTs and UPDATEs from the source database are migrated to the .csv or .parquet file. // // For .csv file format only, how these INSERTs and UPDATEs are recorded depends on the value of the `IncludeOpForFullLoad` parameter. If `IncludeOpForFullLoad` is set to `true` , the first field of every CDC record is set to either `I` or `U` to indicate INSERT and UPDATE operations at the source. But if `IncludeOpForFullLoad` is set to `false` , CDC records are written without an indication of INSERT or UPDATE operations at the source. For more information about how these settings work together, see [Indicating Source DB Operations in Migrated S3 Data](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the *AWS Database Migration Service User Guide.* . // // > AWS DMS supports the use of the `CdcInsertsAndUpdates` parameter in versions 3.3.1 and later. // > // > `CdcInsertsOnly` and `CdcInsertsAndUpdates` can't both be set to `true` for the same endpoint. Set either `CdcInsertsOnly` or `CdcInsertsAndUpdates` to `true` for the same endpoint, but not both. CdcInsertsAndUpdates interface{} `json:"cdcInsertsAndUpdates" yaml:"cdcInsertsAndUpdates"` // A value that enables a change data capture (CDC) load to write only INSERT operations to .csv or columnar storage (.parquet) output files. By default (the `false` setting), the first field in a .csv or .parquet record contains the letter I (INSERT), U (UPDATE), or D (DELETE). These values indicate whether the row was inserted, updated, or deleted at the source database for a CDC load to the target. // // If `CdcInsertsOnly` is set to `true` or `y` , only INSERTs from the source database are migrated to the .csv or .parquet file. For .csv format only, how these INSERTs are recorded depends on the value of `IncludeOpForFullLoad` . If `IncludeOpForFullLoad` is set to `true` , the first field of every CDC record is set to I to indicate the INSERT operation at the source. If `IncludeOpForFullLoad` is set to `false` , every CDC record is written without a first field to indicate the INSERT operation at the source. For more information about how these settings work together, see [Indicating Source DB Operations in Migrated S3 Data](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the *AWS Database Migration Service User Guide.* . // // > AWS DMS supports the interaction described preceding between the `CdcInsertsOnly` and `IncludeOpForFullLoad` parameters in versions 3.1.4 and later. // > // > `CdcInsertsOnly` and `CdcInsertsAndUpdates` can't both be set to `true` for the same endpoint. Set either `CdcInsertsOnly` or `CdcInsertsAndUpdates` to `true` for the same endpoint, but not both. CdcInsertsOnly interface{} `json:"cdcInsertsOnly" yaml:"cdcInsertsOnly"` // Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3. // // When `CdcMaxBatchInterval` and `CdcMinFileSize` are both specified, the file write is triggered by whichever parameter condition is met first within an AWS DMS CloudFormation template. // // The default value is 60 seconds. CdcMaxBatchInterval *float64 `json:"cdcMaxBatchInterval" yaml:"cdcMaxBatchInterval"` // Minimum file size, defined in megabytes, to reach for a file output to Amazon S3. // // When `CdcMinFileSize` and `CdcMaxBatchInterval` are both specified, the file write is triggered by whichever parameter condition is met first within an AWS DMS CloudFormation template. // // The default value is 32 MB. CdcMinFileSize *float64 `json:"cdcMinFileSize" yaml:"cdcMinFileSize"` // Specifies the folder path of CDC files. // // For an S3 source, this setting is required if a task captures change data; otherwise, it's optional. If `CdcPath` is set, AWS DMS reads CDC files from this path and replicates the data changes to the target endpoint. For an S3 target if you set [`PreserveTransactions`](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions) to `true` , AWS DMS verifies that you have set this parameter to a folder path on your S3 target where AWS DMS can save the transaction order for the CDC load. AWS DMS creates this CDC folder path in either your S3 target working directory or the S3 target location specified by [`BucketFolder`](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder) and [`BucketName`](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName) . // // For example, if you specify `CdcPath` as `MyChangedData` , and you specify `BucketName` as `MyTargetBucket` but do not specify `BucketFolder` , AWS DMS creates the CDC folder path following: `MyTargetBucket/MyChangedData` . // // If you specify the same `CdcPath` , and you specify `BucketName` as `MyTargetBucket` and `BucketFolder` as `MyTargetData` , AWS DMS creates the CDC folder path following: `MyTargetBucket/MyTargetData/MyChangedData` . // // For more information on CDC including transaction order on an S3 target, see [Capturing data changes (CDC) including transaction order on the S3 target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath) . // // > This setting is supported in AWS DMS versions 3.4.2 and later. CdcPath *string `json:"cdcPath" yaml:"cdcPath"` // Not currently supported by AWS CloudFormation . CompressionType *string `json:"compressionType" yaml:"compressionType"` // Not currently supported by AWS CloudFormation . CsvDelimiter *string `json:"csvDelimiter" yaml:"csvDelimiter"` // This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written in .csv format. If [`UseCsvNoSupValue`](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-UseCsvNoSupValue) is set to true, specify a string value that you want AWS DMS to use for all columns not included in the supplemental log. If you do not specify a string value, AWS DMS uses the null value for these columns regardless of the `UseCsvNoSupValue` setting. // // > This setting is supported in AWS DMS versions 3.4.1 and later. CsvNoSupValue *string `json:"csvNoSupValue" yaml:"csvNoSupValue"` // An optional parameter that specifies how AWS DMS treats null values. // // While handling the null value, you can use this parameter to pass a user-defined string as null when writing to the target. For example, when target columns are not nullable, you can use this option to differentiate between the empty string value and the null value. So, if you set this parameter value to the empty string ("" or ”), AWS DMS treats the empty string as the null value instead of `NULL` . // // The default value is `NULL` . Valid values include any valid string. CsvNullValue *string `json:"csvNullValue" yaml:"csvNullValue"` // Not currently supported by AWS CloudFormation . CsvRowDelimiter *string `json:"csvRowDelimiter" yaml:"csvRowDelimiter"` // The format of the data that you want to use for output. You can choose one of the following:. // // - `csv` : This is a row-based file format with comma-separated values (.csv). // - `parquet` : Apache Parquet (.parquet) is a columnar storage file format that features efficient compression and provides faster query response. DataFormat *string `json:"dataFormat" yaml:"dataFormat"` // The size of one data page in bytes. // // This parameter defaults to 1024 * 1024 bytes (1 MiB). This number is used for .parquet file format only. DataPageSize *float64 `json:"dataPageSize" yaml:"dataPageSize"` // Specifies a date separating delimiter to use during folder partitioning. // // The default value is `SLASH` . Use this parameter when `DatePartitionedEnabled` is set to `true` . DatePartitionDelimiter *string `json:"datePartitionDelimiter" yaml:"datePartitionDelimiter"` // When set to `true` , this parameter partitions S3 bucket folders based on transaction commit dates. // // The default value is `false` . For more information about date-based folder partitioning, see [Using date-based folder partitioning](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.DatePartitioning) . DatePartitionEnabled interface{} `json:"datePartitionEnabled" yaml:"datePartitionEnabled"` // Identifies the sequence of the date format to use during folder partitioning. // // The default value is `YYYYMMDD` . Use this parameter when `DatePartitionedEnabled` is set to `true` . DatePartitionSequence *string `json:"datePartitionSequence" yaml:"datePartitionSequence"` // When creating an S3 target endpoint, set `DatePartitionTimezone` to convert the current UTC time into a specified time zone. // // The conversion occurs when a date partition folder is created and a CDC filename is generated. The time zone format is Area/Location. Use this parameter when `DatePartitionedEnabled` is set to `true` , as shown in the following example. // // `s3-settings='{"DatePartitionEnabled": true, "DatePartitionSequence": "YYYYMMDDHH", "DatePartitionDelimiter": "SLASH", "DatePartitionTimezone":" *Asia/Seoul* ", "BucketName": "dms-nattarat-test"}'` DatePartitionTimezone *string `json:"datePartitionTimezone" yaml:"datePartitionTimezone"` // The maximum size of an encoded dictionary page of a column. // // If the dictionary page exceeds this, this column is stored using an encoding type of `PLAIN` . This parameter defaults to 1024 * 1024 bytes (1 MiB), the maximum size of a dictionary page before it reverts to `PLAIN` encoding. This size is used for .parquet file format only. DictPageSizeLimit *float64 `json:"dictPageSizeLimit" yaml:"dictPageSizeLimit"` // A value that enables statistics for Parquet pages and row groups. // // Choose `true` to enable statistics, `false` to disable. Statistics include `NULL` , `DISTINCT` , `MAX` , and `MIN` values. This parameter defaults to `true` . This value is used for .parquet file format only. EnableStatistics interface{} `json:"enableStatistics" yaml:"enableStatistics"` // The type of encoding you are using:. // // - `RLE_DICTIONARY` uses a combination of bit-packing and run-length encoding to store repeated values more efficiently. This is the default. // - `PLAIN` doesn't use encoding at all. Values are stored as they are. // - `PLAIN_DICTIONARY` builds a dictionary of the values encountered in a given column. The dictionary is stored in a dictionary page for each column chunk. EncodingType *string `json:"encodingType" yaml:"encodingType"` // The type of server-side encryption that you want to use for your data. // // This encryption type is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either `SSE_S3` (the default) or `SSE_KMS` . // // > For the `ModifyEndpoint` operation, you can change the existing value of the `EncryptionMode` parameter from `SSE_KMS` to `SSE_S3` . But you can’t change the existing value from `SSE_S3` to `SSE_KMS` . // // To use `SSE_S3` , you need an AWS Identity and Access Management (IAM) role with permission to allow `"arn:aws:s3:::dms-*"` to use the following actions: // // - `s3:CreateBucket` // - `s3:ListBucket` // - `s3:DeleteBucket` // - `s3:GetBucketLocation` // - `s3:GetObject` // - `s3:PutObject` // - `s3:DeleteObject` // - `s3:GetObjectVersion` // - `s3:GetBucketPolicy` // - `s3:PutBucketPolicy` // - `s3:DeleteBucketPolicy` EncryptionMode *string `json:"encryptionMode" yaml:"encryptionMode"` // Not currently supported by AWS CloudFormation . ExternalTableDefinition *string `json:"externalTableDefinition" yaml:"externalTableDefinition"` // When this value is set to 1, AWS DMS ignores the first row header in a .csv file. A value of 1 turns on the feature; a value of 0 turns off the feature. // // The default is 0. IgnoreHeaderRows *float64 `json:"ignoreHeaderRows" yaml:"ignoreHeaderRows"` // A value that enables a full load to write INSERT operations to the comma-separated value (.csv) output files only to indicate how the rows were added to the source database. // // > AWS DMS supports the `IncludeOpForFullLoad` parameter in versions 3.1.4 and later. // // For full load, records can only be inserted. By default (the `false` setting), no information is recorded in these output files for a full load to indicate that the rows were inserted at the source database. If `IncludeOpForFullLoad` is set to `true` or `y` , the INSERT is recorded as an I annotation in the first field of the .csv file. This allows the format of your target records from a full load to be consistent with the target records from a CDC load. // // > This setting works together with the `CdcInsertsOnly` and the `CdcInsertsAndUpdates` parameters for output to .csv files only. For more information about how these settings work together, see [Indicating Source DB Operations in Migrated S3 Data](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the *AWS Database Migration Service User Guide.* . IncludeOpForFullLoad interface{} `json:"includeOpForFullLoad" yaml:"includeOpForFullLoad"` // A value that specifies the maximum size (in KB) of any .csv file to be created while migrating to an S3 target during full load. // // The default value is 1,048,576 KB (1 GB). Valid values include 1 to 1,048,576. MaxFileSize *float64 `json:"maxFileSize" yaml:"maxFileSize"` // A value that specifies the precision of any `TIMESTAMP` column values that are written to an Amazon S3 object file in .parquet format. // // > AWS DMS supports the `ParquetTimestampInMillisecond` parameter in versions 3.1.4 and later. // // When `ParquetTimestampInMillisecond` is set to `true` or `y` , AWS DMS writes all `TIMESTAMP` columns in a .parquet formatted file with millisecond precision. Otherwise, DMS writes them with microsecond precision. // // Currently, Amazon Athena and AWS Glue can handle only millisecond precision for `TIMESTAMP` values. Set this parameter to `true` for S3 endpoint object files that are .parquet formatted only if you plan to query or process the data with Athena or AWS Glue . // // > AWS DMS writes any `TIMESTAMP` column values written to an S3 file in .csv format with microsecond precision. // > // > Setting `ParquetTimestampInMillisecond` has no effect on the string format of the timestamp column value that is inserted by setting the `TimestampColumnName` parameter. ParquetTimestampInMillisecond interface{} `json:"parquetTimestampInMillisecond" yaml:"parquetTimestampInMillisecond"` // The version of the Apache Parquet format that you want to use: `parquet_1_0` (the default) or `parquet_2_0` . ParquetVersion *string `json:"parquetVersion" yaml:"parquetVersion"` // If set to `true` , AWS DMS saves the transaction order for a change data capture (CDC) load on the Amazon S3 target specified by [`CdcPath`](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath) . For more information, see [Capturing data changes (CDC) including transaction order on the S3 target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath) . // // > This setting is supported in AWS DMS versions 3.4.2 and later. PreserveTransactions interface{} `json:"preserveTransactions" yaml:"preserveTransactions"` // For an S3 source, when this value is set to `true` or `y` , each leading double quotation mark has to be followed by an ending double quotation mark. // // This formatting complies with RFC 4180. When this value is set to `false` or `n` , string literals are copied to the target as is. In this case, a delimiter (row or column) signals the end of the field. Thus, you can't use a delimiter as part of the string, because it signals the end of the value. // // For an S3 target, an optional parameter used to set behavior to comply with RFC 4180 for data migrated to Amazon S3 using .csv file format only. When this value is set to `true` or `y` using Amazon S3 as a target, if the data has quotation marks or newline characters in it, AWS DMS encloses the entire column with an additional pair of double quotation marks ("). Every quotation mark within the data is repeated twice. // // The default value is `true` . Valid values include `true` , `false` , `y` , and `n` . Rfc4180 interface{} `json:"rfc4180" yaml:"rfc4180"` // The number of rows in a row group. // // A smaller row group size provides faster reads. But as the number of row groups grows, the slower writes become. This parameter defaults to 10,000 rows. This number is used for .parquet file format only. // // If you choose a value larger than the maximum, `RowGroupLength` is set to the max row group length in bytes (64 * 1024 * 1024). RowGroupLength *float64 `json:"rowGroupLength" yaml:"rowGroupLength"` // If you are using `SSE_KMS` for the `EncryptionMode` , provide the AWS KMS key ID. // // The key that you use needs an attached policy that enables AWS Identity and Access Management (IAM) user permissions and allows use of the key. // // Here is a CLI example: `aws dms create-endpoint --endpoint-identifier *value* --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn= *value* ,BucketFolder= *value* ,BucketName= *value* ,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId= *value*` ServerSideEncryptionKmsKeyId *string `json:"serverSideEncryptionKmsKeyId" yaml:"serverSideEncryptionKmsKeyId"` // Not currently supported by AWS CloudFormation . ServiceAccessRoleArn *string `json:"serviceAccessRoleArn" yaml:"serviceAccessRoleArn"` // A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target. // // > AWS DMS supports the `TimestampColumnName` parameter in versions 3.1.4 and later. // // DMS includes an additional `STRING` column in the .csv or .parquet object files of your migrated data when you set `TimestampColumnName` to a nonblank value. // // For a full load, each row of this timestamp column contains a timestamp for when the data was transferred from the source to the target by DMS. // // For a change data capture (CDC) load, each row of the timestamp column contains the timestamp for the commit of that row in the source database. // // The string format for this timestamp column value is `yyyy-MM-dd HH:mm:ss.SSSSSS` . By default, the precision of this value is in microseconds. For a CDC load, the rounding of the precision depends on the commit timestamp supported by DMS for the source database. // // When the `AddColumnName` parameter is set to `true` , DMS also includes a name for the timestamp column that you set with `TimestampColumnName` . TimestampColumnName *string `json:"timestampColumnName" yaml:"timestampColumnName"` // This setting applies if the S3 output files during a change data capture (CDC) load are written in .csv format. If set to `true` for columns not included in the supplemental log, AWS DMS uses the value specified by [`CsvNoSupValue`](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue) . If not set or set to `false` , AWS DMS uses the null value for these columns. // // > This setting is supported in AWS DMS versions 3.4.1 and later. UseCsvNoSupValue interface{} `json:"useCsvNoSupValue" yaml:"useCsvNoSupValue"` // When set to true, this parameter uses the task start time as the timestamp column value instead of the time data is written to target. // // For full load, when `useTaskStartTimeForFullLoadTimestamp` is set to `true` , each row of the timestamp column contains the task start time. For CDC loads, each row of the timestamp column contains the transaction commit time. // // When `useTaskStartTimeForFullLoadTimestamp` is set to `false` , the full load timestamp in the timestamp column increments with the time data arrives at the target. UseTaskStartTimeForFullLoadTimestamp interface{} `json:"useTaskStartTimeForFullLoadTimestamp" yaml:"useTaskStartTimeForFullLoadTimestamp"` }
Not currently supported by AWS CloudFormation .
TODO: EXAMPLE
type CfnEndpoint_SybaseSettingsProperty ¶
type CfnEndpoint_SybaseSettingsProperty struct { // Not currently supported by AWS CloudFormation . SecretsManagerAccessRoleArn *string `json:"secretsManagerAccessRoleArn" yaml:"secretsManagerAccessRoleArn"` // Not currently supported by AWS CloudFormation . SecretsManagerSecretId *string `json:"secretsManagerSecretId" yaml:"secretsManagerSecretId"` }
Not currently supported by AWS CloudFormation .
TODO: EXAMPLE
type CfnEventSubscription ¶
type CfnEventSubscription interface { awscdk.CfnResource awscdk.IInspectable CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string CreationStack() *[]*string Enabled() interface{} SetEnabled(val interface{}) EventCategories() *[]*string SetEventCategories(val *[]*string) LogicalId() *string Node() constructs.Node Ref() *string SnsTopicArn() *string SetSnsTopicArn(val *string) SourceIds() *[]*string SetSourceIds(val *[]*string) SourceType() *string SetSourceType(val *string) Stack() awscdk.Stack SubscriptionName() *string SetSubscriptionName(val *string) Tags() awscdk.TagManager UpdatedProperites() *map[string]interface{} AddDeletionOverride(path *string) AddDependsOn(target awscdk.CfnResource) AddMetadata(key *string, value interface{}) AddOverride(path *string, value interface{}) AddPropertyDeletionOverride(propertyPath *string) AddPropertyOverride(propertyPath *string, value interface{}) ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) GetAtt(attributeName *string) awscdk.Reference GetMetadata(key *string) interface{} Inspect(inspector awscdk.TreeInspector) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::DMS::EventSubscription`.
Use the `AWS::DMS::EventSubscription` resource to get notifications for AWS Database Migration Service events through the Amazon Simple Notification Service. For more information, see [Using AWS DMS Event Notification](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) in the *AWS Database Migration Service User Guide.*
TODO: EXAMPLE
func NewCfnEventSubscription ¶
func NewCfnEventSubscription(scope constructs.Construct, id *string, props *CfnEventSubscriptionProps) CfnEventSubscription
Create a new `AWS::DMS::EventSubscription`.
type CfnEventSubscriptionProps ¶
type CfnEventSubscriptionProps struct { // The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. // // The ARN is created by Amazon SNS when you create a topic and subscribe to it. SnsTopicArn *string `json:"snsTopicArn" yaml:"snsTopicArn"` // Indicates whether to activate the subscription. // // If you don't specify this property, AWS CloudFormation activates the subscription. Enabled interface{} `json:"enabled" yaml:"enabled"` // A list of event categories for a source type that you want to subscribe to. // // If you don't specify this property, you are notified about all event categories. For more information, see [Working with Events and Notifications](https://docs.aws.amazon.com//dms/latest/userguide/CHAP_Events.html) in the *AWS DMS User Guide* . EventCategories *[]*string `json:"eventCategories" yaml:"eventCategories"` // A list of identifiers for which AWS DMS provides notification events. // // If you don't specify a value, notifications are provided for all sources. // // If you specify multiple values, they must be of the same type. For example, if you specify a database instance ID, then all of the other values must be database instance IDs. SourceIds *[]*string `json:"sourceIds" yaml:"sourceIds"` // The type of AWS DMS resource that generates the events. // // For example, if you want to be notified of events generated by a replication instance, you set this parameter to `replication-instance` . If this value isn't specified, all events are returned. // // Valid values: `replication-instance` | `replication-task` SourceType *string `json:"sourceType" yaml:"sourceType"` // The name of the AWS DMS event notification subscription. // // This name must be less than 255 characters. SubscriptionName *string `json:"subscriptionName" yaml:"subscriptionName"` // One or more tags to be assigned to the event subscription. Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"` }
Properties for defining a `CfnEventSubscription`.
TODO: EXAMPLE
type CfnReplicationInstance ¶
type CfnReplicationInstance interface { awscdk.CfnResource awscdk.IInspectable AllocatedStorage() *float64 SetAllocatedStorage(val *float64) AllowMajorVersionUpgrade() interface{} SetAllowMajorVersionUpgrade(val interface{}) AttrReplicationInstancePrivateIpAddresses() *[]*string AttrReplicationInstancePublicIpAddresses() *[]*string AutoMinorVersionUpgrade() interface{} SetAutoMinorVersionUpgrade(val interface{}) AvailabilityZone() *string SetAvailabilityZone(val *string) CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string CreationStack() *[]*string EngineVersion() *string SetEngineVersion(val *string) KmsKeyId() *string SetKmsKeyId(val *string) LogicalId() *string MultiAz() interface{} SetMultiAz(val interface{}) Node() constructs.Node PreferredMaintenanceWindow() *string SetPreferredMaintenanceWindow(val *string) PubliclyAccessible() interface{} SetPubliclyAccessible(val interface{}) Ref() *string ReplicationInstanceClass() *string SetReplicationInstanceClass(val *string) ReplicationInstanceIdentifier() *string SetReplicationInstanceIdentifier(val *string) ReplicationSubnetGroupIdentifier() *string SetReplicationSubnetGroupIdentifier(val *string) ResourceIdentifier() *string SetResourceIdentifier(val *string) Stack() awscdk.Stack Tags() awscdk.TagManager UpdatedProperites() *map[string]interface{} VpcSecurityGroupIds() *[]*string SetVpcSecurityGroupIds(val *[]*string) AddDeletionOverride(path *string) AddDependsOn(target awscdk.CfnResource) AddMetadata(key *string, value interface{}) AddOverride(path *string, value interface{}) AddPropertyDeletionOverride(propertyPath *string) AddPropertyOverride(propertyPath *string, value interface{}) ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) GetAtt(attributeName *string) awscdk.Reference GetMetadata(key *string) interface{} Inspect(inspector awscdk.TreeInspector) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::DMS::ReplicationInstance`.
The `AWS::DMS::ReplicationInstance` resource creates an AWS DMS replication instance.
TODO: EXAMPLE
func NewCfnReplicationInstance ¶
func NewCfnReplicationInstance(scope constructs.Construct, id *string, props *CfnReplicationInstanceProps) CfnReplicationInstance
Create a new `AWS::DMS::ReplicationInstance`.
type CfnReplicationInstanceProps ¶
type CfnReplicationInstanceProps struct { // The compute and memory capacity of the replication instance as defined for the specified replication instance class. // // For example to specify the instance class dms.c4.large, set this parameter to `"dms.c4.large"` . // // For more information on the settings and capacities for the available replication instance classes, see [Selecting the right AWS DMS replication instance for your migration](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth) . ReplicationInstanceClass *string `json:"replicationInstanceClass" yaml:"replicationInstanceClass"` // The amount of storage (in gigabytes) to be initially allocated for the replication instance. AllocatedStorage *float64 `json:"allocatedStorage" yaml:"allocatedStorage"` // Indicates that major version upgrades are allowed. // // Changing this parameter does not result in an outage, and the change is asynchronously applied as soon as possible. // // This parameter must be set to `true` when specifying a value for the `EngineVersion` parameter that is a different major version than the replication instance's current version. AllowMajorVersionUpgrade interface{} `json:"allowMajorVersionUpgrade" yaml:"allowMajorVersionUpgrade"` // A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window. // // This parameter defaults to `true` . // // Default: `true` AutoMinorVersionUpgrade interface{} `json:"autoMinorVersionUpgrade" yaml:"autoMinorVersionUpgrade"` // The Availability Zone that the replication instance will be created in. // // The default value is a random, system-chosen Availability Zone in the endpoint's AWS Region , for example: `us-east-1d` AvailabilityZone *string `json:"availabilityZone" yaml:"availabilityZone"` // The engine version number of the replication instance. // // If an engine version number is not specified when a replication instance is created, the default is the latest engine version available. EngineVersion *string `json:"engineVersion" yaml:"engineVersion"` // An AWS KMS key identifier that is used to encrypt the data on the replication instance. // // If you don't specify a value for the `KmsKeyId` parameter, then AWS DMS uses your default encryption key. // // AWS KMS creates the default encryption key for your AWS account . Your AWS account has a different default encryption key for each AWS Region . KmsKeyId *string `json:"kmsKeyId" yaml:"kmsKeyId"` // Specifies whether the replication instance is a Multi-AZ deployment. // // You can't set the `AvailabilityZone` parameter if the Multi-AZ parameter is set to `true` . MultiAz interface{} `json:"multiAz" yaml:"multiAz"` // The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). // // Format: `ddd:hh24:mi-ddd:hh24:mi` // // Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region , occurring on a random day of the week. // // Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun // // Constraints: Minimum 30-minute window. PreferredMaintenanceWindow *string `json:"preferredMaintenanceWindow" yaml:"preferredMaintenanceWindow"` // Specifies the accessibility options for the replication instance. // // A value of `true` represents an instance with a public IP address. A value of `false` represents an instance with a private IP address. The default value is `true` . PubliclyAccessible interface{} `json:"publiclyAccessible" yaml:"publiclyAccessible"` // The replication instance identifier. This parameter is stored as a lowercase string. // // Constraints: // // - Must contain 1-63 alphanumeric characters or hyphens. // - First character must be a letter. // - Can't end with a hyphen or contain two consecutive hyphens. // // Example: `myrepinstance` ReplicationInstanceIdentifier *string `json:"replicationInstanceIdentifier" yaml:"replicationInstanceIdentifier"` // A subnet group to associate with the replication instance. ReplicationSubnetGroupIdentifier *string `json:"replicationSubnetGroupIdentifier" yaml:"replicationSubnetGroupIdentifier"` // A friendly name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object. // // The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as `Example-App-ARN1` . For example, this value might result in the `EndpointArn` value `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1` . If you don't specify a `ResourceIdentifier` value, AWS DMS generates a default identifier value for the end of `EndpointArn` . ResourceIdentifier *string `json:"resourceIdentifier" yaml:"resourceIdentifier"` // One or more tags to be assigned to the replication instance. Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"` // Specifies the VPC security group to be used with the replication instance. // // The VPC security group must work with the VPC containing the replication instance. VpcSecurityGroupIds *[]*string `json:"vpcSecurityGroupIds" yaml:"vpcSecurityGroupIds"` }
Properties for defining a `CfnReplicationInstance`.
TODO: EXAMPLE
type CfnReplicationSubnetGroup ¶
type CfnReplicationSubnetGroup interface { awscdk.CfnResource awscdk.IInspectable CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string CreationStack() *[]*string LogicalId() *string Node() constructs.Node Ref() *string ReplicationSubnetGroupDescription() *string SetReplicationSubnetGroupDescription(val *string) ReplicationSubnetGroupIdentifier() *string SetReplicationSubnetGroupIdentifier(val *string) Stack() awscdk.Stack SubnetIds() *[]*string SetSubnetIds(val *[]*string) Tags() awscdk.TagManager UpdatedProperites() *map[string]interface{} AddDeletionOverride(path *string) AddDependsOn(target awscdk.CfnResource) AddMetadata(key *string, value interface{}) AddOverride(path *string, value interface{}) AddPropertyDeletionOverride(propertyPath *string) AddPropertyOverride(propertyPath *string, value interface{}) ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) GetAtt(attributeName *string) awscdk.Reference GetMetadata(key *string) interface{} Inspect(inspector awscdk.TreeInspector) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::DMS::ReplicationSubnetGroup`.
The `AWS::DMS::ReplicationSubnetGroup` resource creates an AWS DMS replication subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region.
> Resource creation will fail if the `dms-vpc-role` IAM role doesn't already exist. For more information, see [Creating the IAM Roles to Use With the AWS CLI and AWS DMS API](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.APIRole.html) in the *AWS Database Migration Service User Guide.*
TODO: EXAMPLE
func NewCfnReplicationSubnetGroup ¶
func NewCfnReplicationSubnetGroup(scope constructs.Construct, id *string, props *CfnReplicationSubnetGroupProps) CfnReplicationSubnetGroup
Create a new `AWS::DMS::ReplicationSubnetGroup`.
type CfnReplicationSubnetGroupProps ¶
type CfnReplicationSubnetGroupProps struct { // The description for the subnet group. ReplicationSubnetGroupDescription *string `json:"replicationSubnetGroupDescription" yaml:"replicationSubnetGroupDescription"` // One or more subnet IDs to be assigned to the subnet group. SubnetIds *[]*string `json:"subnetIds" yaml:"subnetIds"` // The identifier for the replication subnet group. // // If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the identifier. ReplicationSubnetGroupIdentifier *string `json:"replicationSubnetGroupIdentifier" yaml:"replicationSubnetGroupIdentifier"` // One or more tags to be assigned to the subnet group. Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"` }
Properties for defining a `CfnReplicationSubnetGroup`.
TODO: EXAMPLE
type CfnReplicationTask ¶
type CfnReplicationTask interface { awscdk.CfnResource awscdk.IInspectable CdcStartPosition() *string SetCdcStartPosition(val *string) CdcStartTime() *float64 SetCdcStartTime(val *float64) CdcStopPosition() *string SetCdcStopPosition(val *string) CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string CreationStack() *[]*string LogicalId() *string MigrationType() *string SetMigrationType(val *string) Node() constructs.Node Ref() *string ReplicationInstanceArn() *string SetReplicationInstanceArn(val *string) ReplicationTaskIdentifier() *string SetReplicationTaskIdentifier(val *string) ReplicationTaskSettings() *string SetReplicationTaskSettings(val *string) ResourceIdentifier() *string SetResourceIdentifier(val *string) SourceEndpointArn() *string SetSourceEndpointArn(val *string) Stack() awscdk.Stack TableMappings() *string SetTableMappings(val *string) Tags() awscdk.TagManager TargetEndpointArn() *string SetTargetEndpointArn(val *string) TaskData() *string SetTaskData(val *string) UpdatedProperites() *map[string]interface{} AddDeletionOverride(path *string) AddDependsOn(target awscdk.CfnResource) AddMetadata(key *string, value interface{}) AddOverride(path *string, value interface{}) AddPropertyDeletionOverride(propertyPath *string) AddPropertyOverride(propertyPath *string, value interface{}) ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) GetAtt(attributeName *string) awscdk.Reference GetMetadata(key *string) interface{} Inspect(inspector awscdk.TreeInspector) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::DMS::ReplicationTask`.
The `AWS::DMS::ReplicationTask` resource creates an AWS DMS replication task.
TODO: EXAMPLE
func NewCfnReplicationTask ¶
func NewCfnReplicationTask(scope constructs.Construct, id *string, props *CfnReplicationTaskProps) CfnReplicationTask
Create a new `AWS::DMS::ReplicationTask`.
type CfnReplicationTaskProps ¶
type CfnReplicationTaskProps struct { // The migration type. // // Valid values: `full-load` | `cdc` | `full-load-and-cdc` MigrationType *string `json:"migrationType" yaml:"migrationType"` // The Amazon Resource Name (ARN) of a replication instance. ReplicationInstanceArn *string `json:"replicationInstanceArn" yaml:"replicationInstanceArn"` // An Amazon Resource Name (ARN) that uniquely identifies the source endpoint. SourceEndpointArn *string `json:"sourceEndpointArn" yaml:"sourceEndpointArn"` // The table mappings for the task, in JSON format. // // For more information, see [Using Table Mapping to Specify Task Settings](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.html) in the *AWS Database Migration Service User Guide.* TableMappings *string `json:"tableMappings" yaml:"tableMappings"` // An Amazon Resource Name (ARN) that uniquely identifies the target endpoint. TargetEndpointArn *string `json:"targetEndpointArn" yaml:"targetEndpointArn"` // Indicates when you want a change data capture (CDC) operation to start. // // Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error. // // The value can be in date, checkpoint, or LSN/SCN format. // // Date Example: --cdc-start-position “2018-03-08T12:12:12” // // Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93" // // LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373” // // > When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the `slotName` extra connection attribute to the name of this logical replication slot. For more information, see [Extra Connection Attributes When Using PostgreSQL as a Source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib) . CdcStartPosition *string `json:"cdcStartPosition" yaml:"cdcStartPosition"` // Indicates the start time for a change data capture (CDC) operation. CdcStartTime *float64 `json:"cdcStartTime" yaml:"cdcStartTime"` // Indicates when you want a change data capture (CDC) operation to stop. // // The value can be either server time or commit time. // // Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12” // // Commit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12 “ CdcStopPosition *string `json:"cdcStopPosition" yaml:"cdcStopPosition"` // An identifier for the replication task. // // Constraints: // // - Must contain 1-255 alphanumeric characters or hyphens. // - First character must be a letter. // - Cannot end with a hyphen or contain two consecutive hyphens. ReplicationTaskIdentifier *string `json:"replicationTaskIdentifier" yaml:"replicationTaskIdentifier"` // Overall settings for the task, in JSON format. // // For more information, see [Specifying Task Settings for AWS Database Migration Service Tasks](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.html) in the *AWS Database Migration Service User Guide.* ReplicationTaskSettings *string `json:"replicationTaskSettings" yaml:"replicationTaskSettings"` // A friendly name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object. // // The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as `Example-App-ARN1` . For example, this value might result in the `EndpointArn` value `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1` . If you don't specify a `ResourceIdentifier` value, AWS DMS generates a default identifier value for the end of `EndpointArn` . ResourceIdentifier *string `json:"resourceIdentifier" yaml:"resourceIdentifier"` // One or more tags to be assigned to the replication task. Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"` // `AWS::DMS::ReplicationTask.TaskData`. TaskData *string `json:"taskData" yaml:"taskData"` }
Properties for defining a `CfnReplicationTask`.
TODO: EXAMPLE