Amazonka.GlobalAccelerator.AddEndpoints

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

There are two advantages to using AddEndpoints to add endpoints:

• It's faster, because Global Accelerator only has to resolve the new endpoints that you're adding.
• It's more convenient, because you don't need to specify all of the current endpoints that are already in the endpoint group in addition to the new endpoints that you want to add.

Creating a Request

data AddEndpoints

See: newAddEndpoints smart constructor.

Constructors

AddEndpoints'

Fields

• endpointConfigurations :: [EndpointConfiguration]

  The list of endpoint objects.

• endpointGroupArn :: Text

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

Instances

ToJSON AddEndpoints

Defined in Amazonka.GlobalAccelerator.AddEndpoints

Methods

toJSON :: AddEndpoints -> Value

toEncoding :: AddEndpoints -> Encoding

toJSONList :: [AddEndpoints] -> Value

toEncodingList :: [AddEndpoints] -> Encoding

ToHeaders AddEndpoints

Defined in Amazonka.GlobalAccelerator.AddEndpoints

Methods

toHeaders :: AddEndpoints -> [Header]

ToPath AddEndpoints

Defined in Amazonka.GlobalAccelerator.AddEndpoints

Methods

toPath :: AddEndpoints -> ByteString

ToQuery AddEndpoints

Defined in Amazonka.GlobalAccelerator.AddEndpoints

Methods

toQuery :: AddEndpoints -> QueryString

AWSRequest AddEndpoints

Defined in Amazonka.GlobalAccelerator.AddEndpoints

Associated Types

type AWSResponse AddEndpoints

Methods

request :: (Service -> Service) -> AddEndpoints -> Request AddEndpoints

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AddEndpoints -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AddEndpoints)))

Generic AddEndpoints

Defined in Amazonka.GlobalAccelerator.AddEndpoints

Associated Types

type Rep AddEndpoints :: Type -> Type

Methods

from :: AddEndpoints -> Rep AddEndpoints x

to :: Rep AddEndpoints x -> AddEndpoints

Read AddEndpoints

Defined in Amazonka.GlobalAccelerator.AddEndpoints

Methods

readsPrec :: Int -> ReadS AddEndpoints

readList :: ReadS [AddEndpoints]

readPrec :: ReadPrec AddEndpoints

readListPrec :: ReadPrec [AddEndpoints]

Show AddEndpoints

Defined in Amazonka.GlobalAccelerator.AddEndpoints

Methods

showsPrec :: Int -> AddEndpoints -> ShowS

show :: AddEndpoints -> String

showList :: [AddEndpoints] -> ShowS

NFData AddEndpoints

Defined in Amazonka.GlobalAccelerator.AddEndpoints

Methods

rnf :: AddEndpoints -> ()

Eq AddEndpoints

Defined in Amazonka.GlobalAccelerator.AddEndpoints

Methods

(==) :: AddEndpoints -> AddEndpoints -> Bool

(/=) :: AddEndpoints -> AddEndpoints -> Bool

Hashable AddEndpoints

Defined in Amazonka.GlobalAccelerator.AddEndpoints

Methods

hashWithSalt :: Int -> AddEndpoints -> Int

hash :: AddEndpoints -> Int

type AWSResponse AddEndpoints

Defined in Amazonka.GlobalAccelerator.AddEndpoints

type AWSResponse AddEndpoints = AddEndpointsResponse

type Rep AddEndpoints

Defined in Amazonka.GlobalAccelerator.AddEndpoints

type Rep AddEndpoints = D1 ('MetaData "AddEndpoints" "Amazonka.GlobalAccelerator.AddEndpoints" "amazonka-globalaccelerator-2.0-5CEURNOKFgU1mORtBGQfFs" 'False) (C1 ('MetaCons "AddEndpoints'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endpointConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [EndpointConfiguration]) :*: S1 ('MetaSel ('Just "endpointGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newAddEndpoints

Arguments

:: Text

AddEndpoints

-> AddEndpoints

Create a value of AddEndpoints with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:endpointConfigurations:AddEndpoints', addEndpoints_endpointConfigurations - The list of endpoint objects.

AddEndpoints, addEndpoints_endpointGroupArn - The Amazon Resource Name (ARN) of the endpoint group.

Request Lenses

addEndpoints_endpointConfigurations :: Lens' AddEndpoints [EndpointConfiguration]

The list of endpoint objects.

addEndpoints_endpointGroupArn :: Lens' AddEndpoints Text

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

Destructuring the Response

data AddEndpointsResponse

See: newAddEndpointsResponse smart constructor.

Constructors

AddEndpointsResponse'

Fields

• endpointDescriptions :: Maybe [EndpointDescription]

  The list of endpoint objects.

• endpointGroupArn :: Maybe Text

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic AddEndpointsResponse

Defined in Amazonka.GlobalAccelerator.AddEndpoints

Associated Types

type Rep AddEndpointsResponse :: Type -> Type

Methods

from :: AddEndpointsResponse -> Rep AddEndpointsResponse x

to :: Rep AddEndpointsResponse x -> AddEndpointsResponse

Read AddEndpointsResponse

Defined in Amazonka.GlobalAccelerator.AddEndpoints

Methods

readsPrec :: Int -> ReadS AddEndpointsResponse

readList :: ReadS [AddEndpointsResponse]

readPrec :: ReadPrec AddEndpointsResponse

readListPrec :: ReadPrec [AddEndpointsResponse]

Show AddEndpointsResponse

Defined in Amazonka.GlobalAccelerator.AddEndpoints

Methods

showsPrec :: Int -> AddEndpointsResponse -> ShowS

show :: AddEndpointsResponse -> String

showList :: [AddEndpointsResponse] -> ShowS

NFData AddEndpointsResponse

Defined in Amazonka.GlobalAccelerator.AddEndpoints

Methods

rnf :: AddEndpointsResponse -> ()

Eq AddEndpointsResponse

Defined in Amazonka.GlobalAccelerator.AddEndpoints

Methods

(==) :: AddEndpointsResponse -> AddEndpointsResponse -> Bool

(/=) :: AddEndpointsResponse -> AddEndpointsResponse -> Bool

type Rep AddEndpointsResponse

Defined in Amazonka.GlobalAccelerator.AddEndpoints

type Rep AddEndpointsResponse = D1 ('MetaData "AddEndpointsResponse" "Amazonka.GlobalAccelerator.AddEndpoints" "amazonka-globalaccelerator-2.0-5CEURNOKFgU1mORtBGQfFs" 'False) (C1 ('MetaCons "AddEndpointsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endpointDescriptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EndpointDescription])) :*: (S1 ('MetaSel ('Just "endpointGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newAddEndpointsResponse

Arguments

:: Int

$sel:httpStatus:AddEndpointsResponse'

-> AddEndpointsResponse

Create a value of AddEndpointsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

AddEndpointsResponse, addEndpointsResponse_endpointDescriptions - The list of endpoint objects.

AddEndpoints, addEndpointsResponse_endpointGroupArn - The Amazon Resource Name (ARN) of the endpoint group.

$sel:httpStatus:AddEndpointsResponse', addEndpointsResponse_httpStatus - The response's http status code.

Response Lenses

addEndpointsResponse_endpointDescriptions :: Lens' AddEndpointsResponse (Maybe [EndpointDescription])

The list of endpoint objects.

addEndpointsResponse_endpointGroupArn :: Lens' AddEndpointsResponse (Maybe Text)

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

addEndpointsResponse_httpStatus :: Lens' AddEndpointsResponse Int

The response's http status code.