Package software.amazon.awssdk.services.databasemigration.model

Class CreateEndpointRequest

    • Method Detail

      • endpointIdentifier

        public final String endpointIdentifier()

        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.

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

      • engineName

        public final String engineName()

        The type of engine for the endpoint. Valid values, depending on the EndpointType value, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "opensearch", "redshift", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "docdb", "sqlserver", "neptune", and "babelfish".

        Returns:
        The type of engine for the endpoint. Valid values, depending on the EndpointType value, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "opensearch", "redshift", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "docdb", "sqlserver", "neptune", and "babelfish".

      • username

        public final String username()

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

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

      • password

        public final String password()

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

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

      • serverName

        public final String serverName()

        The name of the server where the endpoint database resides.

        Returns:
        The name of the server where the endpoint database resides.

      • port

        public final Integer port()

        The port used by the endpoint database.

        Returns:
        The port used by the endpoint database.

      • databaseName

        public final String databaseName()

        The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName. To migrate to a specific database, use this setting and targetDbType.

        Returns:
        The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName. To migrate to a specific database, use this setting and targetDbType.

      • extraConnectionAttributes

        public final String extraConnectionAttributes()

        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 DMS Endpoints in the Database Migration Service User Guide.

        Returns:
        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 DMS Endpoints in the Database Migration Service User Guide.

      • kmsKeyId

        public final String kmsKeyId()

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

        If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.

        KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

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

        If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.

        KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

        public final List<Tag> tags()

        One or more tags to be assigned to the endpoint.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        One or more tags to be assigned to the endpoint.

      • certificateArn

        public final String certificateArn()

        The Amazon Resource Name (ARN) for the certificate.

        Returns:
        The Amazon Resource Name (ARN) for the certificate.

      • sslMode

        public final DmsSslModeValue sslMode()

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

        If the service returns an enum value that is not available in the current SDK version, sslMode will return DmsSslModeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sslModeAsString().

        Returns:
        The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none
        See Also:
        DmsSslModeValue

      • sslModeAsString

        public final String sslModeAsString()

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

        If the service returns an enum value that is not available in the current SDK version, sslMode will return DmsSslModeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sslModeAsString().

        Returns:
        The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none
        See Also:
        DmsSslModeValue

      • serviceAccessRoleArn

        public final String serviceAccessRoleArn()

        The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint. The role must allow the iam:PassRole action.

        Returns:
        The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint. The role must allow the iam:PassRole action.

      • externalTableDefinition

        public final String externalTableDefinition()

        The external table definition.

        Returns:
        The external table definition.

      • dmsTransferSettings

        public final DmsTransferSettings dmsTransferSettings()

        The settings in JSON format for the DMS transfer type of source endpoint.

        Possible settings include the following:

        • ServiceAccessRoleArn - The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow the iam:PassRole action.

        • BucketName - The name of the S3 bucket to use.

        Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string,BucketName=string

        JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", }

        Returns:
        The settings in JSON format for the DMS transfer type of source endpoint.

        Possible settings include the following:

        • ServiceAccessRoleArn - The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow the iam:PassRole action.

        • BucketName - The name of the S3 bucket to use.

        Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string,BucketName=string

        JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", }

      • redshiftSettings

        public final RedshiftSettings redshiftSettings()
        Returns the value of the RedshiftSettings property for this object.
        Returns:
        The value of the RedshiftSettings property for this object.

      • resourceIdentifier

        public final String resourceIdentifier()

        A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1. For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a ResourceIdentifier value, DMS generates a default identifier value for the end of EndpointArn.

        Returns:
        A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1. For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a ResourceIdentifier value, DMS generates a default identifier value for the end of EndpointArn.

      • docDbSettings

        public final DocDbSettings docDbSettings()
        Returns the value of the DocDbSettings property for this object.
        Returns:
        The value of the DocDbSettings property for this object.

      • redisSettings

        public final RedisSettings redisSettings()

        Settings in JSON format for the target Redis endpoint.

        Returns:
        Settings in JSON format for the target Redis endpoint.

      • gcpMySQLSettings

        public final GcpMySQLSettings gcpMySQLSettings()

        Settings in JSON format for the source GCP MySQL endpoint.

        Returns:
        Settings in JSON format for the source GCP MySQL endpoint.

      • timestreamSettings

        public final TimestreamSettings timestreamSettings()

        Settings in JSON format for the target Amazon Timestream endpoint.

        Returns:
        Settings in JSON format for the target Amazon Timestream endpoint.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object