Class: MintPress::Aws::EC2::Instance

Properties (Read/Write)

#connect_address (Default Value: Proc.new { break nil if self.id.nil? or !self.id.start_with?('i-') self.harvest(with_children: false) if public_ip_address.nil? and private_ip_address.nil? break nil if public_ip_address.nil? and private_ip_address.nil? wait_for_connectable([self.public_ip_address, self.private_ip_address], 22, oneshot: true) })

Property Attributes

default ⇒ Proc.new { break nil if self.id.nil? or !self.id.start_with?('i-') self.harvest(with_children: false) if public_ip_address.nil? and private_ip_address.nil? break nil if public_ip_address.nil? and private_ip_address.nil? wait_for_connectable([self.public_ip_address, self.private_ip_address], 22, oneshot: true) }

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 60

property :connect_address, default: Proc.new { 
  break nil if self.id.nil? or !self.id.start_with?('i-')
  self.harvest(with_children: false) if public_ip_address.nil? and private_ip_address.nil?
  break nil if public_ip_address.nil? and private_ip_address.nil?
  wait_for_connectable([self.public_ip_address, self.private_ip_address], 22, oneshot: true)
}

#connect_user (Default Value: 'ec2-user')

Property Attributes

default ⇒ 'ec2-user'

66	# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 66 property :connect_user, default: 'ec2-user'

#admin_connect_user (Default Value: 'ec2-user')

Property Attributes

default ⇒ 'ec2-user'

67	# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 67 property :admin_connect_user, default: 'ec2-user'

#exclude_boot_volume ⇒ [TrueClass,FalseClass]
'Excludes the root volume from being snapshotted.'
Property Attributes

disposition ⇒ :attribute
source ⇒ "MintPress::Aws::EC2::Instance"
orig_name ⇒ 'exclude_boot_volume'
create_snapshots_prop ⇒ 'exclude_boot_volume'

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 68

property :exclude_boot_volume, disposition: :attribute, description: 'Excludes the root volume from being snapshotted.', source: "MintPress::Aws::EC2::Instance", orig_name: 'exclude_boot_volume', type: [TrueClass,FalseClass], create_snapshots_prop: 'exclude_boot_volume'

#block_device_mappings ⇒ Array of ⇒ [MintPress::Aws::EC2::BlockDeviceMapping]
'The block device mapping entries.'
Property Attributes

source ⇒ "create_instances"
orig_name ⇒ 'block_device_mappings'
read_only ⇒ false
create_instances_prop ⇒ 'block_device_mappings'

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 71

property :block_device_mappings, description: 'The block device mapping entries.', source: "create_instances", orig_name: 'block_device_mappings', type: [MintPress::Aws::EC2::BlockDeviceMapping], array: true, read_only: false, create_instances_prop: 'block_device_mappings'

#capacity_reservation ⇒ [MintPress::Aws::EC2::CapacityReservation] (Default Value: MintPress::Aws::EC2::CapacityReservation.new)
'Information about the Capacity Reservation targeting option. If you do not specify this parameter, the instance"s Capacity Reservation preference defaults to open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).'
Property Attributes

source ⇒ "create_instances"
orig_name ⇒ 'capacity_reservation_specification'
read_only ⇒ false
default ⇒ MintPress::Aws::EC2::CapacityReservation.new
create_instances_prop ⇒ 'capacity_reservation_specification'
from ⇒ String

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 72

property :capacity_reservation, description: 'Information about the Capacity Reservation targeting option. If you do
not specify this parameter, the instance"s Capacity Reservation
preference defaults to open, which enables it to run in any open
Capacity Reservation that has matching attributes (instance type,
platform, Availability Zone).', source: "create_instances", orig_name: 'capacity_reservation_specification', type: [MintPress::Aws::EC2::CapacityReservation], read_only: false, default: MintPress::Aws::EC2::CapacityReservation.new, create_instances_prop: 'capacity_reservation_specification', from: String

#client_token ⇒ [String]
'Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency. For more information, see Ensuring Idempotency. Constraints: Maximum 64 ASCII characters'
Property Attributes

source ⇒ "create_instances"
orig_name ⇒ 'client_token'
read_only ⇒ false
create_instances_prop ⇒ 'client_token'

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 77

property :client_token, description: 'Unique, case-sensitive identifier you provide to ensure the
idempotency of the request. If you do not specify a client token, a
randomly generated token is used for the request to ensure
idempotency.

For more information, see Ensuring Idempotency.

Constraints: Maximum 64 ASCII characters', source: "create_instances", orig_name: 'client_token', type: [String], read_only: false, create_instances_prop: 'client_token'

#cpu_options ⇒ [MintPress::Aws::EC2::CpuOption] (Default Value: MintPress::Aws::EC2::CpuOption.new)
'The CPU options for the instance. For more information, see Optimizing CPU options in the Amazon Elastic Compute Cloud User Guide.'
Property Attributes

source ⇒ "create_instances"
orig_name ⇒ 'cpu_options'
default ⇒ MintPress::Aws::EC2::CpuOption.new
read_only ⇒ false
create_instances_prop ⇒ 'cpu_options'



85
86
87

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 85

property :cpu_options, description: 'The CPU options for the instance. For more information, see
Optimizing CPU options in the Amazon Elastic Compute Cloud User
Guide.', source: "create_instances", orig_name: 'cpu_options', type: [MintPress::Aws::EC2::CpuOption], default: MintPress::Aws::EC2::CpuOption.new, read_only: false, create_instances_prop: 'cpu_options'

#ebs_optimized ⇒ [TrueClass,FalseClass]
'Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn"t available with all instance types. Additional usage charges apply when using an EBS-optimized instance. Default: false'
Property Attributes

source ⇒ "create_instances"
orig_name ⇒ 'ebs_optimized'
read_only ⇒ false
create_instances_prop ⇒ 'ebs_optimized'

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 88

property :ebs_optimized, description: 'Indicates whether the instance is optimized for Amazon EBS I/O. This
optimization provides dedicated throughput to Amazon EBS and an
optimized configuration stack to provide optimal Amazon EBS I/O
performance. This optimization isn"t available with all instance
types. Additional usage charges apply when using an EBS-optimized
instance.

Default: false', source: "create_instances", orig_name: 'ebs_optimized', type: [TrueClass,FalseClass], read_only: false, create_instances_prop: 'ebs_optimized'

#enclave_options ⇒ [TrueClass,FalseClass]
'Indicates whether the instance is enabled for AWS Nitro Enclaves. For more information, see What is AWS Nitro Enclaves? in the AWS Nitro Enclaves User Guide. You can"t enable AWS Nitro Enclaves and hibernation on the same instance.'
Property Attributes

source ⇒ "create_instances"
orig_name ⇒ 'enclave_options'
read_only ⇒ false
create_instances_prop ⇒ "enclave_options.enabled"

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 99

property :enclave_options, description: 'Indicates whether the instance is enabled for AWS Nitro Enclaves. For
more information, see  What is AWS Nitro Enclaves? in the AWS
Nitro Enclaves User Guide.

You can"t enable AWS Nitro Enclaves and hibernation on the same
instance.', source: "create_instances", orig_name: 'enclave_options', type: [TrueClass,FalseClass], read_only: false, create_instances_prop: "enclave_options.enabled"

#hibernation_options ⇒ [TrueClass,FalseClass]
'Indicates whether an instance is enabled for hibernation. For more information, see Hibernate your instance in the Amazon Elastic Compute Cloud User Guide. You can"t enable hibernation and AWS Nitro Enclaves on the same instance.'
Property Attributes

source ⇒ "create_instances"
orig_name ⇒ 'hibernation_options'
read_only ⇒ false
create_instances_prop ⇒ "hibernation_options.configured"

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 105

property :hibernation_options, description: 'Indicates whether an instance is enabled for hibernation. For more
information, see Hibernate your instance in the Amazon Elastic
Compute Cloud User Guide.

You can"t enable hibernation and AWS Nitro Enclaves on the same
instance.', source: "create_instances", orig_name: 'hibernation_options', type: [TrueClass,FalseClass], read_only: false, create_instances_prop: "hibernation_options.configured"

#iam_instance_profile ⇒ [MintPress::Aws::EC2::IamInstanceProfile] (Default Value: MintPress::Aws::EC2::IamInstanceProfile.new)
'The IAM instance profile.'
Property Attributes

source ⇒ "create_instances"
orig_name ⇒ 'iam_instance_profile'
default ⇒ MintPress::Aws::EC2::IamInstanceProfile.new
read_only ⇒ false
create_instances_prop ⇒ 'iam_instance_profile'

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 112

property :iam_instance_profile, description: 'The IAM instance profile.', source: "create_instances", orig_name: 'iam_instance_profile', type: [MintPress::Aws::EC2::IamInstanceProfile], default: MintPress::Aws::EC2::IamInstanceProfile.new, read_only: false, create_instances_prop: 'iam_instance_profile'

#instance_type ⇒ [String]
'The instance type. For more information, see Instance types in the Amazon Elastic Compute Cloud User Guide. Default: m1.small'
Property Attributes

source ⇒ "create_instances"
orig_name ⇒ 'instance_type'
read_only ⇒ false
create_instances_prop ⇒ 'instance_type'

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 114

property :instance_type, description: 'The instance type. For more information, see Instance types in
the Amazon Elastic Compute Cloud User Guide.

Default: m1.small', source: "create_instances", orig_name: 'instance_type', type: [String], read_only: false, create_instances_prop: 'instance_type'

#key_name ⇒ [String]
'The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair. If you do not specify a key pair, you can"t connect to the instance unless you choose an AMI that is configured to allow users another way to log in.'
Property Attributes

