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.AllowCustomRoutingTraffic

Description

Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that can receive traffic for a custom routing accelerator. You can allow traffic to all destinations in the subnet endpoint, or allow traffic to a specified list of destination IP addresses and ports in the subnet. Note that you cannot specify IP addresses or ports outside of the range that you configured for the endpoint group.

After you make changes, you can verify that the updates are complete by checking the status of your accelerator: the status changes from IN_PROGRESS to DEPLOYED.

Synopsis

Creating a Request

data AllowCustomRoutingTraffic Source #

See: newAllowCustomRoutingTraffic smart constructor.

Constructors

AllowCustomRoutingTraffic' 

Fields

  • destinationAddresses :: Maybe [Text]

    A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to allow to receive traffic. The IP addresses must be a subset of the IP addresses that you specified for the endpoint group.

    DestinationAddresses is required if AllowAllTrafficToEndpoint is FALSE or is not specified.

  • destinationPorts :: Maybe [Natural]

    A list of specific Amazon EC2 instance ports (destination ports) that you want to allow to receive traffic.

  • allowAllTrafficToEndpoint :: Maybe Bool

    Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint can receive traffic from a custom routing accelerator. The value is TRUE or FALSE.

    When set to TRUE, all destinations in the custom routing VPC subnet can receive traffic. Note that you cannot specify destination IP addresses and ports when the value is set to TRUE.

    When set to FALSE (or not specified), you must specify a list of destination IP addresses that are allowed to receive traffic. A list of ports is optional. If you don't specify a list of ports, the ports that can accept traffic is the same as the ports configured for the endpoint group.

    The default value is FALSE.

  • endpointGroupArn :: Text

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

  • endpointId :: Text

    An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.

Instances

Instances details
Eq AllowCustomRoutingTraffic Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.AllowCustomRoutingTraffic

Read AllowCustomRoutingTraffic Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.AllowCustomRoutingTraffic

Show AllowCustomRoutingTraffic Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.AllowCustomRoutingTraffic

Generic AllowCustomRoutingTraffic Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.AllowCustomRoutingTraffic

Associated Types

type Rep AllowCustomRoutingTraffic :: Type -> Type #

NFData AllowCustomRoutingTraffic Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.AllowCustomRoutingTraffic

Hashable AllowCustomRoutingTraffic Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.AllowCustomRoutingTraffic

ToJSON AllowCustomRoutingTraffic Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.AllowCustomRoutingTraffic

AWSRequest AllowCustomRoutingTraffic Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.AllowCustomRoutingTraffic

ToHeaders AllowCustomRoutingTraffic Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.AllowCustomRoutingTraffic

ToPath AllowCustomRoutingTraffic Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.AllowCustomRoutingTraffic

ToQuery AllowCustomRoutingTraffic Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.AllowCustomRoutingTraffic

type Rep AllowCustomRoutingTraffic Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.AllowCustomRoutingTraffic

