software.amazon.awssdk.services.cloud9.model

Interface CreateEnvironmentEc2Request.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, Cloud9Request.Builder, CopyableBuilder<CreateEnvironmentEc2Request.Builder,CreateEnvironmentEc2Request>, SdkBuilder<CreateEnvironmentEc2Request.Builder,CreateEnvironmentEc2Request>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateEnvironmentEc2Request

public static interface CreateEnvironmentEc2Request.Builder
extends Cloud9Request.Builder, SdkPojo, CopyableBuilder<CreateEnvironmentEc2Request.Builder,CreateEnvironmentEc2Request>

Method Summary

Modifier and Type	Method and Description
CreateEnvironmentEc2Request.Builder	automaticStopTimeMinutes(Integer automaticStopTimeMinutes) The number of minutes until the running instance is shut down after the environment has last been used.
CreateEnvironmentEc2Request.Builder	clientRequestToken(String clientRequestToken) A unique, case-sensitive string that helps AWS Cloud9 to ensure this operation completes no more than one time.
CreateEnvironmentEc2Request.Builder	connectionType(ConnectionType connectionType) The connection type used for connecting to an Amazon EC2 environment.
CreateEnvironmentEc2Request.Builder	connectionType(String connectionType) The connection type used for connecting to an Amazon EC2 environment.
CreateEnvironmentEc2Request.Builder	description(String description) The description of the environment to create.
CreateEnvironmentEc2Request.Builder	imageId(String imageId) The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance.
CreateEnvironmentEc2Request.Builder	instanceType(String instanceType) The type of instance to connect to the environment (for example, t2.micro).
CreateEnvironmentEc2Request.Builder	name(String name) The name of the environment to create.
CreateEnvironmentEc2Request.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateEnvironmentEc2Request.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateEnvironmentEc2Request.Builder	ownerArn(String ownerArn) The Amazon Resource Name (ARN) of the environment owner.
CreateEnvironmentEc2Request.Builder	subnetId(String subnetId) The ID of the subnet in Amazon VPC that AWS Cloud9 will use to communicate with the Amazon EC2 instance.
CreateEnvironmentEc2Request.Builder	tags(Collection<Tag> tags) An array of key-value pairs that will be associated with the new AWS Cloud9 development environment.
CreateEnvironmentEc2Request.Builder	tags(Consumer<Tag.Builder>... tags) An array of key-value pairs that will be associated with the new AWS Cloud9 development environment.
CreateEnvironmentEc2Request.Builder	tags(Tag... tags) An array of key-value pairs that will be associated with the new AWS Cloud9 development environment.

Methods inherited from interface software.amazon.awssdk.services.cloud9.model.Cloud9Request.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

name

CreateEnvironmentEc2Request.Builder name(String name)

The name of the environment to create.

This name is visible to other AWS IAM users in the same AWS account.

Parameters:

name - The name of the environment to create.

This name is visible to other AWS IAM users in the same AWS account.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

CreateEnvironmentEc2Request.Builder description(String description)

The description of the environment to create.

Parameters:

description - The description of the environment to create.

Returns:

Returns a reference to this object so that method calls can be chained together.

clientRequestToken

CreateEnvironmentEc2Request.Builder clientRequestToken(String clientRequestToken)

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

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

Parameters:

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

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

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceType

CreateEnvironmentEc2Request.Builder instanceType(String instanceType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

subnetId

CreateEnvironmentEc2Request.Builder subnetId(String subnetId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

imageId

CreateEnvironmentEc2Request.Builder imageId(String imageId)

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 AWS Systems Manager (SSM) path.

The default AMI is used if the parameter isn't explicitly assigned a value in the request.

AMI aliases

• Amazon Linux (default): amazonlinux-1-x86_64

• Amazon Linux 2: amazonlinux-2-x86_64

• Ubuntu 18.04: ubuntu-18.04-x86_64

SSM paths

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

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

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

Parameters:

imageId - 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 AWS Systems Manager (SSM) path.

The default AMI is used if the parameter isn't explicitly assigned a value in the request.

AMI aliases

• Amazon Linux (default): amazonlinux-1-x86_64

• Amazon Linux 2: amazonlinux-2-x86_64

• Ubuntu 18.04: ubuntu-18.04-x86_64

SSM paths

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

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

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

Returns:

Returns a reference to this object so that method calls can be chained together.

automaticStopTimeMinutes

CreateEnvironmentEc2Request.Builder automaticStopTimeMinutes(Integer automaticStopTimeMinutes)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

ownerArn

CreateEnvironmentEc2Request.Builder ownerArn(String ownerArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateEnvironmentEc2Request.Builder tags(Collection<Tag> tags)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateEnvironmentEc2Request.Builder tags(Tag... tags)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateEnvironmentEc2Request.Builder tags(Consumer<Tag.Builder>... tags)

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

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(List)

connectionType

CreateEnvironmentEc2Request.Builder connectionType(String connectionType)

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

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

Parameters:

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

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ConnectionType, ConnectionType

connectionType

CreateEnvironmentEc2Request.Builder connectionType(ConnectionType connectionType)

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

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

Parameters:

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

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ConnectionType, ConnectionType

overrideConfiguration

CreateEnvironmentEc2Request.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateEnvironmentEc2Request.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder