amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.AdvertiseByoipCidr

Description

Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).

You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.

We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise it from Amazon Web Services. To minimize down time, you can configure your Amazon Web Services resources to use an address from a BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current location and start advertising it through Amazon Web Services.

It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of BGP propagation delays.

To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.

Synopsis

Creating a Request

data AdvertiseByoipCidr Source #

See: newAdvertiseByoipCidr smart constructor.

Constructors

AdvertiseByoipCidr' 

Fields

  • dryRun :: Maybe Bool

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

  • cidr :: Text

    The address range, in CIDR notation. This must be the exact range that you provisioned. You can't advertise only a portion of the provisioned range.

Instances

Instances details
ToHeaders AdvertiseByoipCidr Source # 
Instance details

Defined in Amazonka.EC2.AdvertiseByoipCidr

ToPath AdvertiseByoipCidr Source # 
Instance details

Defined in Amazonka.EC2.AdvertiseByoipCidr

ToQuery AdvertiseByoipCidr Source # 
Instance details

Defined in Amazonka.EC2.AdvertiseByoipCidr

AWSRequest AdvertiseByoipCidr Source # 
Instance details

Defined in Amazonka.EC2.AdvertiseByoipCidr

Associated Types

type AWSResponse AdvertiseByoipCidr #

Generic AdvertiseByoipCidr Source # 
Instance details

Defined in Amazonka.EC2.AdvertiseByoipCidr

Associated Types

type Rep AdvertiseByoipCidr :: Type -> Type #

Read AdvertiseByoipCidr Source # 
Instance details

Defined in Amazonka.EC2.AdvertiseByoipCidr

Show AdvertiseByoipCidr Source # 
Instance details

Defined in Amazonka.EC2.AdvertiseByoipCidr

NFData AdvertiseByoipCidr Source # 
Instance details

Defined in Amazonka.EC2.AdvertiseByoipCidr

Methods

rnf :: AdvertiseByoipCidr -> () #

Eq AdvertiseByoipCidr Source # 
Instance details

Defined in Amazonka.EC2.AdvertiseByoipCidr

Hashable AdvertiseByoipCidr Source # 
Instance details

Defined in Amazonka.EC2.AdvertiseByoipCidr

type AWSResponse AdvertiseByoipCidr Source # 
Instance details

Defined in Amazonka.EC2.AdvertiseByoipCidr

type Rep AdvertiseByoipCidr Source # 
Instance details

Defined in Amazonka.EC2.AdvertiseByoipCidr

type Rep AdvertiseByoipCidr = D1 ('MetaData "AdvertiseByoipCidr" "Amazonka.EC2.AdvertiseByoipCidr" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "AdvertiseByoipCidr'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "cidr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newAdvertiseByoipCidr Source #

Create a value of AdvertiseByoipCidr 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:dryRun:AdvertiseByoipCidr', advertiseByoipCidr_dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

AdvertiseByoipCidr, advertiseByoipCidr_cidr - The address range, in CIDR notation. This must be the exact range that you provisioned. You can't advertise only a portion of the provisioned range.

Request Lenses

advertiseByoipCidr_dryRun :: Lens' AdvertiseByoipCidr (Maybe Bool) Source #

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

advertiseByoipCidr_cidr :: Lens' AdvertiseByoipCidr Text Source #

The address range, in CIDR notation. This must be the exact range that you provisioned. You can't advertise only a portion of the provisioned range.

Destructuring the Response

data AdvertiseByoipCidrResponse Source #

See: newAdvertiseByoipCidrResponse smart constructor.

Constructors

AdvertiseByoipCidrResponse' 

Fields

Instances

Instances details
Generic AdvertiseByoipCidrResponse Source # 
Instance details

Defined in Amazonka.EC2.AdvertiseByoipCidr

Associated Types

type Rep AdvertiseByoipCidrResponse :: Type -> Type #

Read AdvertiseByoipCidrResponse Source # 
Instance details

Defined in Amazonka.EC2.AdvertiseByoipCidr

Show AdvertiseByoipCidrResponse Source # 
Instance details

Defined in Amazonka.EC2.AdvertiseByoipCidr

NFData AdvertiseByoipCidrResponse Source # 
Instance details

Defined in Amazonka.EC2.AdvertiseByoipCidr

Eq AdvertiseByoipCidrResponse Source # 
Instance details

Defined in Amazonka.EC2.AdvertiseByoipCidr

type Rep AdvertiseByoipCidrResponse Source # 
Instance details

Defined in Amazonka.EC2.AdvertiseByoipCidr

type Rep AdvertiseByoipCidrResponse = D1 ('MetaData "AdvertiseByoipCidrResponse" "Amazonka.EC2.AdvertiseByoipCidr" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "AdvertiseByoipCidrResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "byoipCidr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ByoipCidr)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newAdvertiseByoipCidrResponse Source #

Create a value of AdvertiseByoipCidrResponse 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:byoipCidr:AdvertiseByoipCidrResponse', advertiseByoipCidrResponse_byoipCidr - Information about the address range.

$sel:httpStatus:AdvertiseByoipCidrResponse', advertiseByoipCidrResponse_httpStatus - The response's http status code.

Response Lenses