type Rep AllowCustomRoutingTraffic = D1 ('MetaData "AllowCustomRoutingTraffic" "Amazonka.GlobalAccelerator.AllowCustomRoutingTraffic" "libZSservicesZSamazonka-globalacceleratorZSamazonka-globalaccelerator" 'False) (C1 ('MetaCons "AllowCustomRoutingTraffic'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "destinationAddresses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "destinationPorts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Natural]))) :*: (S1 ('MetaSel ('Just "allowAllTrafficToEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "endpointGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "endpointId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse AllowCustomRoutingTraffic Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.AllowCustomRoutingTraffic

newAllowCustomRoutingTraffic Source #

Create a value of AllowCustomRoutingTraffic 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:destinationAddresses:AllowCustomRoutingTraffic', allowCustomRoutingTraffic_destinationAddresses - A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to allow to receive traffic. The IP addresses must be a subset of the IP addresses that you specified for the endpoint group.

DestinationAddresses is required if AllowAllTrafficToEndpoint is FALSE or is not specified.

$sel:destinationPorts:AllowCustomRoutingTraffic', allowCustomRoutingTraffic_destinationPorts - A list of specific Amazon EC2 instance ports (destination ports) that you want to allow to receive traffic.

$sel:allowAllTrafficToEndpoint:AllowCustomRoutingTraffic', allowCustomRoutingTraffic_allowAllTrafficToEndpoint - Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint can receive traffic from a custom routing accelerator. The value is TRUE or FALSE.

When set to TRUE, all destinations in the custom routing VPC subnet can receive traffic. Note that you cannot specify destination IP addresses and ports when the value is set to TRUE.

When set to FALSE (or not specified), you must specify a list of destination IP addresses that are allowed to receive traffic. A list of ports is optional. If you don't specify a list of ports, the ports that can accept traffic is the same as the ports configured for the endpoint group.

The default value is FALSE.

$sel:endpointGroupArn:AllowCustomRoutingTraffic', allowCustomRoutingTraffic_endpointGroupArn - The Amazon Resource Name (ARN) of the endpoint group.

$sel:endpointId:AllowCustomRoutingTraffic', allowCustomRoutingTraffic_endpointId - An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.

Request Lenses

allowCustomRoutingTraffic_destinationAddresses :: Lens' AllowCustomRoutingTraffic (Maybe [Text]) Source #

A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to allow to receive traffic. The IP addresses must be a subset of the IP addresses that you specified for the endpoint group.

DestinationAddresses is required if AllowAllTrafficToEndpoint is FALSE or is not specified.

allowCustomRoutingTraffic_destinationPorts :: Lens' AllowCustomRoutingTraffic (Maybe [Natural]) Source #

A list of specific Amazon EC2 instance ports (destination ports) that you want to allow to receive traffic.

allowCustomRoutingTraffic_allowAllTrafficToEndpoint :: Lens' AllowCustomRoutingTraffic (Maybe Bool) Source #

Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint can receive traffic from a custom routing accelerator. The value is TRUE or FALSE.

When set to TRUE, all destinations in the custom routing VPC subnet can receive traffic. Note that you cannot specify destination IP addresses and ports when the value is set to TRUE.

When set to FALSE (or not specified), you must specify a list of destination IP addresses that are allowed to receive traffic. A list of ports is optional. If you don't specify a list of ports, the ports that can accept traffic is the same as the ports configured for the endpoint group.

The default value is FALSE.

allowCustomRoutingTraffic_endpointGroupArn :: Lens' AllowCustomRoutingTraffic Text Source #

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

allowCustomRoutingTraffic_endpointId :: Lens' AllowCustomRoutingTraffic Text Source #

An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.

Destructuring the Response

data AllowCustomRoutingTrafficResponse Source #

See: newAllowCustomRoutingTrafficResponse smart constructor.

Instances

Instances details
Eq AllowCustomRoutingTrafficResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.AllowCustomRoutingTraffic

Read AllowCustomRoutingTrafficResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.AllowCustomRoutingTraffic

Show AllowCustomRoutingTrafficResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.AllowCustomRoutingTraffic

Generic AllowCustomRoutingTrafficResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.AllowCustomRoutingTraffic

Associated Types

type Rep AllowCustomRoutingTrafficResponse :: Type -> Type #

NFData AllowCustomRoutingTrafficResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.AllowCustomRoutingTraffic

type Rep AllowCustomRoutingTrafficResponse Source # 
Instance details

Defined in Amazonka.GlobalAccelerator.AllowCustomRoutingTraffic

type Rep AllowCustomRoutingTrafficResponse = D1 ('MetaData "AllowCustomRoutingTrafficResponse" "Amazonka.GlobalAccelerator.AllowCustomRoutingTraffic" "libZSservicesZSamazonka-globalacceleratorZSamazonka-globalaccelerator" 'False) (C1 ('MetaCons "AllowCustomRoutingTrafficResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newAllowCustomRoutingTrafficResponse :: AllowCustomRoutingTrafficResponse Source #

Create a value of AllowCustomRoutingTrafficResponse with all optional fields omitted.

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