Package software.amazon.awssdk.services.redshift.model

Class CreateClusterRequest

    • Method Detail

      • dbName

        public final String dbName()

        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.

        Returns:
        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.

      • clusterIdentifier

        public final String 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 Amazon Web Services account.

        Example: myexamplecluster

        Returns:
        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 Amazon Web Services account.

        Example: myexamplecluster

      • clusterType

        public final String clusterType()

        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

        Returns:
        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

      • nodeType

        public final String nodeType()

        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: dc2.large | dc2.8xlarge | ra3.large | ra3.xlplus | ra3.4xlarge | ra3.16xlarge

        Returns:
        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: dc2.large | dc2.8xlarge | ra3.large | ra3.xlplus | ra3.4xlarge | ra3.16xlarge

      • masterUsername

        public final String masterUsername()

        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.

        Returns:
        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.

      • masterUserPassword

        public final String masterUserPassword()

        The password associated with the admin user account for the cluster that is being created.

        You can't use MasterUserPassword if ManageMasterPassword is true.

        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:
        The password associated with the admin user account for the cluster that is being created.

        You can't use MasterUserPassword if ManageMasterPassword is true.

        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 @.

      • hasClusterSecurityGroups

        public final boolean hasClusterSecurityGroups()
        For responses, this returns true if the service returned a value for the ClusterSecurityGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • clusterSecurityGroups

        public final List<String> clusterSecurityGroups()

        A list of security groups to be associated with this cluster.

        Default: The default cluster security group for Amazon Redshift.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasClusterSecurityGroups() method.

        Returns:
        A list of security groups to be associated with this cluster.

        Default: The default cluster security group for Amazon Redshift.

      • hasVpcSecurityGroupIds

        public final boolean hasVpcSecurityGroupIds()
        For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • vpcSecurityGroupIds

        public final List<String> 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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVpcSecurityGroupIds() method.

        Returns:
        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.

      • clusterSubnetGroupName

        public final String 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:
        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).

      • availabilityZone

        public final String 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:
        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.

      • preferredMaintenanceWindow

        public final String 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:
        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.

      • clusterParameterGroupName

        public final String 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 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.

        Returns:
        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.

      • automatedSnapshotRetentionPeriod

        public final Integer 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.

        You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.

        Default: 1

        Constraints: Must be a value from 0 to 35.

        Returns:
        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.

        You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.

        Default: 1

        Constraints: Must be a value from 0 to 35.

      • manualSnapshotRetentionPeriod

        public final Integer 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:
        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.

      • port

        public final Integer 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 or 8191-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.

        Returns:
        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 or 8191-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.

      • clusterVersion

        public final String 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:
        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

      • allowVersionUpgrade

        public final Boolean allowVersionUpgrade()

        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

        Returns:
        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

      • numberOfNodes

        public final Integer numberOfNodes()

        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.

        Returns:
        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.

      • publiclyAccessible

        public final Boolean publiclyAccessible()

        If true, the cluster can be accessed from a public network.

        Returns:
        If true, the cluster can be accessed from a public network.

      • encrypted

        public final Boolean encrypted()

        If true, the data in the cluster is encrypted at rest.

        Default: false

        Returns:
        If true, the data in the cluster is encrypted at rest.

        Default: false

      • hsmClientCertificateIdentifier

        public final String 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:
        Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

      • hsmConfigurationIdentifier

        public final String 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:
        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.

      • elasticIp

        public final String 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:
        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.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

        public final List<Tag> tags()

        A list of tag instances.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        A list of tag instances.

      • kmsKeyId

        public final String kmsKeyId()

        The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.

        Returns:
        The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.

      • enhancedVpcRouting

        public final Boolean 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:
        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

      • additionalInfo

        public final String additionalInfo()

        Reserved.

        Returns:
        Reserved.

      • hasIamRoles

        public final boolean hasIamRoles()
        For responses, this returns true if the service returned a value for the IamRoles property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • iamRoles

        public final List<String> iamRoles()

        A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services 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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIamRoles() method.

        Returns:
        A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services 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.

      • maintenanceTrackName

        public final String 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 the current track.

        Returns:
        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.

      • snapshotScheduleIdentifier

        public final String snapshotScheduleIdentifier()

        A unique identifier for the snapshot schedule.

        Returns:
        A unique identifier for the snapshot schedule.

      • availabilityZoneRelocation

        public final Boolean availabilityZoneRelocation()

        The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.

        Returns:
        The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.

      • aquaConfigurationStatus

        public final AquaConfigurationStatus aquaConfigurationStatus()

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

        If the service returns an enum value that is not available in the current SDK version, aquaConfigurationStatus will return AquaConfigurationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aquaConfigurationStatusAsString().

        Returns:
        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:
        AquaConfigurationStatus

      • aquaConfigurationStatusAsString

        public final String aquaConfigurationStatusAsString()

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

        If the service returns an enum value that is not available in the current SDK version, aquaConfigurationStatus will return AquaConfigurationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aquaConfigurationStatusAsString().

        Returns:
        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:
        AquaConfigurationStatus

      • defaultIamRoleArn

        public final String defaultIamRoleArn()

        The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.

        Returns:
        The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.

      • loadSampleData

        public final String loadSampleData()

        A flag that specifies whether to load sample data once the cluster is created.

        Returns:
        A flag that specifies whether to load sample data once the cluster is created.

      • manageMasterPassword

        public final Boolean manageMasterPassword()

        If true, Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password.

        Returns:
        If true, Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password.

      • masterPasswordSecretKmsKeyId

        public final String masterPasswordSecretKmsKeyId()

        The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. You can only use this parameter if ManageMasterPassword is true.

        Returns:
        The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. You can only use this parameter if ManageMasterPassword is true.

      • ipAddressType

        public final String ipAddressType()

        The IP address types that the cluster supports. Possible values are ipv4 and dualstack.

        Returns:
        The IP address types that the cluster supports. Possible values are ipv4 and dualstack.

      • multiAZ

        public final Boolean multiAZ()

        If true, Amazon Redshift will deploy the cluster in two Availability Zones (AZ).

        Returns:
        If true, Amazon Redshift will deploy the cluster in two Availability Zones (AZ).

      • redshiftIdcApplicationArn

        public final String redshiftIdcApplicationArn()

        The Amazon resource name (ARN) of the Amazon Redshift IAM Identity Center application.

        Returns:
        The Amazon resource name (ARN) of the Amazon Redshift IAM Identity Center application.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object