Struct aws_sdk_globalaccelerator::client::fluent_builders::CreateEndpointGroup

pub struct CreateEndpointGroup { /* private fields */ }

Fluent builder constructing a request to CreateEndpointGroup.

Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one AWS Region. A resource must be valid and active when you add it as an endpoint.

Implementations

impl CreateEndpointGroup

pub async fn send(
    self
) -> Result<CreateEndpointGroupOutput, SdkError<CreateEndpointGroupError>>

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.

pub fn listener_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the listener.

pub fn set_listener_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the listener.

pub fn endpoint_group_region(self, input: impl Into<String>) -> Self

The AWS Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.

pub fn set_endpoint_group_region(self, input: Option<String>) -> Self

The AWS Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.

pub fn endpoint_configurations(self, input: EndpointConfiguration) -> Self

Appends an item to EndpointConfigurations.

To override the contents of this collection use set_endpoint_configurations.

The list of endpoint objects.

pub fn set_endpoint_configurations(
    self,
    input: Option<Vec<EndpointConfiguration>>
) -> Self

The list of endpoint objects.

pub fn traffic_dial_percentage(self, input: f32) -> Self

The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.

Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.

The default value is 100.

pub fn set_traffic_dial_percentage(self, input: Option<f32>) -> Self

The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.

Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.

The default value is 100.

pub fn health_check_port(self, input: i32) -> Self

The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list.

pub fn set_health_check_port(self, input: Option<i32>) -> Self

The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list.

pub fn health_check_protocol(self, input: HealthCheckProtocol) -> Self

The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.

pub fn set_health_check_protocol(
    self,
    input: Option<HealthCheckProtocol>
) -> Self

The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.

pub fn health_check_path(self, input: impl Into<String>) -> Self

If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).

pub fn set_health_check_path(self, input: Option<String>) -> Self

If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).

pub fn health_check_interval_seconds(self, input: i32) -> Self

The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.

pub fn set_health_check_interval_seconds(self, input: Option<i32>) -> Self

The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.

pub fn threshold_count(self, input: i32) -> Self

The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.

pub fn set_threshold_count(self, input: Option<i32>) -> Self

The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.

pub fn idempotency_token(self, input: impl Into<String>) -> Self

A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

pub fn set_idempotency_token(self, input: Option<String>) -> Self

A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

pub fn port_overrides(self, input: PortOverride) -> Self

Appends an item to PortOverrides.

To override the contents of this collection use set_port_overrides.

Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.

For more information, see Port overrides in the AWS Global Accelerator Developer Guide.

pub fn set_port_overrides(self, input: Option<Vec<PortOverride>>) -> Self

Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.

For more information, see Port overrides in the AWS Global Accelerator Developer Guide.

Trait Implementations

impl Clone for CreateEndpointGroup

fn clone(&self) -> CreateEndpointGroup

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateEndpointGroup

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

Formats the value using the given formatter.