libZSservicesZSamazonka-globalacceleratorZSamazonka-globalaccelerator
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.GlobalAccelerator.CreateCustomRoutingAccelerator

Description

Create a custom routing accelerator. A custom routing accelerator directs traffic to one of possibly thousands of Amazon EC2 instance destinations running in a single or multiple virtual private clouds (VPC) subnet endpoints.

Be aware that, by default, all destination EC2 instances in a VPC subnet endpoint cannot receive traffic. To enable all destinations to receive traffic, or to specify individual port mappings that can receive traffic, see the AllowCustomRoutingTraffic operation.

Global Accelerator is a global service that supports endpoints in multiple AWS Regions but you must specify the US West (Oregon) Region to create or update accelerators.

Synopsis

Creating a Request

data CreateCustomRoutingAccelerator Source #

See: newCreateCustomRoutingAccelerator smart constructor.

Constructors

CreateCustomRoutingAccelerator' 

Fields

  • enabled :: Maybe Bool

    Indicates whether an accelerator is enabled. The value is true or false. The default value is true.

    If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.

  • ipAddressType :: Maybe IpAddressType

    The value for the address type must be IPv4.

  • tags :: Maybe [Tag]

    Create tags for an accelerator.

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

  • ipAddresses :: Maybe [Text]

    Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose IP addresses from your own pool to use for the accelerator's static IP addresses when you create an accelerator. You can specify one or two addresses, separated by a space. Do not include the /32 suffix.

    Only one IP address from each of your IP address ranges can be used for each accelerator. If you specify only one IP address from your IP address range, Global Accelerator assigns a second static IP address for the accelerator from the AWS IP address pool.

    Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses.

    For more information, see Bring your own IP addresses (BYOIP) in the AWS Global Accelerator Developer Guide.

  • name :: Text

    The name of a custom routing accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

  • idempotencyToken :: Text

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

Instances

Instances details
Eq CreateCustomRoutingAccelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateCustomRoutingAccelerator

Methods

(==) :: CreateCustomRoutingAccelerator -> CreateCustomRoutingAccelerator -> Bool #

(/=) :: CreateCustomRoutingAccelerator -> CreateCustomRoutingAccelerator -> Bool #

Read CreateCustomRoutingAccelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateCustomRoutingAccelerator

Methods

readsPrec :: Int -> ReadS CreateCustomRoutingAccelerator #

readList :: ReadS [CreateCustomRoutingAccelerator] #

readPrec :: ReadPrec CreateCustomRoutingAccelerator #

readListPrec :: ReadPrec [CreateCustomRoutingAccelerator] #

Show CreateCustomRoutingAccelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateCustomRoutingAccelerator

Methods

showsPrec :: Int -> CreateCustomRoutingAccelerator -> ShowS #

show :: CreateCustomRoutingAccelerator -> String #

showList :: [CreateCustomRoutingAccelerator] -> ShowS #

Generic CreateCustomRoutingAccelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateCustomRoutingAccelerator

Associated Types

type Rep CreateCustomRoutingAccelerator :: Type -> Type #

Methods

from :: CreateCustomRoutingAccelerator -> Rep CreateCustomRoutingAccelerator x #

to :: Rep CreateCustomRoutingAccelerator x -> CreateCustomRoutingAccelerator #

NFData CreateCustomRoutingAccelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateCustomRoutingAccelerator

Methods

rnf :: CreateCustomRoutingAccelerator -> () #

Hashable CreateCustomRoutingAccelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateCustomRoutingAccelerator

Methods

hashWithSalt :: Int -> CreateCustomRoutingAccelerator -> Int #

hash :: CreateCustomRoutingAccelerator -> Int #

ToJSON CreateCustomRoutingAccelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateCustomRoutingAccelerator

Methods

toJSON :: CreateCustomRoutingAccelerator -> Value #

toEncoding :: CreateCustomRoutingAccelerator -> Encoding #

toJSONList :: [CreateCustomRoutingAccelerator] -> Value #

toEncodingList :: [CreateCustomRoutingAccelerator] -> Encoding #

AWSRequest CreateCustomRoutingAccelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateCustomRoutingAccelerator

Associated Types

type AWSResponse CreateCustomRoutingAccelerator #

Methods

request :: CreateCustomRoutingAccelerator -> Request CreateCustomRoutingAccelerator #

response :: MonadResource m => Logger -> Service -> Proxy CreateCustomRoutingAccelerator -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateCustomRoutingAccelerator))) #

ToHeaders CreateCustomRoutingAccelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateCustomRoutingAccelerator

Methods

toHeaders :: CreateCustomRoutingAccelerator -> [Header] #

ToPath CreateCustomRoutingAccelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateCustomRoutingAccelerator

Methods

toPath :: CreateCustomRoutingAccelerator -> ByteString #

ToQuery CreateCustomRoutingAccelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateCustomRoutingAccelerator

Methods

toQuery :: CreateCustomRoutingAccelerator -> QueryString #

type Rep CreateCustomRoutingAccelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateCustomRoutingAccelerator

type Rep CreateCustomRoutingAccelerator = D1 ('MetaData "CreateCustomRoutingAccelerator" "Amazonka.GlobalAccelerator.CreateCustomRoutingAccelerator" "libZSservicesZSamazonka-globalacceleratorZSamazonka-globalaccelerator" 'False) (C1 ('MetaCons "CreateCustomRoutingAccelerator'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "ipAddressType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IpAddressType)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :*: (S1 ('MetaSel ('Just "ipAddresses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "idempotencyToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateCustomRoutingAccelerator Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateCustomRoutingAccelerator

type AWSResponse CreateCustomRoutingAccelerator = CreateCustomRoutingAcceleratorResponse

newCreateCustomRoutingAccelerator Source #

Arguments

:: Text

$sel:name:CreateCustomRoutingAccelerator'

-> Text

$sel:idempotencyToken:CreateCustomRoutingAccelerator'

-> CreateCustomRoutingAccelerator 

Create a value of CreateCustomRoutingAccelerator 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:enabled:CreateCustomRoutingAccelerator', createCustomRoutingAccelerator_enabled - Indicates whether an accelerator is enabled. The value is true or false. The default value is true.

If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.

$sel:ipAddressType:CreateCustomRoutingAccelerator', createCustomRoutingAccelerator_ipAddressType - The value for the address type must be IPv4.

$sel:tags:CreateCustomRoutingAccelerator', createCustomRoutingAccelerator_tags - Create tags for an accelerator.

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

$sel:ipAddresses:CreateCustomRoutingAccelerator', createCustomRoutingAccelerator_ipAddresses - Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose IP addresses from your own pool to use for the accelerator's static IP addresses when you create an accelerator. You can specify one or two addresses, separated by a space. Do not include the /32 suffix.

Only one IP address from each of your IP address ranges can be used for each accelerator. If you specify only one IP address from your IP address range, Global Accelerator assigns a second static IP address for the accelerator from the AWS IP address pool.

Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses.

For more information, see Bring your own IP addresses (BYOIP) in the AWS Global Accelerator Developer Guide.

$sel:name:CreateCustomRoutingAccelerator', createCustomRoutingAccelerator_name - The name of a custom routing accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

$sel:idempotencyToken:CreateCustomRoutingAccelerator', createCustomRoutingAccelerator_idempotencyToken - A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

Request Lenses

createCustomRoutingAccelerator_enabled :: Lens' CreateCustomRoutingAccelerator (Maybe Bool) Source #

Indicates whether an accelerator is enabled. The value is true or false. The default value is true.

If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.

createCustomRoutingAccelerator_ipAddressType :: Lens' CreateCustomRoutingAccelerator (Maybe IpAddressType) Source #

The value for the address type must be IPv4.

createCustomRoutingAccelerator_tags :: Lens' CreateCustomRoutingAccelerator (Maybe [Tag]) Source #

Create tags for an accelerator.

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

createCustomRoutingAccelerator_ipAddresses :: Lens' CreateCustomRoutingAccelerator (Maybe [Text]) Source #

Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose IP addresses from your own pool to use for the accelerator's static IP addresses when you create an accelerator. You can specify one or two addresses, separated by a space. Do not include the /32 suffix.

Only one IP address from each of your IP address ranges can be used for each accelerator. If you specify only one IP address from your IP address range, Global Accelerator assigns a second static IP address for the accelerator from the AWS IP address pool.

Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses.

For more information, see Bring your own IP addresses (BYOIP) in the AWS Global Accelerator Developer Guide.

createCustomRoutingAccelerator_name :: Lens' CreateCustomRoutingAccelerator Text Source #

The name of a custom routing accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

createCustomRoutingAccelerator_idempotencyToken :: Lens' CreateCustomRoutingAccelerator Text Source #

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

Destructuring the Response

data CreateCustomRoutingAcceleratorResponse Source #

See: newCreateCustomRoutingAcceleratorResponse smart constructor.

Constructors

CreateCustomRoutingAcceleratorResponse' 

Fields

Instances

Instances details
Eq CreateCustomRoutingAcceleratorResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateCustomRoutingAccelerator

Methods

(==) :: CreateCustomRoutingAcceleratorResponse -> CreateCustomRoutingAcceleratorResponse -> Bool #

(/=) :: CreateCustomRoutingAcceleratorResponse -> CreateCustomRoutingAcceleratorResponse -> Bool #

Read CreateCustomRoutingAcceleratorResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateCustomRoutingAccelerator

Methods

readsPrec :: Int -> ReadS CreateCustomRoutingAcceleratorResponse #

readList :: ReadS [CreateCustomRoutingAcceleratorResponse] #

readPrec :: ReadPrec CreateCustomRoutingAcceleratorResponse #

readListPrec :: ReadPrec [CreateCustomRoutingAcceleratorResponse] #

Show CreateCustomRoutingAcceleratorResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateCustomRoutingAccelerator

Methods

showsPrec :: Int -> CreateCustomRoutingAcceleratorResponse -> ShowS #

show :: CreateCustomRoutingAcceleratorResponse -> String #

showList :: [CreateCustomRoutingAcceleratorResponse] -> ShowS #

Generic CreateCustomRoutingAcceleratorResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateCustomRoutingAccelerator

Associated Types

type Rep CreateCustomRoutingAcceleratorResponse :: Type -> Type #

Methods

from :: CreateCustomRoutingAcceleratorResponse -> Rep CreateCustomRoutingAcceleratorResponse x #

to :: Rep CreateCustomRoutingAcceleratorResponse x -> CreateCustomRoutingAcceleratorResponse #

NFData CreateCustomRoutingAcceleratorResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateCustomRoutingAccelerator

Methods

rnf :: CreateCustomRoutingAcceleratorResponse -> () #

type Rep CreateCustomRoutingAcceleratorResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.CreateCustomRoutingAccelerator

type Rep CreateCustomRoutingAcceleratorResponse = D1 ('MetaData "CreateCustomRoutingAcceleratorResponse" "Amazonka.GlobalAccelerator.CreateCustomRoutingAccelerator" "libZSservicesZSamazonka-globalacceleratorZSamazonka-globalaccelerator" 'False) (C1 ('MetaCons "CreateCustomRoutingAcceleratorResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accelerator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomRoutingAccelerator)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateCustomRoutingAcceleratorResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateCustomRoutingAcceleratorResponse'

-> CreateCustomRoutingAcceleratorResponse 

Create a value of CreateCustomRoutingAcceleratorResponse 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:accelerator:CreateCustomRoutingAcceleratorResponse', createCustomRoutingAcceleratorResponse_accelerator - The accelerator that is created.

$sel:httpStatus:CreateCustomRoutingAcceleratorResponse', createCustomRoutingAcceleratorResponse_httpStatus - The response's http status code.

Response Lenses

createCustomRoutingAcceleratorResponse_accelerator :: Lens' CreateCustomRoutingAcceleratorResponse (Maybe CustomRoutingAccelerator) Source #

The accelerator that is created.

createCustomRoutingAcceleratorResponse_httpStatus :: Lens' CreateCustomRoutingAcceleratorResponse Int Source #

The response's http status code.