aws_sdk_memorydb/client/

create_cluster.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateCluster`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`cluster_name(impl Into<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::cluster_name) / [`set_cluster_name(Option<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::set_cluster_name):<br>required: **true**<br><p>The name of the cluster. This value must be unique as it also serves as the cluster identifier.</p><br>
    ///   - [`node_type(impl Into<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::node_type) / [`set_node_type(Option<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::set_node_type):<br>required: **true**<br><p>The compute and memory capacity of the nodes in the cluster.</p><br>
    ///   - [`multi_region_cluster_name(impl Into<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::multi_region_cluster_name) / [`set_multi_region_cluster_name(Option<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::set_multi_region_cluster_name):<br>required: **false**<br><p>The name of the multi-Region cluster to be created.</p><br>
    ///   - [`parameter_group_name(impl Into<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::parameter_group_name) / [`set_parameter_group_name(Option<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::set_parameter_group_name):<br>required: **false**<br><p>The name of the parameter group associated with the cluster.</p><br>
    ///   - [`description(impl Into<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::set_description):<br>required: **false**<br><p>An optional description of the cluster.</p><br>
    ///   - [`num_shards(i32)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::num_shards) / [`set_num_shards(Option<i32>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::set_num_shards):<br>required: **false**<br><p>The number of shards the cluster will contain. The default value is 1.</p><br>
    ///   - [`num_replicas_per_shard(i32)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::num_replicas_per_shard) / [`set_num_replicas_per_shard(Option<i32>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::set_num_replicas_per_shard):<br>required: **false**<br><p>The number of replicas to apply to each shard. The default value is 1. The maximum is 5.</p><br>
    ///   - [`subnet_group_name(impl Into<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::subnet_group_name) / [`set_subnet_group_name(Option<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::set_subnet_group_name):<br>required: **false**<br><p>The name of the subnet group to be used for the cluster.</p><br>
    ///   - [`security_group_ids(impl Into<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::security_group_ids) / [`set_security_group_ids(Option<Vec::<String>>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::set_security_group_ids):<br>required: **false**<br><p>A list of security group names to associate with this cluster.</p><br>
    ///   - [`maintenance_window(impl Into<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::maintenance_window) / [`set_maintenance_window(Option<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::set_maintenance_window):<br>required: **false**<br><p>Specifies the weekly time range during which maintenance on the 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.</p> <p>Valid values for <code>ddd</code> are:</p> <ul>  <li>   <p><code>sun</code></p></li>  <li>   <p><code>mon</code></p></li>  <li>   <p><code>tue</code></p></li>  <li>   <p><code>wed</code></p></li>  <li>   <p><code>thu</code></p></li>  <li>   <p><code>fri</code></p></li>  <li>   <p><code>sat</code></p></li> </ul> <p>Example: <code>sun:23:00-mon:01:30</code></p><br>
    ///   - [`port(i32)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::port) / [`set_port(Option<i32>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::set_port):<br>required: **false**<br><p>The port number on which each of the nodes accepts connections.</p><br>
    ///   - [`sns_topic_arn(impl Into<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::sns_topic_arn) / [`set_sns_topic_arn(Option<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::set_sns_topic_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.</p><br>
    ///   - [`tls_enabled(bool)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::tls_enabled) / [`set_tls_enabled(Option<bool>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::set_tls_enabled):<br>required: **false**<br><p>A flag to enable in-transit encryption on the cluster.</p><br>
    ///   - [`kms_key_id(impl Into<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::kms_key_id) / [`set_kms_key_id(Option<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::set_kms_key_id):<br>required: **false**<br><p>The ID of the KMS key used to encrypt the cluster.</p><br>
    ///   - [`snapshot_arns(impl Into<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::snapshot_arns) / [`set_snapshot_arns(Option<Vec::<String>>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::set_snapshot_arns):<br>required: **false**<br><p>A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.</p><br>
    ///   - [`snapshot_name(impl Into<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::snapshot_name) / [`set_snapshot_name(Option<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::set_snapshot_name):<br>required: **false**<br><p>The name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created.</p><br>
    ///   - [`snapshot_retention_limit(i32)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::snapshot_retention_limit) / [`set_snapshot_retention_limit(Option<i32>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::set_snapshot_retention_limit):<br>required: **false**<br><p>The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.</p><br>
    ///   - [`tags(Tag)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::set_tags):<br>required: **false**<br><p>A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.</p><br>
    ///   - [`snapshot_window(impl Into<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::snapshot_window) / [`set_snapshot_window(Option<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::set_snapshot_window):<br>required: **false**<br><p>The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.</p> <p>Example: 05:00-09:00</p> <p>If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.</p><br>
    ///   - [`acl_name(impl Into<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::acl_name) / [`set_acl_name(Option<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::set_acl_name):<br>required: **true**<br><p>The name of the Access Control List to associate with the cluster.</p><br>
    ///   - [`engine(impl Into<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::engine) / [`set_engine(Option<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::set_engine):<br>required: **false**<br><p>The name of the engine to be used for the cluster.</p><br>
    ///   - [`engine_version(impl Into<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::engine_version) / [`set_engine_version(Option<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::set_engine_version):<br>required: **false**<br><p>The version number of the Redis OSS engine to be used for the cluster.</p><br>
    ///   - [`auto_minor_version_upgrade(bool)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::auto_minor_version_upgrade) / [`set_auto_minor_version_upgrade(Option<bool>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::set_auto_minor_version_upgrade):<br>required: **false**<br><p>When set to true, the cluster will automatically receive minor engine version upgrades after launch.</p><br>
    ///   - [`data_tiering(bool)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::data_tiering) / [`set_data_tiering(Option<bool>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::set_data_tiering):<br>required: **false**<br><p>Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see <a href="https://docs.aws.amazon.com/memorydb/latest/devguide/data-tiering.html">Data tiering</a>.</p><br>
    ///   - [`network_type(NetworkType)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::network_type) / [`set_network_type(Option<NetworkType>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::set_network_type):<br>required: **false**<br><p>Specifies the IP address type for the cluster. Valid values are 'ipv4', 'ipv6', or 'dual_stack'. When set to 'ipv4', the cluster will only be accessible via IPv4 addresses. When set to 'ipv6', the cluster will only be accessible via IPv6 addresses. When set to 'dual_stack', the cluster will be accessible via both IPv4 and IPv6 addresses. If not specified, the default is 'ipv4'.</p><br>
    ///   - [`ip_discovery(IpDiscovery)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::ip_discovery) / [`set_ip_discovery(Option<IpDiscovery>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::set_ip_discovery):<br>required: **false**<br><p>The mechanism for discovering IP addresses for the cluster discovery protocol. Valid values are 'ipv4' or 'ipv6'. When set to 'ipv4', cluster discovery functions such as cluster slots, cluster shards, and cluster nodes return IPv4 addresses for cluster nodes. When set to 'ipv6', the cluster discovery functions return IPv6 addresses for cluster nodes. The value must be compatible with the NetworkType parameter. If not specified, the default is 'ipv4'.</p><br>
    /// - On success, responds with [`CreateClusterOutput`](crate::operation::create_cluster::CreateClusterOutput) with field(s):
    ///   - [`cluster(Option<Cluster>)`](crate::operation::create_cluster::CreateClusterOutput::cluster): <p>The newly-created cluster.</p>
    /// - On failure, responds with [`SdkError<CreateClusterError>`](crate::operation::create_cluster::CreateClusterError)
    pub fn create_cluster(&self) -> crate::operation::create_cluster::builders::CreateClusterFluentBuilder {
        crate::operation::create_cluster::builders::CreateClusterFluentBuilder::new(self.handle.clone())
    }
}