Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Cloud9.CreateEnvironmentEC2

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment.

Synopsis

data CreateEnvironmentEC2 = CreateEnvironmentEC2' {
- automaticStopTimeMinutes :: Maybe Int
- subnetId :: Maybe Text
- ownerArn :: Maybe Text
- imageId :: Maybe Text
- clientRequestToken :: Maybe Text
- connectionType :: Maybe ConnectionType
- description :: Maybe (Sensitive Text)
- dryRun :: Maybe Bool
- tags :: Maybe (Sensitive [Sensitive Tag])
- name :: Text
- instanceType :: Text
}
newCreateEnvironmentEC2 :: Text -> Text -> CreateEnvironmentEC2
createEnvironmentEC2_automaticStopTimeMinutes :: Lens' CreateEnvironmentEC2 (Maybe Int)
createEnvironmentEC2_subnetId :: Lens' CreateEnvironmentEC2 (Maybe Text)
createEnvironmentEC2_ownerArn :: Lens' CreateEnvironmentEC2 (Maybe Text)
createEnvironmentEC2_imageId :: Lens' CreateEnvironmentEC2 (Maybe Text)
createEnvironmentEC2_clientRequestToken :: Lens' CreateEnvironmentEC2 (Maybe Text)
createEnvironmentEC2_connectionType :: Lens' CreateEnvironmentEC2 (Maybe ConnectionType)
createEnvironmentEC2_description :: Lens' CreateEnvironmentEC2 (Maybe Text)
createEnvironmentEC2_dryRun :: Lens' CreateEnvironmentEC2 (Maybe Bool)
createEnvironmentEC2_tags :: Lens' CreateEnvironmentEC2 (Maybe [Tag])
createEnvironmentEC2_name :: Lens' CreateEnvironmentEC2 Text
createEnvironmentEC2_instanceType :: Lens' CreateEnvironmentEC2 Text
data CreateEnvironmentEC2Response = CreateEnvironmentEC2Response' {
- environmentId :: Maybe Text
- httpStatus :: Int
}
newCreateEnvironmentEC2Response :: Int -> CreateEnvironmentEC2Response
createEnvironmentEC2Response_environmentId :: Lens' CreateEnvironmentEC2Response (Maybe Text)
createEnvironmentEC2Response_httpStatus :: Lens' CreateEnvironmentEC2Response Int

Creating a Request

data CreateEnvironmentEC2 Source #

See: newCreateEnvironmentEC2 smart constructor.

Constructors

CreateEnvironmentEC2'

Fields

automaticStopTimeMinutes :: Maybe Int
The number of minutes until the running instance is shut down after the environment has last been used.
subnetId :: Maybe Text
The ID of the subnet in Amazon VPC that Cloud9 will use to communicate with the Amazon EC2 instance.
ownerArn :: Maybe Text
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.
imageId :: Maybe Text
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.
The default AMI is used if the parameter isn't explicitly assigned a value in the request. Because Amazon Linux AMI has ended standard support as of December 31, 2020, we recommend you choose Amazon Linux 2, which includes long term support through 2023.
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
clientRequestToken :: Maybe Text
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.
connectionType :: Maybe 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.
description :: Maybe (Sensitive Text)
The description of the environment to create.
dryRun :: Maybe 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.
tags :: Maybe (Sensitive [Sensitive Tag])
An array of key-value pairs that will be associated with the new Cloud9 development environment.
name :: Text
The name of the environment to create.
This name is visible to other IAM users in the same Amazon Web Services account.
instanceType :: Text
The type of instance to connect to the environment (for example, t2.micro).

Instances

Instances details

Eq CreateEnvironmentEC2 Source #
Instance details Defined in Amazonka.Cloud9.CreateEnvironmentEC2 Methods (==) :: CreateEnvironmentEC2 -> CreateEnvironmentEC2 -> Bool # (/=) :: CreateEnvironmentEC2 -> CreateEnvironmentEC2 -> Bool #
Show CreateEnvironmentEC2 Source #
Instance details Defined in Amazonka.Cloud9.CreateEnvironmentEC2 Methods showsPrec :: Int -> CreateEnvironmentEC2 -> ShowS # show :: CreateEnvironmentEC2 -> String # showList :: [CreateEnvironmentEC2] -> ShowS #
Generic CreateEnvironmentEC2 Source #
Instance details Defined in Amazonka.Cloud9.CreateEnvironmentEC2 Associated Types type Rep CreateEnvironmentEC2 :: Type -> Type # Methods from :: CreateEnvironmentEC2 -> Rep CreateEnvironmentEC2 x # to :: Rep CreateEnvironmentEC2 x -> CreateEnvironmentEC2 #
NFData CreateEnvironmentEC2 Source #
Instance details Defined in Amazonka.Cloud9.CreateEnvironmentEC2 Methods rnf :: CreateEnvironmentEC2 -> () #
Hashable CreateEnvironmentEC2 Source #
Instance details Defined in Amazonka.Cloud9.CreateEnvironmentEC2 Methods hashWithSalt :: Int -> CreateEnvironmentEC2 -> Int # hash :: CreateEnvironmentEC2 -> Int #
ToJSON CreateEnvironmentEC2 Source #
Instance details Defined in Amazonka.Cloud9.CreateEnvironmentEC2 Methods toJSON :: CreateEnvironmentEC2 -> Value # toEncoding :: CreateEnvironmentEC2 -> Encoding # toJSONList :: [CreateEnvironmentEC2] -> Value # toEncodingList :: [CreateEnvironmentEC2] -> Encoding #
AWSRequest CreateEnvironmentEC2 Source #
Instance details Defined in Amazonka.Cloud9.CreateEnvironmentEC2 Associated Types type AWSResponse CreateEnvironmentEC2 # Methods request :: CreateEnvironmentEC2 -> Request CreateEnvironmentEC2 # response :: MonadResource m => Logger -> Service -> Proxy CreateEnvironmentEC2 -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateEnvironmentEC2))) #
ToHeaders CreateEnvironmentEC2 Source #
Instance details Defined in Amazonka.Cloud9.CreateEnvironmentEC2 Methods toHeaders :: CreateEnvironmentEC2 -> [Header] #
ToPath CreateEnvironmentEC2 Source #
Instance details Defined in Amazonka.Cloud9.CreateEnvironmentEC2 Methods toPath :: CreateEnvironmentEC2 -> ByteString #
ToQuery CreateEnvironmentEC2 Source #
Instance details Defined in Amazonka.Cloud9.CreateEnvironmentEC2 Methods toQuery :: CreateEnvironmentEC2 -> QueryString #
type Rep CreateEnvironmentEC2 Source #
Instance details Defined in Amazonka.Cloud9.CreateEnvironmentEC2 type Rep CreateEnvironmentEC2 = D1 ('MetaData "CreateEnvironmentEC2" "Amazonka.Cloud9.CreateEnvironmentEC2" "libZSservicesZSamazonka-cloud9ZSamazonka-cloud9" 'False) (C1 ('MetaCons "CreateEnvironmentEC2'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "automaticStopTimeMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "subnetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "ownerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "imageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "connectionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectionType)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive [Sensitive Tag]))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "instanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse CreateEnvironmentEC2 Source #
Instance details Defined in Amazonka.Cloud9.CreateEnvironmentEC2 type AWSResponse CreateEnvironmentEC2 = CreateEnvironmentEC2Response

newCreateEnvironmentEC2 Source #

Arguments

:: Text	`$sel:name:CreateEnvironmentEC2'`
-> Text	`$sel:instanceType:CreateEnvironmentEC2'`
-> CreateEnvironmentEC2

Create a value of CreateEnvironmentEC2 with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:automaticStopTimeMinutes:CreateEnvironmentEC2', createEnvironmentEC2_automaticStopTimeMinutes - The number of minutes until the running instance is shut down after the environment has last been used.

$sel:subnetId:CreateEnvironmentEC2', createEnvironmentEC2_subnetId - The ID of the subnet in Amazon VPC that Cloud9 will use to communicate with the Amazon EC2 instance.

$sel:ownerArn:CreateEnvironmentEC2', createEnvironmentEC2_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.

$sel:imageId:CreateEnvironmentEC2', createEnvironmentEC2_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.

The default AMI is used if the parameter isn't explicitly assigned a value in the request. Because Amazon Linux AMI has ended standard support as of December 31, 2020, we recommend you choose Amazon Linux 2, which includes long term support through 2023.

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

$sel:clientRequestToken:CreateEnvironmentEC2', createEnvironmentEC2_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.

$sel:connectionType:CreateEnvironmentEC2', createEnvironmentEC2_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.

$sel:description:CreateEnvironmentEC2', createEnvironmentEC2_description - The description of the environment to create.

$sel:dryRun:CreateEnvironmentEC2', createEnvironmentEC2_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.

$sel:tags:CreateEnvironmentEC2', createEnvironmentEC2_tags - An array of key-value pairs that will be associated with the new Cloud9 development environment.

$sel:name:CreateEnvironmentEC2', createEnvironmentEC2_name - The name of the environment to create.

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

$sel:instanceType:CreateEnvironmentEC2', createEnvironmentEC2_instanceType - The type of instance to connect to the environment (for example, t2.micro).

Request Lenses

createEnvironmentEC2_automaticStopTimeMinutes :: Lens' CreateEnvironmentEC2 (Maybe Int) Source #

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

createEnvironmentEC2_subnetId :: Lens' CreateEnvironmentEC2 (Maybe Text) Source #

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

createEnvironmentEC2_ownerArn :: Lens' CreateEnvironmentEC2 (Maybe Text) Source #

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.

createEnvironmentEC2_imageId :: Lens' CreateEnvironmentEC2 (Maybe Text) Source #

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.

The default AMI is used if the parameter isn't explicitly assigned a value in the request. Because Amazon Linux AMI has ended standard support as of December 31, 2020, we recommend you choose Amazon Linux 2, which includes long term support through 2023.

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

createEnvironmentEC2_clientRequestToken :: Lens' CreateEnvironmentEC2 (Maybe Text) Source #

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.

createEnvironmentEC2_connectionType :: Lens' CreateEnvironmentEC2 (Maybe ConnectionType) Source #

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.

createEnvironmentEC2_description :: Lens' CreateEnvironmentEC2 (Maybe Text) Source #

The description of the environment to create.

createEnvironmentEC2_dryRun :: Lens' CreateEnvironmentEC2 (Maybe Bool) Source #

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.

createEnvironmentEC2_tags :: Lens' CreateEnvironmentEC2 (Maybe [Tag]) Source #

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

createEnvironmentEC2_name :: Lens' CreateEnvironmentEC2 Text Source #

The name of the environment to create.

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

createEnvironmentEC2_instanceType :: Lens' CreateEnvironmentEC2 Text Source #

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

Destructuring the Response

data CreateEnvironmentEC2Response Source #

See: newCreateEnvironmentEC2Response smart constructor.

Constructors

CreateEnvironmentEC2Response'
Fields environmentId :: Maybe Text The ID of the environment that was created. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateEnvironmentEC2Response Source #
Instance details Defined in Amazonka.Cloud9.CreateEnvironmentEC2 Methods (==) :: CreateEnvironmentEC2Response -> CreateEnvironmentEC2Response -> Bool # (/=) :: CreateEnvironmentEC2Response -> CreateEnvironmentEC2Response -> Bool #
Read CreateEnvironmentEC2Response Source #
Instance details Defined in Amazonka.Cloud9.CreateEnvironmentEC2 Methods readsPrec :: Int -> ReadS CreateEnvironmentEC2Response # readList :: ReadS [CreateEnvironmentEC2Response] # readPrec :: ReadPrec CreateEnvironmentEC2Response # readListPrec :: ReadPrec [CreateEnvironmentEC2Response] #
Show CreateEnvironmentEC2Response Source #
Instance details Defined in Amazonka.Cloud9.CreateEnvironmentEC2 Methods showsPrec :: Int -> CreateEnvironmentEC2Response -> ShowS # show :: CreateEnvironmentEC2Response -> String # showList :: [CreateEnvironmentEC2Response] -> ShowS #
Generic CreateEnvironmentEC2Response Source #
Instance details Defined in Amazonka.Cloud9.CreateEnvironmentEC2 Associated Types type Rep CreateEnvironmentEC2Response :: Type -> Type # Methods from :: CreateEnvironmentEC2Response -> Rep CreateEnvironmentEC2Response x # to :: Rep CreateEnvironmentEC2Response x -> CreateEnvironmentEC2Response #
NFData CreateEnvironmentEC2Response Source #
Instance details Defined in Amazonka.Cloud9.CreateEnvironmentEC2 Methods rnf :: CreateEnvironmentEC2Response -> () #
type Rep CreateEnvironmentEC2Response Source #
Instance details Defined in Amazonka.Cloud9.CreateEnvironmentEC2 type Rep CreateEnvironmentEC2Response = D1 ('MetaData "CreateEnvironmentEC2Response" "Amazonka.Cloud9.CreateEnvironmentEC2" "libZSservicesZSamazonka-cloud9ZSamazonka-cloud9" 'False) (C1 ('MetaCons "CreateEnvironmentEC2Response'" 'PrefixI 'True) (S1 ('MetaSel ('Just "environmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateEnvironmentEC2Response Source #

Arguments

:: Int	`$sel:httpStatus:CreateEnvironmentEC2Response'`
-> CreateEnvironmentEC2Response

Create a value of CreateEnvironmentEC2Response with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:environmentId:CreateEnvironmentEC2Response', createEnvironmentEC2Response_environmentId - The ID of the environment that was created.

$sel:httpStatus:CreateEnvironmentEC2Response', createEnvironmentEC2Response_httpStatus - The response's http status code.

Response Lenses

createEnvironmentEC2Response_environmentId :: Lens' CreateEnvironmentEC2Response (Maybe Text) Source #

The ID of the environment that was created.

createEnvironmentEC2Response_httpStatus :: Lens' CreateEnvironmentEC2Response Int Source #

The response's http status code.