ClusterState class

Input properties used for looking up and filtering Cluster resources.

Constructors

ClusterState({Input<bool?>? allowMajorVersionUpgrade, Input<bool?>? applyImmediately, Input<String?>? arn, Input<List<String>?>? availabilityZones, Input<int?>? backupRetentionPeriod, Input<String?>? clusterIdentifier, Input<String?>? clusterIdentifierPrefix, Input<List<String>?>? clusterMembers, Input<String?>? clusterResourceId, Input<String?>? dbClusterParameterGroupName, Input<String?>? dbSubnetGroupName, Input<bool?>? deletionProtection, Input<List<String>?>? enabledCloudwatchLogsExports, Input<String?>? endpoint, Input<String?>? engine, Input<String?>? engineVersion, Input<String?>? finalSnapshotIdentifier, Input<String?>? globalClusterIdentifier, Input<String?>? hostedZoneId, Input<String?>? kmsKeyId, Input<bool?>? manageMasterUserPassword, Input<String?>? masterPassword, Input<String?>? masterPasswordWo, Input<int?>? masterPasswordWoVersion, Input<List<ClusterMasterUserSecret>?>? masterUserSecrets, Input<String?>? masterUsername, Input<String?>? networkType, Input<int?>? port, Input<String?>? preferredBackupWindow, Input<String?>? preferredMaintenanceWindow, Input<String?>? readerEndpoint, Input<String?>? region, Input<ClusterRestoreToPointInTime?>? restoreToPointInTime, Input<ClusterServerlessV2ScalingConfiguration?>? serverlessV2ScalingConfiguration, Input<bool?>? skipFinalSnapshot, Input<String?>? snapshotIdentifier, Input<bool?>? storageEncrypted, Input<String?>? storageType, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<List<String>?>? vpcSecurityGroupIds})
Creates a new ClusterState. allowMajorVersionUpgrade A value that indicates whether major version upgrades are allowed. Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version. applyImmediately Specifies whether any cluster modifications arn ARN of cluster availabilityZones A list of EC2 Availability Zones that instances in the DB cluster can be created in. backupRetentionPeriod The days to retain backups for. Default 1 clusterIdentifier The cluster identifier. If omitted, the provider will assign a random, unique identifier. clusterIdentifierPrefix Creates a unique cluster identifier beginning with the specified prefix. Conflicts with clusterIdentifier. clusterMembers List of DocumentDB Instances that are a part of this cluster clusterResourceId The DocumentDB Cluster Resource ID dbClusterParameterGroupName A cluster parameter group to associate with the cluster. dbSubnetGroupName A DB subnet group to associate with this DB instance. deletionProtection A boolean value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. Defaults to false. enabledCloudwatchLogsExports List of log types to export to cloudwatch. If omitted, no logs will be exported. endpoint The DNS address of the DocumentDB instance engine The name of the database engine to be used for this DB cluster. Defaults to docdb. Valid values: docdb. engineVersion The database engine version. Updating this argument results in an outage. finalSnapshotIdentifier The name of your final DB snapshot globalClusterIdentifier The global cluster identifier specified on aws.docdb.GlobalCluster. hostedZoneId The Route53 Hosted Zone ID of the endpoint kmsKeyId The ARN for the KMS encryption key. When specifying kmsKeyId, storageEncrypted needs to be set to true. manageMasterUserPassword Set to true to allow Amazon DocumentDB to manage the master user password in AWS Secrets Manager. Cannot be set if masterPassword or masterPasswordWo is provided. masterPassword Password for the master DB user. Note that this may masterPasswordWo NOTE: This field is write-only and its value will not be updated in state as part of read operations. masterPasswordWoVersion Used together with masterPasswordWo to trigger an update. Increment this value when an update to the masterPasswordWo is required. masterUserSecrets Optional. masterUsername Username for the master DB user. networkType The network type of the DB cluster (IPV4 or DUAL). port The port on which the DB accepts connections preferredBackupWindow The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC preferredMaintenanceWindow The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30 readerEndpoint A read-only endpoint for the DocumentDB cluster, automatically load-balanced across replicas region Region where this resource will be managed. Defaults to the Region set in the provider configuration. restoreToPointInTime A configuration block for restoring a DB instance to an arbitrary point in time. Requires the identifier argument to be set with the name of the new DB instance to be created. See Restore To Point In Time below for details. serverlessV2ScalingConfiguration Scaling configuration of an Amazon DocumentDB Serverless cluster. See Serverless V2 Scaling Configuration below for details. skipFinalSnapshot Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from finalSnapshotIdentifier. Default is false. snapshotIdentifier Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Automated snapshots should not be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced. storageEncrypted Specifies whether the DB cluster is encrypted. The default is false. storageType The storage type to associate with the DB cluster. Valid values: standard, iopt1. tags A map of tags to assign to the DB cluster. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. vpcSecurityGroupIds List of VPC security groups to associate
const
ClusterState.fromMap(Map<String, dynamic> map)
factory

