ClusterState constructor
- 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,ClusterClusterNode> ?> - Input<
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,String> ?> - Input<
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,String, String> ?> - Input<
Map< ? tagsAll,String, String> ?> - Input<
List< ? vpcSecurityGroupIds,String> ?>
Creates a new ClusterState.
allowVersionUpgrade 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.
applyImmediately Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
aquaConfigurationStatus The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored.
arn ARN of cluster
automatedSnapshotRetentionPeriod 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.
availabilityZone 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 availabilityZoneRelocationEnabled is true.
availabilityZoneRelocationEnabled 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.
clusterIdentifier The Cluster Identifier. Must be a lower case string.
clusterNamespaceArn Namespace ARN of the cluster
clusterNodes The nodes in the cluster. Cluster node blocks are documented below
clusterParameterGroupName The name of the parameter group to be associated with this cluster.
clusterPublicKey The public key for the cluster
clusterRevisionNumber The specific revision number of the database in the cluster
clusterSubnetGroupName 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.
clusterType The cluster type to use. Either single-node or multi-node.
clusterVersion The version of the Amazon Redshift engine software that you want to deploy on the cluster.
databaseName The name of the first database to be created when the cluster is created.
defaultIamRoleArn ARN for the IAM role that was set as default for the cluster when the cluster was created.
dnsName The DNS name of the cluster
elasticIp The Elastic IP (EIP) address for the cluster.
encrypted If true , the data in the cluster is encrypted at rest.
endpoint The connection endpoint
enhancedVpcRouting If true , enhanced VPC routing is enabled.
finalSnapshotIdentifier The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, skipFinalSnapshot must be false.
iamRoles A list of IAM Role ARNs to associate with the cluster. A Maximum of 10 can be associated to the cluster at any time.
kmsKeyId The ARN for the KMS encryption key. When specifying kmsKeyId, encrypted needs to be set to true.
maintenanceTrackName 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.
manageMasterPassword Whether to use AWS SecretsManager to manage the cluster admin credentials.
manualSnapshotRetentionPeriod 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 -1 and 3653. Default value is -1.
masterPassword Password for the master DB user.
masterPasswordSecretArn ARN of the cluster admin credentials secret
masterPasswordSecretKmsKeyId ID of the KMS key used to encrypt the cluster admin credentials secret.
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.
masterUsername Username for the master DB user.
multiAz Specifies if the Redshift cluster is multi-AZ.
nodeType The node type to be provisioned for the cluster.
numberOfNodes The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. Default is 1.
ownerAccount 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.
port The port number on which the cluster accepts incoming connections. Valid values are between 1115 and 65535.
preferredMaintenanceWindow The weekly time range (in UTC) during which automated cluster maintenance can occur.
publiclyAccessible If true, the cluster can be accessed from a public network. Default is false.
region Region where this resource will be managed. Defaults to the Region set in the provider configuration.
skipFinalSnapshot 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.
snapshotArn The ARN of the snapshot from which to create the new cluster. Conflicts with snapshotIdentifier.
snapshotClusterIdentifier The name of the cluster the source snapshot was created from.
snapshotIdentifier The name of the snapshot from which to create the new cluster. Conflicts with snapshotArn.
tags A 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 A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
vpcSecurityGroupIds List of VPC security groups to be associated with the cluster.
Implementation
const ClusterState({
this.allowVersionUpgrade,
this.applyImmediately,
this.aquaConfigurationStatus,
this.arn,
this.automatedSnapshotRetentionPeriod,
this.availabilityZone,
this.availabilityZoneRelocationEnabled,
this.clusterIdentifier,
this.clusterNamespaceArn,
this.clusterNodes,
this.clusterParameterGroupName,
this.clusterPublicKey,
this.clusterRevisionNumber,
this.clusterSubnetGroupName,
this.clusterType,
this.clusterVersion,
this.databaseName,
this.defaultIamRoleArn,
this.dnsName,
this.elasticIp,
this.encrypted,
this.endpoint,
this.enhancedVpcRouting,
this.finalSnapshotIdentifier,
this.iamRoles,
this.kmsKeyId,
this.maintenanceTrackName,
this.manageMasterPassword,
this.manualSnapshotRetentionPeriod,
this.masterPassword,
this.masterPasswordSecretArn,
this.masterPasswordSecretKmsKeyId,
this.masterPasswordWo,
this.masterPasswordWoVersion,
this.masterUsername,
this.multiAz,
this.nodeType,
this.numberOfNodes,
this.ownerAccount,
this.port,
this.preferredMaintenanceWindow,
this.publiclyAccessible,
this.region,
this.skipFinalSnapshot,
this.snapshotArn,
this.snapshotClusterIdentifier,
this.snapshotIdentifier,
this.tags,
this.tagsAll,
this.vpcSecurityGroupIds,
});