Struct aws_sdk_dax::input::CreateClusterInput

#[non_exhaustive]
pub struct CreateClusterInput {

    pub cluster_name: Option<String>,
    pub node_type: Option<String>,
    pub description: Option<String>,
    pub replication_factor: i32,
    pub availability_zones: Option<Vec<String>>,
    pub subnet_group_name: Option<String>,
    pub security_group_ids: Option<Vec<String>>,
    pub preferred_maintenance_window: Option<String>,
    pub notification_topic_arn: Option<String>,
    pub iam_role_arn: Option<String>,
    pub parameter_group_name: Option<String>,
    pub tags: Option<Vec<Tag>>,
    pub sse_specification: Option<SseSpecification>,
    pub cluster_endpoint_encryption_type: Option<ClusterEndpointEncryptionType>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

cluster_name: Option<String>

The cluster identifier. This parameter is stored as a lowercase string.

Constraints:

• A name must contain from 1 to 20 alphanumeric characters or hyphens.

• The first character must be a letter.

• A name cannot end with a hyphen or contain two consecutive hyphens.

node_type: Option<String>

The compute and memory capacity of the nodes in the cluster.

description: Option<String>

A description of the cluster.

replication_factor: i32

The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set ReplicationFactor to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones parameter is provided, its length must equal the ReplicationFactor.

AWS recommends that you have at least two read replicas per cluster.

availability_zones: Option<Vec<String>>

The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated. If provided, the length of this list must equal the ReplicationFactor parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.

subnet_group_name: Option<String>

The name of the subnet group to be used for the replication group.

DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.

security_group_ids: Option<Vec<String>>

A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.)

If this parameter is not specified, DAX assigns the default VPC security group to each node.

preferred_maintenance_window: Option<String>

Specifies the weekly time range during which maintenance on the DAX cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:

• sun

• mon

• tue

• wed

• thu

• fri

• sat

Example: sun:05:00-sun:09:00

If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.

notification_topic_arn: Option<String>

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

The Amazon SNS topic owner must be same as the DAX cluster owner.

iam_role_arn: Option<String>

A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.

parameter_group_name: Option<String>

The parameter group to be associated with the DAX cluster.

tags: Option<Vec<Tag>>

A set of tags to associate with the DAX cluster.

sse_specification: Option<SseSpecification>

Represents the settings used to enable server-side encryption on the cluster.

cluster_endpoint_encryption_type: Option<ClusterEndpointEncryptionType>

The type of encryption the cluster's endpoint should support. Values are:

• NONE for no encryption

• TLS for Transport Layer Security

Implementations

impl CreateClusterInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<CreateCluster, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<CreateCluster>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CreateClusterInput

impl CreateClusterInput

pub fn cluster_name(&self) -> Option<&str>

The cluster identifier. This parameter is stored as a lowercase string.

Constraints:

• A name must contain from 1 to 20 alphanumeric characters or hyphens.

• The first character must be a letter.

• A name cannot end with a hyphen or contain two consecutive hyphens.

pub fn node_type(&self) -> Option<&str>

The compute and memory capacity of the nodes in the cluster.

pub fn description(&self) -> Option<&str>

A description of the cluster.

pub fn replication_factor(&self) -> i32

The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set ReplicationFactor to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones parameter is provided, its length must equal the ReplicationFactor.

AWS recommends that you have at least two read replicas per cluster.

pub fn availability_zones(&self) -> Option<&[String]>

The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated. If provided, the length of this list must equal the ReplicationFactor parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.

pub fn subnet_group_name(&self) -> Option<&str>

The name of the subnet group to be used for the replication group.

DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.

pub fn security_group_ids(&self) -> Option<&[String]>

A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.)

If this parameter is not specified, DAX assigns the default VPC security group to each node.

pub fn preferred_maintenance_window(&self) -> Option<&str>

Specifies the weekly time range during which maintenance on the DAX cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:

• sun

• mon

• tue

• wed

• thu

• fri

• sat

Example: sun:05:00-sun:09:00

If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.

pub fn notification_topic_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

The Amazon SNS topic owner must be same as the DAX cluster owner.

pub fn iam_role_arn(&self) -> Option<&str>

A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.

pub fn parameter_group_name(&self) -> Option<&str>

The parameter group to be associated with the DAX cluster.

pub fn tags(&self) -> Option<&[Tag]>

A set of tags to associate with the DAX cluster.

pub fn sse_specification(&self) -> Option<&SseSpecification>

Represents the settings used to enable server-side encryption on the cluster.

pub fn cluster_endpoint_encryption_type(
    &self
) -> Option<&ClusterEndpointEncryptionType>

The type of encryption the cluster's endpoint should support. Values are:

• NONE for no encryption

• TLS for Transport Layer Security

Trait Implementations

impl Clone for CreateClusterInput

fn clone(&self) -> CreateClusterInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateClusterInput

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

Formats the value using the given formatter.

impl PartialEq<CreateClusterInput> for CreateClusterInput

fn eq(&self, other: &CreateClusterInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CreateClusterInput) -> bool

This method tests for !=.

impl StructuralPartialEq for CreateClusterInput