Instance.Builder (AWS SDK for Java

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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Instance.Builder`	`agentVersion(String agentVersion)`	The agent version.
`Instance.Builder`	`amiId(String amiId)`	A custom AMI ID to be used to create the instance.
`Instance.Builder`	`architecture(String architecture)`	The instance architecture: "i386" or "x86_64".
`Instance.Builder`	`architecture(Architecture architecture)`	The instance architecture: "i386" or "x86_64".
`Instance.Builder`	`arn(String arn)`
`Instance.Builder`	`autoScalingType(String autoScalingType)`	For load-based or time-based instances, the type.
`Instance.Builder`	`autoScalingType(AutoScalingType autoScalingType)`	For load-based or time-based instances, the type.
`Instance.Builder`	`availabilityZone(String availabilityZone)`	The instance Availability Zone.
`Instance.Builder`	`blockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)`	An array of `BlockDeviceMapping` objects that specify the instance's block device mappings.
`Instance.Builder`	`blockDeviceMappings(BlockDeviceMapping... blockDeviceMappings)`	An array of `BlockDeviceMapping` objects that specify the instance's block device mappings.
`Instance.Builder`	`createdAt(String createdAt)`	The time that the instance was created.
`Instance.Builder`	`ebsOptimized(Boolean ebsOptimized)`	Whether this is an Amazon EBS-optimized instance.
`Instance.Builder`	`ec2InstanceId(String ec2InstanceId)`	The ID of the associated Amazon EC2 instance.
`Instance.Builder`	`ecsClusterArn(String ecsClusterArn)`	For container instances, the Amazon ECS cluster's ARN.
`Instance.Builder`	`ecsContainerInstanceArn(String ecsContainerInstanceArn)`	For container instances, the instance's ARN.
`Instance.Builder`	`elasticIp(String elasticIp)`	The instance Elastic IP address .
`Instance.Builder`	`hostname(String hostname)`	The instance host name.
`Instance.Builder`	`infrastructureClass(String infrastructureClass)`	For registered instances, the infrastructure class: `ec2` or `on-premises`.
`Instance.Builder`	`installUpdatesOnBoot(Boolean installUpdatesOnBoot)`	Whether to install operating system and package updates when the instance boots.
`Instance.Builder`	`instanceId(String instanceId)`	The instance ID.
`Instance.Builder`	`instanceProfileArn(String instanceProfileArn)`	The ARN of the instance's IAM profile.
`Instance.Builder`	`instanceType(String instanceType)`	The instance type, such as `t2.micro`.
`Instance.Builder`	`lastServiceErrorId(String lastServiceErrorId)`	The ID of the last service error.
`Instance.Builder`	`layerIds(String... layerIds)`	An array containing the instance layer IDs.
`Instance.Builder`	`layerIds(Collection<String> layerIds)`	An array containing the instance layer IDs.
`Instance.Builder`	`os(String os)`	The instance's operating system.
`Instance.Builder`	`platform(String platform)`	The instance's platform.
`Instance.Builder`	`privateDns(String privateDns)`	The instance's private DNS name.
`Instance.Builder`	`privateIp(String privateIp)`	The instance's private IP address.
`Instance.Builder`	`publicDns(String publicDns)`	The instance public DNS name.
`Instance.Builder`	`publicIp(String publicIp)`	The instance public IP address.
`Instance.Builder`	`registeredBy(String registeredBy)`	For registered instances, who performed the registration.
`Instance.Builder`	`reportedAgentVersion(String reportedAgentVersion)`	The instance's reported AWS OpsWorks Stacks agent version.
`Instance.Builder`	`reportedOs(ReportedOs reportedOs)`	For registered instances, the reported operating system.
`Instance.Builder`	`rootDeviceType(String rootDeviceType)`	The instance's root device type.
`Instance.Builder`	`rootDeviceType(RootDeviceType rootDeviceType)`	The instance's root device type.
`Instance.Builder`	`rootDeviceVolumeId(String rootDeviceVolumeId)`	The root device volume ID.
`Instance.Builder`	`securityGroupIds(String... securityGroupIds)`	An array containing the instance security group IDs.
`Instance.Builder`	`securityGroupIds(Collection<String> securityGroupIds)`	An array containing the instance security group IDs.
`Instance.Builder`	`sshHostDsaKeyFingerprint(String sshHostDsaKeyFingerprint)`	The SSH key's Deep Security Agent (DSA) fingerprint.
`Instance.Builder`	`sshHostRsaKeyFingerprint(String sshHostRsaKeyFingerprint)`	The SSH key's RSA fingerprint.
`Instance.Builder`	`sshKeyName(String sshKeyName)`	The instance's Amazon EC2 key-pair name.
`Instance.Builder`	`stackId(String stackId)`	The stack ID.
`Instance.Builder`	`status(String status)`	The instance status:
`Instance.Builder`	`subnetId(String subnetId)`	The instance's subnet ID; applicable only if the stack is running in a VPC.
`Instance.Builder`	`tenancy(String tenancy)`	The instance's tenancy option, such as `dedicated` or `host`.
`Instance.Builder`	`virtualizationType(String virtualizationType)`	The instance's virtualization type: `paravirtual` or `hvm`.
`Instance.Builder`	`virtualizationType(VirtualizationType virtualizationType)`	The instance's virtualization type: `paravirtual` or `hvm`.

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
  - agentVersion
```
Instance.Builder agentVersion(String agentVersion)
```
    The agent version. This parameter is set to INHERIT if the instance inherits the default stack setting or to a a version number for a fixed agent version.
    
    Parameters:
    
    agentVersion - The agent version. This parameter is set to INHERIT if the instance inherits the default stack setting or to a a version number for a fixed agent version.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - amiId
```
Instance.Builder amiId(String amiId)
```
    A custom AMI ID to be used to create the instance. For more information, see Instances
    
    Parameters:
    
    amiId - A custom AMI ID to be used to create the instance. For more information, see Instances
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - architecture
```
Instance.Builder architecture(String architecture)
```
    The instance architecture: "i386" or "x86_64".
    
    Parameters:
    
    architecture - The instance architecture: "i386" or "x86_64".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Architecture
  - architecture
```
Instance.Builder architecture(Architecture architecture)
```
    The instance architecture: "i386" or "x86_64".
    
    Parameters:
    
    architecture - The instance architecture: "i386" or "x86_64".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Architecture
  - arn
```
Instance.Builder arn(String arn)
```
    Parameters:
    
    arn -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - autoScalingType
```
Instance.Builder autoScalingType(String autoScalingType)
```
    For load-based or time-based instances, the type.
    
    Parameters:
    
    autoScalingType - For load-based or time-based instances, the type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AutoScalingType
  - autoScalingType
```
Instance.Builder autoScalingType(AutoScalingType autoScalingType)
```
    For load-based or time-based instances, the type.
    
    Parameters:
    
    autoScalingType - For load-based or time-based instances, the type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AutoScalingType
  - availabilityZone
```
Instance.Builder availabilityZone(String availabilityZone)
```
    The instance Availability Zone. For more information, see Regions and Endpoints.
    
    Parameters:
    
    availabilityZone - The instance Availability Zone. For more information, see Regions and Endpoints.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - blockDeviceMappings
```
Instance.Builder blockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)
```
    An array of BlockDeviceMapping objects that specify the instance's block device mappings.
    
    Parameters:
    
    blockDeviceMappings - An array of BlockDeviceMapping objects that specify the instance's block device mappings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - blockDeviceMappings
```
Instance.Builder blockDeviceMappings(BlockDeviceMapping... blockDeviceMappings)
```
    An array of BlockDeviceMapping objects that specify the instance's block device mappings.
    
    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 - An array of BlockDeviceMapping objects that specify the instance's block device mappings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - createdAt
```
Instance.Builder createdAt(String createdAt)
```
    The time that the instance was created.
    
    Parameters:
    
    createdAt - The time that the instance was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - ebsOptimized
```
Instance.Builder ebsOptimized(Boolean ebsOptimized)
```
    Whether this is an Amazon EBS-optimized instance.
    
    Parameters:
    
    ebsOptimized - Whether this is an Amazon EBS-optimized instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - ec2InstanceId
```
Instance.Builder ec2InstanceId(String ec2InstanceId)
```
    The ID of the associated Amazon EC2 instance.
    
    Parameters:
    
    ec2InstanceId - The ID of the associated Amazon EC2 instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - ecsClusterArn
```
Instance.Builder ecsClusterArn(String ecsClusterArn)
```
    For container instances, the Amazon ECS cluster's ARN.
    
    Parameters:
    
    ecsClusterArn - For container instances, the Amazon ECS cluster's ARN.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - ecsContainerInstanceArn
```
Instance.Builder ecsContainerInstanceArn(String ecsContainerInstanceArn)
```
    For container instances, the instance's ARN.
    
    Parameters:
    
    ecsContainerInstanceArn - For container instances, the instance's ARN.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - elasticIp
```
Instance.Builder elasticIp(String elasticIp)
```
    The instance Elastic IP address .
    
    Parameters:
    
    elasticIp - The instance Elastic IP address .
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - hostname
```
Instance.Builder hostname(String hostname)
```
    The instance host name.
    
    Parameters:
    
    hostname - The instance host name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - infrastructureClass
```
Instance.Builder infrastructureClass(String infrastructureClass)
```
    For registered instances, the infrastructure class: ec2 or on-premises.
    
    Parameters:
    
    infrastructureClass - For registered instances, the infrastructure class: ec2 or on-premises.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - installUpdatesOnBoot
```
Instance.Builder installUpdatesOnBoot(Boolean installUpdatesOnBoot)
```
    Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set to false, you must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
    
    We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.
    
    Parameters:
    
    installUpdatesOnBoot - Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set to false, you must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
    
    We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - instanceId
```
Instance.Builder instanceId(String instanceId)
```
    The instance ID.
    
    Parameters:
    
    instanceId - The instance ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - instanceProfileArn
```
Instance.Builder instanceProfileArn(String instanceProfileArn)
```
    The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using Identifiers.
    
    Parameters:
    
    instanceProfileArn - The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using Identifiers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - instanceType
```
Instance.Builder instanceType(String instanceType)
```
    The instance type, such as t2.micro.
    
    Parameters:
    
    instanceType - The instance type, such as t2.micro.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - lastServiceErrorId
```
Instance.Builder lastServiceErrorId(String lastServiceErrorId)
```
    The ID of the last service error. For more information, call DescribeServiceErrors.
    
    Parameters:
    
    lastServiceErrorId - The ID of the last service error. For more information, call DescribeServiceErrors.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - layerIds
```
Instance.Builder layerIds(Collection<String> layerIds)
```
    An array containing the instance layer IDs.
    
    Parameters:
    
    layerIds - An array containing the instance layer IDs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - layerIds
```
Instance.Builder layerIds(String... layerIds)
```
    An array containing the instance layer IDs.
    
    NOTE: This method appends the values to the existing list (if any). Use #setLayerIds(java.util.Collection) or #withLayerIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    layerIds - An array containing the instance layer IDs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - os
```
Instance.Builder os(String os)
```
    The instance's operating system.
    
    Parameters:
    
    os - The instance's operating system.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - platform
```
Instance.Builder platform(String platform)
```
    The instance's platform.
    
    Parameters:
    
    platform - The instance's platform.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - privateDns
```
Instance.Builder privateDns(String privateDns)
```
    The instance's private DNS name.
    
    Parameters:
    
    privateDns - The instance's private DNS name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - privateIp
```
Instance.Builder privateIp(String privateIp)
```
    The instance's private IP address.
    
    Parameters:
    
    privateIp - The instance's private IP address.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - publicDns
```
Instance.Builder publicDns(String publicDns)
```
    The instance public DNS name.
    
    Parameters:
    
    publicDns - The instance public DNS name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - publicIp
```
Instance.Builder publicIp(String publicIp)
```
    The instance public IP address.
    
    Parameters:
    
    publicIp - The instance public IP address.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - registeredBy
```
Instance.Builder registeredBy(String registeredBy)
```
    For registered instances, who performed the registration.
    
    Parameters:
    
    registeredBy - For registered instances, who performed the registration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - reportedAgentVersion
```
Instance.Builder reportedAgentVersion(String reportedAgentVersion)
```
    The instance's reported AWS OpsWorks Stacks agent version.
    
    Parameters:
    
    reportedAgentVersion - The instance's reported AWS OpsWorks Stacks agent version.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - reportedOs
```
Instance.Builder reportedOs(ReportedOs reportedOs)
```
    For registered instances, the reported operating system.
    
    Parameters:
    
    reportedOs - For registered instances, the reported operating system.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - rootDeviceType
```
Instance.Builder rootDeviceType(String rootDeviceType)
```
    The instance's root device type. For more information, see Storage for the Root Device.
    
    Parameters:
    
    rootDeviceType - The instance's root device type. For more information, see Storage for the Root Device.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RootDeviceType
  - rootDeviceType
```
Instance.Builder rootDeviceType(RootDeviceType rootDeviceType)
```
    The instance's root device type. For more information, see Storage for the Root Device.
    
    Parameters:
    
    rootDeviceType - The instance's root device type. For more information, see Storage for the Root Device.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RootDeviceType
  - rootDeviceVolumeId
```
Instance.Builder rootDeviceVolumeId(String rootDeviceVolumeId)
```
    The root device volume ID.
    
    Parameters:
    
    rootDeviceVolumeId - The root device volume ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - securityGroupIds
```
Instance.Builder securityGroupIds(Collection<String> securityGroupIds)
```
    An array containing the instance security group IDs.
    
    Parameters:
    
    securityGroupIds - An array containing the instance security group IDs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - securityGroupIds
```
Instance.Builder securityGroupIds(String... securityGroupIds)
```
    An array containing the instance security group IDs.
    
    NOTE: This method appends the values to the existing list (if any). Use #setSecurityGroupIds(java.util.Collection) or #withSecurityGroupIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    securityGroupIds - An array containing the instance security group IDs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - sshHostDsaKeyFingerprint
```
Instance.Builder sshHostDsaKeyFingerprint(String sshHostDsaKeyFingerprint)
```
    The SSH key's Deep Security Agent (DSA) fingerprint.
    
    Parameters:
    
    sshHostDsaKeyFingerprint - The SSH key's Deep Security Agent (DSA) fingerprint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - sshHostRsaKeyFingerprint
```
Instance.Builder sshHostRsaKeyFingerprint(String sshHostRsaKeyFingerprint)
```
    The SSH key's RSA fingerprint.
    
    Parameters:
    
    sshHostRsaKeyFingerprint - The SSH key's RSA fingerprint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - sshKeyName
```
Instance.Builder sshKeyName(String sshKeyName)
```
    The instance's Amazon EC2 key-pair name.
    
    Parameters:
    
    sshKeyName - The instance's Amazon EC2 key-pair name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - stackId
```
Instance.Builder stackId(String stackId)
```
    The stack ID.
    
    Parameters:
    
    stackId - The stack ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - status
```
Instance.Builder status(String status)
```
    The instance status:
    - booting
    - connection_lost
    - online
    - pending
    - rebooting
    - requested
    - running_setup
    - setup_failed
    - shutting_down
    - start_failed
    - stop_failed
    - stopped
    - stopping
    - terminated
    - terminating
    Parameters:
    status - The instance status:
    
    booting
    
    connection_lost
    
    online
    
    pending
    
    rebooting
    
    requested
    
    running_setup
    
    setup_failed
    
    shutting_down
    
    start_failed
    
    stop_failed
    
    stopped
    
    stopping
    
    terminated
    
    terminating
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - subnetId
```
Instance.Builder subnetId(String subnetId)
```
    The instance's subnet ID; applicable only if the stack is running in a VPC.
    
    Parameters:
    
    subnetId - The instance's subnet ID; applicable only if the stack is running in a VPC.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tenancy
```
Instance.Builder tenancy(String tenancy)
```
    The instance's tenancy option, such as dedicated or host.
    
    Parameters:
    
    tenancy - The instance's tenancy option, such as dedicated or host.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - virtualizationType
```
Instance.Builder virtualizationType(String virtualizationType)
```
    The instance's virtualization type: paravirtual or hvm.
    
    Parameters:
    
    virtualizationType - The instance's virtualization type: paravirtual or hvm.
    
    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 instance's virtualization type: paravirtual or hvm.
    
    Parameters:
    
    virtualizationType - The instance's virtualization type: paravirtual or hvm.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VirtualizationType

Interface Instance.Builder

Method Summary

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

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

Method Detail

agentVersion

amiId

architecture

architecture

arn

autoScalingType

autoScalingType

availabilityZone

blockDeviceMappings

blockDeviceMappings

createdAt

ebsOptimized

ec2InstanceId

ecsClusterArn

ecsContainerInstanceArn

elasticIp

hostname

infrastructureClass

installUpdatesOnBoot

instanceId

instanceProfileArn

instanceType

lastServiceErrorId

layerIds

layerIds

os

platform

privateDns

privateIp

publicDns

publicIp

registeredBy

reportedAgentVersion

reportedOs

rootDeviceType

rootDeviceType

rootDeviceVolumeId

securityGroupIds

securityGroupIds

sshHostDsaKeyFingerprint

sshHostRsaKeyFingerprint

sshKeyName

stackId

status

subnetId

tenancy

virtualizationType

virtualizationType