Class: Aws::Proton::Types::UpdateEnvironmentInput

Inherits:

Struct

• Object
• Struct
• Aws::Proton::Types::UpdateEnvironmentInput

Includes:

Structure

Defined in:

lib/aws-sdk-proton/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:description, :spec]

Instance Attribute Summary

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

• #deployment_type ⇒ String

  There are four modes for updating an environment.

• #description ⇒ String

  A description of the environment update.

• #environment_account_connection_id ⇒ String

  The ID of the environment account connection.

• #name ⇒ String

  The name of the environment to update.

• #proton_service_role_arn ⇒ String

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

• #provisioning_repository ⇒ Types::RepositoryBranchInput

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

• #spec ⇒ String

  The formatted specification that defines the update.

• #template_major_version ⇒ String

  The major version of the environment to update.

• #template_minor_version ⇒ String

  The minor version of the environment to update.

Instance Attribute Details

#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 6121

class UpdateEnvironmentInput < Struct.new(
  :codebuild_role_arn,
  :component_role_arn,
  :deployment_type,
  :description,
  :environment_account_connection_id,
  :name,
  :proton_service_role_arn,
  :provisioning_repository,
  :spec,
  :template_major_version,
  :template_minor_version)
  SENSITIVE = [: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 6121

class UpdateEnvironmentInput < Struct.new(
  :codebuild_role_arn,
  :component_role_arn,
  :deployment_type,
  :description,
  :environment_account_connection_id,
  :name,
  :proton_service_role_arn,
  :provisioning_repository,
  :spec,
  :template_major_version,
  :template_minor_version)
  SENSITIVE = [:description, :spec]
  include Aws::Structure
end

#deployment_type ⇒ String

There are four modes for updating an environment. The ‘deploymentType` field defines the mode.

: ‘NONE`

In this mode, a deployment *doesn't* occur. Only the requested
metadata parameters are updated.

: ‘CURRENT_VERSION`

In this mode, the environment is deployed and updated with the new
spec that you provide. Only requested parameters are updated.
*Don’t* include major or minor version parameters when you use
this `deployment-type`.

: ‘MINOR_VERSION`

In this mode, the environment is deployed and updated with the
published, recommended (latest) minor version of the current major
version in use, by default. You can also specify a different minor
version of the current major version in use.

: ‘MAJOR_VERSION`

In this mode, the environment is deployed and updated with the
published, recommended (latest) major and minor version of the
current template, by default. You can also specify a different
major version that is higher than the major version in use and a
minor version (optional).

Returns:

• (String)

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

class UpdateEnvironmentInput < Struct.new(
  :codebuild_role_arn,
  :component_role_arn,
  :deployment_type,
  :description,
  :environment_account_connection_id,
  :name,
  :proton_service_role_arn,
  :provisioning_repository,
  :spec,
  :template_major_version,
  :template_minor_version)
  SENSITIVE = [:description, :spec]
  include Aws::Structure
end

#description ⇒ String

A description of the environment update.

Returns:

• (String)

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

class UpdateEnvironmentInput < Struct.new(
  :codebuild_role_arn,
  :component_role_arn,
  :deployment_type,
  :description,
  :environment_account_connection_id,
  :name,
  :proton_service_role_arn,
  :provisioning_repository,
  :spec,
  :template_major_version,
  :template_minor_version)
  SENSITIVE = [:description, :spec]
  include Aws::Structure
end

#environment_account_connection_id ⇒ String

The ID of the environment account connection.

You can only update to a new environment account connection if it was created in the same environment account that the current environment account connection was created in and is associated with the current environment.

Returns:

• (String)

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

class UpdateEnvironmentInput < Struct.new(
  :codebuild_role_arn,
  :component_role_arn,
  :deployment_type,
  :description,
  :environment_account_connection_id,
  :name,
  :proton_service_role_arn,
  :provisioning_repository,
  :spec,
  :template_major_version,
  :template_minor_version)
  SENSITIVE = [:description, :spec]
  include Aws::Structure
end

#name ⇒ String

The name of the environment to update.

Returns:

• (String)

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

class UpdateEnvironmentInput < Struct.new(
  :codebuild_role_arn,
  :component_role_arn,
  :deployment_type,
  :description,
  :environment_account_connection_id,
  :name,
  :proton_service_role_arn,
  :provisioning_repository,
  :spec,
  :template_major_version,
  :template_minor_version)
  SENSITIVE = [: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 API calls to other services your behalf.

Returns:

• (String)

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

class UpdateEnvironmentInput < Struct.new(
  :codebuild_role_arn,
  :component_role_arn,
  :deployment_type,
  :description,
  :environment_account_connection_id,
  :name,
  :proton_service_role_arn,
  :provisioning_repository,
  :spec,
  :template_major_version,
  :template_minor_version)
  SENSITIVE = [:description, :spec]
  include Aws::Structure
end

#provisioning_repository ⇒ Types::RepositoryBranchInput

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.

Returns:

• (Types::RepositoryBranchInput)

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

class UpdateEnvironmentInput < Struct.new(
  :codebuild_role_arn,
  :component_role_arn,
  :deployment_type,
  :description,
  :environment_account_connection_id,
  :name,
  :proton_service_role_arn,
  :provisioning_repository,
  :spec,
  :template_major_version,
  :template_minor_version)
  SENSITIVE = [:description, :spec]
  include Aws::Structure
end

#spec ⇒ String

The formatted specification that defines the update.

Returns:

• (String)

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

class UpdateEnvironmentInput < Struct.new(
  :codebuild_role_arn,
  :component_role_arn,
  :deployment_type,
  :description,
  :environment_account_connection_id,
  :name,
  :proton_service_role_arn,
  :provisioning_repository,
  :spec,
  :template_major_version,
  :template_minor_version)
  SENSITIVE = [:description, :spec]
  include Aws::Structure
end

#template_major_version ⇒ String

The major version of the environment to update.

Returns:

• (String)

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

class UpdateEnvironmentInput < Struct.new(
  :codebuild_role_arn,
  :component_role_arn,
  :deployment_type,
  :description,
  :environment_account_connection_id,
  :name,
  :proton_service_role_arn,
  :provisioning_repository,
  :spec,
  :template_major_version,
  :template_minor_version)
  SENSITIVE = [:description, :spec]
  include Aws::Structure
end

#template_minor_version ⇒ String

The minor version of the environment to update.

Returns:

• (String)

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

class UpdateEnvironmentInput < Struct.new(
  :codebuild_role_arn,
  :component_role_arn,
  :deployment_type,
  :description,
  :environment_account_connection_id,
  :name,
  :proton_service_role_arn,
  :provisioning_repository,
  :spec,
  :template_major_version,
  :template_minor_version)
  SENSITIVE = [:description, :spec]
  include Aws::Structure
end