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

Interface Instance.Builder

All Superinterfaces:

CopyableBuilder<Instance.Builder,Instance>, SdkBuilder<Instance.Builder,Instance>

Enclosing class:

Instance

public static interface Instance.Builder
extends CopyableBuilder<Instance.Builder,Instance>

Method Summary

Modifier and Type	Method	Description
Instance.Builder	amiLaunchIndex(Integer amiLaunchIndex)	The AMI launch index, which can be used to find this instance in the launch group.
Instance.Builder	architecture(String architecture)	The architecture of the image.
Instance.Builder	architecture(ArchitectureValues architecture)	The architecture of the image.
Instance.Builder	blockDeviceMappings(Collection<InstanceBlockDeviceMapping> blockDeviceMappings)	Any block device mapping entries for the instance.
Instance.Builder	blockDeviceMappings(InstanceBlockDeviceMapping... blockDeviceMappings)	Any block device mapping entries for the instance.
Instance.Builder	clientToken(String clientToken)	The idempotency token you provided when you launched the instance, if applicable.
Instance.Builder	ebsOptimized(Boolean ebsOptimized)	Indicates whether the instance is optimized for EBS I/O.
Instance.Builder	enaSupport(Boolean enaSupport)	Specifies whether enhanced networking with ENA is enabled.
Instance.Builder	hypervisor(String hypervisor)	The hypervisor type of the instance.
Instance.Builder	hypervisor(HypervisorType hypervisor)	The hypervisor type of the instance.
Instance.Builder	iamInstanceProfile(IamInstanceProfile iamInstanceProfile)	The IAM instance profile associated with the instance, if applicable.
Instance.Builder	imageId(String imageId)	The ID of the AMI used to launch the instance.
Instance.Builder	instanceId(String instanceId)	The ID of the instance.
Instance.Builder	instanceLifecycle(String instanceLifecycle)	Indicates whether this is a Spot instance or a Scheduled Instance.
Instance.Builder	instanceLifecycle(InstanceLifecycleType instanceLifecycle)	Indicates whether this is a Spot instance or a Scheduled Instance.
Instance.Builder	instanceType(String instanceType)	The instance type.
Instance.Builder	instanceType(InstanceType instanceType)	The instance type.
Instance.Builder	kernelId(String kernelId)	The kernel associated with this instance, if applicable.
Instance.Builder	keyName(String keyName)	The name of the key pair, if this instance was launched with an associated key pair.
Instance.Builder	launchTime(Date launchTime)	The time the instance was launched.
Instance.Builder	monitoring(Monitoring monitoring)	The monitoring for the instance.
Instance.Builder	networkInterfaces(Collection<InstanceNetworkInterface> networkInterfaces)	[EC2-VPC] One or more network interfaces for the instance.
Instance.Builder	networkInterfaces(InstanceNetworkInterface... networkInterfaces)	[EC2-VPC] One or more network interfaces for the instance.
Instance.Builder	placement(Placement placement)	The location where the instance launched, if applicable.
Instance.Builder	platform(String platform)	The value is Windows for Windows instances; otherwise blank.
Instance.Builder	platform(PlatformValues platform)	The value is Windows for Windows instances; otherwise blank.
Instance.Builder	privateDnsName(String privateDnsName)	(IPv4 only) The private DNS hostname name assigned to the instance.
Instance.Builder	privateIpAddress(String privateIpAddress)	The private IPv4 address assigned to the instance.
Instance.Builder	productCodes(Collection<ProductCode> productCodes)	The product codes attached to this instance, if applicable.
Instance.Builder	productCodes(ProductCode... productCodes)	The product codes attached to this instance, if applicable.
Instance.Builder	publicDnsName(String publicDnsName)	(IPv4 only) The public DNS name assigned to the instance.
Instance.Builder	publicIpAddress(String publicIpAddress)	The public IPv4 address assigned to the instance, if applicable.
Instance.Builder	ramdiskId(String ramdiskId)	The RAM disk associated with this instance, if applicable.
Instance.Builder	rootDeviceName(String rootDeviceName)	The root device name (for example, /dev/sda1 or /dev/xvda).
Instance.Builder	rootDeviceType(String rootDeviceType)	The root device type used by the AMI.
Instance.Builder	rootDeviceType(DeviceType rootDeviceType)	The root device type used by the AMI.
Instance.Builder	securityGroups(Collection<GroupIdentifier> securityGroups)	One or more security groups for the instance.
Instance.Builder	securityGroups(GroupIdentifier... securityGroups)	One or more security groups for the instance.
Instance.Builder	sourceDestCheck(Boolean sourceDestCheck)	Specifies whether to enable an instance launched in a VPC to perform NAT.
Instance.Builder	spotInstanceRequestId(String spotInstanceRequestId)	If the request is a Spot instance request, the ID of the request.
Instance.Builder	sriovNetSupport(String sriovNetSupport)	Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
Instance.Builder	state(InstanceState state)	The current state of the instance.
Instance.Builder	stateReason(StateReason stateReason)	The reason for the most recent state transition.
Instance.Builder	stateTransitionReason(String stateTransitionReason)	The reason for the most recent state transition.
Instance.Builder	subnetId(String subnetId)	[EC2-VPC] The ID of the subnet in which the instance is running.
Instance.Builder	tags(Collection<Tag> tags)	Any tags assigned to the instance.
Instance.Builder	tags(Tag... tags)	Any tags assigned to the instance.
Instance.Builder	virtualizationType(String virtualizationType)	The virtualization type of the instance.
Instance.Builder	virtualizationType(VirtualizationType virtualizationType)	The virtualization type of the instance.
Instance.Builder	vpcId(String vpcId)	[EC2-VPC] The ID of the VPC in which the instance is running.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

