MDAA TS Docs
    Preparing search index...

    Class MdaaEndpoint

    Reusable CDK construct for a compliant DMS Endpoint. Specifically, enforces KMS Encryption, and prevents use of plaintext credentials.

    Hierarchy

    • CfnEndpoint
      • MdaaEndpoint
    Index

    Constructors

    constructor

    Properties

    _cfnProperties attrExternalId attrId certificateArn? cfnOptions cfnResourceType databaseName? docDbSettings? dynamoDbSettings? elasticsearchSettings? endpointIdentifier? endpointType engineName extraConnectionAttributes? gcpMySqlSettings? ibmDb2Settings? kafkaSettings? kinesisSettings? kmsKeyId? logicalId microsoftSqlServerSettings? mongoDbSettings? mySqlSettings? neptuneSettings? node oracleSettings? password? port? postgreSqlSettings? redisSettings? redshiftSettings? resourceIdentifier? s3Settings? serverName? sslMode? stack sybaseSettings? tags tagsRaw? username? CFN_RESOURCE_TYPE_NAME

    Accessors

    cfnProperties creationStack endpointRef ref updatedProperites updatedProperties

    Methods

    _addResourceDependency _lockLogicalId _removeResourceDependency _toCloudFormation addDeletionOverride addDependency addDependsOn addMetadata addOverride addPropertyDeletionOverride addPropertyOverride applyRemovalPolicy getAtt getMetadata inspect obtainDependencies obtainResourceDependencies overrideLogicalId removeDependency renderProperties replaceDependency shouldSynthesize toString validateProperties _fromCloudFormation fromEndpointId isCfnElement isCfnResource isConstruct

    Constructors

    Properties

    Protected Readonly Internal_cfnProperties

    _cfnProperties: any

    AWS CloudFormation resource properties.

    This object is returned via cfnProperties

    attrExternalId: string

    A value that can be used for cross-account validation.

    ExternalId

    attrId: string

    Id

    certificateArn?: string

    The Amazon Resource Name (ARN) for the certificate.

    cfnOptions: ICfnResourceOptions

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

    cfnResourceType: string

    AWS resource type.

    databaseName?: string

    The name of the endpoint database.

    docDbSettings?: IResolvable | DocDbSettingsProperty

    Settings in JSON format for the source and target DocumentDB endpoint.

    dynamoDbSettings?: IResolvable | DynamoDbSettingsProperty

    Settings in JSON format for the target Amazon DynamoDB endpoint.

    elasticsearchSettings?: IResolvable | ElasticsearchSettingsProperty

    Settings in JSON format for the target OpenSearch endpoint.

    endpointIdentifier?: string

    The database endpoint identifier.

    endpointType: string

    The type of endpoint.

    engineName: string

    The type of engine for the endpoint, depending on the EndpointType value.

    extraConnectionAttributes?: string

    Additional attributes associated with the connection.

    gcpMySqlSettings?: IResolvable | GcpMySQLSettingsProperty

    Settings in JSON format for the source GCP MySQL endpoint.

    ibmDb2Settings?: IResolvable | IbmDb2SettingsProperty

    Settings in JSON format for the source IBM Db2 LUW endpoint.

    kafkaSettings?: IResolvable | KafkaSettingsProperty

    Settings in JSON format for the target Apache Kafka endpoint.

    kinesisSettings?: IResolvable | KinesisSettingsProperty

    Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.

    kmsKeyId?: string

    An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint.

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

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

    microsoftSqlServerSettings?: IResolvable | MicrosoftSqlServerSettingsProperty

    Settings in JSON format for the source and target Microsoft SQL Server endpoint.

    mongoDbSettings?: IResolvable | MongoDbSettingsProperty

    Settings in JSON format for the source MongoDB endpoint.

    mySqlSettings?: IResolvable | MySqlSettingsProperty

    Settings in JSON format for the source and target MySQL endpoint.

    neptuneSettings?: IResolvable | NeptuneSettingsProperty

    Settings in JSON format for the target Amazon Neptune endpoint.

    node: Node

    The tree node.

    oracleSettings?: IResolvable | OracleSettingsProperty

    Settings in JSON format for the source and target Oracle endpoint.

    password?: string

    The password to be used to log in to the endpoint database.

    port?: number

    The port used by the endpoint database.

    postgreSqlSettings?: IResolvable | PostgreSqlSettingsProperty

    Settings in JSON format for the source and target PostgreSQL endpoint.

    redisSettings?: IResolvable | RedisSettingsProperty

    Settings in JSON format for the target Redis endpoint.

    redshiftSettings?: IResolvable | RedshiftSettingsProperty

    Settings in JSON format for the Amazon Redshift endpoint.

    resourceIdentifier?: string

    A display name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.

    s3Settings?: S3SettingsProperty | IResolvable

    Settings in JSON format for the source and target Amazon S3 endpoint.

    serverName?: string

    The name of the server where the endpoint database resides.

    sslMode?: string

    The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none .

    stack: Stack

    The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly).

    sybaseSettings?: IResolvable | SybaseSettingsProperty

    Settings in JSON format for the source and target SAP ASE endpoint.

    tags: TagManager

    Tag Manager which manages the tags for this resource

    tagsRaw?: CfnTag[]

    One or more tags to be assigned to the endpoint.

    username?: string

    The user name to be used to log in to the endpoint database.

    CFN_RESOURCE_TYPE_NAME: string

    The CloudFormation resource type name for this resource class.

    Accessors

    • get cfnProperties(): Record<string, any>

      Returns Record<string, any>

    • get creationStack(): string[]

      Returns string[]

      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.

    • get endpointRef(): EndpointReference

      A reference to a Endpoint resource.

      Returns EndpointReference

    • get ref(): string

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

      Returns string

    • get updatedProperites(): { [key: string]: any }

      Deprecated

      Returns { [key: string]: any }

      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.

    • get updatedProperties(): { [key: string]: any }

      Return properties modified after initiation

      Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

      Returns { [key: string]: any }

    Methods

    _addResourceDependency

    • _addResourceDependency(target: CfnResource): void
      Internal

      Called by the addDependency helper function in order to realize a direct dependency between two resources that are directly defined in the same stacks.

      Use resource.addDependency to define the dependency between two resources, which also takes stack boundaries into account.

      Parameters

      • target: CfnResource

      Returns void

    _lockLogicalId

    • _lockLogicalId(): void
      Internal

      Lock the logicalId of the element and do not allow any updates (e.g. via overrideLogicalId)

      This is needed in cases where you are consuming the LogicalID of an element prior to synthesis and you need to not allow future changes to the id since doing so would cause the value you just consumed to differ from the synth time value of the logicalId.

      For example:

      const bucket = new Bucket(stack, 'Bucket'); stack.exportValue(bucket.bucketArn) <--- consuming the logicalId bucket.overrideLogicalId('NewLogicalId') <--- updating logicalId

      You should most likely never need to use this method, and if you are implementing a feature that requires this, make sure you actually require it.

      Returns void

    _removeResourceDependency

    • _removeResourceDependency(target: CfnResource): void
      Internal

      Remove a dependency between this resource and other resources in the same stack.

      Parameters

      • target: CfnResource

      Returns void

    _toCloudFormation

    • _toCloudFormation(): object
      Internal

      Emits CloudFormation for this resource.

      Returns object

    • Syntactic sugar for addOverride(path, undefined).

      Parameters

      • path: string

        The path of the value to delete

      Returns void

    • 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

      Returns void

    • Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

      Parameters

      • target: CfnResource

      Returns void

      use addDependency

    • Add a value to the CloudFormation Resource Metadata

      Parameters

      • key: string
      • value: any

      Returns void

      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.

    • 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,

      cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
      cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

      would add the overrides

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

      Parameters

      • path: string

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

      • value: any

        The value. Could be primitive or complex.

      Returns void

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

      Parameters

      • propertyPath: string

        The path to the property.

      Returns void

    • Adds an override to a resource property.

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

      Parameters

      • propertyPath: string

        The path of the property

      • value: any

        The value

      Returns void

    • 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:

      Parameters

      • policy: RemovalPolicy | undefined
      • Optionaloptions: RemovalPolicyOptions

      Returns void

      https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

    • 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

      • attributeName: string

        The name of the attribute.

      • OptionaltypeHint: ResolutionTypeHint

      Returns Reference

    • Retrieve a value value from the CloudFormation Resource Metadata

      Parameters

      • key: string

      Returns any

      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.

    • Examines the CloudFormation resource and discloses attributes

      Parameters

      • inspector: TreeInspector

        tree inspector to collect and process attributes

      Returns void

    • Retrieves an array of resources this resource depends on.

      This assembles dependencies on resources across stacks (including nested stacks) automatically.

      Returns Element[]

    • Get a shallow copy of dependencies between this resource and other resources in the same stack.

      Returns CfnResource[]

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

      Parameters

      • newLogicalId: string

        The new logical ID to use for this stack element.

      Returns void

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

      Parameters

      • target: CfnResource

      Returns void

    • Parameters

      • props: Record<string, any>

      Returns Record<string, any>

    • Replaces one dependency with another.

      Parameters

      • target: CfnResource

        The dependency to replace

      • newTarget: CfnResource

        The new dependency to add

      Returns void

    • Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

      Returns boolean

      true if the resource should be included or false is the resource should be omitted.

    • Returns string

      a string representation of this resource

    • Parameters

      • _properties: any

      Returns void

    Static_fromCloudFormation

    • _fromCloudFormation(
          scope: Construct,
          id: string,
          resourceAttributes: any,
          options: FromCloudFormationOptions,
      ): CfnEndpoint
      Internal

      Build a CfnEndpoint from CloudFormation properties

      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: string
      • resourceAttributes: any
      • options: FromCloudFormationOptions

      Returns CfnEndpoint

    • Creates a new IEndpointRef from a endpointId

      Parameters

      • scope: Construct
      • id: string
      • endpointId: string

      Returns IEndpointRef

    • 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

      Returns x is CfnElement

      The construct as a stack element or undefined if it is not a stack element.

    • Check whether the given object is a CfnResource

      Parameters

      • this: void
      • x: any

      Returns x is CfnResource

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

      Parameters

      • x: any

        Any object

      Returns x is Construct

      true if x is an object created from a class which extends Construct.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods