CfnRepositoryCreationTemplateProps

class aws_cdk.aws_ecr.CfnRepositoryCreationTemplateProps(*, applied_for, prefix, custom_role_arn=None, description=None, encryption_configuration=None, image_tag_mutability=None, lifecycle_policy=None, repository_policy=None, resource_tags=None)

Bases: object

Properties for defining a CfnRepositoryCreationTemplate.

Parameters:
  • applied_for (Sequence[str]) – A list of enumerable Strings representing the repository creation scenarios that this template will apply towards. The two supported scenarios are PULL_THROUGH_CACHE and REPLICATION

  • prefix (str) – The repository namespace prefix associated with the repository creation template.

  • custom_role_arn (Optional[str]) – The ARN of the role to be assumed by Amazon ECR. 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.

  • description (Optional[str]) – The description associated with the repository creation template.

  • encryption_configuration (Union[IResolvable, EncryptionConfigurationProperty, Dict[str, Any], None]) – The encryption configuration associated with the repository creation template.

  • image_tag_mutability (Optional[str]) – 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.

  • lifecycle_policy (Optional[str]) – The lifecycle policy to use for repositories created using the template.

  • repository_policy (Optional[str]) – he 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.

  • resource_tags (Union[IResolvable, Sequence[Union[IResolvable, CfnTag, Dict[str, Any]]], None]) – 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repositorycreationtemplate.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ecr as ecr

cfn_repository_creation_template_props = ecr.CfnRepositoryCreationTemplateProps(
    applied_for=["appliedFor"],
    prefix="prefix",

    # the properties below are optional
    custom_role_arn="customRoleArn",
    description="description",
    encryption_configuration=ecr.CfnRepositoryCreationTemplate.EncryptionConfigurationProperty(
        encryption_type="encryptionType",

        # the properties below are optional
        kms_key="kmsKey"
    ),
    image_tag_mutability="imageTagMutability",
    lifecycle_policy="lifecyclePolicy",
    repository_policy="repositoryPolicy",
    resource_tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

applied_for

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

The two supported scenarios are PULL_THROUGH_CACHE and REPLICATION

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repositorycreationtemplate.html#cfn-ecr-repositorycreationtemplate-appliedfor

custom_role_arn

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

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repositorycreationtemplate.html#cfn-ecr-repositorycreationtemplate-customrolearn

description

The description associated with the repository creation template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repositorycreationtemplate.html#cfn-ecr-repositorycreationtemplate-description

encryption_configuration

The encryption configuration associated with the repository creation template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repositorycreationtemplate.html#cfn-ecr-repositorycreationtemplate-encryptionconfiguration

image_tag_mutability

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repositorycreationtemplate.html#cfn-ecr-repositorycreationtemplate-imagetagmutability

lifecycle_policy

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repositorycreationtemplate.html#cfn-ecr-repositorycreationtemplate-lifecyclepolicy

prefix

The repository namespace prefix associated with the repository creation template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repositorycreationtemplate.html#cfn-ecr-repositorycreationtemplate-prefix

repository_policy

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repositorycreationtemplate.html#cfn-ecr-repositorycreationtemplate-repositorypolicy

resource_tags

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repositorycreationtemplate.html#cfn-ecr-repositorycreationtemplate-resourcetags