Struct aws_sdk_cloud9::operation::create_environment_ec2::CreateEnvironmentEc2Input

#[non_exhaustive]
pub struct CreateEnvironmentEc2Input {
    pub name: Option<String>,
    pub description: Option<String>,
    pub client_request_token: Option<String>,
    pub instance_type: Option<String>,
    pub subnet_id: Option<String>,
    pub image_id: Option<String>,
    pub automatic_stop_time_minutes: Option<i32>,
    pub owner_arn: Option<String>,
    pub tags: Option<Vec<Tag>>,
    pub connection_type: Option<ConnectionType>,
    pub dry_run: Option<bool>,
}

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.

name: Option<String>

The name of the environment to create.

This name is visible to other IAM users in the same Amazon Web Services account.

description: Option<String>

The description of the environment to create.

client_request_token: Option<String>

A unique, case-sensitive string that helps Cloud9 to ensure this operation completes no more than one time.

For more information, see Client Tokens in the Amazon EC2 API Reference.

instance_type: Option<String>

The type of instance to connect to the environment (for example, t2.micro).

subnet_id: Option<String>

The ID of the subnet in Amazon VPC that Cloud9 will use to communicate with the Amazon EC2 instance.

image_id: Option<String>

The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance. To choose an AMI for the instance, you must specify a valid AMI alias or a valid Amazon EC2 Systems Manager (SSM) path.

From December 04, 2023, you will be required to include the imageId parameter for the CreateEnvironmentEC2 action. This change will be reflected across all direct methods of communicating with the API, such as Amazon Web Services SDK, Amazon Web Services CLI and Amazon Web Services CloudFormation. This change will only affect direct API consumers, and not Cloud9 console users.

We recommend using Amazon Linux 2023 as the AMI to create your environment as it is fully supported.

Since Ubuntu 18.04 has ended standard support as of May 31, 2023, we recommend you choose Ubuntu 22.04.

AMI aliases

• Amazon Linux 2: amazonlinux-2-x86_64

• Amazon Linux 2023 (recommended): amazonlinux-2023-x86_64

• Ubuntu 18.04: ubuntu-18.04-x86_64

• Ubuntu 22.04: ubuntu-22.04-x86_64

SSM paths

• Amazon Linux 2: resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64

• Amazon Linux 2023 (recommended): resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2023-x86_64

• Ubuntu 18.04: resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64

• Ubuntu 22.04: resolve:ssm:/aws/service/cloud9/amis/ubuntu-22.04-x86_64

automatic_stop_time_minutes: Option<i32>

The number of minutes until the running instance is shut down after the environment has last been used.

owner_arn: Option<String>

The Amazon Resource Name (ARN) of the environment owner. This ARN can be the ARN of any IAM principal. If this value is not specified, the ARN defaults to this environment's creator.

tags: Option<Vec<Tag>>

An array of key-value pairs that will be associated with the new Cloud9 development environment.

connection_type: Option<ConnectionType>

The connection type used for connecting to an Amazon EC2 environment. Valid values are CONNECT_SSH (default) and CONNECT_SSM (connected through Amazon EC2 Systems Manager).

For more information, see Accessing no-ingress EC2 instances with Amazon EC2 Systems Manager in the Cloud9 User Guide.

dry_run: Option<bool>

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.

Implementations

impl CreateEnvironmentEc2Input

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

The name of the environment to create.

This name is visible to other IAM users in the same Amazon Web Services account.

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

The description of the environment to create.

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

A unique, case-sensitive string that helps Cloud9 to ensure this operation completes no more than one time.

For more information, see Client Tokens in the Amazon EC2 API Reference.

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

The type of instance to connect to the environment (for example, t2.micro).

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

The ID of the subnet in Amazon VPC that Cloud9 will use to communicate with the Amazon EC2 instance.

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

The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance. To choose an AMI for the instance, you must specify a valid AMI alias or a valid Amazon EC2 Systems Manager (SSM) path.

From December 04, 2023, you will be required to include the imageId parameter for the CreateEnvironmentEC2 action. This change will be reflected across all direct methods of communicating with the API, such as Amazon Web Services SDK, Amazon Web Services CLI and Amazon Web Services CloudFormation. This change will only affect direct API consumers, and not Cloud9 console users.

We recommend using Amazon Linux 2023 as the AMI to create your environment as it is fully supported.

Since Ubuntu 18.04 has ended standard support as of May 31, 2023, we recommend you choose Ubuntu 22.04.

AMI aliases

• Amazon Linux 2: amazonlinux-2-x86_64

• Amazon Linux 2023 (recommended): amazonlinux-2023-x86_64

• Ubuntu 18.04: ubuntu-18.04-x86_64

• Ubuntu 22.04: ubuntu-22.04-x86_64

SSM paths

• Amazon Linux 2: resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64

• Amazon Linux 2023 (recommended): resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2023-x86_64

• Ubuntu 18.04: resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64

• Ubuntu 22.04: resolve:ssm:/aws/service/cloud9/amis/ubuntu-22.04-x86_64

pub fn automatic_stop_time_minutes(&self) -> Option<i32>

The number of minutes until the running instance is shut down after the environment has last been used.

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

The Amazon Resource Name (ARN) of the environment owner. This ARN can be the ARN of any IAM principal. If this value is not specified, the ARN defaults to this environment's creator.

pub fn tags(&self) -> &[Tag]

An array of key-value pairs that will be associated with the new Cloud9 development environment.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

pub fn connection_type(&self) -> Option<&ConnectionType>

The connection type used for connecting to an Amazon EC2 environment. Valid values are CONNECT_SSH (default) and CONNECT_SSM (connected through Amazon EC2 Systems Manager).

For more information, see Accessing no-ingress EC2 instances with Amazon EC2 Systems Manager in the Cloud9 User Guide.

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

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.

impl CreateEnvironmentEc2Input

pub fn builder() -> CreateEnvironmentEc2InputBuilder

Creates a new builder-style object to manufacture CreateEnvironmentEc2Input.

Trait Implementations

impl Clone for CreateEnvironmentEc2Input

fn clone(&self) -> CreateEnvironmentEc2Input

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateEnvironmentEc2Input

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

Formats the value using the given formatter.

impl PartialEq for CreateEnvironmentEc2Input

fn eq(&self, other: &CreateEnvironmentEc2Input) -> 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 CreateEnvironmentEc2Input