/AWS1/CL_OWXINSTANCE

Describes an instance.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_agentversion TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

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.

iv_amiid TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

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

iv_architecture TYPE /AWS1/OWXARCHITECTURE /AWS1/OWXARCHITECTURE

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

iv_arn TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

The instance's Amazon Resource Number (ARN).

iv_autoscalingtype TYPE /AWS1/OWXAUTOSCALINGTYPE /AWS1/OWXAUTOSCALINGTYPE

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

iv_availabilityzone TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

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

it_blockdevicemappings TYPE /AWS1/CL_OWXBLOCKDEVICEMAPPING=>TT_BLOCKDEVICEMAPPINGS TT_BLOCKDEVICEMAPPINGS

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

iv_createdat TYPE /AWS1/OWXDATETIME /AWS1/OWXDATETIME

The time that the instance was created.

iv_ebsoptimized TYPE /AWS1/OWXBOOLEAN /AWS1/OWXBOOLEAN

Whether this is an Amazon EBS-optimized instance.

iv_ec2instanceid TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

The ID of the associated Amazon EC2 instance.

iv_ecsclusterarn TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

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

iv_ecscontainerinstancearn TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

For container instances, the instance's ARN.

iv_elasticip TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

The instance Elastic IP address.

iv_hostname TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

The instance host name. The following are character limits for instance host names.

• Linux-based instances: 63 characters

• Windows-based instances: 15 characters

iv_infrastructureclass TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

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

iv_installupdatesonboot TYPE /AWS1/OWXBOOLEAN /AWS1/OWXBOOLEAN

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 update 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.

iv_instanceid TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

The instance ID.

iv_instanceprofilearn TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

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

iv_instancetype TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

The instance type, such as t2.micro.

iv_lastserviceerrorid TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

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

it_layerids TYPE /AWS1/CL_OWXSTRINGS_W=>TT_STRINGS TT_STRINGS

An array containing the instance layer IDs.

iv_os TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

The instance's operating system.

iv_platform TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

The instance's platform.

iv_privatedns TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

The instance's private DNS name.

iv_privateip TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

The instance's private IP address.

iv_publicdns TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

The instance public DNS name.

iv_publicip TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

The instance public IP address.

iv_registeredby TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

For registered instances, who performed the registration.

iv_reportedagentversion TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

The instance's reported OpsWorks Stacks agent version.

io_reportedos TYPE REF TO /AWS1/CL_OWXREPORTEDOS /AWS1/CL_OWXREPORTEDOS

For registered instances, the reported operating system.

iv_rootdevicetype TYPE /AWS1/OWXROOTDEVICETYPE /AWS1/OWXROOTDEVICETYPE

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

iv_rootdevicevolumeid TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

The root device volume ID.

it_securitygroupids TYPE /AWS1/CL_OWXSTRINGS_W=>TT_STRINGS TT_STRINGS

An array containing the instance security group IDs.

iv_sshhostdsakeyfingerprint TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

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

iv_sshhostrsakeyfingerprint TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

The SSH key's RSA fingerprint.

iv_sshkeyname TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

The instance's Amazon EC2 key-pair name.

iv_stackid TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

The stack ID.

iv_status TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

The instance status:

• booting

• connection_lost

• online

• pending

• rebooting

• requested

• running_setup

• setup_failed

• shutting_down

• start_failed

• stop_failed

• stopped

• stopping

• terminated

• terminating

iv_subnetid TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

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

iv_tenancy TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

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

iv_virtualizationtype TYPE /AWS1/OWXVIRTUALIZATIONTYPE /AWS1/OWXVIRTUALIZATIONTYPE

The instance's virtualization type: paravirtual or hvm.

---

Queryable Attributes

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.

Accessible with the following methods

Method	Description
GET_AGENTVERSION()	Getter for AGENTVERSION, with configurable default
ASK_AGENTVERSION()	Getter for AGENTVERSION w/ exceptions if field has no value
HAS_AGENTVERSION()	Determine if AGENTVERSION has a value

AmiId

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

Accessible with the following methods

Method	Description
GET_AMIID()	Getter for AMIID, with configurable default
ASK_AMIID()	Getter for AMIID w/ exceptions if field has no value
HAS_AMIID()	Determine if AMIID has a value

Architecture

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

Accessible with the following methods

Method	Description
GET_ARCHITECTURE()	Getter for ARCHITECTURE, with configurable default
ASK_ARCHITECTURE()	Getter for ARCHITECTURE w/ exceptions if field has no value
HAS_ARCHITECTURE()	Determine if ARCHITECTURE has a value

Arn

The instance's Amazon Resource Number (ARN).

Accessible with the following methods

