Class: Aws::Proton::Types::Environment

Inherits:

Struct

• Object
• Struct
• Aws::Proton::Types::Environment

Includes:

Structure

Defined in:

lib/aws-sdk-proton/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:deployment_status_message, :description, :spec]

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the environment.

• #codebuild_role_arn ⇒ String

  The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.

• #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.

• #created_at ⇒ Time

  The time when the environment was created.

• #deployment_status ⇒ String

  The environment deployment status.

• #deployment_status_message ⇒ String

  An environment deployment status message.

• #description ⇒ String

  The description of the environment.

• #environment_account_connection_id ⇒ String

  The ID of the environment account connection that’s used to provision infrastructure resources in an environment account.

• #environment_account_id ⇒ String

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

• #last_attempted_deployment_id ⇒ String

  The ID of the last attempted deployment of this environment.

• #last_deployment_attempted_at ⇒ Time

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

• #last_deployment_succeeded_at ⇒ Time

  The time when the environment was last deployed successfully.

• #last_succeeded_deployment_id ⇒ String

  The ID of the last successful deployment of this environment.

• #name ⇒ String

  The name of the environment.

• #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.

• #provisioning ⇒ String

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

• #provisioning_repository ⇒ Types::RepositoryBranch

  The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning.

• #spec ⇒ String

  The environment spec.

• #template_major_version ⇒ String

  The major version of the environment template.

• #template_minor_version ⇒ String

  The minor version of the environment template.

• #template_name ⇒ String

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

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the environment.

Returns:

• (String)

# File 'lib/aws-sdk-proton/types.rb', line 2115

class Environment < Struct.new(
  :arn,
  :codebuild_role_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,
  :provisioning_repository,
  :spec,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description, :spec]
  include Aws::Structure
end

#codebuild_role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.

Returns:

• (String)

# File 'lib/aws-sdk-proton/types.rb', line 2115

class Environment < Struct.new(
  :arn,
  :codebuild_role_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,
  :provisioning_repository,
  :spec,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description, :spec]
  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)

# File 'lib/aws-sdk-proton/types.rb', line 2115

class Environment < Struct.new(
  :arn,
  :codebuild_role_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,
  :provisioning_repository,
  :spec,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description, :spec]
  include Aws::Structure
end

#created_at ⇒ Time

The time when the environment was created.

Returns:

• (Time)

# File 'lib/aws-sdk-proton/types.rb', line 2115

class Environment < Struct.new(
  :arn,
  :codebuild_role_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,
  :provisioning_repository,
  :spec,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description, :spec]
  include Aws::Structure
end

#deployment_status ⇒ String

The environment deployment status.

Returns:

• (String)

# File 'lib/aws-sdk-proton/types.rb', line 2115

class Environment < Struct.new(
  :arn,
  :codebuild_role_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,
  :provisioning_repository,
  :spec,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description, :spec]
  include Aws::Structure
end

#deployment_status_message ⇒ String

An environment deployment status message.

Returns:

• (String)

# File 'lib/aws-sdk-proton/types.rb', line 2115

class Environment < Struct.new(
  :arn,
  :codebuild_role_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,
  :provisioning_repository,
  :spec,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description, :spec]
  include Aws::Structure
end

#description ⇒ String

The description of the environment.

Returns:

• (String)

# File 'lib/aws-sdk-proton/types.rb', line 2115

class Environment < Struct.new(
  :arn,
  :codebuild_role_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,
  :provisioning_repository,
  :spec,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description, :spec]
  include Aws::Structure
end

#environment_account_connection_id ⇒ String

The ID of the environment account connection that’s used to provision infrastructure resources in an environment account.

Returns:

• (String)

# File 'lib/aws-sdk-proton/types.rb', line 2115

class Environment < Struct.new(
  :arn,
  :codebuild_role_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,
  :provisioning_repository,
  :spec,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description, :spec]
  include Aws::Structure
end

#environment_account_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-proton/types.rb', line 2115

