Struct aws_sdk_globalaccelerator::input::CreateEndpointGroupInput

#[non_exhaustive]
pub struct CreateEndpointGroupInput {
    pub listener_arn: Option<String>,
    pub endpoint_group_region: Option<String>,
    pub endpoint_configurations: Option<Vec<EndpointConfiguration>>,
    pub traffic_dial_percentage: Option<f32>,
    pub health_check_port: Option<i32>,
    pub health_check_protocol: Option<HealthCheckProtocol>,
    pub health_check_path: Option<String>,
    pub health_check_interval_seconds: Option<i32>,
    pub threshold_count: Option<i32>,
    pub idempotency_token: Option<String>,
    pub port_overrides: Option<Vec<PortOverride>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

listener_arn: Option<String>

The Amazon Resource Name (ARN) of the listener.

endpoint_group_region: Option<String>

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

endpoint_configurations: Option<Vec<EndpointConfiguration>>

The list of endpoint objects.

traffic_dial_percentage: Option<f32>

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.

health_check_port: Option<i32>

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.

health_check_protocol: Option<HealthCheckProtocol>

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.

health_check_path: Option<String>

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

health_check_interval_seconds: Option<i32>

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

threshold_count: Option<i32>

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.

idempotency_token: Option<String>

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

port_overrides: Option<Vec<PortOverride>>

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.

Implementations

impl CreateEndpointGroupInput

pub async fn make_operation(
    self,
    _config: &Config
) -> Result<Operation<CreateEndpointGroup, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<CreateEndpointGroup>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CreateEndpointGroupInput

impl CreateEndpointGroupInput

pub fn listener_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the listener.

pub fn endpoint_group_region(&self) -> Option<&str>

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) -> Option<&[EndpointConfiguration]>

The list of endpoint objects.

pub fn traffic_dial_percentage(&self) -> Option<f32>

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) -> Option<i32>

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) -> Option<&HealthCheckProtocol>

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) -> Option<&str>

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) -> Option<i32>

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

pub fn threshold_count(&self) -> Option<i32>

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) -> Option<&str>

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

pub fn port_overrides(&self) -> Option<&[PortOverride]>

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 CreateEndpointGroupInput

fn clone(&self) -> CreateEndpointGroupInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateEndpointGroupInput

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

Formats the value using the given formatter.

impl PartialEq<CreateEndpointGroupInput> for CreateEndpointGroupInput

fn eq(&self, other: &CreateEndpointGroupInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CreateEndpointGroupInput) -> bool

This method tests for !=.

impl StructuralPartialEq for CreateEndpointGroupInput