Package software.amazon.awscdk.services.redshift

Class CfnClusterProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.redshift.CfnClusterProps.Jsii$Proxy
All Implemented Interfaces:
CfnClusterProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
CfnClusterProps
@Stability(Stable) @Internal public static final class CfnClusterProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnClusterProps
An implementation for CfnClusterProps

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(CfnClusterProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the CfnClusterProps.Builder.

  • Method Details

    • getClusterType

      public final String getClusterType()
      Description copied from interface: CfnClusterProps
      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-node

      Default: multi-node

      Specified by:
      getClusterType in interface CfnClusterProps

    • getDbName

      public final String getDbName()
      Description copied from interface: CfnClusterProps
      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: 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.
      Specified by:
      getDbName in interface CfnClusterProps

    • getMasterUsername

      public final String getMasterUsername()
      Description copied from interface: CfnClusterProps
      The user name associated with the admin user 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.
      Specified by:
      getMasterUsername in interface CfnClusterProps

    • getMasterUserPassword

      public final String getMasterUserPassword()
      Description copied from interface: CfnClusterProps
      The password associated with the admin user for the cluster that is being created.

      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 @ .
      Specified by:
      getMasterUserPassword in interface CfnClusterProps

    • getNodeType

      public final String getNodeType()
      Description copied from interface: CfnClusterProps
      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

      Specified by:
      getNodeType in interface CfnClusterProps

    • getAllowVersionUpgrade

      public final Object getAllowVersionUpgrade()
      Description copied from interface: CfnClusterProps
      If true , 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

      Specified by:
      getAllowVersionUpgrade in interface CfnClusterProps

    • getAquaConfigurationStatus

      public final String getAquaConfigurationStatus()
      Description copied from interface: CfnClusterProps
      This parameter is retired.

      It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).

      Specified by:
      getAquaConfigurationStatus in interface CfnClusterProps

    • getAutomatedSnapshotRetentionPeriod

      public final Number getAutomatedSnapshotRetentionPeriod()
      Description copied from interface: CfnClusterProps
      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.

      Specified by:
      getAutomatedSnapshotRetentionPeriod in interface CfnClusterProps

    • getAvailabilityZone

      public final String getAvailabilityZone()
      Description copied from interface: CfnClusterProps
      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.

      Specified by:
      getAvailabilityZone in interface CfnClusterProps

    • getAvailabilityZoneRelocation

      public final Object getAvailabilityZoneRelocation()
      Description copied from interface: CfnClusterProps
      The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.
      Specified by:
      getAvailabilityZoneRelocation in interface CfnClusterProps

    • getAvailabilityZoneRelocationStatus

      public final String getAvailabilityZoneRelocationStatus()
      Description copied from interface: CfnClusterProps
      Describes the status of the Availability Zone relocation operation.
      Specified by:
      getAvailabilityZoneRelocationStatus in interface CfnClusterProps

    • getClassic

      public final Object getClassic()
      Description copied from interface: CfnClusterProps
      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.

      Specified by:
      getClassic in interface CfnClusterProps

    • getClusterIdentifier

      public final String getClusterIdentifier()
      Description copied from interface: CfnClusterProps
      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

      Specified by:
      getClusterIdentifier in interface CfnClusterProps

    • getClusterParameterGroupName

      public final String getClusterParameterGroupName()
      Description copied from interface: CfnClusterProps
      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.
      Specified by:
      getClusterParameterGroupName in interface CfnClusterProps

    • getClusterSecurityGroups

      public final List<String> getClusterSecurityGroups()
      Description copied from interface: CfnClusterProps
      A list of security groups to be associated with this cluster.

      Default: The default cluster security group for Amazon Redshift.

      Specified by:
      getClusterSecurityGroups in interface CfnClusterProps

    • getClusterSubnetGroupName

      public final String getClusterSubnetGroupName()
      Description copied from interface: CfnClusterProps
      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).

      Specified by:
      getClusterSubnetGroupName in interface CfnClusterProps

    • getClusterVersion

      public final String getClusterVersion()
      Description copied from interface: CfnClusterProps
      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

      Specified by:
      getClusterVersion in interface CfnClusterProps

    • getDeferMaintenance

      public final Object getDeferMaintenance()
      Description copied from interface: CfnClusterProps
      A Boolean indicating whether to enable the deferred maintenance window.
      Specified by:
      getDeferMaintenance in interface CfnClusterProps

    • getDeferMaintenanceDuration

      public final Number getDeferMaintenanceDuration()
      Description copied from interface: CfnClusterProps
      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.

      Specified by:
      getDeferMaintenanceDuration in interface CfnClusterProps

    • getDeferMaintenanceEndTime

      public final String getDeferMaintenanceEndTime()
      Description copied from interface: CfnClusterProps
      A timestamp for the end of the time period when we defer maintenance.
      Specified by:
      getDeferMaintenanceEndTime in interface CfnClusterProps

    • getDeferMaintenanceStartTime

      public final String getDeferMaintenanceStartTime()
      Description copied from interface: CfnClusterProps
      A timestamp indicating the start time for the deferred maintenance window.
      Specified by:
      getDeferMaintenanceStartTime in interface CfnClusterProps

    • getDestinationRegion

      public final String getDestinationRegion()
      Description copied from interface: CfnClusterProps
      The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
      Specified by:
      getDestinationRegion in interface CfnClusterProps

    • getElasticIp

      public final String getElasticIp()
      Description copied from interface: CfnClusterProps
      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.

      Specified by:
      getElasticIp in interface CfnClusterProps

    • getEncrypted

      public final Object getEncrypted()
      Description copied from interface: CfnClusterProps
      If true , the data in the cluster is encrypted at rest.

      Default: false

      Specified by:
      getEncrypted in interface CfnClusterProps

    • getEndpoint

      public final Object getEndpoint()
      Description copied from interface: CfnClusterProps
      The connection endpoint.
      Specified by:
      getEndpoint in interface CfnClusterProps

    • getEnhancedVpcRouting

      public final Object getEnhancedVpcRouting()
      Description copied from interface: CfnClusterProps
      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

      Specified by:
      getEnhancedVpcRouting in interface CfnClusterProps

    • getHsmClientCertificateIdentifier

      public final String getHsmClientCertificateIdentifier()
      Description copied from interface: CfnClusterProps
      Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
      Specified by:
      getHsmClientCertificateIdentifier in interface CfnClusterProps

    • getHsmConfigurationIdentifier

      public final String getHsmConfigurationIdentifier()
      Description copied from interface: CfnClusterProps
      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.
      Specified by:
      getHsmConfigurationIdentifier in interface CfnClusterProps

    • getIamRoles

      public final List<String> getIamRoles()
      Description copied from interface: CfnClusterProps
      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 .

      Specified by:
      getIamRoles in interface CfnClusterProps

    • getKmsKeyId

      public final String getKmsKeyId()
      Description copied from interface: CfnClusterProps
      The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
      Specified by:
      getKmsKeyId in interface CfnClusterProps

    • getLoggingProperties

      public final Object getLoggingProperties()
      Description copied from interface: CfnClusterProps
      Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
      Specified by:
      getLoggingProperties in interface CfnClusterProps

    • getMaintenanceTrackName

      public final String getMaintenanceTrackName()
      Description copied from interface: CfnClusterProps
      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 current track.

      Specified by:
      getMaintenanceTrackName in interface CfnClusterProps

    • getManualSnapshotRetentionPeriod

      public final Number getManualSnapshotRetentionPeriod()
      Description copied from interface: CfnClusterProps
      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.

      Specified by:
      getManualSnapshotRetentionPeriod in interface CfnClusterProps

    • getNumberOfNodes

      public final Number getNumberOfNodes()
      Description copied from interface: CfnClusterProps
      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: 1

      Constraints: Value must be at least 1 and no more than 100.

      Specified by:
      getNumberOfNodes in interface CfnClusterProps

    • getOwnerAccount

      public final String getOwnerAccount()
      Description copied from interface: CfnClusterProps
      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.

      Specified by:
      getOwnerAccount in interface CfnClusterProps

    • getPort

      public final Number getPort()
      Description copied from interface: CfnClusterProps
      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: 1150-65535

      Specified by:
      getPort in interface CfnClusterProps

    • getPreferredMaintenanceWindow

      public final String getPreferredMaintenanceWindow()
      Description copied from interface: CfnClusterProps
      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.

      Specified by:
      getPreferredMaintenanceWindow in interface CfnClusterProps

    • getPubliclyAccessible

      public final Object getPubliclyAccessible()
      Description copied from interface: CfnClusterProps
      If true , the cluster can be accessed from a public network.
      Specified by:
      getPubliclyAccessible in interface CfnClusterProps

    • getResourceAction

      public final String getResourceAction()
      Description copied from interface: CfnClusterProps
      The Amazon Redshift operation to be performed.

      Supported operations are pause-cluster and resume-cluster .

      Specified by:
      getResourceAction in interface CfnClusterProps

    • getRevisionTarget

      public final String getRevisionTarget()
      Description copied from interface: CfnClusterProps
      Describes a RevisionTarget object.
      Specified by:
      getRevisionTarget in interface CfnClusterProps

    • getRotateEncryptionKey

      public final Object getRotateEncryptionKey()
      Description copied from interface: CfnClusterProps
      Rotates the encryption keys for a cluster.
      Specified by:
      getRotateEncryptionKey in interface CfnClusterProps

    • getSnapshotClusterIdentifier

      public final String getSnapshotClusterIdentifier()
      Description copied from interface: CfnClusterProps
      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.

      Specified by:
      getSnapshotClusterIdentifier in interface CfnClusterProps

    • getSnapshotCopyGrantName

      public final String getSnapshotCopyGrantName()
      Description copied from interface: CfnClusterProps
      The name of the snapshot copy grant.
      Specified by:
      getSnapshotCopyGrantName in interface CfnClusterProps

    • getSnapshotCopyManual

      public final Object getSnapshotCopyManual()
      Description copied from interface: CfnClusterProps
      Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
      Specified by:
      getSnapshotCopyManual in interface CfnClusterProps

    • getSnapshotCopyRetentionPeriod

      public final Number getSnapshotCopyRetentionPeriod()
      Description copied from interface: CfnClusterProps
      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.

      Specified by:
      getSnapshotCopyRetentionPeriod in interface CfnClusterProps

    • getSnapshotIdentifier

      public final String getSnapshotIdentifier()
      Description copied from interface: CfnClusterProps
      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

      Specified by:
      getSnapshotIdentifier in interface CfnClusterProps

    • getTags

      public final List<CfnTag> getTags()
      Description copied from interface: CfnClusterProps
      A list of tag instances.
      Specified by:
      getTags in interface CfnClusterProps

    • getVpcSecurityGroupIds

      public final List<String> getVpcSecurityGroupIds()
      Description copied from interface: CfnClusterProps
      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.

      Specified by:
      getVpcSecurityGroupIds in interface CfnClusterProps

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object