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

Class CreateNatGatewayRequest

    • Method Detail

      • availabilityMode

        public final AvailabilityMode availabilityMode()

        Specifies whether to create a zonal (single-AZ) or regional (multi-AZ) NAT gateway. Defaults to zonal.

        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.

        If the service returns an enum value that is not available in the current SDK version, availabilityMode will return AvailabilityMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from availabilityModeAsString().

        Returns:
        Specifies whether to create a zonal (single-AZ) or regional (multi-AZ) NAT gateway. Defaults to zonal.

        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.

        See Also:
        AvailabilityMode

      • availabilityModeAsString

        public final String availabilityModeAsString()

        Specifies whether to create a zonal (single-AZ) or regional (multi-AZ) NAT gateway. Defaults to zonal.

        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.

        If the service returns an enum value that is not available in the current SDK version, availabilityMode will return AvailabilityMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from availabilityModeAsString().

        Returns:
        Specifies whether to create a zonal (single-AZ) or regional (multi-AZ) NAT gateway. Defaults to zonal.

        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.

        See Also:
        AvailabilityMode

      • allocationId

        public final String allocationId()

        [Public NAT gateways only] The allocation ID of an Elastic IP address to associate with the NAT gateway. You cannot specify an Elastic IP address with a private NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.

        Returns:
        [Public NAT gateways only] The allocation ID of an Elastic IP address to associate with the NAT gateway. You cannot specify an Elastic IP address with a private NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.

      • clientToken

        public final String clientToken()

        Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

        Constraint: Maximum 64 ASCII characters.

        Returns:
        Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

        Constraint: Maximum 64 ASCII characters.

      • dryRun

        public final Boolean 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.

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

      • subnetId

        public final String subnetId()

        The ID of the subnet in which to create the NAT gateway.

        Returns:
        The ID of the subnet in which to create the NAT gateway.

      • vpcId

        public final String vpcId()

        The ID of the VPC where you want to create a regional NAT gateway.

        Returns:
        The ID of the VPC where you want to create a regional NAT gateway.

      • hasAvailabilityZoneAddresses

        public final boolean hasAvailabilityZoneAddresses()
        For responses, this returns true if the service returned a value for the AvailabilityZoneAddresses property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • availabilityZoneAddresses

        public final List<AvailabilityZoneAddress> availabilityZoneAddresses()

        For regional NAT gateways only: Specifies which Availability Zones you want the NAT gateway to support and the Elastic IP addresses (EIPs) to use in each AZ. The regional NAT gateway uses these EIPs to handle outbound NAT traffic from their respective AZs. If not specified, the NAT gateway will automatically expand to new AZs and associate EIPs upon detection of an elastic network interface. If you specify this parameter, auto-expansion is disabled and you must manually manage AZ coverage.

        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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAvailabilityZoneAddresses() method.

        Returns:
        For regional NAT gateways only: Specifies which Availability Zones you want the NAT gateway to support and the Elastic IP addresses (EIPs) to use in each AZ. The regional NAT gateway uses these EIPs to handle outbound NAT traffic from their respective AZs. If not specified, the NAT gateway will automatically expand to new AZs and associate EIPs upon detection of an elastic network interface. If you specify this parameter, auto-expansion is disabled and you must manually manage AZ coverage.

        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.

      • hasTagSpecifications

        public final boolean hasTagSpecifications()
        For responses, this returns true if the service returned a value for the TagSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tagSpecifications

        public final List<TagSpecification> tagSpecifications()

        The tags to assign to the NAT gateway.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTagSpecifications() method.

        Returns:
        The tags to assign to the NAT gateway.

      • connectivityType

        public final ConnectivityType connectivityType()

        Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.

        If the service returns an enum value that is not available in the current SDK version, connectivityType will return ConnectivityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectivityTypeAsString().

        Returns:
        Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.
        See Also:
        ConnectivityType

      • connectivityTypeAsString

        public final String connectivityTypeAsString()

        Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.

        If the service returns an enum value that is not available in the current SDK version, connectivityType will return ConnectivityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectivityTypeAsString().

        Returns:
        Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.
        See Also:
        ConnectivityType

      • privateIpAddress

        public final String privateIpAddress()

        The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.

        Returns:
        The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.

      • hasSecondaryAllocationIds

        public final boolean hasSecondaryAllocationIds()
        For responses, this returns true if the service returned a value for the SecondaryAllocationIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • secondaryAllocationIds

        public final List<String> secondaryAllocationIds()

        Secondary EIP allocation IDs. For more information, see Create a NAT gateway in the Amazon VPC User Guide.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSecondaryAllocationIds() method.

        Returns:
        Secondary EIP allocation IDs. For more information, see Create a NAT gateway in the Amazon VPC User Guide.

      • hasSecondaryPrivateIpAddresses

        public final boolean hasSecondaryPrivateIpAddresses()
        For responses, this returns true if the service returned a value for the SecondaryPrivateIpAddresses property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • secondaryPrivateIpAddresses

        public final List<String> secondaryPrivateIpAddresses()

        Secondary private IPv4 addresses. For more information about secondary addresses, see Create a NAT gateway in the Amazon VPC User Guide.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSecondaryPrivateIpAddresses() method.

        Returns:
        Secondary private IPv4 addresses. For more information about secondary addresses, see Create a NAT gateway in the Amazon VPC User Guide.

      • secondaryPrivateIpAddressCount

        public final Integer secondaryPrivateIpAddressCount()

        [Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. For more information about secondary addresses, see Create a NAT gateway in the Amazon VPC User Guide.

        Returns:
        [Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. For more information about secondary addresses, see Create a NAT gateway in the Amazon VPC User Guide.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object