Package software.amazon.awssdk.services.ec2.model

Interface NatGateway.Builder

    • Method Detail

      • createTime

        NatGateway.Builder createTime​(Instant createTime)

        The date and time the NAT gateway was created.

        Parameters:
        createTime - The date and time the NAT gateway was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • deleteTime

        NatGateway.Builder deleteTime​(Instant deleteTime)

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

        Parameters:
        deleteTime - The date and time the NAT gateway was deleted, if applicable.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • failureCode

        NatGateway.Builder failureCode​(String 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)

        Parameters:
        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)
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • failureMessage

        NatGateway.Builder failureMessage​(String 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."

        Parameters:
        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."

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • natGatewayAddresses

        NatGateway.Builder natGatewayAddresses​(Collection<NatGatewayAddress> natGatewayAddresses)

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

        Parameters:
        natGatewayAddresses - Information about the IP addresses and network interface associated with the NAT gateway.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • natGatewayAddresses

        NatGateway.Builder natGatewayAddresses​(NatGatewayAddress... natGatewayAddresses)

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

        Parameters:
        natGatewayAddresses - Information about the IP addresses and network interface associated with the NAT gateway.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • natGatewayId

        NatGateway.Builder natGatewayId​(String natGatewayId)

        The ID of the NAT gateway.

        Parameters:
        natGatewayId - The ID of the NAT gateway.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • provisionedBandwidth

        NatGateway.Builder provisionedBandwidth​(ProvisionedBandwidth provisionedBandwidth)

        Reserved. If you need to sustain traffic greater than the documented limits, contact Amazon Web Services Support.

        Parameters:
        provisionedBandwidth - Reserved. If you need to sustain traffic greater than the documented limits, contact Amazon Web Services Support.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • state

        NatGateway.Builder state​(String 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        NatGatewayState, NatGatewayState

      • state

        NatGateway.Builder state​(NatGatewayState 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        NatGatewayState, NatGatewayState

      • subnetId

        NatGateway.Builder subnetId​(String subnetId)

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

        Parameters:
        subnetId - The ID of the subnet in which the NAT gateway is located.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vpcId

        NatGateway.Builder vpcId​(String vpcId)

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

        Parameters:
        vpcId - The ID of the VPC in which the NAT gateway is located.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        NatGateway.Builder tags​(Collection<Tag> tags)

        The tags for the NAT gateway.

        Parameters:
        tags - The tags for the NAT gateway.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        NatGateway.Builder tags​(Tag... tags)

        The tags for the NAT gateway.

        Parameters:
        tags - The tags for the NAT gateway.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        NatGateway.Builder tags​(Consumer<Tag.Builder>... tags)

        The tags for the NAT gateway.

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)

      • connectivityType

        NatGateway.Builder connectivityType​(String connectivityType)

        Indicates whether the NAT gateway supports public or private connectivity.

        Parameters:
        connectivityType - Indicates whether the NAT gateway supports public or private connectivity.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ConnectivityType, ConnectivityType

      • connectivityType

        NatGateway.Builder connectivityType​(ConnectivityType connectivityType)

        Indicates whether the NAT gateway supports public or private connectivity.

        Parameters:
        connectivityType - Indicates whether the NAT gateway supports public or private connectivity.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ConnectivityType, ConnectivityType

      • availabilityMode

        NatGateway.Builder availabilityMode​(String availabilityMode)

        Indicates whether this is a zonal (single-AZ) or regional (multi-AZ) NAT gateway.

        A zonal NAT gateway is a NAT Gateway that provides redundancy and scalability within a single availability zone. A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

        For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide.

        Parameters:
        availabilityMode - Indicates whether this is a zonal (single-AZ) or regional (multi-AZ) NAT gateway.

        A zonal NAT gateway is a NAT Gateway that provides redundancy and scalability within a single availability zone. A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

        For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AvailabilityMode, AvailabilityMode

      • availabilityMode

        NatGateway.Builder availabilityMode​(AvailabilityMode availabilityMode)

        Indicates whether this is a zonal (single-AZ) or regional (multi-AZ) NAT gateway.

        A zonal NAT gateway is a NAT Gateway that provides redundancy and scalability within a single availability zone. A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

        For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide.

        Parameters:
        availabilityMode - Indicates whether this is a zonal (single-AZ) or regional (multi-AZ) NAT gateway.

        A zonal NAT gateway is a NAT Gateway that provides redundancy and scalability within a single availability zone. A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

        For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AvailabilityMode, AvailabilityMode

      • autoScalingIps

        NatGateway.Builder autoScalingIps​(String autoScalingIps)

        For regional NAT gateways only: Indicates whether Amazon Web Services automatically allocates additional Elastic IP addresses (EIPs) in an AZ when the NAT gateway needs more ports due to increased concurrent connections to a single destination from that AZ.

        For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide.

        Parameters:
        autoScalingIps - For regional NAT gateways only: Indicates whether Amazon Web Services automatically allocates additional Elastic IP addresses (EIPs) in an AZ when the NAT gateway needs more ports due to increased concurrent connections to a single destination from that AZ.

        For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AutoScalingIpsState, AutoScalingIpsState

      • autoScalingIps

        NatGateway.Builder autoScalingIps​(AutoScalingIpsState autoScalingIps)

        For regional NAT gateways only: Indicates whether Amazon Web Services automatically allocates additional Elastic IP addresses (EIPs) in an AZ when the NAT gateway needs more ports due to increased concurrent connections to a single destination from that AZ.

        For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide.

        Parameters:
        autoScalingIps - For regional NAT gateways only: Indicates whether Amazon Web Services automatically allocates additional Elastic IP addresses (EIPs) in an AZ when the NAT gateway needs more ports due to increased concurrent connections to a single destination from that AZ.

        For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AutoScalingIpsState, AutoScalingIpsState

      • autoProvisionZones

        NatGateway.Builder autoProvisionZones​(String autoProvisionZones)

        For regional NAT gateways only: Indicates whether Amazon Web Services automatically manages AZ coverage. When enabled, the NAT gateway associates EIPs in all AZs where your VPC has subnets to handle outbound NAT traffic, expands to new AZs when you create subnets there, and retracts from AZs where you've removed all subnets. When disabled, you must manually manage which AZs the NAT gateway supports and their corresponding EIPs.

        A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

        For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide.

        Parameters:
        autoProvisionZones - For regional NAT gateways only: Indicates whether Amazon Web Services automatically manages AZ coverage. When enabled, the NAT gateway associates EIPs in all AZs where your VPC has subnets to handle outbound NAT traffic, expands to new AZs when you create subnets there, and retracts from AZs where you've removed all subnets. When disabled, you must manually manage which AZs the NAT gateway supports and their corresponding EIPs.

        A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

        For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AutoProvisionZonesState, AutoProvisionZonesState

      • autoProvisionZones

        NatGateway.Builder autoProvisionZones​(AutoProvisionZonesState autoProvisionZones)

        For regional NAT gateways only: Indicates whether Amazon Web Services automatically manages AZ coverage. When enabled, the NAT gateway associates EIPs in all AZs where your VPC has subnets to handle outbound NAT traffic, expands to new AZs when you create subnets there, and retracts from AZs where you've removed all subnets. When disabled, you must manually manage which AZs the NAT gateway supports and their corresponding EIPs.

        A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

        For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide.

        Parameters:
        autoProvisionZones - For regional NAT gateways only: Indicates whether Amazon Web Services automatically manages AZ coverage. When enabled, the NAT gateway associates EIPs in all AZs where your VPC has subnets to handle outbound NAT traffic, expands to new AZs when you create subnets there, and retracts from AZs where you've removed all subnets. When disabled, you must manually manage which AZs the NAT gateway supports and their corresponding EIPs.

        A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.

        For more information, see Regional NAT gateways for automatic multi-AZ expansion in the Amazon VPC User Guide.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AutoProvisionZonesState, AutoProvisionZonesState

      • attachedAppliances

        NatGateway.Builder attachedAppliances​(Collection<NatGatewayAttachedAppliance> attachedAppliances)

        The proxy appliances attached to the NAT Gateway for filtering and inspecting traffic to prevent data exfiltration.

        Parameters:
        attachedAppliances - The proxy appliances attached to the NAT Gateway for filtering and inspecting traffic to prevent data exfiltration.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • attachedAppliances

        NatGateway.Builder attachedAppliances​(NatGatewayAttachedAppliance... attachedAppliances)

        The proxy appliances attached to the NAT Gateway for filtering and inspecting traffic to prevent data exfiltration.

        Parameters:
        attachedAppliances - The proxy appliances attached to the NAT Gateway for filtering and inspecting traffic to prevent data exfiltration.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • routeTableId

        NatGateway.Builder routeTableId​(String routeTableId)

        For regional NAT gateways only, this is the ID of the NAT gateway.

        Parameters:
        routeTableId - For regional NAT gateways only, this is the ID of the NAT gateway.
        Returns:
        Returns a reference to this object so that method calls can be chained together.