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::UpdateEnvironmentRequest

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

Overview

Note:

When making an API call, you may pass UpdateEnvironmentRequest data as a hash:

{
  environment_id: "EnvironmentId", # required
  name: "EnvironmentName",
  description: "EnvironmentDescription",
  managed_credentials_action: "ENABLE", # accepts ENABLE, DISABLE
}

Constant Summary collapse

SENSITIVE =
[:description]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

Any new or replacement description for the environment.

Returns:

  • (String)


915
916
917
918
919
920
921
922
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/types.rb', line 915

class UpdateEnvironmentRequest < Struct.new(
  :environment_id,
  :name,
  :description,
  :managed_credentials_action)
  SENSITIVE = [:description]
  include Aws::Structure
end

#environment_idString

The ID of the environment to change settings.

Returns:

  • (String)


915
916
917
918
919
920
921
922
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/types.rb', line 915

class UpdateEnvironmentRequest < Struct.new(
  :environment_id,
  :name,
  :description,
  :managed_credentials_action)
  SENSITIVE = [:description]
  include Aws::Structure
end

#managed_credentials_actionString

Allows the environment owner to turn on or turn off the Amazon Web Services managed temporary credentials for an Cloud9 environment by using one of the following values:

  • ENABLE

  • DISABLE

Only the environment owner can change the status of managed temporary credentials. An AccessDeniedException is thrown if an attempt to turn on or turn off managed temporary credentials is made by an account that's not the environment owner.

Returns:

  • (String)


915
916
917
918
919
920
921
922
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/types.rb', line 915

class UpdateEnvironmentRequest < Struct.new(
  :environment_id,
  :name,
  :description,
  :managed_credentials_action)
  SENSITIVE = [:description]
  include Aws::Structure
end

#nameString

A replacement name for the environment.

Returns:

  • (String)


915
916
917
918
919
920
921
922
# File 'gems/aws-sdk-cloud9/lib/aws-sdk-cloud9/types.rb', line 915

class UpdateEnvironmentRequest < Struct.new(
  :environment_id,
  :name,
  :description,
  :managed_credentials_action)
  SENSITIVE = [:description]
  include Aws::Structure
end