Struct Client

pub struct Client { /* private fields */ }

Client for Amazon DynamoDB Accelerator (DAX)

Client for invoking operations on Amazon DynamoDB Accelerator (DAX). Each operation on Amazon DynamoDB Accelerator (DAX) is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_dax::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_dax::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the CreateCluster operation has a Client::create_cluster, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.create_cluster()
    .cluster_name("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn create_cluster(&self) -> CreateClusterFluentBuilder

Constructs a fluent builder for the CreateCluster operation.

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    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(impl Into<String>) / set_node_type(Option<String>):
    required: true
    

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

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the cluster.

    
    
  • replication_factor(i32) / set_replication_factor(Option<i32>):
    required: true
    

    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(impl Into<String>) / set_availability_zones(Option<Vec::<String>>):
    required: false
    

    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(impl Into<String>) / set_subnet_group_name(Option<String>):
    required: false
    

    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(impl Into<String>) / set_security_group_ids(Option<Vec::<String>>):
    required: false
    

    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(impl Into<String>) / set_preferred_maintenance_window(Option<String>):
    required: false
    

    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(impl Into<String>) / set_notification_topic_arn(Option<String>):
    required: false
    

    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(impl Into<String>) / set_iam_role_arn(Option<String>):
    required: true
    

    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(impl Into<String>) / set_parameter_group_name(Option<String>):
    required: false
    

    The parameter group to be associated with the DAX cluster.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A set of tags to associate with the DAX cluster.

    
    
  • sse_specification(SseSpecification) / set_sse_specification(Option<SseSpecification>):
    required: false
    

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

    
    
  • cluster_endpoint_encryption_type(ClusterEndpointEncryptionType) / set_cluster_endpoint_encryption_type(Option<ClusterEndpointEncryptionType>):
    required: false
    

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

    • NONE for no encryption

    • TLS for Transport Layer Security

    
    
• On success, responds with CreateClusterOutput with field(s):
  • cluster(Option<Cluster>):

    A description of the DAX cluster that you have created.

• On failure, responds with SdkError<CreateClusterError>

impl Client

pub fn create_parameter_group(&self) -> CreateParameterGroupFluentBuilder

Constructs a fluent builder for the CreateParameterGroup operation.

• The fluent builder is configurable:
  • parameter_group_name(impl Into<String>) / set_parameter_group_name(Option<String>):
    required: true
    

    The name of the parameter group to apply to all of the clusters in this replication group.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the parameter group.

    
    
• On success, responds with CreateParameterGroupOutput with field(s):
  • parameter_group(Option<ParameterGroup>):

    Represents the output of a CreateParameterGroup action.

• On failure, responds with SdkError<CreateParameterGroupError>

impl Client

pub fn create_subnet_group(&self) -> CreateSubnetGroupFluentBuilder

Constructs a fluent builder for the CreateSubnetGroup operation.

• The fluent builder is configurable:
  • subnet_group_name(impl Into<String>) / set_subnet_group_name(Option<String>):
    required: true
    

    A name for the subnet group. This value is stored as a lowercase string.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description for the subnet group

    
    
  • subnet_ids(impl Into<String>) / set_subnet_ids(Option<Vec::<String>>):
    required: true
    

    A list of VPC subnet IDs for the subnet group.

    
    
• On success, responds with CreateSubnetGroupOutput with field(s):
  • subnet_group(Option<SubnetGroup>):

    Represents the output of a CreateSubnetGroup operation.

• On failure, responds with SdkError<CreateSubnetGroupError>

impl Client

pub fn decrease_replication_factor( &self, ) -> DecreaseReplicationFactorFluentBuilder

Constructs a fluent builder for the DecreaseReplicationFactor operation.

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    The name of the DAX cluster from which you want to remove nodes.

    
    
  • new_replication_factor(i32) / set_new_replication_factor(Option<i32>):
    required: true
    

    The new number of nodes for the DAX cluster.

    
    
  • availability_zones(impl Into<String>) / set_availability_zones(Option<Vec::<String>>):
    required: false
    

    The Availability Zone(s) from which to remove nodes.

    
    
  • node_ids_to_remove(impl Into<String>) / set_node_ids_to_remove(Option<Vec::<String>>):
    required: false
    

    The unique identifiers of the nodes to be removed from the cluster.

    
    
• On success, responds with DecreaseReplicationFactorOutput with field(s):
  • cluster(Option<Cluster>):

    A description of the DAX cluster, after you have decreased its replication factor.

• On failure, responds with SdkError<DecreaseReplicationFactorError>

impl Client

pub fn delete_cluster(&self) -> DeleteClusterFluentBuilder

Constructs a fluent builder for the DeleteCluster operation.

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    The name of the cluster to be deleted.

    
    
• On success, responds with DeleteClusterOutput with field(s):
  • cluster(Option<Cluster>):

    A description of the DAX cluster that is being deleted.

• On failure, responds with SdkError<DeleteClusterError>

impl Client

pub fn delete_parameter_group(&self) -> DeleteParameterGroupFluentBuilder

Constructs a fluent builder for the DeleteParameterGroup operation.

• The fluent builder is configurable:
  • parameter_group_name(impl Into<String>) / set_parameter_group_name(Option<String>):
    required: true
    

    The name of the parameter group to delete.

    
    
• On success, responds with DeleteParameterGroupOutput with field(s):
  • deletion_message(Option<String>):

    A user-specified message for this action (i.e., a reason for deleting the parameter group).

• On failure, responds with SdkError<DeleteParameterGroupError>

impl Client

pub fn delete_subnet_group(&self) -> DeleteSubnetGroupFluentBuilder

Constructs a fluent builder for the DeleteSubnetGroup operation.

• The fluent builder is configurable:
  • subnet_group_name(impl Into<String>) / set_subnet_group_name(Option<String>):
    required: true
    

    The name of the subnet group to delete.

    
    
• On success, responds with DeleteSubnetGroupOutput with field(s):
  • deletion_message(Option<String>):

    A user-specified message for this action (i.e., a reason for deleting the subnet group).

• On failure, responds with SdkError<DeleteSubnetGroupError>

impl Client

pub fn describe_clusters(&self) -> DescribeClustersFluentBuilder

Constructs a fluent builder for the DescribeClusters operation.

• The fluent builder is configurable:
  • cluster_names(impl Into<String>) / set_cluster_names(Option<Vec::<String>>):
    required: false
    

    The names of the DAX clusters being described.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    The value for MaxResults must be between 20 and 100.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

    
    
• On success, responds with DescribeClustersOutput with field(s):
  • next_token(Option<String>):

    Provides an identifier to allow retrieval of paginated results.

  • clusters(Option<Vec::<Cluster>>):

    The descriptions of your DAX clusters, in response to a DescribeClusters request.

• On failure, responds with SdkError<DescribeClustersError>

impl Client

pub fn describe_default_parameters( &self, ) -> DescribeDefaultParametersFluentBuilder

Constructs a fluent builder for the DescribeDefaultParameters operation.

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    The value for MaxResults must be between 20 and 100.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

    
    
• On success, responds with DescribeDefaultParametersOutput with field(s):
  • next_token(Option<String>):

    Provides an identifier to allow retrieval of paginated results.

  • parameters(Option<Vec::<Parameter>>):

    A list of parameters. Each element in the list represents one parameter.

• On failure, responds with SdkError<DescribeDefaultParametersError>

impl Client

pub fn describe_events(&self) -> DescribeEventsFluentBuilder

Constructs a fluent builder for the DescribeEvents operation.

• The fluent builder is configurable:
  • source_name(impl Into<String>) / set_source_name(Option<String>):
    required: false
    

    The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

    
    
  • source_type(SourceType) / set_source_type(Option<SourceType>):
    required: false
    

    The event source to retrieve events for. If no value is specified, all events are returned.

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: false
    

    The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: false
    

    The end of the time interval for which to retrieve events, specified in ISO 8601 format.

    
    
  • duration(i32) / set_duration(Option<i32>):
    required: false
    

    The number of minutes’ worth of events to retrieve.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    The value for MaxResults must be between 20 and 100.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

    
    
• On success, responds with DescribeEventsOutput with field(s):
  • next_token(Option<String>):

    Provides an identifier to allow retrieval of paginated results.

  • events(Option<Vec::<Event>>):

    An array of events. Each element in the array represents one event.

• On failure, responds with SdkError<DescribeEventsError>

impl Client

pub fn describe_parameter_groups(&self) -> DescribeParameterGroupsFluentBuilder

Constructs a fluent builder for the DescribeParameterGroups operation.

• The fluent builder is configurable:
  • parameter_group_names(impl Into<String>) / set_parameter_group_names(Option<Vec::<String>>):
    required: false
    

    The names of the parameter groups.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    The value for MaxResults must be between 20 and 100.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

    
    
• On success, responds with DescribeParameterGroupsOutput with field(s):
  • next_token(Option<String>):

    Provides an identifier to allow retrieval of paginated results.

  • parameter_groups(Option<Vec::<ParameterGroup>>):

    An array of parameter groups. Each element in the array represents one parameter group.

• On failure, responds with SdkError<DescribeParameterGroupsError>

impl Client

pub fn describe_parameters(&self) -> DescribeParametersFluentBuilder

Constructs a fluent builder for the DescribeParameters operation.

• The fluent builder is configurable:
  • parameter_group_name(impl Into<String>) / set_parameter_group_name(Option<String>):
    required: true
    

    The name of the parameter group.

    
    
  • source(impl Into<String>) / set_source(Option<String>):
    required: false
    

    How the parameter is defined. For example, system denotes a system-defined parameter.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    The value for MaxResults must be between 20 and 100.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

    
    
• On success, responds with DescribeParametersOutput with field(s):
  • next_token(Option<String>):

    Provides an identifier to allow retrieval of paginated results.

  • parameters(Option<Vec::<Parameter>>):

    A list of parameters within a parameter group. Each element in the list represents one parameter.

• On failure, responds with SdkError<DescribeParametersError>

impl Client

pub fn describe_subnet_groups(&self) -> DescribeSubnetGroupsFluentBuilder

Constructs a fluent builder for the DescribeSubnetGroups operation.

• The fluent builder is configurable:
  • subnet_group_names(impl Into<String>) / set_subnet_group_names(Option<Vec::<String>>):
    required: false
    

    The name of the subnet group.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    The value for MaxResults must be between 20 and 100.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

    
    
• On success, responds with DescribeSubnetGroupsOutput with field(s):
  • next_token(Option<String>):

    Provides an identifier to allow retrieval of paginated results.

  • subnet_groups(Option<Vec::<SubnetGroup>>):

    An array of subnet groups. Each element in the array represents a single subnet group.

• On failure, responds with SdkError<DescribeSubnetGroupsError>

impl Client

pub fn increase_replication_factor( &self, ) -> IncreaseReplicationFactorFluentBuilder

Constructs a fluent builder for the IncreaseReplicationFactor operation.

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    The name of the DAX cluster that will receive additional nodes.

    
    
  • new_replication_factor(i32) / set_new_replication_factor(Option<i32>):
    required: true
    

    The new number of nodes for the DAX cluster.

    
    
  • availability_zones(impl Into<String>) / set_availability_zones(Option<Vec::<String>>):
    required: false
    

    The Availability Zones (AZs) in which the cluster nodes will be created. All nodes belonging to the cluster are placed in these Availability Zones. Use this parameter if you want to distribute the nodes across multiple AZs.

    
    
• On success, responds with IncreaseReplicationFactorOutput with field(s):
  • cluster(Option<Cluster>):

    A description of the DAX cluster. with its new replication factor.

• On failure, responds with SdkError<IncreaseReplicationFactorError>

impl Client

pub fn list_tags(&self) -> ListTagsFluentBuilder

Constructs a fluent builder for the ListTags operation.

• The fluent builder is configurable:
  • resource_name(impl Into<String>) / set_resource_name(Option<String>):
    required: true
    

    The name of the DAX resource to which the tags belong.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token.

    
    
• On success, responds with ListTagsOutput with field(s):
  • tags(Option<Vec::<Tag>>):

    A list of tags currently associated with the DAX cluster.

  • next_token(Option<String>):

    If this value is present, there are additional results to be displayed. To retrieve them, call ListTags again, with NextToken set to this value.

• On failure, responds with SdkError<ListTagsError>

impl Client

pub fn reboot_node(&self) -> RebootNodeFluentBuilder

Constructs a fluent builder for the RebootNode operation.

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    The name of the DAX cluster containing the node to be rebooted.

    
    
  • node_id(impl Into<String>) / set_node_id(Option<String>):
    required: true
    

    The system-assigned ID of the node to be rebooted.

    
    
• On success, responds with RebootNodeOutput with field(s):
  • cluster(Option<Cluster>):

    A description of the DAX cluster after a node has been rebooted.

• On failure, responds with SdkError<RebootNodeError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_name(impl Into<String>) / set_resource_name(Option<String>):
    required: true
    

    The name of the DAX resource to which tags should be added.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    The tags to be assigned to the DAX resource.

    
    
• On success, responds with TagResourceOutput with field(s):
  • tags(Option<Vec::<Tag>>):

    The list of tags that are associated with the DAX resource.

• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_name(impl Into<String>) / set_resource_name(Option<String>):
    required: true
    

    The name of the DAX resource from which the tags should be removed.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    A list of tag keys. If the DAX cluster has any tags with these keys, then the tags are removed from the cluster.

    
    
• On success, responds with UntagResourceOutput with field(s):
  • tags(Option<Vec::<Tag>>):

    The tag keys that have been removed from the cluster.

• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_cluster(&self) -> UpdateClusterFluentBuilder

Constructs a fluent builder for the UpdateCluster operation.

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    The name of the DAX cluster to be modified.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the changes being made to the cluster.

    
    
  • preferred_maintenance_window(impl Into<String>) / set_preferred_maintenance_window(Option<String>):
    required: false
    

    A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.

    
    
  • notification_topic_arn(impl Into<String>) / set_notification_topic_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) that identifies the topic.

    
    
  • notification_topic_status(impl Into<String>) / set_notification_topic_status(Option<String>):
    required: false
    

    The current state of the topic. A value of “active” means that notifications will be sent to the topic. A value of “inactive” means that notifications will not be sent to the topic.

    
    
  • parameter_group_name(impl Into<String>) / set_parameter_group_name(Option<String>):
    required: false
    

    The name of a parameter group for this cluster.

    
    
  • security_group_ids(impl Into<String>) / set_security_group_ids(Option<Vec::<String>>):
    required: false
    

    A list of user-specified security group IDs to be assigned to each node in the DAX cluster. If this parameter is not specified, DAX assigns the default VPC security group to each node.

    
    
