Class: Aws::Cloud9::Types::CreateEnvironmentEC2Request
- Inherits:
-
Struct
- Object
- Struct
- Aws::Cloud9::Types::CreateEnvironmentEC2Request
- Defined in:
- gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[:description, :tags]
Instance Attribute Summary collapse
-
#automatic_stop_time_minutes ⇒ Integer
The number of minutes until the running instance is shut down after the environment has last been used.
-
#client_request_token ⇒ String
A unique, case-sensitive string that helps Cloud9 to ensure this operation completes no more than one time.
-
#connection_type ⇒ String
The connection type used for connecting to an Amazon EC2 environment.
-
#description ⇒ String
The description of the environment to create.
-
#dry_run ⇒ Boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
-
#image_id ⇒ String
The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance.
-
#instance_type ⇒ String
The type of instance to connect to the environment (for example,
t2.micro
). -
#name ⇒ String
The name of the environment to create.
-
#owner_arn ⇒ String
The Amazon Resource Name (ARN) of the environment owner.
-
#subnet_id ⇒ String
The ID of the subnet in Amazon VPC that Cloud9 will use to communicate with the Amazon EC2 instance.
-
#tags ⇒ Array<Types::Tag>
An array of key-value pairs that will be associated with the new Cloud9 development environment.
Instance Attribute Details
#automatic_stop_time_minutes ⇒ Integer
The number of minutes until the running instance is shut down after the environment has last been used.
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 |
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/types.rb', line 146 class CreateEnvironmentEC2Request < Struct.new( :name, :description, :client_request_token, :instance_type, :subnet_id, :image_id, :automatic_stop_time_minutes, :owner_arn, :tags, :connection_type, :dry_run) SENSITIVE = [:description, :tags] include Aws::Structure end |
#client_request_token ⇒ 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.
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 |
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/types.rb', line 146 class CreateEnvironmentEC2Request < Struct.new( :name, :description, :client_request_token, :instance_type, :subnet_id, :image_id, :automatic_stop_time_minutes, :owner_arn, :tags, :connection_type, :dry_run) SENSITIVE = [:description, :tags] include Aws::Structure end |
#connection_type ⇒ String
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.
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 |
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/types.rb', line 146 class CreateEnvironmentEC2Request < Struct.new( :name, :description, :client_request_token, :instance_type, :subnet_id, :image_id, :automatic_stop_time_minutes, :owner_arn, :tags, :connection_type, :dry_run) SENSITIVE = [:description, :tags] include Aws::Structure end |
#description ⇒ String
The description of the environment to create.
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 |
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/types.rb', line 146 class CreateEnvironmentEC2Request < Struct.new( :name, :description, :client_request_token, :instance_type, :subnet_id, :image_id, :automatic_stop_time_minutes, :owner_arn, :tags, :connection_type, :dry_run) SENSITIVE = [:description, :tags] include Aws::Structure end |
#dry_run ⇒ Boolean
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
.
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 |
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/types.rb', line 146 class CreateEnvironmentEC2Request < Struct.new( :name, :description, :client_request_token, :instance_type, :subnet_id, :image_id, :automatic_stop_time_minutes, :owner_arn, :tags, :connection_type, :dry_run) SENSITIVE = [:description, :tags] include Aws::Structure end |
#image_id ⇒ 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
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 |
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/types.rb', line 146 class CreateEnvironmentEC2Request < Struct.new( :name, :description, :client_request_token, :instance_type, :subnet_id, :image_id, :automatic_stop_time_minutes, :owner_arn, :tags, :connection_type, :dry_run) SENSITIVE = [:description, :tags] include Aws::Structure end |
#instance_type ⇒ String
The type of instance to connect to the environment (for example,
t2.micro
).
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 |
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/types.rb', line 146 class CreateEnvironmentEC2Request < Struct.new( :name, :description, :client_request_token, :instance_type, :subnet_id, :image_id, :automatic_stop_time_minutes, :owner_arn, :tags, :connection_type, :dry_run) SENSITIVE = [:description, :tags] include Aws::Structure end |
#name ⇒ String
The name of the environment to create.
This name is visible to other IAM users in the same Amazon Web Services account.
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 |
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/types.rb', line 146 class CreateEnvironmentEC2Request < Struct.new( :name, :description, :client_request_token, :instance_type, :subnet_id, :image_id, :automatic_stop_time_minutes, :owner_arn, :tags, :connection_type, :dry_run) SENSITIVE = [:description, :tags] include Aws::Structure end |
#owner_arn ⇒ 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.
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 |
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/types.rb', line 146 class CreateEnvironmentEC2Request < Struct.new( :name, :description, :client_request_token, :instance_type, :subnet_id, :image_id, :automatic_stop_time_minutes, :owner_arn, :tags, :connection_type, :dry_run) SENSITIVE = [:description, :tags] include Aws::Structure end |
#subnet_id ⇒ String
The ID of the subnet in Amazon VPC that Cloud9 will use to communicate with the Amazon EC2 instance.
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 |
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/types.rb', line 146 class CreateEnvironmentEC2Request < Struct.new( :name, :description, :client_request_token, :instance_type, :subnet_id, :image_id, :automatic_stop_time_minutes, :owner_arn, :tags, :connection_type, :dry_run) SENSITIVE = [:description, :tags] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
An array of key-value pairs that will be associated with the new Cloud9 development environment.
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 |
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/types.rb', line 146 class CreateEnvironmentEC2Request < Struct.new( :name, :description, :client_request_token, :instance_type, :subnet_id, :image_id, :automatic_stop_time_minutes, :owner_arn, :tags, :connection_type, :dry_run) SENSITIVE = [:description, :tags] include Aws::Structure end |