Method	Description
GET_ARN()	Getter for ARN, with configurable default
ASK_ARN()	Getter for ARN w/ exceptions if field has no value
HAS_ARN()	Determine if ARN has a value

AutoScalingType

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

Accessible with the following methods

Method	Description
GET_AUTOSCALINGTYPE()	Getter for AUTOSCALINGTYPE, with configurable default
ASK_AUTOSCALINGTYPE()	Getter for AUTOSCALINGTYPE w/ exceptions if field has no val
HAS_AUTOSCALINGTYPE()	Determine if AUTOSCALINGTYPE has a value

AvailabilityZone

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

Accessible with the following methods

Method	Description
GET_AVAILABILITYZONE()	Getter for AVAILABILITYZONE, with configurable default
ASK_AVAILABILITYZONE()	Getter for AVAILABILITYZONE w/ exceptions if field has no va
HAS_AVAILABILITYZONE()	Determine if AVAILABILITYZONE has a value

BlockDeviceMappings

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

Accessible with the following methods

Method	Description
GET_BLOCKDEVICEMAPPINGS()	Getter for BLOCKDEVICEMAPPINGS, with configurable default
ASK_BLOCKDEVICEMAPPINGS()	Getter for BLOCKDEVICEMAPPINGS w/ exceptions if field has no
HAS_BLOCKDEVICEMAPPINGS()	Determine if BLOCKDEVICEMAPPINGS has a value

CreatedAt

The time that the instance was created.

Accessible with the following methods

Method	Description
GET_CREATEDAT()	Getter for CREATEDAT, with configurable default
ASK_CREATEDAT()	Getter for CREATEDAT w/ exceptions if field has no value
HAS_CREATEDAT()	Determine if CREATEDAT has a value

EbsOptimized

Whether this is an Amazon EBS-optimized instance.

Accessible with the following methods

Method	Description
GET_EBSOPTIMIZED()	Getter for EBSOPTIMIZED, with configurable default
ASK_EBSOPTIMIZED()	Getter for EBSOPTIMIZED w/ exceptions if field has no value
HAS_EBSOPTIMIZED()	Determine if EBSOPTIMIZED has a value

Ec2InstanceId

The ID of the associated Amazon EC2 instance.

Accessible with the following methods

Method	Description
GET_EC2INSTANCEID()	Getter for EC2INSTANCEID, with configurable default
ASK_EC2INSTANCEID()	Getter for EC2INSTANCEID w/ exceptions if field has no value
HAS_EC2INSTANCEID()	Determine if EC2INSTANCEID has a value

EcsClusterArn

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

Accessible with the following methods

Method	Description
GET_ECSCLUSTERARN()	Getter for ECSCLUSTERARN, with configurable default
ASK_ECSCLUSTERARN()	Getter for ECSCLUSTERARN w/ exceptions if field has no value
HAS_ECSCLUSTERARN()	Determine if ECSCLUSTERARN has a value

EcsContainerInstanceArn

For container instances, the instance's ARN.

Accessible with the following methods

Method	Description
GET_ECSCONTAINERINSTANCEARN()	Getter for ECSCONTAINERINSTANCEARN, with configurable defaul
ASK_ECSCONTAINERINSTANCEARN()	Getter for ECSCONTAINERINSTANCEARN w/ exceptions if field ha
HAS_ECSCONTAINERINSTANCEARN()	Determine if ECSCONTAINERINSTANCEARN has a value

ElasticIp

The instance Elastic IP address.

Accessible with the following methods

Method	Description
GET_ELASTICIP()	Getter for ELASTICIP, with configurable default
ASK_ELASTICIP()	Getter for ELASTICIP w/ exceptions if field has no value
HAS_ELASTICIP()	Determine if ELASTICIP has a value

Hostname

The instance host name. The following are character limits for instance host names.

• Linux-based instances: 63 characters

• Windows-based instances: 15 characters

Accessible with the following methods

Method	Description
GET_HOSTNAME()	Getter for HOSTNAME, with configurable default
ASK_HOSTNAME()	Getter for HOSTNAME w/ exceptions if field has no value
HAS_HOSTNAME()	Determine if HOSTNAME has a value

InfrastructureClass

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

Accessible with the following methods

Method	Description
GET_INFRASTRUCTURECLASS()	Getter for INFRASTRUCTURECLASS, with configurable default
ASK_INFRASTRUCTURECLASS()	Getter for INFRASTRUCTURECLASS w/ exceptions if field has no
HAS_INFRASTRUCTURECLASS()	Determine if INFRASTRUCTURECLASS has a value

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 update 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.

Accessible with the following methods

