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< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>String?> ? username}) -
Creates a new EndpointState.
certificateArnARN for the certificate.databaseNameName of the endpoint database.elasticsearchSettingsConfiguration block for OpenSearch settings. See below.endpointArnARN for the endpoint.endpointIdDatabase 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.endpointTypeType of endpoint. Valid values aresource,target.engineNameType of engine for the endpoint. Valid values areaurora,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 fortargetendpoint type (e.g.redshift).extraConnectionAttributesAdditional attributes associated with the connection. For available attributes for asourceEndpoint, see Sources for data migration. For available attributes for atargetEndpoint, see Targets for data migration.kafkaSettingsConfiguration block for Kafka settings. See below.kinesisSettingsConfiguration block for Kinesis settings. See below.kmsKeyArnARN for the KMS key that will be used to encrypt the connection parameters. If you do not specify a value forkmsKeyArn, 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. WhenengineNameisredshift,kmsKeyArnis the KMS Key for the Redshift target and the parameterredshift_settings.server_side_encryption_kms_key_idencrypts the S3 intermediate storage.mongodbSettingsConfiguration block for MongoDB settings. See below.mysqlSettingsConfiguration block for MySQL settings. See below.oracleSettingsConfiguration block for Oracle settings. See below.passwordPassword to be used to login to the endpoint database.pauseReplicationTasksWhether 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 isfalse.portPort used by the endpoint database.postgresSettingsConfiguration block for Postgres settings. See below.redisSettingsOptional.redshiftSettingsConfiguration block for Redshift settings. See below.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.secretsManagerAccessRoleArnARN 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 bysecretsManagerArn. The role must allow theiam:PassRoleaction.secretsManagerArnFull ARN, partial ARN, or friendly name of the Secrets Manager secret that contains the endpoint connection details. Supported only whenengineNameisaurora,aurora-postgresql,mariadb,mongodb,mysql,oracle,postgres,redshift, orsqlserver.serverNameHost name of the server.serviceAccessRoleARN used by the service access IAM role for dynamodb endpoints.sslModeSSL mode to use for the connection. Valid values arenone,require,verify-ca,verify-fulltagsMap of tags to assign to the resource. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllMap of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.usernameUser 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 fortargetendpoint type (e.g.redshift).final -
extraConnectionAttributes
→ Input<
String?> ? -
Additional attributes associated with the connection. For available attributes for a
sourceEndpoint, see Sources for data migration. For available attributes for atargetEndpoint, 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. WhenengineNameisredshift,kmsKeyArnis the KMS Key for the Redshift target and the parameterredshift_settings.server_side_encryption_kms_key_idencrypts 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 theiam:PassRoleaction.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
engineNameisaurora,aurora-postgresql,mariadb,mongodb,mysql,oracle,postgres,redshift, orsqlserver.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-fullfinal -
Map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration 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