source ⇒ "create_instances"
orig_name ⇒ 'key_name'
read_only ⇒ false
create_instances_prop ⇒ 'key_name'

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 118

property :key_name, description: 'The name of the key pair. You can create a key pair using
CreateKeyPair or ImportKeyPair.

If you do not specify a key pair, you can"t connect to the instance
unless you choose an AMI that is configured to allow users another way
to log in.', source: "create_instances", orig_name: 'key_name', type: [String], read_only: false, create_instances_prop: 'key_name'

#licenses ⇒ Array of ⇒ [String]
'The license configurations.'
Property Attributes

source ⇒ "create_instances"
orig_name ⇒ 'licenses'
read_only ⇒ false
create_instances_prop ⇒ "license_specifications.license_configuration_arn"

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 125

property :licenses, description: 'The license configurations.', source: "create_instances", orig_name: 'licenses', type: [String], array: true, read_only: false, create_instances_prop: "license_specifications.license_configuration_arn"

#metadata_options ⇒ [MintPress::Aws::EC2::InstanceMetadataOption] (Default Value: MintPress::Aws::EC2::InstanceMetadataOption.new)
'The metadata options for the instance. For more information, see Instance metadata and user data.'
Property Attributes

source ⇒ "create_instances"
orig_name ⇒ 'metadata_options'
default ⇒ MintPress::Aws::EC2::InstanceMetadataOption.new
read_only ⇒ false
create_instances_prop ⇒ 'metadata_options'



126
127

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 126

property :metadata_options, description: 'The metadata options for the instance. For more information, see
Instance metadata and user data.', source: "create_instances", orig_name: 'metadata_options', type: [MintPress::Aws::EC2::InstanceMetadataOption], default: MintPress::Aws::EC2::InstanceMetadataOption.new, read_only: false, create_instances_prop: 'metadata_options'

#monitoring ⇒ [MintPress::Aws::EC2::Monitoring] (Default Value: MintPress::Aws::EC2::Monitoring.new)
'Specifies whether detailed monitoring is enabled for the instance.'
Property Attributes

source ⇒ "create_instances"
orig_name ⇒ 'monitoring'
default ⇒ MintPress::Aws::EC2::Monitoring.new
read_only ⇒ false
create_instances_prop ⇒ 'monitoring'

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 128

property :monitoring, description: 'Specifies whether detailed monitoring is enabled for the instance.', source: "create_instances", orig_name: 'monitoring', type: [MintPress::Aws::EC2::Monitoring], default: MintPress::Aws::EC2::Monitoring.new, read_only: false, create_instances_prop: 'monitoring'

#network_interfaces ⇒ Hash of ⇒ [MintPress::Aws::EC2::NetworkInterface]
'The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.'
Property Attributes

source ⇒ "create_instances"
orig_name ⇒ 'network_interfaces'
create_instances_prop ⇒ 'network_interfaces'
read_only ⇒ false



129
130
131

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 129

property :network_interfaces, description: 'The network interfaces to associate with the instance. If you specify
a network interface, you must specify any security groups and subnets
as part of the network interface.', source: "create_instances", orig_name: 'network_interfaces', type: [MintPress::Aws::EC2::NetworkInterface], array: false, create_instances_prop: 'network_interfaces', read_only: false, hash: true

#placement ⇒ [MintPress::Aws::EC2::Placement] (Default Value: MintPress::Aws::EC2::Placement.new)
'The placement for the instance.'
Property Attributes

source ⇒ "create_instances"
orig_name ⇒ 'placement'
default ⇒ MintPress::Aws::EC2::Placement.new
read_only ⇒ false
create_instances_prop ⇒ 'placement'

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 133

property :placement, description: 'The placement for the instance.', source: "create_instances", orig_name: 'placement', type: [MintPress::Aws::EC2::Placement], default: MintPress::Aws::EC2::Placement.new, read_only: false, create_instances_prop: 'placement'

#private_ip_address ⇒ [String]
'[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet. Only one private IP address can be designated as primary. You can"t specify this option if you"ve specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you"re launching more than one instance in the request. You cannot specify this option and the network interfaces option in the same request.'
Property Attributes

source ⇒ "create_instances"
orig_name ⇒ 'private_ip_address'
read_only ⇒ false
create_instances_prop ⇒ 'private_ip_address'

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 136

property :private_ip_address, description: '[EC2-VPC] The primary IPv4 address. You must specify a value from
the IPv4 address range of the subnet.

Only one private IP address can be designated as primary. You can"t
specify this option if you"ve specified the option to designate a
private IP address as the primary IP address in a network interface
specification. You cannot specify this option if you"re launching
more than one instance in the request.

You cannot specify this option and the network interfaces option in
the same request.', source: "create_instances", orig_name: 'private_ip_address', type: [String], read_only: false, create_instances_prop: 'private_ip_address'

#tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
'The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.'
Property Attributes

source ⇒ "create_instances"
orig_name ⇒ 'tags'
read_only ⇒ false
create_instances_prop ⇒ 'tag_specifications'

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 158

property :tags, description: 'The tags to apply to the resources during launch. You can only tag
instances and volumes on launch. The specified tags are applied to all
instances or volumes that are created during launch. To tag a resource
after it has been created, see CreateTags.', source: "create_instances", orig_name: 'tags', type: [MintPress::Aws::EC2::Tag], array: false, read_only: false, create_instances_prop: 'tag_specifications', hash: true

#filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
'The filters. affinity - The affinity setting for an instance running on a Dedicated Host (default | host). architecture - The instance architecture (i386 | x86_64 | arm64). availability-zone - The Availability Zone of the instance. block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z. block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination. block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh). block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached). block-device-mapping.volume-id - The volume ID of the EBS volume. client-token - The idempotency token you provided when you launched the instance. dns-name - The public DNS name of the instance. group-id - The ID of the security group for the instance. EC2-Classic only. group-name - The name of the security group for the instance. EC2-Classic only. hibernation-options.configured - A Boolean that indicates whether the instance is enabled for hibernation. A value of true means that the instance is enabled for hibernation. host-id - The ID of the Dedicated Host on which the instance is running, if applicable. hypervisor - The hypervisor type of the instance (ovm | xen). The value xen is used for both Xen and Nitro hypervisors. iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN. image-id - The ID of the image used to launch the instance. instance-id - The ID of the instance. instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled Instance (spot | scheduled). instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped). instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped). instance-type - The type of instance (for example, t2.micro). instance.group-id - The ID of the security group for the instance. instance.group-name - The name of the security group for the instance. ip-address - The public IPv4 address of the instance. kernel-id - The kernel ID. key-name - The name of the key pair used when the instance was launched. launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on). launch-time - The time when the instance was launched. metadata-options.http-tokens - The metadata request authorization state (optional | required) metadata-options.http-put-response-hop-limit - The http metadata request put response hop limit (integer, possible values 1 to 64) metadata-options.http-endpoint - Enable or disable metadata access on http endpoint (enabled | disabled) monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled). network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface. network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address. network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface. network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface. network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface. network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface. network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface. network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address. network-interface.attachment.attachment-id - The ID of the interface attachment. network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached. network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached. network-interface.attachment.device-index - The device index to which the network interface is attached. network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached). network-interface.attachment.attach-time - The time that the network interface was attached to an instance. network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated. network-interface.availability-zone - The Availability Zone for the network interface. network-interface.description - The description of the network interface. network-interface.group-id - The ID of a security group associated with the network interface. network-interface.group-name - The name of a security group associated with the network interface. network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface. network-interface.mac-address - The MAC address of the network interface. network-interface.network-interface-id - The ID of the network interface. network-interface.owner-id - The ID of the owner of the network interface. network-interface.private-dns-name - The private DNS name of the network interface. network-interface.requester-id - The requester ID for the network interface. network-interface.requester-managed - Indicates whether the network interface is being managed by AWS. network-interface.status - The status of the network interface (available) | in-use). network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC. network-interface.subnet-id - The ID of the subnet for the network interface. network-interface.vpc-id - The ID of the VPC for the network interface. owner-id - The AWS account ID of the instance owner. placement-group-name - The name of the placement group for the instance. placement-partition-number - The partition in which the instance is located. platform - The platform. To list only Windows instances, use windows. private-dns-name - The private IPv4 DNS name of the instance. private-ip-address - The private IPv4 address of the instance. product-code - The product code associated with the AMI used to launch the instance. product-code.type - The type of product code (devpay | marketplace). ramdisk-id - The RAM disk ID. reason - The reason for the current state of the instance (for example, shows "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter. requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on). reservation-id - The ID of the instance"s reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID. root-device-name - The device name of the root device volume (for example, /dev/sda1). root-device-type - The type of the root device volume (ebs | instance-store). source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC. spot-instance-request-id - The ID of the Spot Instance request. state-reason-code - The reason code for the state change. state-reason-message - A message that describes the state change. subnet-id - The ID of the subnet for the instance. tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value. tenancy - The tenancy of an instance (dedicated | default | host). virtualization-type - The virtualization type of the instance (paravirtual | hvm). vpc-id - The ID of the VPC that the instance is running in.'
Property Attributes

describe_instances_prop ⇒ 'filters'
source ⇒ "describe_instances"

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 163

property :filters, describe_instances_prop: 'filters', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_instances", description: 'The filters.


affinity - The affinity setting for an instance running on a
Dedicated Host (default | host).
architecture - The instance architecture (i386 | x86_64 |
arm64).
availability-zone - The Availability Zone of the instance.
block-device-mapping.attach-time - The attach time for an EBS
volume mapped to the instance, for example,
2010-09-15T17:15:20.000Z.
block-device-mapping.delete-on-termination - A Boolean that
indicates whether the EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name specified in
the block device mapping (for example, /dev/sdh or xvdh).
block-device-mapping.status - The status for the EBS volume
(attaching | attached | detaching | detached).
block-device-mapping.volume-id - The volume ID of the EBS volume.
client-token - The idempotency token you provided when you
launched the instance.
dns-name - The public DNS name of the instance.
group-id - The ID of the security group for the instance.
EC2-Classic only.
group-name - The name of the security group for the instance.
EC2-Classic only.
hibernation-options.configured - A Boolean that indicates whether
the instance is enabled for hibernation. A value of true means
that the instance is enabled for hibernation.
host-id - The ID of the Dedicated Host on which the instance is
running, if applicable.
hypervisor - The hypervisor type of the instance (ovm | xen).
The value xen is used for both Xen and Nitro hypervisors.
iam-instance-profile.arn - The instance profile associated with
the instance. Specified as an ARN.
image-id - The ID of the image used to launch the instance.
instance-id - The ID of the instance.
instance-lifecycle - Indicates whether this is a Spot Instance or
a Scheduled Instance (spot | scheduled).
instance-state-code - The state of the instance, as a 16-bit
unsigned integer. The high byte is used for internal purposes and
should be ignored. The low byte is set based on the state
represented. The valid values are: 0 (pending), 16 (running), 32
(shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending |
running | shutting-down | terminated | stopping |
stopped).
instance-type - The type of instance (for example, t2.micro).
instance.group-id - The ID of the security group for the instance.
instance.group-name - The name of the security group for the
instance.
ip-address - The public IPv4 address of the instance.
kernel-id - The kernel ID.
key-name - The name of the key pair used when the instance was
launched.
launch-index - When launching multiple instances, this is the
index for the instance in the launch group (for example, 0, 1, 2,
and so on).
launch-time - The time when the instance was launched.
metadata-options.http-tokens - The metadata request authorization
state (optional | required)
metadata-options.http-put-response-hop-limit - The http metadata
request put response hop limit (integer, possible values 1 to
64)
metadata-options.http-endpoint - Enable or disable metadata access
on http endpoint (enabled | disabled)
monitoring-state - Indicates whether detailed monitoring is
enabled (disabled | enabled).
network-interface.addresses.private-ip-address - The private IPv4
address associated with the network interface.
network-interface.addresses.primary - Specifies whether the IPv4
address of the network interface is the primary private IPv4
address.
network-interface.addresses.association.public-ip - The ID of the
association of an Elastic IP address (IPv4) with a network
interface.
network-interface.addresses.association.ip-owner-id - The owner ID
of the private IPv4 address associated with the network interface.
network-interface.association.public-ip - The address of the
Elastic IP address (IPv4) bound to the network interface.
network-interface.association.ip-owner-id - The owner of the
Elastic IP address (IPv4) associated with the network interface.
network-interface.association.allocation-id - The allocation ID
returned when you allocated the Elastic IP address (IPv4) for your
network interface.
network-interface.association.association-id - The association ID
returned when the network interface was associated with an IPv4
address.
network-interface.attachment.attachment-id - The ID of the
interface attachment.
network-interface.attachment.instance-id - The ID of the instance
to which the network interface is attached.
network-interface.attachment.instance-owner-id - The owner ID of
the instance to which the network interface is attached.
network-interface.attachment.device-index - The device index to
which the network interface is attached.
network-interface.attachment.status - The status of the attachment
(attaching | attached | detaching | detached).
network-interface.attachment.attach-time - The time that the
network interface was attached to an instance.
network-interface.attachment.delete-on-termination - Specifies
whether the attachment is deleted when an instance is terminated.
network-interface.availability-zone - The Availability Zone for
the network interface.
network-interface.description - The description of the network
interface.
network-interface.group-id - The ID of a security group associated
with the network interface.
network-interface.group-name - The name of a security group
associated with the network interface.
network-interface.ipv6-addresses.ipv6-address - The IPv6 address
associated with the network interface.
network-interface.mac-address - The MAC address of the network
interface.
network-interface.network-interface-id - The ID of the network
interface.
network-interface.owner-id - The ID of the owner of the network
interface.
network-interface.private-dns-name - The private DNS name of the
network interface.
network-interface.requester-id - The requester ID for the network
interface.
network-interface.requester-managed - Indicates whether the
network interface is being managed by AWS.
network-interface.status - The status of the network interface
(available) | in-use).
network-interface.source-dest-check - Whether the network
interface performs source/destination checking. A value of true
means that checking is enabled, and false means that checking is
disabled. The value must be false for the network interface to
perform network address translation (NAT) in your VPC.
network-interface.subnet-id - The ID of the subnet for the network
interface.
network-interface.vpc-id - The ID of the VPC for the network
interface.
owner-id - The AWS account ID of the instance owner.
placement-group-name - The name of the placement group for the
instance.
placement-partition-number - The partition in which the instance
is located.
platform - The platform. To list only Windows instances, use
windows.
private-dns-name - The private IPv4 DNS name of the instance.
private-ip-address - The private IPv4 address of the instance.
product-code - The product code associated with the AMI used to
launch the instance.
product-code.type - The type of product code (devpay |
marketplace).
ramdisk-id - The RAM disk ID.
reason - The reason for the current state of the instance (for
example, shows "User Initiated [date]" when you stop or
terminate the instance). Similar to the state-reason-code filter.
requester-id - The ID of the entity that launched the instance on
your behalf (for example, AWS Management Console, Auto Scaling, and
so on).
reservation-id - The ID of the instance"s reservation. A
reservation ID is created any time you launch an instance. A
reservation ID has a one-to-one relationship with an instance launch
request, but can be associated with more than one instance if you
launch multiple instances using the same launch request. For
example, if you launch one instance, you get one reservation ID. If
you launch ten instances using the same launch request, you also get
one reservation ID.
root-device-name - The device name of the root device volume (for
example, /dev/sda1).
root-device-type - The type of the root device volume (ebs |
instance-store).
source-dest-check - Indicates whether the instance performs
source/destination checking. A value of true means that checking
is enabled, and false means that checking is disabled. The value
must be false for the instance to perform network address
translation (NAT) in your VPC.
spot-instance-request-id - The ID of the Spot Instance request.
state-reason-code - The reason code for the state change.
state-reason-message - A message that describes the state change.
subnet-id - The ID of the subnet for the instance.
tag:<key> - The key/value combination of a tag assigned to
the resource. Use the tag key in the filter name and the tag value
as the filter value. For example, to find all resources that have a
tag with the key Owner and the value TeamA, specify tag:Owner
for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this
filter to find all resources that have a tag with a specific key,
regardless of the tag value.
tenancy - The tenancy of an instance (dedicated | default |
host).
virtualization-type - The virtualization type of the instance
(paravirtual | hvm).
vpc-id - The ID of the VPC that the instance is running in.', hash: true

#dry_run ⇒ [TrueClass,FalseClass]
'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Property Attributes

describe_instances_prop ⇒ 'dry_run'
source ⇒ "create_instances"
monitor_instances_prop ⇒ 'dry_run'
read_only ⇒ false
start_instances_prop ⇒ 'dry_run'
stop_instances_prop ⇒ 'dry_run'
terminate_instances_prop ⇒ 'dry_run'
unmonitor_instances_prop ⇒ 'dry_run'
create_instances_prop ⇒ 'dry_run'

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 351

property :dry_run, describe_instances_prop: 'dry_run', type: [TrueClass,FalseClass], source: "create_instances", description: 'Checks whether you have the required permissions for the action,
without actually making the request, and provides an error response.
If you have the required permissions, the error response is
DryRunOperation. Otherwise, it is UnauthorizedOperation.', monitor_instances_prop: 'dry_run', read_only: false, start_instances_prop: 'dry_run', stop_instances_prop: 'dry_run', terminate_instances_prop: 'dry_run', unmonitor_instances_prop: 'dry_run', create_instances_prop: 'dry_run'

#max_results ⇒ [Integer]
'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.'
Property Attributes

describe_instances_prop ⇒ 'max_results'
source ⇒ "describe_instances"

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 355

property :max_results, describe_instances_prop: 'max_results', type: [Integer], source: "describe_instances", description: 'The maximum number of results to return in a single call. To retrieve
the remaining results, make another call with the returned NextToken
value. This value can be between 5 and 1000. You cannot specify this
parameter and the instance IDs parameter in the same call.'

#additional_info ⇒ [String]
'Reserved.'
Property Attributes

start_instances_prop ⇒ 'additional_info'
read_only ⇒ false
source ⇒ "create_instances"
create_instances_prop ⇒ 'additional_info'

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 359

property :additional_info, start_instances_prop: 'additional_info', type: [String], read_only: false, source: "create_instances", description: 'Reserved.', create_instances_prop: 'additional_info'

#hibernate ⇒ [TrueClass,FalseClass]
'Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon Elastic Compute Cloud User Guide. Default: false'
Property Attributes

stop_instances_prop ⇒ 'hibernate'
read_only ⇒ false
source ⇒ "stop_instances"

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 360

property :hibernate, stop_instances_prop: 'hibernate', type: [TrueClass,FalseClass], read_only: false, source: "stop_instances", description: 'Hibernates the instance if the instance was enabled for hibernation at
launch. If the instance cannot hibernate successfully, a normal
shutdown occurs. For more information, see Hibernate your
instance in the Amazon Elastic Compute Cloud User Guide.