Properties

allowMajorVersionUpgrade → Input<bool?>?
A value that indicates whether major version upgrades are allowed. Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
final
applyImmediately → Input<bool?>?
Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
final
arn → Input<String?>?
ARN of cluster
final
availabilityZones → Input<List<String>?>?
A list of EC2 Availability Zones that instances in the DB cluster can be created in. DocumentDB automatically assigns 3 AZs if less than 3 AZs are configured, which will show as a difference requiring resource recreation next pulumi up. We recommend specifying 3 AZs or using the lifecycle configuration block ignoreChanges argument if necessary.
final
backupRetentionPeriod → Input<int?>?
The days to retain backups for. Default 1
final
clusterIdentifier → Input<String?>?
The cluster identifier. If omitted, the provider will assign a random, unique identifier.
final
clusterIdentifierPrefix → Input<String?>?
Creates a unique cluster identifier beginning with the specified prefix. Conflicts with clusterIdentifier.
final
clusterMembers → Input<List<String>?>?
List of DocumentDB Instances that are a part of this cluster
final
clusterResourceId → Input<String?>?
The DocumentDB Cluster Resource ID
final
dbClusterParameterGroupName → Input<String?>?
A cluster parameter group to associate with the cluster.
final
dbSubnetGroupName → Input<String?>?
A DB subnet group to associate with this DB instance.
final
deletionProtection → Input<bool?>?
A boolean value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. Defaults to false.
final
enabledCloudwatchLogsExports → Input<List<String>?>?
List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, profiler.
final
endpoint → Input<String?>?
The DNS address of the DocumentDB instance
final
engine → Input<String?>?
The name of the database engine to be used for this DB cluster. Defaults to docdb. Valid values: docdb.
final
engineVersion → Input<String?>?
The database engine version. Updating this argument results in an outage.
final
finalSnapshotIdentifier → Input<String?>?
The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
final
globalClusterIdentifier → Input<String?>?
The global cluster identifier specified on aws.docdb.GlobalCluster.
final
hashCode → int
The hash code for this object.
no setterinherited
hostedZoneId → Input<String?>?
The Route53 Hosted Zone ID of the endpoint
final
kmsKeyId → Input<String?>?
The ARN for the KMS encryption key. When specifying kmsKeyId, storageEncrypted needs to be set to true.
final
manageMasterUserPassword → Input<bool?>?
Set to true to allow Amazon DocumentDB to manage the master user password in AWS Secrets Manager. Cannot be set if masterPassword or masterPasswordWo is provided.
final
masterPassword → Input<String?>?
Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the DocumentDB Naming Constraints. Conflicts with masterPasswordWo and manageMasterUserPassword.
final
masterPasswordWo → Input<String?>?
NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the master DB user. Note that this may show up in logs. Please refer to the DocumentDB Naming Constraints. Conflicts with masterPassword and manageMasterUserPassword.
final
masterPasswordWoVersion → Input<int?>?
Used together with masterPasswordWo to trigger an update. Increment this value when an update to the masterPasswordWo is required.
final
masterUsername → Input<String?>?
Username for the master DB user.
final
masterUserSecrets → Input<List<ClusterMasterUserSecret>?>?
final
networkType → Input<String?>?
The network type of the DB cluster (IPV4 or DUAL).
final
port → Input<int?>?
The port on which the DB accepts connections
final
preferredBackupWindow → Input<String?>?
The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC Default: A 30-minute window selected at random from an 8-hour block of time per regionE.g., 04:00-09:00
final
preferredMaintenanceWindow → Input<String?>?
The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
final
readerEndpoint → Input<String?>?
A read-only endpoint for the DocumentDB cluster, automatically load-balanced across replicas
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
restoreToPointInTime → Input<ClusterRestoreToPointInTime?>?
A configuration block for restoring a DB instance to an arbitrary point in time. Requires the identifier argument to be set with the name of the new DB instance to be created. See Restore To Point In Time below for details.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serverlessV2ScalingConfiguration → Input<ClusterServerlessV2ScalingConfiguration?>?
Scaling configuration of an Amazon DocumentDB Serverless cluster. See Serverless V2 Scaling Configuration below for details.
final
skipFinalSnapshot → Input<bool?>?
Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from finalSnapshotIdentifier. Default is false.
final
snapshotIdentifier → Input<String?>?
Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Automated snapshots should not be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.
final
storageEncrypted → Input<bool?>?
Specifies whether the DB cluster is encrypted. The default is false.
final
storageType → Input<String?>?
The storage type to associate with the DB cluster. Valid values: standard, iopt1.
final
tags → Input<Map<String, String>?>?
A map of tags to assign to the DB cluster. 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>?>?
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final
vpcSecurityGroupIds → Input<List<String>?>?
List of VPC security groups to associate with the Cluster
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