Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.GlobalAccelerator.CreateAccelerator

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers.

Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2 on AWS CLI commands.

Synopsis

data CreateAccelerator = CreateAccelerator' {
- enabled :: Maybe Bool
- ipAddressType :: Maybe IpAddressType
- ipAddresses :: Maybe [Text]
- tags :: Maybe [Tag]
- name :: Text
- idempotencyToken :: Text
}
newCreateAccelerator :: Text -> Text -> CreateAccelerator
createAccelerator_enabled :: Lens' CreateAccelerator (Maybe Bool)
createAccelerator_ipAddressType :: Lens' CreateAccelerator (Maybe IpAddressType)
createAccelerator_ipAddresses :: Lens' CreateAccelerator (Maybe [Text])
createAccelerator_tags :: Lens' CreateAccelerator (Maybe [Tag])
createAccelerator_name :: Lens' CreateAccelerator Text
createAccelerator_idempotencyToken :: Lens' CreateAccelerator Text
data CreateAcceleratorResponse = CreateAcceleratorResponse' {
- accelerator :: Maybe Accelerator
- httpStatus :: Int
}
newCreateAcceleratorResponse :: Int -> CreateAcceleratorResponse
createAcceleratorResponse_accelerator :: Lens' CreateAcceleratorResponse (Maybe Accelerator)
createAcceleratorResponse_httpStatus :: Lens' CreateAcceleratorResponse Int

Creating a Request

data CreateAccelerator Source #

See: newCreateAccelerator smart constructor.

Constructors

CreateAccelerator'

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 IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.
ipAddresses :: Maybe [Text]
Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address from your own pool to use for the accelerator's static IPv4 address when you create an accelerator.
After you bring an address range to Amazon Web Services, it appears in your account as an address pool. When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges to Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is because Global Accelerator assigns each address range to a different network zone, for high availability.
You can specify one or two addresses, separated by a space. Do not include the /32 suffix.
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 Global Accelerator Developer Guide.
tags :: Maybe [Tag]
Create tags for an accelerator.
For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.
name :: Text
The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters, periods (.), or hyphens (-), and must not begin or end with a hyphen or period.
idempotencyToken :: Text
A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of an accelerator.

Instances

Instances details

