AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::Cloud9::Types::Environment

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/types.rb

Overview

Information about an Cloud9 development environment.

Constant Summary collapse

SENSITIVE =
[:description]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the environment.

Returns:

  • (String)


517
518
519
520
521
522
523
524
525
526
527
528
529
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/types.rb', line 517

class Environment < Struct.new(
  :id,
  :name,
  :description,
  :type,
  :connection_type,
  :arn,
  :owner_arn,
  :lifecycle,
  :managed_credentials_status)
  SENSITIVE = [:description]
  include Aws::Structure
end

#connection_typeString

The connection type used for connecting to an Amazon EC2 environment. CONNECT_SSH is selected by default.

Returns:

  • (String)


517
518
519
520
521
522
523
524
525
526
527
528
529
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/types.rb', line 517

class Environment < Struct.new(
  :id,
  :name,
  :description,
  :type,
  :connection_type,
  :arn,
  :owner_arn,
  :lifecycle,
  :managed_credentials_status)
  SENSITIVE = [:description]
  include Aws::Structure
end

#descriptionString

The description for the environment.

Returns:

  • (String)


517
518
519
520
521
522
523
524
525
526
527
528
529
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/types.rb', line 517

class Environment < Struct.new(
  :id,
  :name,
  :description,
  :type,
  :connection_type,
  :arn,
  :owner_arn,
  :lifecycle,
  :managed_credentials_status)
  SENSITIVE = [:description]
  include Aws::Structure
end

#idString

The ID of the environment.

Returns:

  • (String)


517
518
519
520
521
522
523
524
525
526
527
528
529
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/types.rb', line 517

class Environment < Struct.new(
  :id,
  :name,
  :description,
  :type,
  :connection_type,
  :arn,
  :owner_arn,
  :lifecycle,
  :managed_credentials_status)
  SENSITIVE = [:description]
  include Aws::Structure
end

#lifecycleTypes::EnvironmentLifecycle

The state of the environment in its creation or deletion lifecycle.



517
518
519
520
521
522
523
524
525
526
527
528
529
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/types.rb', line 517

class Environment < Struct.new(
  :id,
  :name,
  :description,
  :type,
  :connection_type,
  :arn,
  :owner_arn,
  :lifecycle,
  :managed_credentials_status)
  SENSITIVE = [:description]
  include Aws::Structure
end

#managed_credentials_statusString

Describes the status of Amazon Web Services managed temporary credentials for the Cloud9 environment. Available values are:

  • ENABLED_ON_CREATE

  • ENABLED_BY_OWNER

  • DISABLED_BY_DEFAULT

  • DISABLED_BY_OWNER

  • DISABLED_BY_COLLABORATOR

  • PENDING_REMOVAL_BY_COLLABORATOR

  • PENDING_REMOVAL_BY_OWNER

  • FAILED_REMOVAL_BY_COLLABORATOR

  • ENABLED_BY_OWNER

  • DISABLED_BY_DEFAULT

Returns:

  • (String)


517
518
519
520
521
522
523
524
525
526
527
528
529
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/types.rb', line 517

class Environment < Struct.new(
  :id,
  :name,
  :description,
  :type,
  :connection_type,
  :arn,
  :owner_arn,
  :lifecycle,
  :managed_credentials_status)
  SENSITIVE = [:description]
  include Aws::Structure
end

#nameString

The name of the environment.

Returns:

  • (String)


517
518
519
520
521
522
523
524
525
526
527
528
529
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/types.rb', line 517

class Environment < Struct.new(
  :id,
  :name,
  :description,
  :type,
  :connection_type,
  :arn,
  :owner_arn,
  :lifecycle,
  :managed_credentials_status)
  SENSITIVE = [:description]
  include Aws::Structure
end

#owner_arnString

The Amazon Resource Name (ARN) of the environment owner.

Returns:

  • (String)


517
518
519
520
521
522
523
524
525
526
527
528
529
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/types.rb', line 517

class Environment < Struct.new(
  :id,
  :name,
  :description,
  :type,
  :connection_type,
  :arn,
  :owner_arn,
  :lifecycle,
  :managed_credentials_status)
  SENSITIVE = [:description]
  include Aws::Structure
end

#typeString

The type of environment. Valid values include the following:

  • ec2: An Amazon Elastic Compute Cloud (Amazon EC2) instance connects to the environment.

  • ssh: Your own server connects to the environment.

Returns:

  • (String)


517
518
519
520
521
522
523
524
525
526
527
528
529
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/types.rb', line 517

class Environment < Struct.new(
  :id,
  :name,
  :description,
  :type,
  :connection_type,
  :arn,
  :owner_arn,
  :lifecycle,
  :managed_credentials_status)
  SENSITIVE = [:description]
  include Aws::Structure
end