Method	Description
GET_INSTALLUPDATESONBOOT()	Getter for INSTALLUPDATESONBOOT, with configurable default
ASK_INSTALLUPDATESONBOOT()	Getter for INSTALLUPDATESONBOOT w/ exceptions if field has n
HAS_INSTALLUPDATESONBOOT()	Determine if INSTALLUPDATESONBOOT has a value

InstanceId

The instance ID.

Accessible with the following methods

Method	Description
GET_INSTANCEID()	Getter for INSTANCEID, with configurable default
ASK_INSTANCEID()	Getter for INSTANCEID w/ exceptions if field has no value
HAS_INSTANCEID()	Determine if INSTANCEID has a value

InstanceProfileArn

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

Accessible with the following methods

Method	Description
GET_INSTANCEPROFILEARN()	Getter for INSTANCEPROFILEARN, with configurable default
ASK_INSTANCEPROFILEARN()	Getter for INSTANCEPROFILEARN w/ exceptions if field has no
HAS_INSTANCEPROFILEARN()	Determine if INSTANCEPROFILEARN has a value

InstanceType

The instance type, such as t2.micro.

Accessible with the following methods

Method	Description
GET_INSTANCETYPE()	Getter for INSTANCETYPE, with configurable default
ASK_INSTANCETYPE()	Getter for INSTANCETYPE w/ exceptions if field has no value
HAS_INSTANCETYPE()	Determine if INSTANCETYPE has a value

LastServiceErrorId

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

Accessible with the following methods

Method	Description
GET_LASTSERVICEERRORID()	Getter for LASTSERVICEERRORID, with configurable default
ASK_LASTSERVICEERRORID()	Getter for LASTSERVICEERRORID w/ exceptions if field has no
HAS_LASTSERVICEERRORID()	Determine if LASTSERVICEERRORID has a value

LayerIds

An array containing the instance layer IDs.

Accessible with the following methods

Method	Description
GET_LAYERIDS()	Getter for LAYERIDS, with configurable default
ASK_LAYERIDS()	Getter for LAYERIDS w/ exceptions if field has no value
HAS_LAYERIDS()	Determine if LAYERIDS has a value

Os

The instance's operating system.

Accessible with the following methods

Method	Description
GET_OS()	Getter for OS, with configurable default
ASK_OS()	Getter for OS w/ exceptions if field has no value
HAS_OS()	Determine if OS has a value

Platform

The instance's platform.

Accessible with the following methods

Method	Description
GET_PLATFORM()	Getter for PLATFORM, with configurable default
ASK_PLATFORM()	Getter for PLATFORM w/ exceptions if field has no value
HAS_PLATFORM()	Determine if PLATFORM has a value

PrivateDns

The instance's private DNS name.

Accessible with the following methods

Method	Description
GET_PRIVATEDNS()	Getter for PRIVATEDNS, with configurable default
ASK_PRIVATEDNS()	Getter for PRIVATEDNS w/ exceptions if field has no value
HAS_PRIVATEDNS()	Determine if PRIVATEDNS has a value

PrivateIp

The instance's private IP address.

Accessible with the following methods

Method	Description
GET_PRIVATEIP()	Getter for PRIVATEIP, with configurable default
ASK_PRIVATEIP()	Getter for PRIVATEIP w/ exceptions if field has no value
HAS_PRIVATEIP()	Determine if PRIVATEIP has a value

PublicDns

The instance public DNS name.

Accessible with the following methods

Method	Description
GET_PUBLICDNS()	Getter for PUBLICDNS, with configurable default
ASK_PUBLICDNS()	Getter for PUBLICDNS w/ exceptions if field has no value
HAS_PUBLICDNS()	Determine if PUBLICDNS has a value

PublicIp

The instance public IP address.

Accessible with the following methods

Method	Description
GET_PUBLICIP()	Getter for PUBLICIP, with configurable default
ASK_PUBLICIP()	Getter for PUBLICIP w/ exceptions if field has no value
HAS_PUBLICIP()	Determine if PUBLICIP has a value

RegisteredBy

For registered instances, who performed the registration.

Accessible with the following methods

Method	Description
GET_REGISTEREDBY()	Getter for REGISTEREDBY, with configurable default
ASK_REGISTEREDBY()	Getter for REGISTEREDBY w/ exceptions if field has no value
HAS_REGISTEREDBY()	Determine if REGISTEREDBY has a value

ReportedAgentVersion

The instance's reported OpsWorks Stacks agent version.

Accessible with the following methods

Method	Description
GET_REPORTEDAGENTVERSION()	Getter for REPORTEDAGENTVERSION, with configurable default
ASK_REPORTEDAGENTVERSION()	Getter for REPORTEDAGENTVERSION w/ exceptions if field has n
HAS_REPORTEDAGENTVERSION()	Determine if REPORTEDAGENTVERSION has a value

