AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Describes an instance.

Inheritance Hierarchy

System.Object
  Amazon.OpsWorks.Model.Instance

Namespace: Amazon.OpsWorks.Model
Assembly: AWSSDK.OpsWorks.dll
Version: 3.x.y.z

Syntax

C#
public class Instance

The Instance type exposes the following members

Constructors

NameDescription
Public Method Instance()

Properties

NameTypeDescription
Public Property AgentVersion System.String

Gets and sets the property 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.

Public Property AmiId System.String

Gets and sets the property AmiId.

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

Public Property Architecture Amazon.OpsWorks.Architecture

Gets and sets the property Architecture.

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

Public Property Arn System.String

Gets and sets the property Arn.

Public Property AutoScalingType Amazon.OpsWorks.AutoScalingType

Gets and sets the property AutoScalingType.

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

Public Property AvailabilityZone System.String

Gets and sets the property AvailabilityZone.

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

Public Property BlockDeviceMappings System.Collections.Generic.List<Amazon.OpsWorks.Model.BlockDeviceMapping>

Gets and sets the property BlockDeviceMappings.

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

Public Property CreatedAt System.String

Gets and sets the property CreatedAt.

The time that the instance was created.

Public Property EbsOptimized System.Boolean

Gets and sets the property EbsOptimized.

Whether this is an Amazon EBS-optimized instance.

Public Property Ec2InstanceId System.String

Gets and sets the property Ec2InstanceId.

The ID of the associated Amazon EC2 instance.

Public Property EcsClusterArn System.String

Gets and sets the property EcsClusterArn.

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

Public Property EcsContainerInstanceArn System.String

Gets and sets the property EcsContainerInstanceArn.

For container instances, the instance's ARN.

Public Property ElasticIp System.String

Gets and sets the property ElasticIp.

The instance Elastic IP address .

Public Property Hostname System.String

Gets and sets the property Hostname.

The instance host name.

Public Property InfrastructureClass System.String

Gets and sets the property InfrastructureClass.

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

Public Property InstallUpdatesOnBoot System.Boolean

Gets and sets the property 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.

Public Property InstanceId System.String

Gets and sets the property InstanceId.

The instance ID.

Public Property InstanceProfileArn System.String

Gets and sets the property InstanceProfileArn.

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

Public Property InstanceType System.String

Gets and sets the property InstanceType.

The instance type, such as t2.micro.

Public Property LastServiceErrorId System.String

Gets and sets the property LastServiceErrorId.

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

Public Property LayerIds System.Collections.Generic.List<System.String>

Gets and sets the property LayerIds.

An array containing the instance layer IDs.

Public Property Os System.String

Gets and sets the property Os.

The instance's operating system.

Public Property Platform System.String

Gets and sets the property Platform.

The instance's platform.

Public Property PrivateDns System.String

Gets and sets the property PrivateDns.

The instance's private DNS name.

Public Property PrivateIp System.String

Gets and sets the property PrivateIp.

The instance's private IP address.

Public Property PublicDns System.String

Gets and sets the property PublicDns.

The instance public DNS name.

Public Property PublicIp System.String

Gets and sets the property PublicIp.

The instance public IP address.

Public Property RegisteredBy System.String

Gets and sets the property RegisteredBy.

For registered instances, who performed the registration.

Public Property ReportedAgentVersion System.String

Gets and sets the property ReportedAgentVersion.

The instance's reported AWS OpsWorks Stacks agent version.

Public Property ReportedOs Amazon.OpsWorks.Model.ReportedOs

Gets and sets the property ReportedOs.

For registered instances, the reported operating system.

Public Property RootDeviceType Amazon.OpsWorks.RootDeviceType

Gets and sets the property RootDeviceType.

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

Public Property RootDeviceVolumeId System.String

Gets and sets the property RootDeviceVolumeId.

The root device volume ID.

Public Property SecurityGroupIds System.Collections.Generic.List<System.String>

Gets and sets the property SecurityGroupIds.

An array containing the instance security group IDs.

Public Property SshHostDsaKeyFingerprint System.String

Gets and sets the property SshHostDsaKeyFingerprint.

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

Public Property SshHostRsaKeyFingerprint System.String

Gets and sets the property SshHostRsaKeyFingerprint.

The SSH key's RSA fingerprint.

Public Property SshKeyName System.String

Gets and sets the property SshKeyName.

The instance's Amazon EC2 key-pair name.

Public Property StackId System.String

Gets and sets the property StackId.

The stack ID.

Public Property Status System.String

Gets and sets the property 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

Public Property SubnetId System.String

Gets and sets the property SubnetId.

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

Public Property Tenancy System.String

Gets and sets the property Tenancy.

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

Public Property VirtualizationType Amazon.OpsWorks.VirtualizationType

Gets and sets the property VirtualizationType.

The instance's virtualization type: paravirtual or hvm.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms