CfnEndpoint

class aws_cdk.aws_dms.CfnEndpoint(scope, id, *, endpoint_type, engine_name, certificate_arn=None, database_name=None, dynamo_db_settings=None, elasticsearch_settings=None, endpoint_identifier=None, extra_connection_attributes=None, kafka_settings=None, kinesis_settings=None, kms_key_id=None, mongo_db_settings=None, neptune_settings=None, password=None, port=None, s3_settings=None, server_name=None, ssl_mode=None, tags=None, username=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::DMS::Endpoint.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html cloudformationResource: :cloudformationResource:: AWS::DMS::Endpoint

__init__(scope, id, *, endpoint_type, engine_name, certificate_arn=None, database_name=None, dynamo_db_settings=None, elasticsearch_settings=None, endpoint_identifier=None, extra_connection_attributes=None, kafka_settings=None, kinesis_settings=None, kms_key_id=None, mongo_db_settings=None, neptune_settings=None, password=None, port=None, s3_settings=None, server_name=None, ssl_mode=None, tags=None, username=None)

Create a new AWS::DMS::Endpoint.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • endpoint_type (str) – AWS::DMS::Endpoint.EndpointType.

  • engine_name (str) – AWS::DMS::Endpoint.EngineName.

  • certificate_arn (Optional[str]) – AWS::DMS::Endpoint.CertificateArn.

  • database_name (Optional[str]) – AWS::DMS::Endpoint.DatabaseName.

  • dynamo_db_settings (Union[IResolvable, Forwardref, None]) – AWS::DMS::Endpoint.DynamoDbSettings.

  • elasticsearch_settings (Union[IResolvable, Forwardref, None]) – AWS::DMS::Endpoint.ElasticsearchSettings.

  • endpoint_identifier (Optional[str]) – AWS::DMS::Endpoint.EndpointIdentifier.

  • extra_connection_attributes (Optional[str]) – AWS::DMS::Endpoint.ExtraConnectionAttributes.

  • kafka_settings (Union[IResolvable, Forwardref, None]) – AWS::DMS::Endpoint.KafkaSettings.

  • kinesis_settings (Union[IResolvable, Forwardref, None]) – AWS::DMS::Endpoint.KinesisSettings.

  • kms_key_id (Optional[str]) – AWS::DMS::Endpoint.KmsKeyId.

  • mongo_db_settings (Union[IResolvable, Forwardref, None]) – AWS::DMS::Endpoint.MongoDbSettings.

  • neptune_settings (Union[IResolvable, Forwardref, None]) – AWS::DMS::Endpoint.NeptuneSettings.

  • password (Optional[str]) – AWS::DMS::Endpoint.Password.

  • port (Union[int, float, None]) – AWS::DMS::Endpoint.Port.

  • s3_settings (Union[IResolvable, Forwardref, None]) – AWS::DMS::Endpoint.S3Settings.

  • server_name (Optional[str]) – AWS::DMS::Endpoint.ServerName.

  • ssl_mode (Optional[str]) – AWS::DMS::Endpoint.SslMode.

  • tags (Optional[List[CfnTag]]) – AWS::DMS::Endpoint.Tags.

  • username (Optional[str]) – AWS::DMS::Endpoint.Username.

Return type

None

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

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.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

see :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.

Return type

None

add_override(path, value)

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.

For example:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

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.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

stability :stability: experimental

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

return :rtype: str :return: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::DMS::Endpoint'
attr_external_id

cloudformationAttribute: :cloudformationAttribute:: ExternalId

Return type

str

certificate_arn

AWS::DMS::Endpoint.CertificateArn.

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

Return type

Optional[str]

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return :rtype: List[str] :return:

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.

database_name

AWS::DMS::Endpoint.DatabaseName.

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

Return type

Optional[str]

dynamo_db_settings

AWS::DMS::Endpoint.DynamoDbSettings.

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

Return type

Union[IResolvable, Forwardref, None]

elasticsearch_settings

AWS::DMS::Endpoint.ElasticsearchSettings.

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

Return type

Union[IResolvable, Forwardref, None]

endpoint_identifier

AWS::DMS::Endpoint.EndpointIdentifier.

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

Return type

Optional[str]

endpoint_type

AWS::DMS::Endpoint.EndpointType.

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

Return type

str

engine_name

AWS::DMS::Endpoint.EngineName.

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

Return type

str

extra_connection_attributes

AWS::DMS::Endpoint.ExtraConnectionAttributes.

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

Return type

Optional[str]

kafka_settings

AWS::DMS::Endpoint.KafkaSettings.

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

Return type

Union[IResolvable, Forwardref, None]

kinesis_settings

AWS::DMS::Endpoint.KinesisSettings.

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

Return type

Union[IResolvable, Forwardref, None]

kms_key_id

AWS::DMS::Endpoint.KmsKeyId.

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

Return type

Optional[str]

logical_id

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).

return :rtype: str :return:

the logical ID as a stringified token. This value will only get resolved during synthesis.

mongo_db_settings

AWS::DMS::Endpoint.MongoDbSettings.

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

Return type

Union[IResolvable, Forwardref, None]

neptune_settings

AWS::DMS::Endpoint.NeptuneSettings.

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

Return type

Union[IResolvable, Forwardref, None]

node

The construct tree node associated with this construct.

Return type

ConstructNode

password

AWS::DMS::Endpoint.Password.

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

Return type

Optional[str]

port

AWS::DMS::Endpoint.Port.

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

Return type

Union[int, float, None]

ref

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 }).

Return type

str

s3_settings

AWS::DMS::Endpoint.S3Settings.

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

Return type

Union[IResolvable, Forwardref, None]

server_name

AWS::DMS::Endpoint.ServerName.

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

Return type

Optional[str]

ssl_mode

AWS::DMS::Endpoint.SslMode.

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

Return type

Optional[str]

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

tags

AWS::DMS::Endpoint.Tags.

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

Return type

TagManager

username

AWS::DMS::Endpoint.Username.

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

Return type

Optional[str]

Static Methods

classmethod from_cloud_formation(scope, id, resource_attributes, *, finder)

A factory method that creates a new instance of this class from an object containing the CloudFormation properties of this resource.

Used in the @aws-cdk/cloudformation-include module.

Parameters
  • scope (Construct) –

  • id (str) –

  • resource_attributes (Any) –

  • finder (ICfnFinder) – The finder interface used to resolve references across the template.

stability :stability: experimental

Return type

CfnEndpoint

classmethod is_cfn_element(x)

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.

Parameters

x (Any) –

return :rtype: bool :return: The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool