@Stability(value=Stable) @Internal public static final class CfnClusterProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnClusterProps
CfnClusterPropssoftware.amazon.jsii.JsiiObject.InitializationModeCfnClusterProps.Builder, CfnClusterProps.Jsii$Proxy| Modifier | Constructor and Description |
|---|---|
protected |
Jsii$Proxy(CfnClusterProps.Builder builder)
Constructor that initializes the object based on literal property values passed by the
CfnClusterProps.Builder. |
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
| Modifier and Type | Method and Description |
|---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson() |
boolean |
equals(Object o) |
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.
|
String |
getAquaConfigurationStatus()
The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) when it is created.
|
Number |
getAutomatedSnapshotRetentionPeriod()
The number of days that automated snapshots are retained.
|
String |
getAvailabilityZone()
The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster.
|
Object |
getAvailabilityZoneRelocation()
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.
|
String |
getAvailabilityZoneRelocationStatus()
Describes the status of the Availability Zone relocation operation.
|
Object |
getClassic()
A boolean value indicating whether the resize operation is using the classic resize process.
|
String |
getClusterIdentifier()
A unique identifier for the cluster.
|
String |
getClusterParameterGroupName()
The name of the parameter group to be associated with this cluster.
|
List<String> |
getClusterSecurityGroups()
A list of security groups to be associated with this cluster.
|
String |
getClusterSubnetGroupName()
The name of a cluster subnet group to be associated with this cluster.
|
String |
getClusterType()
The type of the cluster.
|
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.
|
Object |
getDeferMaintenance()
`AWS::Redshift::Cluster.DeferMaintenance`.
|
Number |
getDeferMaintenanceDuration()
`AWS::Redshift::Cluster.DeferMaintenanceDuration`.
|
String |
getDeferMaintenanceEndTime()
`AWS::Redshift::Cluster.DeferMaintenanceEndTime`.
|
String |
getDeferMaintenanceStartTime()
`AWS::Redshift::Cluster.DeferMaintenanceStartTime`.
|
String |
getDestinationRegion()
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
|
String |
getElasticIp()
The Elastic IP (EIP) address for the cluster.
|
Object |
getEncrypted()
If `true` , the data in the cluster is encrypted at rest.
|
Object |
getEnhancedVpcRouting()
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
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.
|
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.
|
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.
|
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.
|
Object |
getLoggingProperties()
Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
|
String |
getMaintenanceTrackName()
An optional parameter for the name of the maintenance track for the cluster.
|
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.
|
Number |
getNumberOfNodes()
The number of compute nodes in the cluster.
|
String |
getOwnerAccount()
The AWS account used to create or copy the snapshot.
|
Number |
getPort()
The port number on which the cluster accepts incoming connections.
|
String |
getPreferredMaintenanceWindow()
The weekly time range (in UTC) during which automated cluster maintenance can occur.
|
Object |
getPubliclyAccessible()
If `true` , the cluster can be accessed from a public network.
|
String |
getResourceAction()
`AWS::Redshift::Cluster.ResourceAction`.
|
String |
getRevisionTarget()
`AWS::Redshift::Cluster.RevisionTarget`.
|
Object |
getRotateEncryptionKey()
`AWS::Redshift::Cluster.RotateEncryptionKey`.
|
String |
getSnapshotClusterIdentifier()
The name of the cluster the source snapshot was created from.
|
String |
getSnapshotCopyGrantName()
The name of the snapshot copy grant.
|
Object |
getSnapshotCopyManual()
`AWS::Redshift::Cluster.SnapshotCopyManual`.
|
Number |
getSnapshotCopyRetentionPeriod()
`AWS::Redshift::Cluster.SnapshotCopyRetentionPeriod`.
|
String |
getSnapshotIdentifier()
The name of the snapshot from which to create the new cluster.
|
List<CfnTag> |
getTags()
A list of tag instances.
|
List<String> |
getVpcSecurityGroupIds()
A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
|
int |
hashCode() |
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitbuilderprotected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef - Reference to the JSII managed object.protected Jsii$Proxy(CfnClusterProps.Builder builder)
CfnClusterProps.Builder.public final String getClusterType()
CfnClusterProps
single-node , the NumberOfNodes parameter is not required.multi-node , the NumberOfNodes parameter is required.
Valid Values: multi-node | single-node
Default: multi-node
getClusterType in interface CfnClusterPropspublic final String getDbName()
CfnClusterPropsTo 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:
getDbName in interface CfnClusterPropspublic final String getMasterUsername()
CfnClusterPropsConstraints:
PUBLIC .getMasterUsername in interface CfnClusterPropspublic final String getMasterUserPassword()
CfnClusterPropsConstraints:
getMasterUserPassword in interface CfnClusterPropspublic final String getNodeType()
CfnClusterPropsFor 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
getNodeType in interface CfnClusterPropspublic final Object getAllowVersionUpgrade()
CfnClusterPropsWhen 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
getAllowVersionUpgrade in interface CfnClusterPropspublic final String getAquaConfigurationStatus()
CfnClusterPropsPossible values include the following.
getAquaConfigurationStatus in interface CfnClusterPropspublic final Number getAutomatedSnapshotRetentionPeriod()
CfnClusterPropsIf 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.
getAutomatedSnapshotRetentionPeriod in interface CfnClusterPropspublic final String getAvailabilityZone()
CfnClusterPropsFor 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.
getAvailabilityZone in interface CfnClusterPropspublic final Object getAvailabilityZoneRelocation()
CfnClusterPropsgetAvailabilityZoneRelocation in interface CfnClusterPropspublic final String getAvailabilityZoneRelocationStatus()
CfnClusterPropsgetAvailabilityZoneRelocationStatus in interface CfnClusterPropspublic final Object getClassic()
CfnClusterProps
If you don't provide this parameter or set the value to false , the resize type is elastic.
getClassic in interface CfnClusterPropspublic final String getClusterIdentifier()
CfnClusterPropsYou 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
getClusterIdentifier in interface CfnClusterPropspublic final String getClusterParameterGroupName()
CfnClusterPropsDefault: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups
Constraints:
getClusterParameterGroupName in interface CfnClusterPropspublic final List<String> getClusterSecurityGroups()
CfnClusterPropsDefault: The default cluster security group for Amazon Redshift.
getClusterSecurityGroups in interface CfnClusterPropspublic final String getClusterSubnetGroupName()
CfnClusterPropsIf this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
getClusterSubnetGroupName in interface CfnClusterPropspublic final String getClusterVersion()
CfnClusterPropsThe version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available.
Example: 1.0
getClusterVersion in interface CfnClusterPropspublic final Object getDeferMaintenance()
CfnClusterPropsgetDeferMaintenance in interface CfnClusterPropspublic final Number getDeferMaintenanceDuration()
CfnClusterPropsgetDeferMaintenanceDuration in interface CfnClusterPropspublic final String getDeferMaintenanceEndTime()
CfnClusterPropsgetDeferMaintenanceEndTime in interface CfnClusterPropspublic final String getDeferMaintenanceStartTime()
CfnClusterPropsgetDeferMaintenanceStartTime in interface CfnClusterPropspublic final String getDestinationRegion()
CfnClusterPropsgetDestinationRegion in interface CfnClusterPropspublic final String getElasticIp()
CfnClusterPropsConstraints: 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.
getElasticIp in interface CfnClusterPropspublic final Object getEncrypted()
CfnClusterPropsDefault: false
getEncrypted in interface CfnClusterPropspublic final Object getEnhancedVpcRouting()
CfnClusterPropsTo 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
getEnhancedVpcRouting in interface CfnClusterPropspublic final String getHsmClientCertificateIdentifier()
CfnClusterPropsgetHsmClientCertificateIdentifier in interface CfnClusterPropspublic final String getHsmConfigurationIdentifier()
CfnClusterPropsgetHsmConfigurationIdentifier in interface CfnClusterPropspublic final List<String> getIamRoles()
CfnClusterPropsYou 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.
getIamRoles in interface CfnClusterPropspublic final String getKmsKeyId()
CfnClusterPropsgetKmsKeyId in interface CfnClusterPropspublic final Object getLoggingProperties()
CfnClusterPropsgetLoggingProperties in interface CfnClusterPropspublic final String getMaintenanceTrackName()
CfnClusterProps
If you don't provide a maintenance track name, the cluster is assigned to the current track.
getMaintenanceTrackName in interface CfnClusterPropspublic final Number getManualSnapshotRetentionPeriod()
CfnClusterPropsIf 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.
getManualSnapshotRetentionPeriod in interface CfnClusterPropspublic final Number getNumberOfNodes()
CfnClusterProps
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.
getNumberOfNodes in interface CfnClusterPropspublic final String getOwnerAccount()
CfnClusterPropsRequired if you are restoring a snapshot you do not own, optional if you own the snapshot.
getOwnerAccount in interface CfnClusterPropspublic final Number getPort()
CfnClusterPropsThe 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
getPort in interface CfnClusterPropspublic final String getPreferredMaintenanceWindow()
CfnClusterProps
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.
getPreferredMaintenanceWindow in interface CfnClusterPropspublic final Object getPubliclyAccessible()
CfnClusterPropsgetPubliclyAccessible in interface CfnClusterPropspublic final String getResourceAction()
CfnClusterPropsgetResourceAction in interface CfnClusterPropspublic final String getRevisionTarget()
CfnClusterPropsgetRevisionTarget in interface CfnClusterPropspublic final Object getRotateEncryptionKey()
CfnClusterPropsgetRotateEncryptionKey in interface CfnClusterPropspublic final String getSnapshotClusterIdentifier()
CfnClusterPropsThis parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
getSnapshotClusterIdentifier in interface CfnClusterPropspublic final String getSnapshotCopyGrantName()
CfnClusterPropsgetSnapshotCopyGrantName in interface CfnClusterPropspublic final Object getSnapshotCopyManual()
CfnClusterPropsgetSnapshotCopyManual in interface CfnClusterPropspublic final Number getSnapshotCopyRetentionPeriod()
CfnClusterPropsgetSnapshotCopyRetentionPeriod in interface CfnClusterPropspublic final String getSnapshotIdentifier()
CfnClusterProps
Example: my-snapshot-id
getSnapshotIdentifier in interface CfnClusterPropspublic final List<CfnTag> getTags()
CfnClusterPropsgetTags in interface CfnClusterPropspublic final List<String> getVpcSecurityGroupIds()
CfnClusterPropsDefault: The default VPC security group is associated with the cluster.
getVpcSecurityGroupIds in interface CfnClusterProps@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
$jsii$toJson in interface software.amazon.jsii.JsiiSerializableCopyright © 2022. All rights reserved.