• On success, responds with UpdateClusterOutput with field(s):
  • cluster(Option<Cluster>):

    A description of the DAX cluster, after it has been modified.

• On failure, responds with SdkError<UpdateClusterError>

impl Client

pub fn update_parameter_group(&self) -> UpdateParameterGroupFluentBuilder

Constructs a fluent builder for the UpdateParameterGroup operation.

• The fluent builder is configurable:
  • parameter_group_name(impl Into<String>) / set_parameter_group_name(Option<String>):
    required: true
    

    The name of the parameter group.

    
    
  • parameter_name_values(ParameterNameValue) / set_parameter_name_values(Option<Vec::<ParameterNameValue>>):
    required: true
    

    An array of name-value pairs for the parameters in the group. Each element in the array represents a single parameter.

    record-ttl-millis and query-ttl-millis are the only supported parameter names. For more details, see Configuring TTL Settings.

    
    
• On success, responds with UpdateParameterGroupOutput with field(s):
  • parameter_group(Option<ParameterGroup>):

    The parameter group that has been modified.

• On failure, responds with SdkError<UpdateParameterGroupError>

impl Client

pub fn update_subnet_group(&self) -> UpdateSubnetGroupFluentBuilder

Constructs a fluent builder for the UpdateSubnetGroup operation.

• The fluent builder is configurable:
  • subnet_group_name(impl Into<String>) / set_subnet_group_name(Option<String>):
    required: true
    

    The name of the subnet group.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the subnet group.

    
    
  • subnet_ids(impl Into<String>) / set_subnet_ids(Option<Vec::<String>>):
    required: false
    

    A list of subnet IDs in the subnet group.

    
    
• On success, responds with UpdateSubnetGroupOutput with field(s):
  • subnet_group(Option<SubnetGroup>):

    The subnet group that has been modified.

• On failure, responds with SdkError<UpdateSubnetGroupError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.