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.EC2.AssociateVpcCidrBlock

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP). The IPv6 CIDR block size is fixed at /56.

You must specify one of the following in the request: an IPv4 CIDR block, an IPv6 pool, or an Amazon-provided IPv6 CIDR block.

For more information about associating CIDR blocks with your VPC and applicable restrictions, see VPC and subnet sizing in the Amazon Virtual Private Cloud User Guide.

Synopsis

Creating a Request

data AssociateVpcCidrBlock Source #

See: newAssociateVpcCidrBlock smart constructor.

Constructors

AssociateVpcCidrBlock'

Fields

amazonProvidedIpv6CidrBlock :: Maybe Bool
Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block.
cidrBlock :: Maybe Text
An IPv4 CIDR block to associate with the VPC.
ipv4IpamPoolId :: Maybe Text
Associate a CIDR allocated from an IPv4 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? in the Amazon VPC IPAM User Guide.
ipv4NetmaskLength :: Maybe Int
The netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.
ipv6CidrBlock :: Maybe Text
An IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.
To let Amazon choose the IPv6 CIDR block for you, omit this parameter.
ipv6CidrBlockNetworkBorderGroup :: Maybe Text
The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the CIDR block to this location.
You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.
You can have one IPv6 CIDR block association per network border group.
ipv6IpamPoolId :: Maybe Text
Associates a CIDR allocated from an IPv6 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? in the Amazon VPC IPAM User Guide.
ipv6NetmaskLength :: Maybe Int
The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.
ipv6Pool :: Maybe Text
The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
vpcId :: Text
The ID of the VPC.

Instances

Instances details

ToHeaders AssociateVpcCidrBlock Source #
Instance details Defined in Amazonka.EC2.AssociateVpcCidrBlock Methods toHeaders :: AssociateVpcCidrBlock -> [Header] #
ToPath AssociateVpcCidrBlock Source #
Instance details Defined in Amazonka.EC2.AssociateVpcCidrBlock Methods toPath :: AssociateVpcCidrBlock -> ByteString #
ToQuery AssociateVpcCidrBlock Source #
Instance details Defined in Amazonka.EC2.AssociateVpcCidrBlock Methods toQuery :: AssociateVpcCidrBlock -> QueryString #
AWSRequest AssociateVpcCidrBlock Source #
Instance details Defined in Amazonka.EC2.AssociateVpcCidrBlock Associated Types type AWSResponse AssociateVpcCidrBlock # Methods request :: (Service -> Service) -> AssociateVpcCidrBlock -> Request AssociateVpcCidrBlock # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AssociateVpcCidrBlock -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AssociateVpcCidrBlock))) #
Generic AssociateVpcCidrBlock Source #
Instance details Defined in Amazonka.EC2.AssociateVpcCidrBlock Associated Types type Rep AssociateVpcCidrBlock :: Type -> Type # Methods from :: AssociateVpcCidrBlock -> Rep AssociateVpcCidrBlock x # to :: Rep AssociateVpcCidrBlock x -> AssociateVpcCidrBlock #
Read AssociateVpcCidrBlock Source #
Instance details Defined in Amazonka.EC2.AssociateVpcCidrBlock Methods readsPrec :: Int -> ReadS AssociateVpcCidrBlock # readList :: ReadS [AssociateVpcCidrBlock] # readPrec :: ReadPrec AssociateVpcCidrBlock # readListPrec :: ReadPrec [AssociateVpcCidrBlock] #
Show AssociateVpcCidrBlock Source #
Instance details Defined in Amazonka.EC2.AssociateVpcCidrBlock Methods showsPrec :: Int -> AssociateVpcCidrBlock -> ShowS # show :: AssociateVpcCidrBlock -> String # showList :: [AssociateVpcCidrBlock] -> ShowS #
NFData AssociateVpcCidrBlock Source #
Instance details Defined in Amazonka.EC2.AssociateVpcCidrBlock Methods rnf :: AssociateVpcCidrBlock -> () #
Eq AssociateVpcCidrBlock Source #
Instance details Defined in Amazonka.EC2.AssociateVpcCidrBlock Methods (==) :: AssociateVpcCidrBlock -> AssociateVpcCidrBlock -> Bool # (/=) :: AssociateVpcCidrBlock -> AssociateVpcCidrBlock -> Bool #
Hashable AssociateVpcCidrBlock Source #
Instance details Defined in Amazonka.EC2.AssociateVpcCidrBlock Methods hashWithSalt :: Int -> AssociateVpcCidrBlock -> Int # hash :: AssociateVpcCidrBlock -> Int #
type AWSResponse AssociateVpcCidrBlock Source #
Instance details Defined in Amazonka.EC2.AssociateVpcCidrBlock type AWSResponse AssociateVpcCidrBlock = AssociateVpcCidrBlockResponse
type Rep AssociateVpcCidrBlock Source #
Instance details Defined in Amazonka.EC2.AssociateVpcCidrBlock type Rep AssociateVpcCidrBlock = D1 ('MetaData "AssociateVpcCidrBlock" "Amazonka.EC2.AssociateVpcCidrBlock" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "AssociateVpcCidrBlock'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "amazonProvidedIpv6CidrBlock") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "cidrBlock") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "ipv4IpamPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "ipv4NetmaskLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "ipv6CidrBlock") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "ipv6CidrBlockNetworkBorderGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "ipv6IpamPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "ipv6NetmaskLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "ipv6Pool") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newAssociateVpcCidrBlock Source #

