Add Endpoints

globalaccelerator_add_endpoints

R Documentation

Add endpoints to an endpoint group

Description

Add endpoints to an endpoint group. The add_endpoints API operation is the recommended option for adding endpoints. The alternative options are to add endpoints when you create an endpoint group (with the create_endpoint_group API) or when you update an endpoint group (with the update_endpoint_group API).

There are two advantages to using add_endpoints to add endpoints in Global Accelerator:

• It's faster, because Global Accelerator only has to resolve the new endpoints that you're adding, rather than resolving new and existing endpoints.

• It's more convenient, because you don't need to specify the current endpoints that are already in the endpoint group, in addition to the new endpoints that you want to add.

For information about endpoint types and requirements for endpoints that you can add to Global Accelerator, see Endpoints for standard accelerators in the Global Accelerator Developer Guide.

Usage

globalaccelerator_add_endpoints(EndpointConfigurations,
  EndpointGroupArn)

Arguments

EndpointConfigurations

[required] The list of endpoint objects.

EndpointGroupArn

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

Value

A list with the following syntax:

list(
  EndpointDescriptions = list(
    list(
      EndpointId = "string",
      Weight = 123,
      HealthState = "INITIAL"|"HEALTHY"|"UNHEALTHY",
      HealthReason = "string",
      ClientIPPreservationEnabled = TRUE|FALSE
    )
  ),
  EndpointGroupArn = "string"
)

Request syntax

svc$add_endpoints(
  EndpointConfigurations = list(
    list(
      EndpointId = "string",
      Weight = 123,
      ClientIPPreservationEnabled = TRUE|FALSE,
      AttachmentArn = "string"
    )
  ),
  EndpointGroupArn = "string"
)