Class InstanceState

Inheritance

System.Object

InputArgs

ResourceArgs

InstanceState

Inherited Members

ResourceArgs.Empty

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Ec2

Assembly: Pulumi.Aws.dll

Syntax

public sealed class InstanceState : ResourceArgs

Constructors

InstanceState()

Declaration

public InstanceState()

Properties

Ami

The AMI to use for the instance.

Declaration

public Input<string> Ami { get; set; }

Property Value

Type	Description
Input<System.String>

Arn

The ARN of the instance.

Declaration

public Input<string> Arn { get; set; }

Property Value

Type	Description
Input<System.String>

AssociatePublicIpAddress

Associate a public ip address with an instance in a VPC. Boolean value.

Declaration

public Input<bool> AssociatePublicIpAddress { get; set; }

Property Value

Type	Description
Input<System.Boolean>

AvailabilityZone

The AZ to start the instance in.

Declaration

public Input<string> AvailabilityZone { get; set; }

Property Value

Type	Description
Input<System.String>

CpuCoreCount

Sets the number of CPU cores for an instance. This option is only supported on creation of instance type that support CPU Options CPU Cores and Threads Per CPU Core Per Instance Type - specifying this option for unsupported instance types will return an error from the EC2 API.

Declaration

public Input<int> CpuCoreCount { get; set; }

Property Value

Type	Description
Input<System.Int32>

CpuThreadsPerCore

If set to to 1, hyperthreading is disabled on the launched instance. Defaults to 2 if not set. See Optimizing CPU Options for more information.

Declaration

public Input<int> CpuThreadsPerCore { get; set; }

Property Value

Type	Description
Input<System.Int32>

CreditSpecification

Customize the credit specification of the instance. See Credit Specification below for more details.

Declaration

public Input<InstanceCreditSpecificationGetArgs> CreditSpecification { get; set; }

Property Value

Type	Description
Input<InstanceCreditSpecificationGetArgs>

DisableApiTermination

If true, enables EC2 Instance Termination Protection

Declaration

public Input<bool> DisableApiTermination { get; set; }

Property Value

Type	Description
Input<System.Boolean>

EbsBlockDevices

Additional EBS block devices to attach to the instance. Block device configurations only apply on resource creation. See Block Devices below for details on attributes and drift detection.

Declaration

public InputList<InstanceEbsBlockDeviceGetArgs> EbsBlockDevices { get; set; }

Property Value

Type	Description
InputList<InstanceEbsBlockDeviceGetArgs>

EbsOptimized

If true, the launched EC2 instance will be EBS-optimized. Note that if this is not set on an instance type that is optimized by default then this will show as disabled but if the instance type is optimized by default then there is no need to set this and there is no effect to disabling it. See the EBS Optimized section of the AWS User Guide for more information.

Declaration

public Input<bool> EbsOptimized { get; set; }

Property Value

Type	Description
Input<System.Boolean>

EphemeralBlockDevices

Customize Ephemeral (also known as "Instance Store") volumes on the instance. See Block Devices below for details.

Declaration

public InputList<InstanceEphemeralBlockDeviceGetArgs> EphemeralBlockDevices { get; set; }

Property Value

Type	Description
InputList<InstanceEphemeralBlockDeviceGetArgs>

GetPasswordData

If true, wait for password data to become available and retrieve it. Useful for getting the administrator password for instances running Microsoft Windows. The password data is exported to the password_data attribute. See GetPasswordData for more information.

Declaration

public Input<bool> GetPasswordData { get; set; }

Property Value

Type	Description
Input<System.Boolean>

Hibernation

If true, the launched EC2 instance will support hibernation.

Declaration

public Input<bool> Hibernation { get; set; }

Property Value

Type	Description
Input<System.Boolean>

HostId

The Id of a dedicated host that the instance will be assigned to. Use when an instance is to be launched on a specific dedicated host.

Declaration

public Input<string> HostId { get; set; }

Property Value

Type	Description
Input<System.String>

IamInstanceProfile

The IAM Instance Profile to launch the instance with. Specified as the name of the Instance Profile. Ensure your credentials have the correct permission to assign the instance profile according to the EC2 documentation, notably iam:PassRole.

Declaration

public Input<string> IamInstanceProfile { get; set; }

Property Value

Type	Description
Input<System.String>

InstanceInitiatedShutdownBehavior

Shutdown behavior for the instance. Amazon defaults this to stop for EBS-backed instances and terminate for instance-store instances. Cannot be set on instance-store instances. See Shutdown Behavior for more information.

Declaration

public Input<string> InstanceInitiatedShutdownBehavior { get; set; }

Property Value

Type	Description
Input<System.String>

InstanceType

The type of instance to start. Updates to this field will trigger a stop/start of the EC2 instance.

Declaration

public Input<string> InstanceType { get; set; }

Property Value

Type	Description
Input<System.String>

Ipv6AddressCount

A number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet.

Declaration

public Input<int> Ipv6AddressCount { get; set; }

Property Value

Type	Description
Input<System.Int32>

Ipv6Addresses

Specify one or more IPv6 addresses from the range of the subnet to associate with the primary network interface

Declaration

public InputList<string> Ipv6Addresses { get; set; }

Property Value

Type	Description
InputList<System.String>

KeyName

The key name of the Key Pair to use for the instance; which can be managed using the aws.ec2.KeyPair resource.

Declaration