Default: false'

#force ⇒ [TrueClass,FalseClass]
'Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances. Default: false'
Property Attributes

stop_instances_prop ⇒ 'force'
read_only ⇒ false
source ⇒ "stop_instances"

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 366

property :force, stop_instances_prop: 'force', type: [TrueClass,FalseClass], read_only: false, source: "stop_instances", description: 'Forces the instances to stop. The instances do not have an opportunity
to flush file system caches or file system metadata. If you use this
option, you must perform file system check and repair procedures. This
option is not recommended for Windows instances.

Default: false'

#id ⇒ [String] (Default Value: Proc.new { r = nil ; r = self.name if self.name.start_with?("i-") ; r })
'The IDs of the instances.'
Property Attributes

read_only ⇒ false
source ⇒ "unmonitor_instances"
orig_name ⇒ 'instance_id'
create_snapshots_prop ⇒ 'instance_id'
describe_instances_prop ⇒ 'instance_ids'
monitor_instances_prop ⇒ 'instance_ids'
start_instances_prop ⇒ 'instance_ids'
stop_instances_prop ⇒ 'instance_ids'
terminate_instances_prop ⇒ 'instance_ids'
unmonitor_instances_prop ⇒ 'instance_ids'
default ⇒ Proc.new { r = nil ; r = self.name if self.name.start_with?("i-") ; r }

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 372

property :id, read_only: false, description: 'The IDs of the instances.', source: "unmonitor_instances", orig_name: 'instance_id', type: [String], create_snapshots_prop: 'instance_id', array: false, hash: false, describe_instances_prop: 'instance_ids', monitor_instances_prop: 'instance_ids', start_instances_prop: 'instance_ids', stop_instances_prop: 'instance_ids', terminate_instances_prop: 'instance_ids', unmonitor_instances_prop: 'instance_ids', default: Proc.new { r = nil ; r = self.name if self.name.start_with?("i-") ; r }

#classic_address ⇒ [MintPress::Aws::EC2::ClassicAddress] (Default Value: MintPress::Aws::EC2::ClassicAddress.new)

Property Attributes

disposition ⇒ :association
source ⇒ "MintPress::Aws::EC2::Instance"
orig_name ⇒ 'classic_address'
default ⇒ MintPress::Aws::EC2::ClassicAddress.new

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 373

property :classic_address, disposition: :association, source: "MintPress::Aws::EC2::Instance", orig_name: 'classic_address', type: [MintPress::Aws::EC2::ClassicAddress], default: MintPress::Aws::EC2::ClassicAddress.new

#image ⇒ [MintPress::Aws::EC2::Image] (Default Value: MintPress::Aws::EC2::Image.new)
'The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.'
Property Attributes

disposition ⇒ :association
source ⇒ "MintPress::Aws::EC2::Instance"
orig_name ⇒ 'image'
read_only ⇒ false
create_instances_prop ⇒ 'image_id'
default ⇒ MintPress::Aws::EC2::Image.new
from ⇒ String



374
375

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 374

property :image, disposition: :association, description: 'The ID of the AMI. An AMI ID is required to launch an instance and
must be specified here or in a launch template.', source: "MintPress::Aws::EC2::Instance", orig_name: 'image', type: [MintPress::Aws::EC2::Image], read_only: false, create_instances_prop: 'image_id', default: MintPress::Aws::EC2::Image.new, from: String

#key_pair ⇒ [MintPress::Aws::EC2::KeyPairInfo] (Default Value: MintPress::Aws::EC2::KeyPairInfo.new)

Property Attributes

disposition ⇒ :association
source ⇒ "MintPress::Aws::EC2::Instance"
orig_name ⇒ 'key_pair'
default ⇒ MintPress::Aws::EC2::KeyPairInfo.new

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 376

property :key_pair, disposition: :association, source: "MintPress::Aws::EC2::Instance", orig_name: 'key_pair', type: [MintPress::Aws::EC2::KeyPairInfo], default: MintPress::Aws::EC2::KeyPairInfo.new

#placement_group ⇒ [MintPress::Aws::EC2::PlacementGroup] (Default Value: MintPress::Aws::EC2::PlacementGroup.new)

Property Attributes

disposition ⇒ :association
source ⇒ "Instance"
orig_name ⇒ 'placement_group'
default ⇒ MintPress::Aws::EC2::PlacementGroup.new

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 377

property :placement_group, disposition: :association, source: "Instance", orig_name: 'placement_group', type: [MintPress::Aws::EC2::PlacementGroup], default: MintPress::Aws::EC2::PlacementGroup.new

#subnet ⇒ [MintPress::Aws::EC2::Subnet] (Default Value: MintPress::Aws::EC2::Subnet.new)
'[EC2-VPC] The ID of the subnet to launch the instance into. If you specify a network interface, you must specify any subnets as part of the network interface.'
Property Attributes

disposition ⇒ :association
source ⇒ "Instance"
orig_name ⇒ 'subnet'
read_only ⇒ false
create_instances_prop ⇒ 'subnet_id'
default ⇒ MintPress::Aws::EC2::Subnet.new
from ⇒ String

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 378

property :subnet, disposition: :association, description: '[EC2-VPC] The ID of the subnet to launch the instance into.

If you specify a network interface, you must specify any subnets as
part of the network interface.', source: "Instance", orig_name: 'subnet', type: [MintPress::Aws::EC2::Subnet], read_only: false, create_instances_prop: 'subnet_id', default: MintPress::Aws::EC2::Subnet.new, from: String

#volumes ⇒ Hash of ⇒ [MintPress::Aws::EC2::Volume]

Property Attributes

disposition ⇒ :association
source ⇒ "Instance"
orig_name ⇒ 'volumes'

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 382

property :volumes, disposition: :association, source: "Instance", orig_name: 'volumes', type: [MintPress::Aws::EC2::Volume], array: false, hash: true

#vpc_addresses ⇒ Array of ⇒ [MintPress::Aws::EC2::VpcAddress]

Property Attributes

disposition ⇒ :association
source ⇒ "Instance"
orig_name ⇒ 'vpc_addresses'

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 384

property :vpc_addresses, disposition: :association, source: "Instance", orig_name: 'vpc_addresses', type: [MintPress::Aws::EC2::VpcAddress], array: true

#ipv_6_address_count ⇒ [Integer]
'[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you"ve specified a minimum number of instances to launch. You cannot specify this option and the network interfaces option in the same request.'
Property Attributes

create_instances_prop ⇒ 'ipv_6_address_count'
read_only ⇒ false
source ⇒ "create_instances"

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 385

property :ipv_6_address_count, create_instances_prop: 'ipv_6_address_count', type: [Integer], read_only: false, source: "create_instances", description: '[EC2-VPC] The number of IPv6 addresses to associate with the primary
network interface. Amazon EC2 chooses the IPv6 addresses from the
range of your subnet. You cannot specify this option and the option to
assign specific IPv6 addresses in the same request. You can specify
this option if you"ve specified a minimum number of instances to
launch.

You cannot specify this option and the network interfaces option in
the same request.'

#ipv_6_addresses ⇒ Array of ⇒ [String]
'[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you"ve specified a minimum number of instances to launch. You cannot specify this option and the network interfaces option in the same request.'
Property Attributes

create_instances_prop ⇒ "ipv_6_addresses.ipv_6_address"
read_only ⇒ false
source ⇒ "create_instances"

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 394

property :ipv_6_addresses, create_instances_prop: "ipv_6_addresses.ipv_6_address", type: [String], array: true, read_only: false, source: "create_instances", description: '[EC2-VPC] The IPv6 addresses from the range of the subnet to
associate with the primary network interface. You cannot specify this
option and the option to assign a number of IPv6 addresses in the same
request. You cannot specify this option if you"ve specified a minimum
number of instances to launch.

You cannot specify this option and the network interfaces option in
the same request.'

#max_count ⇒ [Integer] (Default Value: 1)
'The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount. Constraints: Between 1 and the maximum number you"re allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 FAQ.'
Property Attributes

create_instances_prop ⇒ 'max_count'
read_only ⇒ false
source ⇒ "create_instances"
default ⇒ 1

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 402

property :max_count, create_instances_prop: 'max_count', type: [Integer], read_only: false, source: "create_instances", description: 'The maximum number of instances to launch. If you specify more
instances than Amazon EC2 can launch in the target Availability Zone,
Amazon EC2 launches the largest possible number of instances above
MinCount.

Constraints: Between 1 and the maximum number you"re allowed for the
specified instance type. For more information about the default
limits, and how to request an increase, see How many instances can I
run in Amazon EC2 in the Amazon EC2 FAQ.', default: 1

#min_count ⇒ [Integer] (Default Value: 1)
'The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances. Constraints: Between 1 and the maximum number you"re allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.'
Property Attributes

create_instances_prop ⇒ 'min_count'
read_only ⇒ false
source ⇒ "create_instances"
default ⇒ 1

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 411

property :min_count, create_instances_prop: 'min_count', type: [Integer], read_only: false, source: "create_instances", description: 'The minimum number of instances to launch. If you specify a minimum
that is more instances than Amazon EC2 can launch in the target
Availability Zone, Amazon EC2 launches no instances.

Constraints: Between 1 and the maximum number you"re allowed for the
specified instance type. For more information about the default
limits, and how to request an increase, see How many instances can I
run in Amazon EC2 in the Amazon EC2 General FAQ.', default: 1

#user_data ⇒ [String]
'The user data to make available to the instance. For more information, see Running commands on your Linux instance at launch (Linux) and Adding User Data (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.'
Property Attributes

