NatInstanceProps

class aws_cdk.aws_ec2.NatInstanceProps(*, instance_type, key_name=None, machine_image=None)

Bases: object

__init__(*, instance_type, key_name=None, machine_image=None)

Properties for a NAT instance.

Parameters
  • instance_type (InstanceType) – Instance type of the NAT instance.

  • key_name (Optional[str]) – Name of SSH keypair to grant access to instance. Default: - No SSH access will be possible.

  • machine_image (Optional[IMachineImage]) – The machine image (AMI) to use. By default, will do an AMI lookup for the latest NAT instance image. If you have a specific AMI ID you want to use, pass a GenericLinuxImage. For example:: NatProvider.instance({ instanceType: new InstanceType(‘t3.micro’), machineImage: new GenericLinuxImage({ ‘us-east-2’: ‘ami-0f9c61b5a562a16af’ }) }) Default: - Latest NAT instance image

stability :stability: experimental

Attributes

instance_type

Instance type of the NAT instance.

stability :stability: experimental

Return type

InstanceType

key_name

Name of SSH keypair to grant access to instance.

default :default: - No SSH access will be possible.

stability :stability: experimental

Return type

Optional[str]

machine_image

The machine image (AMI) to use.

By default, will do an AMI lookup for the latest NAT instance image.

If you have a specific AMI ID you want to use, pass a GenericLinuxImage. For example:

# Example automatically generated. See https://github.com/aws/jsii/issues/826
NatProvider.instance(
    instance_type=InstanceType("t3.micro"),
    machine_image=GenericLinuxImage(
        us-east-2="ami-0f9c61b5a562a16af"
    )
)

default :default: - Latest NAT instance image

stability :stability: experimental

Return type

Optional[IMachineImage]