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:

{
  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

#descriptionString

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

Returns:

  • (String)


440
441
442
443
444
445
446
447
448
449
450
451
452
453
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 440

class CreateEnvironmentInput < Struct.new(
  :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. You must include either the environmentAccountConnectionId or protonServiceRoleArn parameter and value and omit the provisioningRepository parameter and values. For more information, see Environment account connections in the Proton Administrator guide.

Returns:

  • (String)


440
441
442
443
444
445
446
447
448
449
450
451
452
453
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 440

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


440
441
442
443
444
445
446
447
448
449
450
451
452
453
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 440

class CreateEnvironmentInput < Struct.new(
  :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. You must include either the environmentAccountConnectionId or protonServiceRoleArn parameter and value and omit the provisioningRepository parameter when you use standard provisioning.

Returns:

  • (String)


440
441
442
443
444
445
446
447
448
449
450
451
452
453
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 440

class CreateEnvironmentInput < Struct.new(
  :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 repository that you provide with pull request provisioning. If you provide this parameter, you must omit the environmentAccountConnectionId and protonServiceRoleArn parameters.

Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.



440
441
442
443
444
445
446
447
448
449
450
451
452
453
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 440

class CreateEnvironmentInput < Struct.new(
  :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 link to a YAML formatted spec file that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the Proton Administrator Guide.

Returns:

  • (String)


440
441
442
443
444
445
446
447
448
449
450
451
452
453
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 440

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

Create tags for your environment. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.

Returns:



440
441
442
443
444
445
446
447
448
449
450
451
452
453
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 440

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


440
441
442
443
444
445
446
447
448
449
450
451
452
453
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 440

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


440
441
442
443
444
445
446
447
448
449
450
451
452
453
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 440

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


440
441
442
443
444
445
446
447
448
449
450
451
452
453
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 440

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