You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::OpsWorks::Types::CreateInstanceRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb

Overview

Note:

When making an API call, you may pass CreateInstanceRequest data as a hash:

{
  stack_id: "String", # required
  layer_ids: ["String"], # required
  instance_type: "String", # required
  auto_scaling_type: "load", # accepts load, timer
  hostname: "String",
  os: "String",
  ami_id: "String",
  ssh_key_name: "String",
  availability_zone: "String",
  virtualization_type: "String",
  subnet_id: "String",
  architecture: "x86_64", # accepts x86_64, i386
  root_device_type: "ebs", # accepts ebs, instance-store
  block_device_mappings: [
    {
      device_name: "String",
      no_device: "String",
      virtual_name: "String",
      ebs: {
        snapshot_id: "String",
        iops: 1,
        volume_size: 1,
        volume_type: "gp2", # accepts gp2, io1, standard
        delete_on_termination: false,
      },
    },
  ],
  install_updates_on_boot: false,
  ebs_optimized: false,
  agent_version: "String",
  tenancy: "String",
}

Instance Attribute Summary collapse

Instance Attribute Details

#agent_versionString

The default AWS OpsWorks Stacks agent version. You have the following options:

  • INHERIT - Use the stack's default agent version setting.

  • version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance.

The default setting is INHERIT. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

Returns:

  • (String)


1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 1523

class CreateInstanceRequest < Struct.new(
  :stack_id,
  :layer_ids,
  :instance_type,
  :auto_scaling_type,
  :hostname,
  :os,
  :ami_id,
  :ssh_key_name,
  :availability_zone,
  :virtualization_type,
  :subnet_id,
  :architecture,
  :root_device_type,
  :block_device_mappings,
  :install_updates_on_boot,
  :ebs_optimized,
  :agent_version,
  :tenancy)
  include Aws::Structure
end

#ami_idString

A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see Using Custom AMIs.

If you specify a custom AMI, you must set Os to Custom.

Returns:

  • (String)


1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 1523

class CreateInstanceRequest < Struct.new(
  :stack_id,
  :layer_ids,
  :instance_type,
  :auto_scaling_type,
  :hostname,
  :os,
  :ami_id,
  :ssh_key_name,
  :availability_zone,
  :virtualization_type,
  :subnet_id,
  :architecture,
  :root_device_type,
  :block_device_mappings,
  :install_updates_on_boot,
  :ebs_optimized,
  :agent_version,
  :tenancy)
  include Aws::Structure
end

#architectureString

The instance architecture. The default option is x86_64. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

Returns:

  • (String)


1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 1523

class CreateInstanceRequest < Struct.new(
  :stack_id,
  :layer_ids,
  :instance_type,
  :auto_scaling_type,
  :hostname,
  :os,
  :ami_id,
  :ssh_key_name,
  :availability_zone,
  :virtualization_type,
  :subnet_id,
  :architecture,
  :root_device_type,
  :block_device_mappings,
  :install_updates_on_boot,
  :ebs_optimized,
  :agent_version,
  :tenancy)
  include Aws::Structure
end

#auto_scaling_typeString

For load-based or time-based instances, the type. Windows stacks can use only time-based instances.

Returns:

  • (String)


1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 1523

class CreateInstanceRequest < Struct.new(
  :stack_id,
  :layer_ids,
  :instance_type,
  :auto_scaling_type,
  :hostname,
  :os,
  :ami_id,
  :ssh_key_name,
  :availability_zone,
  :virtualization_type,
  :subnet_id,
  :architecture,
  :root_device_type,
  :block_device_mappings,
  :install_updates_on_boot,
  :ebs_optimized,
  :agent_version,
  :tenancy)
  include Aws::Structure
end

#availability_zoneString

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

Returns:

  • (String)


1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 1523

class CreateInstanceRequest < Struct.new(
  :stack_id,
  :layer_ids,
  :instance_type,
  :auto_scaling_type,
  :hostname,
  :os,
  :ami_id,
  :ssh_key_name,
  :availability_zone,
  :virtualization_type,
  :subnet_id,
  :architecture,
  :root_device_type,
  :block_device_mappings,
  :install_updates_on_boot,
  :ebs_optimized,
  :agent_version,
  :tenancy)
  include Aws::Structure
