Documentation

Describes an instance.

See: newInstance smart constructor.

Create a value of Instance with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:privateDns:Instance', instance_privateDns - The instance's private DNS name.

$sel:reportedAgentVersion:Instance', instance_reportedAgentVersion - The instance's reported AWS OpsWorks Stacks agent version.

$sel:instanceId:Instance', instance_instanceId - The instance ID.

$sel:status:Instance', instance_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

$sel:privateIp:Instance', instance_privateIp - The instance's private IP address.

$sel:installUpdatesOnBoot:Instance', instance_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.

$sel:virtualizationType:Instance', instance_virtualizationType - The instance's virtualization type: paravirtual or hvm.

$sel:instanceProfileArn:Instance', instance_instanceProfileArn - The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using Identifiers.

$sel:platform:Instance', instance_platform - The instance's platform.

$sel:hostname:Instance', instance_hostname - The instance host name.

$sel:sshHostRsaKeyFingerprint:Instance', instance_sshHostRsaKeyFingerprint - The SSH key's RSA fingerprint.

$sel:securityGroupIds:Instance', instance_securityGroupIds - An array containing the instance security group IDs.

$sel:ecsClusterArn:Instance', instance_ecsClusterArn - For container instances, the Amazon ECS cluster's ARN.

$sel:arn:Instance', instance_arn - The instance's Amazon Resource Number (ARN).

$sel:createdAt:Instance', instance_createdAt - The time that the instance was created.

$sel:ec2InstanceId:Instance', instance_ec2InstanceId - The ID of the associated Amazon EC2 instance.

$sel:sshKeyName:Instance', instance_sshKeyName - The instance's Amazon EC2 key-pair name.

$sel:agentVersion:Instance', instance_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.

$sel:rootDeviceVolumeId:Instance', instance_rootDeviceVolumeId - The root device volume ID.

$sel:subnetId:Instance', instance_subnetId - The instance's subnet ID; applicable only if the stack is running in a VPC.

$sel:infrastructureClass:Instance', instance_infrastructureClass - For registered instances, the infrastructure class: ec2 or on-premises.

$sel:sshHostDsaKeyFingerprint:Instance', instance_sshHostDsaKeyFingerprint - The SSH key's Deep Security Agent (DSA) fingerprint.

$sel:instanceType:Instance', instance_instanceType - The instance type, such as t2.micro.

$sel:ebsOptimized:Instance', instance_ebsOptimized - Whether this is an Amazon EBS-optimized instance.

$sel:elasticIp:Instance', instance_elasticIp - The instance Elastic IP address .

$sel:os:Instance', instance_os - The instance's operating system.

$sel:availabilityZone:Instance', instance_availabilityZone - The instance Availability Zone. For more information, see Regions and Endpoints.

$sel:lastServiceErrorId:Instance', instance_lastServiceErrorId - The ID of the last service error. For more information, call DescribeServiceErrors.

$sel:tenancy:Instance', instance_tenancy - The instance's tenancy option, such as dedicated or host.

$sel:autoScalingType:Instance', instance_autoScalingType - For load-based or time-based instances, the type.

$sel:layerIds:Instance', instance_layerIds - An array containing the instance layer IDs.

$sel:architecture:Instance', instance_architecture - The instance architecture: "i386" or "x86_64".

$sel:publicDns:Instance', instance_publicDns - The instance public DNS name.

$sel:amiId:Instance', instance_amiId - A custom AMI ID to be used to create the instance. For more information, see Instances

$sel:publicIp:Instance', instance_publicIp - The instance public IP address.

$sel:reportedOs:Instance', instance_reportedOs - For registered instances, the reported operating system.

$sel:registeredBy:Instance', instance_registeredBy - For registered instances, who performed the registration.

$sel:stackId:Instance', instance_stackId - The stack ID.

$sel:rootDeviceType:Instance', instance_rootDeviceType - The instance's root device type. For more information, see Storage for the Root Device.

$sel:ecsContainerInstanceArn:Instance', instance_ecsContainerInstanceArn - For container instances, the instance's ARN.

$sel:blockDeviceMappings:Instance', instance_blockDeviceMappings - An array of BlockDeviceMapping objects that specify the instance's block device mappings.

The instance's private DNS name.

The instance's reported AWS OpsWorks Stacks agent version.

The instance ID.

The instance status:

• booting

• connection_lost

• online

• pending

• rebooting

• requested

• running_setup

• setup_failed

• shutting_down

• start_failed

• stop_failed

• stopped

• stopping

• terminated

• terminating

The instance's private IP address.

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.

The instance's virtualization type: paravirtual or hvm.

The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using Identifiers.

The instance's platform.

The instance host name.

The SSH key's RSA fingerprint.

An array containing the instance security group IDs.

For container instances, the Amazon ECS cluster's ARN.

The instance's Amazon Resource Number (ARN).

The time that the instance was created.

The ID of the associated Amazon EC2 instance.

The instance's Amazon EC2 key-pair name.

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.

The root device volume ID.

The instance's subnet ID; applicable only if the stack is running in a VPC.

For registered instances, the infrastructure class: ec2 or on-premises.

The SSH key's Deep Security Agent (DSA) fingerprint.

The instance type, such as t2.micro.

Whether this is an Amazon EBS-optimized instance.

The instance Elastic IP address .

The instance's operating system.

The instance Availability Zone. For more information, see Regions and Endpoints.

The ID of the last service error. For more information, call DescribeServiceErrors.

The instance's tenancy option, such as dedicated or host.

For load-based or time-based instances, the type.

An array containing the instance layer IDs.

The instance architecture: "i386" or "x86_64".

The instance public DNS name.

A custom AMI ID to be used to create the instance. For more information, see Instances

The instance public IP address.

For registered instances, the reported operating system.

For registered instances, who performed the registration.

The stack ID.

The instance's root device type. For more information, see Storage for the Root Device.

For container instances, the instance's ARN.

An array of BlockDeviceMapping objects that specify the instance's block device mappings.