Struct aws_sdk_elasticloadbalancingv2::client::Client
source · [−]pub struct Client { /* private fields */ }
Expand description
Client for Elastic Load Balancing
Client for invoking operations on Elastic Load Balancing. Each operation on Elastic Load Balancing is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_elasticloadbalancingv2::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_elasticloadbalancingv2::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_elasticloadbalancingv2::Client::from_conf(config);
Implementations
sourceimpl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
sourceimpl Client
impl Client
sourcepub fn add_listener_certificates(&self) -> AddListenerCertificates
pub fn add_listener_certificates(&self) -> AddListenerCertificates
Constructs a fluent builder for the AddListenerCertificates
operation.
- The fluent builder is configurable:
listener_arn(impl Into<String>)
/set_listener_arn(Option<String>)
:The Amazon Resource Name (ARN) of the listener.
certificates(Vec<Certificate>)
/set_certificates(Option<Vec<Certificate>>)
:The certificate to add. You can specify one certificate per call. Set
CertificateArn
to the certificate ARN but do not setIsDefault
.
- On success, responds with
AddListenerCertificatesOutput
with field(s):certificates(Option<Vec<Certificate>>)
:Information about the certificates in the certificate list.
- On failure, responds with
SdkError<AddListenerCertificatesError>
Constructs a fluent builder for the AddTags
operation.
- The fluent builder is configurable:
resource_arns(Vec<String>)
/set_resource_arns(Option<Vec<String>>)
:The Amazon Resource Name (ARN) of the resource.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tags.
- On success, responds with
AddTagsOutput
- On failure, responds with
SdkError<AddTagsError>
sourcepub fn create_listener(&self) -> CreateListener
pub fn create_listener(&self) -> CreateListener
Constructs a fluent builder for the CreateListener
operation.
- The fluent builder is configurable:
load_balancer_arn(impl Into<String>)
/set_load_balancer_arn(Option<String>)
:The Amazon Resource Name (ARN) of the load balancer.
protocol(ProtocolEnum)
/set_protocol(Option<ProtocolEnum>)
:The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. You can’t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You cannot specify a protocol for a Gateway Load Balancer.
port(i32)
/set_port(Option<i32>)
:The port on which the load balancer is listening. You cannot specify a port for a Gateway Load Balancer.
ssl_policy(impl Into<String>)
/set_ssl_policy(Option<String>)
:[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported.
For more information, see Security policies in the Application Load Balancers Guide and Security policies in the Network Load Balancers Guide.
certificates(Vec<Certificate>)
/set_certificates(Option<Vec<Certificate>>)
:[HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one certificate. Set
CertificateArn
to the certificate ARN but do not setIsDefault
.default_actions(Vec<Action>)
/set_default_actions(Option<Vec<Action>>)
:The actions for the default rule.
alpn_policy(Vec<String>)
/set_alpn_policy(Option<Vec<String>>)
:[TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy. You can specify one policy name. The following are the possible values:
-
HTTP1Only
-
HTTP2Only
-
HTTP2Optional
-
HTTP2Preferred
-
None
For more information, see ALPN policies in the Network Load Balancers Guide.
-
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tags to assign to the listener.
- On success, responds with
CreateListenerOutput
with field(s):listeners(Option<Vec<Listener>>)
:Information about the listener.
- On failure, responds with
SdkError<CreateListenerError>
sourcepub fn create_load_balancer(&self) -> CreateLoadBalancer
pub fn create_load_balancer(&self) -> CreateLoadBalancer
Constructs a fluent builder for the CreateLoadBalancer
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the load balancer.
This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with “internal-”.
subnets(Vec<String>)
/set_subnets(Option<Vec<String>>)
:The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.
[Application Load Balancers] You must specify subnets from at least two Availability Zones.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers] You can specify subnets from one or more Availability Zones.
[Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
subnet_mappings(Vec<SubnetMapping>)
/set_subnet_mappings(Option<Vec<SubnetMapping>>)
:The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.
[Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.
[Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP addresses for your subnets.
security_groups(Vec<String>)
/set_security_groups(Option<Vec<String>>)
:[Application Load Balancers] The IDs of the security groups for the load balancer.
scheme(LoadBalancerSchemeEnum)
/set_scheme(Option<LoadBalancerSchemeEnum>)
:The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.
The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.
The default is an Internet-facing load balancer.
You cannot specify a scheme for a Gateway Load Balancer.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tags to assign to the load balancer.
r#type(LoadBalancerTypeEnum)
/set_type(Option<LoadBalancerTypeEnum>)
:The type of load balancer. The default is
application
.ip_address_type(IpAddressType)
/set_ip_address_type(Option<IpAddressType>)
:The type of IP addresses used by the subnets for your load balancer. The possible values are
ipv4
(for IPv4 addresses) anddualstack
(for IPv4 and IPv6 addresses).customer_owned_ipv4_pool(impl Into<String>)
/set_customer_owned_ipv4_pool(Option<String>)
:[Application Load Balancers on Outposts] The ID of the customer-owned address pool (CoIP pool).
- On success, responds with
CreateLoadBalancerOutput
with field(s):load_balancers(Option<Vec<LoadBalancer>>)
:Information about the load balancer.
- On failure, responds with
SdkError<CreateLoadBalancerError>
sourcepub fn create_rule(&self) -> CreateRule
pub fn create_rule(&self) -> CreateRule
Constructs a fluent builder for the CreateRule
operation.
- The fluent builder is configurable:
listener_arn(impl Into<String>)
/set_listener_arn(Option<String>)
:The Amazon Resource Name (ARN) of the listener.
conditions(Vec<RuleCondition>)
/set_conditions(Option<Vec<RuleCondition>>)
:The conditions.
priority(i32)
/set_priority(Option<i32>)
:The rule priority. A listener can’t have multiple rules with the same priority.
actions(Vec<Action>)
/set_actions(Option<Vec<Action>>)
:The actions.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tags to assign to the rule.
- On success, responds with
CreateRuleOutput
with field(s):rules(Option<Vec<Rule>>)
:Information about the rule.
- On failure, responds with
SdkError<CreateRuleError>
sourcepub fn create_target_group(&self) -> CreateTargetGroup
pub fn create_target_group(&self) -> CreateTargetGroup
Constructs a fluent builder for the CreateTargetGroup
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the target group.
This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
protocol(ProtocolEnum)
/set_protocol(Option<ProtocolEnum>)
:The protocol to use for routing traffic to the targets. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, or TCP_UDP. For Gateway Load Balancers, the supported protocol is GENEVE. A TCP_UDP listener must be associated with a TCP_UDP target group. If the target is a Lambda function, this parameter does not apply.
protocol_version(impl Into<String>)
/set_protocol_version(Option<String>)
:[HTTP/HTTPS protocol] The protocol version. Specify
GRPC
to send requests to targets using gRPC. SpecifyHTTP2
to send requests to targets using HTTP/2. The default isHTTP1
, which sends requests to targets using HTTP/1.1.port(i32)
/set_port(Option<i32>)
:The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081.
vpc_id(impl Into<String>)
/set_vpc_id(Option<String>)
:The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply. Otherwise, this parameter is required.
health_check_protocol(ProtocolEnum)
/set_health_check_protocol(Option<ProtocolEnum>)
:The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load Balancers, the default is TCP. The TCP protocol is not supported for health checks if the protocol of the target group is HTTP or HTTPS. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.
health_check_port(impl Into<String>)
/set_health_check_port(Option<String>)
:The port the load balancer uses when performing health checks on targets. If the protocol is HTTP, HTTPS, TCP, TLS, UDP, or TCP_UDP, the default is
traffic-port
, which is the port on which each target receives traffic from the load balancer. If the protocol is GENEVE, the default is port 80.health_check_enabled(bool)
/set_health_check_enabled(Option<bool>)
:Indicates whether health checks are enabled. If the target type is
lambda
, health checks are disabled by default but can be enabled. If the target type isinstance
,ip
, oralb
, health checks are always enabled and cannot be disabled.health_check_path(impl Into<String>)
/set_health_check_path(Option<String>)
:[HTTP/HTTPS health checks] The destination for health checks on the targets.
[HTTP1 or HTTP2 protocol version] The ping path. The default is /.
[GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /Amazon Web Services.ALB/healthcheck.
health_check_interval_seconds(i32)
/set_health_check_interval_seconds(Option<i32>)
:The approximate amount of time, in seconds, between health checks of an individual target. If the target group protocol is TCP, TLS, UDP, or TCP_UDP, the supported values are 10 and 30 seconds. If the target group protocol is HTTP or HTTPS, the default is 30 seconds. If the target group protocol is GENEVE, the default is 10 seconds. If the target type is
lambda
, the default is 35 seconds.health_check_timeout_seconds(i32)
/set_health_check_timeout_seconds(Option<i32>)
:The amount of time, in seconds, during which no response from a target means a failed health check. For target groups with a protocol of HTTP, HTTPS, or GENEVE, the default is 5 seconds. For target groups with a protocol of TCP or TLS, this value must be 6 seconds for HTTP health checks and 10 seconds for TCP and HTTPS health checks. If the target type is
lambda
, the default is 30 seconds.healthy_threshold_count(i32)
/set_healthy_threshold_count(Option<i32>)
:The number of consecutive health checks successes required before considering an unhealthy target healthy. For target groups with a protocol of HTTP or HTTPS, the default is 5. For target groups with a protocol of TCP, TLS, or GENEVE, the default is 3. If the target type is
lambda
, the default is 5.unhealthy_threshold_count(i32)
/set_unhealthy_threshold_count(Option<i32>)
:The number of consecutive health check failures required before considering a target unhealthy. If the target group protocol is HTTP or HTTPS, the default is 2. If the target group protocol is TCP or TLS, this value must be the same as the healthy threshold count. If the target group protocol is GENEVE, the default is 3. If the target type is
lambda
, the default is 2.matcher(Matcher)
/set_matcher(Option<Matcher>)
:[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
target_type(TargetTypeEnum)
/set_target_type(Option<TargetTypeEnum>)
:The type of target that you must specify when registering targets with this target group. You can’t specify targets for a target group using more than one target type.
-
instance
- Register targets by instance ID. This is the default value. -
ip
- Register targets by IP address. You can specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can’t specify publicly routable IP addresses. -
lambda
- Register a single Lambda function as a target. -
alb
- Register a single Application Load Balancer as a target.
-
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tags to assign to the target group.
ip_address_type(TargetGroupIpAddressTypeEnum)
/set_ip_address_type(Option<TargetGroupIpAddressTypeEnum>)
:The type of IP address used for this target group. The possible values are
ipv4
andipv6
. This is an optional parameter. If not specified, the IP address type defaults toipv4
.
- On success, responds with
CreateTargetGroupOutput
with field(s):target_groups(Option<Vec<TargetGroup>>)
:Information about the target group.
- On failure, responds with
SdkError<CreateTargetGroupError>
sourcepub fn delete_listener(&self) -> DeleteListener
pub fn delete_listener(&self) -> DeleteListener
Constructs a fluent builder for the DeleteListener
operation.
- The fluent builder is configurable:
listener_arn(impl Into<String>)
/set_listener_arn(Option<String>)
:The Amazon Resource Name (ARN) of the listener.
- On success, responds with
DeleteListenerOutput
- On failure, responds with
SdkError<DeleteListenerError>
sourcepub fn delete_load_balancer(&self) -> DeleteLoadBalancer
pub fn delete_load_balancer(&self) -> DeleteLoadBalancer
Constructs a fluent builder for the DeleteLoadBalancer
operation.
- The fluent builder is configurable:
load_balancer_arn(impl Into<String>)
/set_load_balancer_arn(Option<String>)
:The Amazon Resource Name (ARN) of the load balancer.
- On success, responds with
DeleteLoadBalancerOutput
- On failure, responds with
SdkError<DeleteLoadBalancerError>
sourcepub fn delete_rule(&self) -> DeleteRule
pub fn delete_rule(&self) -> DeleteRule
Constructs a fluent builder for the DeleteRule
operation.
- The fluent builder is configurable:
rule_arn(impl Into<String>)
/set_rule_arn(Option<String>)
:The Amazon Resource Name (ARN) of the rule.
- On success, responds with
DeleteRuleOutput
- On failure, responds with
SdkError<DeleteRuleError>
sourcepub fn delete_target_group(&self) -> DeleteTargetGroup
pub fn delete_target_group(&self) -> DeleteTargetGroup
Constructs a fluent builder for the DeleteTargetGroup
operation.
- The fluent builder is configurable:
target_group_arn(impl Into<String>)
/set_target_group_arn(Option<String>)
:The Amazon Resource Name (ARN) of the target group.
- On success, responds with
DeleteTargetGroupOutput
- On failure, responds with
SdkError<DeleteTargetGroupError>
sourcepub fn deregister_targets(&self) -> DeregisterTargets
pub fn deregister_targets(&self) -> DeregisterTargets
Constructs a fluent builder for the DeregisterTargets
operation.
- The fluent builder is configurable:
target_group_arn(impl Into<String>)
/set_target_group_arn(Option<String>)
:The Amazon Resource Name (ARN) of the target group.
targets(Vec<TargetDescription>)
/set_targets(Option<Vec<TargetDescription>>)
:The targets. If you specified a port override when you registered a target, you must specify both the target ID and the port when you deregister it.
- On success, responds with
DeregisterTargetsOutput
- On failure, responds with
SdkError<DeregisterTargetsError>
sourcepub fn describe_account_limits(&self) -> DescribeAccountLimits
pub fn describe_account_limits(&self) -> DescribeAccountLimits
Constructs a fluent builder for the DescribeAccountLimits
operation.
- The fluent builder is configurable:
marker(impl Into<String>)
/set_marker(Option<String>)
:The marker for the next set of results. (You received this marker from a previous call.)
page_size(i32)
/set_page_size(Option<i32>)
:The maximum number of results to return with this call.
- On success, responds with
DescribeAccountLimitsOutput
with field(s):limits(Option<Vec<Limit>>)
:Information about the limits.
next_marker(Option<String>)
:If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
- On failure, responds with
SdkError<DescribeAccountLimitsError>
sourcepub fn describe_listener_certificates(&self) -> DescribeListenerCertificates
pub fn describe_listener_certificates(&self) -> DescribeListenerCertificates
Constructs a fluent builder for the DescribeListenerCertificates
operation.
- The fluent builder is configurable:
listener_arn(impl Into<String>)
/set_listener_arn(Option<String>)
:The Amazon Resource Names (ARN) of the listener.
marker(impl Into<String>)
/set_marker(Option<String>)
:The marker for the next set of results. (You received this marker from a previous call.)
page_size(i32)
/set_page_size(Option<i32>)
:The maximum number of results to return with this call.
- On success, responds with
DescribeListenerCertificatesOutput
with field(s):certificates(Option<Vec<Certificate>>)
:Information about the certificates.
next_marker(Option<String>)
:If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
- On failure, responds with
SdkError<DescribeListenerCertificatesError>
sourcepub fn describe_listeners(&self) -> DescribeListeners
pub fn describe_listeners(&self) -> DescribeListeners
Constructs a fluent builder for the DescribeListeners
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
load_balancer_arn(impl Into<String>)
/set_load_balancer_arn(Option<String>)
:The Amazon Resource Name (ARN) of the load balancer.
listener_arns(Vec<String>)
/set_listener_arns(Option<Vec<String>>)
:The Amazon Resource Names (ARN) of the listeners.
marker(impl Into<String>)
/set_marker(Option<String>)
:The marker for the next set of results. (You received this marker from a previous call.)
page_size(i32)
/set_page_size(Option<i32>)
:The maximum number of results to return with this call.
- On success, responds with
DescribeListenersOutput
with field(s):listeners(Option<Vec<Listener>>)
:Information about the listeners.
next_marker(Option<String>)
:If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
- On failure, responds with
SdkError<DescribeListenersError>
sourcepub fn describe_load_balancer_attributes(
&self
) -> DescribeLoadBalancerAttributes
pub fn describe_load_balancer_attributes(
&self
) -> DescribeLoadBalancerAttributes
Constructs a fluent builder for the DescribeLoadBalancerAttributes
operation.
- The fluent builder is configurable:
load_balancer_arn(impl Into<String>)
/set_load_balancer_arn(Option<String>)
:The Amazon Resource Name (ARN) of the load balancer.
- On success, responds with
DescribeLoadBalancerAttributesOutput
with field(s):attributes(Option<Vec<LoadBalancerAttribute>>)
:Information about the load balancer attributes.
- On failure, responds with
SdkError<DescribeLoadBalancerAttributesError>
sourcepub fn describe_load_balancers(&self) -> DescribeLoadBalancers
pub fn describe_load_balancers(&self) -> DescribeLoadBalancers
Constructs a fluent builder for the DescribeLoadBalancers
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
load_balancer_arns(Vec<String>)
/set_load_balancer_arns(Option<Vec<String>>)
:The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call.
names(Vec<String>)
/set_names(Option<Vec<String>>)
:The names of the load balancers.
marker(impl Into<String>)
/set_marker(Option<String>)
:The marker for the next set of results. (You received this marker from a previous call.)
page_size(i32)
/set_page_size(Option<i32>)
:The maximum number of results to return with this call.
- On success, responds with
DescribeLoadBalancersOutput
with field(s):load_balancers(Option<Vec<LoadBalancer>>)
:Information about the load balancers.
next_marker(Option<String>)
:If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
- On failure, responds with
SdkError<DescribeLoadBalancersError>
sourcepub fn describe_rules(&self) -> DescribeRules
pub fn describe_rules(&self) -> DescribeRules
Constructs a fluent builder for the DescribeRules
operation.
- The fluent builder is configurable:
listener_arn(impl Into<String>)
/set_listener_arn(Option<String>)
:The Amazon Resource Name (ARN) of the listener.
rule_arns(Vec<String>)
/set_rule_arns(Option<Vec<String>>)
:The Amazon Resource Names (ARN) of the rules.
marker(impl Into<String>)
/set_marker(Option<String>)
:The marker for the next set of results. (You received this marker from a previous call.)
page_size(i32)
/set_page_size(Option<i32>)
:The maximum number of results to return with this call.
- On success, responds with
DescribeRulesOutput
with field(s):rules(Option<Vec<Rule>>)
:Information about the rules.
next_marker(Option<String>)
:If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
- On failure, responds with
SdkError<DescribeRulesError>
sourcepub fn describe_ssl_policies(&self) -> DescribeSSLPolicies
pub fn describe_ssl_policies(&self) -> DescribeSSLPolicies
Constructs a fluent builder for the DescribeSSLPolicies
operation.
- The fluent builder is configurable:
names(Vec<String>)
/set_names(Option<Vec<String>>)
:The names of the policies.
marker(impl Into<String>)
/set_marker(Option<String>)
:The marker for the next set of results. (You received this marker from a previous call.)
page_size(i32)
/set_page_size(Option<i32>)
:The maximum number of results to return with this call.
load_balancer_type(LoadBalancerTypeEnum)
/set_load_balancer_type(Option<LoadBalancerTypeEnum>)
:The type of load balancer. The default lists the SSL policies for all load balancers.
- On success, responds with
DescribeSslPoliciesOutput
with field(s):ssl_policies(Option<Vec<SslPolicy>>)
:Information about the security policies.
next_marker(Option<String>)
:If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
- On failure, responds with
SdkError<DescribeSSLPoliciesError>
Constructs a fluent builder for the DescribeTags
operation.
- The fluent builder is configurable:
resource_arns(Vec<String>)
/set_resource_arns(Option<Vec<String>>)
:The Amazon Resource Names (ARN) of the resources. You can specify up to 20 resources in a single call.
- On success, responds with
DescribeTagsOutput
with field(s):tag_descriptions(Option<Vec<TagDescription>>)
:Information about the tags.
- On failure, responds with
SdkError<DescribeTagsError>
sourcepub fn describe_target_group_attributes(&self) -> DescribeTargetGroupAttributes
pub fn describe_target_group_attributes(&self) -> DescribeTargetGroupAttributes
Constructs a fluent builder for the DescribeTargetGroupAttributes
operation.
- The fluent builder is configurable:
target_group_arn(impl Into<String>)
/set_target_group_arn(Option<String>)
:The Amazon Resource Name (ARN) of the target group.
- On success, responds with
DescribeTargetGroupAttributesOutput
with field(s):attributes(Option<Vec<TargetGroupAttribute>>)
:Information about the target group attributes
- On failure, responds with
SdkError<DescribeTargetGroupAttributesError>
sourcepub fn describe_target_groups(&self) -> DescribeTargetGroups
pub fn describe_target_groups(&self) -> DescribeTargetGroups
Constructs a fluent builder for the DescribeTargetGroups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
load_balancer_arn(impl Into<String>)
/set_load_balancer_arn(Option<String>)
:The Amazon Resource Name (ARN) of the load balancer.
target_group_arns(Vec<String>)
/set_target_group_arns(Option<Vec<String>>)
:The Amazon Resource Names (ARN) of the target groups.
names(Vec<String>)
/set_names(Option<Vec<String>>)
:The names of the target groups.
marker(impl Into<String>)
/set_marker(Option<String>)
:The marker for the next set of results. (You received this marker from a previous call.)
page_size(i32)
/set_page_size(Option<i32>)
:The maximum number of results to return with this call.
- On success, responds with
DescribeTargetGroupsOutput
with field(s):target_groups(Option<Vec<TargetGroup>>)
:Information about the target groups.
next_marker(Option<String>)
:If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
- On failure, responds with
SdkError<DescribeTargetGroupsError>
sourcepub fn describe_target_health(&self) -> DescribeTargetHealth
pub fn describe_target_health(&self) -> DescribeTargetHealth
Constructs a fluent builder for the DescribeTargetHealth
operation.
- The fluent builder is configurable:
target_group_arn(impl Into<String>)
/set_target_group_arn(Option<String>)
:The Amazon Resource Name (ARN) of the target group.
targets(Vec<TargetDescription>)
/set_targets(Option<Vec<TargetDescription>>)
:The targets.
- On success, responds with
DescribeTargetHealthOutput
with field(s):target_health_descriptions(Option<Vec<TargetHealthDescription>>)
:Information about the health of the targets.
- On failure, responds with
SdkError<DescribeTargetHealthError>
sourcepub fn modify_listener(&self) -> ModifyListener
pub fn modify_listener(&self) -> ModifyListener
Constructs a fluent builder for the ModifyListener
operation.
- The fluent builder is configurable:
listener_arn(impl Into<String>)
/set_listener_arn(Option<String>)
:The Amazon Resource Name (ARN) of the listener.
port(i32)
/set_port(Option<i32>)
:The port for connections from clients to the load balancer. You cannot specify a port for a Gateway Load Balancer.
protocol(ProtocolEnum)
/set_protocol(Option<ProtocolEnum>)
:The protocol for connections from clients to the load balancer. Application Load Balancers support the HTTP and HTTPS protocols. Network Load Balancers support the TCP, TLS, UDP, and TCP_UDP protocols. You can’t change the protocol to UDP or TCP_UDP if dual-stack mode is enabled. You cannot specify a protocol for a Gateway Load Balancer.
ssl_policy(impl Into<String>)
/set_ssl_policy(Option<String>)
:[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported.
For more information, see Security policies in the Application Load Balancers Guide or Security policies in the Network Load Balancers Guide.
certificates(Vec<Certificate>)
/set_certificates(Option<Vec<Certificate>>)
:[HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one certificate. Set
CertificateArn
to the certificate ARN but do not setIsDefault
.default_actions(Vec<Action>)
/set_default_actions(Option<Vec<Action>>)
:The actions for the default rule.
alpn_policy(Vec<String>)
/set_alpn_policy(Option<Vec<String>>)
:[TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy. You can specify one policy name. The following are the possible values:
-
HTTP1Only
-
HTTP2Only
-
HTTP2Optional
-
HTTP2Preferred
-
None
For more information, see ALPN policies in the Network Load Balancers Guide.
-
- On success, responds with
ModifyListenerOutput
with field(s):listeners(Option<Vec<Listener>>)
:Information about the modified listener.
- On failure, responds with
SdkError<ModifyListenerError>
sourcepub fn modify_load_balancer_attributes(&self) -> ModifyLoadBalancerAttributes
pub fn modify_load_balancer_attributes(&self) -> ModifyLoadBalancerAttributes
Constructs a fluent builder for the ModifyLoadBalancerAttributes
operation.
- The fluent builder is configurable:
load_balancer_arn(impl Into<String>)
/set_load_balancer_arn(Option<String>)
:The Amazon Resource Name (ARN) of the load balancer.
attributes(Vec<LoadBalancerAttribute>)
/set_attributes(Option<Vec<LoadBalancerAttribute>>)
:The load balancer attributes.
- On success, responds with
ModifyLoadBalancerAttributesOutput
with field(s):attributes(Option<Vec<LoadBalancerAttribute>>)
:Information about the load balancer attributes.
- On failure, responds with
SdkError<ModifyLoadBalancerAttributesError>
sourcepub fn modify_rule(&self) -> ModifyRule
pub fn modify_rule(&self) -> ModifyRule
Constructs a fluent builder for the ModifyRule
operation.
- The fluent builder is configurable:
rule_arn(impl Into<String>)
/set_rule_arn(Option<String>)
:The Amazon Resource Name (ARN) of the rule.
conditions(Vec<RuleCondition>)
/set_conditions(Option<Vec<RuleCondition>>)
:The conditions.
actions(Vec<Action>)
/set_actions(Option<Vec<Action>>)
:The actions.
- On success, responds with
ModifyRuleOutput
with field(s):rules(Option<Vec<Rule>>)
:Information about the modified rule.
- On failure, responds with
SdkError<ModifyRuleError>
sourcepub fn modify_target_group(&self) -> ModifyTargetGroup
pub fn modify_target_group(&self) -> ModifyTargetGroup
Constructs a fluent builder for the ModifyTargetGroup
operation.
- The fluent builder is configurable:
target_group_arn(impl Into<String>)
/set_target_group_arn(Option<String>)
:The Amazon Resource Name (ARN) of the target group.
health_check_protocol(ProtocolEnum)
/set_health_check_protocol(Option<ProtocolEnum>)
:The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load Balancers, the default is TCP. The TCP protocol is not supported for health checks if the protocol of the target group is HTTP or HTTPS. It is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.
With Network Load Balancers, you can’t modify this setting.
health_check_port(impl Into<String>)
/set_health_check_port(Option<String>)
:The port the load balancer uses when performing health checks on targets.
health_check_path(impl Into<String>)
/set_health_check_path(Option<String>)
:[HTTP/HTTPS health checks] The destination for health checks on the targets.
[HTTP1 or HTTP2 protocol version] The ping path. The default is /.
[GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /Amazon Web Services.ALB/healthcheck.
health_check_enabled(bool)
/set_health_check_enabled(Option<bool>)
:Indicates whether health checks are enabled.
health_check_interval_seconds(i32)
/set_health_check_interval_seconds(Option<i32>)
:The approximate amount of time, in seconds, between health checks of an individual target. For TCP health checks, the supported values are 10 or 30 seconds.
With Network Load Balancers, you can’t modify this setting.
health_check_timeout_seconds(i32)
/set_health_check_timeout_seconds(Option<i32>)
:[HTTP/HTTPS health checks] The amount of time, in seconds, during which no response means a failed health check.
With Network Load Balancers, you can’t modify this setting.
healthy_threshold_count(i32)
/set_healthy_threshold_count(Option<i32>)
:The number of consecutive health checks successes required before considering an unhealthy target healthy.
unhealthy_threshold_count(i32)
/set_unhealthy_threshold_count(Option<i32>)
:The number of consecutive health check failures required before considering the target unhealthy. For target groups with a protocol of TCP or TLS, this value must be the same as the healthy threshold count.
matcher(Matcher)
/set_matcher(Option<Matcher>)
:[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
With Network Load Balancers, you can’t modify this setting.
- On success, responds with
ModifyTargetGroupOutput
with field(s):target_groups(Option<Vec<TargetGroup>>)
:Information about the modified target group.
- On failure, responds with
SdkError<ModifyTargetGroupError>
sourcepub fn modify_target_group_attributes(&self) -> ModifyTargetGroupAttributes
pub fn modify_target_group_attributes(&self) -> ModifyTargetGroupAttributes
Constructs a fluent builder for the ModifyTargetGroupAttributes
operation.
- The fluent builder is configurable:
target_group_arn(impl Into<String>)
/set_target_group_arn(Option<String>)
:The Amazon Resource Name (ARN) of the target group.
attributes(Vec<TargetGroupAttribute>)
/set_attributes(Option<Vec<TargetGroupAttribute>>)
:The attributes.
- On success, responds with
ModifyTargetGroupAttributesOutput
with field(s):attributes(Option<Vec<TargetGroupAttribute>>)
:Information about the attributes.
- On failure, responds with
SdkError<ModifyTargetGroupAttributesError>
sourcepub fn register_targets(&self) -> RegisterTargets
pub fn register_targets(&self) -> RegisterTargets
Constructs a fluent builder for the RegisterTargets
operation.
- The fluent builder is configurable:
target_group_arn(impl Into<String>)
/set_target_group_arn(Option<String>)
:The Amazon Resource Name (ARN) of the target group.
targets(Vec<TargetDescription>)
/set_targets(Option<Vec<TargetDescription>>)
:The targets.
- On success, responds with
RegisterTargetsOutput
- On failure, responds with
SdkError<RegisterTargetsError>
sourcepub fn remove_listener_certificates(&self) -> RemoveListenerCertificates
pub fn remove_listener_certificates(&self) -> RemoveListenerCertificates
Constructs a fluent builder for the RemoveListenerCertificates
operation.
- The fluent builder is configurable:
listener_arn(impl Into<String>)
/set_listener_arn(Option<String>)
:The Amazon Resource Name (ARN) of the listener.
certificates(Vec<Certificate>)
/set_certificates(Option<Vec<Certificate>>)
:The certificate to remove. You can specify one certificate per call. Set
CertificateArn
to the certificate ARN but do not setIsDefault
.
- On success, responds with
RemoveListenerCertificatesOutput
- On failure, responds with
SdkError<RemoveListenerCertificatesError>
Constructs a fluent builder for the RemoveTags
operation.
- The fluent builder is configurable:
resource_arns(Vec<String>)
/set_resource_arns(Option<Vec<String>>)
:The Amazon Resource Name (ARN) of the resource.
tag_keys(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
:The tag keys for the tags to remove.
- On success, responds with
RemoveTagsOutput
- On failure, responds with
SdkError<RemoveTagsError>
sourcepub fn set_ip_address_type(&self) -> SetIpAddressType
pub fn set_ip_address_type(&self) -> SetIpAddressType
Constructs a fluent builder for the SetIpAddressType
operation.
- The fluent builder is configurable:
load_balancer_arn(impl Into<String>)
/set_load_balancer_arn(Option<String>)
:The Amazon Resource Name (ARN) of the load balancer.
ip_address_type(IpAddressType)
/set_ip_address_type(Option<IpAddressType>)
:The IP address type. The possible values are
ipv4
(for IPv4 addresses) anddualstack
(for IPv4 and IPv6 addresses). You can’t specifydualstack
for a load balancer with a UDP or TCP_UDP listener.
- On success, responds with
SetIpAddressTypeOutput
with field(s):ip_address_type(Option<IpAddressType>)
:The IP address type.
- On failure, responds with
SdkError<SetIpAddressTypeError>
sourcepub fn set_rule_priorities(&self) -> SetRulePriorities
pub fn set_rule_priorities(&self) -> SetRulePriorities
Constructs a fluent builder for the SetRulePriorities
operation.
- The fluent builder is configurable:
rule_priorities(Vec<RulePriorityPair>)
/set_rule_priorities(Option<Vec<RulePriorityPair>>)
:The rule priorities.
- On success, responds with
SetRulePrioritiesOutput
with field(s):rules(Option<Vec<Rule>>)
:Information about the rules.
- On failure, responds with
SdkError<SetRulePrioritiesError>
sourcepub fn set_security_groups(&self) -> SetSecurityGroups
pub fn set_security_groups(&self) -> SetSecurityGroups
Constructs a fluent builder for the SetSecurityGroups
operation.
- The fluent builder is configurable:
load_balancer_arn(impl Into<String>)
/set_load_balancer_arn(Option<String>)
:The Amazon Resource Name (ARN) of the load balancer.
security_groups(Vec<String>)
/set_security_groups(Option<Vec<String>>)
:The IDs of the security groups.
- On success, responds with
SetSecurityGroupsOutput
with field(s):security_group_ids(Option<Vec<String>>)
:The IDs of the security groups associated with the load balancer.
- On failure, responds with
SdkError<SetSecurityGroupsError>
sourcepub fn set_subnets(&self) -> SetSubnets
pub fn set_subnets(&self) -> SetSubnets
Constructs a fluent builder for the SetSubnets
operation.
- The fluent builder is configurable:
load_balancer_arn(impl Into<String>)
/set_load_balancer_arn(Option<String>)
:The Amazon Resource Name (ARN) of the load balancer.
subnets(Vec<String>)
/set_subnets(Option<Vec<String>>)
:The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.
[Application Load Balancers] You must specify subnets from at least two Availability Zones.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers] You can specify subnets from one or more Availability Zones.
subnet_mappings(Vec<SubnetMapping>)
/set_subnet_mappings(Option<Vec<SubnetMapping>>)
:The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.
[Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.
ip_address_type(IpAddressType)
/set_ip_address_type(Option<IpAddressType>)
:[Network Load Balancers] The type of IP addresses used by the subnets for your load balancer. The possible values are
ipv4
(for IPv4 addresses) anddualstack
(for IPv4 and IPv6 addresses). You can’t specifydualstack
for a load balancer with a UDP or TCP_UDP listener. .
- On success, responds with
SetSubnetsOutput
with field(s):availability_zones(Option<Vec<AvailabilityZone>>)
:Information about the subnets.
ip_address_type(Option<IpAddressType>)
:[Network Load Balancers] The IP address type.
- On failure, responds with
SdkError<SetSubnetsError>
sourceimpl Client
impl Client
sourcepub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
Creates a client with the given service config and connector override.
Trait Implementations
sourceimpl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
sourcefn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
Converts to this type from the input type.
Auto Trait Implementations
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more