create_instances_prop ⇒ 'user_data'
read_only ⇒ false
source ⇒ "create_instances"

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 419

property :user_data, create_instances_prop: 'user_data', type: [String], read_only: false, source: "create_instances", description: 'The user data to make available to the instance. For more information,
see Running commands on your Linux instance at launch (Linux) and
Adding User Data (Windows). If you are using a command line tool,
base64-encoding is performed for you, and you can load the text from a
file. Otherwise, you must provide base64-encoded text. User data is
limited to 16 KB.'

#disable_api_termination ⇒ [TrueClass,FalseClass]
'If you set this parameter to true, you can"t terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance. Default: false'
Property Attributes

create_instances_prop ⇒ 'disable_api_termination'
read_only ⇒ false
source ⇒ "create_instances"

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 425

property :disable_api_termination, create_instances_prop: 'disable_api_termination', type: [TrueClass,FalseClass], read_only: false, source: "create_instances", description: 'If you set this parameter to true, you can"t terminate the instance
using the Amazon EC2 console, CLI, or API; otherwise, you can. To
change this attribute after launch, use ModifyInstanceAttribute.
Alternatively, if you set InstanceInitiatedShutdownBehavior to
terminate, you can terminate the instance by running the shutdown
command from the instance.

Default: false'

#instance_initiated_shutdown_behavior ⇒ [String]
'Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). Default: stop'
Property Attributes

create_instances_prop ⇒ 'instance_initiated_shutdown_behavior'
read_only ⇒ false
source ⇒ "create_instances"

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 433

property :instance_initiated_shutdown_behavior, create_instances_prop: 'instance_initiated_shutdown_behavior', type: [String], read_only: false, source: "create_instances", description: 'Indicates whether an instance stops or terminates when you initiate
shutdown from the instance (using the operating system command for
system shutdown).

Default: stop'

#elastic_gpu ⇒ Hash of ⇒ [MintPress::Aws::EC2::ElasticGpu]
'An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs in the Amazon Elastic Compute Cloud User Guide.'
Property Attributes

create_instances_prop ⇒ 'elastic_gpu_specification'
read_only ⇒ false
source ⇒ "create_instances"

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 438

property :elastic_gpu, create_instances_prop: 'elastic_gpu_specification', type: [MintPress::Aws::EC2::ElasticGpu], array: false, read_only: false, source: "create_instances", description: 'An elastic GPU to associate with the instance. An Elastic GPU is a GPU
resource that you can attach to your Windows instance to accelerate
the graphics performance of your applications. For more information,
see  Amazon EC2 Elastic GPUs in the Amazon Elastic Compute Cloud
User Guide.', hash: true

#elastic_inference_accelerators ⇒ Array of ⇒ [MintPress::Aws::EC2::ElasticInferenceAccelerator]
'An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads. You cannot specify accelerators from different generations in the same request.'
Property Attributes

create_instances_prop ⇒ 'elastic_inference_accelerators'
read_only ⇒ false
source ⇒ "create_instances"

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 443

property :elastic_inference_accelerators, create_instances_prop: 'elastic_inference_accelerators', type: [MintPress::Aws::EC2::ElasticInferenceAccelerator], array: true, read_only: false, source: "create_instances", description: 'An elastic inference accelerator to associate with the instance.
Elastic inference accelerators are a resource you can attach to your
Amazon EC2 instances to accelerate your Deep Learning (DL) inference
workloads.

You cannot specify accelerators from different generations in the same
request.'

#launch_template ⇒ [MintPress::Aws::EC2::LaunchTemplate] (Default Value: MintPress::Aws::EC2::LaunchTemplate.new)
'The launch template to use to launch the instances. Any parameters that you specify in RunInstances override the same parameters in the launch template. You can specify either the name or ID of a launch template, but not both.'
Property Attributes

create_instances_prop ⇒ 'launch_template'
default ⇒ MintPress::Aws::EC2::LaunchTemplate.new
read_only ⇒ false
source ⇒ "create_instances"

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 450

property :launch_template, create_instances_prop: 'launch_template', type: [MintPress::Aws::EC2::LaunchTemplate], default: MintPress::Aws::EC2::LaunchTemplate.new, read_only: false, source: "create_instances", description: 'The launch template to use to launch the instances. Any parameters
that you specify in RunInstances override the same parameters in the
launch template. You can specify either the name or ID of a launch
template, but not both.'

#instance_market_options ⇒ [MintPress::Aws::EC2::InstanceMarketOption] (Default Value: MintPress::Aws::EC2::InstanceMarketOption.new)
'The market (purchasing) option for the instances. For RunInstances, persistent Spot Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or stop.'
Property Attributes

create_instances_prop ⇒ 'instance_market_options'
default ⇒ MintPress::Aws::EC2::InstanceMarketOption.new
read_only ⇒ false
source ⇒ "create_instances"

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 454

property :instance_market_options, create_instances_prop: 'instance_market_options', type: [MintPress::Aws::EC2::InstanceMarketOption], default: MintPress::Aws::EC2::InstanceMarketOption.new, read_only: false, source: "create_instances", description: 'The market (purchasing) option for the instances.

For RunInstances, persistent Spot Instance requests are only supported
when InstanceInterruptionBehavior is set to either hibernate or
stop.'

#credit ⇒ [String]
'The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited. To change this attribute after launch, use ModifyInstanceCreditSpecification. For more information, see Burstable performance instances in the Amazon Elastic Compute Cloud User Guide. Default: standard (T2 instances) or unlimited (T3/T3a instances)'
Property Attributes

create_instances_prop ⇒ "credit_specification.cpu_credits"
read_only ⇒ false
source ⇒ "create_instances"

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 459

property :credit, create_instances_prop: "credit_specification.cpu_credits", type: [String], read_only: false, source: "create_instances", description: 'The credit option for CPU usage of the burstable performance instance.
Valid values are standard and unlimited. To change this attribute
after launch, use  ModifyInstanceCreditSpecification. For more
information, see Burstable performance instances in the Amazon
Elastic Compute Cloud User Guide.

Default: standard (T2 instances) or unlimited (T3/T3a instances)'

#kernel ⇒ [String]
'The ID of the kernel. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.'
Property Attributes

source ⇒ "create_instances"
orig_name ⇒ 'kernel_id'
read_only ⇒ false
create_instances_prop ⇒ 'kernel_id'

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 466

property :kernel, description: 'The ID of the kernel.

We recommend that you use PV-GRUB instead of kernels and RAM disks.
For more information, see  PV-GRUB in the Amazon Elastic Compute
Cloud User Guide.', source: "create_instances", orig_name: 'kernel_id', type: [String], read_only: false, create_instances_prop: 'kernel_id'

#ramdisk ⇒ [String]
'The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the AWS Resource Center and search for the kernel ID. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.'
Property Attributes

source ⇒ "create_instances"
orig_name ⇒ 'ramdisk_id'
read_only ⇒ false
create_instances_prop ⇒ 'ramdisk_id'

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 471

property :ramdisk, description: 'The ID of the RAM disk to select. Some kernels require additional
drivers at launch. Check the kernel requirements for information about
whether you need to specify a RAM disk. To find kernel requirements,
go to the AWS Resource Center and search for the kernel ID.

We recommend that you use PV-GRUB instead of kernels and RAM disks.
For more information, see  PV-GRUB in the Amazon Elastic Compute
Cloud User Guide.', source: "create_instances", orig_name: 'ramdisk_id', type: [String], read_only: false, create_instances_prop: 'ramdisk_id'

#name ⇒ String

Property Attributes

480	# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 480 property :name, type: String

#region ⇒ String
Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
Property Attributes
484
# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 484 property :region, type: String

#name ⇒ String
The name of this resource
Property Attributes

37	# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 37 property :name, type: String

#hostname ⇒ String (Default Value: Proc.new { r = self.name.split('.')[0] ; r = nil if r == ''; r })
The hostname of the box _without_ the DNS domain name - note that individual network interfaces can have different hostnames!
Property Attributes

default ⇒ Proc.new { r = self.name.split('.')[0] ; r = nil if r == ''; r }

40	# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 40 property :hostname, type: String, default: Proc.new { r = self.name.split('.')[0] ; r = nil if r == ''; r }

#dns_domain ⇒ String (Default Value: Proc.new { r = self.name.split('.')[1..-1].join('.') ; r = nil if r == '.' ; r })
Just the DNS domain name of the box - again, individual network interfaces _can_ override this!
Property Attributes

default ⇒ Proc.new { r = self.name.split('.')[1..-1].join('.') ; r = nil if r == '.' ; r }

# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 42

property :dns_domain, type: String, default: Proc.new { r = self.name.split('.')[1..-1].join('.') ; r = nil if r == '.' ; r }

#max_connections ⇒ Integer
How many connections, at most, do we allow to this host?
Property Attributes

49	# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 49 property :max_connections, type: Integer

#max_connections_per_second ⇒ Float
How many connections per second, at most, do we allow to this host? This internally defaults to 1.0
Property Attributes
52
# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 52 property :max_connections_per_second, type: Float

#affinity_group ⇒ String (Default Value: Proc.new{self.hostname.gsub(/[0-9]/,'').split('.')[0].split('-')[0]})
Create, by default, an affinity group with no number - note that some infra types don't support named affinity groups, and so this won't work in those cases, and it will always use the node ID in that case
Property Attributes

default ⇒ Proc.new{self.hostname.gsub(/[0-9]/,'').split('.')[0].split('-')[0]}

# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 56

property :affinity_group, type: String, default: Proc.new{self.hostname.gsub(/[0-9]/,'').split('.')[0].split('-')[0]}