ToJSON CreateAccelerator Source #
Instance details Defined in Amazonka.GlobalAccelerator.CreateAccelerator Methods toJSON :: CreateAccelerator -> Value # toEncoding :: CreateAccelerator -> Encoding # toJSONList :: [CreateAccelerator] -> Value # toEncodingList :: [CreateAccelerator] -> Encoding #
ToHeaders CreateAccelerator Source #
Instance details Defined in Amazonka.GlobalAccelerator.CreateAccelerator Methods toHeaders :: CreateAccelerator -> [Header] #
ToPath CreateAccelerator Source #
Instance details Defined in Amazonka.GlobalAccelerator.CreateAccelerator Methods toPath :: CreateAccelerator -> ByteString #
ToQuery CreateAccelerator Source #
Instance details Defined in Amazonka.GlobalAccelerator.CreateAccelerator Methods toQuery :: CreateAccelerator -> QueryString #
AWSRequest CreateAccelerator Source #
Instance details Defined in Amazonka.GlobalAccelerator.CreateAccelerator Associated Types type AWSResponse CreateAccelerator # Methods request :: (Service -> Service) -> CreateAccelerator -> Request CreateAccelerator # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateAccelerator -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateAccelerator))) #
Generic CreateAccelerator Source #
Instance details Defined in Amazonka.GlobalAccelerator.CreateAccelerator Associated Types type Rep CreateAccelerator :: Type -> Type # Methods from :: CreateAccelerator -> Rep CreateAccelerator x # to :: Rep CreateAccelerator x -> CreateAccelerator #
Read CreateAccelerator Source #
Instance details Defined in Amazonka.GlobalAccelerator.CreateAccelerator Methods readsPrec :: Int -> ReadS CreateAccelerator # readList :: ReadS [CreateAccelerator] # readPrec :: ReadPrec CreateAccelerator # readListPrec :: ReadPrec [CreateAccelerator] #
Show CreateAccelerator Source #
Instance details Defined in Amazonka.GlobalAccelerator.CreateAccelerator Methods showsPrec :: Int -> CreateAccelerator -> ShowS # show :: CreateAccelerator -> String # showList :: [CreateAccelerator] -> ShowS #
NFData CreateAccelerator Source #
Instance details Defined in Amazonka.GlobalAccelerator.CreateAccelerator Methods rnf :: CreateAccelerator -> () #
Eq CreateAccelerator Source #
Instance details Defined in Amazonka.GlobalAccelerator.CreateAccelerator Methods (==) :: CreateAccelerator -> CreateAccelerator -> Bool # (/=) :: CreateAccelerator -> CreateAccelerator -> Bool #
Hashable CreateAccelerator Source #
Instance details Defined in Amazonka.GlobalAccelerator.CreateAccelerator Methods hashWithSalt :: Int -> CreateAccelerator -> Int # hash :: CreateAccelerator -> Int #
type AWSResponse CreateAccelerator Source #
Instance details Defined in Amazonka.GlobalAccelerator.CreateAccelerator type AWSResponse CreateAccelerator = CreateAcceleratorResponse
type Rep CreateAccelerator Source #
Instance details Defined in Amazonka.GlobalAccelerator.CreateAccelerator type Rep CreateAccelerator = D1 ('MetaData "CreateAccelerator" "Amazonka.GlobalAccelerator.CreateAccelerator" "amazonka-globalaccelerator-2.0-5CEURNOKFgU1mORtBGQfFs" 'False) (C1 ('MetaCons "CreateAccelerator'" '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 "ipAddresses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "idempotencyToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateAccelerator Source #

Arguments

:: Text	`CreateAccelerator`
-> Text	`$sel:idempotencyToken:CreateAccelerator'`
-> CreateAccelerator

Create a value of CreateAccelerator 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:

CreateAccelerator, createAccelerator_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.

CreateAccelerator, createAccelerator_ipAddressType - The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.

CreateAccelerator, createAccelerator_ipAddresses - Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address from your own pool to use for the accelerator's static IPv4 address when you create an accelerator.

After you bring an address range to Amazon Web Services, it appears in your account as an address pool. When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges to Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is because Global Accelerator assigns each address range to a different network zone, for high availability.

You can specify one or two addresses, separated by a space. Do not include the /32 suffix.

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 Global Accelerator Developer Guide.

$sel:tags:CreateAccelerator', createAccelerator_tags - Create tags for an accelerator.

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

CreateAccelerator, createAccelerator_name - The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters, periods (.), or hyphens (-), and must not begin or end with a hyphen or period.

$sel:idempotencyToken:CreateAccelerator', createAccelerator_idempotencyToken - A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of an accelerator.

Request Lenses

createAccelerator_enabled :: Lens' CreateAccelerator (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.

createAccelerator_ipAddressType :: Lens' CreateAccelerator (Maybe IpAddressType) Source #

The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.

createAccelerator_ipAddresses :: Lens' CreateAccelerator (Maybe [Text]) Source #

Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address from your own pool to use for the accelerator's static IPv4 address when you create an accelerator.

After you bring an address range to Amazon Web Services, it appears in your account as an address pool. When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges to Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is because Global Accelerator assigns each address range to a different network zone, for high availability.

You can specify one or two addresses, separated by a space. Do not include the /32 suffix.

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 Global Accelerator Developer Guide.

createAccelerator_tags :: Lens' CreateAccelerator (Maybe [Tag]) Source #

Create tags for an accelerator.

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

createAccelerator_name :: Lens' CreateAccelerator Text Source #

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

createAccelerator_idempotencyToken :: Lens' CreateAccelerator Text Source #

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

Destructuring the Response

data CreateAcceleratorResponse Source #

See: newCreateAcceleratorResponse smart constructor.

Constructors

CreateAcceleratorResponse'
Fields accelerator :: Maybe Accelerator The accelerator that is created by specifying a listener and the supported IP address types. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateAcceleratorResponse Source #
Instance details Defined in Amazonka.GlobalAccelerator.CreateAccelerator Associated Types type Rep CreateAcceleratorResponse :: Type -> Type # Methods from :: CreateAcceleratorResponse -> Rep CreateAcceleratorResponse x # to :: Rep CreateAcceleratorResponse x -> CreateAcceleratorResponse #
Read CreateAcceleratorResponse Source #
Instance details Defined in Amazonka.GlobalAccelerator.CreateAccelerator Methods readsPrec :: Int -> ReadS CreateAcceleratorResponse # readList :: ReadS [CreateAcceleratorResponse] # readPrec :: ReadPrec CreateAcceleratorResponse # readListPrec :: ReadPrec [CreateAcceleratorResponse] #
Show CreateAcceleratorResponse Source #
Instance details Defined in Amazonka.GlobalAccelerator.CreateAccelerator Methods showsPrec :: Int -> CreateAcceleratorResponse -> ShowS # show :: CreateAcceleratorResponse -> String # showList :: [CreateAcceleratorResponse] -> ShowS #
NFData CreateAcceleratorResponse Source #
Instance details Defined in Amazonka.GlobalAccelerator.CreateAccelerator Methods rnf :: CreateAcceleratorResponse -> () #
Eq CreateAcceleratorResponse Source #
Instance details Defined in Amazonka.GlobalAccelerator.CreateAccelerator Methods (==) :: CreateAcceleratorResponse -> CreateAcceleratorResponse -> Bool # (/=) :: CreateAcceleratorResponse -> CreateAcceleratorResponse -> Bool #
type Rep CreateAcceleratorResponse Source #
Instance details Defined in Amazonka.GlobalAccelerator.CreateAccelerator type Rep CreateAcceleratorResponse = D1 ('MetaData "CreateAcceleratorResponse" "Amazonka.GlobalAccelerator.CreateAccelerator" "amazonka-globalaccelerator-2.0-5CEURNOKFgU1mORtBGQfFs" 'False) (C1 ('MetaCons "CreateAcceleratorResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accelerator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Accelerator)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateAcceleratorResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateAcceleratorResponse'`
-> CreateAcceleratorResponse

Create a value of CreateAcceleratorResponse 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:CreateAcceleratorResponse', createAcceleratorResponse_accelerator - The accelerator that is created by specifying a listener and the supported IP address types.

$sel:httpStatus:CreateAcceleratorResponse', createAcceleratorResponse_httpStatus - The response's http status code.

Response Lenses

createAcceleratorResponse_accelerator :: Lens' CreateAcceleratorResponse (Maybe Accelerator) Source #

The accelerator that is created by specifying a listener and the supported IP address types.

createAcceleratorResponse_httpStatus :: Lens' CreateAcceleratorResponse Int Source #

The response's http status code.