class Environment < Struct.new(
  :arn,
  :codebuild_role_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,
  :provisioning_repository,
  :spec,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description, :spec]
  include Aws::Structure
end

#last_attempted_deployment_id ⇒ String

The ID of the last attempted deployment of this environment.

Returns:

• (String)

# File 'lib/aws-sdk-proton/types.rb', line 2115

class Environment < Struct.new(
  :arn,
  :codebuild_role_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,
  :provisioning_repository,
  :spec,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description, :spec]
  include Aws::Structure
end

#last_deployment_attempted_at ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-proton/types.rb', line 2115

class Environment < Struct.new(
  :arn,
  :codebuild_role_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,
  :provisioning_repository,
  :spec,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description, :spec]
  include Aws::Structure
end

#last_deployment_succeeded_at ⇒ Time

The time when the environment was last deployed successfully.

Returns:

• (Time)

# File 'lib/aws-sdk-proton/types.rb', line 2115

class Environment < Struct.new(
  :arn,
  :codebuild_role_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,
  :provisioning_repository,
  :spec,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description, :spec]
  include Aws::Structure
end

#last_succeeded_deployment_id ⇒ String

The ID of the last successful deployment of this environment.

Returns:

• (String)

# File 'lib/aws-sdk-proton/types.rb', line 2115

class Environment < Struct.new(
  :arn,
  :codebuild_role_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,
  :provisioning_repository,
  :spec,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description, :spec]
  include Aws::Structure
end

#name ⇒ String

The name of the environment.

Returns:

• (String)

# File 'lib/aws-sdk-proton/types.rb', line 2115

class Environment < Struct.new(
  :arn,
  :codebuild_role_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,
  :provisioning_repository,
  :spec,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description, :spec]
  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)

# File 'lib/aws-sdk-proton/types.rb', line 2115

class Environment < Struct.new(
  :arn,
  :codebuild_role_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,
  :provisioning_repository,
  :spec,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description, :spec]
  include Aws::Structure
end

#provisioning ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-proton/types.rb', line 2115

class Environment < Struct.new(
  :arn,
  :codebuild_role_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,
  :provisioning_repository,
  :spec,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description, :spec]
  include Aws::Structure
end

#provisioning_repository ⇒ Types::RepositoryBranch

The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see [CreateRepository].

[1]: docs.aws.amazon.com/proton/latest/APIReference/API_CreateRepository.html

Returns:

• (Types::RepositoryBranch)

# File 'lib/aws-sdk-proton/types.rb', line 2115

class Environment < Struct.new(
  :arn,
  :codebuild_role_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,
  :provisioning_repository,
  :spec,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description, :spec]
  include Aws::Structure
end

#spec ⇒ String

The environment spec.

Returns:

• (String)

# File 'lib/aws-sdk-proton/types.rb', line 2115

class Environment < Struct.new(
  :arn,
  :codebuild_role_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,
  :provisioning_repository,
  :spec,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description, :spec]
  include Aws::Structure
end

#template_major_version ⇒ String

The major version of the environment template.

Returns:

• (String)

# File 'lib/aws-sdk-proton/types.rb', line 2115

class Environment < Struct.new(
  :arn,
  :codebuild_role_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,
  :provisioning_repository,
  :spec,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description, :spec]
  include Aws::Structure
end

#template_minor_version ⇒ String

The minor version of the environment template.

Returns:

• (String)

# File 'lib/aws-sdk-proton/types.rb', line 2115

class Environment < Struct.new(
  :arn,
  :codebuild_role_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,
  :provisioning_repository,
  :spec,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description, :spec]
  include Aws::Structure
end

#template_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-proton/types.rb', line 2115

class Environment < Struct.new(
  :arn,
  :codebuild_role_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,
  :provisioning_repository,
  :spec,
  :template_major_version,
  :template_minor_version,
  :template_name)
  SENSITIVE = [:deployment_status_message, :description, :spec]
  include Aws::Structure
end