EndpointState class

Input properties used for looking up and filtering Endpoint resources.

Constructors

EndpointState({Input<String?>? certificateArn, Input<String?>? databaseName, Input<EndpointElasticsearchSettings?>? elasticsearchSettings, Input<String?>? endpointArn, Input<String?>? endpointId, Input<String?>? endpointType, Input<String?>? engineName, Input<String?>? extraConnectionAttributes, Input<EndpointKafkaSettings?>? kafkaSettings, Input<EndpointKinesisSettings?>? kinesisSettings, Input<String?>? kmsKeyArn, Input<EndpointMongodbSettings?>? mongodbSettings, Input<EndpointMysqlSettings?>? mysqlSettings, Input<EndpointOracleSettings?>? oracleSettings, Input<String?>? password, Input<bool?>? pauseReplicationTasks, Input<int?>? port, Input<EndpointPostgresSettings?>? postgresSettings, Input<EndpointRedisSettings?>? redisSettings, Input<EndpointRedshiftSettings?>? redshiftSettings, Input<String?>? region, Input<String?>? secretsManagerAccessRoleArn, Input<String?>? secretsManagerArn, Input<String?>? serverName, Input<String?>? serviceAccessRole, Input<String?>? sslMode, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<String?>? username})
Creates a new EndpointState. certificateArn ARN for the certificate. databaseName Name of the endpoint database. elasticsearchSettings Configuration block for OpenSearch settings. See below. endpointArn ARN for the endpoint. 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. endpointType Type of endpoint. Valid values are source, target. 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). extraConnectionAttributes Additional attributes associated with the connection. For available attributes for a source Endpoint, see Sources for data migration. For available attributes for a target Endpoint, see Targets for data migration. kafkaSettings Configuration block for Kafka settings. See below. kinesisSettings Configuration block for Kinesis settings. See below. 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. mongodbSettings Configuration block for MongoDB settings. See below. mysqlSettings Configuration block for MySQL settings. See below. oracleSettings Configuration block for Oracle settings. See below. password Password to be used to login to the endpoint database. 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. port Port used by the endpoint database. postgresSettings Configuration block for Postgres settings. See below. redisSettings Optional. redshiftSettings Configuration block for Redshift settings. See below. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. 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. 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. serverName Host name of the server. serviceAccessRole ARN used by the service access IAM role for dynamodb endpoints. sslMode SSL mode to use for the connection. Valid values are none, require, verify-ca, verify-full 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. tagsAll Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. username User name to be used to login to the endpoint database.
const
EndpointState.fromMap(Map<String, dynamic> map)
factory

Properties

certificateArn → Input<String?>?
ARN for the certificate.
final
databaseName → Input<String?>?
Name of the endpoint database.
final
elasticsearchSettings → Input<EndpointElasticsearchSettings?>?
Configuration block for OpenSearch settings. See below.
final
endpointArn → Input<String?>?
ARN for the endpoint.
final
endpointId → Input<String?>?
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.
final
endpointType → Input<String?>?
Type of endpoint. Valid values are source, target.
final
engineName → Input<String?>?
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).
final
extraConnectionAttributes → Input<String?>?
Additional attributes associated with the connection. For available attributes for a source Endpoint, see Sources for data migration. For available attributes for a target Endpoint, see Targets for data migration.
final
hashCode → int
The hash code for this object.
no setterinherited
kafkaSettings → Input<EndpointKafkaSettings?>?
Configuration block for Kafka settings. See below.
final
kinesisSettings → Input<EndpointKinesisSettings?>?
Configuration block for Kinesis settings. See below.
final
kmsKeyArn → Input<String?>?
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.
final
mongodbSettings → Input<EndpointMongodbSettings?>?
Configuration block for MongoDB settings. See below.
final
mysqlSettings → Input<EndpointMysqlSettings?>?
Configuration block for MySQL settings. See below.
final
oracleSettings → Input<EndpointOracleSettings?>?
Configuration block for Oracle settings. See below.
final
password → Input<String?>?
Password to be used to login to the endpoint database.
final
pauseReplicationTasks → Input<bool?>?
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.
final
port → Input<int?>?
Port used by the endpoint database.
final
postgresSettings → Input<EndpointPostgresSettings?>?
Configuration block for Postgres settings. See below.
final
redisSettings → Input<EndpointRedisSettings?>?
final
redshiftSettings → Input<EndpointRedshiftSettings?>?
Configuration block for Redshift settings. See below.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
secretsManagerAccessRoleArn → Input<String?>?
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.
final
secretsManagerArn → Input<String?>?
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.
final
serverName → Input<String?>?
Host name of the server.
final
serviceAccessRole → Input<String?>?
ARN used by the service access IAM role for dynamodb endpoints.
final
sslMode → Input<String?>?
SSL mode to use for the connection. Valid values are none, require, verify-ca, verify-full
final
tags → Input<Map<String, String>?>?
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.
final
tagsAll → Input<Map<String, String>?>?
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final
username → Input<String?>?
User name to be used to login to the endpoint database.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited