Interface CfnClusterProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnClusterProps.Jsii$Proxy
CfnCluster.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.redshift.*;
Object namespaceResourcePolicy;
CfnClusterProps cfnClusterProps = CfnClusterProps.builder()
.clusterType("clusterType")
.dbName("dbName")
.masterUsername("masterUsername")
.nodeType("nodeType")
// the properties below are optional
.allowVersionUpgrade(false)
.aquaConfigurationStatus("aquaConfigurationStatus")
.automatedSnapshotRetentionPeriod(123)
.availabilityZone("availabilityZone")
.availabilityZoneRelocation(false)
.availabilityZoneRelocationStatus("availabilityZoneRelocationStatus")
.classic(false)
.clusterIdentifier("clusterIdentifier")
.clusterParameterGroupName("clusterParameterGroupName")
.clusterSecurityGroups(List.of("clusterSecurityGroups"))
.clusterSubnetGroupName("clusterSubnetGroupName")
.clusterVersion("clusterVersion")
.deferMaintenance(false)
.deferMaintenanceDuration(123)
.deferMaintenanceEndTime("deferMaintenanceEndTime")
.deferMaintenanceStartTime("deferMaintenanceStartTime")
.destinationRegion("destinationRegion")
.elasticIp("elasticIp")
.encrypted(false)
.endpoint(EndpointProperty.builder()
.address("address")
.port("port")
.build())
.enhancedVpcRouting(false)
.hsmClientCertificateIdentifier("hsmClientCertificateIdentifier")
.hsmConfigurationIdentifier("hsmConfigurationIdentifier")
.iamRoles(List.of("iamRoles"))
.kmsKeyId("kmsKeyId")
.loggingProperties(LoggingPropertiesProperty.builder()
.bucketName("bucketName")
.s3KeyPrefix("s3KeyPrefix")
.build())
.maintenanceTrackName("maintenanceTrackName")
.manageMasterPassword(false)
.manualSnapshotRetentionPeriod(123)
.masterPasswordSecretKmsKeyId("masterPasswordSecretKmsKeyId")
.masterUserPassword("masterUserPassword")
.multiAz(false)
.namespaceResourcePolicy(namespaceResourcePolicy)
.numberOfNodes(123)
.ownerAccount("ownerAccount")
.port(123)
.preferredMaintenanceWindow("preferredMaintenanceWindow")
.publiclyAccessible(false)
.resourceAction("resourceAction")
.revisionTarget("revisionTarget")
.rotateEncryptionKey(false)
.snapshotClusterIdentifier("snapshotClusterIdentifier")
.snapshotCopyGrantName("snapshotCopyGrantName")
.snapshotCopyManual(false)
.snapshotCopyRetentionPeriod(123)
.snapshotIdentifier("snapshotIdentifier")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.vpcSecurityGroupIds(List.of("vpcSecurityGroupIds"))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnClusterPropsstatic final classAn implementation forCfnClusterProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnClusterProps.Builderbuilder()default ObjectIftrue, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.default StringThis parameter is retired.default NumberThe number of days that automated snapshots are retained.default StringThe EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster.default ObjectThe option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.default StringDescribes the status of the Availability Zone relocation operation.default ObjectA boolean value indicating whether the resize operation is using the classic resize process.default StringA unique identifier for the cluster.default StringThe name of the parameter group to be associated with this cluster.A list of security groups to be associated with this cluster.default StringThe name of a cluster subnet group to be associated with this cluster.The type of the cluster.default StringThe version of the Amazon Redshift engine software that you want to deploy on the cluster.The name of the first database to be created when the cluster is created.default ObjectA Boolean indicating whether to enable the deferred maintenance window.default NumberAn integer indicating the duration of the maintenance window in days.default StringA timestamp for the end of the time period when we defer maintenance.default StringA timestamp indicating the start time for the deferred maintenance window.default StringThe destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.default StringThe Elastic IP (EIP) address for the cluster.default ObjectIftrue, the data in the cluster is encrypted at rest.default ObjectThe connection endpoint.default ObjectAn option that specifies whether to create the cluster with enhanced VPC routing enabled.default StringSpecifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.default StringSpecifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.default StringThe AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.default ObjectSpecifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.default StringAn optional parameter for the name of the maintenance track for the cluster.default ObjectIftrue, Amazon Redshift uses AWS Secrets Manager to manage this cluster's admin credentials.default NumberThe default number of days to retain a manual snapshot.default StringThe ID of the AWS Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.The user name associated with the admin user account for the cluster that is being created.default StringThe password associated with the admin user account for the cluster that is being created.default ObjectA boolean indicating whether Amazon Redshift should deploy the cluster in two Availability Zones.default ObjectThe policy that is attached to a resource.The node type to be provisioned for the cluster.default NumberThe number of compute nodes in the cluster.default StringThe AWS account used to create or copy the snapshot.default NumbergetPort()The port number on which the cluster accepts incoming connections.default StringThe weekly time range (in UTC) during which automated cluster maintenance can occur.default ObjectIftrue, the cluster can be accessed from a public network.default StringThe Amazon Redshift operation to be performed.default StringDescribes aRevisionTargetobject.default ObjectRotates the encryption keys for a cluster.default StringThe name of the cluster the source snapshot was created from.default StringThe name of the snapshot copy grant.default ObjectIndicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.default NumberThe number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region .default StringThe name of the snapshot from which to create the new cluster.getTags()A list of tag instances.A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getClusterType
The type of the cluster. When cluster type is specified as.single-node, the NumberOfNodes parameter is not required.multi-node, the NumberOfNodes parameter is required.
Valid Values:
multi-node|single-nodeDefault:
multi-node- See Also:
-
getDbName
The name of the first database to be created when the cluster is created.To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.
Default:
devConstraints:
- Must contain 1 to 64 alphanumeric characters.
- Must contain only lowercase letters.
- Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
- See Also:
-
getMasterUsername
The user name associated with the admin user account for the cluster that is being created.Constraints:
- Must be 1 - 128 alphanumeric characters or hyphens. The user name can't be
PUBLIC. - Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
- The first character must be a letter.
- Must not contain a colon (:) or a slash (/).
- Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
- See Also:
- Must be 1 - 128 alphanumeric characters or hyphens. The user name can't be
-
getNodeType
The node type to be provisioned for the cluster.For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide .
Valid Values:
ds2.xlarge|ds2.8xlarge|dc1.large|dc1.8xlarge|dc2.large|dc2.8xlarge|ra3.xlplus|ra3.4xlarge|ra3.16xlarge- See Also:
-
getAllowVersionUpgrade
Iftrue, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.
Default:
true- See Also:
-
getAquaConfigurationStatus
This parameter is retired.It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
- See Also:
-
getAutomatedSnapshotRetentionPeriod
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 CreateClusterSnapshot in the Amazon Redshift API Reference .
Default:
1Constraints: Must be a value from 0 to 35.
- See Also:
-
getAvailabilityZone
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.
Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.
Example:
us-east-2dConstraint: The specified Availability Zone must be in the same region as the current endpoint.
- See Also:
-
getAvailabilityZoneRelocation
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.- See Also:
-
getAvailabilityZoneRelocationStatus
Describes the status of the Availability Zone relocation operation.- See Also:
-
getClassic
A boolean value indicating whether the resize operation is using the classic resize process.If you don't provide this parameter or set the value to
false, the resize type is elastic.- See Also:
-
getClusterIdentifier
A unique identifier for the cluster.You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.
Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens.
- Alphabetic characters must be lowercase.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
- Must be unique for all clusters within an AWS account .
Example:
myexamplecluster- See Also:
-
getClusterParameterGroupName
The name of the parameter group to be associated with this cluster.Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups
Constraints:
- Must be 1 to 255 alphanumeric characters or hyphens.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
- See Also:
-
getClusterSecurityGroups
A list of security groups to be associated with this cluster.Default: The default cluster security group for Amazon Redshift.
- See Also:
-
getClusterSubnetGroupName
The 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 virtual private cloud (VPC).
- See Also:
-
getClusterVersion
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.
Constraints: Only version 1.0 is currently available.
Example:
1.0- See Also:
-
getDeferMaintenance
A Boolean indicating whether to enable the deferred maintenance window.- See Also:
-
getDeferMaintenanceDuration
An integer indicating the duration of the maintenance window in days.If you specify a duration, you can't specify an end time. The duration must be 45 days or less.
- See Also:
-
getDeferMaintenanceEndTime
A timestamp for the end of the time period when we defer maintenance.- See Also:
-
getDeferMaintenanceStartTime
A timestamp indicating the start time for the deferred maintenance window.- See Also:
-
getDestinationRegion
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.- See Also:
-
getElasticIp
The Elastic IP (EIP) address for the cluster.Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
- See Also:
-
getEncrypted
Iftrue, the data in the cluster is encrypted at rest.Default: false
- See Also:
-
getEndpoint
The connection endpoint.- See Also:
-
getEnhancedVpcRouting
An option that specifies whether to create the cluster with enhanced VPC routing enabled.To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is
true, enhanced VPC routing is enabled.Default: false
- See Also:
-
getHsmClientCertificateIdentifier
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.- See Also:
-
getHsmConfigurationIdentifier
Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.- See Also:
-
getIamRoles
A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.You must supply the IAM roles in their Amazon Resource Name (ARN) format.
The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide .
- See Also:
-
getKmsKeyId
The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.- See Also:
-
getLoggingProperties
Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.- See Also:
-
getMaintenanceTrackName
An optional parameter for the name of the maintenance track for the cluster.If you don't provide a maintenance track name, the cluster is assigned to the
currenttrack.- See Also:
-
getManageMasterPassword
Iftrue, Amazon Redshift uses AWS Secrets Manager to manage this cluster's admin credentials.You can't use
MasterUserPasswordifManageMasterPasswordis true. IfManageMasterPasswordis false or not set, Amazon Redshift usesMasterUserPasswordfor the admin user account's password.- See Also:
-
getManualSnapshotRetentionPeriod
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.
The value must be either -1 or an integer between 1 and 3,653.
- See Also:
-
getMasterPasswordSecretKmsKeyId
The ID of the AWS Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.You can only use this parameter if
ManageMasterPasswordis true.- See Also:
-
getMasterUserPassword
The password associated with the admin user account for the cluster that is being created.You can't use
MasterUserPasswordifManageMasterPasswordistrue.Constraints:
- Must be between 8 and 64 characters in length.
- Must contain at least one uppercase letter.
- Must contain at least one lowercase letter.
- Must contain one number.
- Can be any printable ASCII character (ASCII code 33-126) except
'(single quote),"(double quote),\,/, or@.
- See Also:
-
getMultiAz
A boolean indicating whether Amazon Redshift should deploy the cluster in two Availability Zones.The default is false.
- See Also:
-
getNamespaceResourcePolicy
The policy that is attached to a resource.- See Also:
-
getNumberOfNodes
The number of compute nodes in the cluster.This parameter is required when the ClusterType parameter is specified as
multi-node.For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide .
If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.
Default:
1Constraints: Value must be at least 1 and no more than 100.
- See Also:
-
getOwnerAccount
The AWS 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.
- See Also:
-
getPort
The port number on which the cluster accepts incoming connections.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:
5439Valid Values:
- For clusters with ra3 nodes - Select a port within the ranges
5431-5455or8191-8215. (If you have an existing cluster with ra3 nodes, it isn't required that you change the port to these ranges.) - For clusters with ds2 or dc2 nodes - Select a port within the range
1150-65535.
- See Also:
- For clusters with ra3 nodes - Select a port within the ranges
-
getPreferredMaintenanceWindow
The weekly time range (in UTC) during which automated cluster maintenance can occur.Format:
ddd:hh24:mi-ddd:hh24:miDefault: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
- See Also:
-
getPubliclyAccessible
Iftrue, the cluster can be accessed from a public network.- See Also:
-
getResourceAction
The Amazon Redshift operation to be performed.Supported operations are
pause-cluster,resume-cluster, andfailover-primary-compute.- See Also:
-
getRevisionTarget
Describes aRevisionTargetobject.- See Also:
-
getRotateEncryptionKey
Rotates the encryption keys for a cluster.- See Also:
-
getSnapshotClusterIdentifier
The name of the cluster the source snapshot was created from.This parameter is required if your user or role has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
- See Also:
-
getSnapshotCopyGrantName
The name of the snapshot copy grant.- See Also:
-
getSnapshotCopyManual
Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.- See Also:
-
getSnapshotCopyRetentionPeriod
The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region .By default, this only changes the retention period of copied automated snapshots.
If you decrease the retention period for automated snapshots that are copied to a destination AWS Region , Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period.
Constraints: Must be at least 1 and no more than 35 for automated snapshots.
If you specify the
manualoption, only newly copied manual snapshots will have the new retention period.If you specify the value of -1 newly copied manual snapshots are retained indefinitely.
Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.
- See Also:
-
getSnapshotIdentifier
The name of the snapshot from which to create the new cluster.This parameter isn't case sensitive. You must specify this parameter or
snapshotArn, but not both.Example:
my-snapshot-id- See Also:
-
getTags
A list of tag instances.- See Also:
-
getVpcSecurityGroupIds
A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.Default: The default VPC security group is associated with the cluster.
- See Also:
-
builder
- Returns:
- a
CfnClusterProps.BuilderofCfnClusterProps
-