Struct aws_sdk_opsworks::client::fluent_builders::CreateInstance

pub struct CreateInstance<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to CreateInstance.

Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Implementations

impl<C, M, R> CreateInstance<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<CreateInstanceOutput, SdkError<CreateInstanceError>> where
    R::Policy: SmithyRetryPolicy<CreateInstanceInputOperationOutputAlias, CreateInstanceOutput, CreateInstanceError, CreateInstanceInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn stack_id(self, inp: impl Into<String>) -> Self

The stack ID.

pub fn set_stack_id(self, input: Option<String>) -> Self

The stack ID.

pub fn layer_ids(self, inp: impl Into<String>) -> Self

Appends an item to LayerIds.

To override the contents of this collection use set_layer_ids.

An array that contains the instance's layer IDs.

pub fn set_layer_ids(self, input: Option<Vec<String>>) -> Self

An array that contains the instance's layer IDs.

pub fn instance_type(self, inp: impl Into<String>) -> Self

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 set_instance_type(self, input: Option<String>) -> Self

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, inp: AutoScalingType) -> Self

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

pub fn set_auto_scaling_type(self, input: Option<AutoScalingType>) -> Self

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

pub fn hostname(self, inp: impl Into<String>) -> Self

The instance host name.

pub fn set_hostname(self, input: Option<String>) -> Self

The instance host name.

pub fn os(self, inp: impl Into<String>) -> Self

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 set_os(self, input: Option<String>) -> Self

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, inp: impl Into<String>) -> Self

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 set_ami_id(self, input: Option<String>) -> Self

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, inp: impl Into<String>) -> Self

The instance's Amazon EC2 key-pair name.

pub fn set_ssh_key_name(self, input: Option<String>) -> Self

The instance's Amazon EC2 key-pair name.

pub fn availability_zone(self, inp: impl Into<String>) -> Self

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

pub fn set_availability_zone(self, input: Option<String>) -> Self

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

pub fn virtualization_type(self, inp: impl Into<String>) -> Self

The instance's virtualization type, paravirtual or hvm.

pub fn set_virtualization_type(self, input: Option<String>) -> Self

The instance's virtualization type, paravirtual or hvm.

pub fn subnet_id(self, inp: impl Into<String>) -> Self

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 set_subnet_id(self, input: Option<String>) -> Self

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, inp: Architecture) -> Self

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 set_architecture(self, input: Option<Architecture>) -> Self

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, inp: RootDeviceType) -> Self

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

pub fn set_root_device_type(self, input: Option<RootDeviceType>) -> Self

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

pub fn block_device_mappings(self, inp: impl Into<BlockDeviceMapping>) -> Self

Appends an item to BlockDeviceMappings.

To override the contents of this collection use set_block_device_mappings.

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 set_block_device_mappings(
    self,
    input: Option<Vec<BlockDeviceMapping>>
) -> Self

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, inp: bool) -> Self

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 set_install_updates_on_boot(self, input: Option<bool>) -> Self

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, inp: bool) -> Self

Whether to create an Amazon EBS-optimized instance.

pub fn set_ebs_optimized(self, input: Option<bool>) -> Self

Whether to create an Amazon EBS-optimized instance.

pub fn agent_version(self, inp: impl Into<String>) -> Self

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 set_agent_version(self, input: Option<String>) -> Self

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, inp: impl Into<String>) -> Self

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.

pub fn set_tenancy(self, input: Option<String>) -> Self

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.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for CreateInstance<C, M, R>

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

Formats the value using the given formatter.