Class: Aws::Proton::Types::CreateServiceTemplateVersionInput

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

{
  client_token: "ClientToken",
  compatible_environment_templates: [ # required
    {
      major_version: "TemplateVersionPart", # required
      template_name: "ResourceName", # required
    },
  ],
  description: "Description",
  major_version: "TemplateVersionPart",
  source: { # required
    s3: {
      bucket: "S3Bucket", # required
      key: "S3Key", # required
    },
  },
  supported_component_sources: ["DIRECTLY_DEFINED"], # accepts DIRECTLY_DEFINED
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  template_name: "ResourceName", # required
}

Constant Summary collapse

SENSITIVE =
[:description]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

When included, if two identical requests are made with the same client token, Proton returns the service template version that the first request created.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 1349

class CreateServiceTemplateVersionInput < Struct.new(
  :client_token,
  :compatible_environment_templates,
  :description,
  :major_version,
  :source,
  :supported_component_sources,
  :tags,
  :template_name)
  SENSITIVE = [:description]
  include Aws::Structure
end

#compatible_environment_templatesArray<Types::CompatibleEnvironmentTemplateInput>

An array of environment template objects that are compatible with the new service template version. A service instance based on this service template version can run in environments based on compatible templates.



1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 1349

class CreateServiceTemplateVersionInput < Struct.new(
  :client_token,
  :compatible_environment_templates,
  :description,
  :major_version,
  :source,
  :supported_component_sources,
  :tags,
  :template_name)
  SENSITIVE = [:description]
  include Aws::Structure
end

#descriptionString

A description of the new version of a service template.

Returns:

  • (String)


1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 1349

class CreateServiceTemplateVersionInput < Struct.new(
  :client_token,
  :compatible_environment_templates,
  :description,
  :major_version,
  :source,
  :supported_component_sources,
  :tags,
  :template_name)
  SENSITIVE = [:description]
  include Aws::Structure
end

#major_versionString

To create a new minor version of the service template, include a major Version.

To create a new major and minor version of the service template, exclude major Version.

Returns:

  • (String)


1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 1349

class CreateServiceTemplateVersionInput < Struct.new(
  :client_token,
  :compatible_environment_templates,
  :description,
  :major_version,
  :source,
  :supported_component_sources,
  :tags,
  :template_name)
  SENSITIVE = [:description]
  include Aws::Structure
end

#sourceTypes::TemplateVersionSourceInput

An object that includes the template bundle S3 bucket path and name for the new version of a service template.



1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 1349

class CreateServiceTemplateVersionInput < Struct.new(
  :client_token,
  :compatible_environment_templates,
  :description,
  :major_version,
  :source,
  :supported_component_sources,
  :tags,
  :template_name)
  SENSITIVE = [:description]
  include Aws::Structure
end

#supported_component_sourcesArray<String>

An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.

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

Returns:

  • (Array<String>)


1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 1349

class CreateServiceTemplateVersionInput < Struct.new(
  :client_token,
  :compatible_environment_templates,
  :description,
  :major_version,
  :source,
  :supported_component_sources,
  :tags,
  :template_name)
  SENSITIVE = [:description]
  include Aws::Structure
end

#tagsArray<Types::Tag>

An optional list of metadata items that you can associate with the Proton service template version. 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:



1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 1349

class CreateServiceTemplateVersionInput < Struct.new(
  :client_token,
  :compatible_environment_templates,
  :description,
  :major_version,
  :source,
  :supported_component_sources,
  :tags,
  :template_name)
  SENSITIVE = [:description]
  include Aws::Structure
end

#template_nameString

The name of the service template.

Returns:

  • (String)


1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 1349

class CreateServiceTemplateVersionInput < Struct.new(
  :client_token,
  :compatible_environment_templates,
  :description,
  :major_version,
  :source,
  :supported_component_sources,
  :tags,
  :template_name)
  SENSITIVE = [:description]
  include Aws::Structure
end