@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)", date="2022-01-09T19:25:26.038Z") @Stability(value=Stable) public interface CfnClusterProps extends software.amazon.jsii.JsiiSerializable
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.*;
CfnClusterProps cfnClusterProps = CfnClusterProps.builder()
.clusterType("clusterType")
.dbName("dbName")
.masterUsername("masterUsername")
.masterUserPassword("masterUserPassword")
.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)
.enhancedVpcRouting(false)
.hsmClientCertificateIdentifier("hsmClientCertificateIdentifier")
.hsmConfigurationIdentifier("hsmConfigurationIdentifier")
.iamRoles(List.of("iamRoles"))
.kmsKeyId("kmsKeyId")
.loggingProperties(LoggingPropertiesProperty.builder()
.bucketName("bucketName")
// the properties below are optional
.s3KeyPrefix("s3KeyPrefix")
.build())
.maintenanceTrackName("maintenanceTrackName")
.manualSnapshotRetentionPeriod(123)
.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();
| Modifier and Type | Interface and Description |
|---|---|
static class |
CfnClusterProps.Builder
A builder for
CfnClusterProps |
static class |
CfnClusterProps.Jsii$Proxy
An implementation for
CfnClusterProps |
| Modifier and Type | Method and Description |
|---|---|
static CfnClusterProps.Builder |
builder() |
default Object |
getAllowVersionUpgrade()
If `true` , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
|
default String |
getAquaConfigurationStatus()
The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) when it is created.
|
default Number |
getAutomatedSnapshotRetentionPeriod()
The number of days that automated snapshots are retained.
|
default String |
getAvailabilityZone()
The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster.
|
default Object |
getAvailabilityZoneRelocation()
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.
|
default String |
getAvailabilityZoneRelocationStatus()
Describes the status of the Availability Zone relocation operation.
|
default Object |
getClassic()
A boolean value indicating whether the resize operation is using the classic resize process.
|
default String |
getClusterIdentifier()
A unique identifier for the cluster.
|
default String |
getClusterParameterGroupName()
The name of the parameter group to be associated with this cluster.
|
default List<String> |
getClusterSecurityGroups()
A list of security groups to be associated with this cluster.
|
default String |
getClusterSubnetGroupName()
The name of a cluster subnet group to be associated with this cluster.
|
String |
getClusterType()
The type of the cluster.
|
default String |
getClusterVersion()
The version of the Amazon Redshift engine software that you want to deploy on the cluster.
|
String |
getDbName()
The name of the first database to be created when the cluster is created.
|
default Object |
getDeferMaintenance()
`AWS::Redshift::Cluster.DeferMaintenance`.
|
default Number |
getDeferMaintenanceDuration()
`AWS::Redshift::Cluster.DeferMaintenanceDuration`.
|
default String |
getDeferMaintenanceEndTime()
`AWS::Redshift::Cluster.DeferMaintenanceEndTime`.
|
default String |
getDeferMaintenanceStartTime()
`AWS::Redshift::Cluster.DeferMaintenanceStartTime`.
|
default String |
getDestinationRegion()
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
|
default String |
getElasticIp()
The Elastic IP (EIP) address for the cluster.
|
default Object |
getEncrypted()
If `true` , the data in the cluster is encrypted at rest.
|
default Object |
getEnhancedVpcRouting()
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
default String |
getHsmClientCertificateIdentifier()
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
|
default String |
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.
|
default List<String> |
getIamRoles()
A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
|
default String |
getKmsKeyId()
The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
|
default Object |
getLoggingProperties()
Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
|
default String |
getMaintenanceTrackName()
An optional parameter for the name of the maintenance track for the cluster.
|
default Number |
getManualSnapshotRetentionPeriod()
The default number of days to retain a manual snapshot.
|
String |
getMasterUsername()
The user name associated with the admin user account for the cluster that is being created.
|
String |
getMasterUserPassword()
The password associated with the admin user account for the cluster that is being created.
|
String |
getNodeType()
The node type to be provisioned for the cluster.
|
default Number |
getNumberOfNodes()
The number of compute nodes in the cluster.
|
default String |
getOwnerAccount()
The AWS account used to create or copy the snapshot.
|
default Number |
getPort()
The port number on which the cluster accepts incoming connections.
|
default String |
getPreferredMaintenanceWindow()
The weekly time range (in UTC) during which automated cluster maintenance can occur.
|
default Object |
getPubliclyAccessible()
If `true` , the cluster can be accessed from a public network.
|
default String |
getResourceAction()
`AWS::Redshift::Cluster.ResourceAction`.
|
default String |
getRevisionTarget()
`AWS::Redshift::Cluster.RevisionTarget`.
|
default Object |
getRotateEncryptionKey()
`AWS::Redshift::Cluster.RotateEncryptionKey`.
|
default String |
getSnapshotClusterIdentifier()
The name of the cluster the source snapshot was created from.
|
default String |
getSnapshotCopyGrantName()
The name of the snapshot copy grant.
|
default Object |
getSnapshotCopyManual()
`AWS::Redshift::Cluster.SnapshotCopyManual`.
|
default Number |
getSnapshotCopyRetentionPeriod()
`AWS::Redshift::Cluster.SnapshotCopyRetentionPeriod`.
|
default String |
getSnapshotIdentifier()
The name of the snapshot from which to create the new cluster.
|
default List<CfnTag> |
getTags()
A list of tag instances.
|
default List<String> |
getVpcSecurityGroupIds()
A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
|
@Stability(value=Stable) @NotNull String getClusterType()
single-node , the NumberOfNodes parameter is not required.multi-node , the NumberOfNodes parameter is required.
Valid Values: multi-node | single-node
Default: multi-node
@Stability(value=Stable) @NotNull String getDbName()
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: dev
Constraints:
@Stability(value=Stable) @NotNull String getMasterUsername()
Constraints:
PUBLIC .@Stability(value=Stable) @NotNull String getMasterUserPassword()
Constraints:
@Stability(value=Stable) @NotNull String getNodeType()
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
@Stability(value=Stable) @Nullable default Object getAllowVersionUpgrade()
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
@Stability(value=Stable) @Nullable default String getAquaConfigurationStatus()
Possible values include the following.
@Stability(value=Stable) @Nullable default Number getAutomatedSnapshotRetentionPeriod()
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: 1
Constraints: Must be a value from 0 to 35.
@Stability(value=Stable) @Nullable default String getAvailabilityZone()
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-2d
Constraint: The specified Availability Zone must be in the same region as the current endpoint.
@Stability(value=Stable) @Nullable default Object getAvailabilityZoneRelocation()
@Stability(value=Stable) @Nullable default String getAvailabilityZoneRelocationStatus()
@Stability(value=Stable) @Nullable default Object getClassic()
If you don't provide this parameter or set the value to false , the resize type is elastic.
@Stability(value=Stable) @Nullable default String getClusterIdentifier()
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:
Example: myexamplecluster
@Stability(value=Stable) @Nullable default String getClusterParameterGroupName()
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups
Constraints:
@Stability(value=Stable) @Nullable default List<String> getClusterSecurityGroups()
Default: The default cluster security group for Amazon Redshift.
@Stability(value=Stable) @Nullable default String getClusterSubnetGroupName()
If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
@Stability(value=Stable) @Nullable default String getClusterVersion()
The version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available.
Example: 1.0
@Stability(value=Stable) @Nullable default Object getDeferMaintenance()
@Stability(value=Stable) @Nullable default Number getDeferMaintenanceDuration()
@Stability(value=Stable) @Nullable default String getDeferMaintenanceEndTime()
@Stability(value=Stable) @Nullable default String getDeferMaintenanceStartTime()
@Stability(value=Stable) @Nullable default String getDestinationRegion()
@Stability(value=Stable) @Nullable default String getElasticIp()
Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
@Stability(value=Stable) @Nullable default Object getEncrypted()
Default: false
@Stability(value=Stable) @Nullable default Object getEnhancedVpcRouting()
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
@Stability(value=Stable) @Nullable default String getHsmClientCertificateIdentifier()
@Stability(value=Stable) @Nullable default String getHsmConfigurationIdentifier()
@Stability(value=Stable) @Nullable default List<String> getIamRoles()
You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.
A cluster can have up to 10 IAM roles associated with it at any time.
@Stability(value=Stable) @Nullable default String getKmsKeyId()
@Stability(value=Stable) @Nullable default Object getLoggingProperties()
@Stability(value=Stable) @Nullable default String getMaintenanceTrackName()
If you don't provide a maintenance track name, the cluster is assigned to the current track.
@Stability(value=Stable) @Nullable default Number getManualSnapshotRetentionPeriod()
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.
@Stability(value=Stable) @Nullable default Number getNumberOfNodes()
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: 1
Constraints: Value must be at least 1 and no more than 100.
@Stability(value=Stable) @Nullable default String getOwnerAccount()
Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
@Stability(value=Stable) @Nullable default Number getPort()
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: 5439
Valid Values: 1150-65535
@Stability(value=Stable) @Nullable default String getPreferredMaintenanceWindow()
Format: ddd:hh24:mi-ddd:hh24:mi
Default: 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.
@Stability(value=Stable) @Nullable default Object getPubliclyAccessible()
@Stability(value=Stable) @Nullable default String getResourceAction()
@Stability(value=Stable) @Nullable default String getRevisionTarget()
@Stability(value=Stable) @Nullable default Object getRotateEncryptionKey()
@Stability(value=Stable) @Nullable default String getSnapshotClusterIdentifier()
This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
@Stability(value=Stable) @Nullable default String getSnapshotCopyGrantName()
@Stability(value=Stable) @Nullable default Object getSnapshotCopyManual()
@Stability(value=Stable) @Nullable default Number getSnapshotCopyRetentionPeriod()
@Stability(value=Stable) @Nullable default String getSnapshotIdentifier()
Example: my-snapshot-id
@Stability(value=Stable) @Nullable default List<String> getVpcSecurityGroupIds()
Default: The default VPC security group is associated with the cluster.
@Stability(value=Stable) static CfnClusterProps.Builder builder()
CfnClusterProps.Builder of CfnClusterPropsCopyright © 2022. All rights reserved.