end

#block_device_mappingsArray<Types::BlockDeviceMapping>

An array of BlockDeviceMapping objects that specify the instance's block devices. For more information, see Block Device Mapping. Note that block device mappings are not supported for custom AMIs.

Returns:



1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 1523

class CreateInstanceRequest < Struct.new(
  :stack_id,
  :layer_ids,
  :instance_type,
  :auto_scaling_type,
  :hostname,
  :os,
  :ami_id,
  :ssh_key_name,
  :availability_zone,
  :virtualization_type,
  :subnet_id,
  :architecture,
  :root_device_type,
  :block_device_mappings,
  :install_updates_on_boot,
  :ebs_optimized,
  :agent_version,
  :tenancy)
  include Aws::Structure
end

#ebs_optimizedBoolean

Whether to create an Amazon EBS-optimized instance.

Returns:

  • (Boolean)


1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 1523

class CreateInstanceRequest < Struct.new(
  :stack_id,
  :layer_ids,
  :instance_type,
  :auto_scaling_type,
  :hostname,
  :os,
  :ami_id,
  :ssh_key_name,
  :availability_zone,
  :virtualization_type,
  :subnet_id,
  :architecture,
  :root_device_type,
  :block_device_mappings,
  :install_updates_on_boot,
  :ebs_optimized,
  :agent_version,
  :tenancy)
  include Aws::Structure
end

#hostnameString

The instance host name.

Returns:

  • (String)


1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 1523

class CreateInstanceRequest < Struct.new(
  :stack_id,
  :layer_ids,
  :instance_type,
  :auto_scaling_type,
  :hostname,
  :os,
  :ami_id,
  :ssh_key_name,
  :availability_zone,
  :virtualization_type,
  :subnet_id,
  :architecture,
  :root_device_type,
  :block_device_mappings,
  :install_updates_on_boot,
  :ebs_optimized,
  :agent_version,
  :tenancy)
  include Aws::Structure
end

#install_updates_on_bootBoolean

Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

We strongly recommend using the default value of true to ensure that your instances have the latest security updates.

Returns:

  • (Boolean)


1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 1523

class CreateInstanceRequest < Struct.new(
  :stack_id,
  :layer_ids,
  :instance_type,
  :auto_scaling_type,
  :hostname,
  :os,
  :ami_id,
  :ssh_key_name,
  :availability_zone,
  :virtualization_type,
  :subnet_id,
  :architecture,
  :root_device_type,
  :block_device_mappings,
  :install_updates_on_boot,
  :ebs_optimized,
  :agent_version,
  :tenancy)
  include Aws::Structure
end

#instance_typeString

The instance type, such as t2.micro. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

Returns:

  • (String)


1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 1523

class CreateInstanceRequest < Struct.new(
  :stack_id,
  :layer_ids,
  :instance_type,
  :auto_scaling_type,
  :hostname,
  :os,
  :ami_id,
  :ssh_key_name,
  :availability_zone,
  :virtualization_type,
  :subnet_id,
  :architecture,
  :root_device_type,
  :block_device_mappings,
  :install_updates_on_boot,
  :ebs_optimized,
  :agent_version,
  :tenancy)
  include Aws::Structure
end

#layer_idsArray<String>

An array that contains the instance's layer IDs.

Returns:

  • (Array<String>)


1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 1523

class CreateInstanceRequest < Struct.new(
  :stack_id,
  :layer_ids,
  :instance_type,
  :auto_scaling_type,
  :hostname,
  :os,
  :ami_id,
  :ssh_key_name,
  :availability_zone,
  :virtualization_type,
  :subnet_id,
  :architecture,
  :root_device_type,
  :block_device_mappings,
  :install_updates_on_boot,
  :ebs_optimized,
  :agent_version,
  :tenancy)
  include Aws::Structure
end

#osString

The instance's operating system, which must be set to one of the following.

  • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

  • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

  • CentOS Linux 7

  • Red Hat Enterprise Linux 7

  • A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

  • A custom AMI: Custom.

For more information on the supported operating systems, see AWS OpsWorks Stacks Operating Systems.

