Class Instance
- java.lang.Object
-
- com.amazonaws.services.opsworks.model.Instance
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class Instance extends Object implements Serializable, Cloneable
Describes an instance.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description Instance()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Instance
clone()
boolean
equals(Object obj)
String
getAgentVersion()
The agent version.String
getAmiId()
A custom AMI ID to be used to create the instance.String
getArchitecture()
The instance architecture: "i386" or "x86_64".String
getAutoScalingType()
For load-based or time-based instances, the type.String
getAvailabilityZone()
The instance Availability Zone.List<BlockDeviceMapping>
getBlockDeviceMappings()
An array ofBlockDeviceMapping
objects that specify the instance's block device mappings.String
getCreatedAt()
The time that the instance was created.Boolean
getEbsOptimized()
Whether this is an Amazon EBS-optimized instance.String
getEc2InstanceId()
The ID of the associated Amazon EC2 instance.String
getEcsClusterArn()
For container instances, the Amazon ECS cluster's ARN.String
getEcsContainerInstanceArn()
For container instances, the instance's ARN.String
getElasticIp()
The instance Elastic IP address .String
getHostname()
The instance host name.String
getInfrastructureClass()
For registered instances, the infrastructure class:ec2
oron-premises
.Boolean
getInstallUpdatesOnBoot()
Whether to install operating system and package updates when the instance boots.String
getInstanceId()
The instance ID.String
getInstanceProfileArn()
The ARN of the instance's IAM profile.String
getInstanceType()
The instance type, such ast2.micro
.String
getLastServiceErrorId()
The ID of the last service error.List<String>
getLayerIds()
An array containing the instance layer IDs.String
getOs()
The instance's operating system.String
getPlatform()
The instance's platform.String
getPrivateDns()
The The instance's private DNS name.String
getPrivateIp()
The instance's private IP address.String
getPublicDns()
The instance public DNS name.String
getPublicIp()
The instance public IP address.String
getRegisteredBy()
For registered instances, who performed the registration.String
getReportedAgentVersion()
The instance's reported AWS OpsWorks agent version.ReportedOs
getReportedOs()
For registered instances, the reported operating system.String
getRootDeviceType()
The instance's root device type.String
getRootDeviceVolumeId()
The root device volume ID.List<String>
getSecurityGroupIds()
An array containing the instance security group IDs.String
getSshHostDsaKeyFingerprint()
The SSH key's Deep Security Agent (DSA) fingerprint.String
getSshHostRsaKeyFingerprint()
The SSH key's RSA fingerprint.String
getSshKeyName()
The instance's Amazon EC2 key-pair name.String
getStackId()
The stack ID.String
getStatus()
The instance status:String
getSubnetId()
The instance's subnet ID; applicable only if the stack is running in a VPC.String
getTenancy()
The instance's tenancy option, such asdedicated
orhost
.String
getVirtualizationType()
The instance's virtualization type:paravirtual
orhvm
.int
hashCode()
Boolean
isEbsOptimized()
Whether this is an Amazon EBS-optimized instance.Boolean
isInstallUpdatesOnBoot()
Whether to install operating system and package updates when the instance boots.void
setAgentVersion(String agentVersion)
The agent version.void
setAmiId(String amiId)
A custom AMI ID to be used to create the instance.void
setArchitecture(Architecture architecture)
The instance architecture: "i386" or "x86_64".void
setArchitecture(String architecture)
The instance architecture: "i386" or "x86_64".void
setAutoScalingType(AutoScalingType autoScalingType)
For load-based or time-based instances, the type.void
setAutoScalingType(String autoScalingType)
For load-based or time-based instances, the type.void
setAvailabilityZone(String availabilityZone)
The instance Availability Zone.void
setBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)
An array ofBlockDeviceMapping
objects that specify the instance's block device mappings.void
setCreatedAt(String createdAt)
The time that the instance was created.void
setEbsOptimized(Boolean ebsOptimized)
Whether this is an Amazon EBS-optimized instance.void
setEc2InstanceId(String ec2InstanceId)
The ID of the associated Amazon EC2 instance.void
setEcsClusterArn(String ecsClusterArn)
For container instances, the Amazon ECS cluster's ARN.void
setEcsContainerInstanceArn(String ecsContainerInstanceArn)
For container instances, the instance's ARN.void
setElasticIp(String elasticIp)
The instance Elastic IP address .void
setHostname(String hostname)
The instance host name.void
setInfrastructureClass(String infrastructureClass)
For registered instances, the infrastructure class:ec2
oron-premises
.void
setInstallUpdatesOnBoot(Boolean installUpdatesOnBoot)
Whether to install operating system and package updates when the instance boots.void
setInstanceId(String instanceId)
The instance ID.void
setInstanceProfileArn(String instanceProfileArn)
The ARN of the instance's IAM profile.void
setInstanceType(String instanceType)
The instance type, such ast2.micro
.void
setLastServiceErrorId(String lastServiceErrorId)
The ID of the last service error.void
setLayerIds(Collection<String> layerIds)
An array containing the instance layer IDs.void
setOs(String os)
The instance's operating system.void
setPlatform(String platform)
The instance's platform.void
setPrivateDns(String privateDns)
The The instance's private DNS name.void
setPrivateIp(String privateIp)
The instance's private IP address.void
setPublicDns(String publicDns)
The instance public DNS name.void
setPublicIp(String publicIp)
The instance public IP address.void
setRegisteredBy(String registeredBy)
For registered instances, who performed the registration.void
setReportedAgentVersion(String reportedAgentVersion)
The instance's reported AWS OpsWorks agent version.void
setReportedOs(ReportedOs reportedOs)
For registered instances, the reported operating system.void
setRootDeviceType(RootDeviceType rootDeviceType)
The instance's root device type.void
setRootDeviceType(String rootDeviceType)
The instance's root device type.void
setRootDeviceVolumeId(String rootDeviceVolumeId)
The root device volume ID.void
setSecurityGroupIds(Collection<String> securityGroupIds)
An array containing the instance security group IDs.void
setSshHostDsaKeyFingerprint(String sshHostDsaKeyFingerprint)
The SSH key's Deep Security Agent (DSA) fingerprint.void
setSshHostRsaKeyFingerprint(String sshHostRsaKeyFingerprint)
The SSH key's RSA fingerprint.void
setSshKeyName(String sshKeyName)
The instance's Amazon EC2 key-pair name.void
setStackId(String stackId)
The stack ID.void
setStatus(String status)
The instance status:void
setSubnetId(String subnetId)
The instance's subnet ID; applicable only if the stack is running in a VPC.void
setTenancy(String tenancy)
The instance's tenancy option, such asdedicated
orhost
.void
setVirtualizationType(VirtualizationType virtualizationType)
The instance's virtualization type:paravirtual
orhvm
.void
setVirtualizationType(String virtualizationType)
The instance's virtualization type:paravirtual
orhvm
.String
toString()
Returns a string representation of this object; useful for testing and debugging.Instance
withAgentVersion(String agentVersion)
The agent version.Instance
withAmiId(String amiId)
A custom AMI ID to be used to create the instance.Instance
withArchitecture(Architecture architecture)
The instance architecture: "i386" or "x86_64".Instance
withArchitecture(String architecture)
The instance architecture: "i386" or "x86_64".Instance
withAutoScalingType(AutoScalingType autoScalingType)
For load-based or time-based instances, the type.Instance
withAutoScalingType(String autoScalingType)
For load-based or time-based instances, the type.Instance
withAvailabilityZone(String availabilityZone)
The instance Availability Zone.Instance
withBlockDeviceMappings(BlockDeviceMapping... blockDeviceMappings)
An array ofBlockDeviceMapping
objects that specify the instance's block device mappings.Instance
withBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)
An array ofBlockDeviceMapping
objects that specify the instance's block device mappings.Instance
withCreatedAt(String createdAt)
The time that the instance was created.Instance
withEbsOptimized(Boolean ebsOptimized)
Whether this is an Amazon EBS-optimized instance.Instance
withEc2InstanceId(String ec2InstanceId)
The ID of the associated Amazon EC2 instance.Instance
withEcsClusterArn(String ecsClusterArn)
For container instances, the Amazon ECS cluster's ARN.Instance
withEcsContainerInstanceArn(String ecsContainerInstanceArn)
For container instances, the instance's ARN.Instance
withElasticIp(String elasticIp)
The instance Elastic IP address .Instance
withHostname(String hostname)
The instance host name.Instance
withInfrastructureClass(String infrastructureClass)
For registered instances, the infrastructure class:ec2
oron-premises
.Instance
withInstallUpdatesOnBoot(Boolean installUpdatesOnBoot)
Whether to install operating system and package updates when the instance boots.Instance
withInstanceId(String instanceId)
The instance ID.Instance
withInstanceProfileArn(String instanceProfileArn)
The ARN of the instance's IAM profile.Instance
withInstanceType(String instanceType)
The instance type, such ast2.micro
.Instance
withLastServiceErrorId(String lastServiceErrorId)
The ID of the last service error.Instance
withLayerIds(String... layerIds)
An array containing the instance layer IDs.Instance
withLayerIds(Collection<String> layerIds)
An array containing the instance layer IDs.Instance
withOs(String os)
The instance's operating system.Instance
withPlatform(String platform)
The instance's platform.Instance
withPrivateDns(String privateDns)
The The instance's private DNS name.Instance
withPrivateIp(String privateIp)
The instance's private IP address.Instance
withPublicDns(String publicDns)
The instance public DNS name.Instance
withPublicIp(String publicIp)
The instance public IP address.Instance
withRegisteredBy(String registeredBy)
For registered instances, who performed the registration.Instance
withReportedAgentVersion(String reportedAgentVersion)
The instance's reported AWS OpsWorks agent version.Instance
withReportedOs(ReportedOs reportedOs)
For registered instances, the reported operating system.Instance
withRootDeviceType(RootDeviceType rootDeviceType)
The instance's root device type.Instance
withRootDeviceType(String rootDeviceType)
The instance's root device type.Instance
withRootDeviceVolumeId(String rootDeviceVolumeId)
The root device volume ID.Instance
withSecurityGroupIds(String... securityGroupIds)
An array containing the instance security group IDs.Instance
withSecurityGroupIds(Collection<String> securityGroupIds)
An array containing the instance security group IDs.Instance
withSshHostDsaKeyFingerprint(String sshHostDsaKeyFingerprint)
The SSH key's Deep Security Agent (DSA) fingerprint.Instance
withSshHostRsaKeyFingerprint(String sshHostRsaKeyFingerprint)
The SSH key's RSA fingerprint.Instance
withSshKeyName(String sshKeyName)
The instance's Amazon EC2 key-pair name.Instance
withStackId(String stackId)
The stack ID.Instance
withStatus(String status)
The instance status:Instance
withSubnetId(String subnetId)
The instance's subnet ID; applicable only if the stack is running in a VPC.Instance
withTenancy(String tenancy)
The instance's tenancy option, such asdedicated
orhost
.Instance
withVirtualizationType(VirtualizationType virtualizationType)
The instance's virtualization type:paravirtual
orhvm
.Instance
withVirtualizationType(String virtualizationType)
The instance's virtualization type:paravirtual
orhvm
.
-
-
-
Method Detail
-
setAgentVersion
public void setAgentVersion(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 toINHERIT
if the instance inherits the default stack setting or to a a version number for a fixed agent version.
-
getAgentVersion
public String getAgentVersion()
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:
- 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.
-
withAgentVersion
public Instance withAgentVersion(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 toINHERIT
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.
-
setAmiId
public void setAmiId(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
-
getAmiId
public String getAmiId()
A custom AMI ID to be used to create the instance. For more information, see Instances
- Returns:
- A custom AMI ID to be used to create the instance. For more information, see Instances
-
withAmiId
public Instance withAmiId(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.
-
setArchitecture
public void setArchitecture(String architecture)
The instance architecture: "i386" or "x86_64".
- Parameters:
architecture
- The instance architecture: "i386" or "x86_64".- See Also:
Architecture
-
getArchitecture
public String getArchitecture()
The instance architecture: "i386" or "x86_64".
- Returns:
- The instance architecture: "i386" or "x86_64".
- See Also:
Architecture
-
withArchitecture
public Instance withArchitecture(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
-
setArchitecture
public void setArchitecture(Architecture architecture)
The instance architecture: "i386" or "x86_64".
- Parameters:
architecture
- The instance architecture: "i386" or "x86_64".- See Also:
Architecture
-
withArchitecture
public Instance withArchitecture(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
-
setAutoScalingType
public void setAutoScalingType(String autoScalingType)
For load-based or time-based instances, the type.
- Parameters:
autoScalingType
- For load-based or time-based instances, the type.- See Also:
AutoScalingType
-
getAutoScalingType
public String getAutoScalingType()
For load-based or time-based instances, the type.
- Returns:
- For load-based or time-based instances, the type.
- See Also:
AutoScalingType
-
withAutoScalingType
public Instance withAutoScalingType(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
-
setAutoScalingType
public void setAutoScalingType(AutoScalingType autoScalingType)
For load-based or time-based instances, the type.
- Parameters:
autoScalingType
- For load-based or time-based instances, the type.- See Also:
AutoScalingType
-
withAutoScalingType
public Instance withAutoScalingType(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
-
setAvailabilityZone
public void setAvailabilityZone(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.
-
getAvailabilityZone
public String getAvailabilityZone()
The instance Availability Zone. For more information, see Regions and Endpoints.
- Returns:
- The instance Availability Zone. For more information, see Regions and Endpoints.
-
withAvailabilityZone
public Instance withAvailabilityZone(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.
-
getBlockDeviceMappings
public List<BlockDeviceMapping> getBlockDeviceMappings()
An array of
BlockDeviceMapping
objects that specify the instance's block device mappings.- Returns:
- An array of
BlockDeviceMapping
objects that specify the instance's block device mappings.
-
setBlockDeviceMappings
public void setBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)
An array of
BlockDeviceMapping
objects that specify the instance's block device mappings.- Parameters:
blockDeviceMappings
- An array ofBlockDeviceMapping
objects that specify the instance's block device mappings.
-
withBlockDeviceMappings
public Instance withBlockDeviceMappings(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)
orwithBlockDeviceMappings(java.util.Collection)
if you want to override the existing values.- Parameters:
blockDeviceMappings
- An array ofBlockDeviceMapping
objects that specify the instance's block device mappings.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withBlockDeviceMappings
public Instance withBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)
An array of
BlockDeviceMapping
objects that specify the instance's block device mappings.- Parameters:
blockDeviceMappings
- An array ofBlockDeviceMapping
objects that specify the instance's block device mappings.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCreatedAt
public void setCreatedAt(String createdAt)
The time that the instance was created.
- Parameters:
createdAt
- The time that the instance was created.
-
getCreatedAt
public String getCreatedAt()
The time that the instance was created.
- Returns:
- The time that the instance was created.
-
withCreatedAt
public Instance withCreatedAt(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.
-
setEbsOptimized
public void setEbsOptimized(Boolean ebsOptimized)
Whether this is an Amazon EBS-optimized instance.
- Parameters:
ebsOptimized
- Whether this is an Amazon EBS-optimized instance.
-
getEbsOptimized
public Boolean getEbsOptimized()
Whether this is an Amazon EBS-optimized instance.
- Returns:
- Whether this is an Amazon EBS-optimized instance.
-
withEbsOptimized
public Instance withEbsOptimized(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.
-
isEbsOptimized
public Boolean isEbsOptimized()
Whether this is an Amazon EBS-optimized instance.
- Returns:
- Whether this is an Amazon EBS-optimized instance.
-
setEc2InstanceId
public void setEc2InstanceId(String ec2InstanceId)
The ID of the associated Amazon EC2 instance.
- Parameters:
ec2InstanceId
- The ID of the associated Amazon EC2 instance.
-
getEc2InstanceId
public String getEc2InstanceId()
The ID of the associated Amazon EC2 instance.
- Returns:
- The ID of the associated Amazon EC2 instance.
-
withEc2InstanceId
public Instance withEc2InstanceId(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.
-
setEcsClusterArn
public void setEcsClusterArn(String ecsClusterArn)
For container instances, the Amazon ECS cluster's ARN.
- Parameters:
ecsClusterArn
- For container instances, the Amazon ECS cluster's ARN.
-
getEcsClusterArn
public String getEcsClusterArn()
For container instances, the Amazon ECS cluster's ARN.
- Returns:
- For container instances, the Amazon ECS cluster's ARN.
-
withEcsClusterArn
public Instance withEcsClusterArn(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.
-
setEcsContainerInstanceArn
public void setEcsContainerInstanceArn(String ecsContainerInstanceArn)
For container instances, the instance's ARN.
- Parameters:
ecsContainerInstanceArn
- For container instances, the instance's ARN.
-
getEcsContainerInstanceArn
public String getEcsContainerInstanceArn()
For container instances, the instance's ARN.
- Returns:
- For container instances, the instance's ARN.
-
withEcsContainerInstanceArn
public Instance withEcsContainerInstanceArn(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.
-
setElasticIp
public void setElasticIp(String elasticIp)
The instance Elastic IP address .
- Parameters:
elasticIp
- The instance Elastic IP address .
-
getElasticIp
public String getElasticIp()
The instance Elastic IP address .
- Returns:
- The instance Elastic IP address .
-
withElasticIp
public Instance withElasticIp(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.
-
setHostname
public void setHostname(String hostname)
The instance host name.
- Parameters:
hostname
- The instance host name.
-
getHostname
public String getHostname()
The instance host name.
- Returns:
- The instance host name.
-
withHostname
public Instance withHostname(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.
-
setInfrastructureClass
public void setInfrastructureClass(String infrastructureClass)
For registered instances, the infrastructure class:
ec2
oron-premises
.- Parameters:
infrastructureClass
- For registered instances, the infrastructure class:ec2
oron-premises
.
-
getInfrastructureClass
public String getInfrastructureClass()
For registered instances, the infrastructure class:
ec2
oron-premises
.- Returns:
- For registered instances, the infrastructure class:
ec2
oron-premises
.
-
withInfrastructureClass
public Instance withInfrastructureClass(String infrastructureClass)
For registered instances, the infrastructure class:
ec2
oron-premises
.- Parameters:
infrastructureClass
- For registered instances, the infrastructure class:ec2
oron-premises
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setInstallUpdatesOnBoot
public void setInstallUpdatesOnBoot(Boolean installUpdatesOnBoot)
Whether to install operating system and package updates when the instance boots. The default value is
true
. If this value is set tofalse
, you must then update your instances manually by using CreateDeployment to run theupdate_dependencies
stack command or by manually runningyum
(Amazon Linux) orapt-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 istrue
. If this value is set tofalse
, you must then update your instances manually by using CreateDeployment to run theupdate_dependencies
stack command or by manually runningyum
(Amazon Linux) orapt-get
(Ubuntu) on the instances.We strongly recommend using the default value of
true
, to ensure that your instances have the latest security updates.
-
getInstallUpdatesOnBoot
public Boolean getInstallUpdatesOnBoot()
Whether to install operating system and package updates when the instance boots. The default value is
true
. If this value is set tofalse
, you must then update your instances manually by using CreateDeployment to run theupdate_dependencies
stack command or by manually runningyum
(Amazon Linux) orapt-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:
- Whether to install operating system and package updates when the
instance boots. The default value is
true
. If this value is set tofalse
, you must then update your instances manually by using CreateDeployment to run theupdate_dependencies
stack command or by manually runningyum
(Amazon Linux) orapt-get
(Ubuntu) on the instances.We strongly recommend using the default value of
true
, to ensure that your instances have the latest security updates.
-
withInstallUpdatesOnBoot
public Instance withInstallUpdatesOnBoot(Boolean installUpdatesOnBoot)
Whether to install operating system and package updates when the instance boots. The default value is
true
. If this value is set tofalse
, you must then update your instances manually by using CreateDeployment to run theupdate_dependencies
stack command or by manually runningyum
(Amazon Linux) orapt-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 istrue
. If this value is set tofalse
, you must then update your instances manually by using CreateDeployment to run theupdate_dependencies
stack command or by manually runningyum
(Amazon Linux) orapt-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.
-
isInstallUpdatesOnBoot
public Boolean isInstallUpdatesOnBoot()
Whether to install operating system and package updates when the instance boots. The default value is
true
. If this value is set tofalse
, you must then update your instances manually by using CreateDeployment to run theupdate_dependencies
stack command or by manually runningyum
(Amazon Linux) orapt-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:
- Whether to install operating system and package updates when the
instance boots. The default value is
true
. If this value is set tofalse
, you must then update your instances manually by using CreateDeployment to run theupdate_dependencies
stack command or by manually runningyum
(Amazon Linux) orapt-get
(Ubuntu) on the instances.We strongly recommend using the default value of
true
, to ensure that your instances have the latest security updates.
-
setInstanceId
public void setInstanceId(String instanceId)
The instance ID.
- Parameters:
instanceId
- The instance ID.
-
getInstanceId
public String getInstanceId()
The instance ID.
- Returns:
- The instance ID.
-
withInstanceId
public Instance withInstanceId(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.
-
setInstanceProfileArn
public void setInstanceProfileArn(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.
-
getInstanceProfileArn
public String getInstanceProfileArn()
The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using Identifiers.
- Returns:
- The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using Identifiers.
-
withInstanceProfileArn
public Instance withInstanceProfileArn(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.
-
setInstanceType
public void setInstanceType(String instanceType)
The instance type, such as
t2.micro
.- Parameters:
instanceType
- The instance type, such ast2.micro
.
-
getInstanceType
public String getInstanceType()
The instance type, such as
t2.micro
.- Returns:
- The instance type, such as
t2.micro
.
-
withInstanceType
public Instance withInstanceType(String instanceType)
The instance type, such as
t2.micro
.- Parameters:
instanceType
- The instance type, such ast2.micro
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLastServiceErrorId
public void setLastServiceErrorId(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.
-
getLastServiceErrorId
public String getLastServiceErrorId()
The ID of the last service error. For more information, call DescribeServiceErrors.
- Returns:
- The ID of the last service error. For more information, call DescribeServiceErrors.
-
withLastServiceErrorId
public Instance withLastServiceErrorId(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.
-
getLayerIds
public List<String> getLayerIds()
An array containing the instance layer IDs.
- Returns:
- An array containing the instance layer IDs.
-
setLayerIds
public void setLayerIds(Collection<String> layerIds)
An array containing the instance layer IDs.
- Parameters:
layerIds
- An array containing the instance layer IDs.
-
withLayerIds
public Instance withLayerIds(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)
orwithLayerIds(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.
-
withLayerIds
public Instance withLayerIds(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.
-
setOs
public void setOs(String os)
The instance's operating system.
- Parameters:
os
- The instance's operating system.
-
getOs
public String getOs()
The instance's operating system.
- Returns:
- The instance's operating system.
-
withOs
public Instance withOs(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.
-
setPlatform
public void setPlatform(String platform)
The instance's platform.
- Parameters:
platform
- The instance's platform.
-
getPlatform
public String getPlatform()
The instance's platform.
- Returns:
- The instance's platform.
-
withPlatform
public Instance withPlatform(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.
-
setPrivateDns
public void setPrivateDns(String privateDns)
The The instance's private DNS name.
- Parameters:
privateDns
- The The instance's private DNS name.
-
getPrivateDns
public String getPrivateDns()
The The instance's private DNS name.
- Returns:
- The The instance's private DNS name.
-
withPrivateDns
public Instance withPrivateDns(String privateDns)
The The instance's private DNS name.
- Parameters:
privateDns
- The The instance's private DNS name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPrivateIp
public void setPrivateIp(String privateIp)
The instance's private IP address.
- Parameters:
privateIp
- The instance's private IP address.
-
getPrivateIp
public String getPrivateIp()
The instance's private IP address.
- Returns:
- The instance's private IP address.
-
withPrivateIp
public Instance withPrivateIp(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.
-
setPublicDns
public void setPublicDns(String publicDns)
The instance public DNS name.
- Parameters:
publicDns
- The instance public DNS name.
-
getPublicDns
public String getPublicDns()
The instance public DNS name.
- Returns:
- The instance public DNS name.
-
withPublicDns
public Instance withPublicDns(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.
-
setPublicIp
public void setPublicIp(String publicIp)
The instance public IP address.
- Parameters:
publicIp
- The instance public IP address.
-
getPublicIp
public String getPublicIp()
The instance public IP address.
- Returns:
- The instance public IP address.
-
withPublicIp
public Instance withPublicIp(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.
-
setRegisteredBy
public void setRegisteredBy(String registeredBy)
For registered instances, who performed the registration.
- Parameters:
registeredBy
- For registered instances, who performed the registration.
-
getRegisteredBy
public String getRegisteredBy()
For registered instances, who performed the registration.
- Returns:
- For registered instances, who performed the registration.
-
withRegisteredBy
public Instance withRegisteredBy(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.
-
setReportedAgentVersion
public void setReportedAgentVersion(String reportedAgentVersion)
The instance's reported AWS OpsWorks agent version.
- Parameters:
reportedAgentVersion
- The instance's reported AWS OpsWorks agent version.
-
getReportedAgentVersion
public String getReportedAgentVersion()
The instance's reported AWS OpsWorks agent version.
- Returns:
- The instance's reported AWS OpsWorks agent version.
-
withReportedAgentVersion
public Instance withReportedAgentVersion(String reportedAgentVersion)
The instance's reported AWS OpsWorks agent version.
- Parameters:
reportedAgentVersion
- The instance's reported AWS OpsWorks agent version.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setReportedOs
public void setReportedOs(ReportedOs reportedOs)
For registered instances, the reported operating system.
- Parameters:
reportedOs
- For registered instances, the reported operating system.
-
getReportedOs
public ReportedOs getReportedOs()
For registered instances, the reported operating system.
- Returns:
- For registered instances, the reported operating system.
-
withReportedOs
public Instance withReportedOs(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.
-
setRootDeviceType
public void setRootDeviceType(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.- See Also:
RootDeviceType
-
getRootDeviceType
public String getRootDeviceType()
The instance's root device type. For more information, see Storage for the Root Device.
- Returns:
- The instance's root device type. For more information, see Storage for the Root Device.
- See Also:
RootDeviceType
-
withRootDeviceType
public Instance withRootDeviceType(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
-
setRootDeviceType
public void setRootDeviceType(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.- See Also:
RootDeviceType
-
withRootDeviceType
public Instance withRootDeviceType(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
-
setRootDeviceVolumeId
public void setRootDeviceVolumeId(String rootDeviceVolumeId)
The root device volume ID.
- Parameters:
rootDeviceVolumeId
- The root device volume ID.
-
getRootDeviceVolumeId
public String getRootDeviceVolumeId()
The root device volume ID.
- Returns:
- The root device volume ID.
-
withRootDeviceVolumeId
public Instance withRootDeviceVolumeId(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.
-
getSecurityGroupIds
public List<String> getSecurityGroupIds()
An array containing the instance security group IDs.
- Returns:
- An array containing the instance security group IDs.
-
setSecurityGroupIds
public void setSecurityGroupIds(Collection<String> securityGroupIds)
An array containing the instance security group IDs.
- Parameters:
securityGroupIds
- An array containing the instance security group IDs.
-
withSecurityGroupIds
public Instance withSecurityGroupIds(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)
orwithSecurityGroupIds(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.
-
withSecurityGroupIds
public Instance withSecurityGroupIds(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.
-
setSshHostDsaKeyFingerprint
public void setSshHostDsaKeyFingerprint(String sshHostDsaKeyFingerprint)
The SSH key's Deep Security Agent (DSA) fingerprint.
- Parameters:
sshHostDsaKeyFingerprint
- The SSH key's Deep Security Agent (DSA) fingerprint.
-
getSshHostDsaKeyFingerprint
public String getSshHostDsaKeyFingerprint()
The SSH key's Deep Security Agent (DSA) fingerprint.
- Returns:
- The SSH key's Deep Security Agent (DSA) fingerprint.
-
withSshHostDsaKeyFingerprint
public Instance withSshHostDsaKeyFingerprint(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.
-
setSshHostRsaKeyFingerprint
public void setSshHostRsaKeyFingerprint(String sshHostRsaKeyFingerprint)
The SSH key's RSA fingerprint.
- Parameters:
sshHostRsaKeyFingerprint
- The SSH key's RSA fingerprint.
-
getSshHostRsaKeyFingerprint
public String getSshHostRsaKeyFingerprint()
The SSH key's RSA fingerprint.
- Returns:
- The SSH key's RSA fingerprint.
-
withSshHostRsaKeyFingerprint
public Instance withSshHostRsaKeyFingerprint(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.
-
setSshKeyName
public void setSshKeyName(String sshKeyName)
The instance's Amazon EC2 key-pair name.
- Parameters:
sshKeyName
- The instance's Amazon EC2 key-pair name.
-
getSshKeyName
public String getSshKeyName()
The instance's Amazon EC2 key-pair name.
- Returns:
- The instance's Amazon EC2 key-pair name.
-
withSshKeyName
public Instance withSshKeyName(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.
-
setStackId
public void setStackId(String stackId)
The stack ID.
- Parameters:
stackId
- The stack ID.
-
getStackId
public String getStackId()
The stack ID.
- Returns:
- The stack ID.
-
withStackId
public Instance withStackId(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.
-
setStatus
public void setStatus(String status)
The instance status:
-
booting
-
connection_lost
-
online
-
pending
-
rebooting
-
requested
-
running_setup
-
setup_failed
-
shutting_down
-
start_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
-
stopped
-
stopping
-
terminated
-
terminating
-
-
-
getStatus
public String getStatus()
The instance status:
-
booting
-
connection_lost
-
online
-
pending
-
rebooting
-
requested
-
running_setup
-
setup_failed
-
shutting_down
-
start_failed
-
stopped
-
stopping
-
terminated
-
terminating
- Returns:
- The instance status:
-
booting
-
connection_lost
-
online
-
pending
-
rebooting
-
requested
-
running_setup
-
setup_failed
-
shutting_down
-
start_failed
-
stopped
-
stopping
-
terminated
-
terminating
-
-
-
withStatus
public Instance withStatus(String status)
The instance status:
-
booting
-
connection_lost
-
online
-
pending
-
rebooting
-
requested
-
running_setup
-
setup_failed
-
shutting_down
-
start_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
-
stopped
-
stopping
-
terminated
-
terminating
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
setSubnetId
public void setSubnetId(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.
-
getSubnetId
public String getSubnetId()
The instance's subnet ID; applicable only if the stack is running in a VPC.
- Returns:
- The instance's subnet ID; applicable only if the stack is running in a VPC.
-
withSubnetId
public Instance withSubnetId(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.
-
setTenancy
public void setTenancy(String tenancy)
The instance's tenancy option, such as
dedicated
orhost
.- Parameters:
tenancy
- The instance's tenancy option, such asdedicated
orhost
.
-
getTenancy
public String getTenancy()
The instance's tenancy option, such as
dedicated
orhost
.- Returns:
- The instance's tenancy option, such as
dedicated
orhost
.
-
withTenancy
public Instance withTenancy(String tenancy)
The instance's tenancy option, such as
dedicated
orhost
.- Parameters:
tenancy
- The instance's tenancy option, such asdedicated
orhost
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setVirtualizationType
public void setVirtualizationType(String virtualizationType)
The instance's virtualization type:
paravirtual
orhvm
.- Parameters:
virtualizationType
- The instance's virtualization type:paravirtual
orhvm
.- See Also:
VirtualizationType
-
getVirtualizationType
public String getVirtualizationType()
The instance's virtualization type:
paravirtual
orhvm
.- Returns:
- The instance's virtualization type:
paravirtual
orhvm
. - See Also:
VirtualizationType
-
withVirtualizationType
public Instance withVirtualizationType(String virtualizationType)
The instance's virtualization type:
paravirtual
orhvm
.- Parameters:
virtualizationType
- The instance's virtualization type:paravirtual
orhvm
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
VirtualizationType
-
setVirtualizationType
public void setVirtualizationType(VirtualizationType virtualizationType)
The instance's virtualization type:
paravirtual
orhvm
.- Parameters:
virtualizationType
- The instance's virtualization type:paravirtual
orhvm
.- See Also:
VirtualizationType
-
withVirtualizationType
public Instance withVirtualizationType(VirtualizationType virtualizationType)
The instance's virtualization type:
paravirtual
orhvm
.- Parameters:
virtualizationType
- The instance's virtualization type:paravirtual
orhvm
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
VirtualizationType
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
-