| 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.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 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 CreateCustomRoutingAccelerator = CreateCustomRoutingAccelerator' {
- enabled :: Maybe Bool
- ipAddressType :: Maybe IpAddressType
- ipAddresses :: Maybe [Text]
- tags :: Maybe [Tag]
- name :: Text
- idempotencyToken :: Text
- newCreateCustomRoutingAccelerator :: Text -> Text -> CreateCustomRoutingAccelerator
- createCustomRoutingAccelerator_enabled :: Lens' CreateCustomRoutingAccelerator (Maybe Bool)
- createCustomRoutingAccelerator_ipAddressType :: Lens' CreateCustomRoutingAccelerator (Maybe IpAddressType)
- createCustomRoutingAccelerator_ipAddresses :: Lens' CreateCustomRoutingAccelerator (Maybe [Text])
- createCustomRoutingAccelerator_tags :: Lens' CreateCustomRoutingAccelerator (Maybe [Tag])
- createCustomRoutingAccelerator_name :: Lens' CreateCustomRoutingAccelerator Text
- createCustomRoutingAccelerator_idempotencyToken :: Lens' CreateCustomRoutingAccelerator Text
- data CreateCustomRoutingAcceleratorResponse = CreateCustomRoutingAcceleratorResponse' {}
- newCreateCustomRoutingAcceleratorResponse :: Int -> CreateCustomRoutingAcceleratorResponse
- createCustomRoutingAcceleratorResponse_accelerator :: Lens' CreateCustomRoutingAcceleratorResponse (Maybe CustomRoutingAccelerator)
- createCustomRoutingAcceleratorResponse_httpStatus :: Lens' CreateCustomRoutingAcceleratorResponse Int
Creating a Request
data CreateCustomRoutingAccelerator Source #
See: newCreateCustomRoutingAccelerator smart constructor.
Constructors
| CreateCustomRoutingAccelerator' | |
Fields
| |
Instances
newCreateCustomRoutingAccelerator Source #
Arguments
| :: Text | |
| -> Text | |
| -> 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:
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.
CreateCustomRoutingAccelerator, createCustomRoutingAccelerator_ipAddressType - The IP address type that an accelerator supports. For a custom routing
accelerator, the value must be IPV4.
CreateCustomRoutingAccelerator, createCustomRoutingAccelerator_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:CreateCustomRoutingAccelerator', createCustomRoutingAccelerator_tags - Create tags for an accelerator.
For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.
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 IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.
createCustomRoutingAccelerator_ipAddresses :: Lens' CreateCustomRoutingAccelerator (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.
createCustomRoutingAccelerator_tags :: Lens' CreateCustomRoutingAccelerator (Maybe [Tag]) Source #
Create tags for an accelerator.
For more information, see Tagging in Global Accelerator in the 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
newCreateCustomRoutingAcceleratorResponse Source #
Arguments
| :: Int | |
| -> 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.