create_nat_gateway ¶

def create_nat_gateway(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    availability_mode: Optional[
        "capo_ec2.types.availability_mode.AvailabilityMode"
    ] = None,
    allocation_id: Optional["capo_ec2.types.allocation_id.AllocationId"] = None,
    client_token: Optional["capo_ec2.types.string.String"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    subnet_id: Optional["capo_ec2.types.subnet_id.SubnetId"] = None,
    vpc_id: Optional["capo_ec2.types.vpc_id.VpcId"] = None,
    availability_zone_addresses: Optional[
        "capo_ec2.types.availability_zone_addresses.AvailabilityZoneAddresses"
    ] = None,
    tag_specifications: Optional[
        "capo_ec2.types.tag_specification_list.TagSpecificationList"
    ] = None,
    connectivity_type: Optional[
        "capo_ec2.types.connectivity_type.ConnectivityType"
    ] = None,
    private_ip_address: Optional["capo_ec2.types.string.String"] = None,
    secondary_allocation_ids: Optional[
        "capo_ec2.types.allocation_id_list.AllocationIdList"
    ] = None,
    secondary_private_ip_addresses: Optional[
        "capo_ec2.types.ip_list.IpList"
    ] = None,
    secondary_private_ip_address_count: Optional[
        "capo_ec2.types.private_ip_address_count.PrivateIpAddressCount"
    ] = None,
) -> "capo_ec2.types.create_nat_gateway_result.CreateNatGatewayResult":
    """<p>Creates a NAT gateway in the specified subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. You can create either a public NAT gateway or a private NAT gateway.</p> <p>With a public NAT gateway, internet-bound traffic from a private subnet can be routed to the NAT gateway, so that instances in a private subnet can connect to the internet.</p> <p>With a private NAT gateway, private communication is routed across VPCs and on-premises networks through a transit gateway or virtual private gateway. Common use cases include running large workloads behind a small pool of allowlisted IPv4 addresses, preserving private IPv4 addresses, and communicating between overlapping networks.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html">NAT gateways</a> in the <i>Amazon VPC User Guide</i>.</p> <important> <p>When you create a public NAT gateway and assign it an EIP or secondary EIPs, the network border group of the EIPs must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. If it's not the same, the NAT gateway will fail to launch. You can see the network border group for the subnet's AZ by viewing the details of the subnet. Similarly, you can view the network border group of an EIP by viewing the details of the EIP address. For more information about network border groups and EIPs, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/WorkWithEIPs.html">Allocate an Elastic IP address</a> in the <i>Amazon VPC User Guide</i>. </p> </important>

    Args:
        availability_mode: <p>Specifies whether to create a zonal (single-AZ) or regional (multi-AZ) NAT gateway. Defaults to <code>zonal</code>.</p> <p>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.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateways-regional.html">Regional NAT gateways for automatic multi-AZ expansion</a> in the <i>Amazon VPC User Guide</i>.</p>
        allocation_id: <p>[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.</p>
        client_token: <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html">Ensuring idempotency</a>.</p> <p>Constraint: Maximum 64 ASCII characters.</p>
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
        subnet_id: <p>The ID of the subnet in which to create the NAT gateway.</p>
        vpc_id: <p>The ID of the VPC where you want to create a regional NAT gateway.</p>
        availability_zone_addresses: <p>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.</p> <p>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.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateways-regional.html">Regional NAT gateways for automatic multi-AZ expansion</a> in the <i>Amazon VPC User Guide</i>.</p>
        tag_specifications: <p>The tags to assign to the NAT gateway.</p>
        connectivity_type: <p>Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.</p>
        private_ip_address: <p>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.</p>
        secondary_allocation_ids: <p>Secondary EIP allocation IDs. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-working-with.html">Create a NAT gateway</a> in the <i>Amazon VPC User Guide</i>.</p>
        secondary_private_ip_addresses: <p>Secondary private IPv4 addresses. For more information about secondary addresses, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-working-with.html">Create a NAT gateway</a> in the <i>Amazon VPC User Guide</i>.</p>
        secondary_private_ip_address_count: <p>[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 <a href="https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-working-with.html">Create a NAT gateway</a> in the <i>Amazon VPC User Guide</i>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To create a NAT gateway
        This example creates a NAT gateway in subnet subnet-1a2b3c4d and associates an Elastic IP address with the allocation ID eipalloc-37fc1a52 with the NAT gateway.

        >>> client.create_nat_gateway(subnet_id='subnet-1a2b3c4d', allocation_id='eipalloc-37fc1a52')
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.create_nat_gateway_request.CreateNatGatewayRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.create_nat_gateway_result.CreateNatGatewayResult"
    ]:
        import capo_ec2._operations.amazon_ec2.create_nat_gateway

        output, http_response = (
            capo_ec2._operations.amazon_ec2.create_nat_gateway.create_nat_gateway(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateNatGateway")
    )
    input_: capo_ec2.types.create_nat_gateway_request.CreateNatGatewayRequest = {}
    if availability_mode is not None:
        input_["availability_mode"] = availability_mode
    if allocation_id is not None:
        input_["allocation_id"] = allocation_id
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if subnet_id is not None:
        input_["subnet_id"] = subnet_id
    if vpc_id is not None:
        input_["vpc_id"] = vpc_id
    if availability_zone_addresses is not None:
        input_["availability_zone_addresses"] = availability_zone_addresses
    if tag_specifications is not None:
        input_["tag_specifications"] = tag_specifications
    if connectivity_type is not None:
        input_["connectivity_type"] = connectivity_type
    if private_ip_address is not None:
        input_["private_ip_address"] = private_ip_address
    if secondary_allocation_ids is not None:
        input_["secondary_allocation_ids"] = secondary_allocation_ids
    if secondary_private_ip_addresses is not None:
        input_["secondary_private_ip_addresses"] = secondary_private_ip_addresses
    if secondary_private_ip_address_count is not None:
        input_["secondary_private_ip_address_count"] = (
            secondary_private_ip_address_count
        )

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output