ReportedOs

For registered instances, the reported operating system.

Accessible with the following methods

Method	Description
GET_REPORTEDOS()	Getter for REPORTEDOS

RootDeviceType

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

Accessible with the following methods

Method	Description
GET_ROOTDEVICETYPE()	Getter for ROOTDEVICETYPE, with configurable default
ASK_ROOTDEVICETYPE()	Getter for ROOTDEVICETYPE w/ exceptions if field has no valu
HAS_ROOTDEVICETYPE()	Determine if ROOTDEVICETYPE has a value

RootDeviceVolumeId

The root device volume ID.

Accessible with the following methods

Method	Description
GET_ROOTDEVICEVOLUMEID()	Getter for ROOTDEVICEVOLUMEID, with configurable default
ASK_ROOTDEVICEVOLUMEID()	Getter for ROOTDEVICEVOLUMEID w/ exceptions if field has no
HAS_ROOTDEVICEVOLUMEID()	Determine if ROOTDEVICEVOLUMEID has a value

SecurityGroupIds

An array containing the instance security group IDs.

Accessible with the following methods

Method	Description
GET_SECURITYGROUPIDS()	Getter for SECURITYGROUPIDS, with configurable default
ASK_SECURITYGROUPIDS()	Getter for SECURITYGROUPIDS w/ exceptions if field has no va
HAS_SECURITYGROUPIDS()	Determine if SECURITYGROUPIDS has a value

SshHostDsaKeyFingerprint

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

Accessible with the following methods

Method	Description
GET_SSHHOSTDSAKEYFINGERPRINT()	Getter for SSHHOSTDSAKEYFINGERPRINT, with configurable defau
ASK_SSHHOSTDSAKEYFINGERPRINT()	Getter for SSHHOSTDSAKEYFINGERPRINT w/ exceptions if field h
HAS_SSHHOSTDSAKEYFINGERPRINT()	Determine if SSHHOSTDSAKEYFINGERPRINT has a value

SshHostRsaKeyFingerprint

The SSH key's RSA fingerprint.

Accessible with the following methods

Method	Description
GET_SSHHOSTRSAKEYFINGERPRINT()	Getter for SSHHOSTRSAKEYFINGERPRINT, with configurable defau
ASK_SSHHOSTRSAKEYFINGERPRINT()	Getter for SSHHOSTRSAKEYFINGERPRINT w/ exceptions if field h
HAS_SSHHOSTRSAKEYFINGERPRINT()	Determine if SSHHOSTRSAKEYFINGERPRINT has a value

SshKeyName

The instance's Amazon EC2 key-pair name.

Accessible with the following methods

Method	Description
GET_SSHKEYNAME()	Getter for SSHKEYNAME, with configurable default
ASK_SSHKEYNAME()	Getter for SSHKEYNAME w/ exceptions if field has no value
HAS_SSHKEYNAME()	Determine if SSHKEYNAME has a value

StackId

The stack ID.

Accessible with the following methods

Method	Description
GET_STACKID()	Getter for STACKID, with configurable default
ASK_STACKID()	Getter for STACKID w/ exceptions if field has no value
HAS_STACKID()	Determine if STACKID has a value

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

Accessible with the following methods

Method	Description
GET_STATUS()	Getter for STATUS, with configurable default
ASK_STATUS()	Getter for STATUS w/ exceptions if field has no value
HAS_STATUS()	Determine if STATUS has a value

SubnetId

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

Accessible with the following methods

Method	Description
GET_SUBNETID()	Getter for SUBNETID, with configurable default
ASK_SUBNETID()	Getter for SUBNETID w/ exceptions if field has no value
HAS_SUBNETID()	Determine if SUBNETID has a value

Tenancy

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

Accessible with the following methods

Method	Description
GET_TENANCY()	Getter for TENANCY, with configurable default
ASK_TENANCY()	Getter for TENANCY w/ exceptions if field has no value
HAS_TENANCY()	Determine if TENANCY has a value

VirtualizationType

The instance's virtualization type: paravirtual or hvm.

Accessible with the following methods

Method	Description
GET_VIRTUALIZATIONTYPE()	Getter for VIRTUALIZATIONTYPE, with configurable default
ASK_VIRTUALIZATIONTYPE()	Getter for VIRTUALIZATIONTYPE w/ exceptions if field has no
HAS_VIRTUALIZATIONTYPE()	Determine if VIRTUALIZATIONTYPE has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_INSTANCES

TYPES TT_INSTANCES TYPE STANDARD TABLE OF REF TO /AWS1/CL_OWXINSTANCE WITH DEFAULT KEY
.