public Input<string> KeyName { get; set; }

Property Value

Type	Description
Input<System.String>

MetadataOptions

Customize the metadata options of the instance. See Metadata Options below for more details.

Declaration

public Input<InstanceMetadataOptionsGetArgs> MetadataOptions { get; set; }

Property Value

Type	Description
Input<InstanceMetadataOptionsGetArgs>

Monitoring

If true, the launched EC2 instance will have detailed monitoring enabled. (Available since v0.6.0)

Declaration

public Input<bool> Monitoring { get; set; }

Property Value

Type	Description
Input<System.Boolean>

NetworkInterfaces

Customize network interfaces to be attached at instance boot time. See Network Interfaces below for more details.

Declaration

public InputList<InstanceNetworkInterfaceGetArgs> NetworkInterfaces { get; set; }

Property Value

Type	Description
InputList<InstanceNetworkInterfaceGetArgs>

OutpostArn

The ARN of the Outpost the instance is assigned to.

Declaration

public Input<string> OutpostArn { get; set; }

Property Value

Type	Description
Input<System.String>

PasswordData

Base-64 encoded encrypted password data for the instance. Useful for getting the administrator password for instances running Microsoft Windows. This attribute is only exported if get_password_data is true. Note that this encrypted value will be stored in the state file, as with all exported attributes. See GetPasswordData for more information.

Declaration

public Input<string> PasswordData { get; set; }

Property Value

Type	Description
Input<System.String>

PlacementGroup

The Placement Group to start the instance in.

Declaration

public Input<string> PlacementGroup { get; set; }

Property Value

Type	Description
Input<System.String>

PrimaryNetworkInterfaceId

The ID of the instance's primary network interface.

Declaration

public Input<string> PrimaryNetworkInterfaceId { get; set; }

Property Value

Type	Description
Input<System.String>

PrivateDns

The private DNS name assigned to the instance. Can only be used inside the Amazon EC2, and only available if you've enabled DNS hostnames for your VPC

Declaration

public Input<string> PrivateDns { get; set; }

Property Value

Type	Description
Input<System.String>

PrivateIp

Private IP address to associate with the instance in a VPC.

Declaration

public Input<string> PrivateIp { get; set; }

Property Value

Type	Description
Input<System.String>

PublicDns

The public DNS name assigned to the instance. For EC2-VPC, this is only available if you've enabled DNS hostnames for your VPC

Declaration

public Input<string> PublicDns { get; set; }

Property Value

Type	Description
Input<System.String>

PublicIp

The public IP address assigned to the instance, if applicable. NOTE: If you are using an aws.ec2.Eip with your instance, you should refer to the EIP's address directly and not use public_ip, as this field will change after the EIP is attached.

Declaration

public Input<string> PublicIp { get; set; }

Property Value

Type	Description
Input<System.String>

RootBlockDevice

Customize details about the root block device of the instance. See Block Devices below for details.

Declaration

public Input<InstanceRootBlockDeviceGetArgs> RootBlockDevice { get; set; }

Property Value

Type	Description
Input<InstanceRootBlockDeviceGetArgs>

SecurityGroups

A list of security group names (EC2-Classic) or IDs (default VPC) to associate with.

Declaration

[Obsolete("Use of `securityGroups` is discouraged as it does not allow for changes and will force your instance to be replaced if changes are made. To avoid this, use `vpcSecurityGroupIds` which allows for updates.")]
public InputList<string> SecurityGroups { get; set; }

Property Value

Type	Description
InputList<System.String>

SourceDestCheck

Controls if traffic is routed to the instance when the destination address does not match the instance. Used for NAT or VPNs. Defaults true.

Declaration

public Input<bool> SourceDestCheck { get; set; }

Property Value

Type	Description
Input<System.Boolean>

State

The state of the instance. One of: pending, running, shutting-down, terminated, stopping, stopped. See Instance Lifecycle for more information.

Declaration

public Input<string> State { get; set; }

Property Value

Type	Description
Input<System.String>

SubnetId

The VPC Subnet ID to launch in.

Declaration

public Input<string> SubnetId { get; set; }

Property Value

Type	Description
Input<System.String>

Tags

A map of tags to assign to the resource.

Declaration

public InputMap<object> Tags { get; set; }

Property Value

Type	Description
InputMap<System.Object>

Tenancy

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the import-instance command.

Declaration

public Input<string> Tenancy { get; set; }

Property Value

Type	Description
Input<System.String>

UserData

The user data to provide when launching the instance. Do not pass gzip-compressed data via this argument; see user_data_base64 instead.

Declaration

public Input<string> UserData { get; set; }

Property Value

Type	Description
Input<System.String>

UserDataBase64

Can be used instead of user_data to pass base64-encoded binary data directly. Use this instead of user_data whenever the value is not a valid UTF-8 string. For example, gzip-encoded user data must be base64-encoded and passed via this argument to avoid corruption.

Declaration

public Input<string> UserDataBase64 { get; set; }

Property Value

Type	Description
Input<System.String>

VolumeTags

A map of tags to assign to the devices created by the instance at launch time.

Declaration

public InputMap<object> VolumeTags { get; set; }

Property Value

Type	Description
InputMap<System.Object>

VpcSecurityGroupIds

A list of security group IDs to associate with.

Declaration

public InputList<string> VpcSecurityGroupIds { get; set; }

Property Value

Type	Description
InputList<System.String>