public static interface Instance.Builder extends CopyableBuilder<Instance.Builder,Instance>
Modifier and Type | Method and 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(Architecture architecture)
The instance architecture: "i386" or "x86_64".
|
Instance.Builder |
architecture(String architecture)
The instance architecture: "i386" or "x86_64".
|
Instance.Builder |
arn(String arn)
Sets the value of the Arn property for this object.
|
Instance.Builder |
autoScalingType(AutoScalingType autoScalingType)
For load-based or time-based instances, the type.
|
Instance.Builder |
autoScalingType(String autoScalingType)
For load-based or time-based instances, the type.
|
Instance.Builder |
availabilityZone(String availabilityZone)
The instance Availability Zone.
|
Instance.Builder |
blockDeviceMappings(BlockDeviceMapping... blockDeviceMappings)
An array of
BlockDeviceMapping objects that specify the instance's block device mappings. |
Instance.Builder |
blockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)
An array of
BlockDeviceMapping objects that specify the instance's block device mappings. |
Instance.Builder |
blockDeviceMappings(Consumer<BlockDeviceMapping.Builder>... 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(Collection<String> layerIds)
An array containing the instance layer IDs.
|
Instance.Builder |
layerIds(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.
|
default Instance.Builder |
reportedOs(Consumer<ReportedOs.Builder> reportedOs)
For registered instances, the reported operating system.
|
Instance.Builder |
reportedOs(ReportedOs reportedOs)
For registered instances, the reported operating system.
|
Instance.Builder |
rootDeviceType(RootDeviceType rootDeviceType)
The instance's root device type.
|
Instance.Builder |
rootDeviceType(String rootDeviceType)
The instance's root device type.
|
Instance.Builder |
rootDeviceVolumeId(String rootDeviceVolumeId)
The root device volume ID.
|
Instance.Builder |
securityGroupIds(Collection<String> securityGroupIds)
An array containing the instance security group IDs.
|
Instance.Builder |
securityGroupIds(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 . |
copy
applyMutation, build
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.
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.Instance.Builder amiId(String amiId)
A custom AMI ID to be used to create the instance. For more information, see Instances
amiId
- A custom AMI ID to be used to create the instance. For more information, see InstancesInstance.Builder architecture(String architecture)
The instance architecture: "i386" or "x86_64".
architecture
- The instance architecture: "i386" or "x86_64".Architecture
,
Architecture
Instance.Builder architecture(Architecture architecture)
The instance architecture: "i386" or "x86_64".
architecture
- The instance architecture: "i386" or "x86_64".Architecture
,
Architecture
Instance.Builder arn(String arn)
arn
- The new value for the Arn property for this object.Instance.Builder autoScalingType(String autoScalingType)
For load-based or time-based instances, the type.
autoScalingType
- For load-based or time-based instances, the type.AutoScalingType
,
AutoScalingType
Instance.Builder autoScalingType(AutoScalingType autoScalingType)
For load-based or time-based instances, the type.
autoScalingType
- For load-based or time-based instances, the type.AutoScalingType
,
AutoScalingType
Instance.Builder availabilityZone(String availabilityZone)
The instance Availability Zone. For more information, see Regions and Endpoints.
availabilityZone
- The instance Availability Zone. For more information, see Regions and Endpoints.Instance.Builder blockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)
An array of BlockDeviceMapping
objects that specify the instance's block device mappings.
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.
blockDeviceMappings
- An array of BlockDeviceMapping
objects that specify the instance's block device mappings.Instance.Builder blockDeviceMappings(Consumer<BlockDeviceMapping.Builder>... blockDeviceMappings)
An array of BlockDeviceMapping
objects that specify the instance's block device mappings.
List.Builder
avoiding the
need to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately
and its result is passed to #blockDeviceMappings(List)
.blockDeviceMappings
- a consumer that will call methods on List.Builder
#blockDeviceMappings(List)
Instance.Builder createdAt(String createdAt)
The time that the instance was created.
createdAt
- The time that the instance was created.Instance.Builder ebsOptimized(Boolean ebsOptimized)
Whether this is an Amazon EBS-optimized instance.
ebsOptimized
- Whether this is an Amazon EBS-optimized instance.Instance.Builder ec2InstanceId(String ec2InstanceId)
The ID of the associated Amazon EC2 instance.
ec2InstanceId
- The ID of the associated Amazon EC2 instance.Instance.Builder ecsClusterArn(String ecsClusterArn)
For container instances, the Amazon ECS cluster's ARN.
ecsClusterArn
- For container instances, the Amazon ECS cluster's ARN.Instance.Builder ecsContainerInstanceArn(String ecsContainerInstanceArn)
For container instances, the instance's ARN.
ecsContainerInstanceArn
- For container instances, the instance's ARN.Instance.Builder elasticIp(String elasticIp)
The instance Elastic IP address .
elasticIp
- The instance Elastic IP
address .Instance.Builder hostname(String hostname)
The instance host name.
hostname
- The instance host name.Instance.Builder infrastructureClass(String infrastructureClass)
For registered instances, the infrastructure class: ec2
or on-premises
.
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. 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.
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.
Instance.Builder instanceId(String instanceId)
The instance ID.
instanceId
- The instance ID.Instance.Builder instanceProfileArn(String instanceProfileArn)
The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using Identifiers.
instanceProfileArn
- The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using Identifiers.Instance.Builder instanceType(String instanceType)
The instance type, such as t2.micro
.
instanceType
- The instance type, such as t2.micro
.Instance.Builder lastServiceErrorId(String lastServiceErrorId)
The ID of the last service error. For more information, call DescribeServiceErrors.
lastServiceErrorId
- The ID of the last service error. For more information, call DescribeServiceErrors.Instance.Builder layerIds(Collection<String> layerIds)
An array containing the instance layer IDs.
layerIds
- An array containing the instance layer IDs.Instance.Builder layerIds(String... layerIds)
An array containing the instance layer IDs.
layerIds
- An array containing the instance layer IDs.Instance.Builder os(String os)
The instance's operating system.
os
- The instance's operating system.Instance.Builder platform(String platform)
The instance's platform.
platform
- The instance's platform.Instance.Builder privateDns(String privateDns)
The instance's private DNS name.
privateDns
- The instance's private DNS name.Instance.Builder privateIp(String privateIp)
The instance's private IP address.
privateIp
- The instance's private IP address.Instance.Builder publicDns(String publicDns)
The instance public DNS name.
publicDns
- The instance public DNS name.Instance.Builder publicIp(String publicIp)
The instance public IP address.
publicIp
- The instance public IP address.Instance.Builder registeredBy(String registeredBy)
For registered instances, who performed the registration.
registeredBy
- For registered instances, who performed the registration.Instance.Builder reportedAgentVersion(String reportedAgentVersion)
The instance's reported AWS OpsWorks Stacks agent version.
reportedAgentVersion
- The instance's reported AWS OpsWorks Stacks agent version.Instance.Builder reportedOs(ReportedOs reportedOs)
For registered instances, the reported operating system.
reportedOs
- For registered instances, the reported operating system.default Instance.Builder reportedOs(Consumer<ReportedOs.Builder> reportedOs)
For registered instances, the reported operating system.
This is a convenience that creates an instance of theReportedOs.Builder
avoiding the need to create
one manually via ReportedOs.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its result
is passed to reportedOs(ReportedOs)
.reportedOs
- a consumer that will call methods on ReportedOs.Builder
reportedOs(ReportedOs)
Instance.Builder rootDeviceType(String rootDeviceType)
The instance's root device type. For more information, see Storage for the Root Device.
rootDeviceType
- The instance's root device type. For more information, see Storage for the Root Device.RootDeviceType
,
RootDeviceType
Instance.Builder rootDeviceType(RootDeviceType rootDeviceType)
The instance's root device type. For more information, see Storage for the Root Device.
rootDeviceType
- The instance's root device type. For more information, see Storage for the Root Device.RootDeviceType
,
RootDeviceType
Instance.Builder rootDeviceVolumeId(String rootDeviceVolumeId)
The root device volume ID.
rootDeviceVolumeId
- The root device volume ID.Instance.Builder securityGroupIds(Collection<String> securityGroupIds)
An array containing the instance security group IDs.
securityGroupIds
- An array containing the instance security group IDs.Instance.Builder securityGroupIds(String... securityGroupIds)
An array containing the instance security group IDs.
securityGroupIds
- An array containing the instance security group IDs.Instance.Builder sshHostDsaKeyFingerprint(String sshHostDsaKeyFingerprint)
The SSH key's Deep Security Agent (DSA) fingerprint.
sshHostDsaKeyFingerprint
- The SSH key's Deep Security Agent (DSA) fingerprint.Instance.Builder sshHostRsaKeyFingerprint(String sshHostRsaKeyFingerprint)
The SSH key's RSA fingerprint.
sshHostRsaKeyFingerprint
- The SSH key's RSA fingerprint.Instance.Builder sshKeyName(String sshKeyName)
The instance's Amazon EC2 key-pair name.
sshKeyName
- The instance's Amazon EC2 key-pair name.Instance.Builder stackId(String stackId)
The stack ID.
stackId
- The stack ID.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
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
Instance.Builder subnetId(String subnetId)
The instance's subnet ID; applicable only if the stack is running in a VPC.
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
.
tenancy
- The instance's tenancy option, such as dedicated
or host
.Instance.Builder virtualizationType(String virtualizationType)
The instance's virtualization type: paravirtual
or hvm
.
virtualizationType
- The instance's virtualization type: paravirtual
or hvm
.VirtualizationType
,
VirtualizationType
Instance.Builder virtualizationType(VirtualizationType virtualizationType)
The instance's virtualization type: paravirtual
or hvm
.
virtualizationType
- The instance's virtualization type: paravirtual
or hvm
.VirtualizationType
,
VirtualizationType
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.