#strict_anti_affinity ⇒ [TrueClass, FalseClass] (Default Value: false)
Do we strictly enforce anti-affinity, or is it just advisory. Note that if you don't have enough nodes or availability zones to seperate all of your resources, setting this to true _will_ result in failures!
Property Attributes

default ⇒ false

60	# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 60 property :strict_anti_affinity, type: [TrueClass, FalseClass], default: false

#host_number ⇒ Integer (Default Value: Proc.new { self.hostname.split('.')[0].split('-')[0].tr("^0-9",'').to_i })
The numeric ID of this host within an affinity group - this is derived, by default, from the host number. Implementations that have "full" access to the system should convert this back to their own set, so things can be enforced...
Property Attributes

default ⇒ Proc.new { self.hostname.split('.')[0].split('-')[0].tr("^0-9",'').to_i }

# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 63

property :host_number, type: Integer, default: Proc.new { self.hostname.split('.')[0].split('-')[0].tr("^0-9",'').to_i }

#connect_address ⇒ String (Default Value: Proc.new { self.fqdn })
This one should be overridden by children - usually we'll get a useful IP from our provider. Failing that, potentially it should come from network_interfaces if they exist! This might be replaced by an action function at some point, though it'll always be through a prop so that it's overridable
Property Attributes

default ⇒ Proc.new { self.fqdn }

68	# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 68 property :connect_address, type: String, default: Proc.new { self.fqdn }

#mounts ⇒ Hash of ⇒ MintPress::Infrastructure::MountPoint
Shares such as NasShare/CifsShare are children of this, so we don't have to repeat ourselves!
Property Attributes

71	# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 71 property :mounts, type: MintPress::Infrastructure::MountPoint, hash: true

#network_interfaces ⇒ Hash of ⇒ MintPress::Infrastructure::NetworkInterface
Network interfaces to be attached to this host
Property Attributes

74	# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 74 property :network_interfaces, type: MintPress::Infrastructure::NetworkInterface, hash: true

#interfaces ⇒ Hash of ⇒ MintPress::Infrastructure::HostInterface
"The list of interfaces on the host."
Property Attributes

# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 77

property :interfaces, type: MintPress::Infrastructure::HostInterface, hash: true, description: "The list of interfaces on the host."

#block_devices ⇒ Hash of ⇒ MintPress::Infrastructure::BlockDevice
Which block devcies should be attached to this virtual machine. Block devices are generally either attached disks, FC luns, or iscsi
Property Attributes

canonical ⇒ true

80	# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 80 property :block_devices, type: MintPress::Infrastructure::BlockDevice, hash: true, canonical: true

#nas_shares ⇒ Hash of ⇒ MintPress::Infrastructure::NasShare
Which NAS shares should be attached to this system? NAS shares can be either NFS or CIFS shares
Property Attributes

canonical ⇒ true

82	# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 82 property :nas_shares, type: MintPress::Infrastructure::NasShare, hash: true, canonical: true

#admin_connect_user ⇒ String
Which user should be used to connect as an administrive user. Different providers will default this differnetly - for example, ec2-user for AWS.
Property Attributes
85
# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 85 property :admin_connect_user, type: String

#admin_final_user ⇒ String
The final user for admin will almost always be root, but you _could_ change it for a particularly weird environment
Property Attributes
87
# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 87 property :admin_final_user, type: String

#admin_keys ⇒ Array of ⇒ String (Default Value: Proc.new { self.keys })
SSH keys for connecting as an administrative user (these have an in-code default of [ "~/.ssh/id_rsa","~/.ssh/id_dsa" ])
Property Attributes

default ⇒ Proc.new { self.keys }

90	# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 90 property :admin_keys, type: String, array: true, default: Proc.new { self.keys }

#admin_password ⇒ String
Password for connecting as an administrtive user
Property Attributes

92	# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 92 property :admin_password, type: String

#admin_key_data ⇒ String (Default Value: Proc.new { self.key_data })
SSH key data (ie the actual contents of the key file) as an administrative user
Property Attributes

default ⇒ Proc.new { self.key_data }

94	# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 94 property :admin_key_data, type: String, default: Proc.new { self.key_data }

#environment_variables ⇒ Hash of ⇒ String
Environment variables to set on the unprivleged transport
Property Attributes

97	# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 97 property :environment_variables, type: String, hash: true

#admin_environment_variables ⇒ Hash of ⇒ String
Environment variables to set on the privleged transport
Property Attributes

100	# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 100 property :admin_environment_variables, type: String, hash: true

#never_transform ⇒ [TrueClass, FalseClass] (Default Value: false)
Disable using the connection proxy server? This can be required on certain systems that don't support our ruby, such as EL5 systems, but generally should be avoided
Property Attributes

default ⇒ false

104	# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 104 property :never_transform, type: [TrueClass, FalseClass], default: false

#os_family ⇒ String (Default Value: Proc.new { self.detect_os_family })
Some details about the OS
Property Attributes

default ⇒ Proc.new { self.detect_os_family }

107	# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 107 property :os_family, type: String, default: Proc.new { self.detect_os_family }

#os_release ⇒ Hash (Default Value: Proc.new { self.detect_os_release })
Some details about the OS Release
Property Attributes

default ⇒ Proc.new { self.detect_os_release }

110	# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 110 property :os_release, type: Hash, default: Proc.new { self.detect_os_release }

#os_arch ⇒ String (Default Value: Proc.new { self.detect_os_arch })
Some details about the OS Architecture
Property Attributes

default ⇒ Proc.new { self.detect_os_arch }

113	# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 113 property :os_arch, type: String, default: Proc.new { self.detect_os_arch }

#os_cpu_count ⇒ Integer (Default Value: Proc.new { self.detect_os_cpu_count })
Some details about the OS CPU Count
Property Attributes

default ⇒ Proc.new { self.detect_os_cpu_count }

116	# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 116 property :os_cpu_count, type: Integer, default: Proc.new { self.detect_os_cpu_count }

#os_memory_total ⇒ Integer (Default Value: Proc.new { self.detect_os_memory_total })
Some details about the OS Memory Total
Property Attributes

default ⇒ Proc.new { self.detect_os_memory_total }

119	# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 119 property :os_memory_total, type: Integer, default: Proc.new { self.detect_os_memory_total }

#os_swap_total ⇒ Integer (Default Value: Proc.new { self.detect_os_swap_total })
Some details about the OS Swap Total
Property Attributes

default ⇒ Proc.new { self.detect_os_swap_total }

122	# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 122 property :os_swap_total, type: Integer, default: Proc.new { self.detect_os_swap_total }

#connect_user ⇒ String
Which user should be used to connect as an ordinary user. Different providers will default this differnetly - for example, ec2-user for AWS.
Property Attributes
125
# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 125 property :connect_user, type: String

#final_user ⇒ String
Which user should we finally end up as, either by being the same as connect_user, or via sudo/su. It is possible to leave both this and connect user black, in which case you will have a host which is not contactable via SSH, but can still be contacted via an external means (docker transport, for example, does not require a user)
Property Attributes
129
# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 129 property :final_user, type: String

#keys ⇒ Array of ⇒ String
SSH keys to connect (these have an in-code default of [ "~/.ssh/id_rsa","~/.ssh/id_dsa" ])
Property Attributes

131	# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 131 property :keys, type: String, array: true

#password ⇒ String
Password to use to authenticate the user
Property Attributes

133	# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 133 property :password, type: String

#key_data ⇒ String
SSH key data (ie the actual contents of the key file)
Property Attributes

135	# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 135 property :key_data, type: String

#protocol ⇒ String (Default Value: Proc.new { r=nil if self.name.to_s == 'local' r='local' else r='ssh' end r })
These would generally be overriden by children as well - sensible options are 'ssh','winrm','httprpc','docker', and 'local'.
Property Attributes

default ⇒ Proc.new { r=nil if self.name.to_s == 'local' r='local' else r='ssh' end r }

# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 139

property :protocol, type: String, default: Proc.new { r=nil 
if self.name.to_s == 'local' 
  r='local' 
else 
  r='ssh'
end
r }

#user_switch_type ⇒ String
Which user switch type should be used - the options for this depend on your protocol, however usually "sudo", "su", and "direct" are the sensible options. Generally this will default to something sane.
Property Attributes
148
# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 148 property :user_switch_type, type: String

#connect_port ⇒ Integer
The port on which to connect - default is 22 for ssh, and 443 for HTTP/RPC, and nil for local
Property Attributes
150
# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 150 property :connect_port, type: Integer

#jump_host ⇒ MintPress::Infrastructure::Host
What jump box is required to access this? This will be used via add_hop in las-rpc-utils
Property Attributes

153	# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 153 property :jump_host, type: MintPress::Infrastructure::Host

#temp_folder ⇒ String (Default Value: Proc.new { self.guess_tmp_folder })
a temporary folder on the remote system. If this is nil, it'll try and work one out
Property Attributes

default ⇒ Proc.new { self.guess_tmp_folder }
cached_proc ⇒ true

156	# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 156 property :temp_folder, type: String, default: Proc.new { self.guess_tmp_folder }, cached_proc: true

#factory ⇒ MintPress::Infrastructure::TransportFactory (Default Value: Proc.new { $mintpress_transport_factory = MintPress::Infrastructure::TransportFactory.new if $mintpress_transport_factory.nil? $mintpress_transport_factory })
Use a non-default transport factory (See the TransportFactory resource for details)
Property Attributes

