Documentation
¶
Index ¶
- func CfnCertificate_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCertificate_IsCfnElement(x interface{}) *bool
- func CfnCertificate_IsCfnResource(x interface{}) *bool
- func CfnCertificate_IsConstruct(x interface{}) *bool
- func CfnDataProvider_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDataProvider_IsCfnElement(x interface{}) *bool
- func CfnDataProvider_IsCfnResource(x interface{}) *bool
- func CfnDataProvider_IsConstruct(x interface{}) *bool
- func CfnEndpoint_CFN_RESOURCE_TYPE_NAME() *string
- func CfnEndpoint_IsCfnElement(x interface{}) *bool
- func CfnEndpoint_IsCfnResource(x interface{}) *bool
- func CfnEndpoint_IsConstruct(x interface{}) *bool
- func CfnEventSubscription_CFN_RESOURCE_TYPE_NAME() *string
- func CfnEventSubscription_IsCfnElement(x interface{}) *bool
- func CfnEventSubscription_IsCfnResource(x interface{}) *bool
- func CfnEventSubscription_IsConstruct(x interface{}) *bool
- func CfnInstanceProfile_CFN_RESOURCE_TYPE_NAME() *string
- func CfnInstanceProfile_IsCfnElement(x interface{}) *bool
- func CfnInstanceProfile_IsCfnResource(x interface{}) *bool
- func CfnInstanceProfile_IsConstruct(x interface{}) *bool
- func CfnMigrationProject_CFN_RESOURCE_TYPE_NAME() *string
- func CfnMigrationProject_IsCfnElement(x interface{}) *bool
- func CfnMigrationProject_IsCfnResource(x interface{}) *bool
- func CfnMigrationProject_IsConstruct(x interface{}) *bool
- func CfnReplicationConfig_CFN_RESOURCE_TYPE_NAME() *string
- func CfnReplicationConfig_IsCfnElement(x interface{}) *bool
- func CfnReplicationConfig_IsCfnResource(x interface{}) *bool
- func CfnReplicationConfig_IsConstruct(x interface{}) *bool
- func CfnReplicationInstance_CFN_RESOURCE_TYPE_NAME() *string
- func CfnReplicationInstance_IsCfnElement(x interface{}) *bool
- func CfnReplicationInstance_IsCfnResource(x interface{}) *bool
- func CfnReplicationInstance_IsConstruct(x interface{}) *bool
- func CfnReplicationSubnetGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnReplicationSubnetGroup_IsCfnElement(x interface{}) *bool
- func CfnReplicationSubnetGroup_IsCfnResource(x interface{}) *bool
- func CfnReplicationSubnetGroup_IsConstruct(x interface{}) *bool
- func CfnReplicationTask_CFN_RESOURCE_TYPE_NAME() *string
- func CfnReplicationTask_IsCfnElement(x interface{}) *bool
- func CfnReplicationTask_IsCfnResource(x interface{}) *bool
- func CfnReplicationTask_IsConstruct(x interface{}) *bool
- func NewCfnCertificate_Override(c CfnCertificate, scope constructs.Construct, id *string, ...)
- func NewCfnDataProvider_Override(c CfnDataProvider, 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 NewCfnInstanceProfile_Override(c CfnInstanceProfile, scope constructs.Construct, id *string, ...)
- func NewCfnMigrationProject_Override(c CfnMigrationProject, scope constructs.Construct, id *string, ...)
- func NewCfnReplicationConfig_Override(c CfnReplicationConfig, 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 CfnDataProvider
- type CfnDataProviderProps
- 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 CfnInstanceProfile
- type CfnInstanceProfileProps
- type CfnMigrationProject
- type CfnMigrationProjectProps
- type CfnMigrationProject_DataProviderDescriptorProperty
- type CfnMigrationProject_SchemaConversionApplicationAttributesProperty
- type CfnReplicationConfig
- type CfnReplicationConfigProps
- type CfnReplicationConfig_ComputeConfigProperty
- 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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnCertificate_IsConstruct ¶
func CfnCertificate_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnDataProvider_CFN_RESOURCE_TYPE_NAME ¶ added in v2.115.0
func CfnDataProvider_CFN_RESOURCE_TYPE_NAME() *string
func CfnDataProvider_IsCfnElement ¶ added in v2.115.0
func CfnDataProvider_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 CfnDataProvider_IsCfnResource ¶ added in v2.115.0
func CfnDataProvider_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnDataProvider_IsConstruct ¶ added in v2.115.0
func CfnDataProvider_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnEndpoint_IsConstruct ¶
func CfnEndpoint_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnEventSubscription_IsConstruct ¶
func CfnEventSubscription_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnInstanceProfile_CFN_RESOURCE_TYPE_NAME ¶ added in v2.115.0
func CfnInstanceProfile_CFN_RESOURCE_TYPE_NAME() *string
func CfnInstanceProfile_IsCfnElement ¶ added in v2.115.0
func CfnInstanceProfile_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 CfnInstanceProfile_IsCfnResource ¶ added in v2.115.0
func CfnInstanceProfile_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnInstanceProfile_IsConstruct ¶ added in v2.115.0
func CfnInstanceProfile_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnMigrationProject_CFN_RESOURCE_TYPE_NAME ¶ added in v2.115.0
func CfnMigrationProject_CFN_RESOURCE_TYPE_NAME() *string
func CfnMigrationProject_IsCfnElement ¶ added in v2.115.0
func CfnMigrationProject_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 CfnMigrationProject_IsCfnResource ¶ added in v2.115.0
func CfnMigrationProject_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnMigrationProject_IsConstruct ¶ added in v2.115.0
func CfnMigrationProject_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnReplicationConfig_CFN_RESOURCE_TYPE_NAME ¶ added in v2.91.0
func CfnReplicationConfig_CFN_RESOURCE_TYPE_NAME() *string
func CfnReplicationConfig_IsCfnElement ¶ added in v2.91.0
func CfnReplicationConfig_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 CfnReplicationConfig_IsCfnResource ¶ added in v2.91.0
func CfnReplicationConfig_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnReplicationConfig_IsConstruct ¶ added in v2.91.0
func CfnReplicationConfig_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnReplicationInstance_IsConstruct ¶
func CfnReplicationInstance_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnReplicationSubnetGroup_IsConstruct ¶
func CfnReplicationSubnetGroup_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnReplicationTask_IsConstruct ¶
func CfnReplicationTask_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnCertificate_Override ¶
func NewCfnCertificate_Override(c CfnCertificate, scope constructs.Construct, id *string, props *CfnCertificateProps)
func NewCfnDataProvider_Override ¶ added in v2.115.0
func NewCfnDataProvider_Override(c CfnDataProvider, scope constructs.Construct, id *string, props *CfnDataProviderProps)
func NewCfnEndpoint_Override ¶
func NewCfnEndpoint_Override(c CfnEndpoint, scope constructs.Construct, id *string, props *CfnEndpointProps)
func NewCfnEventSubscription_Override ¶
func NewCfnEventSubscription_Override(c CfnEventSubscription, scope constructs.Construct, id *string, props *CfnEventSubscriptionProps)
func NewCfnInstanceProfile_Override ¶ added in v2.115.0
func NewCfnInstanceProfile_Override(c CfnInstanceProfile, scope constructs.Construct, id *string, props *CfnInstanceProfileProps)
func NewCfnMigrationProject_Override ¶ added in v2.115.0
func NewCfnMigrationProject_Override(c CfnMigrationProject, scope constructs.Construct, id *string, props *CfnMigrationProjectProps)
func NewCfnReplicationConfig_Override ¶ added in v2.91.0
func NewCfnReplicationConfig_Override(c CfnReplicationConfig, scope constructs.Construct, id *string, props *CfnReplicationConfigProps)
func NewCfnReplicationInstance_Override ¶
func NewCfnReplicationInstance_Override(c CfnReplicationInstance, scope constructs.Construct, id *string, props *CfnReplicationInstanceProps)
func NewCfnReplicationSubnetGroup_Override ¶
func NewCfnReplicationSubnetGroup_Override(c CfnReplicationSubnetGroup, scope constructs.Construct, id *string, props *CfnReplicationSubnetGroupProps)
func NewCfnReplicationTask_Override ¶
func NewCfnReplicationTask_Override(c CfnReplicationTask, scope constructs.Construct, id *string, props *CfnReplicationTaskProps)
Types ¶
type CfnCertificate ¶
type CfnCertificate interface { awscdk.CfnResource awscdk.IInspectable AttrId() *string // A customer-assigned name for the certificate. CertificateIdentifier() *string SetCertificateIdentifier(val *string) // The contents of a `.pem` file, which contains an X.509 certificate. CertificatePem() *string SetCertificatePem(val *string) // The location of an imported Oracle Wallet certificate for use with SSL. CertificateWallet() *string SetCertificateWallet(val *string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
The `AWS::DMS::Certificate` resource creates an Secure Sockets Layer (SSL) certificate that encrypts connections between AWS DMS endpoints and the replication instance.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnCertificate := awscdk.Aws_dms.NewCfnCertificate(this, jsii.String("MyCfnCertificate"), &CfnCertificateProps{ CertificateIdentifier: jsii.String("certificateIdentifier"), CertificatePem: jsii.String("certificatePem"), CertificateWallet: jsii.String("certificateWallet"), })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-certificate.html
func NewCfnCertificate ¶
func NewCfnCertificate(scope constructs.Construct, id *string, props *CfnCertificateProps) CfnCertificate
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-certificate.html#cfn-dms-certificate-certificateidentifier // CertificateIdentifier *string `field:"optional" json:"certificateIdentifier" yaml:"certificateIdentifier"` // The contents of a `.pem` file, which contains an X.509 certificate. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-certificate.html#cfn-dms-certificate-certificatepem // CertificatePem *string `field:"optional" json:"certificatePem" yaml:"certificatePem"` // The location of an imported Oracle Wallet certificate for use with SSL. // // An example is: `filebase64("${path.root}/rds-ca-2019-root.sso")` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-certificate.html#cfn-dms-certificate-certificatewallet // CertificateWallet *string `field:"optional" json:"certificateWallet" yaml:"certificateWallet"` }
Properties for defining a `CfnCertificate`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnCertificateProps := &CfnCertificateProps{ CertificateIdentifier: jsii.String("certificateIdentifier"), CertificatePem: jsii.String("certificatePem"), CertificateWallet: jsii.String("certificateWallet"), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-certificate.html
type CfnDataProvider ¶ added in v2.115.0
type CfnDataProvider interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 // The Amazon Resource Name (ARN) string that uniquely identifies the data provider. AttrDataProviderArn() *string // The time the data provider was created. AttrDataProviderCreationTime() *string // Tag Manager which manages the tags for this resource. CdkTagManager() awscdk.TagManager // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The identifier of the data provider. DataProviderIdentifier() *string SetDataProviderIdentifier(val *string) // The name of the data provider. DataProviderName() *string SetDataProviderName(val *string) // A description of the data provider. Description() *string SetDescription(val *string) // The type of database engine for the data provider. Engine() *string SetEngine(val *string) // The property describes the exact settings which can be modified. ExactSettings() interface{} SetExactSettings(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // An array of key-value pairs to apply to this resource. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Provides information that defines a data provider.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnDataProvider := awscdk.Aws_dms.NewCfnDataProvider(this, jsii.String("MyCfnDataProvider"), &CfnDataProviderProps{ Engine: jsii.String("engine"), // the properties below are optional DataProviderIdentifier: jsii.String("dataProviderIdentifier"), DataProviderName: jsii.String("dataProviderName"), Description: jsii.String("description"), ExactSettings: jsii.Boolean(false), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html
func NewCfnDataProvider ¶ added in v2.115.0
func NewCfnDataProvider(scope constructs.Construct, id *string, props *CfnDataProviderProps) CfnDataProvider
type CfnDataProviderProps ¶ added in v2.115.0
type CfnDataProviderProps struct { // The type of database engine for the data provider. // // Valid values include `"aurora"` , `"aurora-postgresql"` , `"mysql"` , `"oracle"` , `"postgres"` , `"sqlserver"` , `redshift` , `mariadb` , `mongodb` , and `docdb` . A value of `"aurora"` represents Amazon Aurora MySQL-Compatible Edition. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html#cfn-dms-dataprovider-engine // Engine *string `field:"required" json:"engine" yaml:"engine"` // The identifier of the data provider. // // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html#cfn-dms-dataprovider-dataprovideridentifier // DataProviderIdentifier *string `field:"optional" json:"dataProviderIdentifier" yaml:"dataProviderIdentifier"` // The name of the data provider. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html#cfn-dms-dataprovider-dataprovidername // DataProviderName *string `field:"optional" json:"dataProviderName" yaml:"dataProviderName"` // A description of the data provider. // // Descriptions can have up to 31 characters. A description can contain only ASCII letters, digits, and hyphens ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html#cfn-dms-dataprovider-description // Description *string `field:"optional" json:"description" yaml:"description"` // The property describes the exact settings which can be modified. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html#cfn-dms-dataprovider-exactsettings // // Default: - false. // ExactSettings interface{} `field:"optional" json:"exactSettings" yaml:"exactSettings"` // An array of key-value pairs to apply to this resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html#cfn-dms-dataprovider-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnDataProvider`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnDataProviderProps := &CfnDataProviderProps{ Engine: jsii.String("engine"), // the properties below are optional DataProviderIdentifier: jsii.String("dataProviderIdentifier"), DataProviderName: jsii.String("dataProviderName"), Description: jsii.String("description"), ExactSettings: jsii.Boolean(false), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html
type CfnEndpoint ¶
type CfnEndpoint interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // A value that can be used for cross-account validation. AttrExternalId() *string AttrId() *string // The Amazon Resource Name (ARN) for the certificate. CertificateArn() *string SetCertificateArn(val *string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The name of the endpoint database. DatabaseName() *string SetDatabaseName(val *string) // Settings in JSON format for the source and target DocumentDB endpoint. DocDbSettings() interface{} SetDocDbSettings(val interface{}) // Settings in JSON format for the target Amazon DynamoDB endpoint. DynamoDbSettings() interface{} SetDynamoDbSettings(val interface{}) // Settings in JSON format for the target OpenSearch endpoint. ElasticsearchSettings() interface{} SetElasticsearchSettings(val interface{}) // The database endpoint identifier. EndpointIdentifier() *string SetEndpointIdentifier(val *string) // The type of endpoint. EndpointType() *string SetEndpointType(val *string) // The type of engine for the endpoint, depending on the `EndpointType` value. EngineName() *string SetEngineName(val *string) // Additional attributes associated with the connection. ExtraConnectionAttributes() *string SetExtraConnectionAttributes(val *string) // Settings in JSON format for the source GCP MySQL endpoint. GcpMySqlSettings() interface{} SetGcpMySqlSettings(val interface{}) // Settings in JSON format for the source IBM Db2 LUW endpoint. IbmDb2Settings() interface{} SetIbmDb2Settings(val interface{}) // Settings in JSON format for the target Apache Kafka endpoint. KafkaSettings() interface{} SetKafkaSettings(val interface{}) // Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. KinesisSettings() interface{} SetKinesisSettings(val interface{}) // An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint. KmsKeyId() *string SetKmsKeyId(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // Settings in JSON format for the source and target Microsoft SQL Server endpoint. MicrosoftSqlServerSettings() interface{} SetMicrosoftSqlServerSettings(val interface{}) // Settings in JSON format for the source MongoDB endpoint. MongoDbSettings() interface{} SetMongoDbSettings(val interface{}) // Settings in JSON format for the source and target MySQL endpoint. MySqlSettings() interface{} SetMySqlSettings(val interface{}) // Settings in JSON format for the target Amazon Neptune endpoint. NeptuneSettings() interface{} SetNeptuneSettings(val interface{}) // The tree node. Node() constructs.Node // Settings in JSON format for the source and target Oracle endpoint. OracleSettings() interface{} SetOracleSettings(val interface{}) // The password to be used to log in to the endpoint database. Password() *string SetPassword(val *string) // The port used by the endpoint database. Port() *float64 SetPort(val *float64) // Settings in JSON format for the source and target PostgreSQL endpoint. PostgreSqlSettings() interface{} SetPostgreSqlSettings(val interface{}) // Settings in JSON format for the target Redis endpoint. RedisSettings() interface{} SetRedisSettings(val interface{}) // Settings in JSON format for the Amazon Redshift endpoint. RedshiftSettings() interface{} SetRedshiftSettings(val interface{}) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // A display name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object. ResourceIdentifier() *string SetResourceIdentifier(val *string) // Settings in JSON format for the source and target Amazon S3 endpoint. S3Settings() interface{} SetS3Settings(val interface{}) // The name of the server where the endpoint database resides. ServerName() *string SetServerName(val *string) // The Secure Sockets Layer (SSL) mode to use for the SSL connection. // // The default is `none` . SslMode() *string SetSslMode(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Settings in JSON format for the source and target SAP ASE endpoint. SybaseSettings() interface{} SetSybaseSettings(val interface{}) // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // One or more tags to be assigned to the endpoint. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The user name to be used to log in to the endpoint database. Username() *string SetUsername(val *string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
The `AWS::DMS::Endpoint` resource specifies an AWS DMS endpoint.
Currently, AWS CloudFormation supports all AWS DMS endpoint types.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnEndpoint := awscdk.Aws_dms.NewCfnEndpoint(this, jsii.String("MyCfnEndpoint"), &CfnEndpointProps{ EndpointType: jsii.String("endpointType"), EngineName: jsii.String("engineName"), // the properties below are optional CertificateArn: jsii.String("certificateArn"), DatabaseName: jsii.String("databaseName"), DocDbSettings: &DocDbSettingsProperty{ DocsToInvestigate: jsii.Number(123), ExtractDocId: jsii.Boolean(false), NestingLevel: jsii.String("nestingLevel"), SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), }, DynamoDbSettings: &DynamoDbSettingsProperty{ ServiceAccessRoleArn: jsii.String("serviceAccessRoleArn"), }, ElasticsearchSettings: &ElasticsearchSettingsProperty{ EndpointUri: jsii.String("endpointUri"), ErrorRetryDuration: jsii.Number(123), FullLoadErrorPercentage: jsii.Number(123), ServiceAccessRoleArn: jsii.String("serviceAccessRoleArn"), }, EndpointIdentifier: jsii.String("endpointIdentifier"), ExtraConnectionAttributes: jsii.String("extraConnectionAttributes"), GcpMySqlSettings: &GcpMySQLSettingsProperty{ AfterConnectScript: jsii.String("afterConnectScript"), CleanSourceMetadataOnMismatch: jsii.Boolean(false), DatabaseName: jsii.String("databaseName"), EventsPollInterval: jsii.Number(123), MaxFileSize: jsii.Number(123), ParallelLoadThreads: jsii.Number(123), Password: jsii.String("password"), Port: jsii.Number(123), SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), ServerName: jsii.String("serverName"), ServerTimezone: jsii.String("serverTimezone"), Username: jsii.String("username"), }, IbmDb2Settings: &IbmDb2SettingsProperty{ CurrentLsn: jsii.String("currentLsn"), KeepCsvFiles: jsii.Boolean(false), LoadTimeout: jsii.Number(123), MaxFileSize: jsii.Number(123), MaxKBytesPerRead: jsii.Number(123), SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), SetDataCaptureChanges: jsii.Boolean(false), WriteBufferSize: jsii.Number(123), }, KafkaSettings: &KafkaSettingsProperty{ Broker: jsii.String("broker"), IncludeControlDetails: jsii.Boolean(false), IncludeNullAndEmpty: jsii.Boolean(false), IncludePartitionValue: jsii.Boolean(false), IncludeTableAlterOperations: jsii.Boolean(false), IncludeTransactionDetails: jsii.Boolean(false), MessageFormat: jsii.String("messageFormat"), MessageMaxBytes: jsii.Number(123), NoHexPrefix: jsii.Boolean(false), PartitionIncludeSchemaTable: jsii.Boolean(false), SaslPassword: jsii.String("saslPassword"), SaslUserName: jsii.String("saslUserName"), SecurityProtocol: jsii.String("securityProtocol"), SslCaCertificateArn: jsii.String("sslCaCertificateArn"), SslClientCertificateArn: jsii.String("sslClientCertificateArn"), SslClientKeyArn: jsii.String("sslClientKeyArn"), SslClientKeyPassword: jsii.String("sslClientKeyPassword"), Topic: jsii.String("topic"), }, KinesisSettings: &KinesisSettingsProperty{ IncludeControlDetails: jsii.Boolean(false), IncludeNullAndEmpty: jsii.Boolean(false), IncludePartitionValue: jsii.Boolean(false), IncludeTableAlterOperations: jsii.Boolean(false), IncludeTransactionDetails: jsii.Boolean(false), MessageFormat: jsii.String("messageFormat"), NoHexPrefix: jsii.Boolean(false), PartitionIncludeSchemaTable: jsii.Boolean(false), ServiceAccessRoleArn: jsii.String("serviceAccessRoleArn"), StreamArn: jsii.String("streamArn"), }, KmsKeyId: jsii.String("kmsKeyId"), MicrosoftSqlServerSettings: &MicrosoftSqlServerSettingsProperty{ BcpPacketSize: jsii.Number(123), ControlTablesFileGroup: jsii.String("controlTablesFileGroup"), DatabaseName: jsii.String("databaseName"), ForceLobLookup: jsii.Boolean(false), Password: jsii.String("password"), Port: jsii.Number(123), QuerySingleAlwaysOnNode: jsii.Boolean(false), ReadBackupOnly: jsii.Boolean(false), SafeguardPolicy: jsii.String("safeguardPolicy"), SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), ServerName: jsii.String("serverName"), TlogAccessMode: jsii.String("tlogAccessMode"), TrimSpaceInChar: jsii.Boolean(false), UseBcpFullLoad: jsii.Boolean(false), Username: jsii.String("username"), UseThirdPartyBackupDevice: jsii.Boolean(false), }, MongoDbSettings: &MongoDbSettingsProperty{ AuthMechanism: jsii.String("authMechanism"), AuthSource: jsii.String("authSource"), AuthType: jsii.String("authType"), DatabaseName: jsii.String("databaseName"), DocsToInvestigate: jsii.String("docsToInvestigate"), ExtractDocId: jsii.String("extractDocId"), NestingLevel: jsii.String("nestingLevel"), Password: jsii.String("password"), Port: jsii.Number(123), SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), ServerName: jsii.String("serverName"), Username: jsii.String("username"), }, MySqlSettings: &MySqlSettingsProperty{ AfterConnectScript: jsii.String("afterConnectScript"), CleanSourceMetadataOnMismatch: jsii.Boolean(false), EventsPollInterval: jsii.Number(123), MaxFileSize: jsii.Number(123), ParallelLoadThreads: jsii.Number(123), SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), ServerTimezone: jsii.String("serverTimezone"), TargetDbType: jsii.String("targetDbType"), }, NeptuneSettings: &NeptuneSettingsProperty{ ErrorRetryDuration: jsii.Number(123), IamAuthEnabled: jsii.Boolean(false), MaxFileSize: jsii.Number(123), MaxRetryCount: jsii.Number(123), S3BucketFolder: jsii.String("s3BucketFolder"), S3BucketName: jsii.String("s3BucketName"), ServiceAccessRoleArn: jsii.String("serviceAccessRoleArn"), }, OracleSettings: &OracleSettingsProperty{ AccessAlternateDirectly: jsii.Boolean(false), AdditionalArchivedLogDestId: jsii.Number(123), AddSupplementalLogging: jsii.Boolean(false), AllowSelectNestedTables: jsii.Boolean(false), ArchivedLogDestId: jsii.Number(123), ArchivedLogsOnly: jsii.Boolean(false), AsmPassword: jsii.String("asmPassword"), AsmServer: jsii.String("asmServer"), AsmUser: jsii.String("asmUser"), CharLengthSemantics: jsii.String("charLengthSemantics"), DirectPathNoLog: jsii.Boolean(false), DirectPathParallelLoad: jsii.Boolean(false), EnableHomogenousTablespace: jsii.Boolean(false), ExtraArchivedLogDestIds: []interface{}{ jsii.Number(123), }, FailTasksOnLobTruncation: jsii.Boolean(false), NumberDatatypeScale: jsii.Number(123), OraclePathPrefix: jsii.String("oraclePathPrefix"), ParallelAsmReadThreads: jsii.Number(123), ReadAheadBlocks: jsii.Number(123), ReadTableSpaceName: jsii.Boolean(false), ReplacePathPrefix: jsii.Boolean(false), RetryInterval: jsii.Number(123), SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerOracleAsmAccessRoleArn: jsii.String("secretsManagerOracleAsmAccessRoleArn"), SecretsManagerOracleAsmSecretId: jsii.String("secretsManagerOracleAsmSecretId"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), SecurityDbEncryption: jsii.String("securityDbEncryption"), SecurityDbEncryptionName: jsii.String("securityDbEncryptionName"), SpatialDataOptionToGeoJsonFunctionName: jsii.String("spatialDataOptionToGeoJsonFunctionName"), StandbyDelayTime: jsii.Number(123), UseAlternateFolderForOnline: jsii.Boolean(false), UseBFile: jsii.Boolean(false), UseDirectPathFullLoad: jsii.Boolean(false), UseLogminerReader: jsii.Boolean(false), UsePathPrefix: jsii.String("usePathPrefix"), }, Password: jsii.String("password"), Port: jsii.Number(123), PostgreSqlSettings: &PostgreSqlSettingsProperty{ AfterConnectScript: jsii.String("afterConnectScript"), BabelfishDatabaseName: jsii.String("babelfishDatabaseName"), CaptureDdls: jsii.Boolean(false), DatabaseMode: jsii.String("databaseMode"), DdlArtifactsSchema: jsii.String("ddlArtifactsSchema"), ExecuteTimeout: jsii.Number(123), FailTasksOnLobTruncation: jsii.Boolean(false), HeartbeatEnable: jsii.Boolean(false), HeartbeatFrequency: jsii.Number(123), HeartbeatSchema: jsii.String("heartbeatSchema"), MapBooleanAsBoolean: jsii.Boolean(false), MaxFileSize: jsii.Number(123), PluginName: jsii.String("pluginName"), SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), SlotName: jsii.String("slotName"), }, RedisSettings: &RedisSettingsProperty{ AuthPassword: jsii.String("authPassword"), AuthType: jsii.String("authType"), AuthUserName: jsii.String("authUserName"), Port: jsii.Number(123), ServerName: jsii.String("serverName"), SslCaCertificateArn: jsii.String("sslCaCertificateArn"), SslSecurityProtocol: jsii.String("sslSecurityProtocol"), }, RedshiftSettings: &RedshiftSettingsProperty{ AcceptAnyDate: jsii.Boolean(false), AfterConnectScript: jsii.String("afterConnectScript"), BucketFolder: jsii.String("bucketFolder"), BucketName: jsii.String("bucketName"), CaseSensitiveNames: jsii.Boolean(false), CompUpdate: jsii.Boolean(false), ConnectionTimeout: jsii.Number(123), DateFormat: jsii.String("dateFormat"), EmptyAsNull: jsii.Boolean(false), EncryptionMode: jsii.String("encryptionMode"), ExplicitIds: jsii.Boolean(false), FileTransferUploadStreams: jsii.Number(123), LoadTimeout: jsii.Number(123), MapBooleanAsBoolean: jsii.Boolean(false), MaxFileSize: jsii.Number(123), RemoveQuotes: jsii.Boolean(false), ReplaceChars: jsii.String("replaceChars"), ReplaceInvalidChars: jsii.String("replaceInvalidChars"), SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), ServerSideEncryptionKmsKeyId: jsii.String("serverSideEncryptionKmsKeyId"), ServiceAccessRoleArn: jsii.String("serviceAccessRoleArn"), TimeFormat: jsii.String("timeFormat"), TrimBlanks: jsii.Boolean(false), TruncateColumns: jsii.Boolean(false), WriteBufferSize: jsii.Number(123), }, ResourceIdentifier: jsii.String("resourceIdentifier"), S3Settings: &S3SettingsProperty{ AddColumnName: jsii.Boolean(false), AddTrailingPaddingCharacter: jsii.Boolean(false), BucketFolder: jsii.String("bucketFolder"), BucketName: jsii.String("bucketName"), CannedAclForObjects: jsii.String("cannedAclForObjects"), CdcInsertsAndUpdates: jsii.Boolean(false), CdcInsertsOnly: jsii.Boolean(false), CdcMaxBatchInterval: jsii.Number(123), CdcMinFileSize: jsii.Number(123), CdcPath: jsii.String("cdcPath"), CompressionType: jsii.String("compressionType"), CsvDelimiter: jsii.String("csvDelimiter"), CsvNoSupValue: jsii.String("csvNoSupValue"), CsvNullValue: jsii.String("csvNullValue"), CsvRowDelimiter: jsii.String("csvRowDelimiter"), DataFormat: jsii.String("dataFormat"), DataPageSize: jsii.Number(123), DatePartitionDelimiter: jsii.String("datePartitionDelimiter"), DatePartitionEnabled: jsii.Boolean(false), DatePartitionSequence: jsii.String("datePartitionSequence"), DatePartitionTimezone: jsii.String("datePartitionTimezone"), DictPageSizeLimit: jsii.Number(123), EnableStatistics: jsii.Boolean(false), EncodingType: jsii.String("encodingType"), EncryptionMode: jsii.String("encryptionMode"), ExpectedBucketOwner: jsii.String("expectedBucketOwner"), ExternalTableDefinition: jsii.String("externalTableDefinition"), GlueCatalogGeneration: jsii.Boolean(false), IgnoreHeaderRows: jsii.Number(123), IncludeOpForFullLoad: jsii.Boolean(false), MaxFileSize: jsii.Number(123), ParquetTimestampInMillisecond: jsii.Boolean(false), ParquetVersion: jsii.String("parquetVersion"), PreserveTransactions: jsii.Boolean(false), Rfc4180: jsii.Boolean(false), RowGroupLength: jsii.Number(123), ServerSideEncryptionKmsKeyId: jsii.String("serverSideEncryptionKmsKeyId"), ServiceAccessRoleArn: jsii.String("serviceAccessRoleArn"), TimestampColumnName: jsii.String("timestampColumnName"), UseCsvNoSupValue: jsii.Boolean(false), UseTaskStartTimeForFullLoadTimestamp: jsii.Boolean(false), }, ServerName: jsii.String("serverName"), SslMode: jsii.String("sslMode"), SybaseSettings: &SybaseSettingsProperty{ SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, Username: jsii.String("username"), })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html
func NewCfnEndpoint ¶
func NewCfnEndpoint(scope constructs.Construct, id *string, props *CfnEndpointProps) CfnEndpoint
type CfnEndpointProps ¶
type CfnEndpointProps struct { // The type of endpoint. // // Valid values are `source` and `target` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-endpointtype // EndpointType *string `field:"required" json:"endpointType" yaml:"endpointType"` // The type of engine for the endpoint, depending on the `EndpointType` value. // // *Valid values* : `mysql` | `oracle` | `postgres` | `mariadb` | `aurora` | `aurora-postgresql` | `opensearch` | `redshift` | `redshift-serverless` | `s3` | `db2` | `azuredb` | `sybase` | `dynamodb` | `mongodb` | `kinesis` | `kafka` | `elasticsearch` | `docdb` | `sqlserver` | `neptune`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-enginename // EngineName *string `field:"required" json:"engineName" yaml:"engineName"` // The Amazon Resource Name (ARN) for the certificate. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-certificatearn // CertificateArn *string `field:"optional" json:"certificateArn" yaml:"certificateArn"` // The name of the endpoint database. // // For a MySQL source or target endpoint, don't specify `DatabaseName` . To migrate to a specific database, use this setting and `targetDbType` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-databasename // DatabaseName *string `field:"optional" json:"databaseName" yaml:"databaseName"` // Settings in JSON format for the source and target DocumentDB endpoint. // // For more information about other available settings, see [Using extra connections attributes with Amazon DocumentDB as a source](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DocumentDB.html#CHAP_Source.DocumentDB.ECAs) and [Using Amazon DocumentDB as a target for AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DocumentDB.html) in the *AWS Database Migration Service User Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-docdbsettings // DocDbSettings interface{} `field:"optional" 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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-dynamodbsettings // DynamoDbSettings interface{} `field:"optional" 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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-elasticsearchsettings // ElasticsearchSettings interface{} `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-endpointidentifier // EndpointIdentifier *string `field:"optional" 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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-extraconnectionattributes // ExtraConnectionAttributes *string `field:"optional" json:"extraConnectionAttributes" yaml:"extraConnectionAttributes"` // Settings in JSON format for the source GCP MySQL endpoint. // // These settings are much the same as the settings for any MySQL-compatible endpoint. For more information, 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) in the *AWS Database Migration Service User Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-gcpmysqlsettings // GcpMySqlSettings interface{} `field:"optional" json:"gcpMySqlSettings" yaml:"gcpMySqlSettings"` // Settings in JSON format for the source IBM Db2 LUW endpoint. // // For information about other available settings, see [Extra connection attributes when using Db2 LUW as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DB2.html#CHAP_Source.DB2.ConnectionAttrib) in the *AWS Database Migration Service User Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-ibmdb2settings // IbmDb2Settings interface{} `field:"optional" json:"ibmDb2Settings" yaml:"ibmDb2Settings"` // Settings in JSON format for the target Apache Kafka endpoint. // // For more information about other 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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-kafkasettings // KafkaSettings interface{} `field:"optional" json:"kafkaSettings" yaml:"kafkaSettings"` // Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. // // For more information about other available settings, see [Using object mapping to migrate data to a Kinesis data stream](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping) in the *AWS Database Migration Service User Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-kinesissettings // KinesisSettings interface{} `field:"optional" 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, 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 . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-kmskeyid // KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"` // Settings in JSON format for the source and target Microsoft SQL Server endpoint. // // For information about other available settings, see [Extra connection attributes when using SQL Server as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SQLServer.html#CHAP_Source.SQLServer.ConnectionAttrib) and [Extra connection attributes when using SQL Server as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SQLServer.html#CHAP_Target.SQLServer.ConnectionAttrib) in the *AWS Database Migration Service User Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-microsoftsqlserversettings // MicrosoftSqlServerSettings interface{} `field:"optional" json:"microsoftSqlServerSettings" yaml:"microsoftSqlServerSettings"` // Settings in JSON format for the source MongoDB endpoint. // // For more information about the available settings, see [Using MongoDB as a target for AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html#CHAP_Source.MongoDB.Configuration) in the *AWS Database Migration Service User Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-mongodbsettings // MongoDbSettings interface{} `field:"optional" 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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-mysqlsettings // MySqlSettings interface{} `field:"optional" json:"mySqlSettings" yaml:"mySqlSettings"` // Settings in JSON format for the target Amazon Neptune endpoint. // // For more information about the available settings, see [Specifying endpoint settings for Amazon Neptune as a target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings) in the *AWS Database Migration Service User Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-neptunesettings // NeptuneSettings interface{} `field:"optional" 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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-oraclesettings // OracleSettings interface{} `field:"optional" json:"oracleSettings" yaml:"oracleSettings"` // The password to be used to log in to the endpoint database. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-password // Password *string `field:"optional" json:"password" yaml:"password"` // The port used by the endpoint database. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-port // Port *float64 `field:"optional" json:"port" yaml:"port"` // Settings in JSON format for the source and target PostgreSQL endpoint. // // For information about other available settings, 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) and [Extra connection attributes when using PostgreSQL as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.PostgreSQL.html#CHAP_Target.PostgreSQL.ConnectionAttrib) in the *AWS Database Migration Service User Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-postgresqlsettings // PostgreSqlSettings interface{} `field:"optional" json:"postgreSqlSettings" yaml:"postgreSqlSettings"` // Settings in JSON format for the target Redis endpoint. // // For information about other available settings, see [Specifying endpoint settings for Redis as a target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Redis.html#CHAP_Target.Redis.EndpointSettings) in the *AWS Database Migration Service User Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-redissettings // RedisSettings interface{} `field:"optional" json:"redisSettings" yaml:"redisSettings"` // Settings in JSON format for the Amazon Redshift endpoint. // // For more information about other available settings, see [Extra connection attributes when using Amazon Redshift as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Redshift.html#CHAP_Target.Redshift.ConnectionAttrib) in the *AWS Database Migration Service User Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-redshiftsettings // RedshiftSettings interface{} `field:"optional" json:"redshiftSettings" yaml:"redshiftSettings"` // A display 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-resourceidentifier // ResourceIdentifier *string `field:"optional" json:"resourceIdentifier" yaml:"resourceIdentifier"` // Settings in JSON format for the source and target Amazon S3 endpoint. // // For more information about other available settings, see [Extra connection attributes when using Amazon S3 as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.S3.html#CHAP_Source.S3.Configuring) and [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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-s3settings // S3Settings interface{} `field:"optional" json:"s3Settings" yaml:"s3Settings"` // The name of the server where the endpoint database resides. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-servername // ServerName *string `field:"optional" 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, the only allowed value is `none` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-sslmode // SslMode *string `field:"optional" 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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-sybasesettings // SybaseSettings interface{} `field:"optional" json:"sybaseSettings" yaml:"sybaseSettings"` // One or more tags to be assigned to the endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // The user name to be used to log in to the endpoint database. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-username // Username *string `field:"optional" json:"username" yaml:"username"` }
Properties for defining a `CfnEndpoint`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnEndpointProps := &CfnEndpointProps{ EndpointType: jsii.String("endpointType"), EngineName: jsii.String("engineName"), // the properties below are optional CertificateArn: jsii.String("certificateArn"), DatabaseName: jsii.String("databaseName"), DocDbSettings: &DocDbSettingsProperty{ DocsToInvestigate: jsii.Number(123), ExtractDocId: jsii.Boolean(false), NestingLevel: jsii.String("nestingLevel"), SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), }, DynamoDbSettings: &DynamoDbSettingsProperty{ ServiceAccessRoleArn: jsii.String("serviceAccessRoleArn"), }, ElasticsearchSettings: &ElasticsearchSettingsProperty{ EndpointUri: jsii.String("endpointUri"), ErrorRetryDuration: jsii.Number(123), FullLoadErrorPercentage: jsii.Number(123), ServiceAccessRoleArn: jsii.String("serviceAccessRoleArn"), }, EndpointIdentifier: jsii.String("endpointIdentifier"), ExtraConnectionAttributes: jsii.String("extraConnectionAttributes"), GcpMySqlSettings: &GcpMySQLSettingsProperty{ AfterConnectScript: jsii.String("afterConnectScript"), CleanSourceMetadataOnMismatch: jsii.Boolean(false), DatabaseName: jsii.String("databaseName"), EventsPollInterval: jsii.Number(123), MaxFileSize: jsii.Number(123), ParallelLoadThreads: jsii.Number(123), Password: jsii.String("password"), Port: jsii.Number(123), SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), ServerName: jsii.String("serverName"), ServerTimezone: jsii.String("serverTimezone"), Username: jsii.String("username"), }, IbmDb2Settings: &IbmDb2SettingsProperty{ CurrentLsn: jsii.String("currentLsn"), KeepCsvFiles: jsii.Boolean(false), LoadTimeout: jsii.Number(123), MaxFileSize: jsii.Number(123), MaxKBytesPerRead: jsii.Number(123), SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), SetDataCaptureChanges: jsii.Boolean(false), WriteBufferSize: jsii.Number(123), }, KafkaSettings: &KafkaSettingsProperty{ Broker: jsii.String("broker"), IncludeControlDetails: jsii.Boolean(false), IncludeNullAndEmpty: jsii.Boolean(false), IncludePartitionValue: jsii.Boolean(false), IncludeTableAlterOperations: jsii.Boolean(false), IncludeTransactionDetails: jsii.Boolean(false), MessageFormat: jsii.String("messageFormat"), MessageMaxBytes: jsii.Number(123), NoHexPrefix: jsii.Boolean(false), PartitionIncludeSchemaTable: jsii.Boolean(false), SaslPassword: jsii.String("saslPassword"), SaslUserName: jsii.String("saslUserName"), SecurityProtocol: jsii.String("securityProtocol"), SslCaCertificateArn: jsii.String("sslCaCertificateArn"), SslClientCertificateArn: jsii.String("sslClientCertificateArn"), SslClientKeyArn: jsii.String("sslClientKeyArn"), SslClientKeyPassword: jsii.String("sslClientKeyPassword"), Topic: jsii.String("topic"), }, KinesisSettings: &KinesisSettingsProperty{ IncludeControlDetails: jsii.Boolean(false), IncludeNullAndEmpty: jsii.Boolean(false), IncludePartitionValue: jsii.Boolean(false), IncludeTableAlterOperations: jsii.Boolean(false), IncludeTransactionDetails: jsii.Boolean(false), MessageFormat: jsii.String("messageFormat"), NoHexPrefix: jsii.Boolean(false), PartitionIncludeSchemaTable: jsii.Boolean(false), ServiceAccessRoleArn: jsii.String("serviceAccessRoleArn"), StreamArn: jsii.String("streamArn"), }, KmsKeyId: jsii.String("kmsKeyId"), MicrosoftSqlServerSettings: &MicrosoftSqlServerSettingsProperty{ BcpPacketSize: jsii.Number(123), ControlTablesFileGroup: jsii.String("controlTablesFileGroup"), DatabaseName: jsii.String("databaseName"), ForceLobLookup: jsii.Boolean(false), Password: jsii.String("password"), Port: jsii.Number(123), QuerySingleAlwaysOnNode: jsii.Boolean(false), ReadBackupOnly: jsii.Boolean(false), SafeguardPolicy: jsii.String("safeguardPolicy"), SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), ServerName: jsii.String("serverName"), TlogAccessMode: jsii.String("tlogAccessMode"), TrimSpaceInChar: jsii.Boolean(false), UseBcpFullLoad: jsii.Boolean(false), Username: jsii.String("username"), UseThirdPartyBackupDevice: jsii.Boolean(false), }, MongoDbSettings: &MongoDbSettingsProperty{ AuthMechanism: jsii.String("authMechanism"), AuthSource: jsii.String("authSource"), AuthType: jsii.String("authType"), DatabaseName: jsii.String("databaseName"), DocsToInvestigate: jsii.String("docsToInvestigate"), ExtractDocId: jsii.String("extractDocId"), NestingLevel: jsii.String("nestingLevel"), Password: jsii.String("password"), Port: jsii.Number(123), SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), ServerName: jsii.String("serverName"), Username: jsii.String("username"), }, MySqlSettings: &MySqlSettingsProperty{ AfterConnectScript: jsii.String("afterConnectScript"), CleanSourceMetadataOnMismatch: jsii.Boolean(false), EventsPollInterval: jsii.Number(123), MaxFileSize: jsii.Number(123), ParallelLoadThreads: jsii.Number(123), SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), ServerTimezone: jsii.String("serverTimezone"), TargetDbType: jsii.String("targetDbType"), }, NeptuneSettings: &NeptuneSettingsProperty{ ErrorRetryDuration: jsii.Number(123), IamAuthEnabled: jsii.Boolean(false), MaxFileSize: jsii.Number(123), MaxRetryCount: jsii.Number(123), S3BucketFolder: jsii.String("s3BucketFolder"), S3BucketName: jsii.String("s3BucketName"), ServiceAccessRoleArn: jsii.String("serviceAccessRoleArn"), }, OracleSettings: &OracleSettingsProperty{ AccessAlternateDirectly: jsii.Boolean(false), AdditionalArchivedLogDestId: jsii.Number(123), AddSupplementalLogging: jsii.Boolean(false), AllowSelectNestedTables: jsii.Boolean(false), ArchivedLogDestId: jsii.Number(123), ArchivedLogsOnly: jsii.Boolean(false), AsmPassword: jsii.String("asmPassword"), AsmServer: jsii.String("asmServer"), AsmUser: jsii.String("asmUser"), CharLengthSemantics: jsii.String("charLengthSemantics"), DirectPathNoLog: jsii.Boolean(false), DirectPathParallelLoad: jsii.Boolean(false), EnableHomogenousTablespace: jsii.Boolean(false), ExtraArchivedLogDestIds: []interface{}{ jsii.Number(123), }, FailTasksOnLobTruncation: jsii.Boolean(false), NumberDatatypeScale: jsii.Number(123), OraclePathPrefix: jsii.String("oraclePathPrefix"), ParallelAsmReadThreads: jsii.Number(123), ReadAheadBlocks: jsii.Number(123), ReadTableSpaceName: jsii.Boolean(false), ReplacePathPrefix: jsii.Boolean(false), RetryInterval: jsii.Number(123), SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerOracleAsmAccessRoleArn: jsii.String("secretsManagerOracleAsmAccessRoleArn"), SecretsManagerOracleAsmSecretId: jsii.String("secretsManagerOracleAsmSecretId"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), SecurityDbEncryption: jsii.String("securityDbEncryption"), SecurityDbEncryptionName: jsii.String("securityDbEncryptionName"), SpatialDataOptionToGeoJsonFunctionName: jsii.String("spatialDataOptionToGeoJsonFunctionName"), StandbyDelayTime: jsii.Number(123), UseAlternateFolderForOnline: jsii.Boolean(false), UseBFile: jsii.Boolean(false), UseDirectPathFullLoad: jsii.Boolean(false), UseLogminerReader: jsii.Boolean(false), UsePathPrefix: jsii.String("usePathPrefix"), }, Password: jsii.String("password"), Port: jsii.Number(123), PostgreSqlSettings: &PostgreSqlSettingsProperty{ AfterConnectScript: jsii.String("afterConnectScript"), BabelfishDatabaseName: jsii.String("babelfishDatabaseName"), CaptureDdls: jsii.Boolean(false), DatabaseMode: jsii.String("databaseMode"), DdlArtifactsSchema: jsii.String("ddlArtifactsSchema"), ExecuteTimeout: jsii.Number(123), FailTasksOnLobTruncation: jsii.Boolean(false), HeartbeatEnable: jsii.Boolean(false), HeartbeatFrequency: jsii.Number(123), HeartbeatSchema: jsii.String("heartbeatSchema"), MapBooleanAsBoolean: jsii.Boolean(false), MaxFileSize: jsii.Number(123), PluginName: jsii.String("pluginName"), SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), SlotName: jsii.String("slotName"), }, RedisSettings: &RedisSettingsProperty{ AuthPassword: jsii.String("authPassword"), AuthType: jsii.String("authType"), AuthUserName: jsii.String("authUserName"), Port: jsii.Number(123), ServerName: jsii.String("serverName"), SslCaCertificateArn: jsii.String("sslCaCertificateArn"), SslSecurityProtocol: jsii.String("sslSecurityProtocol"), }, RedshiftSettings: &RedshiftSettingsProperty{ AcceptAnyDate: jsii.Boolean(false), AfterConnectScript: jsii.String("afterConnectScript"), BucketFolder: jsii.String("bucketFolder"), BucketName: jsii.String("bucketName"), CaseSensitiveNames: jsii.Boolean(false), CompUpdate: jsii.Boolean(false), ConnectionTimeout: jsii.Number(123), DateFormat: jsii.String("dateFormat"), EmptyAsNull: jsii.Boolean(false), EncryptionMode: jsii.String("encryptionMode"), ExplicitIds: jsii.Boolean(false), FileTransferUploadStreams: jsii.Number(123), LoadTimeout: jsii.Number(123), MapBooleanAsBoolean: jsii.Boolean(false), MaxFileSize: jsii.Number(123), RemoveQuotes: jsii.Boolean(false), ReplaceChars: jsii.String("replaceChars"), ReplaceInvalidChars: jsii.String("replaceInvalidChars"), SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), ServerSideEncryptionKmsKeyId: jsii.String("serverSideEncryptionKmsKeyId"), ServiceAccessRoleArn: jsii.String("serviceAccessRoleArn"), TimeFormat: jsii.String("timeFormat"), TrimBlanks: jsii.Boolean(false), TruncateColumns: jsii.Boolean(false), WriteBufferSize: jsii.Number(123), }, ResourceIdentifier: jsii.String("resourceIdentifier"), S3Settings: &S3SettingsProperty{ AddColumnName: jsii.Boolean(false), AddTrailingPaddingCharacter: jsii.Boolean(false), BucketFolder: jsii.String("bucketFolder"), BucketName: jsii.String("bucketName"), CannedAclForObjects: jsii.String("cannedAclForObjects"), CdcInsertsAndUpdates: jsii.Boolean(false), CdcInsertsOnly: jsii.Boolean(false), CdcMaxBatchInterval: jsii.Number(123), CdcMinFileSize: jsii.Number(123), CdcPath: jsii.String("cdcPath"), CompressionType: jsii.String("compressionType"), CsvDelimiter: jsii.String("csvDelimiter"), CsvNoSupValue: jsii.String("csvNoSupValue"), CsvNullValue: jsii.String("csvNullValue"), CsvRowDelimiter: jsii.String("csvRowDelimiter"), DataFormat: jsii.String("dataFormat"), DataPageSize: jsii.Number(123), DatePartitionDelimiter: jsii.String("datePartitionDelimiter"), DatePartitionEnabled: jsii.Boolean(false), DatePartitionSequence: jsii.String("datePartitionSequence"), DatePartitionTimezone: jsii.String("datePartitionTimezone"), DictPageSizeLimit: jsii.Number(123), EnableStatistics: jsii.Boolean(false), EncodingType: jsii.String("encodingType"), EncryptionMode: jsii.String("encryptionMode"), ExpectedBucketOwner: jsii.String("expectedBucketOwner"), ExternalTableDefinition: jsii.String("externalTableDefinition"), GlueCatalogGeneration: jsii.Boolean(false), IgnoreHeaderRows: jsii.Number(123), IncludeOpForFullLoad: jsii.Boolean(false), MaxFileSize: jsii.Number(123), ParquetTimestampInMillisecond: jsii.Boolean(false), ParquetVersion: jsii.String("parquetVersion"), PreserveTransactions: jsii.Boolean(false), Rfc4180: jsii.Boolean(false), RowGroupLength: jsii.Number(123), ServerSideEncryptionKmsKeyId: jsii.String("serverSideEncryptionKmsKeyId"), ServiceAccessRoleArn: jsii.String("serviceAccessRoleArn"), TimestampColumnName: jsii.String("timestampColumnName"), UseCsvNoSupValue: jsii.Boolean(false), UseTaskStartTimeForFullLoadTimestamp: jsii.Boolean(false), }, ServerName: jsii.String("serverName"), SslMode: jsii.String("sslMode"), SybaseSettings: &SybaseSettingsProperty{ SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, Username: jsii.String("username"), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html
type CfnEndpoint_DocDbSettingsProperty ¶
type CfnEndpoint_DocDbSettingsProperty struct { // Indicates the number of documents to preview to determine the document organization. // // Use this setting when `NestingLevel` is set to `"one"` . // // Must be a positive value greater than `0` . Default value is `1000` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-docdbsettings.html#cfn-dms-endpoint-docdbsettings-docstoinvestigate // DocsToInvestigate *float64 `field:"optional" json:"docsToInvestigate" yaml:"docsToInvestigate"` // Specifies the document ID. Use this setting when `NestingLevel` is set to `"none"` . // // Default value is `"false"` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-docdbsettings.html#cfn-dms-endpoint-docdbsettings-extractdocid // ExtractDocId interface{} `field:"optional" json:"extractDocId" yaml:"extractDocId"` // Specifies either document or table mode. // // Default value is `"none"` . Specify `"none"` to use document mode. Specify `"one"` to use table mode. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-docdbsettings.html#cfn-dms-endpoint-docdbsettings-nestinglevel // NestingLevel *string `field:"optional" json:"nestingLevel" yaml:"nestingLevel"` // 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 DocumentDB 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` , the corresponding `SecretsManagerAccessRoleArn` , and the `SecretsManagerSecretId` that is 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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-docdbsettings.html#cfn-dms-endpoint-docdbsettings-secretsmanageraccessrolearn // SecretsManagerAccessRoleArn *string `field:"optional" json:"secretsManagerAccessRoleArn" yaml:"secretsManagerAccessRoleArn"` // The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the DocumentDB endpoint connection details. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-docdbsettings.html#cfn-dms-endpoint-docdbsettings-secretsmanagersecretid // SecretsManagerSecretId *string `field:"optional" json:"secretsManagerSecretId" yaml:"secretsManagerSecretId"` }
Provides information that defines a DocumentDB endpoint.
This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For more information about other available settings, see [Using extra connections attributes with Amazon DocumentDB as a source](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DocumentDB.html#CHAP_Source.DocumentDB.ECAs) and [Using Amazon DocumentDB as a target for AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DocumentDB.html) in the *AWS Database Migration Service User Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" docDbSettingsProperty := &DocDbSettingsProperty{ DocsToInvestigate: jsii.Number(123), ExtractDocId: jsii.Boolean(false), NestingLevel: jsii.String("nestingLevel"), SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-dynamodbsettings.html#cfn-dms-endpoint-dynamodbsettings-serviceaccessrolearn // ServiceAccessRoleArn *string `field:"optional" json:"serviceAccessRoleArn" yaml:"serviceAccessRoleArn"` }
Provides information, including the Amazon Resource Name (ARN) of the IAM role used to define an Amazon DynamoDB target endpoint.
This information also includes the output format of records applied to the endpoint and details of transaction and control table data information. 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* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" dynamoDbSettingsProperty := &DynamoDbSettingsProperty{ ServiceAccessRoleArn: jsii.String("serviceAccessRoleArn"), }
type CfnEndpoint_ElasticsearchSettingsProperty ¶
type CfnEndpoint_ElasticsearchSettingsProperty struct { // The endpoint for the OpenSearch cluster. // // AWS DMS uses HTTPS if a transport protocol (either HTTP or HTTPS) isn't specified. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.html#cfn-dms-endpoint-elasticsearchsettings-endpointuri // EndpointUri *string `field:"optional" json:"endpointUri" yaml:"endpointUri"` // The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.html#cfn-dms-endpoint-elasticsearchsettings-errorretryduration // ErrorRetryDuration *float64 `field:"optional" 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 1,000 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.html#cfn-dms-endpoint-elasticsearchsettings-fullloaderrorpercentage // FullLoadErrorPercentage *float64 `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.html#cfn-dms-endpoint-elasticsearchsettings-serviceaccessrolearn // ServiceAccessRoleArn *string `field:"optional" json:"serviceAccessRoleArn" yaml:"serviceAccessRoleArn"` }
Provides information that defines an OpenSearch endpoint.
This information includes the output format of records applied to the endpoint and details of transaction and control table data information. 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* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" elasticsearchSettingsProperty := &ElasticsearchSettingsProperty{ EndpointUri: jsii.String("endpointUri"), ErrorRetryDuration: jsii.Number(123), FullLoadErrorPercentage: jsii.Number(123), ServiceAccessRoleArn: jsii.String("serviceAccessRoleArn"), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-afterconnectscript // AfterConnectScript *string `field:"optional" 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-cleansourcemetadataonmismatch // CleanSourceMetadataOnMismatch interface{} `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-databasename // DatabaseName *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-eventspollinterval // EventsPollInterval *float64 `field:"optional" 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`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-maxfilesize // MaxFileSize *float64 `field:"optional" 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`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-parallelloadthreads // ParallelLoadThreads *float64 `field:"optional" json:"parallelLoadThreads" yaml:"parallelLoadThreads"` // Endpoint connection password. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-password // Password *string `field:"optional" json:"password" yaml:"password"` // The port used by the endpoint database. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-port // Port *float64 `field:"optional" 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` , the corresponding `SecretsManagerAccessRoleArn` , and the `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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-secretsmanageraccessrolearn // SecretsManagerAccessRoleArn *string `field:"optional" json:"secretsManagerAccessRoleArn" yaml:"secretsManagerAccessRoleArn"` // The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the MySQL endpoint connection details. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-secretsmanagersecretid // SecretsManagerSecretId *string `field:"optional" json:"secretsManagerSecretId" yaml:"secretsManagerSecretId"` // The MySQL host name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-servername // ServerName *string `field:"optional" json:"serverName" yaml:"serverName"` // Specifies the time zone for the source MySQL database. Don't enclose time zones in single quotation marks. // // Example: `serverTimezone=US/Pacific;`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-servertimezone // ServerTimezone *string `field:"optional" json:"serverTimezone" yaml:"serverTimezone"` // Endpoint connection user name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html#cfn-dms-endpoint-gcpmysqlsettings-username // Username *string `field:"optional" json:"username" yaml:"username"` }
Provides information that defines a GCP MySQL endpoint.
This information includes the output format of records applied to the endpoint and details of transaction and control table data information. These settings are much the same as the settings for any MySQL-compatible endpoint. For more information, 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) in the *AWS Database Migration Service User Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" gcpMySQLSettingsProperty := &GcpMySQLSettingsProperty{ AfterConnectScript: jsii.String("afterConnectScript"), CleanSourceMetadataOnMismatch: jsii.Boolean(false), DatabaseName: jsii.String("databaseName"), EventsPollInterval: jsii.Number(123), MaxFileSize: jsii.Number(123), ParallelLoadThreads: jsii.Number(123), Password: jsii.String("password"), Port: jsii.Number(123), SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), ServerName: jsii.String("serverName"), ServerTimezone: jsii.String("serverTimezone"), Username: jsii.String("username"), }
type CfnEndpoint_IbmDb2SettingsProperty ¶
type CfnEndpoint_IbmDb2SettingsProperty struct { // For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html#cfn-dms-endpoint-ibmdb2settings-currentlsn // CurrentLsn *string `field:"optional" json:"currentLsn" yaml:"currentLsn"` // If true, AWS DMS saves any .csv files to the Db2 LUW target that were used to replicate data. DMS uses these files for analysis and troubleshooting. // // The default value is false. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html#cfn-dms-endpoint-ibmdb2settings-keepcsvfiles // KeepCsvFiles interface{} `field:"optional" json:"keepCsvFiles" yaml:"keepCsvFiles"` // The amount of time (in milliseconds) before AWS DMS times out operations performed by DMS on the Db2 target. // // The default value is 1200 (20 minutes). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html#cfn-dms-endpoint-ibmdb2settings-loadtimeout // LoadTimeout *float64 `field:"optional" json:"loadTimeout" yaml:"loadTimeout"` // Specifies the maximum size (in KB) of .csv files used to transfer data to Db2 LUW. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html#cfn-dms-endpoint-ibmdb2settings-maxfilesize // MaxFileSize *float64 `field:"optional" json:"maxFileSize" yaml:"maxFileSize"` // Maximum number of bytes per read, as a NUMBER value. // // The default is 64 KB. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html#cfn-dms-endpoint-ibmdb2settings-maxkbytesperread // MaxKBytesPerRead *float64 `field:"optional" json:"maxKBytesPerRead" yaml:"maxKBytesPerRead"` // 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 ofthe AWS Secrets Manager secret that allows access to the Db2 LUW 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` , the corresponding `SecretsManagerAccessRoleArn` , and the `SecretsManagerSecretId` that is 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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html#cfn-dms-endpoint-ibmdb2settings-secretsmanageraccessrolearn // SecretsManagerAccessRoleArn *string `field:"optional" json:"secretsManagerAccessRoleArn" yaml:"secretsManagerAccessRoleArn"` // The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the IBMDB2 endpoint connection details. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html#cfn-dms-endpoint-ibmdb2settings-secretsmanagersecretid // SecretsManagerSecretId *string `field:"optional" json:"secretsManagerSecretId" yaml:"secretsManagerSecretId"` // Enables ongoing replication (CDC) as a BOOLEAN value. // // The default is true. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html#cfn-dms-endpoint-ibmdb2settings-setdatacapturechanges // SetDataCaptureChanges interface{} `field:"optional" json:"setDataCaptureChanges" yaml:"setDataCaptureChanges"` // The size (in KB) of the in-memory file write buffer used when generating .csv files on the local disk on the DMS replication instance. The default value is 1024 (1 MB). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html#cfn-dms-endpoint-ibmdb2settings-writebuffersize // WriteBufferSize *float64 `field:"optional" json:"writeBufferSize" yaml:"writeBufferSize"` }
Provides information that defines an IBMDB2 endpoint.
This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For more information about other available settings, see [Extra connection attributes when using Db2 LUW as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DB2.html#CHAP_Source.DB2.ConnectionAttrib) in the *AWS Database Migration Service User Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" ibmDb2SettingsProperty := &IbmDb2SettingsProperty{ CurrentLsn: jsii.String("currentLsn"), KeepCsvFiles: jsii.Boolean(false), LoadTimeout: jsii.Number(123), MaxFileSize: jsii.Number(123), MaxKBytesPerRead: jsii.Number(123), SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), SetDataCaptureChanges: jsii.Boolean(false), WriteBufferSize: jsii.Number(123), }
type CfnEndpoint_KafkaSettingsProperty ¶
type CfnEndpoint_KafkaSettingsProperty struct { // A comma-separated list of one or more broker locations in your Kafka cluster that host your Kafka instance. // // Specify each broker location in the form `*broker-hostname-or-ip* : *port*` . For example, `"ec2-12-345-678-901.compute-1.amazonaws.com:2345"` . For more information and examples of specifying a list of broker locations, see [Using Apache Kafka as a target for AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html) in the *AWS Database Migration Service User Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-broker // Broker *string `field:"optional" 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-includecontroldetails // IncludeControlDetails interface{} `field:"optional" json:"includeControlDetails" yaml:"includeControlDetails"` // Include NULL and empty columns for records migrated to the endpoint. // // The default is `false` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-includenullandempty // IncludeNullAndEmpty interface{} `field:"optional" json:"includeNullAndEmpty" yaml:"includeNullAndEmpty"` // Shows the partition value within the Kafka message output unless the partition type is `schema-table-type` . // // The default is `false` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-includepartitionvalue // IncludePartitionValue interface{} `field:"optional" json:"includePartitionValue" yaml:"includePartitionValue"` // 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-includetablealteroperations // IncludeTableAlterOperations interface{} `field:"optional" 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-includetransactiondetails // IncludeTransactionDetails interface{} `field:"optional" json:"includeTransactionDetails" yaml:"includeTransactionDetails"` // The output format for the records created on the endpoint. // // The message format is `JSON` (default) or `JSON_UNFORMATTED` (a single line with no tab). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-messageformat // MessageFormat *string `field:"optional" json:"messageFormat" yaml:"messageFormat"` // The maximum size in bytes for records created on the endpoint The default is 1,000,000. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-messagemaxbytes // MessageMaxBytes *float64 `field:"optional" json:"messageMaxBytes" yaml:"messageMaxBytes"` // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-nohexprefix // NoHexPrefix interface{} `field:"optional" 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-partitionincludeschematable // PartitionIncludeSchemaTable interface{} `field:"optional" json:"partitionIncludeSchemaTable" yaml:"partitionIncludeSchemaTable"` // The secure password that you created when you first set up your Amazon MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-saslpassword // SaslPassword *string `field:"optional" json:"saslPassword" yaml:"saslPassword"` // The secure user name you created when you first set up your Amazon MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-saslusername // SaslUserName *string `field:"optional" 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-securityprotocol // SecurityProtocol *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-sslcacertificatearn // SslCaCertificateArn *string `field:"optional" json:"sslCaCertificateArn" yaml:"sslCaCertificateArn"` // The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-sslclientcertificatearn // SslClientCertificateArn *string `field:"optional" json:"sslClientCertificateArn" yaml:"sslClientCertificateArn"` // The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-sslclientkeyarn // SslClientKeyArn *string `field:"optional" json:"sslClientKeyArn" yaml:"sslClientKeyArn"` // The password for the client private key used to securely connect to a Kafka target endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-sslclientkeypassword // SslClientKeyPassword *string `field:"optional" json:"sslClientKeyPassword" yaml:"sslClientKeyPassword"` // The topic to which you migrate the data. // // If you don't specify a topic, AWS DMS specifies `"kafka-default-topic"` as the migration topic. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-topic // Topic *string `field:"optional" json:"topic" yaml:"topic"` }
Provides information that describes an Apache Kafka endpoint.
This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For more information about other 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* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" kafkaSettingsProperty := &KafkaSettingsProperty{ Broker: jsii.String("broker"), IncludeControlDetails: jsii.Boolean(false), IncludeNullAndEmpty: jsii.Boolean(false), IncludePartitionValue: jsii.Boolean(false), IncludeTableAlterOperations: jsii.Boolean(false), IncludeTransactionDetails: jsii.Boolean(false), MessageFormat: jsii.String("messageFormat"), MessageMaxBytes: jsii.Number(123), NoHexPrefix: jsii.Boolean(false), PartitionIncludeSchemaTable: jsii.Boolean(false), SaslPassword: jsii.String("saslPassword"), SaslUserName: jsii.String("saslUserName"), SecurityProtocol: jsii.String("securityProtocol"), SslCaCertificateArn: jsii.String("sslCaCertificateArn"), SslClientCertificateArn: jsii.String("sslClientCertificateArn"), SslClientKeyArn: jsii.String("sslClientKeyArn"), SslClientKeyPassword: jsii.String("sslClientKeyPassword"), Topic: jsii.String("topic"), }
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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.html#cfn-dms-endpoint-kinesissettings-includecontroldetails // IncludeControlDetails interface{} `field:"optional" json:"includeControlDetails" yaml:"includeControlDetails"` // Include NULL and empty columns for records migrated to the endpoint. // // The default is `false` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.html#cfn-dms-endpoint-kinesissettings-includenullandempty // IncludeNullAndEmpty interface{} `field:"optional" json:"includeNullAndEmpty" yaml:"includeNullAndEmpty"` // Shows the partition value within the Kinesis message output, unless the partition type is `schema-table-type` . // // The default is `false` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.html#cfn-dms-endpoint-kinesissettings-includepartitionvalue // IncludePartitionValue interface{} `field:"optional" json:"includePartitionValue" yaml:"includePartitionValue"` // 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.html#cfn-dms-endpoint-kinesissettings-includetablealteroperations // IncludeTableAlterOperations interface{} `field:"optional" 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.html#cfn-dms-endpoint-kinesissettings-includetransactiondetails // IncludeTransactionDetails interface{} `field:"optional" json:"includeTransactionDetails" yaml:"includeTransactionDetails"` // The output format for the records created on the endpoint. // // The message format is `JSON` (default) or `JSON_UNFORMATTED` (a single line with no tab). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.html#cfn-dms-endpoint-kinesissettings-messageformat // MessageFormat *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.html#cfn-dms-endpoint-kinesissettings-nohexprefix // NoHexPrefix interface{} `field:"optional" 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.html#cfn-dms-endpoint-kinesissettings-partitionincludeschematable // PartitionIncludeSchemaTable interface{} `field:"optional" json:"partitionIncludeSchemaTable" yaml:"partitionIncludeSchemaTable"` // The Amazon Resource Name (ARN) for the IAM role that AWS DMS uses to write to the Kinesis data stream. // // The role must allow the `iam:PassRole` action. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.html#cfn-dms-endpoint-kinesissettings-serviceaccessrolearn // ServiceAccessRoleArn *string `field:"optional" json:"serviceAccessRoleArn" yaml:"serviceAccessRoleArn"` // The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.html#cfn-dms-endpoint-kinesissettings-streamarn // StreamArn *string `field:"optional" json:"streamArn" yaml:"streamArn"` }
Provides information that describes an Amazon Kinesis Data Stream endpoint.
This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For more information about other available settings, see [Using object mapping to migrate data to a Kinesis data stream](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping) in the *AWS Database Migration Service User Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" kinesisSettingsProperty := &KinesisSettingsProperty{ IncludeControlDetails: jsii.Boolean(false), IncludeNullAndEmpty: jsii.Boolean(false), IncludePartitionValue: jsii.Boolean(false), IncludeTableAlterOperations: jsii.Boolean(false), IncludeTransactionDetails: jsii.Boolean(false), MessageFormat: jsii.String("messageFormat"), NoHexPrefix: jsii.Boolean(false), PartitionIncludeSchemaTable: jsii.Boolean(false), ServiceAccessRoleArn: jsii.String("serviceAccessRoleArn"), StreamArn: jsii.String("streamArn"), }
type CfnEndpoint_MicrosoftSqlServerSettingsProperty ¶
type CfnEndpoint_MicrosoftSqlServerSettingsProperty struct { // The maximum size of the packets (in bytes) used to transfer data using BCP. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-bcppacketsize // BcpPacketSize *float64 `field:"optional" json:"bcpPacketSize" yaml:"bcpPacketSize"` // Specifies a file group for the AWS DMS internal tables. // // When the replication task starts, all the internal AWS DMS control tables (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created for the specified file group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-controltablesfilegroup // ControlTablesFileGroup *string `field:"optional" json:"controlTablesFileGroup" yaml:"controlTablesFileGroup"` // Database name for the endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-databasename // DatabaseName *string `field:"optional" json:"databaseName" yaml:"databaseName"` // Forces LOB lookup on inline LOB. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-forceloblookup // ForceLobLookup interface{} `field:"optional" json:"forceLobLookup" yaml:"forceLobLookup"` // Endpoint connection password. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-password // Password *string `field:"optional" json:"password" yaml:"password"` // Endpoint TCP port. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-port // Port *float64 `field:"optional" json:"port" yaml:"port"` // Cleans and recreates table metadata information on the replication instance when a mismatch occurs. // // An example is a situation where running an alter DDL statement on a table might result in different information about the table cached in the replication instance. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-querysinglealwaysonnode // QuerySingleAlwaysOnNode interface{} `field:"optional" json:"querySingleAlwaysOnNode" yaml:"querySingleAlwaysOnNode"` // When this attribute is set to `Y` , AWS DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication. // // Setting this parameter to `Y` enables you to control active transaction log file growth during full load and ongoing replication tasks. However, it can add some source latency to ongoing replication. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-readbackuponly // ReadBackupOnly interface{} `field:"optional" json:"readBackupOnly" yaml:"readBackupOnly"` // Use this attribute to minimize the need to access the backup log and enable AWS DMS to prevent truncation using one of the following two methods. // // *Start transactions in the database:* This is the default method. When this method is used, AWS DMS prevents TLOG truncation by mimicking a transaction in the database. As long as such a transaction is open, changes that appear after the transaction started aren't truncated. If you need Microsoft Replication to be enabled in your database, then you must choose this method. // // *Exclusively use sp_repldone within a single task* : When this method is used, AWS DMS reads the changes and then uses sp_repldone to mark the TLOG transactions as ready for truncation. Although this method doesn't involve any transactional activities, it can only be used when Microsoft Replication isn't running. Also, when using this method, only one AWS DMS task can access the database at any given time. Therefore, if you need to run parallel AWS DMS tasks against the same database, use the default method. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-safeguardpolicy // SafeguardPolicy *string `field:"optional" json:"safeguardPolicy" yaml:"safeguardPolicy"` // 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 SQL Server 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` , the corresponding `SecretsManagerAccessRoleArn` , and the `SecretsManagerSecretId` that is 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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-secretsmanageraccessrolearn // SecretsManagerAccessRoleArn *string `field:"optional" json:"secretsManagerAccessRoleArn" yaml:"secretsManagerAccessRoleArn"` // The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the MicrosoftSQLServer endpoint connection details. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-secretsmanagersecretid // SecretsManagerSecretId *string `field:"optional" json:"secretsManagerSecretId" yaml:"secretsManagerSecretId"` // Fully qualified domain name of the endpoint. // // For an Amazon RDS SQL Server instance, this is the output of [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html) , in the `[Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html) .Address` field. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-servername // ServerName *string `field:"optional" json:"serverName" yaml:"serverName"` // Indicates the mode used to fetch CDC data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-tlogaccessmode // TlogAccessMode *string `field:"optional" json:"tlogAccessMode" yaml:"tlogAccessMode"` // Use the `TrimSpaceInChar` source endpoint setting to right-trim data on CHAR and NCHAR data types during migration. // // Setting `TrimSpaceInChar` does not left-trim data. The default value is `true` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-trimspaceinchar // TrimSpaceInChar interface{} `field:"optional" json:"trimSpaceInChar" yaml:"trimSpaceInChar"` // Use this to attribute to transfer data for full-load operations using BCP. // // When the target table contains an identity column that does not exist in the source table, you must disable the use BCP for loading table option. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-usebcpfullload // UseBcpFullLoad interface{} `field:"optional" json:"useBcpFullLoad" yaml:"useBcpFullLoad"` // Endpoint connection user name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-username // Username *string `field:"optional" json:"username" yaml:"username"` // When this attribute is set to `Y` , DMS processes third-party transaction log backups if they are created in native format. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html#cfn-dms-endpoint-microsoftsqlserversettings-usethirdpartybackupdevice // UseThirdPartyBackupDevice interface{} `field:"optional" json:"useThirdPartyBackupDevice" yaml:"useThirdPartyBackupDevice"` }
Provides information that defines a Microsoft SQL Server endpoint.
This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For information about other available settings, see [Extra connection attributes when using SQL Server as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SQLServer.html#CHAP_Source.SQLServer.ConnectionAttrib) and [Extra connection attributes when using SQL Server as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SQLServer.html#CHAP_Target.SQLServer.ConnectionAttrib) in the *AWS Database Migration Service User Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" microsoftSqlServerSettingsProperty := &MicrosoftSqlServerSettingsProperty{ BcpPacketSize: jsii.Number(123), ControlTablesFileGroup: jsii.String("controlTablesFileGroup"), DatabaseName: jsii.String("databaseName"), ForceLobLookup: jsii.Boolean(false), Password: jsii.String("password"), Port: jsii.Number(123), QuerySingleAlwaysOnNode: jsii.Boolean(false), ReadBackupOnly: jsii.Boolean(false), SafeguardPolicy: jsii.String("safeguardPolicy"), SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), ServerName: jsii.String("serverName"), TlogAccessMode: jsii.String("tlogAccessMode"), TrimSpaceInChar: jsii.Boolean(false), UseBcpFullLoad: jsii.Boolean(false), Username: jsii.String("username"), UseThirdPartyBackupDevice: jsii.Boolean(false), }
type CfnEndpoint_MongoDbSettingsProperty ¶
type CfnEndpoint_MongoDbSettingsProperty struct { // The authentication mechanism you use to access the MongoDB source endpoint. // // For the default value, in MongoDB version 2.x, `"default"` is `"mongodb_cr"` . For MongoDB version 3.x or later, `"default"` is `"scram_sha_1"` . This setting isn't used when `AuthType` is set to `"no"` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-authmechanism // AuthMechanism *string `field:"optional" json:"authMechanism" yaml:"authMechanism"` // The MongoDB database name. This setting isn't used when `AuthType` is set to `"no"` . // // The default is `"admin"` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-authsource // AuthSource *string `field:"optional" json:"authSource" yaml:"authSource"` // The authentication type you use to access the MongoDB source endpoint. // // When set to `"no"` , user name and password parameters are not used and can be empty. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-authtype // AuthType *string `field:"optional" json:"authType" yaml:"authType"` // The database name on the MongoDB source endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-databasename // DatabaseName *string `field:"optional" json:"databaseName" yaml:"databaseName"` // Indicates the number of documents to preview to determine the document organization. // // Use this setting when `NestingLevel` is set to `"one"` . // // Must be a positive value greater than `0` . Default value is `1000` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-docstoinvestigate // DocsToInvestigate *string `field:"optional" json:"docsToInvestigate" yaml:"docsToInvestigate"` // Specifies the document ID. Use this setting when `NestingLevel` is set to `"none"` . // // Default value is `"false"` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-extractdocid // ExtractDocId *string `field:"optional" json:"extractDocId" yaml:"extractDocId"` // Specifies either document or table mode. // // Default value is `"none"` . Specify `"none"` to use document mode. Specify `"one"` to use table mode. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-nestinglevel // NestingLevel *string `field:"optional" json:"nestingLevel" yaml:"nestingLevel"` // The password for the user account you use to access the MongoDB source endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-password // Password *string `field:"optional" json:"password" yaml:"password"` // The port value for the MongoDB source endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-port // Port *float64 `field:"optional" 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 MongoDB 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` , the corresponding `SecretsManagerAccessRoleArn` , and the `SecretsManagerSecretId` that is 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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-secretsmanageraccessrolearn // SecretsManagerAccessRoleArn *string `field:"optional" json:"secretsManagerAccessRoleArn" yaml:"secretsManagerAccessRoleArn"` // The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the MongoDB endpoint connection details. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-secretsmanagersecretid // SecretsManagerSecretId *string `field:"optional" json:"secretsManagerSecretId" yaml:"secretsManagerSecretId"` // The name of the server on the MongoDB source endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-servername // ServerName *string `field:"optional" json:"serverName" yaml:"serverName"` // The user name you use to access the MongoDB source endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-username // Username *string `field:"optional" json:"username" yaml:"username"` }
Provides information that defines a MongoDB endpoint.
This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For more information about other available settings, see [Endpoint configuration settings when using MongoDB as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html#CHAP_Source.MongoDB.Configuration) in the *AWS Database Migration Service User Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" mongoDbSettingsProperty := &MongoDbSettingsProperty{ AuthMechanism: jsii.String("authMechanism"), AuthSource: jsii.String("authSource"), AuthType: jsii.String("authType"), DatabaseName: jsii.String("databaseName"), DocsToInvestigate: jsii.String("docsToInvestigate"), ExtractDocId: jsii.String("extractDocId"), NestingLevel: jsii.String("nestingLevel"), Password: jsii.String("password"), Port: jsii.Number(123), SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), ServerName: jsii.String("serverName"), Username: jsii.String("username"), }
type CfnEndpoint_MySqlSettingsProperty ¶
type CfnEndpoint_MySqlSettingsProperty 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html#cfn-dms-endpoint-mysqlsettings-afterconnectscript // AfterConnectScript *string `field:"optional" json:"afterConnectScript" yaml:"afterConnectScript"` // Cleans and recreates table metadata information on the replication instance when a mismatch occurs. // // For example, in a situation where running an alter DDL on the table could result in different information about the table cached in the replication instance. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html#cfn-dms-endpoint-mysqlsettings-cleansourcemetadataonmismatch // CleanSourceMetadataOnMismatch interface{} `field:"optional" json:"cleanSourceMetadataOnMismatch" yaml:"cleanSourceMetadataOnMismatch"` // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html#cfn-dms-endpoint-mysqlsettings-eventspollinterval // EventsPollInterval *float64 `field:"optional" 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`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html#cfn-dms-endpoint-mysqlsettings-maxfilesize // MaxFileSize *float64 `field:"optional" 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`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html#cfn-dms-endpoint-mysqlsettings-parallelloadthreads // ParallelLoadThreads *float64 `field:"optional" json:"parallelLoadThreads" yaml:"parallelLoadThreads"` // 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` , the corresponding `SecretsManagerAccessRoleArn` , and the `SecretsManagerSecretId` that is 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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html#cfn-dms-endpoint-mysqlsettings-secretsmanageraccessrolearn // SecretsManagerAccessRoleArn *string `field:"optional" json:"secretsManagerAccessRoleArn" yaml:"secretsManagerAccessRoleArn"` // The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the MySQL endpoint connection details. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html#cfn-dms-endpoint-mysqlsettings-secretsmanagersecretid // SecretsManagerSecretId *string `field:"optional" json:"secretsManagerSecretId" yaml:"secretsManagerSecretId"` // Specifies the time zone for the source MySQL database. // // Example: `serverTimezone=US/Pacific;` // // Note: Do not enclose time zones in single quotes. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html#cfn-dms-endpoint-mysqlsettings-servertimezone // ServerTimezone *string `field:"optional" json:"serverTimezone" yaml:"serverTimezone"` // Specifies where to migrate source tables on the target, either to a single database or multiple databases. // // If you specify `SPECIFIC_DATABASE` , specify the database name using the `DatabaseName` parameter of the `Endpoint` object. // // Example: `targetDbType=MULTIPLE_DATABASES`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html#cfn-dms-endpoint-mysqlsettings-targetdbtype // TargetDbType *string `field:"optional" json:"targetDbType" yaml:"targetDbType"` }
Provides information that defines a MySQL endpoint.
This information includes the output format of records applied to the endpoint and details of transaction and control table data information. 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* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" mySqlSettingsProperty := &MySqlSettingsProperty{ AfterConnectScript: jsii.String("afterConnectScript"), CleanSourceMetadataOnMismatch: jsii.Boolean(false), EventsPollInterval: jsii.Number(123), MaxFileSize: jsii.Number(123), ParallelLoadThreads: jsii.Number(123), SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), ServerTimezone: jsii.String("serverTimezone"), TargetDbType: jsii.String("targetDbType"), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html#cfn-dms-endpoint-neptunesettings-errorretryduration // ErrorRetryDuration *float64 `field:"optional" json:"errorRetryDuration" yaml:"errorRetryDuration"` // If you want 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html#cfn-dms-endpoint-neptunesettings-iamauthenabled // IamAuthEnabled interface{} `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html#cfn-dms-endpoint-neptunesettings-maxfilesize // MaxFileSize *float64 `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html#cfn-dms-endpoint-neptunesettings-maxretrycount // MaxRetryCount *float64 `field:"optional" json:"maxRetryCount" yaml:"maxRetryCount"` // A folder path where you want AWS DMS to store migrated graph data in the S3 bucket specified by `S3BucketName`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html#cfn-dms-endpoint-neptunesettings-s3bucketfolder // S3BucketFolder *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html#cfn-dms-endpoint-neptunesettings-s3bucketname // S3BucketName *string `field:"optional" 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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html#cfn-dms-endpoint-neptunesettings-serviceaccessrolearn // ServiceAccessRoleArn *string `field:"optional" json:"serviceAccessRoleArn" yaml:"serviceAccessRoleArn"` }
Provides information that defines an Amazon Neptune endpoint.
This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For more information about the available settings, see [Specifying endpoint settings for Amazon Neptune as a target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings) in the *AWS Database Migration Service User Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" neptuneSettingsProperty := &NeptuneSettingsProperty{ ErrorRetryDuration: jsii.Number(123), IamAuthEnabled: jsii.Boolean(false), MaxFileSize: jsii.Number(123), MaxRetryCount: jsii.Number(123), S3BucketFolder: jsii.String("s3BucketFolder"), S3BucketName: jsii.String("s3BucketName"), ServiceAccessRoleArn: jsii.String("serviceAccessRoleArn"), }
type CfnEndpoint_OracleSettingsProperty ¶
type CfnEndpoint_OracleSettingsProperty struct { // Set this attribute to `false` in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. // // This tells the DMS instance to not access redo logs through any specified path prefix replacement using direct file access. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-accessalternatedirectly // AccessAlternateDirectly interface{} `field:"optional" json:"accessAlternateDirectly" yaml:"accessAlternateDirectly"` // Set this attribute with `ArchivedLogDestId` in a primary/ standby setup. // // This attribute is useful in the case of a switchover. In this case, AWS DMS needs to know which destination to get archive redo logs from to read changes. This need arises because the previous primary instance is now a standby instance after switchover. // // Although AWS DMS supports the use of the Oracle `RESETLOGS` option to open the database, never use `RESETLOGS` unless necessary. For additional information about `RESETLOGS` , see [RMAN Data Repair Concepts](https://docs.aws.amazon.com/https://docs.oracle.com/en/database/oracle/oracle-database/19/bradv/rman-data-repair-concepts.html#GUID-1805CCF7-4AF2-482D-B65A-998192F89C2B) in the *Oracle Database Backup and Recovery User's Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-additionalarchivedlogdestid // AdditionalArchivedLogDestId *float64 `field:"optional" json:"additionalArchivedLogDestId" yaml:"additionalArchivedLogDestId"` // Set this attribute to set up table-level supplemental logging for the Oracle database. // // This attribute enables PRIMARY KEY supplemental logging on all tables selected for a migration task. // // If you use this option, you still need to enable database-level supplemental logging. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-addsupplementallogging // AddSupplementalLogging interface{} `field:"optional" json:"addSupplementalLogging" yaml:"addSupplementalLogging"` // Set this attribute to `true` to enable replication of Oracle tables containing columns that are nested tables or defined types. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-allowselectnestedtables // AllowSelectNestedTables interface{} `field:"optional" json:"allowSelectNestedTables" yaml:"allowSelectNestedTables"` // Specifies the ID of the destination for the archived redo logs. // // This value should be the same as a number in the dest_id column of the v$archived_log view. If you work with an additional redo log destination, use the `AdditionalArchivedLogDestId` option to specify the additional destination ID. Doing this improves performance by ensuring that the correct logs are accessed from the outset. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-archivedlogdestid // ArchivedLogDestId *float64 `field:"optional" json:"archivedLogDestId" yaml:"archivedLogDestId"` // When this field is set to `Y` , AWS DMS only accesses the archived redo logs. // // If the archived redo logs are stored on Automatic Storage Management (ASM) only, the AWS DMS user account needs to be granted ASM privileges. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-archivedlogsonly // ArchivedLogsOnly interface{} `field:"optional" json:"archivedLogsOnly" yaml:"archivedLogsOnly"` // For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password. // // You can set this value from the `*asm_user_password*` value. You set this value as part of the comma-separated value that you set to the `Password` request parameter when you create the endpoint to access transaction logs using Binary Reader. For more information, see [Configuration for change data capture (CDC) on an Oracle source database](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-asmpassword // AsmPassword *string `field:"optional" json:"asmPassword" yaml:"asmPassword"` // For an Oracle source endpoint, your ASM server address. // // You can set this value from the `asm_server` value. You set `asm_server` as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see [Configuration for change data capture (CDC) on an Oracle source database](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-asmserver // AsmServer *string `field:"optional" json:"asmServer" yaml:"asmServer"` // For an Oracle source endpoint, your ASM user name. // // You can set this value from the `asm_user` value. You set `asm_user` as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see [Configuration for change data capture (CDC) on an Oracle source database](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-asmuser // AsmUser *string `field:"optional" json:"asmUser" yaml:"asmUser"` // Specifies whether the length of a character column is in bytes or in characters. // // To indicate that the character column length is in characters, set this attribute to `CHAR` . Otherwise, the character column length is in bytes. // // Example: `charLengthSemantics=CHAR;`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-charlengthsemantics // CharLengthSemantics *string `field:"optional" json:"charLengthSemantics" yaml:"charLengthSemantics"` // When set to `true` , this attribute helps to increase the commit rate on the Oracle target database by writing directly to tables and not writing a trail to database logs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-directpathnolog // DirectPathNoLog interface{} `field:"optional" json:"directPathNoLog" yaml:"directPathNoLog"` // When set to `true` , this attribute specifies a parallel load when `useDirectPathFullLoad` is set to `Y` . // // This attribute also only applies when you use the AWS DMS parallel load feature. Note that the target table cannot have any constraints or indexes. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-directpathparallelload // DirectPathParallelLoad interface{} `field:"optional" json:"directPathParallelLoad" yaml:"directPathParallelLoad"` // Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-enablehomogenoustablespace // EnableHomogenousTablespace interface{} `field:"optional" json:"enableHomogenousTablespace" yaml:"enableHomogenousTablespace"` // Specifies the IDs of one more destinations for one or more archived redo logs. // // These IDs are the values of the `dest_id` column in the `v$archived_log` view. Use this setting with the `archivedLogDestId` extra connection attribute in a primary-to-single setup or a primary-to-multiple-standby setup. // // This setting is useful in a switchover when you use an Oracle Data Guard database as a source. In this case, AWS DMS needs information about what destination to get archive redo logs from to read changes. AWS DMS needs this because after the switchover the previous primary is a standby instance. For example, in a primary-to-single standby setup you might apply the following settings. // // `archivedLogDestId=1; ExtraArchivedLogDestIds=[2]` // // In a primary-to-multiple-standby setup, you might apply the following settings. // // `archivedLogDestId=1; ExtraArchivedLogDestIds=[2,3,4]` // // Although AWS DMS supports the use of the Oracle `RESETLOGS` option to open the database, never use `RESETLOGS` unless it's necessary. For more information about `RESETLOGS` , see [RMAN Data Repair Concepts](https://docs.aws.amazon.com/https://docs.oracle.com/en/database/oracle/oracle-database/19/bradv/rman-data-repair-concepts.html#GUID-1805CCF7-4AF2-482D-B65A-998192F89C2B) in the *Oracle Database Backup and Recovery User's Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-extraarchivedlogdestids // ExtraArchivedLogDestIds interface{} `field:"optional" json:"extraArchivedLogDestIds" yaml:"extraArchivedLogDestIds"` // When set to `true` , this attribute causes a task to fail if the actual size of an LOB column is greater than the specified `LobMaxSize` . // // If a task is set to limited LOB mode and this option is set to `true` , the task fails instead of truncating the LOB data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-failtasksonlobtruncation // FailTasksOnLobTruncation interface{} `field:"optional" json:"failTasksOnLobTruncation" yaml:"failTasksOnLobTruncation"` // Specifies the number scale. // // You can select a scale up to 38, or you can select FLOAT. By default, the NUMBER data type is converted to precision 38, scale 10. // // Example: `numberDataTypeScale=12`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-numberdatatypescale // NumberDatatypeScale *float64 `field:"optional" json:"numberDatatypeScale" yaml:"numberDatatypeScale"` // Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. // // This value specifies the default Oracle root used to access the redo logs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-oraclepathprefix // OraclePathPrefix *string `field:"optional" json:"oraclePathPrefix" yaml:"oraclePathPrefix"` // Set this attribute to change the number of threads that DMS configures to perform a change data capture (CDC) load using Oracle Automatic Storage Management (ASM). // // You can specify an integer value between 2 (the default) and 8 (the maximum). Use this attribute together with the `readAheadBlocks` attribute. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-parallelasmreadthreads // ParallelAsmReadThreads *float64 `field:"optional" json:"parallelAsmReadThreads" yaml:"parallelAsmReadThreads"` // Set this attribute to change the number of read-ahead blocks that DMS configures to perform a change data capture (CDC) load using Oracle Automatic Storage Management (ASM). // // You can specify an integer value between 1000 (the default) and 200,000 (the maximum). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-readaheadblocks // ReadAheadBlocks *float64 `field:"optional" json:"readAheadBlocks" yaml:"readAheadBlocks"` // When set to `true` , this attribute supports tablespace replication. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-readtablespacename // ReadTableSpaceName interface{} `field:"optional" json:"readTableSpaceName" yaml:"readTableSpaceName"` // Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. // // This setting tells DMS instance to replace the default Oracle root with the specified `usePathPrefix` setting to access the redo logs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-replacepathprefix // ReplacePathPrefix interface{} `field:"optional" json:"replacePathPrefix" yaml:"replacePathPrefix"` // Specifies the number of seconds that the system waits before resending a query. // // Example: `retryInterval=6;`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-retryinterval // RetryInterval *float64 `field:"optional" json:"retryInterval" yaml:"retryInterval"` // 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 Oracle 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` , the corresponding `SecretsManagerAccessRoleArn` , and the `SecretsManagerSecretId` that is 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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-secretsmanageraccessrolearn // SecretsManagerAccessRoleArn *string `field:"optional" json:"secretsManagerAccessRoleArn" yaml:"secretsManagerAccessRoleArn"` // Required only if your Oracle endpoint uses Advanced Storage Manager (ASM). // // The full ARN of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the `SecretsManagerOracleAsmSecret` . This `SecretsManagerOracleAsmSecret` has the secret value that allows access to the Oracle ASM of the endpoint. // // > You can specify one of two sets of values for these permissions. You can specify the values for this setting and `SecretsManagerOracleAsmSecretId` . Or you can specify clear-text values for `AsmUser` , `AsmPassword` , and `AsmServerName` . You can't specify both. // > // > For more information on creating this `SecretsManagerOracleAsmSecret` , the corresponding `SecretsManagerOracleAsmAccessRoleArn` , and the `SecretsManagerOracleAsmSecretId` that is 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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-secretsmanageroracleasmaccessrolearn // SecretsManagerOracleAsmAccessRoleArn *string `field:"optional" json:"secretsManagerOracleAsmAccessRoleArn" yaml:"secretsManagerOracleAsmAccessRoleArn"` // Required only if your Oracle endpoint uses Advanced Storage Manager (ASM). // // The full ARN, partial ARN, or display name of the `SecretsManagerOracleAsmSecret` that contains the Oracle ASM connection details for the Oracle endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-secretsmanageroracleasmsecretid // SecretsManagerOracleAsmSecretId *string `field:"optional" json:"secretsManagerOracleAsmSecretId" yaml:"secretsManagerOracleAsmSecretId"` // The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the Oracle endpoint connection details. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-secretsmanagersecretid // SecretsManagerSecretId *string `field:"optional" json:"secretsManagerSecretId" yaml:"secretsManagerSecretId"` // For an Oracle source endpoint, the transparent data encryption (TDE) password required by AWM DMS to access Oracle redo logs encrypted by TDE using Binary Reader. // // It is also the `*TDE_Password*` part of the comma-separated value you set to the `Password` request parameter when you create the endpoint. The `SecurityDbEncryptian` setting is related to this `SecurityDbEncryptionName` setting. For more information, see [Supported encryption methods for using Oracle as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.Encryption) in the *AWS Database Migration Service User Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-securitydbencryption // SecurityDbEncryption *string `field:"optional" json:"securityDbEncryption" yaml:"securityDbEncryption"` // For an Oracle source endpoint, the name of a key used for the transparent data encryption (TDE) of the columns and tablespaces in an Oracle source database that is encrypted using TDE. // // The key value is the value of the `SecurityDbEncryption` setting. For more information on setting the key name value of `SecurityDbEncryptionName` , see the information and example for setting the `securityDbEncryptionName` extra connection attribute in [Supported encryption methods for using Oracle as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.Encryption) in the *AWS Database Migration Service User Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-securitydbencryptionname // SecurityDbEncryptionName *string `field:"optional" json:"securityDbEncryptionName" yaml:"securityDbEncryptionName"` // Use this attribute to convert `SDO_GEOMETRY` to `GEOJSON` format. // // By default, DMS calls the `SDO2GEOJSON` custom function if present and accessible. Or you can create your own custom function that mimics the operation of `SDOGEOJSON` and set `SpatialDataOptionToGeoJsonFunctionName` to call it instead. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-spatialdataoptiontogeojsonfunctionname // SpatialDataOptionToGeoJsonFunctionName *string `field:"optional" json:"spatialDataOptionToGeoJsonFunctionName" yaml:"spatialDataOptionToGeoJsonFunctionName"` // Use this attribute to specify a time in minutes for the delay in standby sync. // // If the source is an Oracle Active Data Guard standby database, use this attribute to specify the time lag between primary and standby databases. // // In AWS DMS , you can create an Oracle CDC task that uses an Active Data Guard standby instance as a source for replicating ongoing changes. Doing this eliminates the need to connect to an active database that might be in production. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-standbydelaytime // StandbyDelayTime *float64 `field:"optional" json:"standbyDelayTime" yaml:"standbyDelayTime"` // Set this attribute to `true` in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. // // This tells the DMS instance to use any specified prefix replacement to access all online redo logs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-usealternatefolderforonline // UseAlternateFolderForOnline interface{} `field:"optional" json:"useAlternateFolderForOnline" yaml:"useAlternateFolderForOnline"` // Set this attribute to Y to capture change data using the Binary Reader utility. // // Set `UseLogminerReader` to N to set this attribute to Y. To use Binary Reader with Amazon RDS for Oracle as the source, you set additional attributes. For more information about using this setting with Oracle Automatic Storage Management (ASM), see [Using Oracle LogMiner or AWS DMS Binary Reader for CDC](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-usebfile // UseBFile interface{} `field:"optional" json:"useBFile" yaml:"useBFile"` // Set this attribute to Y to have AWS DMS use a direct path full load. // // Specify this value to use the direct path protocol in the Oracle Call Interface (OCI). By using this OCI protocol, you can bulk-load Oracle target tables during a full load. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-usedirectpathfullload // UseDirectPathFullLoad interface{} `field:"optional" json:"useDirectPathFullLoad" yaml:"useDirectPathFullLoad"` // Set this attribute to Y to capture change data using the Oracle LogMiner utility (the default). // // Set this attribute to N if you want to access the redo logs as a binary file. When you set `UseLogminerReader` to N, also set `UseBfile` to Y. For more information on this setting and using Oracle ASM, see [Using Oracle LogMiner or AWS DMS Binary Reader for CDC](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC) in the *AWS DMS User Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-uselogminerreader // UseLogminerReader interface{} `field:"optional" json:"useLogminerReader" yaml:"useLogminerReader"` // Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. // // This value specifies the path prefix used to replace the default Oracle root to access the redo logs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html#cfn-dms-endpoint-oraclesettings-usepathprefix // UsePathPrefix *string `field:"optional" json:"usePathPrefix" yaml:"usePathPrefix"` }
Provides information that defines an Oracle endpoint.
This information includes the output format of records applied to the endpoint and details of transaction and control table data information. 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* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" oracleSettingsProperty := &OracleSettingsProperty{ AccessAlternateDirectly: jsii.Boolean(false), AdditionalArchivedLogDestId: jsii.Number(123), AddSupplementalLogging: jsii.Boolean(false), AllowSelectNestedTables: jsii.Boolean(false), ArchivedLogDestId: jsii.Number(123), ArchivedLogsOnly: jsii.Boolean(false), AsmPassword: jsii.String("asmPassword"), AsmServer: jsii.String("asmServer"), AsmUser: jsii.String("asmUser"), CharLengthSemantics: jsii.String("charLengthSemantics"), DirectPathNoLog: jsii.Boolean(false), DirectPathParallelLoad: jsii.Boolean(false), EnableHomogenousTablespace: jsii.Boolean(false), ExtraArchivedLogDestIds: []interface{}{ jsii.Number(123), }, FailTasksOnLobTruncation: jsii.Boolean(false), NumberDatatypeScale: jsii.Number(123), OraclePathPrefix: jsii.String("oraclePathPrefix"), ParallelAsmReadThreads: jsii.Number(123), ReadAheadBlocks: jsii.Number(123), ReadTableSpaceName: jsii.Boolean(false), ReplacePathPrefix: jsii.Boolean(false), RetryInterval: jsii.Number(123), SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerOracleAsmAccessRoleArn: jsii.String("secretsManagerOracleAsmAccessRoleArn"), SecretsManagerOracleAsmSecretId: jsii.String("secretsManagerOracleAsmSecretId"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), SecurityDbEncryption: jsii.String("securityDbEncryption"), SecurityDbEncryptionName: jsii.String("securityDbEncryptionName"), SpatialDataOptionToGeoJsonFunctionName: jsii.String("spatialDataOptionToGeoJsonFunctionName"), StandbyDelayTime: jsii.Number(123), UseAlternateFolderForOnline: jsii.Boolean(false), UseBFile: jsii.Boolean(false), UseDirectPathFullLoad: jsii.Boolean(false), UseLogminerReader: jsii.Boolean(false), UsePathPrefix: jsii.String("usePathPrefix"), }
type CfnEndpoint_PostgreSqlSettingsProperty ¶
type CfnEndpoint_PostgreSqlSettingsProperty struct { // For use with change data capture (CDC) only, this attribute has AWS DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data. // // Example: `afterConnectScript=SET session_replication_role='replica'`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-afterconnectscript // AfterConnectScript *string `field:"optional" json:"afterConnectScript" yaml:"afterConnectScript"` // The Babelfish for Aurora PostgreSQL database name for the endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-babelfishdatabasename // BabelfishDatabaseName *string `field:"optional" json:"babelfishDatabaseName" yaml:"babelfishDatabaseName"` // To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts. // // You can later remove these artifacts. // // If this value is set to `True` , you don't have to create tables or triggers on the source database. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-captureddls // CaptureDdls interface{} `field:"optional" json:"captureDdls" yaml:"captureDdls"` // Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-databasemode // DatabaseMode *string `field:"optional" json:"databaseMode" yaml:"databaseMode"` // The schema in which the operational DDL database artifacts are created. // // The default value is `public` . // // Example: `ddlArtifactsSchema=xyzddlschema;`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-ddlartifactsschema // DdlArtifactsSchema *string `field:"optional" json:"ddlArtifactsSchema" yaml:"ddlArtifactsSchema"` // Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds. // // Example: `executeTimeout=100;`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-executetimeout // ExecuteTimeout *float64 `field:"optional" json:"executeTimeout" yaml:"executeTimeout"` // When set to `true` , this value causes a task to fail if the actual size of a LOB column is greater than the specified `LobMaxSize` . // // The default value is `false` . // // If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-failtasksonlobtruncation // FailTasksOnLobTruncation interface{} `field:"optional" json:"failTasksOnLobTruncation" yaml:"failTasksOnLobTruncation"` // The write-ahead log (WAL) heartbeat feature mimics a dummy transaction. // // By doing this, it prevents idle logical replication slots from holding onto old WAL logs, which can result in storage full situations on the source. This heartbeat keeps `restart_lsn` moving and prevents storage full scenarios. // // The default value is `false` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-heartbeatenable // HeartbeatEnable interface{} `field:"optional" json:"heartbeatEnable" yaml:"heartbeatEnable"` // Sets the WAL heartbeat frequency (in minutes). // // The default value is 5 minutes. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-heartbeatfrequency // HeartbeatFrequency *float64 `field:"optional" json:"heartbeatFrequency" yaml:"heartbeatFrequency"` // Sets the schema in which the heartbeat artifacts are created. // // The default value is `public` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-heartbeatschema // HeartbeatSchema *string `field:"optional" json:"heartbeatSchema" yaml:"heartbeatSchema"` // When true, lets PostgreSQL migrate the boolean type as boolean. // // By default, PostgreSQL migrates booleans as `varchar(5)` . You must set this setting on both the source and target endpoints for it to take effect. // // The default value is `false` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-mapbooleanasboolean // MapBooleanAsBoolean interface{} `field:"optional" json:"mapBooleanAsBoolean" yaml:"mapBooleanAsBoolean"` // Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL. // // The default value is 32,768 KB (32 MB). // // Example: `maxFileSize=512`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-maxfilesize // MaxFileSize *float64 `field:"optional" json:"maxFileSize" yaml:"maxFileSize"` // Specifies the plugin to use to create a replication slot. // // The default value is `pglogical` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-pluginname // PluginName *string `field:"optional" json:"pluginName" yaml:"pluginName"` // 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 PostgreSQL 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` , the corresponding `SecretsManagerAccessRoleArn` , and the `SecretsManagerSecretId` that is 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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-secretsmanageraccessrolearn // SecretsManagerAccessRoleArn *string `field:"optional" json:"secretsManagerAccessRoleArn" yaml:"secretsManagerAccessRoleArn"` // The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the PostgreSQL endpoint connection details. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-secretsmanagersecretid // SecretsManagerSecretId *string `field:"optional" json:"secretsManagerSecretId" yaml:"secretsManagerSecretId"` // Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the PostgreSQL source instance. // // When used with the `CdcStartPosition` request parameter for the AWS DMS API , this attribute also makes it possible to use native CDC start points. DMS verifies that the specified logical replication slot exists before starting the CDC load task. It also verifies that the task was created with a valid setting of `CdcStartPosition` . If the specified slot doesn't exist or the task doesn't have a valid `CdcStartPosition` setting, DMS raises an error. // // For more information about setting the `CdcStartPosition` request parameter, see [Determining a CDC native start point](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Task.CDC.html#CHAP_Task.CDC.StartPoint.Native) in the *AWS Database Migration Service User Guide* . For more information about using `CdcStartPosition` , see [CreateReplicationTask](https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html) , [StartReplicationTask](https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html) , and [ModifyReplicationTask](https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-slotname // SlotName *string `field:"optional" json:"slotName" yaml:"slotName"` }
Provides information that defines a PostgreSQL endpoint.
This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For information about other available settings, 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) and [Extra connection attributes when using PostgreSQL as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.PostgreSQL.html#CHAP_Target.PostgreSQL.ConnectionAttrib) in the *AWS Database Migration Service User Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" postgreSqlSettingsProperty := &PostgreSqlSettingsProperty{ AfterConnectScript: jsii.String("afterConnectScript"), BabelfishDatabaseName: jsii.String("babelfishDatabaseName"), CaptureDdls: jsii.Boolean(false), DatabaseMode: jsii.String("databaseMode"), DdlArtifactsSchema: jsii.String("ddlArtifactsSchema"), ExecuteTimeout: jsii.Number(123), FailTasksOnLobTruncation: jsii.Boolean(false), HeartbeatEnable: jsii.Boolean(false), HeartbeatFrequency: jsii.Number(123), HeartbeatSchema: jsii.String("heartbeatSchema"), MapBooleanAsBoolean: jsii.Boolean(false), MaxFileSize: jsii.Number(123), PluginName: jsii.String("pluginName"), SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), SlotName: jsii.String("slotName"), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redissettings.html#cfn-dms-endpoint-redissettings-authpassword // AuthPassword *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redissettings.html#cfn-dms-endpoint-redissettings-authtype // AuthType *string `field:"optional" json:"authType" yaml:"authType"` // The user name provided with the `auth-role` option of the `AuthType` setting for a Redis target endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redissettings.html#cfn-dms-endpoint-redissettings-authusername // AuthUserName *string `field:"optional" json:"authUserName" yaml:"authUserName"` // Transmission Control Protocol (TCP) port for the endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redissettings.html#cfn-dms-endpoint-redissettings-port // Port *float64 `field:"optional" json:"port" yaml:"port"` // Fully qualified domain name of the endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redissettings.html#cfn-dms-endpoint-redissettings-servername // ServerName *string `field:"optional" json:"serverName" yaml:"serverName"` // The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redissettings.html#cfn-dms-endpoint-redissettings-sslcacertificatearn // SslCaCertificateArn *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redissettings.html#cfn-dms-endpoint-redissettings-sslsecurityprotocol // SslSecurityProtocol *string `field:"optional" json:"sslSecurityProtocol" yaml:"sslSecurityProtocol"` }
Provides information that defines a Redis target endpoint.
This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For information about other available settings, see [Specifying endpoint settings for Redis as a target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Redis.html#CHAP_Target.Redis.EndpointSettings) in the *AWS Database Migration Service User Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" redisSettingsProperty := &RedisSettingsProperty{ AuthPassword: jsii.String("authPassword"), AuthType: jsii.String("authType"), AuthUserName: jsii.String("authUserName"), Port: jsii.Number(123), ServerName: jsii.String("serverName"), SslCaCertificateArn: jsii.String("sslCaCertificateArn"), SslSecurityProtocol: jsii.String("sslSecurityProtocol"), }
type CfnEndpoint_RedshiftSettingsProperty ¶
type CfnEndpoint_RedshiftSettingsProperty struct { // A value that indicates to allow any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error. // // You can choose `true` or `false` (the default). // // This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data doesn't match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-acceptanydate // AcceptAnyDate interface{} `field:"optional" json:"acceptAnyDate" yaml:"acceptAnyDate"` // Code to run after connecting. // // This parameter should contain the code itself, not the name of a file containing the code. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-afterconnectscript // AfterConnectScript *string `field:"optional" json:"afterConnectScript" yaml:"afterConnectScript"` // An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster. // // For full load mode, AWS DMS converts source records into .csv files and loads them to the *BucketFolder/TableID* path. AWS DMS uses the Redshift `COPY` command to upload the .csv files to the target table. The files are deleted once the `COPY` operation has finished. For more information, see [COPY](https://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html) in the *Amazon Redshift Database Developer Guide* . // // For change-data-capture (CDC) mode, AWS DMS creates a *NetChanges* table, and loads the .csv files to this *BucketFolder/NetChangesTableID* path. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-bucketfolder // BucketFolder *string `field:"optional" json:"bucketFolder" yaml:"bucketFolder"` // The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-bucketname // BucketName *string `field:"optional" json:"bucketName" yaml:"bucketName"` // If Amazon Redshift is configured to support case sensitive schema names, set `CaseSensitiveNames` to `true` . // // The default is `false` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-casesensitivenames // CaseSensitiveNames interface{} `field:"optional" json:"caseSensitiveNames" yaml:"caseSensitiveNames"` // If you set `CompUpdate` to `true` Amazon Redshift applies automatic compression if the table is empty. // // This applies even if the table columns already have encodings other than `RAW` . If you set `CompUpdate` to `false` , automatic compression is disabled and existing column encodings aren't changed. The default is `true` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-compupdate // CompUpdate interface{} `field:"optional" json:"compUpdate" yaml:"compUpdate"` // A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-connectiontimeout // ConnectionTimeout *float64 `field:"optional" json:"connectionTimeout" yaml:"connectionTimeout"` // The date format that you are using. // // Valid values are `auto` (case-sensitive), your date format string enclosed in quotes, or NULL. If this parameter is left unset (NULL), it defaults to a format of 'YYYY-MM-DD'. Using `auto` recognizes most strings, even some that aren't supported when you use a date format string. // // If your date and time values use formats different from each other, set this to `auto` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-dateformat // DateFormat *string `field:"optional" json:"dateFormat" yaml:"dateFormat"` // A value that specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL. // // A value of `true` sets empty CHAR and VARCHAR fields to null. The default is `false` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-emptyasnull // EmptyAsNull interface{} `field:"optional" json:"emptyAsNull" yaml:"emptyAsNull"` // 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` , create an AWS Identity and Access Management (IAM) role with a policy that allows `"arn:aws:s3:::*"` to use the following actions: `"s3:PutObject", "s3:ListBucket"`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-encryptionmode // EncryptionMode *string `field:"optional" json:"encryptionMode" yaml:"encryptionMode"` // This setting is only valid for a full-load migration task. // // Set `ExplicitIds` to `true` to have tables with `IDENTITY` columns override their auto-generated values with explicit values loaded from the source data files used to populate the tables. The default is `false` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-explicitids // ExplicitIds interface{} `field:"optional" json:"explicitIds" yaml:"explicitIds"` // The number of threads used to upload a single file. // // This parameter accepts a value from 1 through 64. It defaults to 10. // // The number of parallel streams used to upload a single .csv file to an S3 bucket using S3 Multipart Upload. For more information, see [Multipart upload overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html) . // // `FileTransferUploadStreams` accepts a value from 1 through 64. It defaults to 10. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-filetransferuploadstreams // FileTransferUploadStreams *float64 `field:"optional" json:"fileTransferUploadStreams" yaml:"fileTransferUploadStreams"` // The amount of time to wait (in milliseconds) before timing out of operations performed by AWS DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-loadtimeout // LoadTimeout *float64 `field:"optional" json:"loadTimeout" yaml:"loadTimeout"` // When true, lets Redshift migrate the boolean type as boolean. // // By default, Redshift migrates booleans as `varchar(1)` . You must set this setting on both the source and target endpoints for it to take effect. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-mapbooleanasboolean // MapBooleanAsBoolean interface{} `field:"optional" json:"mapBooleanAsBoolean" yaml:"mapBooleanAsBoolean"` // The maximum size (in KB) of any .csv file used to load data on an S3 bucket and transfer data to Amazon Redshift. It defaults to 1048576KB (1 GB). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-maxfilesize // MaxFileSize *float64 `field:"optional" json:"maxFileSize" yaml:"maxFileSize"` // A value that specifies to remove surrounding quotation marks from strings in the incoming data. // // All characters within the quotation marks, including delimiters, are retained. Choose `true` to remove quotation marks. The default is `false` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-removequotes // RemoveQuotes interface{} `field:"optional" json:"removeQuotes" yaml:"removeQuotes"` // A value that specifies to replaces the invalid characters specified in `ReplaceInvalidChars` , substituting the specified characters instead. // // The default is `"?"` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-replacechars // ReplaceChars *string `field:"optional" json:"replaceChars" yaml:"replaceChars"` // A list of characters that you want to replace. // // Use with `ReplaceChars` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-replaceinvalidchars // ReplaceInvalidChars *string `field:"optional" json:"replaceInvalidChars" yaml:"replaceInvalidChars"` // 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 Amazon Redshift 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` , the corresponding `SecretsManagerAccessRoleArn` , and the `SecretsManagerSecretId` that is 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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-secretsmanageraccessrolearn // SecretsManagerAccessRoleArn *string `field:"optional" json:"secretsManagerAccessRoleArn" yaml:"secretsManagerAccessRoleArn"` // The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the Amazon Redshift endpoint connection details. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-secretsmanagersecretid // SecretsManagerSecretId *string `field:"optional" json:"secretsManagerSecretId" yaml:"secretsManagerSecretId"` // The AWS KMS key ID. // // If you are using `SSE_KMS` for the `EncryptionMode` , provide this key ID. The key that you use needs an attached policy that enables IAM user permissions and allows use of the key. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-serversideencryptionkmskeyid // ServerSideEncryptionKmsKeyId *string `field:"optional" json:"serverSideEncryptionKmsKeyId" yaml:"serverSideEncryptionKmsKeyId"` // The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service. // // The role must allow the `iam:PassRole` action. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-serviceaccessrolearn // ServiceAccessRoleArn *string `field:"optional" json:"serviceAccessRoleArn" yaml:"serviceAccessRoleArn"` // The time format that you want to use. // // Valid values are `auto` (case-sensitive), `'timeformat_string'` , `'epochsecs'` , or `'epochmillisecs'` . It defaults to 10. Using `auto` recognizes most strings, even some that aren't supported when you use a time format string. // // If your date and time values use formats different from each other, set this parameter to `auto` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-timeformat // TimeFormat *string `field:"optional" json:"timeFormat" yaml:"timeFormat"` // A value that specifies to remove the trailing white space characters from a VARCHAR string. // // This parameter applies only to columns with a VARCHAR data type. Choose `true` to remove unneeded white space. The default is `false` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-trimblanks // TrimBlanks interface{} `field:"optional" json:"trimBlanks" yaml:"trimBlanks"` // A value that specifies to truncate data in columns to the appropriate number of characters, so that the data fits in the column. // // This parameter applies only to columns with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less. Choose `true` to truncate data. The default is `false` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-truncatecolumns // TruncateColumns interface{} `field:"optional" json:"truncateColumns" yaml:"truncateColumns"` // The size (in KB) of the in-memory file write buffer used when generating .csv files on the local disk at the DMS replication instance. The default value is 1000 (buffer size is 1000KB). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-writebuffersize // WriteBufferSize *float64 `field:"optional" json:"writeBufferSize" yaml:"writeBufferSize"` }
Provides information that defines an Amazon Redshift endpoint.
This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For more information about other available settings, see [Extra connection attributes when using Amazon Redshift as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Redshift.html#CHAP_Target.Redshift.ConnectionAttrib) in the *AWS Database Migration Service User Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" redshiftSettingsProperty := &RedshiftSettingsProperty{ AcceptAnyDate: jsii.Boolean(false), AfterConnectScript: jsii.String("afterConnectScript"), BucketFolder: jsii.String("bucketFolder"), BucketName: jsii.String("bucketName"), CaseSensitiveNames: jsii.Boolean(false), CompUpdate: jsii.Boolean(false), ConnectionTimeout: jsii.Number(123), DateFormat: jsii.String("dateFormat"), EmptyAsNull: jsii.Boolean(false), EncryptionMode: jsii.String("encryptionMode"), ExplicitIds: jsii.Boolean(false), FileTransferUploadStreams: jsii.Number(123), LoadTimeout: jsii.Number(123), MapBooleanAsBoolean: jsii.Boolean(false), MaxFileSize: jsii.Number(123), RemoveQuotes: jsii.Boolean(false), ReplaceChars: jsii.String("replaceChars"), ReplaceInvalidChars: jsii.String("replaceInvalidChars"), SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), ServerSideEncryptionKmsKeyId: jsii.String("serverSideEncryptionKmsKeyId"), ServiceAccessRoleArn: jsii.String("serviceAccessRoleArn"), TimeFormat: jsii.String("timeFormat"), TrimBlanks: jsii.Boolean(false), TruncateColumns: jsii.Boolean(false), WriteBufferSize: jsii.Number(123), }
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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-addcolumnname // AddColumnName interface{} `field:"optional" json:"addColumnName" yaml:"addColumnName"` // Use the S3 target endpoint setting `AddTrailingPaddingCharacter` to add padding on string data. // // The default value is `false` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-addtrailingpaddingcharacter // AddTrailingPaddingCharacter interface{} `field:"optional" json:"addTrailingPaddingCharacter" yaml:"addTrailingPaddingCharacter"` // An optional parameter to set a folder name in the S3 bucket. // // If provided, tables are created in the path `*bucketFolder* / *schema_name* / *table_name* /` . If this parameter isn't specified, the path used is `*schema_name* / *table_name* /` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-bucketfolder // BucketFolder *string `field:"optional" json:"bucketFolder" yaml:"bucketFolder"` // The name of the S3 bucket. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-bucketname // BucketName *string `field:"optional" json:"bucketName" yaml:"bucketName"` // A value that enables AWS DMS to specify a predefined (canned) access control list (ACL) 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/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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-cannedaclforobjects // CannedAclForObjects *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-cdcinsertsandupdates // CdcInsertsAndUpdates interface{} `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-cdcinsertsonly // CdcInsertsOnly interface{} `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-cdcmaxbatchinterval // CdcMaxBatchInterval *float64 `field:"optional" json:"cdcMaxBatchInterval" yaml:"cdcMaxBatchInterval"` // Minimum file size, defined in kilobytes, 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-cdcminfilesize // CdcMinFileSize *float64 `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-cdcpath // CdcPath *string `field:"optional" json:"cdcPath" yaml:"cdcPath"` // An optional parameter. // // When set to GZIP it enables the service to compress the target files. To allow the service to write the target files uncompressed, either set this parameter to NONE (the default) or don't specify the parameter at all. This parameter applies to both .csv and .parquet file formats. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-compressiontype // CompressionType *string `field:"optional" json:"compressionType" yaml:"compressionType"` // The delimiter used to separate columns in the .csv file for both source and target. The default is a comma. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-csvdelimiter // CsvDelimiter *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-csvnosupvalue // CsvNoSupValue *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-csvnullvalue // CsvNullValue *string `field:"optional" json:"csvNullValue" yaml:"csvNullValue"` // The delimiter used to separate rows in the .csv file for both source and target. // // The default is a carriage return ( `\n` ). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-csvrowdelimiter // CsvRowDelimiter *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-dataformat // DataFormat *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-datapagesize // DataPageSize *float64 `field:"optional" 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-datepartitiondelimiter // DatePartitionDelimiter *string `field:"optional" 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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-datepartitionenabled // DatePartitionEnabled interface{} `field:"optional" 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-datepartitionsequence // DatePartitionSequence *string `field:"optional" 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 change data capture (CDC) file name 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"}'`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-datepartitiontimezone // DatePartitionTimezone *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-dictpagesizelimit // DictPageSizeLimit *float64 `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-enablestatistics // EnableStatistics interface{} `field:"optional" json:"enableStatistics" yaml:"enableStatistics"` // The type of encoding that you're 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-encodingtype // EncodingType *string `field:"optional" 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 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`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-encryptionmode // EncryptionMode *string `field:"optional" json:"encryptionMode" yaml:"encryptionMode"` // To specify a bucket owner and prevent sniping, you can use the `ExpectedBucketOwner` endpoint setting. // // Example: `--s3-settings='{"ExpectedBucketOwner": " *AWS_Account_ID* "}'` // // When you make a request to test a connection or perform a migration, S3 checks the account ID of the bucket owner against the specified parameter. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-expectedbucketowner // ExpectedBucketOwner *string `field:"optional" json:"expectedBucketOwner" yaml:"expectedBucketOwner"` // The external table definition. // // Conditional: If `S3` is used as a source then `ExternalTableDefinition` is required. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-externaltabledefinition // ExternalTableDefinition *string `field:"optional" json:"externalTableDefinition" yaml:"externalTableDefinition"` // When true, allows AWS Glue to catalog your S3 bucket. // // Creating an AWS Glue catalog lets you use Athena to query your data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-gluecataloggeneration // GlueCatalogGeneration interface{} `field:"optional" json:"glueCatalogGeneration" yaml:"glueCatalogGeneration"` // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-ignoreheaderrows // IgnoreHeaderRows *float64 `field:"optional" 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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-includeopforfullload // IncludeOpForFullLoad interface{} `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-maxfilesize // MaxFileSize *float64 `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-parquettimestampinmillisecond // ParquetTimestampInMillisecond interface{} `field:"optional" 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-parquetversion // ParquetVersion *string `field:"optional" json:"parquetVersion" yaml:"parquetVersion"` // If this setting is 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-preservetransactions // PreserveTransactions interface{} `field:"optional" 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-rfc4180 // Rfc4180 interface{} `field:"optional" 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). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-rowgrouplength // RowGroupLength *float64 `field:"optional" 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 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*`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-serversideencryptionkmskeyid // ServerSideEncryptionKmsKeyId *string `field:"optional" json:"serverSideEncryptionKmsKeyId" yaml:"serverSideEncryptionKmsKeyId"` // A required parameter that specifies the Amazon Resource Name (ARN) used by the service to access the IAM role. // // The role must allow the `iam:PassRole` action. It enables AWS DMS to read and write objects from an S3 bucket. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-serviceaccessrolearn // ServiceAccessRoleArn *string `field:"optional" 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. // // AWS 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-timestampcolumnname // TimestampColumnName *string `field:"optional" 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 this setting is 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 this setting isn't set or is 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-usecsvnosupvalue // UseCsvNoSupValue interface{} `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-usetaskstarttimeforfullloadtimestamp // UseTaskStartTimeForFullLoadTimestamp interface{} `field:"optional" json:"useTaskStartTimeForFullLoadTimestamp" yaml:"useTaskStartTimeForFullLoadTimestamp"` }
Provides information that defines an Amazon S3 endpoint.
This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For more information about the available settings, see [Extra connection attributes when using Amazon S3 as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.S3.html#CHAP_Source.S3.Configuring) and [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* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" s3SettingsProperty := &S3SettingsProperty{ AddColumnName: jsii.Boolean(false), AddTrailingPaddingCharacter: jsii.Boolean(false), BucketFolder: jsii.String("bucketFolder"), BucketName: jsii.String("bucketName"), CannedAclForObjects: jsii.String("cannedAclForObjects"), CdcInsertsAndUpdates: jsii.Boolean(false), CdcInsertsOnly: jsii.Boolean(false), CdcMaxBatchInterval: jsii.Number(123), CdcMinFileSize: jsii.Number(123), CdcPath: jsii.String("cdcPath"), CompressionType: jsii.String("compressionType"), CsvDelimiter: jsii.String("csvDelimiter"), CsvNoSupValue: jsii.String("csvNoSupValue"), CsvNullValue: jsii.String("csvNullValue"), CsvRowDelimiter: jsii.String("csvRowDelimiter"), DataFormat: jsii.String("dataFormat"), DataPageSize: jsii.Number(123), DatePartitionDelimiter: jsii.String("datePartitionDelimiter"), DatePartitionEnabled: jsii.Boolean(false), DatePartitionSequence: jsii.String("datePartitionSequence"), DatePartitionTimezone: jsii.String("datePartitionTimezone"), DictPageSizeLimit: jsii.Number(123), EnableStatistics: jsii.Boolean(false), EncodingType: jsii.String("encodingType"), EncryptionMode: jsii.String("encryptionMode"), ExpectedBucketOwner: jsii.String("expectedBucketOwner"), ExternalTableDefinition: jsii.String("externalTableDefinition"), GlueCatalogGeneration: jsii.Boolean(false), IgnoreHeaderRows: jsii.Number(123), IncludeOpForFullLoad: jsii.Boolean(false), MaxFileSize: jsii.Number(123), ParquetTimestampInMillisecond: jsii.Boolean(false), ParquetVersion: jsii.String("parquetVersion"), PreserveTransactions: jsii.Boolean(false), Rfc4180: jsii.Boolean(false), RowGroupLength: jsii.Number(123), ServerSideEncryptionKmsKeyId: jsii.String("serverSideEncryptionKmsKeyId"), ServiceAccessRoleArn: jsii.String("serviceAccessRoleArn"), TimestampColumnName: jsii.String("timestampColumnName"), UseCsvNoSupValue: jsii.Boolean(false), UseTaskStartTimeForFullLoadTimestamp: jsii.Boolean(false), }
type CfnEndpoint_SybaseSettingsProperty ¶
type CfnEndpoint_SybaseSettingsProperty struct { // 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 SAP ASE 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` , the corresponding `SecretsManagerAccessRoleArn` , and the `SecretsManagerSecretId` that is 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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-sybasesettings.html#cfn-dms-endpoint-sybasesettings-secretsmanageraccessrolearn // SecretsManagerAccessRoleArn *string `field:"optional" json:"secretsManagerAccessRoleArn" yaml:"secretsManagerAccessRoleArn"` // The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the SAP SAE endpoint connection details. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-sybasesettings.html#cfn-dms-endpoint-sybasesettings-secretsmanagersecretid // SecretsManagerSecretId *string `field:"optional" json:"secretsManagerSecretId" yaml:"secretsManagerSecretId"` }
Provides information that defines a SAP ASE endpoint.
This information includes the output format of records applied to the endpoint and details of transaction and control table data information. 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* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" sybaseSettingsProperty := &SybaseSettingsProperty{ SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), }
type CfnEventSubscription ¶
type CfnEventSubscription interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable AttrId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // Indicates whether to activate the subscription. Enabled() interface{} SetEnabled(val interface{}) // A list of event categories for a source type that you want to subscribe to. EventCategories() *[]*string SetEventCategories(val *[]*string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. SnsTopicArn() *string SetSnsTopicArn(val *string) // A list of identifiers for which AWS DMS provides notification events. SourceIds() *[]*string SetSourceIds(val *[]*string) // The type of AWS DMS resource that generates the events. SourceType() *string SetSourceType(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The name of the AWS DMS event notification subscription. SubscriptionName() *string SetSubscriptionName(val *string) // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // One or more tags to be assigned to the event subscription. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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 [Working with events and notifications in AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) in the *AWS Database Migration Service User Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnEventSubscription := awscdk.Aws_dms.NewCfnEventSubscription(this, jsii.String("MyCfnEventSubscription"), &CfnEventSubscriptionProps{ SnsTopicArn: jsii.String("snsTopicArn"), // the properties below are optional Enabled: jsii.Boolean(false), EventCategories: []*string{ jsii.String("eventCategories"), }, SourceIds: []*string{ jsii.String("sourceIds"), }, SourceType: jsii.String("sourceType"), SubscriptionName: jsii.String("subscriptionName"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnEventSubscription ¶
func NewCfnEventSubscription(scope constructs.Construct, id *string, props *CfnEventSubscriptionProps) CfnEventSubscription
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-snstopicarn // SnsTopicArn *string `field:"required" json:"snsTopicArn" yaml:"snsTopicArn"` // Indicates whether to activate the subscription. // // If you don't specify this property, AWS CloudFormation activates the subscription. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-enabled // Enabled interface{} `field:"optional" 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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-eventcategories // EventCategories *[]*string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-sourceids // SourceIds *[]*string `field:"optional" 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`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-sourcetype // SourceType *string `field:"optional" json:"sourceType" yaml:"sourceType"` // The name of the AWS DMS event notification subscription. // // This name must be less than 255 characters. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-subscriptionname // SubscriptionName *string `field:"optional" json:"subscriptionName" yaml:"subscriptionName"` // One or more tags to be assigned to the event subscription. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnEventSubscription`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnEventSubscriptionProps := &CfnEventSubscriptionProps{ SnsTopicArn: jsii.String("snsTopicArn"), // the properties below are optional Enabled: jsii.Boolean(false), EventCategories: []*string{ jsii.String("eventCategories"), }, SourceIds: []*string{ jsii.String("sourceIds"), }, SourceType: jsii.String("sourceType"), SubscriptionName: jsii.String("subscriptionName"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnInstanceProfile ¶ added in v2.115.0
type CfnInstanceProfile interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 // The Amazon Resource Name (ARN) string that uniquely identifies the instance profile. AttrInstanceProfileArn() *string // The time the instance profile was created. AttrInstanceProfileCreationTime() *string // The Availability Zone where the instance profile runs. AvailabilityZone() *string SetAvailabilityZone(val *string) // Tag Manager which manages the tags for this resource. CdkTagManager() awscdk.TagManager // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A description of the instance profile. Description() *string SetDescription(val *string) // The identifier of the instance profile. InstanceProfileIdentifier() *string SetInstanceProfileIdentifier(val *string) // The user-friendly name for the instance profile. InstanceProfileName() *string SetInstanceProfileName(val *string) // The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the connection parameters for the instance profile. KmsKeyArn() *string SetKmsKeyArn(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // Specifies the network type for the instance profile. NetworkType() *string SetNetworkType(val *string) // The tree node. Node() constructs.Node // Specifies the accessibility options for the instance profile. PubliclyAccessible() interface{} SetPubliclyAccessible(val interface{}) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The identifier of the subnet group that is associated with the instance profile. SubnetGroupIdentifier() *string SetSubnetGroupIdentifier(val *string) // An array of key-value pairs to apply to this resource. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The VPC security groups that are used with the instance profile. VpcSecurityGroups() *[]*string SetVpcSecurityGroups(val *[]*string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Provides information that defines an instance profile.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnInstanceProfile := awscdk.Aws_dms.NewCfnInstanceProfile(this, jsii.String("MyCfnInstanceProfile"), &CfnInstanceProfileProps{ AvailabilityZone: jsii.String("availabilityZone"), Description: jsii.String("description"), InstanceProfileIdentifier: jsii.String("instanceProfileIdentifier"), InstanceProfileName: jsii.String("instanceProfileName"), KmsKeyArn: jsii.String("kmsKeyArn"), NetworkType: jsii.String("networkType"), PubliclyAccessible: jsii.Boolean(false), SubnetGroupIdentifier: jsii.String("subnetGroupIdentifier"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, VpcSecurityGroups: []*string{ jsii.String("vpcSecurityGroups"), }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html
func NewCfnInstanceProfile ¶ added in v2.115.0
func NewCfnInstanceProfile(scope constructs.Construct, id *string, props *CfnInstanceProfileProps) CfnInstanceProfile
type CfnInstanceProfileProps ¶ added in v2.115.0
type CfnInstanceProfileProps struct { // The Availability Zone where the instance profile runs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-availabilityzone // AvailabilityZone *string `field:"optional" json:"availabilityZone" yaml:"availabilityZone"` // A description of the instance profile. // // Descriptions can have up to 31 characters. A description can contain only ASCII letters, digits, and hyphens ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-description // Description *string `field:"optional" json:"description" yaml:"description"` // The identifier of the instance profile. // // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-instanceprofileidentifier // InstanceProfileIdentifier *string `field:"optional" json:"instanceProfileIdentifier" yaml:"instanceProfileIdentifier"` // The user-friendly name for the instance profile. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-instanceprofilename // InstanceProfileName *string `field:"optional" json:"instanceProfileName" yaml:"instanceProfileName"` // The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the connection parameters for the instance profile. // // If you don't specify a value for the `KmsKeyArn` 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 . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-kmskeyarn // KmsKeyArn *string `field:"optional" json:"kmsKeyArn" yaml:"kmsKeyArn"` // Specifies the network type for the instance profile. // // A value of `IPV4` represents an instance profile with IPv4 network type and only supports IPv4 addressing. A value of `IPV6` represents an instance profile with IPv6 network type and only supports IPv6 addressing. A value of `DUAL` represents an instance profile with dual network type that supports IPv4 and IPv6 addressing. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-networktype // NetworkType *string `field:"optional" json:"networkType" yaml:"networkType"` // Specifies the accessibility options for the instance profile. // // A value of `true` represents an instance profile with a public IP address. A value of `false` represents an instance profile with a private IP address. The default value is `true` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-publiclyaccessible // // Default: - false. // PubliclyAccessible interface{} `field:"optional" json:"publiclyAccessible" yaml:"publiclyAccessible"` // The identifier of the subnet group that is associated with the instance profile. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-subnetgroupidentifier // SubnetGroupIdentifier *string `field:"optional" json:"subnetGroupIdentifier" yaml:"subnetGroupIdentifier"` // An array of key-value pairs to apply to this resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // The VPC security groups that are used with the instance profile. // // The VPC security group must work with the VPC containing the instance profile. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html#cfn-dms-instanceprofile-vpcsecuritygroups // VpcSecurityGroups *[]*string `field:"optional" json:"vpcSecurityGroups" yaml:"vpcSecurityGroups"` }
Properties for defining a `CfnInstanceProfile`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnInstanceProfileProps := &CfnInstanceProfileProps{ AvailabilityZone: jsii.String("availabilityZone"), Description: jsii.String("description"), InstanceProfileIdentifier: jsii.String("instanceProfileIdentifier"), InstanceProfileName: jsii.String("instanceProfileName"), KmsKeyArn: jsii.String("kmsKeyArn"), NetworkType: jsii.String("networkType"), PubliclyAccessible: jsii.Boolean(false), SubnetGroupIdentifier: jsii.String("subnetGroupIdentifier"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, VpcSecurityGroups: []*string{ jsii.String("vpcSecurityGroups"), }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html
type CfnMigrationProject ¶ added in v2.115.0
type CfnMigrationProject interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 // The ARN string that uniquely identifies the migration project. AttrMigrationProjectArn() *string // Tag Manager which manages the tags for this resource. CdkTagManager() awscdk.TagManager // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A user-friendly description of the migration project. Description() *string SetDescription(val *string) // The Amazon Resource Name (ARN) of the instance profile for your migration project. InstanceProfileArn() *string SetInstanceProfileArn(val *string) // The identifier of the instance profile for your migration project. InstanceProfileIdentifier() *string SetInstanceProfileIdentifier(val *string) // The name of the associated instance profile. InstanceProfileName() *string SetInstanceProfileName(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The property describes a creating time of the migration project. // Deprecated: this property has been deprecated. MigrationProjectCreationTime() *string // Deprecated: this property has been deprecated. SetMigrationProjectCreationTime(val *string) // The identifier of the migration project. MigrationProjectIdentifier() *string SetMigrationProjectIdentifier(val *string) // The name of the migration project. MigrationProjectName() *string SetMigrationProjectName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN. SchemaConversionApplicationAttributes() interface{} SetSchemaConversionApplicationAttributes(val interface{}) // Information about the source data provider, including the name or ARN, and AWS Secrets Manager parameters. SourceDataProviderDescriptors() interface{} SetSourceDataProviderDescriptors(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // An array of key-value pairs to apply to this resource. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // Information about the target data provider, including the name or ARN, and AWS Secrets Manager parameters. TargetDataProviderDescriptors() interface{} SetTargetDataProviderDescriptors(val interface{}) // The settings in JSON format for migration rules. TransformationRules() *string SetTransformationRules(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Provides information that defines a migration project.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnMigrationProject := awscdk.Aws_dms.NewCfnMigrationProject(this, jsii.String("MyCfnMigrationProject"), &CfnMigrationProjectProps{ Description: jsii.String("description"), InstanceProfileArn: jsii.String("instanceProfileArn"), InstanceProfileIdentifier: jsii.String("instanceProfileIdentifier"), InstanceProfileName: jsii.String("instanceProfileName"), MigrationProjectCreationTime: jsii.String("migrationProjectCreationTime"), MigrationProjectIdentifier: jsii.String("migrationProjectIdentifier"), MigrationProjectName: jsii.String("migrationProjectName"), SchemaConversionApplicationAttributes: &SchemaConversionApplicationAttributesProperty{ S3BucketPath: jsii.String("s3BucketPath"), S3BucketRoleArn: jsii.String("s3BucketRoleArn"), }, SourceDataProviderDescriptors: []interface{}{ &DataProviderDescriptorProperty{ DataProviderArn: jsii.String("dataProviderArn"), DataProviderIdentifier: jsii.String("dataProviderIdentifier"), DataProviderName: jsii.String("dataProviderName"), SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), }, }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, TargetDataProviderDescriptors: []interface{}{ &DataProviderDescriptorProperty{ DataProviderArn: jsii.String("dataProviderArn"), DataProviderIdentifier: jsii.String("dataProviderIdentifier"), DataProviderName: jsii.String("dataProviderName"), SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), }, }, TransformationRules: jsii.String("transformationRules"), })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html
func NewCfnMigrationProject ¶ added in v2.115.0
func NewCfnMigrationProject(scope constructs.Construct, id *string, props *CfnMigrationProjectProps) CfnMigrationProject
type CfnMigrationProjectProps ¶ added in v2.115.0
type CfnMigrationProjectProps struct { // A user-friendly description of the migration project. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-description // Description *string `field:"optional" json:"description" yaml:"description"` // The Amazon Resource Name (ARN) of the instance profile for your migration project. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-instanceprofilearn // InstanceProfileArn *string `field:"optional" json:"instanceProfileArn" yaml:"instanceProfileArn"` // The identifier of the instance profile for your migration project. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-instanceprofileidentifier // InstanceProfileIdentifier *string `field:"optional" json:"instanceProfileIdentifier" yaml:"instanceProfileIdentifier"` // The name of the associated instance profile. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-instanceprofilename // InstanceProfileName *string `field:"optional" json:"instanceProfileName" yaml:"instanceProfileName"` // The property describes a creating time of the migration project. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-migrationprojectcreationtime // // Deprecated: this property has been deprecated. MigrationProjectCreationTime *string `field:"optional" json:"migrationProjectCreationTime" yaml:"migrationProjectCreationTime"` // The identifier of the migration project. // // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-migrationprojectidentifier // MigrationProjectIdentifier *string `field:"optional" json:"migrationProjectIdentifier" yaml:"migrationProjectIdentifier"` // The name of the migration project. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-migrationprojectname // MigrationProjectName *string `field:"optional" json:"migrationProjectName" yaml:"migrationProjectName"` // The schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-schemaconversionapplicationattributes // SchemaConversionApplicationAttributes interface{} `field:"optional" json:"schemaConversionApplicationAttributes" yaml:"schemaConversionApplicationAttributes"` // Information about the source data provider, including the name or ARN, and AWS Secrets Manager parameters. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-sourcedataproviderdescriptors // SourceDataProviderDescriptors interface{} `field:"optional" json:"sourceDataProviderDescriptors" yaml:"sourceDataProviderDescriptors"` // An array of key-value pairs to apply to this resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // Information about the target data provider, including the name or ARN, and AWS Secrets Manager parameters. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-targetdataproviderdescriptors // TargetDataProviderDescriptors interface{} `field:"optional" json:"targetDataProviderDescriptors" yaml:"targetDataProviderDescriptors"` // The settings in JSON format for migration rules. // // Migration rules make it possible for you to change the object names according to the rules that you specify. For example, you can change an object name to lowercase or uppercase, add or remove a prefix or suffix, or rename objects. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html#cfn-dms-migrationproject-transformationrules // TransformationRules *string `field:"optional" json:"transformationRules" yaml:"transformationRules"` }
Properties for defining a `CfnMigrationProject`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnMigrationProjectProps := &CfnMigrationProjectProps{ Description: jsii.String("description"), InstanceProfileArn: jsii.String("instanceProfileArn"), InstanceProfileIdentifier: jsii.String("instanceProfileIdentifier"), InstanceProfileName: jsii.String("instanceProfileName"), MigrationProjectCreationTime: jsii.String("migrationProjectCreationTime"), MigrationProjectIdentifier: jsii.String("migrationProjectIdentifier"), MigrationProjectName: jsii.String("migrationProjectName"), SchemaConversionApplicationAttributes: &SchemaConversionApplicationAttributesProperty{ S3BucketPath: jsii.String("s3BucketPath"), S3BucketRoleArn: jsii.String("s3BucketRoleArn"), }, SourceDataProviderDescriptors: []interface{}{ &DataProviderDescriptorProperty{ DataProviderArn: jsii.String("dataProviderArn"), DataProviderIdentifier: jsii.String("dataProviderIdentifier"), DataProviderName: jsii.String("dataProviderName"), SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), }, }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, TargetDataProviderDescriptors: []interface{}{ &DataProviderDescriptorProperty{ DataProviderArn: jsii.String("dataProviderArn"), DataProviderIdentifier: jsii.String("dataProviderIdentifier"), DataProviderName: jsii.String("dataProviderName"), SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), }, }, TransformationRules: jsii.String("transformationRules"), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.html
type CfnMigrationProject_DataProviderDescriptorProperty ¶ added in v2.115.0
type CfnMigrationProject_DataProviderDescriptorProperty struct { // The Amazon Resource Name (ARN) of the data provider. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-migrationproject-dataproviderdescriptor.html#cfn-dms-migrationproject-dataproviderdescriptor-dataproviderarn // DataProviderArn *string `field:"optional" json:"dataProviderArn" yaml:"dataProviderArn"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-migrationproject-dataproviderdescriptor.html#cfn-dms-migrationproject-dataproviderdescriptor-dataprovideridentifier // DataProviderIdentifier *string `field:"optional" json:"dataProviderIdentifier" yaml:"dataProviderIdentifier"` // The user-friendly name of the data provider. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-migrationproject-dataproviderdescriptor.html#cfn-dms-migrationproject-dataproviderdescriptor-dataprovidername // DataProviderName *string `field:"optional" json:"dataProviderName" yaml:"dataProviderName"` // The ARN of the role used to access AWS Secrets Manager. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-migrationproject-dataproviderdescriptor.html#cfn-dms-migrationproject-dataproviderdescriptor-secretsmanageraccessrolearn // SecretsManagerAccessRoleArn *string `field:"optional" json:"secretsManagerAccessRoleArn" yaml:"secretsManagerAccessRoleArn"` // The identifier of the AWS Secrets Manager Secret used to store access credentials for the data provider. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-migrationproject-dataproviderdescriptor.html#cfn-dms-migrationproject-dataproviderdescriptor-secretsmanagersecretid // SecretsManagerSecretId *string `field:"optional" json:"secretsManagerSecretId" yaml:"secretsManagerSecretId"` }
Information about a data provider.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" dataProviderDescriptorProperty := &DataProviderDescriptorProperty{ DataProviderArn: jsii.String("dataProviderArn"), DataProviderIdentifier: jsii.String("dataProviderIdentifier"), DataProviderName: jsii.String("dataProviderName"), SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"), SecretsManagerSecretId: jsii.String("secretsManagerSecretId"), }
type CfnMigrationProject_SchemaConversionApplicationAttributesProperty ¶ added in v2.115.0
type CfnMigrationProject_SchemaConversionApplicationAttributesProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-migrationproject-schemaconversionapplicationattributes.html#cfn-dms-migrationproject-schemaconversionapplicationattributes-s3bucketpath // S3BucketPath *string `field:"optional" json:"s3BucketPath" yaml:"s3BucketPath"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-migrationproject-schemaconversionapplicationattributes.html#cfn-dms-migrationproject-schemaconversionapplicationattributes-s3bucketrolearn // S3BucketRoleArn *string `field:"optional" json:"s3BucketRoleArn" yaml:"s3BucketRoleArn"` }
The property describes schema conversion application attributes for the migration project.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" schemaConversionApplicationAttributesProperty := &SchemaConversionApplicationAttributesProperty{ S3BucketPath: jsii.String("s3BucketPath"), S3BucketRoleArn: jsii.String("s3BucketRoleArn"), }
type CfnReplicationConfig ¶ added in v2.91.0
type CfnReplicationConfig interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 // The Amazon Resource Name (ARN) of the Replication Config. AttrReplicationConfigArn() *string // Tag Manager which manages the tags for this resource. CdkTagManager() awscdk.TagManager // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Configuration parameters for provisioning an AWS DMS Serverless replication. ComputeConfig() interface{} SetComputeConfig(val interface{}) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // A unique identifier that you want to use to create a `ReplicationConfigArn` that is returned as part of the output from this action. ReplicationConfigIdentifier() *string SetReplicationConfigIdentifier(val *string) // Optional JSON settings for AWS DMS Serverless replications that are provisioned using this replication configuration. ReplicationSettings() interface{} SetReplicationSettings(val interface{}) // The type of AWS DMS Serverless replication to provision using this replication configuration. ReplicationType() *string SetReplicationType(val *string) // Optional unique value or name that you set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource. ResourceIdentifier() *string SetResourceIdentifier(val *string) // The Amazon Resource Name (ARN) of the source endpoint for this AWS DMS Serverless replication configuration. SourceEndpointArn() *string SetSourceEndpointArn(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Optional JSON settings for specifying supplemental data. SupplementalSettings() interface{} SetSupplementalSettings(val interface{}) // JSON table mappings for AWS DMS Serverless replications that are provisioned using this replication configuration. TableMappings() interface{} SetTableMappings(val interface{}) // One or more optional tags associated with resources used by the AWS DMS Serverless replication. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // The Amazon Resource Name (ARN) of the target endpoint for this AWS DMS serverless replication configuration. TargetEndpointArn() *string SetTargetEndpointArn(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var replicationSettings interface{} var supplementalSettings interface{} var tableMappings interface{} cfnReplicationConfig := awscdk.Aws_dms.NewCfnReplicationConfig(this, jsii.String("MyCfnReplicationConfig"), &CfnReplicationConfigProps{ ComputeConfig: &ComputeConfigProperty{ MaxCapacityUnits: jsii.Number(123), // the properties below are optional AvailabilityZone: jsii.String("availabilityZone"), DnsNameServers: jsii.String("dnsNameServers"), KmsKeyId: jsii.String("kmsKeyId"), MinCapacityUnits: jsii.Number(123), MultiAz: jsii.Boolean(false), PreferredMaintenanceWindow: jsii.String("preferredMaintenanceWindow"), ReplicationSubnetGroupId: jsii.String("replicationSubnetGroupId"), VpcSecurityGroupIds: []*string{ jsii.String("vpcSecurityGroupIds"), }, }, ReplicationConfigIdentifier: jsii.String("replicationConfigIdentifier"), ReplicationSettings: replicationSettings, ReplicationType: jsii.String("replicationType"), ResourceIdentifier: jsii.String("resourceIdentifier"), SourceEndpointArn: jsii.String("sourceEndpointArn"), SupplementalSettings: supplementalSettings, TableMappings: tableMappings, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, TargetEndpointArn: jsii.String("targetEndpointArn"), })
func NewCfnReplicationConfig ¶ added in v2.91.0
func NewCfnReplicationConfig(scope constructs.Construct, id *string, props *CfnReplicationConfigProps) CfnReplicationConfig
type CfnReplicationConfigProps ¶ added in v2.91.0
type CfnReplicationConfigProps struct { // Configuration parameters for provisioning an AWS DMS Serverless replication. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html#cfn-dms-replicationconfig-computeconfig // ComputeConfig interface{} `field:"optional" json:"computeConfig" yaml:"computeConfig"` // A unique identifier that you want to use to create a `ReplicationConfigArn` that is returned as part of the output from this action. // // You can then pass this output `ReplicationConfigArn` as the value of the `ReplicationConfigArn` option for other actions to identify both AWS DMS Serverless replications and replication configurations that you want those actions to operate on. For some actions, you can also use either this unique identifier or a corresponding ARN in action filters to identify the specific replication and replication configuration to operate on. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html#cfn-dms-replicationconfig-replicationconfigidentifier // ReplicationConfigIdentifier *string `field:"optional" json:"replicationConfigIdentifier" yaml:"replicationConfigIdentifier"` // Optional JSON settings for AWS DMS Serverless replications that are provisioned using this replication configuration. // // For example, see [Change processing tuning settings](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.ChangeProcessingTuning.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html#cfn-dms-replicationconfig-replicationsettings // ReplicationSettings interface{} `field:"optional" json:"replicationSettings" yaml:"replicationSettings"` // The type of AWS DMS Serverless replication to provision using this replication configuration. // // Possible values: // // - `"full-load"` // - `"cdc"` // - `"full-load-and-cdc"`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html#cfn-dms-replicationconfig-replicationtype // ReplicationType *string `field:"optional" json:"replicationType" yaml:"replicationType"` // Optional unique value or name that you set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource. // // For more information, see [Fine-grained access control using resource names and tags](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#CHAP_Security.FineGrainedAccess) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html#cfn-dms-replicationconfig-resourceidentifier // ResourceIdentifier *string `field:"optional" json:"resourceIdentifier" yaml:"resourceIdentifier"` // The Amazon Resource Name (ARN) of the source endpoint for this AWS DMS Serverless replication configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html#cfn-dms-replicationconfig-sourceendpointarn // SourceEndpointArn *string `field:"optional" json:"sourceEndpointArn" yaml:"sourceEndpointArn"` // Optional JSON settings for specifying supplemental data. // // For more information, see [Specifying supplemental data for task settings](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html#cfn-dms-replicationconfig-supplementalsettings // SupplementalSettings interface{} `field:"optional" json:"supplementalSettings" yaml:"supplementalSettings"` // JSON table mappings for AWS DMS Serverless replications that are provisioned using this replication configuration. // // For more information, see [Specifying table selection and transformations rules using JSON](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.SelectionTransformation.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html#cfn-dms-replicationconfig-tablemappings // TableMappings interface{} `field:"optional" json:"tableMappings" yaml:"tableMappings"` // One or more optional tags associated with resources used by the AWS DMS Serverless replication. // // For more information, see [Tagging resources in AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tagging.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html#cfn-dms-replicationconfig-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // The Amazon Resource Name (ARN) of the target endpoint for this AWS DMS serverless replication configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html#cfn-dms-replicationconfig-targetendpointarn // TargetEndpointArn *string `field:"optional" json:"targetEndpointArn" yaml:"targetEndpointArn"` }
Properties for defining a `CfnReplicationConfig`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var replicationSettings interface{} var supplementalSettings interface{} var tableMappings interface{} cfnReplicationConfigProps := &CfnReplicationConfigProps{ ComputeConfig: &ComputeConfigProperty{ MaxCapacityUnits: jsii.Number(123), // the properties below are optional AvailabilityZone: jsii.String("availabilityZone"), DnsNameServers: jsii.String("dnsNameServers"), KmsKeyId: jsii.String("kmsKeyId"), MinCapacityUnits: jsii.Number(123), MultiAz: jsii.Boolean(false), PreferredMaintenanceWindow: jsii.String("preferredMaintenanceWindow"), ReplicationSubnetGroupId: jsii.String("replicationSubnetGroupId"), VpcSecurityGroupIds: []*string{ jsii.String("vpcSecurityGroupIds"), }, }, ReplicationConfigIdentifier: jsii.String("replicationConfigIdentifier"), ReplicationSettings: replicationSettings, ReplicationType: jsii.String("replicationType"), ResourceIdentifier: jsii.String("resourceIdentifier"), SourceEndpointArn: jsii.String("sourceEndpointArn"), SupplementalSettings: supplementalSettings, TableMappings: tableMappings, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, TargetEndpointArn: jsii.String("targetEndpointArn"), }
type CfnReplicationConfig_ComputeConfigProperty ¶ added in v2.91.0
type CfnReplicationConfig_ComputeConfigProperty struct { // Specifies the maximum value of the AWS DMS capacity units (DCUs) for which a given AWS DMS Serverless replication can be provisioned. // // A single DCU is 2GB of RAM, with 1 DCU as the minimum value allowed. The list of valid DCU values includes 1, 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. So, the maximum value that you can specify for AWS DMS Serverless is 384. The `MaxCapacityUnits` parameter is the only DCU parameter you are required to specify. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-replicationconfig-computeconfig.html#cfn-dms-replicationconfig-computeconfig-maxcapacityunits // MaxCapacityUnits *float64 `field:"required" json:"maxCapacityUnits" yaml:"maxCapacityUnits"` // The Availability Zone where the AWS DMS Serverless replication using this configuration will run. // // The default value is a random, system-chosen Availability Zone in the configuration's AWS Region , for example, `"us-west-2"` . You can't set this parameter if the `MultiAZ` parameter is set to `true` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-replicationconfig-computeconfig.html#cfn-dms-replicationconfig-computeconfig-availabilityzone // AvailabilityZone *string `field:"optional" json:"availabilityZone" yaml:"availabilityZone"` // A list of custom DNS name servers supported for the AWS DMS Serverless replication to access your source or target database. // // This list overrides the default name servers supported by the AWS DMS Serverless replication. You can specify a comma-separated list of internet addresses for up to four DNS name servers. For example: `"1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-replicationconfig-computeconfig.html#cfn-dms-replicationconfig-computeconfig-dnsnameservers // DnsNameServers *string `field:"optional" json:"dnsNameServers" yaml:"dnsNameServers"` // An AWS Key Management Service ( AWS KMS ) key Amazon Resource Name (ARN) that is used to encrypt the data during AWS DMS Serverless replication. // // If you don't specify a value for the `KmsKeyId` parameter, AWS DMS uses your default encryption key. // // AWS KMS creates the default encryption key for your Amazon Web Services account. Your AWS account has a different default encryption key for each AWS Region . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-replicationconfig-computeconfig.html#cfn-dms-replicationconfig-computeconfig-kmskeyid // KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"` // Specifies the minimum value of the AWS DMS capacity units (DCUs) for which a given AWS DMS Serverless replication can be provisioned. // // A single DCU is 2GB of RAM, with 1 DCU as the minimum value allowed. The list of valid DCU values includes 1, 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. So, the minimum DCU value that you can specify for AWS DMS Serverless is 1. If you don't set this value, AWS DMS sets this parameter to the minimum DCU value allowed, 1. If there is no current source activity, AWS DMS scales down your replication until it reaches the value specified in `MinCapacityUnits` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-replicationconfig-computeconfig.html#cfn-dms-replicationconfig-computeconfig-mincapacityunits // MinCapacityUnits *float64 `field:"optional" json:"minCapacityUnits" yaml:"minCapacityUnits"` // Specifies whether the AWS DMS Serverless replication is a Multi-AZ deployment. // // You can't set the `AvailabilityZone` parameter if the `MultiAZ` parameter is set to `true` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-replicationconfig-computeconfig.html#cfn-dms-replicationconfig-computeconfig-multiaz // MultiAz interface{} `field:"optional" json:"multiAz" yaml:"multiAz"` // The weekly time range during which system maintenance can occur for the AWS DMS Serverless replication, in Universal Coordinated Time (UTC). // // The format is `ddd:hh24:mi-ddd:hh24:mi` . // // The default is a 30-minute window selected at random from an 8-hour block of time per AWS Region . This maintenance occurs on a random day of the week. Valid values for days of the week include `Mon` , `Tue` , `Wed` , `Thu` , `Fri` , `Sat` , and `Sun` . // // Constraints include a minimum 30-minute window. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-replicationconfig-computeconfig.html#cfn-dms-replicationconfig-computeconfig-preferredmaintenancewindow // PreferredMaintenanceWindow *string `field:"optional" json:"preferredMaintenanceWindow" yaml:"preferredMaintenanceWindow"` // Specifies a subnet group identifier to associate with the AWS DMS Serverless replication. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-replicationconfig-computeconfig.html#cfn-dms-replicationconfig-computeconfig-replicationsubnetgroupid // ReplicationSubnetGroupId *string `field:"optional" json:"replicationSubnetGroupId" yaml:"replicationSubnetGroupId"` // Specifies the virtual private cloud (VPC) security group to use with the AWS DMS Serverless replication. // // The VPC security group must work with the VPC containing the replication. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-replicationconfig-computeconfig.html#cfn-dms-replicationconfig-computeconfig-vpcsecuritygroupids // VpcSecurityGroupIds *[]*string `field:"optional" json:"vpcSecurityGroupIds" yaml:"vpcSecurityGroupIds"` }
Configuration parameters for provisioning an AWS DMS Serverless replication.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" computeConfigProperty := &ComputeConfigProperty{ MaxCapacityUnits: jsii.Number(123), // the properties below are optional AvailabilityZone: jsii.String("availabilityZone"), DnsNameServers: jsii.String("dnsNameServers"), KmsKeyId: jsii.String("kmsKeyId"), MinCapacityUnits: jsii.Number(123), MultiAz: jsii.Boolean(false), PreferredMaintenanceWindow: jsii.String("preferredMaintenanceWindow"), ReplicationSubnetGroupId: jsii.String("replicationSubnetGroupId"), VpcSecurityGroupIds: []*string{ jsii.String("vpcSecurityGroupIds"), }, }
type CfnReplicationInstance ¶
type CfnReplicationInstance interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The amount of storage (in gigabytes) to be initially allocated for the replication instance. AllocatedStorage() *float64 SetAllocatedStorage(val *float64) // Indicates that major version upgrades are allowed. AllowMajorVersionUpgrade() interface{} SetAllowMajorVersionUpgrade(val interface{}) AttrId() *string // One or more private IP addresses for the replication instance. AttrReplicationInstancePrivateIpAddresses() *string // One or more public IP addresses for the replication instance. AttrReplicationInstancePublicIpAddresses() *string // A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window. AutoMinorVersionUpgrade() interface{} SetAutoMinorVersionUpgrade(val interface{}) // The Availability Zone that the replication instance will be created in. AvailabilityZone() *string SetAvailabilityZone(val *string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The engine version number of the replication instance. EngineVersion() *string SetEngineVersion(val *string) // An AWS KMS key identifier that is used to encrypt the data on the replication instance. KmsKeyId() *string SetKmsKeyId(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // Specifies whether the replication instance is a Multi-AZ deployment. MultiAz() interface{} SetMultiAz(val interface{}) // The tree node. Node() constructs.Node // The weekly time range during which system maintenance can occur, in UTC. PreferredMaintenanceWindow() *string SetPreferredMaintenanceWindow(val *string) // Specifies the accessibility options for the replication instance. PubliclyAccessible() interface{} SetPubliclyAccessible(val interface{}) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The compute and memory capacity of the replication instance as defined for the specified replication instance class. ReplicationInstanceClass() *string SetReplicationInstanceClass(val *string) // The replication instance identifier. // // This parameter is stored as a lowercase string. ReplicationInstanceIdentifier() *string SetReplicationInstanceIdentifier(val *string) // A subnet group to associate with the replication instance. ReplicationSubnetGroupIdentifier() *string SetReplicationSubnetGroupIdentifier(val *string) // A display name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object. ResourceIdentifier() *string SetResourceIdentifier(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // One or more tags to be assigned to the replication instance. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Specifies the virtual private cloud (VPC) security group to be used with the replication instance. VpcSecurityGroupIds() *[]*string SetVpcSecurityGroupIds(val *[]*string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
The `AWS::DMS::ReplicationInstance` resource creates an AWS DMS replication instance.
To create a ReplicationInstance, you need permissions to create instances. You'll need similar permissions to terminate instances when you delete stacks with instances.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnReplicationInstance := awscdk.Aws_dms.NewCfnReplicationInstance(this, jsii.String("MyCfnReplicationInstance"), &CfnReplicationInstanceProps{ ReplicationInstanceClass: jsii.String("replicationInstanceClass"), // the properties below are optional AllocatedStorage: jsii.Number(123), AllowMajorVersionUpgrade: jsii.Boolean(false), AutoMinorVersionUpgrade: jsii.Boolean(false), AvailabilityZone: jsii.String("availabilityZone"), EngineVersion: jsii.String("engineVersion"), KmsKeyId: jsii.String("kmsKeyId"), MultiAz: jsii.Boolean(false), PreferredMaintenanceWindow: jsii.String("preferredMaintenanceWindow"), PubliclyAccessible: jsii.Boolean(false), ReplicationInstanceIdentifier: jsii.String("replicationInstanceIdentifier"), ReplicationSubnetGroupIdentifier: jsii.String("replicationSubnetGroupIdentifier"), ResourceIdentifier: jsii.String("resourceIdentifier"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, VpcSecurityGroupIds: []*string{ jsii.String("vpcSecurityGroupIds"), }, })
func NewCfnReplicationInstance ¶
func NewCfnReplicationInstance(scope constructs.Construct, id *string, props *CfnReplicationInstanceProps) CfnReplicationInstance
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) in the *AWS Database Migration Service User Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-replicationinstanceclass // ReplicationInstanceClass *string `field:"required" json:"replicationInstanceClass" yaml:"replicationInstanceClass"` // The amount of storage (in gigabytes) to be initially allocated for the replication instance. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-allocatedstorage // AllocatedStorage *float64 `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-allowmajorversionupgrade // AllowMajorVersionUpgrade interface{} `field:"optional" 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`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-autominorversionupgrade // AutoMinorVersionUpgrade interface{} `field:"optional" 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-availabilityzone // AvailabilityZone *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-engineversion // EngineVersion *string `field:"optional" 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, 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 . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-kmskeyid // KmsKeyId *string `field:"optional" 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-multiaz // MultiAz interface{} `field:"optional" json:"multiAz" yaml:"multiAz"` // The weekly time range during which system maintenance can occur, in 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* ( `ddd` ): `Mon` | `Tue` | `Wed` | `Thu` | `Fri` | `Sat` | `Sun` // // *Constraints* : Minimum 30-minute window. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-preferredmaintenancewindow // PreferredMaintenanceWindow *string `field:"optional" 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-publiclyaccessible // PubliclyAccessible interface{} `field:"optional" 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`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-replicationinstanceidentifier // ReplicationInstanceIdentifier *string `field:"optional" json:"replicationInstanceIdentifier" yaml:"replicationInstanceIdentifier"` // A subnet group to associate with the replication instance. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-replicationsubnetgroupidentifier // ReplicationSubnetGroupIdentifier *string `field:"optional" json:"replicationSubnetGroupIdentifier" yaml:"replicationSubnetGroupIdentifier"` // A display 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-resourceidentifier // ResourceIdentifier *string `field:"optional" json:"resourceIdentifier" yaml:"resourceIdentifier"` // One or more tags to be assigned to the replication instance. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // Specifies the virtual private cloud (VPC) security group to be used with the replication instance. // // The VPC security group must work with the VPC containing the replication instance. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-vpcsecuritygroupids // VpcSecurityGroupIds *[]*string `field:"optional" json:"vpcSecurityGroupIds" yaml:"vpcSecurityGroupIds"` }
Properties for defining a `CfnReplicationInstance`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnReplicationInstanceProps := &CfnReplicationInstanceProps{ ReplicationInstanceClass: jsii.String("replicationInstanceClass"), // the properties below are optional AllocatedStorage: jsii.Number(123), AllowMajorVersionUpgrade: jsii.Boolean(false), AutoMinorVersionUpgrade: jsii.Boolean(false), AvailabilityZone: jsii.String("availabilityZone"), EngineVersion: jsii.String("engineVersion"), KmsKeyId: jsii.String("kmsKeyId"), MultiAz: jsii.Boolean(false), PreferredMaintenanceWindow: jsii.String("preferredMaintenanceWindow"), PubliclyAccessible: jsii.Boolean(false), ReplicationInstanceIdentifier: jsii.String("replicationInstanceIdentifier"), ReplicationSubnetGroupIdentifier: jsii.String("replicationSubnetGroupIdentifier"), ResourceIdentifier: jsii.String("resourceIdentifier"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, VpcSecurityGroupIds: []*string{ jsii.String("vpcSecurityGroupIds"), }, }
type CfnReplicationSubnetGroup ¶
type CfnReplicationSubnetGroup interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable AttrId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The description for the subnet group. ReplicationSubnetGroupDescription() *string SetReplicationSubnetGroupDescription(val *string) // The identifier for the replication subnet group. ReplicationSubnetGroupIdentifier() *string SetReplicationSubnetGroupIdentifier(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // One or more subnet IDs to be assigned to the subnet group. SubnetIds() *[]*string SetSubnetIds(val *[]*string) // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // One or more tags to be assigned to the subnet group. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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 AWS Region .
> Resource creation fails if the `dms-vpc-role` AWS Identity and Access Management ( 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* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnReplicationSubnetGroup := awscdk.Aws_dms.NewCfnReplicationSubnetGroup(this, jsii.String("MyCfnReplicationSubnetGroup"), &CfnReplicationSubnetGroupProps{ ReplicationSubnetGroupDescription: jsii.String("replicationSubnetGroupDescription"), SubnetIds: []*string{ jsii.String("subnetIds"), }, // the properties below are optional ReplicationSubnetGroupIdentifier: jsii.String("replicationSubnetGroupIdentifier"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnReplicationSubnetGroup ¶
func NewCfnReplicationSubnetGroup(scope constructs.Construct, id *string, props *CfnReplicationSubnetGroupProps) CfnReplicationSubnetGroup
type CfnReplicationSubnetGroupProps ¶
type CfnReplicationSubnetGroupProps struct { // The description for the subnet group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationsubnetgroup.html#cfn-dms-replicationsubnetgroup-replicationsubnetgroupdescription // ReplicationSubnetGroupDescription *string `field:"required" json:"replicationSubnetGroupDescription" yaml:"replicationSubnetGroupDescription"` // One or more subnet IDs to be assigned to the subnet group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationsubnetgroup.html#cfn-dms-replicationsubnetgroup-subnetids // SubnetIds *[]*string `field:"required" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationsubnetgroup.html#cfn-dms-replicationsubnetgroup-replicationsubnetgroupidentifier // ReplicationSubnetGroupIdentifier *string `field:"optional" json:"replicationSubnetGroupIdentifier" yaml:"replicationSubnetGroupIdentifier"` // One or more tags to be assigned to the subnet group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationsubnetgroup.html#cfn-dms-replicationsubnetgroup-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnReplicationSubnetGroup`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnReplicationSubnetGroupProps := &CfnReplicationSubnetGroupProps{ ReplicationSubnetGroupDescription: jsii.String("replicationSubnetGroupDescription"), SubnetIds: []*string{ jsii.String("subnetIds"), }, // the properties below are optional ReplicationSubnetGroupIdentifier: jsii.String("replicationSubnetGroupIdentifier"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnReplicationTask ¶
type CfnReplicationTask interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable AttrId() *string // Indicates when you want a change data capture (CDC) operation to start. CdcStartPosition() *string SetCdcStartPosition(val *string) // Indicates the start time for a change data capture (CDC) operation. CdcStartTime() *float64 SetCdcStartTime(val *float64) // Indicates when you want a change data capture (CDC) operation to stop. CdcStopPosition() *string SetCdcStopPosition(val *string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The migration type. MigrationType() *string SetMigrationType(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The Amazon Resource Name (ARN) of a replication instance. ReplicationInstanceArn() *string SetReplicationInstanceArn(val *string) // An identifier for the replication task. ReplicationTaskIdentifier() *string SetReplicationTaskIdentifier(val *string) // Overall settings for the task, in JSON format. ReplicationTaskSettings() *string SetReplicationTaskSettings(val *string) // A display name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object. ResourceIdentifier() *string SetResourceIdentifier(val *string) // An Amazon Resource Name (ARN) that uniquely identifies the source endpoint. SourceEndpointArn() *string SetSourceEndpointArn(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The table mappings for the task, in JSON format. TableMappings() *string SetTableMappings(val *string) // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // One or more tags to be assigned to the replication task. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // An Amazon Resource Name (ARN) that uniquely identifies the target endpoint. TargetEndpointArn() *string SetTargetEndpointArn(val *string) // Supplemental information that the task requires to migrate the data for certain source and target endpoints. TaskData() *string SetTaskData(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
The `AWS::DMS::ReplicationTask` resource creates an AWS DMS replication task.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnReplicationTask := awscdk.Aws_dms.NewCfnReplicationTask(this, jsii.String("MyCfnReplicationTask"), &CfnReplicationTaskProps{ MigrationType: jsii.String("migrationType"), ReplicationInstanceArn: jsii.String("replicationInstanceArn"), SourceEndpointArn: jsii.String("sourceEndpointArn"), TableMappings: jsii.String("tableMappings"), TargetEndpointArn: jsii.String("targetEndpointArn"), // the properties below are optional CdcStartPosition: jsii.String("cdcStartPosition"), CdcStartTime: jsii.Number(123), CdcStopPosition: jsii.String("cdcStopPosition"), ReplicationTaskIdentifier: jsii.String("replicationTaskIdentifier"), ReplicationTaskSettings: jsii.String("replicationTaskSettings"), ResourceIdentifier: jsii.String("resourceIdentifier"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, TaskData: jsii.String("taskData"), })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html
func NewCfnReplicationTask ¶
func NewCfnReplicationTask(scope constructs.Construct, id *string, props *CfnReplicationTaskProps) CfnReplicationTask
type CfnReplicationTaskProps ¶
type CfnReplicationTaskProps struct { // The migration type. // // Valid values: `full-load` | `cdc` | `full-load-and-cdc`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-migrationtype // MigrationType *string `field:"required" json:"migrationType" yaml:"migrationType"` // The Amazon Resource Name (ARN) of a replication instance. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationinstancearn // ReplicationInstanceArn *string `field:"required" json:"replicationInstanceArn" yaml:"replicationInstanceArn"` // An Amazon Resource Name (ARN) that uniquely identifies the source endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-sourceendpointarn // SourceEndpointArn *string `field:"required" 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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-tablemappings // TableMappings *string `field:"required" json:"tableMappings" yaml:"tableMappings"` // An Amazon Resource Name (ARN) that uniquely identifies the target endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-targetendpointarn // TargetEndpointArn *string `field:"required" 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, log sequence number (LSN), or system change number (SCN) format. // // Here is a date example: `--cdc-start-position "2018-03-08T12:12:12"` // // Here is a 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"` // // Here is an 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) in the *AWS Database Migration Service User Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstartposition // CdcStartPosition *string `field:"optional" json:"cdcStartPosition" yaml:"cdcStartPosition"` // Indicates the start time for a change data capture (CDC) operation. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstarttime // CdcStartTime *float64 `field:"optional" 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. // // Here is a server time example: `--cdc-stop-position "server_time:2018-02-09T12:12:12"` // // Here is a commit time example: `--cdc-stop-position "commit_time: 2018-02-09T12:12:12"`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstopposition // CdcStopPosition *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationtaskidentifier // ReplicationTaskIdentifier *string `field:"optional" 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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationtasksettings // ReplicationTaskSettings *string `field:"optional" json:"replicationTaskSettings" yaml:"replicationTaskSettings"` // A display 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-resourceidentifier // ResourceIdentifier *string `field:"optional" json:"resourceIdentifier" yaml:"resourceIdentifier"` // One or more tags to be assigned to the replication task. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // Supplemental information that the task requires to migrate the data for certain source and target endpoints. // // For more information, see [Specifying Supplemental Data for Task Settings](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html) in the *AWS Database Migration Service User Guide.* // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-taskdata // TaskData *string `field:"optional" json:"taskData" yaml:"taskData"` }
Properties for defining a `CfnReplicationTask`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnReplicationTaskProps := &CfnReplicationTaskProps{ MigrationType: jsii.String("migrationType"), ReplicationInstanceArn: jsii.String("replicationInstanceArn"), SourceEndpointArn: jsii.String("sourceEndpointArn"), TableMappings: jsii.String("tableMappings"), TargetEndpointArn: jsii.String("targetEndpointArn"), // the properties below are optional CdcStartPosition: jsii.String("cdcStartPosition"), CdcStartTime: jsii.Number(123), CdcStopPosition: jsii.String("cdcStopPosition"), ReplicationTaskIdentifier: jsii.String("replicationTaskIdentifier"), ReplicationTaskSettings: jsii.String("replicationTaskSettings"), ResourceIdentifier: jsii.String("resourceIdentifier"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, TaskData: jsii.String("taskData"), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html
Source Files
¶
- CfnCertificate.go
- CfnCertificateProps.go
- CfnCertificate__checks.go
- CfnDataProvider.go
- CfnDataProviderProps.go
- CfnDataProvider__checks.go
- CfnEndpoint.go
- CfnEndpointProps.go
- CfnEndpoint_DocDbSettingsProperty.go
- CfnEndpoint_DynamoDbSettingsProperty.go
- CfnEndpoint_ElasticsearchSettingsProperty.go
- CfnEndpoint_GcpMySQLSettingsProperty.go
- CfnEndpoint_IbmDb2SettingsProperty.go
- CfnEndpoint_KafkaSettingsProperty.go
- CfnEndpoint_KinesisSettingsProperty.go
- CfnEndpoint_MicrosoftSqlServerSettingsProperty.go
- CfnEndpoint_MongoDbSettingsProperty.go
- CfnEndpoint_MySqlSettingsProperty.go
- CfnEndpoint_NeptuneSettingsProperty.go
- CfnEndpoint_OracleSettingsProperty.go
- CfnEndpoint_PostgreSqlSettingsProperty.go
- CfnEndpoint_RedisSettingsProperty.go
- CfnEndpoint_RedshiftSettingsProperty.go
- CfnEndpoint_S3SettingsProperty.go
- CfnEndpoint_SybaseSettingsProperty.go
- CfnEndpoint__checks.go
- CfnEventSubscription.go
- CfnEventSubscriptionProps.go
- CfnEventSubscription__checks.go
- CfnInstanceProfile.go
- CfnInstanceProfileProps.go
- CfnInstanceProfile__checks.go
- CfnMigrationProject.go
- CfnMigrationProjectProps.go
- CfnMigrationProject_DataProviderDescriptorProperty.go
- CfnMigrationProject_SchemaConversionApplicationAttributesProperty.go
- CfnMigrationProject__checks.go
- CfnReplicationConfig.go
- CfnReplicationConfigProps.go
- CfnReplicationConfig_ComputeConfigProperty.go
- CfnReplicationConfig__checks.go
- CfnReplicationInstance.go
- CfnReplicationInstanceProps.go
- CfnReplicationInstance__checks.go
- CfnReplicationSubnetGroup.go
- CfnReplicationSubnetGroupProps.go
- CfnReplicationSubnetGroup__checks.go
- CfnReplicationTask.go
- CfnReplicationTaskProps.go
- CfnReplicationTask__checks.go
- main.go