The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom. For more information on the supported operating systems, see Operating SystemsFor more information on how to use custom AMIs with AWS OpsWorks Stacks, see Using Custom AMIs.

Returns:

  • (String)


1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 1523

class CreateInstanceRequest < Struct.new(
  :stack_id,
  :layer_ids,
  :instance_type,
  :auto_scaling_type,
  :hostname,
  :os,
  :ami_id,
  :ssh_key_name,
  :availability_zone,
  :virtualization_type,
  :subnet_id,
  :architecture,
  :root_device_type,
  :block_device_mappings,
  :install_updates_on_boot,
  :ebs_optimized,
  :agent_version,
  :tenancy)
  include Aws::Structure
end

#root_device_typeString

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

Returns:

  • (String)


1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 1523

class CreateInstanceRequest < Struct.new(
  :stack_id,
  :layer_ids,
  :instance_type,
  :auto_scaling_type,
  :hostname,
  :os,
  :ami_id,
  :ssh_key_name,
  :availability_zone,
  :virtualization_type,
  :subnet_id,
  :architecture,
  :root_device_type,
  :block_device_mappings,
  :install_updates_on_boot,
  :ebs_optimized,
  :agent_version,
  :tenancy)
  include Aws::Structure
end

#ssh_key_nameString

The instance's Amazon EC2 key-pair name.

Returns:

  • (String)


1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 1523

class CreateInstanceRequest < Struct.new(
  :stack_id,
  :layer_ids,
  :instance_type,
  :auto_scaling_type,
  :hostname,
  :os,
  :ami_id,
  :ssh_key_name,
  :availability_zone,
  :virtualization_type,
  :subnet_id,
  :architecture,
  :root_device_type,
  :block_device_mappings,
  :install_updates_on_boot,
  :ebs_optimized,
  :agent_version,
  :tenancy)
  include Aws::Structure
end

#stack_idString

The stack ID.

Returns:

  • (String)


1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 1523

class CreateInstanceRequest < Struct.new(
  :stack_id,
  :layer_ids,
  :instance_type,
  :auto_scaling_type,
  :hostname,
  :os,
  :ami_id,
  :ssh_key_name,
  :availability_zone,
  :virtualization_type,
  :subnet_id,
  :architecture,
  :root_device_type,
  :block_device_mappings,
  :install_updates_on_boot,
  :ebs_optimized,
  :agent_version,
  :tenancy)
  include Aws::Structure
end

#subnet_idString

The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet.

Returns:

  • (String)


1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 1523

class CreateInstanceRequest < Struct.new(
  :stack_id,
  :layer_ids,
  :instance_type,
  :auto_scaling_type,
  :hostname,
  :os,
  :ami_id,
  :ssh_key_name,
  :availability_zone,
  :virtualization_type,
  :subnet_id,
  :architecture,
  :root_device_type,
  :block_device_mappings,
  :install_updates_on_boot,
  :ebs_optimized,
  :agent_version,
  :tenancy)
  include Aws::Structure
end

#tenancyString

The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: dedicated, default, or host. Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts. For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances.

Returns:

  • (String)


1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 1523

class CreateInstanceRequest < Struct.new(
  :stack_id,
  :layer_ids,
  :instance_type,
  :auto_scaling_type,
  :hostname,
  :os,
  :ami_id,
  :ssh_key_name,
  :availability_zone,
  :virtualization_type,
  :subnet_id,
  :architecture,
  :root_device_type,
  :block_device_mappings,
  :install_updates_on_boot,
  :ebs_optimized,
  :agent_version,
  :tenancy)
  include Aws::Structure
end

#virtualization_typeString

The instance's virtualization type, paravirtual or hvm.

Returns:

  • (String)


1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 1523

class CreateInstanceRequest < Struct.new(
  :stack_id,
  :layer_ids,
  :instance_type,
  :auto_scaling_type,
  :hostname,
  :os,
  :ami_id,
  :ssh_key_name,
  :availability_zone,
  :virtualization_type,
  :subnet_id,
  :architecture,
  :root_device_type,
  :block_device_mappings,
  :install_updates_on_boot,
  :ebs_optimized,
  :agent_version,
  :tenancy)
  include Aws::Structure
end