default ⇒ Proc.new { $mintpress_transport_factory = MintPress::Infrastructure::TransportFactory.new if $mintpress_transport_factory.nil? $mintpress_transport_factory }

# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 159

property :factory, type: MintPress::Infrastructure::TransportFactory, default: Proc.new {
  $mintpress_transport_factory = MintPress::Infrastructure::TransportFactory.new if $mintpress_transport_factory.nil?
  $mintpress_transport_factory
}

#bootstrapper ⇒ Array of ⇒ MintPress::Infrastructure::Bootstrapper (Default Value: MintPress::Infrastructure::Bootstrapper.new(host: self))
Which bootstrap provider to use for creating new hosts
Property Attributes

default ⇒ MintPress::Infrastructure::Bootstrapper.new(host: self)
canonical ⇒ true

# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 165

property :bootstrapper, type: MintPress::Infrastructure::Bootstrapper, default: MintPress::Infrastructure::Bootstrapper.new(host: self), canonical: true, array: true

#always_use_mintpress_bootstrap ⇒ [TrueClass, FalseClass] (Default Value: true)
Should we always use the mintpress internal bootstrap provider, even when anotehr is seperately specified? This defaults to 'true', since usually you need things like disks formatted and so forth before calling out to a chef, puppet, ansible, or salt - but if your provider does handle everything you need, you are free to disable this.
Property Attributes

default ⇒ true

169	# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 169 property :always_use_mintpress_bootstrap, type: [TrueClass, FalseClass], default: true

#bootstrap_with_dns ⇒ [TrueClass, FalseClass] (Default Value: false)
Should we create DNS entries?
Property Attributes

default ⇒ false

171	# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 171 property :bootstrap_with_dns, type: [TrueClass, FalseClass], default: false

#bootstrap_dns_provider ⇒ String
Which DNS provider should we use for creating DNS entries?
Property Attributes

173	# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 173 property :bootstrap_dns_provider, type: String

#public_postfix ⇒ String
Public postfix if no network interfaces are defined.
Property Attributes

183	# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 183 property :public_postfix, type: String

#private_postfix ⇒ String
Private postfix if no network interfaces are defined.
Property Attributes

185	# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 185 property :private_postfix, type: String

Properties (Read Only)

#ami_launch_index ⇒ [Integer]
'The AMI launch index, which can be used to find this instance in the launch group.'
Property Attributes

disposition ⇒ :read_only_attribute
source ⇒ "MintPress::Aws::EC2::Instance"
orig_name ⇒ 'ami_launch_index'
read_only ⇒ true

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 69

property :ami_launch_index, disposition: :read_only_attribute, description: 'The AMI launch index, which can be used to find this instance in the launch group.', source: "MintPress::Aws::EC2::Instance", orig_name: 'ami_launch_index', type: [Integer], read_only: true

#architecture ⇒ [String]
'The architecture of the image.'
Property Attributes

disposition ⇒ :read_only_attribute
source ⇒ "MintPress::Aws::EC2::Instance"
orig_name ⇒ 'architecture'
read_only ⇒ true

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 70

property :architecture, disposition: :read_only_attribute, description: 'The architecture of the image.', source: "MintPress::Aws::EC2::Instance", orig_name: 'architecture', type: [String], read_only: true

#elastic_gpu_associations ⇒ Hash of ⇒ [MintPress::Aws::EC2::ElasticGpuAssociation]
'The Elastic GPU associated with the instance.'
Property Attributes

disposition ⇒ :read_only_attribute
source ⇒ "MintPress::Aws::EC2::Instance"
orig_name ⇒ 'elastic_gpu_associations'
read_only ⇒ true

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 96

property :elastic_gpu_associations, disposition: :read_only_attribute, description: 'The Elastic GPU associated with the instance.', source: "MintPress::Aws::EC2::Instance", orig_name: 'elastic_gpu_associations', type: [MintPress::Aws::EC2::ElasticGpuAssociation], array: false, read_only: true, hash: true

#elastic_inference_accelerator_associations ⇒ Hash of ⇒ [MintPress::Aws::EC2::ElasticInferenceAcceleratorAssociation]
'The elastic inference accelerator associated with the instance.'
Property Attributes

disposition ⇒ :read_only_attribute
source ⇒ "MintPress::Aws::EC2::Instance"
orig_name ⇒ 'elastic_inference_accelerator_associations'
read_only ⇒ true

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 97

property :elastic_inference_accelerator_associations, disposition: :read_only_attribute, description: 'The elastic inference accelerator associated with the instance.', source: "MintPress::Aws::EC2::Instance", orig_name: 'elastic_inference_accelerator_associations', type: [MintPress::Aws::EC2::ElasticInferenceAcceleratorAssociation], array: false, read_only: true, hash: true

#ena_support ⇒ [TrueClass,FalseClass]
'Specifies whether enhanced networking with ENA is enabled.'
Property Attributes

disposition ⇒ :read_only_attribute
source ⇒ "MintPress::Aws::EC2::Instance"
orig_name ⇒ 'ena_support'
read_only ⇒ true

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 98

property :ena_support, disposition: :read_only_attribute, description: 'Specifies whether enhanced networking with ENA is enabled.', source: "MintPress::Aws::EC2::Instance", orig_name: 'ena_support', type: [TrueClass,FalseClass], read_only: true

#hypervisor ⇒ [String]
'The hypervisor type of the instance.'
Property Attributes

disposition ⇒ :read_only_attribute
source ⇒ "MintPress::Aws::EC2::Instance"
orig_name ⇒ 'hypervisor'
read_only ⇒ true

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 111

property :hypervisor, disposition: :read_only_attribute, description: 'The hypervisor type of the instance.', source: "MintPress::Aws::EC2::Instance", orig_name: 'hypervisor', type: [String], read_only: true

#instance_lifecycle ⇒ [String]
'Indicates whether this is a Spot Instance or a Scheduled Instance.'
Property Attributes

disposition ⇒ :read_only_attribute
source ⇒ "MintPress::Aws::EC2::Instance"
orig_name ⇒ 'instance_lifecycle'
read_only ⇒ true

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 113

property :instance_lifecycle, disposition: :read_only_attribute, description: 'Indicates whether this is a Spot Instance or a Scheduled Instance.', source: "MintPress::Aws::EC2::Instance", orig_name: 'instance_lifecycle', type: [String], read_only: true

#launch_time ⇒ [Time]
'The time the instance was launched.'
Property Attributes

disposition ⇒ :read_only_attribute
source ⇒ "MintPress::Aws::EC2::Instance"
orig_name ⇒ 'launch_time'
read_only ⇒ true

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 124

property :launch_time, disposition: :read_only_attribute, description: 'The time the instance was launched.', source: "MintPress::Aws::EC2::Instance", orig_name: 'launch_time', type: [Time], read_only: true

#outpost_arn ⇒ [String]
'The Amazon Resource Name (ARN) of the Outpost.'
Property Attributes

disposition ⇒ :read_only_attribute
source ⇒ "MintPress::Aws::EC2::Instance"
orig_name ⇒ 'outpost_arn'
read_only ⇒ true

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 132

property :outpost_arn, disposition: :read_only_attribute, description: 'The Amazon Resource Name (ARN) of the Outpost.', source: "MintPress::Aws::EC2::Instance", orig_name: 'outpost_arn', type: [String], read_only: true

#platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
Property Attributes

disposition ⇒ :read_only_attribute
source ⇒ "MintPress::Aws::EC2::Instance"
orig_name ⇒ 'platform'
read_only ⇒ true
default ⇒ MintPress::InfrastructureAws::AwsPlatform.new

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 487

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

#private_dns_name ⇒ [String]
'(IPv4 only) The private DNS hostname name assigned to the instance.'
Property Attributes

disposition ⇒ :read_only_attribute
source ⇒ "MintPress::Aws::EC2::Instance"
orig_name ⇒ 'private_dns_name'
read_only ⇒ true

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 135

property :private_dns_name, disposition: :read_only_attribute, description: '(IPv4 only) The private DNS hostname name assigned to the instance.', source: "MintPress::Aws::EC2::Instance", orig_name: 'private_dns_name', type: [String], read_only: true

#product_codes ⇒ Hash of ⇒ [MintPress::Aws::EC2::ProductCode]
'The product codes attached to this instance, if applicable.'
Property Attributes

disposition ⇒ :read_only_attribute
source ⇒ "MintPress::Aws::EC2::Instance"
orig_name ⇒ 'product_codes'
read_only ⇒ true

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 147

property :product_codes, disposition: :read_only_attribute, description: 'The product codes attached to this instance, if applicable.', source: "MintPress::Aws::EC2::Instance", orig_name: 'product_codes', type: [MintPress::Aws::EC2::ProductCode], array: false, read_only: true, hash: true

#public_dns_name ⇒ [String]
'(IPv4 only) The public DNS name assigned to the instance.'
Property Attributes

disposition ⇒ :read_only_attribute
source ⇒ "MintPress::Aws::EC2::Instance"
orig_name ⇒ 'public_dns_name'
read_only ⇒ true

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 148

property :public_dns_name, disposition: :read_only_attribute, description: '(IPv4 only) The public DNS name assigned to the instance.', source: "MintPress::Aws::EC2::Instance", orig_name: 'public_dns_name', type: [String], read_only: true

#public_ip_address ⇒ [String]
'The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.'
Property Attributes

disposition ⇒ :read_only_attribute
source ⇒ "MintPress::Aws::EC2::Instance"
orig_name ⇒ 'public_ip_address'
read_only ⇒ true

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 149

property :public_ip_address, disposition: :read_only_attribute, description: 'The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.', source: "MintPress::Aws::EC2::Instance", orig_name: 'public_ip_address', type: [String], read_only: true