amiLaunchIndex

Instance.Builder amiLaunchIndex(Integer amiLaunchIndex)

The AMI launch index, which can be used to find this instance in the launch group.

Parameters:

amiLaunchIndex - The AMI launch index, which can be used to find this instance in the launch group.

Returns:

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

imageId

Instance.Builder imageId(String imageId)

The ID of the AMI used to launch the instance.

Parameters:

imageId - The ID of the AMI used to launch the instance.

Returns:

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

instanceId

Instance.Builder instanceId(String instanceId)

The ID of the instance.

Parameters:

instanceId - The ID of the instance.

Returns:

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

instanceType

Instance.Builder instanceType(String instanceType)

The instance type.

Parameters:

instanceType - The instance type.

Returns:

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

See Also:

InstanceType

instanceType

Instance.Builder instanceType(InstanceType instanceType)

The instance type.

Parameters:

instanceType - The instance type.

Returns:

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

See Also:

InstanceType

kernelId

Instance.Builder kernelId(String kernelId)

The kernel associated with this instance, if applicable.

Parameters:

kernelId - The kernel associated with this instance, if applicable.

Returns:

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

keyName

Instance.Builder keyName(String keyName)

The name of the key pair, if this instance was launched with an associated key pair.

Parameters:

keyName - The name of the key pair, if this instance was launched with an associated key pair.

Returns:

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

launchTime

Instance.Builder launchTime(Date launchTime)

The time the instance was launched.

Parameters:

launchTime - The time the instance was launched.

Returns:

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

monitoring

Instance.Builder monitoring(Monitoring monitoring)

The monitoring for the instance.

Parameters:

monitoring - The monitoring for the instance.

Returns:

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

placement

Instance.Builder placement(Placement placement)

The location where the instance launched, if applicable.

Parameters:

placement - The location where the instance launched, if applicable.

Returns:

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

platform

Instance.Builder platform(String platform)

The value is Windows for Windows instances; otherwise blank.

Parameters:

platform - The value is Windows for Windows instances; otherwise blank.

Returns:

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

See Also:

PlatformValues

platform

Instance.Builder platform(PlatformValues platform)

The value is Windows for Windows instances; otherwise blank.

Parameters:

platform - The value is Windows for Windows instances; otherwise blank.

Returns:

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

See Also:

PlatformValues

privateDnsName

Instance.Builder privateDnsName(String privateDnsName)

(IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.

[EC2-VPC] The Amazon-provided DNS server will resolve Amazon-provided private DNS hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.

Parameters:

privateDnsName - (IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.

[EC2-VPC] The Amazon-provided DNS server will resolve Amazon-provided private DNS hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.

Returns:

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

privateIpAddress

Instance.Builder privateIpAddress(String privateIpAddress)

The private IPv4 address assigned to the instance.

Parameters:

privateIpAddress - The private IPv4 address assigned to the instance.

Returns:

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

productCodes

Instance.Builder productCodes(Collection<ProductCode> productCodes)

The product codes attached to this instance, if applicable.

Parameters:

productCodes - The product codes attached to this instance, if applicable.

Returns:

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

productCodes

Instance.Builder productCodes(ProductCode... productCodes)

The product codes attached to this instance, if applicable.

NOTE: This method appends the values to the existing list (if any). Use #setProductCodes(java.util.Collection) or #withProductCodes(java.util.Collection) if you want to override the existing values.

Parameters:

productCodes - The product codes attached to this instance, if applicable.

Returns:

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

publicDnsName

Instance.Builder publicDnsName(String publicDnsName)

(IPv4 only) The public DNS name assigned to the instance. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you've enabled DNS hostnames for your VPC.

Parameters:

publicDnsName - (IPv4 only) The public DNS name assigned to the instance. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you've enabled DNS hostnames for your VPC.

Returns:

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

publicIpAddress

Instance.Builder publicIpAddress(String publicIpAddress)

The public IPv4 address assigned to the instance, if applicable.

Parameters:

publicIpAddress - The public IPv4 address assigned to the instance, if applicable.

Returns:

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

ramdiskId

Instance.Builder ramdiskId(String ramdiskId)

The RAM disk associated with this instance, if applicable.

Parameters:

ramdiskId - The RAM disk associated with this instance, if applicable.

Returns:

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

state

Instance.Builder state(InstanceState state)

The current state of the instance.

Parameters:

state - The current state of the instance.

Returns:

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

stateTransitionReason

Instance.Builder stateTransitionReason(String stateTransitionReason)

The reason for the most recent state transition. This might be an empty string.

Parameters:

stateTransitionReason - The reason for the most recent state transition. This might be an empty string.

Returns:

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

subnetId

Instance.Builder subnetId(String subnetId)

[EC2-VPC] The ID of the subnet in which the instance is running.

Parameters:

subnetId - [EC2-VPC] The ID of the subnet in which the instance is running.

Returns:

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

vpcId

Instance.Builder vpcId(String vpcId)

[EC2-VPC] The ID of the VPC in which the instance is running.

Parameters:

vpcId - [EC2-VPC] The ID of the VPC in which the instance is running.

Returns:

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

architecture

Instance.Builder architecture(String architecture)

The architecture of the image.

Parameters:

architecture - The architecture of the image.

Returns:

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

See Also:

ArchitectureValues

architecture

Instance.Builder architecture(ArchitectureValues architecture)

The architecture of the image.

Parameters:

architecture - The architecture of the image.

Returns:

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

See Also:

ArchitectureValues

blockDeviceMappings

Instance.Builder blockDeviceMappings(Collection<InstanceBlockDeviceMapping> blockDeviceMappings)

Any block device mapping entries for the instance.

Parameters:

blockDeviceMappings - Any block device mapping entries for the instance.

Returns:

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

blockDeviceMappings

Instance.Builder blockDeviceMappings(InstanceBlockDeviceMapping... blockDeviceMappings)

Any block device mapping entries for the instance.

NOTE: This method appends the values to the existing list (if any). Use #setBlockDeviceMappings(java.util.Collection) or #withBlockDeviceMappings(java.util.Collection) if you want to override the existing values.

Parameters:

blockDeviceMappings - Any block device mapping entries for the instance.

Returns:

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

clientToken

Instance.Builder clientToken(String clientToken)

The idempotency token you provided when you launched the instance, if applicable.

Parameters:

clientToken - The idempotency token you provided when you launched the instance, if applicable.

Returns:

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

ebsOptimized

Instance.Builder ebsOptimized(Boolean ebsOptimized)

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Parameters:

ebsOptimized - Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Returns:

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

enaSupport

Instance.Builder enaSupport(Boolean enaSupport)

Specifies whether enhanced networking with ENA is enabled.

Parameters:

enaSupport - Specifies whether enhanced networking with ENA is enabled.

Returns:

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

hypervisor

Instance.Builder hypervisor(String hypervisor)

The hypervisor type of the instance.

Parameters:

hypervisor - The hypervisor type of the instance.

Returns:

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

See Also:

HypervisorType

hypervisor

Instance.Builder hypervisor(HypervisorType hypervisor)

The hypervisor type of the instance.

Parameters:

hypervisor - The hypervisor type of the instance.

Returns:

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

See Also:

HypervisorType

iamInstanceProfile

Instance.Builder iamInstanceProfile(IamInstanceProfile iamInstanceProfile)

The IAM instance profile associated with the instance, if applicable.

Parameters:

iamInstanceProfile - The IAM instance profile associated with the instance, if applicable.

Returns:

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

instanceLifecycle

Instance.Builder instanceLifecycle(String instanceLifecycle)

Indicates whether this is a Spot instance or a Scheduled Instance.

Parameters:

instanceLifecycle - Indicates whether this is a Spot instance or a Scheduled Instance.

Returns:

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

See Also:

InstanceLifecycleType

instanceLifecycle

Instance.Builder instanceLifecycle(InstanceLifecycleType instanceLifecycle)

Indicates whether this is a Spot instance or a Scheduled Instance.

Parameters:

instanceLifecycle - Indicates whether this is a Spot instance or a Scheduled Instance.

Returns:

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

See Also:

InstanceLifecycleType

networkInterfaces

Instance.Builder networkInterfaces(Collection<InstanceNetworkInterface> networkInterfaces)

[EC2-VPC] One or more network interfaces for the instance.

Parameters:

networkInterfaces - [EC2-VPC] One or more network interfaces for the instance.

Returns:

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

networkInterfaces

Instance.Builder networkInterfaces(InstanceNetworkInterface... networkInterfaces)

[EC2-VPC] One or more network interfaces for the instance.

NOTE: This method appends the values to the existing list (if any). Use #setNetworkInterfaces(java.util.Collection) or #withNetworkInterfaces(java.util.Collection) if you want to override the existing values.

Parameters:

networkInterfaces - [EC2-VPC] One or more network interfaces for the instance.

Returns:

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

rootDeviceName

Instance.Builder rootDeviceName(String rootDeviceName)

The root device name (for example, /dev/sda1 or /dev/xvda).

Parameters:

rootDeviceName - The root device name (for example, /dev/sda1 or /dev/xvda).

Returns:

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

rootDeviceType

Instance.Builder rootDeviceType(String rootDeviceType)

The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.

Parameters:

rootDeviceType - The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.

Returns:

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

See Also:

DeviceType

rootDeviceType

Instance.Builder rootDeviceType(DeviceType rootDeviceType)

The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.

Parameters:

rootDeviceType - The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.

Returns:

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

See Also:

DeviceType

securityGroups

Instance.Builder securityGroups(Collection<GroupIdentifier> securityGroups)

One or more security groups for the instance.

Parameters:

securityGroups - One or more security groups for the instance.

Returns:

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

securityGroups

Instance.Builder securityGroups(GroupIdentifier... securityGroups)

One or more security groups for the instance.

NOTE: This method appends the values to the existing list (if any). Use #setSecurityGroups(java.util.Collection) or #withSecurityGroups(java.util.Collection) if you want to override the existing values.

Parameters:

securityGroups - One or more security groups for the instance.

Returns:

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

sourceDestCheck

Instance.Builder sourceDestCheck(Boolean sourceDestCheck)

Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

Parameters:

sourceDestCheck - Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

Returns:

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

spotInstanceRequestId

Instance.Builder spotInstanceRequestId(String spotInstanceRequestId)

If the request is a Spot instance request, the ID of the request.

Parameters:

spotInstanceRequestId - If the request is a Spot instance request, the ID of the request.

Returns:

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

sriovNetSupport

Instance.Builder sriovNetSupport(String sriovNetSupport)

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

Parameters:

sriovNetSupport - Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

Returns:

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

stateReason

Instance.Builder stateReason(StateReason stateReason)

The reason for the most recent state transition.

Parameters:

stateReason - The reason for the most recent state transition.

Returns:

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

tags

Instance.Builder tags(Collection<Tag> tags)

Any tags assigned to the instance.

Parameters:

tags - Any tags assigned to the instance.

Returns:

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

tags

Instance.Builder tags(Tag... tags)

Any tags assigned to the instance.

NOTE: This method appends the values to the existing list (if any). Use #setTags(java.util.Collection) or #withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - Any tags assigned to the instance.

Returns:

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

virtualizationType

Instance.Builder virtualizationType(String virtualizationType)

The virtualization type of the instance.

Parameters:

virtualizationType - The virtualization type of the instance.

Returns:

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

See Also:

VirtualizationType

virtualizationType

Instance.Builder virtualizationType(VirtualizationType virtualizationType)

The virtualization type of the instance.

Parameters:

virtualizationType - The virtualization type of the instance.

Returns:

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

See Also:

VirtualizationType