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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:description, :spec]

Instance Attribute Summary collapse

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.

To use CodeBuild-based provisioning for the environment or for any service instance running in the environment, specify either the ‘environmentAccountConnectionId` or `codebuildRoleArn` parameter.

Returns:

  • (String) 


821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-proton/types.rb', line 821

class CreateEnvironmentInput < Struct.new(
  :codebuild_role_arn,
  :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

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

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 User Guide*.

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

Returns:

  • (String) 


821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-proton/types.rb', line 821

class CreateEnvironmentInput < Struct.new(
  :codebuild_role_arn,
  :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

#description ⇒ String

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

Returns:

  • (String) 


821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-proton/types.rb', line 821

class CreateEnvironmentInput < Struct.new(
  :codebuild_role_arn,
  :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_id ⇒ String

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 User guide*.

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

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

Returns:

  • (String) 


821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-proton/types.rb', line 821

class CreateEnvironmentInput < Struct.new(
  :codebuild_role_arn,
  :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

#name ⇒ String

The name of the environment.

Returns:

  • (String) 


821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-proton/types.rb', line 821

class CreateEnvironmentInput < Struct.new(
  :codebuild_role_arn,
  :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_arn ⇒ String

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) 


821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-proton/types.rb', line 821

class CreateEnvironmentInput < Struct.new(
  :codebuild_role_arn,
  :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_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.

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

Returns:



821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-proton/types.rb', line 821

class CreateEnvironmentInput < Struct.new(
  :codebuild_role_arn,
  :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

#spec ⇒ String

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

Environments][1

in the *Proton User Guide*.

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

Returns:

  • (String) 


821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-proton/types.rb', line 821

class CreateEnvironmentInput < Struct.new(
  :codebuild_role_arn,
  :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

#tags ⇒ Array<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 User Guide*.

[1]: docs.aws.amazon.com/proton/latest/userguide/resources.html

Returns:



821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-proton/types.rb', line 821

class CreateEnvironmentInput < Struct.new(
  :codebuild_role_arn,
  :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_version ⇒ String

The major version of the environment template.

Returns:

  • (String) 


821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-proton/types.rb', line 821

class CreateEnvironmentInput < Struct.new(
  :codebuild_role_arn,
  :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_version ⇒ String

The minor version of the environment template.

Returns:

  • (String) 


821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-proton/types.rb', line 821

class CreateEnvironmentInput < Struct.new(
  :codebuild_role_arn,
  :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_name ⇒ String

The name of the environment template. For more information, see

Environment Templates][1

in the *Proton User Guide*.

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

Returns:

  • (String) 


821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-proton/types.rb', line 821

class CreateEnvironmentInput < Struct.new(
  :codebuild_role_arn,
  :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