Package com.pulumi.aws.dms

Class EndpointArgs

  • public final class EndpointArgs
extends com.pulumi.resources.ResourceArgs

    • Method Detail

      • certificateArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> certificateArn()
        Returns:
        ARN for the certificate.

      • databaseName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> databaseName()
        Returns:
        Name of the endpoint database.

      • elasticsearchSettings

        public java.util.Optional<com.pulumi.core.Output<EndpointElasticsearchSettingsArgs>> elasticsearchSettings()
        Returns:
        Configuration block for OpenSearch settings. See below.

      • endpointId

        public com.pulumi.core.Output<java.lang.String> endpointId()
        Returns:
        Database endpoint identifier. Identifiers must contain from 1 to 255 alphanumeric characters or hyphens, begin with a letter, contain only ASCII letters, digits, and hyphens, not end with a hyphen, and not contain two consecutive hyphens.

      • endpointType

        public com.pulumi.core.Output<java.lang.String> endpointType()
        Returns:
        Type of endpoint. Valid values are `source`, `target`.

      • engineName

        public com.pulumi.core.Output<java.lang.String> engineName()
        Returns:
        Type of engine for the endpoint. Valid values are `aurora`, `aurora-postgresql`, `aurora-serverless`, `aurora-postgresql-serverless`,`azuredb`, `azure-sql-managed-instance`, `babelfish`, `db2`, `db2-zos`, `docdb`, `dynamodb`, `elasticsearch`, `kafka`, `kinesis`, `mariadb`, `mongodb`, `mysql`, `opensearch`, `oracle`, `postgres`, `redshift`,`redshift-serverless`, `sqlserver`, `neptune` ,`sybase`. Please note that some of engine names are available only for `target` endpoint type (e.g. `redshift`).

      • extraConnectionAttributes

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> extraConnectionAttributes()
        Returns:
        Additional attributes associated with the connection. For available attributes for a `source` Endpoint, see [Sources for data migration](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.html). For available attributes for a `target` Endpoint, see [Targets for data migration](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.html).

      • kafkaSettings

        public java.util.Optional<com.pulumi.core.Output<EndpointKafkaSettingsArgs>> kafkaSettings()
        Returns:
        Configuration block for Kafka settings. See below.

      • kinesisSettings

        public java.util.Optional<com.pulumi.core.Output<EndpointKinesisSettingsArgs>> kinesisSettings()
        Returns:
        Configuration block for Kinesis settings. See below.

      • kmsKeyArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyArn()
        Returns:
        ARN for the KMS key that will be used to encrypt the connection parameters. If you do not specify a value for `kmsKeyArn`, then AWS DMS will use 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. When `engineName` is `redshift`, `kmsKeyArn` is the KMS Key for the Redshift target and the parameter `redshift_settings.server_side_encryption_kms_key_id` encrypts the S3 intermediate storage. The following arguments are optional:

      • mongodbSettings

        public java.util.Optional<com.pulumi.core.Output<EndpointMongodbSettingsArgs>> mongodbSettings()
        Returns:
        Configuration block for MongoDB settings. See below.

      • mysqlSettings

        public java.util.Optional<com.pulumi.core.Output<EndpointMysqlSettingsArgs>> mysqlSettings()
        Returns:
        Configuration block for MySQL settings. See below.

      • oracleSettings

        public java.util.Optional<com.pulumi.core.Output<EndpointOracleSettingsArgs>> oracleSettings()
        Returns:
        Configuration block for Oracle settings. See below.

      • password

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> password()
        Returns:
        Password to be used to login to the endpoint database.

      • pauseReplicationTasks

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> pauseReplicationTasks()
        Returns:
        Whether to pause associated running replication tasks, regardless if they are managed by Terraform, prior to modifying the endpoint. Only tasks paused by the resource will be restarted after the modification completes. Default is `false`.

      • port

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> port()
        Returns:
        Port used by the endpoint database.

      • postgresSettings

        public java.util.Optional<com.pulumi.core.Output<EndpointPostgresSettingsArgs>> postgresSettings()
        Returns:
        Configuration block for Postgres settings. See below.

      • redshiftSettings

        public java.util.Optional<com.pulumi.core.Output<EndpointRedshiftSettingsArgs>> redshiftSettings()
        Returns:
        Configuration block for Redshift settings. See below.

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • secretsManagerAccessRoleArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> secretsManagerAccessRoleArn()
        Returns:
        ARN of the IAM role that specifies AWS DMS as the trusted entity and has the required permissions to access the value in the Secrets Manager secret referred to by `secretsManagerArn`. The role must allow the `iam:PassRole` action. > **Note:** You can specify one of two sets of values for these permissions. You can specify the values for this setting and `secretsManagerArn`. Or you can specify clear-text values for `username`, `password` , `serverName`, and `port`. You can't specify both.

      • secretsManagerArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> secretsManagerArn()
        Returns:
        Full ARN, partial ARN, or friendly name of the Secrets Manager secret that contains the endpoint connection details. Supported only when `engineName` is `aurora`, `aurora-postgresql`, `mariadb`, `mongodb`, `mysql`, `oracle`, `postgres`, `redshift`, or `sqlserver`.

      • serverName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> serverName()
        Returns:
        Host name of the server.

      • serviceAccessRole

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> serviceAccessRole()
        Returns:
        ARN used by the service access IAM role for DynamoDB endpoints.

      • sslMode

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> sslMode()
        Returns:
        SSL mode to use for the connection. Valid values are `none`, `require`, `verify-ca`, `verify-full`

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • username

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> username()
        Returns:
        User name to be used to login to the endpoint database.