Interface CreateNatGatewayRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateNatGatewayRequest.Builder,CreateNatGatewayRequest>, Ec2Request.Builder, SdkBuilder<CreateNatGatewayRequest.Builder,CreateNatGatewayRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateNatGatewayRequest
@Mutable @NotThreadSafe public static interface CreateNatGatewayRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<CreateNatGatewayRequest.Builder,CreateNatGatewayRequest>

  • Method Details

    • availabilityMode

      CreateNatGatewayRequest.Builder availabilityMode(String 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.

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

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

    • availabilityMode

      CreateNatGatewayRequest.Builder availabilityMode(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.

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

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

    • allocationId

      CreateNatGatewayRequest.Builder allocationId(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.

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

    • clientToken

      CreateNatGatewayRequest.Builder clientToken(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.

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

    • dryRun

      CreateNatGatewayRequest.Builder dryRun(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.

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

    • subnetId

      CreateNatGatewayRequest.Builder subnetId(String subnetId)

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

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

    • vpcId

      CreateNatGatewayRequest.Builder vpcId(String vpcId)

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

      Parameters:
      vpcId - The ID of the VPC where you want to create a regional NAT gateway.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • availabilityZoneAddresses

      CreateNatGatewayRequest.Builder availabilityZoneAddresses(Collection<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.

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

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

    • availabilityZoneAddresses

      CreateNatGatewayRequest.Builder availabilityZoneAddresses(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.

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

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

    • availabilityZoneAddresses

      CreateNatGatewayRequest.Builder availabilityZoneAddresses(Consumer<AvailabilityZoneAddress.Builder>... 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.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to availabilityZoneAddresses(List<AvailabilityZoneAddress>).

      Parameters:
      availabilityZoneAddresses - a consumer that will call methods on AvailabilityZoneAddress.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tagSpecifications

      CreateNatGatewayRequest.Builder tagSpecifications(Collection<TagSpecification> tagSpecifications)

      The tags to assign to the NAT gateway.

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

    • tagSpecifications

      CreateNatGatewayRequest.Builder tagSpecifications(TagSpecification... tagSpecifications)

      The tags to assign to the NAT gateway.

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

    • tagSpecifications

      CreateNatGatewayRequest.Builder tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)

      The tags to assign to the NAT gateway.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tagSpecifications(List<TagSpecification>).

      Parameters:
      tagSpecifications - a consumer that will call methods on TagSpecification.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • connectivityType

      CreateNatGatewayRequest.Builder connectivityType(String connectivityType)

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

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

    • connectivityType

      CreateNatGatewayRequest.Builder connectivityType(ConnectivityType connectivityType)

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

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

    • privateIpAddress

      CreateNatGatewayRequest.Builder privateIpAddress(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.

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

    • secondaryAllocationIds

      CreateNatGatewayRequest.Builder secondaryAllocationIds(Collection<String> secondaryAllocationIds)

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

      Parameters:
      secondaryAllocationIds - Secondary EIP allocation IDs. For more information, see Create a NAT gateway in the Amazon VPC User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secondaryAllocationIds

      CreateNatGatewayRequest.Builder secondaryAllocationIds(String... secondaryAllocationIds)

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

      Parameters:
      secondaryAllocationIds - Secondary EIP allocation IDs. For more information, see Create a NAT gateway in the Amazon VPC User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secondaryPrivateIpAddresses

      CreateNatGatewayRequest.Builder secondaryPrivateIpAddresses(Collection<String> secondaryPrivateIpAddresses)

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

      Parameters:
      secondaryPrivateIpAddresses - Secondary private IPv4 addresses. For more information about secondary addresses, see Create a NAT gateway in the Amazon VPC User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secondaryPrivateIpAddresses

      CreateNatGatewayRequest.Builder secondaryPrivateIpAddresses(String... secondaryPrivateIpAddresses)

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

      Parameters:
      secondaryPrivateIpAddresses - Secondary private IPv4 addresses. For more information about secondary addresses, see Create a NAT gateway in the Amazon VPC User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secondaryPrivateIpAddressCount

      CreateNatGatewayRequest.Builder secondaryPrivateIpAddressCount(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.

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

    • overrideConfiguration

      CreateNatGatewayRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateNatGatewayRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.