#root_device_name ⇒ [String]
'The device name of the root device volume (for example, /dev/sda1).'
Property Attributes

disposition ⇒ :read_only_attribute
source ⇒ "MintPress::Aws::EC2::Instance"
orig_name ⇒ 'root_device_name'
read_only ⇒ true

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 150

property :root_device_name, disposition: :read_only_attribute, description: 'The device name of the root device volume (for example, /dev/sda1).', source: "MintPress::Aws::EC2::Instance", orig_name: 'root_device_name', type: [String], read_only: true

#root_device_type ⇒ [String]
'The root device type used by the AMI.'
Property Attributes

disposition ⇒ :read_only_attribute
source ⇒ "MintPress::Aws::EC2::Instance"
orig_name ⇒ 'root_device_type'
read_only ⇒ true

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 151

property :root_device_type, disposition: :read_only_attribute, description: 'The root device type used by the AMI.', source: "MintPress::Aws::EC2::Instance", orig_name: 'root_device_type', type: [String], read_only: true

#security_groups ⇒ Hash of ⇒ [MintPress::Aws::EC2::GroupIdentifier]
'The security groups for the instance.'
Property Attributes

create_instances_prop ⇒ 'security_group_ids'
disposition ⇒ :read_only_attribute
read_only ⇒ true
source ⇒ "MintPress::Aws::EC2::Instance"
orig_name ⇒ 'security_groups'
from ⇒ String

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 152

property :security_groups, create_instances_prop: 'security_group_ids', type: [MintPress::Aws::EC2::GroupIdentifier], array: false, disposition: :read_only_attribute, read_only: true, source: "MintPress::Aws::EC2::Instance", description: 'The security groups for the instance.', orig_name: 'security_groups', from: String, hash: true

#source_dest_check ⇒ [TrueClass,FalseClass]
'Specifies whether to enable an instance launched in a VPC to perform NAT.'
Property Attributes

disposition ⇒ :read_only_attribute
source ⇒ "MintPress::Aws::EC2::Instance"
orig_name ⇒ 'source_dest_check'
read_only ⇒ true

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 153

property :source_dest_check, disposition: :read_only_attribute, description: 'Specifies whether to enable an instance launched in a VPC to perform NAT.', source: "MintPress::Aws::EC2::Instance", orig_name: 'source_dest_check', type: [TrueClass,FalseClass], read_only: true

#sriov_net_support ⇒ [String]
'Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.'
Property Attributes

disposition ⇒ :read_only_attribute
source ⇒ "MintPress::Aws::EC2::Instance"
orig_name ⇒ 'sriov_net_support'
read_only ⇒ true

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 154

property :sriov_net_support, disposition: :read_only_attribute, description: 'Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.', source: "MintPress::Aws::EC2::Instance", orig_name: 'sriov_net_support', type: [String], read_only: true

#state ⇒ [MintPress::Aws::EC2::InstanceState] (Default Value: MintPress::Aws::EC2::InstanceState.new)
'The current state of the instance.'
Property Attributes

disposition ⇒ :read_only_attribute
source ⇒ "MintPress::Aws::EC2::Instance"
orig_name ⇒ 'state'
default ⇒ MintPress::Aws::EC2::InstanceState.new
read_only ⇒ true

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 155

property :state, disposition: :read_only_attribute, description: 'The current state of the instance.', source: "MintPress::Aws::EC2::Instance", orig_name: 'state', type: [MintPress::Aws::EC2::InstanceState], default: MintPress::Aws::EC2::InstanceState.new, read_only: true

#state_reason ⇒ [MintPress::Aws::EC2::StateReason] (Default Value: MintPress::Aws::EC2::StateReason.new)
'The reason for the most recent state transition.'
Property Attributes

disposition ⇒ :read_only_attribute
source ⇒ "MintPress::Aws::EC2::Instance"
orig_name ⇒ 'state_reason'
default ⇒ MintPress::Aws::EC2::StateReason.new
read_only ⇒ true

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 156

property :state_reason, disposition: :read_only_attribute, description: 'The reason for the most recent state transition.', source: "MintPress::Aws::EC2::Instance", orig_name: 'state_reason', type: [MintPress::Aws::EC2::StateReason], default: MintPress::Aws::EC2::StateReason.new, read_only: true

#state_transition_reason ⇒ [String]
'The reason for the most recent state transition.'
Property Attributes

disposition ⇒ :read_only_attribute
source ⇒ "MintPress::Aws::EC2::Instance"
orig_name ⇒ 'state_transition_reason'
read_only ⇒ true

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 157

property :state_transition_reason, disposition: :read_only_attribute, description: 'The reason for the most recent state transition.', source: "MintPress::Aws::EC2::Instance", orig_name: 'state_transition_reason', type: [String], read_only: true

#virtualization_type ⇒ [String]
'The virtualization type of the instance.'
Property Attributes

disposition ⇒ :read_only_attribute
source ⇒ "MintPress::Aws::EC2::Instance"
orig_name ⇒ 'virtualization_type'
read_only ⇒ true

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 162

property :virtualization_type, disposition: :read_only_attribute, description: 'The virtualization type of the instance.', source: "MintPress::Aws::EC2::Instance", orig_name: 'virtualization_type', type: [String], read_only: true

#vpc ⇒ [MintPress::Aws::EC2::Vpc] (Default Value: MintPress::Aws::EC2::Vpc.new)
'[EC2-VPC] The ID of the VPC in which the instance is running.'
Property Attributes

disposition ⇒ :association
source ⇒ "Instance"
orig_name ⇒ 'vpc'
read_only ⇒ true
default ⇒ MintPress::Aws::EC2::Vpc.new
from ⇒ String

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 383

property :vpc, disposition: :association, description: '[EC2-VPC] The ID of the VPC in which the instance is running.', source: "Instance", orig_name: 'vpc', type: [MintPress::Aws::EC2::Vpc], read_only: true, default: MintPress::Aws::EC2::Vpc.new, from: String

#spot_instance_request ⇒ [String]
'If the request is a Spot Instance request, the ID of the request.'
Property Attributes

disposition ⇒ :read_only_attribute
source ⇒ "MintPress::Aws::EC2::Instance"
orig_name ⇒ 'spot_instance_request_id'
read_only ⇒ true

# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/instance.rb', line 479

property :spot_instance_request, disposition: :read_only_attribute, description: 'If the request is a Spot Instance request, the ID of the request.', source: "MintPress::Aws::EC2::Instance", orig_name: 'spot_instance_request_id', type: [String], read_only: true

#fqdn ⇒ String (Default Value: Proc.new { r = [self.hostname, self.dns_domain].join('.').gsub(/\.$/,'') ; r = nil if r=='.' or r=='' ; r })
The FQDN of the box. This is set to read_only since it should be formed by hostname/dns_domain, which also defaults from a FQDN name variable.
Property Attributes

default ⇒ Proc.new { r = [self.hostname, self.dns_domain].join('.').gsub(/\.$/,'') ; r = nil if r=='.' or r=='' ; r }
read_only ⇒ true

# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 46

property :fqdn, type: String, default: Proc.new { r = [self.hostname, self.dns_domain].join('.').gsub(/\.$/,'') ; r = nil if r=='.' or r=='' ; r }, read_only: true

#implemented_providers ⇒ Array of ⇒ String
'List of infrastructure providers that this class can work with'
Property Attributes

read_only ⇒ true

# File 'src/mintpress-infrastructure/lib/mintpress-infrastructure/host.rb', line 176

property :implemented_providers, type: String, array: true, read_only: true, description: 'List of infrastructure providers that this class can work with'

Constructor Details

#initialize(opts = {}) ⇒ `Instance`

Returns a new instance of Instance.

Properties (Read/Write)

Properties (Read Only)

Constant Summary

Constants included from MintLogger

Instance Attribute Summary

Attributes included from Mixins::Properties

Instance Method Summary collapse

Methods included from AwsCommon

Methods included from Mixins::Properties

Methods included from MintLogger::Utils::Common

Methods inherited from Infrastructure::Host

Methods included from Mixins::GenericProvider

Methods included from Mixins::Backgroundable

Constructor Details

#initialize(opts = {}) ⇒ `Instance`

Instance Method Details

#create ⇒ `Object`

#delete_cascade ⇒ `Object`

#describe ⇒ `Object`

#monitor ⇒ `Object`

#start ⇒ `Object`

#stop ⇒ `Object`

#terminate ⇒ `Object`

#unmonitor ⇒ `Object`

Class: MintPress::Aws::EC2::Instance

Properties (Read/Write)

Properties (Read Only)

Constant Summary

Constants included from MintLogger

Instance Attribute Summary

Attributes included from Mixins::Properties

Instance Method Summary collapse

Methods included from AwsCommon

Methods included from Mixins::Properties

Methods included from MintLogger::Utils::Common

Methods inherited from Infrastructure::Host

Methods included from Mixins::GenericProvider

Methods included from Mixins::Backgroundable

Constructor Details

#initialize(opts = {}) ⇒ Instance

Instance Method Details

#create ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object

#monitor ⇒ Object

#start ⇒ Object

#stop ⇒ Object

#terminate ⇒ Object

#unmonitor ⇒ Object

#initialize(opts = {}) ⇒ `Instance`

#create ⇒ `Object`

#delete_cascade ⇒ `Object`

#describe ⇒ `Object`

#monitor ⇒ `Object`

#start ⇒ `Object`

#stop ⇒ `Object`

#terminate ⇒ `Object`

#unmonitor ⇒ `Object`