Skip to content

AWS.DMS.Endpoint

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html

Index

Fields

fn new

new(errorOnEmptyProp)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html

fn creationPolicy

creationPolicy(policy)

Associate the CreationPolicy attribute with a resource to prevent its status from reaching create complete until AWS CloudFormation receives a specified number of success signals or the timeout period is exceeded. To signal a resource, you can use the cfn-signal helper script or SignalResource API. CloudFormation publishes valid signals to the stack events so that you track the number of signals sent. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-creationpolicy.html

fn creationPolicyMixin

creationPolicyMixin(policy)

cf creationPolicy(), but return a merged object

fn deletionPolicy

deletionPolicy(policy)

With the DeletionPolicy attribute you can preserve, and in some cases, backup a resource when its stack is deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html

fn deletionPolicyMixin

deletionPolicyMixin(policy)

cf deletionPolicy(), but return a merged object

fn dependsOn

dependsOn(dependencies)

With the DependsOn attribute you can specify that the creation of a specific resource follows another. When you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource specified in the DependsOn attribute. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html

fn dependsOnMixin

dependsOnMixin(dependencies)

cf dependsOn(), but return a merged array

fn metadata

metadata(metadatas)

The metadata attribute enables you to associate structured data with a resource. By adding a metadata attribute to a resource, you can add data in JSON or YAML to the resource declaration. In addition, you can use intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the metadata attribute to add those interpreted values. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-metadata.html

fn metadataMixin

metadataMixin(metadatas)

cf metadata(), but return a merged object

fn updatePolicy

updatePolicy(policy)

Use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the AWS::AppStream::Fleet, AWS::AutoScaling::AutoScalingGroup, AWS::ElastiCache::ReplicationGroup, AWS::OpenSearchService::Domain, AWS::Elasticsearch::Domain, or AWS::Lambda::Alias resources. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html

fn updatePolicyMixin

updatePolicyMixin(policy)

cf `updatePolicy(), but return a merged object

fn updateReplacePolicy

updateReplacePolicy(policy)

Use the UpdateReplacePolicy attribute to retain or, in some cases, backup the existing physical instance of a resource when it's replaced during a stack update operation. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html

fn updateReplacePolicyMixin

updateReplacePolicyMixin(policy)

cf updateReplacePolicy, but return a merged object

fn withCertificateArn

withCertificateArn(certificateArn)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-certificatearn

fn withDatabaseName

withDatabaseName(databaseName)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-databasename

fn withDocDbSettings

withDocDbSettings(docDbSettings)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-docdbsettings

fn withDocDbSettingsMixin

withDocDbSettingsMixin(docDbSettings)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-docdbsettings

fn withDynamoDbSettings

withDynamoDbSettings(dynamoDbSettings)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-dynamodbsettings

fn withDynamoDbSettingsMixin

withDynamoDbSettingsMixin(dynamoDbSettings)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-dynamodbsettings

fn withElasticsearchSettings

withElasticsearchSettings(elasticsearchSettings)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-elasticsearchsettings

fn withElasticsearchSettingsMixin

withElasticsearchSettingsMixin(elasticsearchSettings)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-elasticsearchsettings

fn withEndpointIdentifier

withEndpointIdentifier(endpointIdentifier)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-endpointidentifier

fn withEndpointType

withEndpointType(endpointType)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-endpointtype

fn withEngineName

withEngineName(engineName)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-enginename

fn withExtraConnectionAttributes

withExtraConnectionAttributes(extraConnectionAttributes)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-extraconnectionattributes

fn withIbmDb2Settings

withIbmDb2Settings(ibmDb2settings)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-ibmdb2settings

fn withIbmDb2SettingsMixin

withIbmDb2SettingsMixin(ibmDb2settings)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-ibmdb2settings

fn withKafkaSettings

withKafkaSettings(kafkaSettings)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-kafkasettings

fn withKafkaSettingsMixin

withKafkaSettingsMixin(kafkaSettings)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-kafkasettings

fn withKinesisSettings

withKinesisSettings(kinesisSettings)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-kinesissettings

fn withKinesisSettingsMixin

withKinesisSettingsMixin(kinesisSettings)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-kinesissettings

fn withKmsKeyId

withKmsKeyId(kmsKeyId)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-kmskeyid

fn withMicrosoftSqlServerSettings

withMicrosoftSqlServerSettings(microsoftSqlServerSettings)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-microsoftsqlserversettings

fn withMicrosoftSqlServerSettingsMixin

withMicrosoftSqlServerSettingsMixin(microsoftSqlServerSettings)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-microsoftsqlserversettings

fn withMongoDbSettings

withMongoDbSettings(mongoDbSettings)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-mongodbsettings

fn withMongoDbSettingsMixin

withMongoDbSettingsMixin(mongoDbSettings)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-mongodbsettings

fn withMySqlSettings

withMySqlSettings(mySqlSettings)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-mysqlsettings

fn withMySqlSettingsMixin

withMySqlSettingsMixin(mySqlSettings)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-mysqlsettings

fn withNeptuneSettings

withNeptuneSettings(neptuneSettings)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-neptunesettings

fn withNeptuneSettingsMixin

withNeptuneSettingsMixin(neptuneSettings)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-neptunesettings

fn withOracleSettings

withOracleSettings(oracleSettings)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-oraclesettings

fn withOracleSettingsMixin

withOracleSettingsMixin(oracleSettings)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-oraclesettings

fn withPassword

withPassword(password)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-password

fn withPort

withPort(port)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-port

fn withPostgreSqlSettings

withPostgreSqlSettings(postgreSqlSettings)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-postgresqlsettings

fn withPostgreSqlSettingsMixin

withPostgreSqlSettingsMixin(postgreSqlSettings)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-postgresqlsettings

fn withRedshiftSettings

withRedshiftSettings(redshiftSettings)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-redshiftsettings

fn withRedshiftSettingsMixin

withRedshiftSettingsMixin(redshiftSettings)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-redshiftsettings

fn withResourceIdentifier

withResourceIdentifier(resourceIdentifier)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-resourceidentifier

fn withS3Settings

withS3Settings(s3settings)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-s3settings

fn withS3SettingsMixin

withS3SettingsMixin(s3settings)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-s3settings

fn withServerName

withServerName(serverName)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-servername

fn withSslMode

withSslMode(sslMode)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-sslmode

fn withSybaseSettings

withSybaseSettings(sybaseSettings)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-sybasesettings

fn withSybaseSettingsMixin

withSybaseSettingsMixin(sybaseSettings)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-sybasesettings

fn withTags

withTags(tags)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-tags

fn withTagsMixin

withTagsMixin(tags)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-tags

fn withUsername

withUsername(username)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-username