Class: Aws::Proton::Types::CreateEnvironmentInput

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 CreateEnvironmentInput data as a hash:

{
  component_role_arn: "Arn",
  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", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  template_major_version: "TemplateVersionPart", # required
  template_minor_version: "TemplateVersionPart",
  template_name: "ResourceName", # required
}

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.

You must specify componentRoleArn to allow directly defined components to be associated with this environment.

For more information about components, see Proton components in the Proton Administrator Guide.

Returns:

  • (String)


777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 777

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

#descriptionString

A description of the environment that's being created and deployed.

Returns:

  • (String)


777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 777

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

#environment_account_connection_idString

The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment account. For more information, see Environment account connections in the Proton Administrator guide.

To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.

Returns:

  • (String)


777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 777

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

#nameString

The name of the environment.

Returns:

  • (String)


777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 777

class CreateEnvironmentInput < Struct.new(
  :component_role_arn,
  :description,
  :environment_account_connection_id,
  :name,
  :proton_service_role_arn,
  :provisioning_repository,
  :spec,
  :tags,
  :template_major_version,
  :template_minor_version,
  :template_name)
  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 calls to other services on your behalf.

To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.

Returns:

  • (String)


777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 777

class CreateEnvironmentInput < Struct.new(
  :component_role_arn,
  :description,
  :environment_account_connection_id,
  :name,
  :proton_service_role_arn,
  :provisioning_repository,
  :spec,
  :tags,
  :template_major_version,
  :template_minor_version,
  :template_name)
  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.

To use self-managed provisioning for the environment, specify this parameter and omit the environmentAccountConnectionId and protonServiceRoleArn parameters.



777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 777

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

#specString

A YAML formatted string that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the Proton Administrator Guide.

Returns:

  • (String)


777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 777

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

#tagsArray<Types::Tag>

An optional list of metadata items that you can associate with the Proton environment. A tag is a key-value pair.

For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.

Returns:



777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 777

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

#template_major_versionString

The major version of the environment template.

Returns:

  • (String)


777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 777

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

#template_minor_versionString

The minor version of the environment template.

Returns:

  • (String)


777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 777

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

#template_nameString

The name of the environment template. For more information, see Environment Templates in the Proton Administrator Guide.

Returns:

  • (String)


777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 777

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