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

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

Overview

Note:

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

{
  component_role_arn: "Arn",
  deployment_type: "NONE", # required, accepts NONE, CURRENT_VERSION, MINOR_VERSION, MAJOR_VERSION
  description: "Description",
  environment_account_connection_id: "EnvironmentAccountConnectionId",
  name: "ResourceName", # required
  proton_service_role_arn: "Arn",
  provisioning_repository: {
    branch: "GitBranchName", # required
    name: "RepositoryName", # required
    provider: "GITHUB", # required, accepts GITHUB, GITHUB_ENTERPRISE, BITBUCKET
  },
  spec: "SpecContents",
  template_major_version: "TemplateVersionPart",
  template_minor_version: "TemplateVersionPart",
}

Constant Summary collapse

SENSITIVE =
[:description, :spec]

Instance Attribute Summary collapse

Instance Attribute Details

#component_role_arnString

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 Administrator Guide.

Returns:

  • (String)


5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 5609

class UpdateEnvironmentInput < Struct.new(
  :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_typeString

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)


5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 5609

class UpdateEnvironmentInput < Struct.new(
  :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

#descriptionString

A description of the environment update.

Returns:

  • (String)


5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 5609

class UpdateEnvironmentInput < Struct.new(
  :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_idString

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)


5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 5609

class UpdateEnvironmentInput < Struct.new(
  :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

#nameString

The name of the environment to update.

Returns:

  • (String)


5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 5609

class UpdateEnvironmentInput < Struct.new(
  :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_arnString

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

Returns:

  • (String)


5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 5609

class UpdateEnvironmentInput < Struct.new(
  :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_repositoryTypes::RepositoryBranchInput

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



5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 5609

class UpdateEnvironmentInput < Struct.new(
  :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

#specString

The formatted specification that defines the update.

Returns:

  • (String)


5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 5609

class UpdateEnvironmentInput < Struct.new(
  :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_versionString

The major version of the environment to update.

Returns:

  • (String)


5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 5609

class UpdateEnvironmentInput < Struct.new(
  :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_versionString

The minor version of the environment to update.

Returns:

  • (String)


5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 5609

class UpdateEnvironmentInput < Struct.new(
  :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