ClusterState class
Input properties used for looking up and filtering Cluster resources.
Constructors
-
ClusterState({Input<
bool?> ? allowVersionUpgrade, Input<bool?> ? applyImmediately, Input<String?> ? aquaConfigurationStatus, Input<String?> ? arn, Input<int?> ? automatedSnapshotRetentionPeriod, Input<String?> ? availabilityZone, Input<bool?> ? availabilityZoneRelocationEnabled, Input<String?> ? clusterIdentifier, Input<String?> ? clusterNamespaceArn, Input<List< ? clusterNodes, Input<ClusterClusterNode> ?>String?> ? clusterParameterGroupName, Input<String?> ? clusterPublicKey, Input<String?> ? clusterRevisionNumber, Input<String?> ? clusterSubnetGroupName, Input<String?> ? clusterType, Input<String?> ? clusterVersion, Input<String?> ? databaseName, Input<String?> ? defaultIamRoleArn, Input<String?> ? dnsName, Input<String?> ? elasticIp, Input<String?> ? encrypted, Input<String?> ? endpoint, Input<bool?> ? enhancedVpcRouting, Input<String?> ? finalSnapshotIdentifier, Input<List< ? iamRoles, Input<String> ?>String?> ? kmsKeyId, Input<String?> ? maintenanceTrackName, Input<bool?> ? manageMasterPassword, Input<int?> ? manualSnapshotRetentionPeriod, Input<String?> ? masterPassword, Input<String?> ? masterPasswordSecretArn, Input<String?> ? masterPasswordSecretKmsKeyId, Input<String?> ? masterPasswordWo, Input<int?> ? masterPasswordWoVersion, Input<String?> ? masterUsername, Input<bool?> ? multiAz, Input<String?> ? nodeType, Input<int?> ? numberOfNodes, Input<String?> ? ownerAccount, Input<int?> ? port, Input<String?> ? preferredMaintenanceWindow, Input<bool?> ? publiclyAccessible, Input<String?> ? region, Input<bool?> ? skipFinalSnapshot, Input<String?> ? snapshotArn, Input<String?> ? snapshotClusterIdentifier, Input<String?> ? snapshotIdentifier, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>List< ? vpcSecurityGroupIds})String> ?> -
Creates a new ClusterState.
allowVersionUpgradeIf true , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default istrue.applyImmediatelySpecifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default isfalse.aquaConfigurationStatusThe value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored.arnARN of clusterautomatedSnapshotRetentionPeriodThe number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with create-cluster-snapshot. Default is 1.availabilityZoneThe EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency. Can only be changed ifavailabilityZoneRelocationEnabledistrue.availabilityZoneRelocationEnabledIf true, the cluster can be relocated to another availabity zone, either automatically by AWS or when requested. Default isfalse. Available for use on clusters from the RA3 instance family.clusterIdentifierThe Cluster Identifier. Must be a lower case string.clusterNamespaceArnNamespace ARN of the clusterclusterNodesThe nodes in the cluster. Cluster node blocks are documented belowclusterParameterGroupNameThe name of the parameter group to be associated with this cluster.clusterPublicKeyThe public key for the clusterclusterRevisionNumberThe specific revision number of the database in the clusterclusterSubnetGroupNameName of a cluster subnet group to be associated with this cluster. If this parameter is not provided the resulting cluster will be deployed outside VPC.clusterTypeThe cluster type to use. Eithersingle-nodeormulti-node.clusterVersionThe version of the Amazon Redshift engine software that you want to deploy on the cluster.databaseNameThe name of the first database to be created when the cluster is created.defaultIamRoleArnARN for the IAM role that was set as default for the cluster when the cluster was created.dnsNameThe DNS name of the clusterelasticIpThe Elastic IP (EIP) address for the cluster.encryptedIf true , the data in the cluster is encrypted at rest.endpointThe connection endpointenhancedVpcRoutingIf true , enhanced VPC routing is enabled.finalSnapshotIdentifierThe identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided,skipFinalSnapshotmust be false.iamRolesA list of IAM Role ARNs to associate with the cluster. A Maximum of 10 can be associated to the cluster at any time.kmsKeyIdThe ARN for the KMS encryption key. When specifyingkmsKeyId,encryptedneeds to be set to true.maintenanceTrackNameThe name of the maintenance track for the restored cluster. When you take a snapshot, the snapshot inherits the MaintenanceTrack value from the cluster. The snapshot might be on a different track than the cluster that was the source for the snapshot. For example, suppose that you take a snapshot of a cluster that is on the current track and then change the cluster to be on the trailing track. In this case, the snapshot and the source cluster are on different tracks. Default value iscurrent.manageMasterPasswordWhether to use AWS SecretsManager to manage the cluster admin credentials.manualSnapshotRetentionPeriodThe default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots. Valid values are between-1and3653. Default value is-1.masterPasswordPassword for the master DB user.masterPasswordSecretArnARN of the cluster admin credentials secretmasterPasswordSecretKmsKeyIdID of the KMS key used to encrypt the cluster admin credentials secret.masterPasswordWoNOTE: This field is write-only and its value will not be updated in state as part of read operations.masterPasswordWoVersionUsed together withmasterPasswordWoto trigger an update. Increment this value when an update to themasterPasswordWois required.masterUsernameUsername for the master DB user.multiAzSpecifies if the Redshift cluster is multi-AZ.nodeTypeThe node type to be provisioned for the cluster.numberOfNodesThe number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. Default is 1.ownerAccountThe AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.portThe port number on which the cluster accepts incoming connections. Valid values are between1115and65535.preferredMaintenanceWindowThe weekly time range (in UTC) during which automated cluster maintenance can occur.publiclyAccessibleIf true, the cluster can be accessed from a public network. Default isfalse.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.skipFinalSnapshotDetermines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true , a final cluster snapshot is not created. If false , a final cluster snapshot is created before the cluster is deleted. Default is false.snapshotArnThe ARN of the snapshot from which to create the new cluster. Conflicts withsnapshotIdentifier.snapshotClusterIdentifierThe name of the cluster the source snapshot was created from.snapshotIdentifierThe name of the snapshot from which to create the new cluster. Conflicts withsnapshotArn.tagsA map 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.tagsAllA map of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.vpcSecurityGroupIdsList of VPC security groups to be associated with the cluster.const -
ClusterState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
allowVersionUpgrade
→ Input<
bool?> ? -
If true , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default is
true.final -
applyImmediately
→ Input<
bool?> ? -
Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is
false.final -
aquaConfigurationStatus
→ Input<
String?> ? -
The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored.
No longer supported by the AWS API.
Always returns
auto.final -
arn
→ Input<
String?> ? -
ARN of cluster
final
-
automatedSnapshotRetentionPeriod
→ Input<
int?> ? -
The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with create-cluster-snapshot. Default is 1.
final
-
availabilityZone
→ Input<
String?> ? -
The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency. Can only be changed if
availabilityZoneRelocationEnabledistrue.final -
availabilityZoneRelocationEnabled
→ Input<
bool?> ? -
If true, the cluster can be relocated to another availabity zone, either automatically by AWS or when requested. Default is
false. Available for use on clusters from the RA3 instance family.final -
clusterIdentifier
→ Input<
String?> ? -
The Cluster Identifier. Must be a lower case string.
final
-
clusterNamespaceArn
→ Input<
String?> ? -
Namespace ARN of the cluster
final
-
clusterNodes
→ Input<
List< ?ClusterClusterNode> ?> -
The nodes in the cluster. Cluster node blocks are documented below
final
-
clusterParameterGroupName
→ Input<
String?> ? -
The name of the parameter group to be associated with this cluster.
final
-
clusterPublicKey
→ Input<
String?> ? -
The public key for the cluster
final
-
clusterRevisionNumber
→ Input<
String?> ? -
The specific revision number of the database in the cluster
final
-
clusterSubnetGroupName
→ Input<
String?> ? -
Name of a cluster subnet group to be associated with this cluster. If this parameter is not provided the resulting cluster will be deployed outside VPC.
final
-
clusterType
→ Input<
String?> ? -
The cluster type to use. Either
single-nodeormulti-node.final -
clusterVersion
→ Input<
String?> ? -
The version of the Amazon Redshift engine software that you want to deploy on the cluster.
The version selected runs on all the nodes in the cluster.
final
-
databaseName
→ Input<
String?> ? -
The name of the first database to be created when the cluster is created.
If you do not provide a name, Amazon Redshift will create a default database called
dev.final -
defaultIamRoleArn
→ Input<
String?> ? -
ARN for the IAM role that was set as default for the cluster when the cluster was created.
final
-
dnsName
→ Input<
String?> ? -
The DNS name of the cluster
final
-
elasticIp
→ Input<
String?> ? -
The Elastic IP (EIP) address for the cluster.
final
-
encrypted
→ Input<
String?> ? -
If true , the data in the cluster is encrypted at rest.
Default is
true.final -
endpoint
→ Input<
String?> ? -
The connection endpoint
final
-
enhancedVpcRouting
→ Input<
bool?> ? -
If true , enhanced VPC routing is enabled.
final
-
finalSnapshotIdentifier
→ Input<
String?> ? -
The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided,
skipFinalSnapshotmust be false.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
iamRoles
→ Input<
List< ?String> ?> -
A list of IAM Role ARNs to associate with the cluster. A Maximum of 10 can be associated to the cluster at any time.
final
-
kmsKeyId
→ Input<
String?> ? -
The ARN for the KMS encryption key. When specifying
kmsKeyId,encryptedneeds to be set to true.final -
maintenanceTrackName
→ Input<
String?> ? -
The name of the maintenance track for the restored cluster. When you take a snapshot, the snapshot inherits the MaintenanceTrack value from the cluster. The snapshot might be on a different track than the cluster that was the source for the snapshot. For example, suppose that you take a snapshot of a cluster that is on the current track and then change the cluster to be on the trailing track. In this case, the snapshot and the source cluster are on different tracks. Default value is
current.final -
manageMasterPassword
→ Input<
bool?> ? -
Whether to use AWS SecretsManager to manage the cluster admin credentials.
Conflicts with
masterPasswordandmasterPasswordWo. One ofmasterPasswordormanageMasterPasswordis required unlesssnapshotIdentifieris provided.final -
manualSnapshotRetentionPeriod
→ Input<
int?> ? -
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots. Valid values are between
-1and3653. Default value is-1.final -
masterPassword
→ Input<
String?> ? -
Password for the master DB user.
Conflicts with
manageMasterPasswordandmasterPasswordWo. One ofmasterPassword,masterPasswordWoormanageMasterPasswordis required unlesssnapshotIdentifieris provided. Note that this may show up in logs, and it will be stored in the state file. Password must contain at least 8 characters and contain at least one uppercase letter, one lowercase letter, and one number.final -
masterPasswordSecretArn
→ Input<
String?> ? -
ARN of the cluster admin credentials secret
final
-
masterPasswordSecretKmsKeyId
→ Input<
String?> ? -
ID of the KMS key used to encrypt the cluster admin credentials secret.
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.
Conflicts with
manageMasterPasswordandmasterPassword. One ofmasterPasswordWo,masterPasswordormanageMasterPasswordis required unlesssnapshotIdentifieris provided. Note that this may show up in logs. Password must contain at least 8 characters and contain at least one uppercase letter, one lowercase letter, and one number.final -
masterPasswordWoVersion
→ Input<
int?> ? -
Used together with
masterPasswordWoto trigger an update. Increment this value when an update to themasterPasswordWois required.final -
masterUsername
→ Input<
String?> ? -
Username for the master DB user.
final
-
multiAz
→ Input<
bool?> ? -
Specifies if the Redshift cluster is multi-AZ.
final
-
nodeType
→ Input<
String?> ? -
The node type to be provisioned for the cluster.
final
-
numberOfNodes
→ Input<
int?> ? -
The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. Default is 1.
final
-
ownerAccount
→ Input<
String?> ? -
The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
final
-
port
→ Input<
int?> ? -
The port number on which the cluster accepts incoming connections. Valid values are between
1115and65535. The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. Default port is5439.final -
preferredMaintenanceWindow
→ Input<
String?> ? -
The weekly time range (in UTC) during which automated cluster maintenance can occur.
Format: ddd:hh24:mi-ddd:hh24:mi
final
-
publiclyAccessible
→ Input<
bool?> ? -
If true, the cluster can be accessed from a public network. Default is
false.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
-
skipFinalSnapshot
→ Input<
bool?> ? -
Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true , a final cluster snapshot is not created. If false , a final cluster snapshot is created before the cluster is deleted. Default is false.
final
-
snapshotArn
→ Input<
String?> ? -
The ARN of the snapshot from which to create the new cluster. Conflicts with
snapshotIdentifier.final -
snapshotClusterIdentifier
→ Input<
String?> ? -
The name of the cluster the source snapshot was created from.
final
-
snapshotIdentifier
→ Input<
String?> ? -
The name of the snapshot from which to create the new cluster. Conflicts with
snapshotArn.final -
A 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 -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
vpcSecurityGroupIds
→ Input<
List< ?String> ?> -
List of VPC security groups to be associated 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