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.Types.Subnet

Description

Synopsis

data Subnet = Subnet' {
- assignIpv6AddressOnCreation :: Maybe Bool
- availabilityZoneId :: Maybe Text
- customerOwnedIpv4Pool :: Maybe Text
- defaultForAz :: Maybe Bool
- enableDns64 :: Maybe Bool
- enableLniAtDeviceIndex :: Maybe Int
- ipv6CidrBlockAssociationSet :: Maybe [SubnetIpv6CidrBlockAssociation]
- ipv6Native :: Maybe Bool
- mapCustomerOwnedIpOnLaunch :: Maybe Bool
- mapPublicIpOnLaunch :: Maybe Bool
- outpostArn :: Maybe Text
- ownerId :: Maybe Text
- privateDnsNameOptionsOnLaunch :: Maybe PrivateDnsNameOptionsOnLaunch
- subnetArn :: Maybe Text
- tags :: Maybe [Tag]
- availabilityZone :: Text
- availableIpAddressCount :: Int
- cidrBlock :: Text
- state :: SubnetState
- subnetId :: Text
- vpcId :: Text
}
newSubnet :: Text -> Int -> Text -> SubnetState -> Text -> Text -> Subnet
subnet_assignIpv6AddressOnCreation :: Lens' Subnet (Maybe Bool)
subnet_availabilityZoneId :: Lens' Subnet (Maybe Text)
subnet_customerOwnedIpv4Pool :: Lens' Subnet (Maybe Text)
subnet_defaultForAz :: Lens' Subnet (Maybe Bool)
subnet_enableDns64 :: Lens' Subnet (Maybe Bool)
subnet_enableLniAtDeviceIndex :: Lens' Subnet (Maybe Int)
subnet_ipv6CidrBlockAssociationSet :: Lens' Subnet (Maybe [SubnetIpv6CidrBlockAssociation])
subnet_ipv6Native :: Lens' Subnet (Maybe Bool)
subnet_mapCustomerOwnedIpOnLaunch :: Lens' Subnet (Maybe Bool)
subnet_mapPublicIpOnLaunch :: Lens' Subnet (Maybe Bool)
subnet_outpostArn :: Lens' Subnet (Maybe Text)
subnet_ownerId :: Lens' Subnet (Maybe Text)
subnet_privateDnsNameOptionsOnLaunch :: Lens' Subnet (Maybe PrivateDnsNameOptionsOnLaunch)
subnet_subnetArn :: Lens' Subnet (Maybe Text)
subnet_tags :: Lens' Subnet (Maybe [Tag])
subnet_availabilityZone :: Lens' Subnet Text
subnet_availableIpAddressCount :: Lens' Subnet Int
subnet_cidrBlock :: Lens' Subnet Text
subnet_state :: Lens' Subnet SubnetState
subnet_subnetId :: Lens' Subnet Text
subnet_vpcId :: Lens' Subnet Text

Documentation

data Subnet Source #

Describes a subnet.

See: newSubnet smart constructor.

Constructors

Subnet'

Fields

assignIpv6AddressOnCreation :: Maybe Bool
Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives an IPv6 address.
availabilityZoneId :: Maybe Text
The AZ ID of the subnet.
customerOwnedIpv4Pool :: Maybe Text
The customer-owned IPv4 address pool associated with the subnet.
defaultForAz :: Maybe Bool
Indicates whether this is the default subnet for the Availability Zone.
enableDns64 :: Maybe Bool
Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.
enableLniAtDeviceIndex :: Maybe Int
Indicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1).
ipv6CidrBlockAssociationSet :: Maybe [SubnetIpv6CidrBlockAssociation]
Information about the IPv6 CIDR blocks associated with the subnet.
ipv6Native :: Maybe Bool
Indicates whether this is an IPv6 only subnet.
mapCustomerOwnedIpOnLaunch :: Maybe Bool
Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.
mapPublicIpOnLaunch :: Maybe Bool
Indicates whether instances launched in this subnet receive a public IPv4 address.
outpostArn :: Maybe Text
The Amazon Resource Name (ARN) of the Outpost.
ownerId :: Maybe Text
The ID of the Amazon Web Services account that owns the subnet.
privateDnsNameOptionsOnLaunch :: Maybe PrivateDnsNameOptionsOnLaunch
The type of hostnames to assign to instances in the subnet at launch. An instance hostname is based on the IPv4 address or ID of the instance.
subnetArn :: Maybe Text
The Amazon Resource Name (ARN) of the subnet.
tags :: Maybe [Tag]
Any tags assigned to the subnet.
availabilityZone :: Text
The Availability Zone of the subnet.
availableIpAddressCount :: Int
The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable.
cidrBlock :: Text
The IPv4 CIDR block assigned to the subnet.
state :: SubnetState
The current state of the subnet.
subnetId :: Text
The ID of the subnet.
vpcId :: Text
The ID of the VPC the subnet is in.

Instances

Instances details

FromXML Subnet Source #
Instance details Defined in Amazonka.EC2.Types.Subnet Methods parseXML :: [Node] -> Either String Subnet #
Generic Subnet Source #
Instance details Defined in Amazonka.EC2.Types.Subnet Associated Types type Rep Subnet :: Type -> Type # Methods from :: Subnet -> Rep Subnet x # to :: Rep Subnet x -> Subnet #
Read Subnet Source #
Instance details Defined in Amazonka.EC2.Types.Subnet Methods readsPrec :: Int -> ReadS Subnet # readList :: ReadS [Subnet] # readPrec :: ReadPrec Subnet # readListPrec :: ReadPrec [Subnet] #
Show Subnet Source #
Instance details Defined in Amazonka.EC2.Types.Subnet Methods showsPrec :: Int -> Subnet -> ShowS # show :: Subnet -> String # showList :: [Subnet] -> ShowS #
NFData Subnet Source #
Instance details Defined in Amazonka.EC2.Types.Subnet Methods rnf :: Subnet -> () #
Eq Subnet Source #
Instance details Defined in Amazonka.EC2.Types.Subnet Methods (==) :: Subnet -> Subnet -> Bool # (/=) :: Subnet -> Subnet -> Bool #
Hashable Subnet Source #
Instance details Defined in Amazonka.EC2.Types.Subnet Methods hashWithSalt :: Int -> Subnet -> Int # hash :: Subnet -> Int #
type Rep Subnet Source #
Instance details Defined in Amazonka.EC2.Types.Subnet type Rep Subnet = D1 ('MetaData "Subnet" "Amazonka.EC2.Types.Subnet" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "Subnet'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "assignIpv6AddressOnCreation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "availabilityZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "customerOwnedIpv4Pool") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "defaultForAz") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "enableDns64") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :: ((S1 ('MetaSel ('Just "enableLniAtDeviceIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "ipv6CidrBlockAssociationSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SubnetIpv6CidrBlockAssociation]))) :: (S1 ('MetaSel ('Just "ipv6Native") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "mapCustomerOwnedIpOnLaunch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "mapPublicIpOnLaunch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))) :: (((S1 ('MetaSel ('Just "outpostArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "ownerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "privateDnsNameOptionsOnLaunch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PrivateDnsNameOptionsOnLaunch)) :: (S1 ('MetaSel ('Just "subnetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))))) :: ((S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "availableIpAddressCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "cidrBlock") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubnetState) :: (S1 ('MetaSel ('Just "subnetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newSubnet Source #

Arguments

:: Text	`$sel:availabilityZone:Subnet'`
-> Int	`$sel:availableIpAddressCount:Subnet'`
-> Text	`$sel:cidrBlock:Subnet'`
-> SubnetState	`$sel:state:Subnet'`
-> Text	`$sel:subnetId:Subnet'`
-> Text	`$sel:vpcId:Subnet'`
-> Subnet

Create a value of Subnet 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:assignIpv6AddressOnCreation:Subnet', subnet_assignIpv6AddressOnCreation - Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives an IPv6 address.

$sel:availabilityZoneId:Subnet', subnet_availabilityZoneId - The AZ ID of the subnet.

$sel:customerOwnedIpv4Pool:Subnet', subnet_customerOwnedIpv4Pool - The customer-owned IPv4 address pool associated with the subnet.

$sel:defaultForAz:Subnet', subnet_defaultForAz - Indicates whether this is the default subnet for the Availability Zone.

$sel:enableDns64:Subnet', subnet_enableDns64 - Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.

$sel:enableLniAtDeviceIndex:Subnet', subnet_enableLniAtDeviceIndex - Indicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1).

$sel:ipv6CidrBlockAssociationSet:Subnet', subnet_ipv6CidrBlockAssociationSet - Information about the IPv6 CIDR blocks associated with the subnet.

$sel:ipv6Native:Subnet', subnet_ipv6Native - Indicates whether this is an IPv6 only subnet.

$sel:mapCustomerOwnedIpOnLaunch:Subnet', subnet_mapCustomerOwnedIpOnLaunch - Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.

$sel:mapPublicIpOnLaunch:Subnet', subnet_mapPublicIpOnLaunch - Indicates whether instances launched in this subnet receive a public IPv4 address.

$sel:outpostArn:Subnet', subnet_outpostArn - The Amazon Resource Name (ARN) of the Outpost.

$sel:ownerId:Subnet', subnet_ownerId - The ID of the Amazon Web Services account that owns the subnet.

$sel:privateDnsNameOptionsOnLaunch:Subnet', subnet_privateDnsNameOptionsOnLaunch - The type of hostnames to assign to instances in the subnet at launch. An instance hostname is based on the IPv4 address or ID of the instance.

$sel:subnetArn:Subnet', subnet_subnetArn - The Amazon Resource Name (ARN) of the subnet.

$sel:tags:Subnet', subnet_tags - Any tags assigned to the subnet.

$sel:availabilityZone:Subnet', subnet_availabilityZone - The Availability Zone of the subnet.

$sel:availableIpAddressCount:Subnet', subnet_availableIpAddressCount - The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable.

$sel:cidrBlock:Subnet', subnet_cidrBlock - The IPv4 CIDR block assigned to the subnet.

$sel:state:Subnet', subnet_state - The current state of the subnet.

$sel:subnetId:Subnet', subnet_subnetId - The ID of the subnet.

$sel:vpcId:Subnet', subnet_vpcId - The ID of the VPC the subnet is in.

subnet_assignIpv6AddressOnCreation :: Lens' Subnet (Maybe Bool) Source #

Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives an IPv6 address.

subnet_availabilityZoneId :: Lens' Subnet (Maybe Text) Source #

The AZ ID of the subnet.

subnet_customerOwnedIpv4Pool :: Lens' Subnet (Maybe Text) Source #

The customer-owned IPv4 address pool associated with the subnet.

subnet_defaultForAz :: Lens' Subnet (Maybe Bool) Source #

Indicates whether this is the default subnet for the Availability Zone.

subnet_enableDns64 :: Lens' Subnet (Maybe Bool) Source #

Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.

subnet_enableLniAtDeviceIndex :: Lens' Subnet (Maybe Int) Source #

Indicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1).

subnet_ipv6CidrBlockAssociationSet :: Lens' Subnet (Maybe [SubnetIpv6CidrBlockAssociation]) Source #

Information about the IPv6 CIDR blocks associated with the subnet.

subnet_ipv6Native :: Lens' Subnet (Maybe Bool) Source #

Indicates whether this is an IPv6 only subnet.

subnet_mapCustomerOwnedIpOnLaunch :: Lens' Subnet (Maybe Bool) Source #

Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.

subnet_mapPublicIpOnLaunch :: Lens' Subnet (Maybe Bool) Source #

Indicates whether instances launched in this subnet receive a public IPv4 address.

subnet_outpostArn :: Lens' Subnet (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Outpost.

subnet_ownerId :: Lens' Subnet (Maybe Text) Source #

The ID of the Amazon Web Services account that owns the subnet.

subnet_privateDnsNameOptionsOnLaunch :: Lens' Subnet (Maybe PrivateDnsNameOptionsOnLaunch) Source #

The type of hostnames to assign to instances in the subnet at launch. An instance hostname is based on the IPv4 address or ID of the instance.

subnet_subnetArn :: Lens' Subnet (Maybe Text) Source #

The Amazon Resource Name (ARN) of the subnet.

subnet_tags :: Lens' Subnet (Maybe [Tag]) Source #

Any tags assigned to the subnet.