ClusterState constructor

const ClusterState({
  1. Input<bool?>? allowMajorVersionUpgrade,
  2. Input<bool?>? applyImmediately,
  3. Input<String?>? arn,
  4. Input<List<String>?>? availabilityZones,
  5. Input<int?>? backupRetentionPeriod,
  6. Input<String?>? clusterIdentifier,
  7. Input<String?>? clusterIdentifierPrefix,
  8. Input<List<String>?>? clusterMembers,
  9. Input<String?>? clusterResourceId,
  10. Input<String?>? dbClusterParameterGroupName,
  11. Input<String?>? dbSubnetGroupName,
  12. Input<bool?>? deletionProtection,
  13. Input<List<String>?>? enabledCloudwatchLogsExports,
  14. Input<String?>? endpoint,
  15. Input<String?>? engine,
  16. Input<String?>? engineVersion,
  17. Input<String?>? finalSnapshotIdentifier,
  18. Input<String?>? globalClusterIdentifier,
  19. Input<String?>? hostedZoneId,
  20. Input<String?>? kmsKeyId,
  21. Input<bool?>? manageMasterUserPassword,
  22. Input<String?>? masterPassword,
  23. Input<String?>? masterPasswordWo,
  24. Input<int?>? masterPasswordWoVersion,
  25. Input<List<ClusterMasterUserSecret>?>? masterUserSecrets,
  26. Input<String?>? masterUsername,
  27. Input<String?>? networkType,
  28. Input<int?>? port,
  29. Input<String?>? preferredBackupWindow,
  30. Input<String?>? preferredMaintenanceWindow,
  31. Input<String?>? readerEndpoint,
  32. Input<String?>? region,
  33. Input<ClusterRestoreToPointInTime?>? restoreToPointInTime,
  34. Input<ClusterServerlessV2ScalingConfiguration?>? serverlessV2ScalingConfiguration,
  35. Input<bool?>? skipFinalSnapshot,
  36. Input<String?>? snapshotIdentifier,
  37. Input<bool?>? storageEncrypted,
  38. Input<String?>? storageType,
  39. Input<Map<String, String>?>? tags,
  40. Input<Map<String, String>?>? tagsAll,
  41. 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

Implementation

const ClusterState({
  this.allowMajorVersionUpgrade,
  this.applyImmediately,
  this.arn,
  this.availabilityZones,
  this.backupRetentionPeriod,
  this.clusterIdentifier,
  this.clusterIdentifierPrefix,
  this.clusterMembers,
  this.clusterResourceId,
  this.dbClusterParameterGroupName,
  this.dbSubnetGroupName,
  this.deletionProtection,
  this.enabledCloudwatchLogsExports,
  this.endpoint,
  this.engine,
  this.engineVersion,
  this.finalSnapshotIdentifier,
  this.globalClusterIdentifier,
  this.hostedZoneId,
  this.kmsKeyId,
  this.manageMasterUserPassword,
  this.masterPassword,
  this.masterPasswordWo,
  this.masterPasswordWoVersion,
  this.masterUserSecrets,
  this.masterUsername,
  this.networkType,
  this.port,
  this.preferredBackupWindow,
  this.preferredMaintenanceWindow,
  this.readerEndpoint,
  this.region,
  this.restoreToPointInTime,
  this.serverlessV2ScalingConfiguration,
  this.skipFinalSnapshot,
  this.snapshotIdentifier,
  this.storageEncrypted,
  this.storageType,
  this.tags,
  this.tagsAll,
  this.vpcSecurityGroupIds,
});