Package com.pulumi.aws.dms

Class EndpointArgs.Builder

  • Enclosing class:
    EndpointArgs
    public static final class EndpointArgs.Builder
extends java.lang.Object

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • certificateArn

        public EndpointArgs.Builder certificateArn​(@Nullable
                                           com.pulumi.core.Output<java.lang.String> certificateArn)
        Parameters:
        certificateArn - ARN for the certificate.
        Returns:
        builder

      • certificateArn

        public EndpointArgs.Builder certificateArn​(java.lang.String certificateArn)
        Parameters:
        certificateArn - ARN for the certificate.
        Returns:
        builder

      • databaseName

        public EndpointArgs.Builder databaseName​(@Nullable
                                         com.pulumi.core.Output<java.lang.String> databaseName)
        Parameters:
        databaseName - Name of the endpoint database.
        Returns:
        builder

      • databaseName

        public EndpointArgs.Builder databaseName​(java.lang.String databaseName)
        Parameters:
        databaseName - Name of the endpoint database.
        Returns:
        builder

      • elasticsearchSettings

        public EndpointArgs.Builder elasticsearchSettings​(@Nullable
                                                  com.pulumi.core.Output<EndpointElasticsearchSettingsArgs> elasticsearchSettings)
        Parameters:
        elasticsearchSettings - Configuration block for OpenSearch settings. See below.
        Returns:
        builder

      • endpointId

        public EndpointArgs.Builder endpointId​(com.pulumi.core.Output<java.lang.String> endpointId)
        Parameters:
        endpointId - 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.
        Returns:
        builder

      • endpointId

        public EndpointArgs.Builder endpointId​(java.lang.String endpointId)
        Parameters:
        endpointId - 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.
        Returns:
        builder

      • endpointType

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

      • endpointType

        public EndpointArgs.Builder endpointType​(java.lang.String endpointType)
        Parameters:
        endpointType - Type of endpoint. Valid values are `source`, `target`.
        Returns:
        builder

      • engineName

        public EndpointArgs.Builder engineName​(com.pulumi.core.Output<java.lang.String> engineName)
        Parameters:
        engineName - 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`).
        Returns:
        builder

      • engineName

        public EndpointArgs.Builder engineName​(java.lang.String engineName)
        Parameters:
        engineName - 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`).
        Returns:
        builder

      • extraConnectionAttributes

        public EndpointArgs.Builder extraConnectionAttributes​(@Nullable
                                                      com.pulumi.core.Output<java.lang.String> extraConnectionAttributes)
        Parameters:
        extraConnectionAttributes - 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).
        Returns:
        builder

      • extraConnectionAttributes

        public EndpointArgs.Builder extraConnectionAttributes​(java.lang.String extraConnectionAttributes)
        Parameters:
        extraConnectionAttributes - 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).
        Returns:
        builder

      • kafkaSettings

        public EndpointArgs.Builder kafkaSettings​(@Nullable
                                          com.pulumi.core.Output<EndpointKafkaSettingsArgs> kafkaSettings)
        Parameters:
        kafkaSettings - Configuration block for Kafka settings. See below.
        Returns:
        builder

      • kinesisSettings

        public EndpointArgs.Builder kinesisSettings​(@Nullable
                                            com.pulumi.core.Output<EndpointKinesisSettingsArgs> kinesisSettings)
        Parameters:
        kinesisSettings - Configuration block for Kinesis settings. See below.
        Returns:
        builder

      • kmsKeyArn

        public EndpointArgs.Builder kmsKeyArn​(@Nullable
                                      com.pulumi.core.Output<java.lang.String> kmsKeyArn)
        Parameters:
        kmsKeyArn - 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:
        Returns:
        builder

      • kmsKeyArn

        public EndpointArgs.Builder kmsKeyArn​(java.lang.String kmsKeyArn)
        Parameters:
        kmsKeyArn - 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:
        Returns:
        builder

      • mongodbSettings

        public EndpointArgs.Builder mongodbSettings​(@Nullable
                                            com.pulumi.core.Output<EndpointMongodbSettingsArgs> mongodbSettings)
        Parameters:
        mongodbSettings - Configuration block for MongoDB settings. See below.
        Returns:
        builder

      • mysqlSettings

        public EndpointArgs.Builder mysqlSettings​(@Nullable
                                          com.pulumi.core.Output<EndpointMysqlSettingsArgs> mysqlSettings)
        Parameters:
        mysqlSettings - Configuration block for MySQL settings. See below.
        Returns:
        builder

      • oracleSettings

        public EndpointArgs.Builder oracleSettings​(@Nullable
                                           com.pulumi.core.Output<EndpointOracleSettingsArgs> oracleSettings)
        Parameters:
        oracleSettings - Configuration block for Oracle settings. See below.
        Returns:
        builder

      • password

        public EndpointArgs.Builder password​(@Nullable
                                     com.pulumi.core.Output<java.lang.String> password)
        Parameters:
        password - Password to be used to login to the endpoint database.
        Returns:
        builder

      • password

        public EndpointArgs.Builder password​(java.lang.String password)
        Parameters:
        password - Password to be used to login to the endpoint database.
        Returns:
        builder

      • pauseReplicationTasks

        public EndpointArgs.Builder pauseReplicationTasks​(@Nullable
                                                  com.pulumi.core.Output<java.lang.Boolean> pauseReplicationTasks)
        Parameters:
        pauseReplicationTasks - 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`.
        Returns:
        builder

      • pauseReplicationTasks

        public EndpointArgs.Builder pauseReplicationTasks​(java.lang.Boolean pauseReplicationTasks)
        Parameters:
        pauseReplicationTasks - 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`.
        Returns:
        builder

      • port

        public EndpointArgs.Builder port​(@Nullable
                                 com.pulumi.core.Output<java.lang.Integer> port)
        Parameters:
        port - Port used by the endpoint database.
        Returns:
        builder

      • port

        public EndpointArgs.Builder port​(java.lang.Integer port)
        Parameters:
        port - Port used by the endpoint database.
        Returns:
        builder

      • postgresSettings

        public EndpointArgs.Builder postgresSettings​(@Nullable
                                             com.pulumi.core.Output<EndpointPostgresSettingsArgs> postgresSettings)
        Parameters:
        postgresSettings - Configuration block for Postgres settings. See below.
        Returns:
        builder

      • redshiftSettings

        public EndpointArgs.Builder redshiftSettings​(@Nullable
                                             com.pulumi.core.Output<EndpointRedshiftSettingsArgs> redshiftSettings)
        Parameters:
        redshiftSettings - Configuration block for Redshift settings. See below.
        Returns:
        builder

      • region

        public EndpointArgs.Builder region​(@Nullable
                                   com.pulumi.core.Output<java.lang.String> region)
        Parameters:
        region - 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.
        Returns:
        builder

      • region

        public EndpointArgs.Builder region​(java.lang.String region)
        Parameters:
        region - 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.
        Returns:
        builder

      • secretsManagerAccessRoleArn

        public EndpointArgs.Builder secretsManagerAccessRoleArn​(@Nullable
                                                        com.pulumi.core.Output<java.lang.String> secretsManagerAccessRoleArn)
        Parameters:
        secretsManagerAccessRoleArn - 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.
        Returns:
        builder

      • secretsManagerAccessRoleArn

        public EndpointArgs.Builder secretsManagerAccessRoleArn​(java.lang.String secretsManagerAccessRoleArn)
        Parameters:
        secretsManagerAccessRoleArn - 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.
        Returns:
        builder

      • secretsManagerArn

        public EndpointArgs.Builder secretsManagerArn​(@Nullable
                                              com.pulumi.core.Output<java.lang.String> secretsManagerArn)
        Parameters:
        secretsManagerArn - 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`.
        Returns:
        builder

      • secretsManagerArn

        public EndpointArgs.Builder secretsManagerArn​(java.lang.String secretsManagerArn)
        Parameters:
        secretsManagerArn - 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`.
        Returns:
        builder

      • serverName

        public EndpointArgs.Builder serverName​(@Nullable
                                       com.pulumi.core.Output<java.lang.String> serverName)
        Parameters:
        serverName - Host name of the server.
        Returns:
        builder

      • serverName

        public EndpointArgs.Builder serverName​(java.lang.String serverName)
        Parameters:
        serverName - Host name of the server.
        Returns:
        builder

      • serviceAccessRole

        public EndpointArgs.Builder serviceAccessRole​(@Nullable
                                              com.pulumi.core.Output<java.lang.String> serviceAccessRole)
        Parameters:
        serviceAccessRole - ARN used by the service access IAM role for DynamoDB endpoints.
        Returns:
        builder

      • serviceAccessRole

        public EndpointArgs.Builder serviceAccessRole​(java.lang.String serviceAccessRole)
        Parameters:
        serviceAccessRole - ARN used by the service access IAM role for DynamoDB endpoints.
        Returns:
        builder

      • sslMode

        public EndpointArgs.Builder sslMode​(@Nullable
                                    com.pulumi.core.Output<java.lang.String> sslMode)
        Parameters:
        sslMode - SSL mode to use for the connection. Valid values are `none`, `require`, `verify-ca`, `verify-full`
        Returns:
        builder

      • sslMode

        public EndpointArgs.Builder sslMode​(java.lang.String sslMode)
        Parameters:
        sslMode - SSL mode to use for the connection. Valid values are `none`, `require`, `verify-ca`, `verify-full`
        Returns:
        builder

      • tags

        public EndpointArgs.Builder tags​(@Nullable
                                 com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tags)
        Parameters:
        tags - 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.
        Returns:
        builder

      • tags

        public EndpointArgs.Builder tags​(java.util.Map<java.lang.String,​java.lang.String> tags)
        Parameters:
        tags - 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.
        Returns:
        builder

      • username

        public EndpointArgs.Builder username​(@Nullable
                                     com.pulumi.core.Output<java.lang.String> username)
        Parameters:
        username - User name to be used to login to the endpoint database.
        Returns:
        builder

      • username

        public EndpointArgs.Builder username​(java.lang.String username)
        Parameters:
        username - User name to be used to login to the endpoint database.
        Returns:
        builder