The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Paws::GlobalAccelerator::UpdateEndpointGroup - Arguments for method UpdateEndpointGroup on Paws::GlobalAccelerator

DESCRIPTION

This class represents the parameters used for calling the method UpdateEndpointGroup on the AWS Global Accelerator service. Use the attributes of this class as arguments to method UpdateEndpointGroup.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateEndpointGroup.

SYNOPSIS

    my $globalaccelerator = Paws->service('GlobalAccelerator');
    my $UpdateEndpointGroupResponse = $globalaccelerator->UpdateEndpointGroup(
      EndpointGroupArn       => 'MyGenericString',
      EndpointConfigurations => [
        {
          ClientIPPreservationEnabled => 1,                 # OPTIONAL
          EndpointId                  => 'MyGenericString', # max: 255
          Weight                      => 1,                 # max: 255; OPTIONAL
        },
        ...
      ],    # OPTIONAL
      HealthCheckIntervalSeconds => 1,                      # OPTIONAL
      HealthCheckPath            => 'MyHealthCheckPath',    # OPTIONAL
      HealthCheckPort            => 1,                      # OPTIONAL
      HealthCheckProtocol        => 'TCP',                  # OPTIONAL
      PortOverrides              => [
        {
          EndpointPort => 1,    # min: 1, max: 65535; OPTIONAL
          ListenerPort => 1,    # min: 1, max: 65535; OPTIONAL
        },
        ...
      ],    # OPTIONAL
      ThresholdCount        => 1,      # OPTIONAL
      TrafficDialPercentage => 1.0,    # OPTIONAL
    );

    # Results:
    my $EndpointGroup = $UpdateEndpointGroupResponse->EndpointGroup;

    # Returns a L<Paws::GlobalAccelerator::UpdateEndpointGroupResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator/UpdateEndpointGroup

ATTRIBUTES

EndpointConfigurations => ArrayRef[Paws::GlobalAccelerator::EndpointConfiguration]

The list of endpoint objects. A resource must be valid and active when you add it as an endpoint.

REQUIRED EndpointGroupArn => Str

The Amazon Resource Name (ARN) of the endpoint group.

HealthCheckIntervalSeconds => Int

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

HealthCheckPath => 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 (/).

HealthCheckPort => Int

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 the listener port is a list of ports, Global Accelerator uses the first port in the list.

HealthCheckProtocol => Str

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.

Valid values are: "TCP", "HTTP", "HTTPS"

PortOverrides => ArrayRef[Paws::GlobalAccelerator::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 (https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups-port-override.html) in the AWS Global Accelerator Developer Guide.

ThresholdCount => Int

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.

TrafficDialPercentage => Num

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.

SEE ALSO

This class forms part of Paws, documenting arguments for method UpdateEndpointGroup in Paws::GlobalAccelerator

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues