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

Description

 
Synopsis

Documentation

data NatGateway Source #

Describes a NAT gateway.

See: newNatGateway smart constructor.

Constructors

NatGateway' 

Fields

  • connectivityType :: Maybe ConnectivityType

    Indicates whether the NAT gateway supports public or private connectivity.

  • createTime :: Maybe ISO8601

    The date and time the NAT gateway was created.

  • deleteTime :: Maybe ISO8601

    The date and time the NAT gateway was deleted, if applicable.

  • failureCode :: Maybe Text

    If the NAT gateway could not be created, specifies the error code for the failure. (InsufficientFreeAddressesInSubnet | Gateway.NotAttached | InvalidAllocationID.NotFound | Resource.AlreadyAssociated | InternalError | InvalidSubnetID.NotFound)

  • failureMessage :: Maybe Text

    If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.

    • For InsufficientFreeAddressesInSubnet: "Subnet has insufficient free addresses to create this NAT gateway"
    • For Gateway.NotAttached: "Network vpc-xxxxxxxx has no Internet gateway attached"
    • For InvalidAllocationID.NotFound: "Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway"
    • For Resource.AlreadyAssociated: "Elastic IP address eipalloc-xxxxxxxx is already associated"
    • For InternalError: "Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again."
    • For InvalidSubnetID.NotFound: "The specified subnet subnet-xxxxxxxx does not exist or could not be found."
  • natGatewayAddresses :: Maybe [NatGatewayAddress]

    Information about the IP addresses and network interface associated with the NAT gateway.

  • natGatewayId :: Maybe Text

    The ID of the NAT gateway.

  • provisionedBandwidth :: Maybe ProvisionedBandwidth

    Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

  • state :: Maybe NatGatewayState

    The state of the NAT gateway.

    • pending: The NAT gateway is being created and is not ready to process traffic.
    • failed: The NAT gateway could not be created. Check the failureCode and failureMessage fields for the reason.
    • available: The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway.
    • deleting: The NAT gateway is in the process of being terminated and may still be processing traffic.
    • deleted: The NAT gateway has been terminated and is no longer processing traffic.
  • subnetId :: Maybe Text

    The ID of the subnet in which the NAT gateway is located.

  • tags :: Maybe [Tag]

    The tags for the NAT gateway.

  • vpcId :: Maybe Text

    The ID of the VPC in which the NAT gateway is located.

Instances

Instances details
FromXML NatGateway Source # 
Instance details

Defined in Amazonka.EC2.Types.NatGateway

Methods

parseXML :: [Node] -> Either String NatGateway #

Generic NatGateway Source # 
Instance details

Defined in Amazonka.EC2.Types.NatGateway

Associated Types

type Rep NatGateway :: Type -> Type #

Methods

from :: NatGateway -> Rep NatGateway x #

to :: Rep NatGateway x -> NatGateway #

Read NatGateway Source # 
Instance details

Defined in Amazonka.EC2.Types.NatGateway

Methods

readsPrec :: Int -> ReadS NatGateway #

readList :: ReadS [NatGateway] #

readPrec :: ReadPrec NatGateway #

readListPrec :: ReadPrec [NatGateway] #

Show NatGateway Source # 
Instance details

Defined in Amazonka.EC2.Types.NatGateway

Methods

showsPrec :: Int -> NatGateway -> ShowS #

show :: NatGateway -> String #

showList :: [NatGateway] -> ShowS #

NFData NatGateway Source # 
Instance details

Defined in Amazonka.EC2.Types.NatGateway

Methods

rnf :: NatGateway -> () #

Eq NatGateway Source # 
Instance details

Defined in Amazonka.EC2.Types.NatGateway

Methods

(==) :: NatGateway -> NatGateway -> Bool #

(/=) :: NatGateway -> NatGateway -> Bool #

Hashable NatGateway Source # 
Instance details

Defined in Amazonka.EC2.Types.NatGateway

Methods

hashWithSalt :: Int -> NatGateway -> Int #

hash :: NatGateway -> Int #

type Rep NatGateway Source # 
Instance details

Defined in Amazonka.EC2.Types.NatGateway

type Rep NatGateway = D1 ('MetaData "NatGateway" "Amazonka.EC2.Types.NatGateway" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "NatGateway'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "connectivityType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectivityType)) :*: (S1 ('MetaSel ('Just "createTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "deleteTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)))) :*: (S1 ('MetaSel ('Just "failureCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "failureMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "natGatewayAddresses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [NatGatewayAddress]))))) :*: ((S1 ('MetaSel ('Just "natGatewayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "provisionedBandwidth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProvisionedBandwidth)) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NatGatewayState)))) :*: (S1 ('MetaSel ('Just "subnetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newNatGateway :: NatGateway Source #

Create a value of NatGateway 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:connectivityType:NatGateway', natGateway_connectivityType - Indicates whether the NAT gateway supports public or private connectivity.

$sel:createTime:NatGateway', natGateway_createTime - The date and time the NAT gateway was created.

$sel:deleteTime:NatGateway', natGateway_deleteTime - The date and time the NAT gateway was deleted, if applicable.

$sel:failureCode:NatGateway', natGateway_failureCode - If the NAT gateway could not be created, specifies the error code for the failure. (InsufficientFreeAddressesInSubnet | Gateway.NotAttached | InvalidAllocationID.NotFound | Resource.AlreadyAssociated | InternalError | InvalidSubnetID.NotFound)

$sel:failureMessage:NatGateway', natGateway_failureMessage - If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.

  • For InsufficientFreeAddressesInSubnet: "Subnet has insufficient free addresses to create this NAT gateway"
  • For Gateway.NotAttached: "Network vpc-xxxxxxxx has no Internet gateway attached"
  • For InvalidAllocationID.NotFound: "Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway"
  • For Resource.AlreadyAssociated: "Elastic IP address eipalloc-xxxxxxxx is already associated"
  • For InternalError: "Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again."
  • For InvalidSubnetID.NotFound: "The specified subnet subnet-xxxxxxxx does not exist or could not be found."

$sel:natGatewayAddresses:NatGateway', natGateway_natGatewayAddresses - Information about the IP addresses and network interface associated with the NAT gateway.

$sel:natGatewayId:NatGateway', natGateway_natGatewayId - The ID of the NAT gateway.

$sel:provisionedBandwidth:NatGateway', natGateway_provisionedBandwidth - Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

$sel:state:NatGateway', natGateway_state - The state of the NAT gateway.

  • pending: The NAT gateway is being created and is not ready to process traffic.
  • failed: The NAT gateway could not be created. Check the failureCode and failureMessage fields for the reason.
  • available: The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway.
  • deleting: The NAT gateway is in the process of being terminated and may still be processing traffic.
  • deleted: The NAT gateway has been terminated and is no longer processing traffic.

$sel:subnetId:NatGateway', natGateway_subnetId - The ID of the subnet in which the NAT gateway is located.

$sel:tags:NatGateway', natGateway_tags - The tags for the NAT gateway.

$sel:vpcId:NatGateway', natGateway_vpcId - The ID of the VPC in which the NAT gateway is located.

natGateway_connectivityType :: Lens' NatGateway (Maybe ConnectivityType) Source #

Indicates whether the NAT gateway supports public or private connectivity.

natGateway_createTime :: Lens' NatGateway (Maybe UTCTime) Source #

The date and time the NAT gateway was created.

natGateway_deleteTime :: Lens' NatGateway (Maybe UTCTime) Source #

The date and time the NAT gateway was deleted, if applicable.

natGateway_failureCode :: Lens' NatGateway (Maybe Text) Source #

If the NAT gateway could not be created, specifies the error code for the failure. (InsufficientFreeAddressesInSubnet | Gateway.NotAttached | InvalidAllocationID.NotFound | Resource.AlreadyAssociated | InternalError | InvalidSubnetID.NotFound)

natGateway_failureMessage :: Lens' NatGateway (Maybe Text) Source #

If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.

  • For InsufficientFreeAddressesInSubnet: "Subnet has insufficient free addresses to create this NAT gateway"
  • For Gateway.NotAttached: "Network vpc-xxxxxxxx has no Internet gateway attached"
  • For InvalidAllocationID.NotFound: "Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway"
  • For Resource.AlreadyAssociated: "Elastic IP address eipalloc-xxxxxxxx is already associated"
  • For InternalError: "Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again."
  • For InvalidSubnetID.NotFound: "The specified subnet subnet-xxxxxxxx does not exist or could not be found."

natGateway_natGatewayAddresses :: Lens' NatGateway (Maybe [NatGatewayAddress]) Source #

Information about the IP addresses and network interface associated with the NAT gateway.

natGateway_natGatewayId :: Lens' NatGateway (Maybe Text) Source #

The ID of the NAT gateway.

natGateway_provisionedBandwidth :: Lens' NatGateway (Maybe ProvisionedBandwidth) Source #

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

natGateway_state :: Lens' NatGateway (Maybe NatGatewayState) Source #

The state of the NAT gateway.

  • pending: The NAT gateway is being created and is not ready to process traffic.
  • failed: The NAT gateway could not be created. Check the failureCode and failureMessage fields for the reason.
  • available: The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway.
  • deleting: The NAT gateway is in the process of being terminated and may still be processing traffic.
  • deleted: The NAT gateway has been terminated and is no longer processing traffic.

natGateway_subnetId :: Lens' NatGateway (Maybe Text) Source #

The ID of the subnet in which the NAT gateway is located.

natGateway_tags :: Lens' NatGateway (Maybe [Tag]) Source #

The tags for the NAT gateway.

natGateway_vpcId :: Lens' NatGateway (Maybe Text) Source #

The ID of the VPC in which the NAT gateway is located.