redshift/aws.sdk.kotlin.services.redshift.model/CreateClusterRequest/Builder

Builder

class Builder

Properties

additionalInfo

var additionalInfo: String?

Reserved.

allowVersionUpgrade

var allowVersionUpgrade: Boolean?

If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

aquaConfigurationStatus

var 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).

automatedSnapshotRetentionPeriod

var automatedSnapshotRetentionPeriod: Int?

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.

availabilityZone

var availabilityZone: String?

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.

availabilityZoneRelocation

var availabilityZoneRelocation: Boolean?

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

clusterIdentifier

var clusterIdentifier: String?

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.

clusterParameterGroupName

var clusterParameterGroupName: String?

The name of the parameter group to be associated with this cluster.

clusterSecurityGroups

var clusterSecurityGroups: List<String>?

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

clusterSubnetGroupName

var clusterSubnetGroupName: String?

The name of a cluster subnet group to be associated with this cluster.

clusterType

var clusterType: String?

The type of the cluster. When cluster type is specified as

clusterVersion

var clusterVersion: String?

The version of the Amazon Redshift engine software that you want to deploy on the cluster.

dbName

var dbName: String?

The name of the first database to be created when the cluster is created.

defaultIamRoleArn

var defaultIamRoleArn: String?

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

elasticIp

var elasticIp: String?

The Elastic IP (EIP) address for the cluster.

encrypted

var encrypted: Boolean?

If true, the data in the cluster is encrypted at rest. If you set the value on this parameter to false, the request will fail.

enhancedVpcRouting

var enhancedVpcRouting: Boolean?

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.

hsmClientCertificateIdentifier

var hsmClientCertificateIdentifier: String?

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

hsmConfigurationIdentifier

var hsmConfigurationIdentifier: String?

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.

iamRoles

var iamRoles: List<String>?

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.

ipAddressType

var ipAddressType: String?

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

kmsKeyId

var kmsKeyId: String?

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

loadSampleData

var loadSampleData: String?

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

maintenanceTrackName

var maintenanceTrackName: String?

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.

manageMasterPassword

var manageMasterPassword: Boolean?

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.

manualSnapshotRetentionPeriod

var manualSnapshotRetentionPeriod: Int?

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.

masterPasswordSecretKmsKeyId

var masterPasswordSecretKmsKeyId: String?

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.

masterUsername

var masterUsername: String?

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

masterUserPassword

var masterUserPassword: String?

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

multiAz

var multiAz: Boolean?

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

nodeType

var nodeType: String?

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.

numberOfNodes

var numberOfNodes: Int?

The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.

port

var port: Int?

The port number on which the cluster accepts incoming connections.

preferredMaintenanceWindow

var preferredMaintenanceWindow: String?

The weekly time range (in UTC) during which automated cluster maintenance can occur.

publiclyAccessible

var publiclyAccessible: Boolean?

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