Package software.amazon.awssdk.services.cloud9.model

Interface CreateEnvironmentEc2Request.Builder

    • Method Detail

      • name

        CreateEnvironmentEc2Request.Builder name​(String name)

        The name of the environment to create.

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

        Parameters:
        name - The name of the environment to create.

        This name is visible to other IAM users in the same Amazon Web Services 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 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 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 Cloud9 will use to communicate with the Amazon EC2 instance.

        Parameters:
        subnetId - The ID of the subnet in Amazon VPC that 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 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.

        From January 22, 2024, Amazon Linux (AL1) will be removed from the list of available image IDs for Cloud9. This is necessary as AL1 will reach the end of maintenance support in December 2023, and as a result will no longer receive security updates. We recommend using Amazon Linux 2 as the AMI to create your environment as it is fully supported. This change will only affect direct API consumers, and not Cloud9 console users.

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

        AMI aliases

        • Amazon Linux: amazonlinux-1-x86_64

        • Amazon Linux 2: amazonlinux-2-x86_64

        • Ubuntu 18.04: ubuntu-18.04-x86_64

        • Ubuntu 22.04: ubuntu-22.04-x86_64

        SSM paths

        • Amazon Linux: 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

        • Ubuntu 22.04: resolve:ssm:/aws/service/cloud9/amis/ubuntu-22.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 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.

        From January 22, 2024, Amazon Linux (AL1) will be removed from the list of available image IDs for Cloud9. This is necessary as AL1 will reach the end of maintenance support in December 2023, and as a result will no longer receive security updates. We recommend using Amazon Linux 2 as the AMI to create your environment as it is fully supported. This change will only affect direct API consumers, and not Cloud9 console users.

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

        AMI aliases

        • Amazon Linux: amazonlinux-1-x86_64

        • Amazon Linux 2: amazonlinux-2-x86_64

        • Ubuntu 18.04: ubuntu-18.04-x86_64

        • Ubuntu 22.04: ubuntu-22.04-x86_64

        SSM paths

        • Amazon Linux: 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

        • Ubuntu 22.04: resolve:ssm:/aws/service/cloud9/amis/ubuntu-22.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 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 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 Cloud9 development environment.

        Parameters:
        tags - An array of key-value pairs that will be associated with the new 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 Cloud9 development environment.

        Parameters:
        tags - An array of key-value pairs that will be associated with the new 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 Cloud9 development environment.

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)

      • dryRun

        CreateEnvironmentEc2Request.Builder dryRun​(Boolean dryRun)

        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.

        Parameters:
        dryRun - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.