software.amazon.awscdk.services.ec2

Class NatInstanceProps.Builder

java.lang.Object

software.amazon.awscdk.services.ec2.NatInstanceProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<NatInstanceProps>

Enclosing interface:

NatInstanceProps

@Stability(value=Experimental)
public static final class NatInstanceProps.Builder
extends Object
implements software.amazon.jsii.Builder<NatInstanceProps>

A builder for NatInstanceProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
NatInstanceProps	build() Builds the configured instance.
NatInstanceProps.Builder	defaultAllowedTraffic(NatTrafficDirection defaultAllowedTraffic) Sets the value of NatInstanceProps.getDefaultAllowedTraffic()
NatInstanceProps.Builder	instanceType(InstanceType instanceType) Sets the value of NatInstanceProps.getInstanceType()
NatInstanceProps.Builder	keyName(String keyName) Sets the value of NatInstanceProps.getKeyName()
NatInstanceProps.Builder	machineImage(IMachineImage machineImage) Sets the value of NatInstanceProps.getMachineImage()
NatInstanceProps.Builder	securityGroup(ISecurityGroup securityGroup) Sets the value of NatInstanceProps.getSecurityGroup()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

instanceType

@Stability(value=Experimental)
public NatInstanceProps.Builder instanceType(InstanceType instanceType)

Sets the value of NatInstanceProps.getInstanceType()

Parameters:

instanceType - Instance type of the NAT instance. This parameter is required.

Returns:

this

defaultAllowedTraffic

@Stability(value=Experimental)
public NatInstanceProps.Builder defaultAllowedTraffic(NatTrafficDirection defaultAllowedTraffic)

Sets the value of NatInstanceProps.getDefaultAllowedTraffic()

Parameters:

defaultAllowedTraffic - Direction to allow all traffic through the NAT instance by default. By default, inbound and outbound traffic is allowed.

If you set this to another value than INBOUND_AND_OUTBOUND, you must configure the NAT instance's security groups in another way, either by passing in a fully configured Security Group using the securityGroup property, or by configuring it using the .securityGroup or .connections members after passing the NAT Instance Provider to a Vpc.

Returns:

this

keyName

@Stability(value=Experimental)
public NatInstanceProps.Builder keyName(String keyName)

Sets the value of NatInstanceProps.getKeyName()

Parameters:

keyName - Name of SSH keypair to grant access to instance.

Returns:

this

machineImage

@Stability(value=Experimental)
public NatInstanceProps.Builder machineImage(IMachineImage machineImage)

Sets the value of NatInstanceProps.getMachineImage()

Parameters:

machineImage - 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 without compilation. See https://github.com/aws/jsii/issues/826
                     ec2.NatProvider.instance(Map.of(
                             "instanceType", new InstanceType("t3.micro"),
                             "machineImage", GenericLinuxImage.Builder.create()
                                     .us-east-2("ami-0f9c61b5a562a16af")
                                     .build()));
                     

Returns:

this

securityGroup

@Stability(value=Experimental)
public NatInstanceProps.Builder securityGroup(ISecurityGroup securityGroup)

Sets the value of NatInstanceProps.getSecurityGroup()

Parameters:

securityGroup - Security Group for NAT instances.

Returns:

this

build

@Stability(value=Experimental)
public NatInstanceProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<NatInstanceProps>

Returns:

a new instance of NatInstanceProps

Throws:

NullPointerException - if any required attribute was not provided