Class: Aws::Proton::Types::EnvironmentSummary

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-proton/types.rb

Overview

Summary data of an Proton environment resource. An Proton environment is a set of resources shared across Proton services.

See Also:

Constant Summary collapse

SENSITIVE = 
[:deployment_status_message, :description]

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the environment.

Returns:

  • (String) 


2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
 
# File 'lib/aws-sdk-proton/types.rb', line 2431

class EnvironmentSummary < Struct.new(
  :arn,
  :component_role_arn,
  :created_at,
  :deployment_status,
  :deployment_status_message,
  :description,
  :environment_account_connection_id,
  :environment_account_id,
  :last_attempted_deployment_id,
  :last_deployment_attempted_at,
  :last_deployment_succeeded_at,
  :last_succeeded_deployment_id,
  :name,
  :proton_service_role_arn,
  :provisioning,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description]
  include Aws::Structure
end

#component_role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.

The environment must have a ‘componentRoleArn` to allow directly defined components to be associated with the environment.

For more information about components, see [Proton components] in the *Proton User Guide*.

[1]: docs.aws.amazon.com/proton/latest/userguide/ag-components.html

Returns:

  • (String) 


2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
 
# File 'lib/aws-sdk-proton/types.rb', line 2431

class EnvironmentSummary < Struct.new(
  :arn,
  :component_role_arn,
  :created_at,
  :deployment_status,
  :deployment_status_message,
  :description,
  :environment_account_connection_id,
  :environment_account_id,
  :last_attempted_deployment_id,
  :last_deployment_attempted_at,
  :last_deployment_succeeded_at,
  :last_succeeded_deployment_id,
  :name,
  :proton_service_role_arn,
  :provisioning,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description]
  include Aws::Structure
end

#created_at ⇒ Time

The time when the environment was created.

Returns:

  • (Time) 


2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
 
# File 'lib/aws-sdk-proton/types.rb', line 2431

class EnvironmentSummary < Struct.new(
  :arn,
  :component_role_arn,
  :created_at,
  :deployment_status,
  :deployment_status_message,
  :description,
  :environment_account_connection_id,
  :environment_account_id,
  :last_attempted_deployment_id,
  :last_deployment_attempted_at,
  :last_deployment_succeeded_at,
  :last_succeeded_deployment_id,
  :name,
  :proton_service_role_arn,
  :provisioning,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description]
  include Aws::Structure
end

#deployment_status ⇒ String

The environment deployment status.

Returns:

  • (String) 


2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
 
# File 'lib/aws-sdk-proton/types.rb', line 2431

class EnvironmentSummary < Struct.new(
  :arn,
  :component_role_arn,
  :created_at,
  :deployment_status,
  :deployment_status_message,
  :description,
  :environment_account_connection_id,
  :environment_account_id,
  :last_attempted_deployment_id,
  :last_deployment_attempted_at,
  :last_deployment_succeeded_at,
  :last_succeeded_deployment_id,
  :name,
  :proton_service_role_arn,
  :provisioning,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description]
  include Aws::Structure
end

#deployment_status_message ⇒ String

An environment deployment status message.

Returns:

  • (String) 


2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
 
# File 'lib/aws-sdk-proton/types.rb', line 2431

class EnvironmentSummary < Struct.new(
  :arn,
  :component_role_arn,
  :created_at,
  :deployment_status,
  :deployment_status_message,
  :description,
  :environment_account_connection_id,
  :environment_account_id,
  :last_attempted_deployment_id,
  :last_deployment_attempted_at,
  :last_deployment_succeeded_at,
  :last_succeeded_deployment_id,
  :name,
  :proton_service_role_arn,
  :provisioning,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description]
  include Aws::Structure
end

#description ⇒ String

The description of the environment.

Returns:

  • (String) 


2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
 
# File 'lib/aws-sdk-proton/types.rb', line 2431

class EnvironmentSummary < Struct.new(
  :arn,
  :component_role_arn,
  :created_at,
  :deployment_status,
  :deployment_status_message,
  :description,
  :environment_account_connection_id,
  :environment_account_id,
  :last_attempted_deployment_id,
  :last_deployment_attempted_at,
  :last_deployment_succeeded_at,
  :last_succeeded_deployment_id,
  :name,
  :proton_service_role_arn,
  :provisioning,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description]
  include Aws::Structure
end

#environment_account_connection_id ⇒ String

The ID of the environment account connection that the environment is associated with.

Returns:

  • (String) 


2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
 
# File 'lib/aws-sdk-proton/types.rb', line 2431

class EnvironmentSummary < Struct.new(
  :arn,
  :component_role_arn,
  :created_at,
  :deployment_status,
  :deployment_status_message,
  :description,
  :environment_account_connection_id,
  :environment_account_id,
  :last_attempted_deployment_id,
  :last_deployment_attempted_at,
  :last_deployment_succeeded_at,
  :last_succeeded_deployment_id,
  :name,
  :proton_service_role_arn,
  :provisioning,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description]
  include Aws::Structure
end

#environment_account_id ⇒ String

The ID of the environment account that the environment infrastructure resources are provisioned in.

Returns:

  • (String) 


2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
 
# File 'lib/aws-sdk-proton/types.rb', line 2431

class EnvironmentSummary < Struct.new(
  :arn,
  :component_role_arn,
  :created_at,
  :deployment_status,
  :deployment_status_message,
  :description,
  :environment_account_connection_id,
  :environment_account_id,
  :last_attempted_deployment_id,
  :last_deployment_attempted_at,
  :last_deployment_succeeded_at,
  :last_succeeded_deployment_id,
  :name,
  :proton_service_role_arn,
  :provisioning,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description]
  include Aws::Structure
end

#last_attempted_deployment_id ⇒ String

The ID of the last attempted deployment of this environment.

Returns:

  • (String) 


2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
 
# File 'lib/aws-sdk-proton/types.rb', line 2431

class EnvironmentSummary < Struct.new(
  :arn,
  :component_role_arn,
  :created_at,
  :deployment_status,
  :deployment_status_message,
  :description,
  :environment_account_connection_id,
  :environment_account_id,
  :last_attempted_deployment_id,
  :last_deployment_attempted_at,
  :last_deployment_succeeded_at,
  :last_succeeded_deployment_id,
  :name,
  :proton_service_role_arn,
  :provisioning,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description]
  include Aws::Structure
end

#last_deployment_attempted_at ⇒ Time

The time when a deployment of the environment was last attempted.

Returns:

  • (Time) 


2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
 
# File 'lib/aws-sdk-proton/types.rb', line 2431

class EnvironmentSummary < Struct.new(
  :arn,
  :component_role_arn,
  :created_at,
  :deployment_status,
  :deployment_status_message,
  :description,
  :environment_account_connection_id,
  :environment_account_id,
  :last_attempted_deployment_id,
  :last_deployment_attempted_at,
  :last_deployment_succeeded_at,
  :last_succeeded_deployment_id,
  :name,
  :proton_service_role_arn,
  :provisioning,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description]
  include Aws::Structure
end

#last_deployment_succeeded_at ⇒ Time

The time when the environment was last deployed successfully.

Returns:

  • (Time) 


2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
 
# File 'lib/aws-sdk-proton/types.rb', line 2431

class EnvironmentSummary < Struct.new(
  :arn,
  :component_role_arn,
  :created_at,
  :deployment_status,
  :deployment_status_message,
  :description,
  :environment_account_connection_id,
  :environment_account_id,
  :last_attempted_deployment_id,
  :last_deployment_attempted_at,
  :last_deployment_succeeded_at,
  :last_succeeded_deployment_id,
  :name,
  :proton_service_role_arn,
  :provisioning,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description]
  include Aws::Structure
end

#last_succeeded_deployment_id ⇒ String

The ID of the last successful deployment of this environment.

Returns:

  • (String) 


2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
 
# File 'lib/aws-sdk-proton/types.rb', line 2431

class EnvironmentSummary < Struct.new(
  :arn,
  :component_role_arn,
  :created_at,
  :deployment_status,
  :deployment_status_message,
  :description,
  :environment_account_connection_id,
  :environment_account_id,
  :last_attempted_deployment_id,
  :last_deployment_attempted_at,
  :last_deployment_succeeded_at,
  :last_succeeded_deployment_id,
  :name,
  :proton_service_role_arn,
  :provisioning,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description]
  include Aws::Structure
end

#name ⇒ String

The name of the environment.

Returns:

  • (String) 


2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
 
# File 'lib/aws-sdk-proton/types.rb', line 2431

class EnvironmentSummary < Struct.new(
  :arn,
  :component_role_arn,
  :created_at,
  :deployment_status,
  :deployment_status_message,
  :description,
  :environment_account_connection_id,
  :environment_account_id,
  :last_attempted_deployment_id,
  :last_deployment_attempted_at,
  :last_deployment_succeeded_at,
  :last_succeeded_deployment_id,
  :name,
  :proton_service_role_arn,
  :provisioning,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description]
  include Aws::Structure
end

#proton_service_role_arn ⇒ String

The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.

Returns:

  • (String) 


2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
 
# File 'lib/aws-sdk-proton/types.rb', line 2431

class EnvironmentSummary < Struct.new(
  :arn,
  :component_role_arn,
  :created_at,
  :deployment_status,
  :deployment_status_message,
  :description,
  :environment_account_connection_id,
  :environment_account_id,
  :last_attempted_deployment_id,
  :last_deployment_attempted_at,
  :last_deployment_succeeded_at,
  :last_succeeded_deployment_id,
  :name,
  :proton_service_role_arn,
  :provisioning,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description]
  include Aws::Structure
end

#provisioning ⇒ String

When included, indicates that the environment template is for customer provisioned and managed infrastructure.

Returns:

  • (String) 


2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
 
# File 'lib/aws-sdk-proton/types.rb', line 2431

class EnvironmentSummary < Struct.new(
  :arn,
  :component_role_arn,
  :created_at,
  :deployment_status,
  :deployment_status_message,
  :description,
  :environment_account_connection_id,
  :environment_account_id,
  :last_attempted_deployment_id,
  :last_deployment_attempted_at,
  :last_deployment_succeeded_at,
  :last_succeeded_deployment_id,
  :name,
  :proton_service_role_arn,
  :provisioning,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description]
  include Aws::Structure
end

#template_major_version ⇒ String

The major version of the environment template.

Returns:

  • (String) 


2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
 
# File 'lib/aws-sdk-proton/types.rb', line 2431

class EnvironmentSummary < Struct.new(
  :arn,
  :component_role_arn,
  :created_at,
  :deployment_status,
  :deployment_status_message,
  :description,
  :environment_account_connection_id,
  :environment_account_id,
  :last_attempted_deployment_id,
  :last_deployment_attempted_at,
  :last_deployment_succeeded_at,
  :last_succeeded_deployment_id,
  :name,
  :proton_service_role_arn,
  :provisioning,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description]
  include Aws::Structure
end

#template_minor_version ⇒ String

The minor version of the environment template.

Returns:

  • (String) 


2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
 
# File 'lib/aws-sdk-proton/types.rb', line 2431

class EnvironmentSummary < Struct.new(
  :arn,
  :component_role_arn,
  :created_at,
  :deployment_status,
  :deployment_status_message,
  :description,
  :environment_account_connection_id,
  :environment_account_id,
  :last_attempted_deployment_id,
  :last_deployment_attempted_at,
  :last_deployment_succeeded_at,
  :last_succeeded_deployment_id,
  :name,
  :proton_service_role_arn,
  :provisioning,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description]
  include Aws::Structure
end

#template_name ⇒ String

The name of the environment template.

Returns:

  • (String) 


2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
 
# File 'lib/aws-sdk-proton/types.rb', line 2431

class EnvironmentSummary < Struct.new(
  :arn,
  :component_role_arn,
  :created_at,
  :deployment_status,
  :deployment_status_message,
  :description,
  :environment_account_connection_id,
  :environment_account_id,
  :last_attempted_deployment_id,
  :last_deployment_attempted_at,
  :last_deployment_succeeded_at,
  :last_succeeded_deployment_id,
  :name,
  :proton_service_role_arn,
  :provisioning,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description]
  include Aws::Structure
end