Struct aws_sdk_redshift::client::fluent_builders::CreateCluster

pub struct CreateCluster { /* private fields */ }

Fluent builder constructing a request to CreateCluster.

Creates a new cluster with the specified parameters.

To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

Implementations

impl CreateCluster

pub async fn send(
    self
) -> Result<CreateClusterOutput, SdkError<CreateClusterError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn db_name(self, input: impl Into<String>) -> Self

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.

pub fn set_db_name(self, input: Option<String>) -> Self

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.

pub fn cluster_identifier(self, input: impl Into<String>) -> Self

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

pub fn set_cluster_identifier(self, input: Option<String>) -> Self

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

pub fn cluster_type(self, input: impl Into<String>) -> Self

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

pub fn set_cluster_type(self, input: Option<String>) -> Self

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

pub fn node_type(self, input: impl Into<String>) -> Self

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

pub fn set_node_type(self, input: Option<String>) -> Self

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

pub fn master_username(self, input: impl Into<String>) -> Self

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

Constraints:

• Must be 1 - 128 alphanumeric characters. The user name can't be PUBLIC.

• First character must be a letter.

• Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

pub fn set_master_username(self, input: Option<String>) -> Self

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

Constraints:

• Must be 1 - 128 alphanumeric characters. The user name can't be PUBLIC.

• First character must be a letter.

• Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

pub fn master_user_password(self, input: impl Into<String>) -> Self

The password associated with the admin user account 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 @.

pub fn set_master_user_password(self, input: Option<String>) -> Self

The password associated with the admin user account 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 @.

pub fn cluster_security_groups(self, input: impl Into<String>) -> Self

Appends an item to ClusterSecurityGroups.

To override the contents of this collection use set_cluster_security_groups.

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

Default: The default cluster security group for Amazon Redshift.

pub fn set_cluster_security_groups(self, input: Option<Vec<String>>) -> Self

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

Default: The default cluster security group for Amazon Redshift.

pub fn vpc_security_group_ids(self, input: impl Into<String>) -> Self

Appends an item to VpcSecurityGroupIds.

To override the contents of this collection use set_vpc_security_group_ids.

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.

pub fn set_vpc_security_group_ids(self, input: Option<Vec<String>>) -> Self

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.

pub fn cluster_subnet_group_name(self, input: impl Into<String>) -> Self

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

pub fn set_cluster_subnet_group_name(self, input: Option<String>) -> Self

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

pub fn availability_zone(self, input: impl Into<String>) -> Self

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.

pub fn set_availability_zone(self, input: Option<String>) -> Self

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.

pub fn preferred_maintenance_window(self, input: impl Into<String>) -> Self

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.

pub fn set_preferred_maintenance_window(self, input: Option<String>) -> Self

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.

pub fn cluster_parameter_group_name(self, input: impl Into<String>) -> Self

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.

pub fn set_cluster_parameter_group_name(self, input: Option<String>) -> Self

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.

pub fn automated_snapshot_retention_period(self, input: i32) -> Self

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.

pub fn set_automated_snapshot_retention_period(self, input: Option<i32>) -> Self

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.

pub fn manual_snapshot_retention_period(self, input: i32) -> Self

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.

pub fn set_manual_snapshot_retention_period(self, input: Option<i32>) -> Self

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.

pub fn port(self, input: i32) -> Self

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

pub fn set_port(self, input: Option<i32>) -> Self

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

pub fn cluster_version(self, input: impl Into<String>) -> Self

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

pub fn set_cluster_version(self, input: Option<String>) -> Self

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

pub fn allow_version_upgrade(self, input: bool) -> Self

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

pub fn set_allow_version_upgrade(self, input: Option<bool>) -> Self

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

pub fn number_of_nodes(self, input: i32) -> Self

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.

pub fn set_number_of_nodes(self, input: Option<i32>) -> Self

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.

pub fn publicly_accessible(self, input: bool) -> Self

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

pub fn set_publicly_accessible(self, input: Option<bool>) -> Self

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

pub fn encrypted(self, input: bool) -> Self

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

Default: false

pub fn set_encrypted(self, input: Option<bool>) -> Self

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

Default: false

pub fn hsm_client_certificate_identifier(self, input: impl Into<String>) -> Self

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

pub fn set_hsm_client_certificate_identifier(
    self,
    input: Option<String>
) -> Self

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

pub fn hsm_configuration_identifier(self, input: impl Into<String>) -> Self

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.

pub fn set_hsm_configuration_identifier(self, input: Option<String>) -> Self

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.

pub fn elastic_ip(self, input: impl Into<String>) -> Self

The Elastic IP (EIP) address for the cluster.

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

pub fn set_elastic_ip(self, input: Option<String>) -> Self

The Elastic IP (EIP) address for the cluster.

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

pub fn tags(self, input: Tag) -> Self

Appends an item to Tags.

To override the contents of this collection use set_tags.

A list of tag instances.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

A list of tag instances.

pub fn kms_key_id(self, input: impl Into<String>) -> Self

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

pub fn set_kms_key_id(self, input: Option<String>) -> Self

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

pub fn enhanced_vpc_routing(self, input: bool) -> Self

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

pub fn set_enhanced_vpc_routing(self, input: Option<bool>) -> Self

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

pub fn additional_info(self, input: impl Into<String>) -> Self

Reserved.

pub fn set_additional_info(self, input: Option<String>) -> Self

Reserved.

pub fn iam_roles(self, input: impl Into<String>) -> Self

Appends an item to IamRoles.

To override the contents of this collection use set_iam_roles.

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.

pub fn set_iam_roles(self, input: Option<Vec<String>>) -> Self

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.

pub fn maintenance_track_name(self, input: impl Into<String>) -> Self

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.

pub fn set_maintenance_track_name(self, input: Option<String>) -> Self

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.

pub fn snapshot_schedule_identifier(self, input: impl Into<String>) -> Self

A unique identifier for the snapshot schedule.

pub fn set_snapshot_schedule_identifier(self, input: Option<String>) -> Self

A unique identifier for the snapshot schedule.

pub fn availability_zone_relocation(self, input: bool) -> Self

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

pub fn set_availability_zone_relocation(self, input: Option<bool>) -> Self

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

pub fn aqua_configuration_status(self, input: AquaConfigurationStatus) -> Self

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) when it is created. Possible values include the following.

• enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.

• disabled - Don't use AQUA.

• auto - Amazon Redshift determines whether to use AQUA.

pub fn set_aqua_configuration_status(
    self,
    input: Option<AquaConfigurationStatus>
) -> Self

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) when it is created. Possible values include the following.

• enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.

• disabled - Don't use AQUA.

• auto - Amazon Redshift determines whether to use AQUA.

pub fn default_iam_role_arn(self, input: impl Into<String>) -> Self

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

pub fn set_default_iam_role_arn(self, input: Option<String>) -> Self

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

pub fn load_sample_data(self, input: impl Into<String>) -> Self

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

pub fn set_load_sample_data(self, input: Option<String>) -> Self

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

Trait Implementations

impl Clone for CreateCluster

fn clone(&self) -> CreateCluster

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateCluster

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.