AWS SDK for .NET Documentation
Instance Class
Amazon ► Amazon.OpsWorks.Model ► Instance Did this page help you?   Yes   No    Tell us about it...
Describes an instance.
Declaration Syntax
C#
public class Instance
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
Instance()()()()
Initializes a new instance of the Instance class

AmiId
Gets and sets the property AmiId.

A custom AMI ID to be used to create the instance. The AMI should be based on one of the standard AWS OpsWorks APIs: Amazon Linux or Ubuntu 12.04 LTS. For more information, see Instances


Architecture
Gets and sets the property Architecture.

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


AutoScalingType
Gets and sets the property AutoScalingType.

The instance's auto scaling type, which has three possible values:

  • AlwaysRunning: A 24/7 instance, which is not affected by auto scaling.
  • TimeBasedAutoScaling: A time-based auto scaling instance, which is started and stopped based on a specified schedule.
  • LoadBasedAutoScaling: A load-based auto scaling instance, which is started and stopped based on load metrics.

AvailabilityZone
Gets and sets the property AvailabilityZone.

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


CreatedAt
Gets and sets the property CreatedAt.

The time that the instance was created.


EbsOptimized
Gets and sets the property EbsOptimized.

Whether this is an Amazon EBS-optimized instance.


Ec2InstanceId
Gets and sets the property Ec2InstanceId.

The ID of the associated Amazon EC2 instance.


ElasticIp
Gets and sets the property ElasticIp.

The instance Elastic IP address .


Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
Hostname
Gets and sets the property Hostname.

The instance host name.


InstallUpdatesOnBoot
Gets and sets the property InstallUpdatesOnBoot.

Whether to install operating system and package updates when the instance boots. The default value is

CopyC#
true
. If this value is set to
CopyC#
false
, you must then update your instances manually by using CreateDeployment to run the
CopyC#
update_dependencies
 stack command or manually running
CopyC#
yum
 (Amazon Linux) or
CopyC#
apt-get
 (Ubuntu) on the instances.

Note:

We strongly recommend using the default value of

CopyC#
true
, to ensure that your instances have the latest security updates.


InstanceId
Gets and sets the property InstanceId.

The instance ID.


InstanceProfileArn
Gets and sets the property InstanceProfileArn.

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


InstanceType
Gets and sets the property InstanceType.

The instance type. AWS OpsWorks supports all instance types except Cluster Compute, Cluster GPU, and High Memory Cluster. For more information, see Instance Families and Types. The parameter values that specify the various types are in the API Name column of the Available Instance Types table.


LastServiceErrorId
Gets and sets the property LastServiceErrorId.

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


LayerIds
Gets and sets the property LayerIds.

An array containing the instance layer IDs.


Os
Gets and sets the property Os.

The instance operating system.


PrivateDns
Gets and sets the property PrivateDns.

The instance private DNS name.


PrivateIp
Gets and sets the property PrivateIp.

The instance private IP address.


PublicDns
Gets and sets the property PublicDns.

The instance public DNS name.


PublicIp
Gets and sets the property PublicIp.

The instance public IP address.


RootDeviceType
Gets and sets the property RootDeviceType.

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


RootDeviceVolumeId
Gets and sets the property RootDeviceVolumeId.

The root device volume ID.


SecurityGroupIds
Gets and sets the property SecurityGroupIds.

An array containing the instance security group IDs.


SshHostDsaKeyFingerprint
Gets and sets the property SshHostDsaKeyFingerprint.

The SSH key's DSA fingerprint.


SshHostRsaKeyFingerprint
Gets and sets the property SshHostRsaKeyFingerprint.

The SSH key's RSA fingerprint.


SshKeyName
Gets and sets the property SshKeyName.

The instance SSH key name.


StackId
Gets and sets the property StackId.

The stack ID.


Status
Gets and sets the property Status.

The instance status:

  • CopyC#
    requested
  • CopyC#
    booting
  • CopyC#
    running_setup
  • CopyC#
    online
  • CopyC#
    setup_failed
  • CopyC#
    start_failed
  • CopyC#
    terminating
  • CopyC#
    terminated
  • CopyC#
    stopped
  • CopyC#
    connection_lost

SubnetId
Gets and sets the property SubnetId.

The instance's subnet ID, if the stack is running in a VPC.


ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
VirtualizationType
Gets and sets the property VirtualizationType.

The instance's virtualization type,

CopyC#
paravirtual
or
CopyC#
hvm
.


WithAmiId(String) Obsolete.
Sets the AmiId property

WithArchitecture(String) Obsolete.
Sets the Architecture property

WithAutoScalingType(String) Obsolete.
Sets the AutoScalingType property

WithAvailabilityZone(String) Obsolete.
Sets the AvailabilityZone property

WithCreatedAt(String) Obsolete.
Sets the CreatedAt property

WithEbsOptimized(Boolean) Obsolete.
Sets the EbsOptimized property

WithEc2InstanceId(String) Obsolete.
Sets the Ec2InstanceId property

WithElasticIp(String) Obsolete.
Sets the ElasticIp property

WithHostname(String) Obsolete.
Sets the Hostname property

WithInstallUpdatesOnBoot(Boolean) Obsolete.
Sets the InstallUpdatesOnBoot property

WithInstanceId(String) Obsolete.
Sets the InstanceId property

WithInstanceProfileArn(String) Obsolete.
Sets the InstanceProfileArn property

WithInstanceType(String) Obsolete.
Sets the InstanceType property

WithLastServiceErrorId(String) Obsolete.
Sets the LastServiceErrorId property

WithLayerIds(array<String>[]()[][]) Obsolete.
Sets the LayerIds property

WithLayerIds(IEnumerable<(Of <<'(String>)>>)) Obsolete.
Sets the LayerIds property

WithOs(String) Obsolete.
Sets the Os property

WithPrivateDns(String) Obsolete.
Sets the PrivateDns property

WithPrivateIp(String) Obsolete.
Sets the PrivateIp property

WithPublicDns(String) Obsolete.
Sets the PublicDns property

WithPublicIp(String) Obsolete.
Sets the PublicIp property

WithRootDeviceType(String) Obsolete.
Sets the RootDeviceType property

WithRootDeviceVolumeId(String) Obsolete.
Sets the RootDeviceVolumeId property

WithSecurityGroupIds(array<String>[]()[][]) Obsolete.
Sets the SecurityGroupIds property

WithSecurityGroupIds(IEnumerable<(Of <<'(String>)>>)) Obsolete.
Sets the SecurityGroupIds property

WithSshHostDsaKeyFingerprint(String) Obsolete.
Sets the SshHostDsaKeyFingerprint property

WithSshHostRsaKeyFingerprint(String) Obsolete.
Sets the SshHostRsaKeyFingerprint property

WithSshKeyName(String) Obsolete.
Sets the SshKeyName property

WithStackId(String) Obsolete.
Sets the StackId property

WithStatus(String) Obsolete.
Sets the Status property

WithSubnetId(String) Obsolete.
Sets the SubnetId property

WithVirtualizationType(String) Obsolete.
Sets the VirtualizationType property

Inheritance Hierarchy
Object
Instance

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)