Class: Aws::ECR::Types::CreateRepositoryCreationTemplateRequest

Inherits:

Struct

• Object
• Struct
• Aws::ECR::Types::CreateRepositoryCreationTemplateRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ecr/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #applied_for ⇒ Array<String>

  A list of enumerable strings representing the Amazon ECR repository creation scenarios that this template will apply towards.

• #custom_role_arn ⇒ String

  The ARN of the role to be assumed by Amazon ECR.

• #description ⇒ String

  A description for the repository creation template.

• #encryption_configuration ⇒ Types::EncryptionConfigurationForRepositoryCreationTemplate

  The encryption configuration to use for repositories created using the template.

• #image_tag_mutability ⇒ String

  The tag mutability setting for the repository.

• #lifecycle_policy ⇒ String

  The lifecycle policy to use for repositories created using the template.

• #prefix ⇒ String

  The repository namespace prefix to associate with the template.

• #repository_policy ⇒ String

  The repository policy to apply to repositories created using the template.

• #resource_tags ⇒ Array<Types::Tag>

  The metadata to apply to the repository to help you categorize and organize.

Instance Attribute Details

#applied_for ⇒ Array<String>

A list of enumerable strings representing the Amazon ECR repository creation scenarios that this template will apply towards. The two supported scenarios are ‘PULL_THROUGH_CACHE` and `REPLICATION`

Returns:

• (Array<String>)

# File 'lib/aws-sdk-ecr/types.rb', line 541

class CreateRepositoryCreationTemplateRequest < Struct.new(
  :prefix,
  :description,
  :encryption_configuration,
  :resource_tags,
  :image_tag_mutability,
  :repository_policy,
  :lifecycle_policy,
  :applied_for,
  :custom_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#custom_role_arn ⇒ String

The ARN of the role to be assumed by Amazon ECR. This role must be in the same account as the registry that you are configuring. Amazon ECR will assume your supplied role when the customRoleArn is specified. When this field isn’t specified, Amazon ECR will use the service-linked role for the repository creation template.

Returns:

• (String)

# File 'lib/aws-sdk-ecr/types.rb', line 541

class CreateRepositoryCreationTemplateRequest < Struct.new(
  :prefix,
  :description,
  :encryption_configuration,
  :resource_tags,
  :image_tag_mutability,
  :repository_policy,
  :lifecycle_policy,
  :applied_for,
  :custom_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description for the repository creation template.

Returns:

• (String)

# File 'lib/aws-sdk-ecr/types.rb', line 541

class CreateRepositoryCreationTemplateRequest < Struct.new(
  :prefix,
  :description,
  :encryption_configuration,
  :resource_tags,
  :image_tag_mutability,
  :repository_policy,
  :lifecycle_policy,
  :applied_for,
  :custom_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_configuration ⇒ Types::EncryptionConfigurationForRepositoryCreationTemplate

The encryption configuration to use for repositories created using the template.

Returns:

• (Types::EncryptionConfigurationForRepositoryCreationTemplate)

# File 'lib/aws-sdk-ecr/types.rb', line 541

class CreateRepositoryCreationTemplateRequest < Struct.new(
  :prefix,
  :description,
  :encryption_configuration,
  :resource_tags,
  :image_tag_mutability,
  :repository_policy,
  :lifecycle_policy,
  :applied_for,
  :custom_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#image_tag_mutability ⇒ String

The tag mutability setting for the repository. If this parameter is omitted, the default setting of ‘MUTABLE` will be used which will allow image tags to be overwritten. If `IMMUTABLE` is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.

Returns:

• (String)

# File 'lib/aws-sdk-ecr/types.rb', line 541

class CreateRepositoryCreationTemplateRequest < Struct.new(
  :prefix,
  :description,
  :encryption_configuration,
  :resource_tags,
  :image_tag_mutability,
  :repository_policy,
  :lifecycle_policy,
  :applied_for,
  :custom_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#lifecycle_policy ⇒ String

The lifecycle policy to use for repositories created using the template.

Returns:

• (String)

# File 'lib/aws-sdk-ecr/types.rb', line 541

class CreateRepositoryCreationTemplateRequest < Struct.new(
  :prefix,
  :description,
  :encryption_configuration,
  :resource_tags,
  :image_tag_mutability,
  :repository_policy,
  :lifecycle_policy,
  :applied_for,
  :custom_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#prefix ⇒ String

The repository namespace prefix to associate with the template. All repositories created using this namespace prefix will have the settings defined in this template applied. For example, a prefix of ‘prod` would apply to all repositories beginning with `prod/`. Similarly, a prefix of `prod/team` would apply to all repositories beginning with `prod/team/`.

To apply a template to all repositories in your registry that don’t have an associated creation template, you can use ‘ROOT` as the prefix.

There is always an assumed ‘/` applied to the end of the prefix. If you specify `ecr-public` as the prefix, Amazon ECR treats that as `ecr-public/`. When using a pull through cache rule, the repository prefix you specify during rule creation is what you should specify as your repository creation template prefix as well.

Returns:

• (String)

# File 'lib/aws-sdk-ecr/types.rb', line 541

class CreateRepositoryCreationTemplateRequest < Struct.new(
  :prefix,
  :description,
  :encryption_configuration,
  :resource_tags,
  :image_tag_mutability,
  :repository_policy,
  :lifecycle_policy,
  :applied_for,
  :custom_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#repository_policy ⇒ String

The repository policy to apply to repositories created using the template. A repository policy is a permissions policy associated with a repository to control access permissions.

Returns:

• (String)

# File 'lib/aws-sdk-ecr/types.rb', line 541

class CreateRepositoryCreationTemplateRequest < Struct.new(
  :prefix,
  :description,
  :encryption_configuration,
  :resource_tags,
  :image_tag_mutability,
  :repository_policy,
  :lifecycle_policy,
  :applied_for,
  :custom_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#resource_tags ⇒ Array<Types::Tag>

The metadata to apply to the repository to help you categorize and organize. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-ecr/types.rb', line 541

class CreateRepositoryCreationTemplateRequest < Struct.new(
  :prefix,
  :description,
  :encryption_configuration,
  :resource_tags,
  :image_tag_mutability,
  :repository_policy,
  :lifecycle_policy,
  :applied_for,
  :custom_role_arn)
  SENSITIVE = []
  include Aws::Structure
end