Amazonka.OpsWorks.Types.Instance

Documentation

data Instance

Describes an instance.

See: newInstance smart constructor.

Constructors

Instance'

Fields

• agentVersion :: Maybe Text

  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.

• amiId :: Maybe Text

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

• architecture :: Maybe Architecture

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

• arn :: Maybe Text

  The instance's Amazon Resource Number (ARN).

• autoScalingType :: Maybe AutoScalingType

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

• availabilityZone :: Maybe Text

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

• blockDeviceMappings :: Maybe [BlockDeviceMapping]

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

• createdAt :: Maybe Text

  The time that the instance was created.

• ebsOptimized :: Maybe Bool

  Whether this is an Amazon EBS-optimized instance.

• ec2InstanceId :: Maybe Text

  The ID of the associated Amazon EC2 instance.

• ecsClusterArn :: Maybe Text

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

• ecsContainerInstanceArn :: Maybe Text

  For container instances, the instance's ARN.

• elasticIp :: Maybe Text

  The instance Elastic IP address .

• hostname :: Maybe Text

  The instance host name.

• infrastructureClass :: Maybe Text

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

• installUpdatesOnBoot :: Maybe Bool

  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.

• instanceId :: Maybe Text

  The instance ID.

• instanceProfileArn :: Maybe Text

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

• instanceType :: Maybe Text

  The instance type, such as t2.micro.

• lastServiceErrorId :: Maybe Text

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

• layerIds :: Maybe [Text]

  An array containing the instance layer IDs.

• os :: Maybe Text

  The instance's operating system.

• platform :: Maybe Text

  The instance's platform.

• privateDns :: Maybe Text

  The instance's private DNS name.

• privateIp :: Maybe Text

  The instance's private IP address.

• publicDns :: Maybe Text

  The instance public DNS name.

• publicIp :: Maybe Text

  The instance public IP address.

• registeredBy :: Maybe Text

  For registered instances, who performed the registration.

• reportedAgentVersion :: Maybe Text

  The instance's reported AWS OpsWorks Stacks agent version.

• reportedOs :: Maybe ReportedOs

  For registered instances, the reported operating system.

• rootDeviceType :: Maybe RootDeviceType

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

• rootDeviceVolumeId :: Maybe Text

  The root device volume ID.

• securityGroupIds :: Maybe [Text]

  An array containing the instance security group IDs.

• sshHostDsaKeyFingerprint :: Maybe Text

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

• sshHostRsaKeyFingerprint :: Maybe Text

  The SSH key's RSA fingerprint.

• sshKeyName :: Maybe Text

  The instance's Amazon EC2 key-pair name.

• stackId :: Maybe Text

  The stack ID.

• status :: Maybe Text

  The instance status:

  • booting

  • connection_lost

  • online

  • pending

  • rebooting

  • requested

  • running_setup

  • setup_failed

  • shutting_down

  • start_failed

  • stop_failed

  • stopped

  • stopping

  • terminated

  • terminating

• subnetId :: Maybe Text

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

• tenancy :: Maybe Text

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

• virtualizationType :: Maybe VirtualizationType

  The instance's virtualization type: paravirtual or hvm.

Instances

FromJSON Instance

Defined in Amazonka.OpsWorks.Types.Instance

Methods

parseJSON :: Value -> Parser Instance

parseJSONList :: Value -> Parser [Instance]

Generic Instance

Defined in Amazonka.OpsWorks.Types.Instance

Associated Types

type Rep Instance :: Type -> Type

Methods

from :: Instance -> Rep Instance x

to :: Rep Instance x -> Instance

Read Instance

Defined in Amazonka.OpsWorks.Types.Instance

Methods

readsPrec :: Int -> ReadS Instance

readList :: ReadS [Instance]

readPrec :: ReadPrec Instance

readListPrec :: ReadPrec [Instance]

Show Instance

Defined in Amazonka.OpsWorks.Types.Instance

Methods

showsPrec :: Int -> Instance -> ShowS

show :: Instance -> String

showList :: [Instance] -> ShowS

NFData Instance

Defined in Amazonka.OpsWorks.Types.Instance

Methods

rnf :: Instance -> ()

Eq Instance

Defined in Amazonka.OpsWorks.Types.Instance

Methods

(==) :: Instance -> Instance -> Bool

(/=) :: Instance -> Instance -> Bool

Hashable Instance

Defined in Amazonka.OpsWorks.Types.Instance

Methods

hashWithSalt :: Int -> Instance -> Int

hash :: Instance -> Int

type Rep Instance

Defined in Amazonka.OpsWorks.Types.Instance

