Class CfnClusterProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnClusterProps>
- Enclosing interface:
CfnClusterProps
CfnClusterProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionallowVersionUpgrade
(Boolean allowVersionUpgrade) Sets the value ofCfnClusterProps.getAllowVersionUpgrade()
allowVersionUpgrade
(IResolvable allowVersionUpgrade) Sets the value ofCfnClusterProps.getAllowVersionUpgrade()
aquaConfigurationStatus
(String aquaConfigurationStatus) Sets the value ofCfnClusterProps.getAquaConfigurationStatus()
automatedSnapshotRetentionPeriod
(Number automatedSnapshotRetentionPeriod) Sets the value ofCfnClusterProps.getAutomatedSnapshotRetentionPeriod()
availabilityZone
(String availabilityZone) Sets the value ofCfnClusterProps.getAvailabilityZone()
availabilityZoneRelocation
(Boolean availabilityZoneRelocation) Sets the value ofCfnClusterProps.getAvailabilityZoneRelocation()
availabilityZoneRelocation
(IResolvable availabilityZoneRelocation) Sets the value ofCfnClusterProps.getAvailabilityZoneRelocation()
availabilityZoneRelocationStatus
(String availabilityZoneRelocationStatus) Sets the value ofCfnClusterProps.getAvailabilityZoneRelocationStatus()
build()
Builds the configured instance.Sets the value ofCfnClusterProps.getClassic()
classic
(IResolvable classic) Sets the value ofCfnClusterProps.getClassic()
clusterIdentifier
(String clusterIdentifier) Sets the value ofCfnClusterProps.getClusterIdentifier()
clusterParameterGroupName
(String clusterParameterGroupName) Sets the value ofCfnClusterProps.getClusterParameterGroupName()
clusterSecurityGroups
(List<String> clusterSecurityGroups) Sets the value ofCfnClusterProps.getClusterSecurityGroups()
clusterSubnetGroupName
(String clusterSubnetGroupName) Sets the value ofCfnClusterProps.getClusterSubnetGroupName()
clusterType
(String clusterType) Sets the value ofCfnClusterProps.getClusterType()
clusterVersion
(String clusterVersion) Sets the value ofCfnClusterProps.getClusterVersion()
Sets the value ofCfnClusterProps.getDbName()
deferMaintenance
(Boolean deferMaintenance) Sets the value ofCfnClusterProps.getDeferMaintenance()
deferMaintenance
(IResolvable deferMaintenance) Sets the value ofCfnClusterProps.getDeferMaintenance()
deferMaintenanceDuration
(Number deferMaintenanceDuration) Sets the value ofCfnClusterProps.getDeferMaintenanceDuration()
deferMaintenanceEndTime
(String deferMaintenanceEndTime) Sets the value ofCfnClusterProps.getDeferMaintenanceEndTime()
deferMaintenanceStartTime
(String deferMaintenanceStartTime) Sets the value ofCfnClusterProps.getDeferMaintenanceStartTime()
destinationRegion
(String destinationRegion) Sets the value ofCfnClusterProps.getDestinationRegion()
Sets the value ofCfnClusterProps.getElasticIp()
Sets the value ofCfnClusterProps.getEncrypted()
encrypted
(IResolvable encrypted) Sets the value ofCfnClusterProps.getEncrypted()
endpoint
(IResolvable endpoint) Sets the value ofCfnClusterProps.getEndpoint()
endpoint
(CfnCluster.EndpointProperty endpoint) Sets the value ofCfnClusterProps.getEndpoint()
enhancedVpcRouting
(Boolean enhancedVpcRouting) Sets the value ofCfnClusterProps.getEnhancedVpcRouting()
enhancedVpcRouting
(IResolvable enhancedVpcRouting) Sets the value ofCfnClusterProps.getEnhancedVpcRouting()
hsmClientCertificateIdentifier
(String hsmClientCertificateIdentifier) Sets the value ofCfnClusterProps.getHsmClientCertificateIdentifier()
hsmConfigurationIdentifier
(String hsmConfigurationIdentifier) Sets the value ofCfnClusterProps.getHsmConfigurationIdentifier()
Sets the value ofCfnClusterProps.getIamRoles()
Sets the value ofCfnClusterProps.getKmsKeyId()
loggingProperties
(IResolvable loggingProperties) Sets the value ofCfnClusterProps.getLoggingProperties()
loggingProperties
(CfnCluster.LoggingPropertiesProperty loggingProperties) Sets the value ofCfnClusterProps.getLoggingProperties()
maintenanceTrackName
(String maintenanceTrackName) Sets the value ofCfnClusterProps.getMaintenanceTrackName()
manageMasterPassword
(Boolean manageMasterPassword) Sets the value ofCfnClusterProps.getManageMasterPassword()
manageMasterPassword
(IResolvable manageMasterPassword) Sets the value ofCfnClusterProps.getManageMasterPassword()
manualSnapshotRetentionPeriod
(Number manualSnapshotRetentionPeriod) Sets the value ofCfnClusterProps.getManualSnapshotRetentionPeriod()
masterPasswordSecretKmsKeyId
(String masterPasswordSecretKmsKeyId) Sets the value ofCfnClusterProps.getMasterPasswordSecretKmsKeyId()
masterUsername
(String masterUsername) Sets the value ofCfnClusterProps.getMasterUsername()
masterUserPassword
(String masterUserPassword) Sets the value ofCfnClusterProps.getMasterUserPassword()
Sets the value ofCfnClusterProps.getMultiAz()
multiAz
(IResolvable multiAz) Sets the value ofCfnClusterProps.getMultiAz()
namespaceResourcePolicy
(Object namespaceResourcePolicy) Sets the value ofCfnClusterProps.getNamespaceResourcePolicy()
Sets the value ofCfnClusterProps.getNodeType()
numberOfNodes
(Number numberOfNodes) Sets the value ofCfnClusterProps.getNumberOfNodes()
ownerAccount
(String ownerAccount) Sets the value ofCfnClusterProps.getOwnerAccount()
Sets the value ofCfnClusterProps.getPort()
preferredMaintenanceWindow
(String preferredMaintenanceWindow) Sets the value ofCfnClusterProps.getPreferredMaintenanceWindow()
publiclyAccessible
(Boolean publiclyAccessible) Sets the value ofCfnClusterProps.getPubliclyAccessible()
publiclyAccessible
(IResolvable publiclyAccessible) Sets the value ofCfnClusterProps.getPubliclyAccessible()
resourceAction
(String resourceAction) Sets the value ofCfnClusterProps.getResourceAction()
revisionTarget
(String revisionTarget) Sets the value ofCfnClusterProps.getRevisionTarget()
rotateEncryptionKey
(Boolean rotateEncryptionKey) Sets the value ofCfnClusterProps.getRotateEncryptionKey()
rotateEncryptionKey
(IResolvable rotateEncryptionKey) Sets the value ofCfnClusterProps.getRotateEncryptionKey()
snapshotClusterIdentifier
(String snapshotClusterIdentifier) Sets the value ofCfnClusterProps.getSnapshotClusterIdentifier()
snapshotCopyGrantName
(String snapshotCopyGrantName) Sets the value ofCfnClusterProps.getSnapshotCopyGrantName()
snapshotCopyManual
(Boolean snapshotCopyManual) Sets the value ofCfnClusterProps.getSnapshotCopyManual()
snapshotCopyManual
(IResolvable snapshotCopyManual) Sets the value ofCfnClusterProps.getSnapshotCopyManual()
snapshotCopyRetentionPeriod
(Number snapshotCopyRetentionPeriod) Sets the value ofCfnClusterProps.getSnapshotCopyRetentionPeriod()
snapshotIdentifier
(String snapshotIdentifier) Sets the value ofCfnClusterProps.getSnapshotIdentifier()
Sets the value ofCfnClusterProps.getTags()
vpcSecurityGroupIds
(List<String> vpcSecurityGroupIds) Sets the value ofCfnClusterProps.getVpcSecurityGroupIds()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
clusterType
Sets the value ofCfnClusterProps.getClusterType()
- Parameters:
clusterType
- The type of the cluster. When cluster type is specified as. This parameter is required.single-node
, the NumberOfNodes parameter is not required.multi-node
, the NumberOfNodes parameter is required.
Valid Values:
multi-node
|single-node
Default:
multi-node
- Returns:
this
-
dbName
Sets the value ofCfnClusterProps.getDbName()
- Parameters:
dbName
- The name of the first database to be created when the cluster is created. This parameter is required. 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:
- 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.
- Returns:
this
-
masterUsername
Sets the value ofCfnClusterProps.getMasterUsername()
- Parameters:
masterUsername
- The user name associated with the admin user account for the cluster that is being created. This parameter is required. 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.
- Must be 1 - 128 alphanumeric characters or hyphens. The user name can't be
- Returns:
this
-
nodeType
Sets the value ofCfnClusterProps.getNodeType()
- Parameters:
nodeType
- The node type to be provisioned for the cluster. This parameter is required. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide .Valid Values:
dc2.large
|dc2.8xlarge
|ra3.large
|ra3.xlplus
|ra3.4xlarge
|ra3.16xlarge
- Returns:
this
-
allowVersionUpgrade
Sets the value ofCfnClusterProps.getAllowVersionUpgrade()
- Parameters:
allowVersionUpgrade
- 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
- Returns:
this
-
allowVersionUpgrade
@Stability(Stable) public CfnClusterProps.Builder allowVersionUpgrade(IResolvable allowVersionUpgrade) Sets the value ofCfnClusterProps.getAllowVersionUpgrade()
- Parameters:
allowVersionUpgrade
- 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
- Returns:
this
-
aquaConfigurationStatus
@Stability(Stable) public CfnClusterProps.Builder aquaConfigurationStatus(String aquaConfigurationStatus) Sets the value ofCfnClusterProps.getAquaConfigurationStatus()
- Parameters:
aquaConfigurationStatus
- This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).- Returns:
this
-
automatedSnapshotRetentionPeriod
@Stability(Stable) public CfnClusterProps.Builder automatedSnapshotRetentionPeriod(Number automatedSnapshotRetentionPeriod) Sets the value ofCfnClusterProps.getAutomatedSnapshotRetentionPeriod()
- Parameters:
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 CreateClusterSnapshot in the Amazon Redshift API Reference .Default:
1
Constraints: Must be a value from 0 to 35.
- Returns:
this
-
availabilityZone
Sets the value ofCfnClusterProps.getAvailabilityZone()
- Parameters:
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.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.
- Returns:
this
-
availabilityZoneRelocation
@Stability(Stable) public CfnClusterProps.Builder availabilityZoneRelocation(Boolean availabilityZoneRelocation) Sets the value ofCfnClusterProps.getAvailabilityZoneRelocation()
- Parameters:
availabilityZoneRelocation
- The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.- Returns:
this
-
availabilityZoneRelocation
@Stability(Stable) public CfnClusterProps.Builder availabilityZoneRelocation(IResolvable availabilityZoneRelocation) Sets the value ofCfnClusterProps.getAvailabilityZoneRelocation()
- Parameters:
availabilityZoneRelocation
- The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.- Returns:
this
-
availabilityZoneRelocationStatus
@Stability(Stable) public CfnClusterProps.Builder availabilityZoneRelocationStatus(String availabilityZoneRelocationStatus) Sets the value ofCfnClusterProps.getAvailabilityZoneRelocationStatus()
- Parameters:
availabilityZoneRelocationStatus
- Describes the status of the Availability Zone relocation operation.- Returns:
this
-
classic
Sets the value ofCfnClusterProps.getClassic()
- Parameters:
classic
- 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 tofalse
, the resize type is elastic.- Returns:
this
-
classic
Sets the value ofCfnClusterProps.getClassic()
- Parameters:
classic
- 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 tofalse
, the resize type is elastic.- Returns:
this
-
clusterIdentifier
Sets the value ofCfnClusterProps.getClusterIdentifier()
- Parameters:
clusterIdentifier
- 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
- Returns:
this
-
clusterParameterGroupName
@Stability(Stable) public CfnClusterProps.Builder clusterParameterGroupName(String clusterParameterGroupName) Sets the value ofCfnClusterProps.getClusterParameterGroupName()
- Parameters:
clusterParameterGroupName
- 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 GroupsConstraints:
- 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.
- Returns:
this
-
clusterSecurityGroups
@Stability(Stable) public CfnClusterProps.Builder clusterSecurityGroups(List<String> clusterSecurityGroups) Sets the value ofCfnClusterProps.getClusterSecurityGroups()
- Parameters:
clusterSecurityGroups
- A list of security groups to be associated with this cluster. Default: The default cluster security group for Amazon Redshift.- Returns:
this
-
clusterSubnetGroupName
@Stability(Stable) public CfnClusterProps.Builder clusterSubnetGroupName(String clusterSubnetGroupName) Sets the value ofCfnClusterProps.getClusterSubnetGroupName()
- Parameters:
clusterSubnetGroupName
- 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).- Returns:
this
-
clusterVersion
Sets the value ofCfnClusterProps.getClusterVersion()
- Parameters:
clusterVersion
- 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
- Returns:
this
-
deferMaintenance
Sets the value ofCfnClusterProps.getDeferMaintenance()
- Parameters:
deferMaintenance
- A Boolean indicating whether to enable the deferred maintenance window.- Returns:
this
-
deferMaintenance
Sets the value ofCfnClusterProps.getDeferMaintenance()
- Parameters:
deferMaintenance
- A Boolean indicating whether to enable the deferred maintenance window.- Returns:
this
-
deferMaintenanceDuration
@Stability(Stable) public CfnClusterProps.Builder deferMaintenanceDuration(Number deferMaintenanceDuration) Sets the value ofCfnClusterProps.getDeferMaintenanceDuration()
- Parameters:
deferMaintenanceDuration
- 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.- Returns:
this
-
deferMaintenanceEndTime
@Stability(Stable) public CfnClusterProps.Builder deferMaintenanceEndTime(String deferMaintenanceEndTime) Sets the value ofCfnClusterProps.getDeferMaintenanceEndTime()
- Parameters:
deferMaintenanceEndTime
- A timestamp for the end of the time period when we defer maintenance.- Returns:
this
-
deferMaintenanceStartTime
@Stability(Stable) public CfnClusterProps.Builder deferMaintenanceStartTime(String deferMaintenanceStartTime) Sets the value ofCfnClusterProps.getDeferMaintenanceStartTime()
- Parameters:
deferMaintenanceStartTime
- A timestamp indicating the start time for the deferred maintenance window.- Returns:
this
-
destinationRegion
Sets the value ofCfnClusterProps.getDestinationRegion()
- Parameters:
destinationRegion
- The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.- Returns:
this
-
elasticIp
Sets the value ofCfnClusterProps.getElasticIp()
- Parameters:
elasticIp
- 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.- Returns:
this
-
encrypted
Sets the value ofCfnClusterProps.getEncrypted()
- Parameters:
encrypted
- Iftrue
, the data in the cluster is encrypted at rest. Default: false- Returns:
this
-
encrypted
Sets the value ofCfnClusterProps.getEncrypted()
- Parameters:
encrypted
- Iftrue
, the data in the cluster is encrypted at rest. Default: false- Returns:
this
-
endpoint
Sets the value ofCfnClusterProps.getEndpoint()
- Parameters:
endpoint
- The connection endpoint.- Returns:
this
-
endpoint
Sets the value ofCfnClusterProps.getEndpoint()
- Parameters:
endpoint
- The connection endpoint.- Returns:
this
-
enhancedVpcRouting
Sets the value ofCfnClusterProps.getEnhancedVpcRouting()
- Parameters:
enhancedVpcRouting
- 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
- Returns:
this
-
enhancedVpcRouting
@Stability(Stable) public CfnClusterProps.Builder enhancedVpcRouting(IResolvable enhancedVpcRouting) Sets the value ofCfnClusterProps.getEnhancedVpcRouting()
- Parameters:
enhancedVpcRouting
- 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
- Returns:
this
-
hsmClientCertificateIdentifier
@Stability(Stable) public CfnClusterProps.Builder hsmClientCertificateIdentifier(String hsmClientCertificateIdentifier) Sets the value ofCfnClusterProps.getHsmClientCertificateIdentifier()
- Parameters:
hsmClientCertificateIdentifier
- Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.- Returns:
this
-
hsmConfigurationIdentifier
@Stability(Stable) public CfnClusterProps.Builder hsmConfigurationIdentifier(String hsmConfigurationIdentifier) Sets the value ofCfnClusterProps.getHsmConfigurationIdentifier()
- Parameters:
hsmConfigurationIdentifier
- 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.- Returns:
this
-
iamRoles
Sets the value ofCfnClusterProps.getIamRoles()
- Parameters:
iamRoles
- 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 .
- Returns:
this
-
kmsKeyId
Sets the value ofCfnClusterProps.getKmsKeyId()
- Parameters:
kmsKeyId
- The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.- Returns:
this
-
loggingProperties
Sets the value ofCfnClusterProps.getLoggingProperties()
- Parameters:
loggingProperties
- Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.- Returns:
this
-
loggingProperties
@Stability(Stable) public CfnClusterProps.Builder loggingProperties(CfnCluster.LoggingPropertiesProperty loggingProperties) Sets the value ofCfnClusterProps.getLoggingProperties()
- Parameters:
loggingProperties
- Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.- Returns:
this
-
maintenanceTrackName
Sets the value ofCfnClusterProps.getMaintenanceTrackName()
- Parameters:
maintenanceTrackName
- 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 thecurrent
track.- Returns:
this
-
manageMasterPassword
@Stability(Stable) public CfnClusterProps.Builder manageMasterPassword(Boolean manageMasterPassword) Sets the value ofCfnClusterProps.getManageMasterPassword()
- Parameters:
manageMasterPassword
- Iftrue
, Amazon Redshift uses AWS Secrets Manager to manage this cluster's admin credentials. You can't useMasterUserPassword
ifManageMasterPassword
is true. IfManageMasterPassword
is false or not set, Amazon Redshift usesMasterUserPassword
for the admin user account's password.- Returns:
this
-
manageMasterPassword
@Stability(Stable) public CfnClusterProps.Builder manageMasterPassword(IResolvable manageMasterPassword) Sets the value ofCfnClusterProps.getManageMasterPassword()
- Parameters:
manageMasterPassword
- Iftrue
, Amazon Redshift uses AWS Secrets Manager to manage this cluster's admin credentials. You can't useMasterUserPassword
ifManageMasterPassword
is true. IfManageMasterPassword
is false or not set, Amazon Redshift usesMasterUserPassword
for the admin user account's password.- Returns:
this
-
manualSnapshotRetentionPeriod
@Stability(Stable) public CfnClusterProps.Builder manualSnapshotRetentionPeriod(Number manualSnapshotRetentionPeriod) Sets the value ofCfnClusterProps.getManualSnapshotRetentionPeriod()
- Parameters:
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.The value must be either -1 or an integer between 1 and 3,653.
- Returns:
this
-
masterPasswordSecretKmsKeyId
@Stability(Stable) public CfnClusterProps.Builder masterPasswordSecretKmsKeyId(String masterPasswordSecretKmsKeyId) Sets the value ofCfnClusterProps.getMasterPasswordSecretKmsKeyId()
- Parameters:
masterPasswordSecretKmsKeyId
- 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 ifManageMasterPassword
is true.- Returns:
this
-
masterUserPassword
Sets the value ofCfnClusterProps.getMasterUserPassword()
- Parameters:
masterUserPassword
- The password associated with the admin user account for the cluster that is being created. You can't useMasterUserPassword
ifManageMasterPassword
istrue
.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@
.
- Returns:
this
-
multiAz
Sets the value ofCfnClusterProps.getMultiAz()
- Parameters:
multiAz
- A boolean indicating whether Amazon Redshift should deploy the cluster in two Availability Zones. The default is false.- Returns:
this
-
multiAz
Sets the value ofCfnClusterProps.getMultiAz()
- Parameters:
multiAz
- A boolean indicating whether Amazon Redshift should deploy the cluster in two Availability Zones. The default is false.- Returns:
this
-
namespaceResourcePolicy
@Stability(Stable) public CfnClusterProps.Builder namespaceResourcePolicy(Object namespaceResourcePolicy) Sets the value ofCfnClusterProps.getNamespaceResourcePolicy()
- Parameters:
namespaceResourcePolicy
- The policy that is attached to a resource.- Returns:
this
-
numberOfNodes
Sets the value ofCfnClusterProps.getNumberOfNodes()
- Parameters:
numberOfNodes
- The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified asmulti-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.
- Returns:
this
-
ownerAccount
Sets the value ofCfnClusterProps.getOwnerAccount()
- Parameters:
ownerAccount
- 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.- Returns:
this
-
port
Sets the value ofCfnClusterProps.getPort()
- Parameters:
port
- 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:
5439
Valid Values:
- For clusters with ra3 nodes - Select a port within the ranges
5431-5455
or8191-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 dc2 nodes - Select a port within the range
1150-65535
.
- For clusters with ra3 nodes - Select a port within the ranges
- Returns:
this
-
preferredMaintenanceWindow
@Stability(Stable) public CfnClusterProps.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow) Sets the value ofCfnClusterProps.getPreferredMaintenanceWindow()
- Parameters:
preferredMaintenanceWindow
- The weekly time range (in UTC) during which automated cluster maintenance can occur. 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.
- Returns:
this
-
publiclyAccessible
Sets the value ofCfnClusterProps.getPubliclyAccessible()
- Parameters:
publiclyAccessible
- Iftrue
, the cluster can be accessed from a public network.- Returns:
this
-
publiclyAccessible
@Stability(Stable) public CfnClusterProps.Builder publiclyAccessible(IResolvable publiclyAccessible) Sets the value ofCfnClusterProps.getPubliclyAccessible()
- Parameters:
publiclyAccessible
- Iftrue
, the cluster can be accessed from a public network.- Returns:
this
-
resourceAction
Sets the value ofCfnClusterProps.getResourceAction()
- Parameters:
resourceAction
- The Amazon Redshift operation to be performed. Supported operations arepause-cluster
,resume-cluster
, andfailover-primary-compute
.- Returns:
this
-
revisionTarget
Sets the value ofCfnClusterProps.getRevisionTarget()
- Parameters:
revisionTarget
- Describes aRevisionTarget
object.- Returns:
this
-
rotateEncryptionKey
Sets the value ofCfnClusterProps.getRotateEncryptionKey()
- Parameters:
rotateEncryptionKey
- Rotates the encryption keys for a cluster.- Returns:
this
-
rotateEncryptionKey
@Stability(Stable) public CfnClusterProps.Builder rotateEncryptionKey(IResolvable rotateEncryptionKey) Sets the value ofCfnClusterProps.getRotateEncryptionKey()
- Parameters:
rotateEncryptionKey
- Rotates the encryption keys for a cluster.- Returns:
this
-
snapshotClusterIdentifier
@Stability(Stable) public CfnClusterProps.Builder snapshotClusterIdentifier(String snapshotClusterIdentifier) Sets the value ofCfnClusterProps.getSnapshotClusterIdentifier()
- Parameters:
snapshotClusterIdentifier
- 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.- Returns:
this
-
snapshotCopyGrantName
@Stability(Stable) public CfnClusterProps.Builder snapshotCopyGrantName(String snapshotCopyGrantName) Sets the value ofCfnClusterProps.getSnapshotCopyGrantName()
- Parameters:
snapshotCopyGrantName
- The name of the snapshot copy grant.- Returns:
this
-
snapshotCopyManual
Sets the value ofCfnClusterProps.getSnapshotCopyManual()
- Parameters:
snapshotCopyManual
- Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.- Returns:
this
-
snapshotCopyManual
@Stability(Stable) public CfnClusterProps.Builder snapshotCopyManual(IResolvable snapshotCopyManual) Sets the value ofCfnClusterProps.getSnapshotCopyManual()
- Parameters:
snapshotCopyManual
- Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.- Returns:
this
-
snapshotCopyRetentionPeriod
@Stability(Stable) public CfnClusterProps.Builder snapshotCopyRetentionPeriod(Number snapshotCopyRetentionPeriod) Sets the value ofCfnClusterProps.getSnapshotCopyRetentionPeriod()
- Parameters:
snapshotCopyRetentionPeriod
- 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
manual
option, 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.
- Returns:
this
-
snapshotIdentifier
Sets the value ofCfnClusterProps.getSnapshotIdentifier()
- Parameters:
snapshotIdentifier
- The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. You must specify this parameter orsnapshotArn
, but not both.Example:
my-snapshot-id
- Returns:
this
-
tags
Sets the value ofCfnClusterProps.getTags()
- Parameters:
tags
- A list of tag instances.- Returns:
this
-
vpcSecurityGroupIds
@Stability(Stable) public CfnClusterProps.Builder vpcSecurityGroupIds(List<String> vpcSecurityGroupIds) Sets the value ofCfnClusterProps.getVpcSecurityGroupIds()
- Parameters:
vpcSecurityGroupIds
- 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.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnClusterProps>
- Returns:
- a new instance of
CfnClusterProps
- Throws:
NullPointerException
- if any required attribute was not provided
-