Arguments

:: Text	`AssociateVpcCidrBlock`
-> AssociateVpcCidrBlock

Create a value of AssociateVpcCidrBlock 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:amazonProvidedIpv6CidrBlock:AssociateVpcCidrBlock', associateVpcCidrBlock_amazonProvidedIpv6CidrBlock - Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block.

AssociateVpcCidrBlock, associateVpcCidrBlock_cidrBlock - An IPv4 CIDR block to associate with the VPC.

$sel:ipv4IpamPoolId:AssociateVpcCidrBlock', associateVpcCidrBlock_ipv4IpamPoolId - Associate a CIDR allocated from an IPv4 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? in the Amazon VPC IPAM User Guide.

$sel:ipv4NetmaskLength:AssociateVpcCidrBlock', associateVpcCidrBlock_ipv4NetmaskLength - The netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.

AssociateVpcCidrBlock, associateVpcCidrBlock_ipv6CidrBlock - An IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.

To let Amazon choose the IPv6 CIDR block for you, omit this parameter.

$sel:ipv6CidrBlockNetworkBorderGroup:AssociateVpcCidrBlock', associateVpcCidrBlock_ipv6CidrBlockNetworkBorderGroup - The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the CIDR block to this location.

You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.

You can have one IPv6 CIDR block association per network border group.

$sel:ipv6IpamPoolId:AssociateVpcCidrBlock', associateVpcCidrBlock_ipv6IpamPoolId - Associates a CIDR allocated from an IPv6 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? in the Amazon VPC IPAM User Guide.

$sel:ipv6NetmaskLength:AssociateVpcCidrBlock', associateVpcCidrBlock_ipv6NetmaskLength - The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.

AssociateVpcCidrBlock, associateVpcCidrBlock_ipv6Pool - The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.

AssociateVpcCidrBlock, associateVpcCidrBlock_vpcId - The ID of the VPC.

Request Lenses

associateVpcCidrBlock_amazonProvidedIpv6CidrBlock :: Lens' AssociateVpcCidrBlock (Maybe Bool) Source #

Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block.

associateVpcCidrBlock_cidrBlock :: Lens' AssociateVpcCidrBlock (Maybe Text) Source #

An IPv4 CIDR block to associate with the VPC.

associateVpcCidrBlock_ipv4IpamPoolId :: Lens' AssociateVpcCidrBlock (Maybe Text) Source #

Associate a CIDR allocated from an IPv4 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? in the Amazon VPC IPAM User Guide.

associateVpcCidrBlock_ipv4NetmaskLength :: Lens' AssociateVpcCidrBlock (Maybe Int) Source #

The netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.

associateVpcCidrBlock_ipv6CidrBlock :: Lens' AssociateVpcCidrBlock (Maybe Text) Source #

An IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.

To let Amazon choose the IPv6 CIDR block for you, omit this parameter.

associateVpcCidrBlock_ipv6CidrBlockNetworkBorderGroup :: Lens' AssociateVpcCidrBlock (Maybe Text) Source #

The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the CIDR block to this location.

You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.

You can have one IPv6 CIDR block association per network border group.

associateVpcCidrBlock_ipv6IpamPoolId :: Lens' AssociateVpcCidrBlock (Maybe Text) Source #

Associates a CIDR allocated from an IPv6 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? in the Amazon VPC IPAM User Guide.

associateVpcCidrBlock_ipv6NetmaskLength :: Lens' AssociateVpcCidrBlock (Maybe Int) Source #

The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.

associateVpcCidrBlock_ipv6Pool :: Lens' AssociateVpcCidrBlock (Maybe Text) Source #

The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.

associateVpcCidrBlock_vpcId :: Lens' AssociateVpcCidrBlock Text Source #

The ID of the VPC.

Destructuring the Response

data AssociateVpcCidrBlockResponse Source #

See: newAssociateVpcCidrBlockResponse smart constructor.

Constructors

AssociateVpcCidrBlockResponse'
Fields cidrBlockAssociation :: Maybe VpcCidrBlockAssociation Information about the IPv4 CIDR block association. ipv6CidrBlockAssociation :: Maybe VpcIpv6CidrBlockAssociation Information about the IPv6 CIDR block association. vpcId :: Maybe Text The ID of the VPC. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic AssociateVpcCidrBlockResponse Source #
Instance details Defined in Amazonka.EC2.AssociateVpcCidrBlock Associated Types type Rep AssociateVpcCidrBlockResponse :: Type -> Type # Methods from :: AssociateVpcCidrBlockResponse -> Rep AssociateVpcCidrBlockResponse x # to :: Rep AssociateVpcCidrBlockResponse x -> AssociateVpcCidrBlockResponse #
Read AssociateVpcCidrBlockResponse Source #
Instance details Defined in Amazonka.EC2.AssociateVpcCidrBlock Methods readsPrec :: Int -> ReadS AssociateVpcCidrBlockResponse # readList :: ReadS [AssociateVpcCidrBlockResponse] # readPrec :: ReadPrec AssociateVpcCidrBlockResponse # readListPrec :: ReadPrec [AssociateVpcCidrBlockResponse] #
Show AssociateVpcCidrBlockResponse Source #
Instance details Defined in Amazonka.EC2.AssociateVpcCidrBlock Methods showsPrec :: Int -> AssociateVpcCidrBlockResponse -> ShowS # show :: AssociateVpcCidrBlockResponse -> String # showList :: [AssociateVpcCidrBlockResponse] -> ShowS #
NFData AssociateVpcCidrBlockResponse Source #
Instance details Defined in Amazonka.EC2.AssociateVpcCidrBlock Methods rnf :: AssociateVpcCidrBlockResponse -> () #
Eq AssociateVpcCidrBlockResponse Source #
Instance details Defined in Amazonka.EC2.AssociateVpcCidrBlock Methods (==) :: AssociateVpcCidrBlockResponse -> AssociateVpcCidrBlockResponse -> Bool # (/=) :: AssociateVpcCidrBlockResponse -> AssociateVpcCidrBlockResponse -> Bool #
type Rep AssociateVpcCidrBlockResponse Source #
Instance details Defined in Amazonka.EC2.AssociateVpcCidrBlock type Rep AssociateVpcCidrBlockResponse = D1 ('MetaData "AssociateVpcCidrBlockResponse" "Amazonka.EC2.AssociateVpcCidrBlock" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "AssociateVpcCidrBlockResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cidrBlockAssociation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcCidrBlockAssociation)) :: S1 ('MetaSel ('Just "ipv6CidrBlockAssociation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcIpv6CidrBlockAssociation))) :: (S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))