type Rep Instance = D1 ('MetaData "Instance" "Amazonka.OpsWorks.Types.Instance" "amazonka-opsworks-2.0-7XrzSD2vbuN9lVUGWMVZ7S" 'False) (C1 ('MetaCons "Instance'" 'PrefixI 'True) (((((S1 ('MetaSel ('Just "agentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "amiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "architecture") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Architecture)) :*: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "autoScalingType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoScalingType))))) :*: ((S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "blockDeviceMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BlockDeviceMapping]))) :*: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "ebsOptimized") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "ec2InstanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "ecsClusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "ecsContainerInstanceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "elasticIp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "hostname") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "infrastructureClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "installUpdatesOnBoot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "instanceProfileArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "instanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastServiceErrorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))) :*: ((((S1 ('MetaSel ('Just "layerIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "os") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "platform") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "privateDns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "privateIp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "publicDns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "publicIp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "registeredBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "reportedAgentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "reportedOs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReportedOs)))))) :*: (((S1 ('MetaSel ('Just "rootDeviceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RootDeviceType)) :*: S1 ('MetaSel ('Just "rootDeviceVolumeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "sshHostDsaKeyFingerprint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sshHostRsaKeyFingerprint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "sshKeyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "stackId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "subnetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tenancy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "virtualizationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VirtualizationType)))))))))

newInstance :: Instance

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: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:amiId:Instance', instance_amiId - A custom AMI ID to be used to create the instance. For more information, see Instances

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

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

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

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

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

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

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

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

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

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

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

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

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

$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:instanceId:Instance', instance_instanceId - The instance ID.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

$sel:stackId:Instance', instance_stackId - The stack 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:subnetId:Instance', instance_subnetId - The instance's subnet ID; applicable only if the stack is running in a VPC.

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

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

instance_agentVersion :: Lens' Instance (Maybe Text)

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_amiId :: Lens' Instance (Maybe Text)

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

instance_architecture :: Lens' Instance (Maybe Architecture)

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

instance_arn :: Lens' Instance (Maybe Text)

The instance's Amazon Resource Number (ARN).

instance_autoScalingType :: Lens' Instance (Maybe AutoScalingType)

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

instance_availabilityZone :: Lens' Instance (Maybe Text)

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

instance_blockDeviceMappings :: Lens' Instance (Maybe [BlockDeviceMapping])

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

instance_createdAt :: Lens' Instance (Maybe Text)

The time that the instance was created.

instance_ebsOptimized :: Lens' Instance (Maybe Bool)

Whether this is an Amazon EBS-optimized instance.

instance_ec2InstanceId :: Lens' Instance (Maybe Text)

The ID of the associated Amazon EC2 instance.

instance_ecsClusterArn :: Lens' Instance (Maybe Text)

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

instance_ecsContainerInstanceArn :: Lens' Instance (Maybe Text)

For container instances, the instance's ARN.

instance_elasticIp :: Lens' Instance (Maybe Text)

The instance Elastic IP address .

instance_hostname :: Lens' Instance (Maybe Text)

The instance host name.

instance_infrastructureClass :: Lens' Instance (Maybe Text)

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

instance_installUpdatesOnBoot :: Lens' Instance (Maybe Bool)

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_instanceId :: Lens' Instance (Maybe Text)

The instance ID.

instance_instanceProfileArn :: Lens' Instance (Maybe Text)

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

instance_instanceType :: Lens' Instance (Maybe Text)

The instance type, such as t2.micro.

instance_lastServiceErrorId :: Lens' Instance (Maybe Text)

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

instance_layerIds :: Lens' Instance (Maybe [Text])

An array containing the instance layer IDs.

instance_os :: Lens' Instance (Maybe Text)

The instance's operating system.

instance_platform :: Lens' Instance (Maybe Text)

The instance's platform.

instance_privateDns :: Lens' Instance (Maybe Text)

The instance's private DNS name.

instance_privateIp :: Lens' Instance (Maybe Text)

The instance's private IP address.

instance_publicDns :: Lens' Instance (Maybe Text)

The instance public DNS name.

instance_publicIp :: Lens' Instance (Maybe Text)

The instance public IP address.

instance_registeredBy :: Lens' Instance (Maybe Text)

For registered instances, who performed the registration.

instance_reportedAgentVersion :: Lens' Instance (Maybe Text)

The instance's reported AWS OpsWorks Stacks agent version.

instance_reportedOs :: Lens' Instance (Maybe ReportedOs)

For registered instances, the reported operating system.

instance_rootDeviceType :: Lens' Instance (Maybe RootDeviceType)

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

instance_rootDeviceVolumeId :: Lens' Instance (Maybe Text)

The root device volume ID.

instance_securityGroupIds :: Lens' Instance (Maybe [Text])

An array containing the instance security group IDs.

instance_sshHostDsaKeyFingerprint :: Lens' Instance (Maybe Text)

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

instance_sshHostRsaKeyFingerprint :: Lens' Instance (Maybe Text)

The SSH key's RSA fingerprint.

instance_sshKeyName :: Lens' Instance (Maybe Text)

The instance's Amazon EC2 key-pair name.

instance_stackId :: Lens' Instance (Maybe Text)

The stack ID.

instance_status :: Lens' Instance (Maybe Text)

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_subnetId :: Lens' Instance (Maybe Text)

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

instance_tenancy :: Lens' Instance (Maybe Text)

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

instance_virtualizationType :: Lens' Instance (Maybe VirtualizationType)

The instance's virtualization type: paravirtual or hvm.