Struct aws_sdk_opsworks::operation::create_instance::CreateInstanceInput

#[non_exhaustive]
pub struct CreateInstanceInput {

    pub stack_id: Option<String>,
    pub layer_ids: Option<Vec<String>>,
    pub instance_type: Option<String>,
    pub auto_scaling_type: Option<AutoScalingType>,
    pub hostname: Option<String>,
    pub os: Option<String>,
    pub ami_id: Option<String>,
    pub ssh_key_name: Option<String>,
    pub availability_zone: Option<String>,
    pub virtualization_type: Option<String>,
    pub subnet_id: Option<String>,
    pub architecture: Option<Architecture>,
    pub root_device_type: Option<RootDeviceType>,
    pub block_device_mappings: Option<Vec<BlockDeviceMapping>>,
    pub install_updates_on_boot: Option<bool>,
    pub ebs_optimized: Option<bool>,
    pub agent_version: Option<String>,
    pub tenancy: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

stack_id: Option<String>

The stack ID.

layer_ids: Option<Vec<String>>

An array that contains the instance's layer IDs.

instance_type: Option<String>

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.

auto_scaling_type: Option<AutoScalingType>

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

hostname: Option<String>

The instance host name.

os: Option<String>

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 2018.03, Amazon Linux 2017.09, 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 about 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 about supported operating systems, see Operating SystemsFor more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using Custom AMIs.

ami_id: Option<String>

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.

ssh_key_name: Option<String>

The instance's Amazon EC2 key-pair name.

availability_zone: Option<String>

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

virtualization_type: Option<String>

The instance's virtualization type, paravirtual or hvm.

subnet_id: Option<String>

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.

architecture: Option<Architecture>

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.

root_device_type: Option<RootDeviceType>

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

block_device_mappings: Option<Vec<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.

install_updates_on_boot: Option<bool>

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.

ebs_optimized: Option<bool>

Whether to create an Amazon EBS-optimized instance.

agent_version: Option<String>

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.

tenancy: Option<String>

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.

Implementations

impl CreateInstanceInput

pub fn stack_id(&self) -> Option<&str>

The stack ID.

pub fn layer_ids(&self) -> Option<&[String]>

An array that contains the instance's layer IDs.

pub fn instance_type(&self) -> Option<&str>

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.

pub fn auto_scaling_type(&self) -> Option<&AutoScalingType>

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

pub fn hostname(&self) -> Option<&str>

The instance host name.

pub fn os(&self) -> Option<&str>

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 2018.03, Amazon Linux 2017.09, 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 about 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 about supported operating systems, see Operating SystemsFor more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using Custom AMIs.

pub fn ami_id(&self) -> Option<&str>

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.

pub fn ssh_key_name(&self) -> Option<&str>

The instance's Amazon EC2 key-pair name.

pub fn availability_zone(&self) -> Option<&str>

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

pub fn virtualization_type(&self) -> Option<&str>

The instance's virtualization type, paravirtual or hvm.

pub fn subnet_id(&self) -> Option<&str>

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.

pub fn architecture(&self) -> Option<&Architecture>

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.

pub fn root_device_type(&self) -> Option<&RootDeviceType>

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

pub fn block_device_mappings(&self) -> Option<&[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.

pub fn install_updates_on_boot(&self) -> Option<bool>

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.

pub fn ebs_optimized(&self) -> Option<bool>

Whether to create an Amazon EBS-optimized instance.

pub fn agent_version(&self) -> Option<&str>

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.

pub fn tenancy(&self) -> Option<&str>

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.

impl CreateInstanceInput

pub fn builder() -> CreateInstanceInputBuilder

Creates a new builder-style object to manufacture CreateInstanceInput.

Trait Implementations

impl Clone for CreateInstanceInput

fn clone(&self) -> CreateInstanceInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateInstanceInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<CreateInstanceInput> for CreateInstanceInput

fn eq(&self, other: &CreateInstanceInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateInstanceInput