pub struct CreateTargetGroup { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateTargetGroup
.
Creates a target group.
For more information, see the following:
This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple target groups with the same settings, each call succeeds.
Implementations
sourceimpl CreateTargetGroup
impl CreateTargetGroup
sourcepub async fn send(
self
) -> Result<CreateTargetGroupOutput, SdkError<CreateTargetGroupError>>
pub async fn send(
self
) -> Result<CreateTargetGroupOutput, SdkError<CreateTargetGroupError>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_name(self, input: Option<String>) -> Self
pub fn set_name(self, input: Option<String>) -> Self
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.
sourcepub fn protocol(self, input: ProtocolEnum) -> Self
pub fn protocol(self, input: ProtocolEnum) -> Self
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.
sourcepub fn set_protocol(self, input: Option<ProtocolEnum>) -> Self
pub fn set_protocol(self, input: Option<ProtocolEnum>) -> Self
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.
sourcepub fn protocol_version(self, input: impl Into<String>) -> Self
pub fn protocol_version(self, input: impl Into<String>) -> Self
[HTTP/HTTPS protocol] The protocol version. Specify GRPC
to send requests to targets using gRPC. Specify HTTP2
to send requests to targets using HTTP/2. The default is HTTP1
, which sends requests to targets using HTTP/1.1.
sourcepub fn set_protocol_version(self, input: Option<String>) -> Self
pub fn set_protocol_version(self, input: Option<String>) -> Self
[HTTP/HTTPS protocol] The protocol version. Specify GRPC
to send requests to targets using gRPC. Specify HTTP2
to send requests to targets using HTTP/2. The default is HTTP1
, which sends requests to targets using HTTP/1.1.
sourcepub fn port(self, input: i32) -> Self
pub fn port(self, input: i32) -> Self
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.
sourcepub fn set_port(self, input: Option<i32>) -> Self
pub fn set_port(self, input: Option<i32>) -> Self
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.
sourcepub fn vpc_id(self, input: impl Into<String>) -> Self
pub fn vpc_id(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_vpc_id(self, input: Option<String>) -> Self
pub fn set_vpc_id(self, input: Option<String>) -> Self
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.
sourcepub fn health_check_protocol(self, input: ProtocolEnum) -> Self
pub fn health_check_protocol(self, input: ProtocolEnum) -> Self
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.
sourcepub fn set_health_check_protocol(self, input: Option<ProtocolEnum>) -> Self
pub fn set_health_check_protocol(self, input: Option<ProtocolEnum>) -> Self
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.
sourcepub fn health_check_port(self, input: impl Into<String>) -> Self
pub fn health_check_port(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_health_check_port(self, input: Option<String>) -> Self
pub fn set_health_check_port(self, input: Option<String>) -> Self
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.
sourcepub fn health_check_enabled(self, input: bool) -> Self
pub fn health_check_enabled(self, input: bool) -> Self
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 is instance
, ip
, or alb
, health checks are always enabled and cannot be disabled.
sourcepub fn set_health_check_enabled(self, input: Option<bool>) -> Self
pub fn set_health_check_enabled(self, input: Option<bool>) -> Self
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 is instance
, ip
, or alb
, health checks are always enabled and cannot be disabled.
sourcepub fn health_check_path(self, input: impl Into<String>) -> Self
pub fn health_check_path(self, input: impl Into<String>) -> Self
[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.
sourcepub fn set_health_check_path(self, input: Option<String>) -> Self
pub fn set_health_check_path(self, input: Option<String>) -> Self
[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.
sourcepub fn health_check_interval_seconds(self, input: i32) -> Self
pub fn health_check_interval_seconds(self, input: i32) -> Self
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.
sourcepub fn set_health_check_interval_seconds(self, input: Option<i32>) -> Self
pub fn set_health_check_interval_seconds(self, input: Option<i32>) -> Self
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.
sourcepub fn health_check_timeout_seconds(self, input: i32) -> Self
pub fn health_check_timeout_seconds(self, input: i32) -> Self
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.
sourcepub fn set_health_check_timeout_seconds(self, input: Option<i32>) -> Self
pub fn set_health_check_timeout_seconds(self, input: Option<i32>) -> Self
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.
sourcepub fn healthy_threshold_count(self, input: i32) -> Self
pub fn healthy_threshold_count(self, input: i32) -> Self
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.
sourcepub fn set_healthy_threshold_count(self, input: Option<i32>) -> Self
pub fn set_healthy_threshold_count(self, input: Option<i32>) -> Self
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.
sourcepub fn unhealthy_threshold_count(self, input: i32) -> Self
pub fn unhealthy_threshold_count(self, input: i32) -> Self
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.
sourcepub fn set_unhealthy_threshold_count(self, input: Option<i32>) -> Self
pub fn set_unhealthy_threshold_count(self, input: Option<i32>) -> Self
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.
sourcepub fn matcher(self, input: Matcher) -> Self
pub fn matcher(self, input: Matcher) -> Self
[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
sourcepub fn set_matcher(self, input: Option<Matcher>) -> Self
pub fn set_matcher(self, input: Option<Matcher>) -> Self
[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
sourcepub fn target_type(self, input: TargetTypeEnum) -> Self
pub fn target_type(self, input: TargetTypeEnum) -> Self
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.
sourcepub fn set_target_type(self, input: Option<TargetTypeEnum>) -> Self
pub fn set_target_type(self, input: Option<TargetTypeEnum>) -> Self
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.
Appends an item to Tags
.
To override the contents of this collection use set_tags
.
The tags to assign to the target group.
The tags to assign to the target group.
sourcepub fn ip_address_type(self, input: TargetGroupIpAddressTypeEnum) -> Self
pub fn ip_address_type(self, input: TargetGroupIpAddressTypeEnum) -> Self
The type of IP address used for this target group. The possible values are ipv4
and ipv6
. This is an optional parameter. If not specified, the IP address type defaults to ipv4
.
sourcepub fn set_ip_address_type(
self,
input: Option<TargetGroupIpAddressTypeEnum>
) -> Self
pub fn set_ip_address_type(
self,
input: Option<TargetGroupIpAddressTypeEnum>
) -> Self
The type of IP address used for this target group. The possible values are ipv4
and ipv6
. This is an optional parameter. If not specified, the IP address type defaults to ipv4
.
Trait Implementations
sourceimpl Clone for CreateTargetGroup
impl Clone for CreateTargetGroup
sourcefn clone(&self) -> CreateTargetGroup
fn clone(&self) -> CreateTargetGroup
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for CreateTargetGroup
impl Send for CreateTargetGroup
impl Sync for CreateTargetGroup
impl Unpin for CreateTargetGroup
impl !UnwindSafe for CreateTargetGroup
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