1. Packages
  2. AWS Native
  3. API Docs
  4. ecr
  5. RepositoryCreationTemplate

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

aws-native.ecr.RepositoryCreationTemplate

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

    AWS::ECR::RepositoryCreationTemplate is used to create repository with configuration from a pre-defined template.

    Create RepositoryCreationTemplate Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new RepositoryCreationTemplate(name: string, args: RepositoryCreationTemplateArgs, opts?: CustomResourceOptions);
    @overload
    def RepositoryCreationTemplate(resource_name: str,
                                   args: RepositoryCreationTemplateArgs,
                                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def RepositoryCreationTemplate(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   applied_for: Optional[Sequence[RepositoryCreationTemplateAppliedForItem]] = None,
                                   prefix: Optional[str] = None,
                                   custom_role_arn: Optional[str] = None,
                                   description: Optional[str] = None,
                                   encryption_configuration: Optional[RepositoryCreationTemplateEncryptionConfigurationArgs] = None,
                                   image_tag_mutability: Optional[RepositoryCreationTemplateImageTagMutability] = None,
                                   lifecycle_policy: Optional[str] = None,
                                   repository_policy: Optional[str] = None,
                                   resource_tags: Optional[Sequence[RepositoryCreationTemplateTagArgs]] = None)
    func NewRepositoryCreationTemplate(ctx *Context, name string, args RepositoryCreationTemplateArgs, opts ...ResourceOption) (*RepositoryCreationTemplate, error)
    public RepositoryCreationTemplate(string name, RepositoryCreationTemplateArgs args, CustomResourceOptions? opts = null)
    public RepositoryCreationTemplate(String name, RepositoryCreationTemplateArgs args)
    public RepositoryCreationTemplate(String name, RepositoryCreationTemplateArgs args, CustomResourceOptions options)
    
    type: aws-native:ecr:RepositoryCreationTemplate
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args RepositoryCreationTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args RepositoryCreationTemplateArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args RepositoryCreationTemplateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RepositoryCreationTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RepositoryCreationTemplateArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    RepositoryCreationTemplate Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The RepositoryCreationTemplate resource accepts the following input properties:

    AppliedFor List<Pulumi.AwsNative.Ecr.RepositoryCreationTemplateAppliedForItem>
    A list of enumerable Strings representing the repository creation scenarios that the template will apply towards.
    Prefix string
    The prefix use to match the repository name and apply the template.
    CustomRoleArn string
    The ARN of the role to be assumed by ECR. This role must be in the same account as the registry that you are configuring.
    Description string
    The description of the template.
    EncryptionConfiguration Pulumi.AwsNative.Ecr.Inputs.RepositoryCreationTemplateEncryptionConfiguration
    The encryption configuration associated with the repository creation template.
    ImageTagMutability Pulumi.AwsNative.Ecr.RepositoryCreationTemplateImageTagMutability
    The image tag mutability setting for the repository.
    LifecyclePolicy string
    The JSON lifecycle policy text to apply to the repository. For information about lifecycle policy syntax, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html
    RepositoryPolicy string
    The JSON repository policy text to apply to the repository. For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html
    ResourceTags List<Pulumi.AwsNative.Ecr.Inputs.RepositoryCreationTemplateTag>
    An array of key-value pairs to apply to this resource.
    AppliedFor []RepositoryCreationTemplateAppliedForItem
    A list of enumerable Strings representing the repository creation scenarios that the template will apply towards.
    Prefix string
    The prefix use to match the repository name and apply the template.
    CustomRoleArn string
    The ARN of the role to be assumed by ECR. This role must be in the same account as the registry that you are configuring.
    Description string
    The description of the template.
    EncryptionConfiguration RepositoryCreationTemplateEncryptionConfigurationArgs
    The encryption configuration associated with the repository creation template.
    ImageTagMutability RepositoryCreationTemplateImageTagMutability
    The image tag mutability setting for the repository.
    LifecyclePolicy string
    The JSON lifecycle policy text to apply to the repository. For information about lifecycle policy syntax, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html
    RepositoryPolicy string
    The JSON repository policy text to apply to the repository. For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html
    ResourceTags []RepositoryCreationTemplateTagArgs
    An array of key-value pairs to apply to this resource.
    appliedFor List<RepositoryCreationTemplateAppliedForItem>
    A list of enumerable Strings representing the repository creation scenarios that the template will apply towards.
    prefix String
    The prefix use to match the repository name and apply the template.
    customRoleArn String
    The ARN of the role to be assumed by ECR. This role must be in the same account as the registry that you are configuring.
    description String
    The description of the template.
    encryptionConfiguration RepositoryCreationTemplateEncryptionConfiguration
    The encryption configuration associated with the repository creation template.
    imageTagMutability RepositoryCreationTemplateImageTagMutability
    The image tag mutability setting for the repository.
    lifecyclePolicy String
    The JSON lifecycle policy text to apply to the repository. For information about lifecycle policy syntax, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html
    repositoryPolicy String
    The JSON repository policy text to apply to the repository. For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html
    resourceTags List<RepositoryCreationTemplateTag>
    An array of key-value pairs to apply to this resource.
    appliedFor RepositoryCreationTemplateAppliedForItem[]
    A list of enumerable Strings representing the repository creation scenarios that the template will apply towards.
    prefix string
    The prefix use to match the repository name and apply the template.
    customRoleArn string
    The ARN of the role to be assumed by ECR. This role must be in the same account as the registry that you are configuring.
    description string
    The description of the template.
    encryptionConfiguration RepositoryCreationTemplateEncryptionConfiguration
    The encryption configuration associated with the repository creation template.
    imageTagMutability RepositoryCreationTemplateImageTagMutability
    The image tag mutability setting for the repository.
    lifecyclePolicy string
    The JSON lifecycle policy text to apply to the repository. For information about lifecycle policy syntax, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html
    repositoryPolicy string
    The JSON repository policy text to apply to the repository. For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html
    resourceTags RepositoryCreationTemplateTag[]
    An array of key-value pairs to apply to this resource.
    applied_for Sequence[RepositoryCreationTemplateAppliedForItem]
    A list of enumerable Strings representing the repository creation scenarios that the template will apply towards.
    prefix str
    The prefix use to match the repository name and apply the template.
    custom_role_arn str
    The ARN of the role to be assumed by ECR. This role must be in the same account as the registry that you are configuring.
    description str
    The description of the template.
    encryption_configuration RepositoryCreationTemplateEncryptionConfigurationArgs
    The encryption configuration associated with the repository creation template.
    image_tag_mutability RepositoryCreationTemplateImageTagMutability
    The image tag mutability setting for the repository.
    lifecycle_policy str
    The JSON lifecycle policy text to apply to the repository. For information about lifecycle policy syntax, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html
    repository_policy str
    The JSON repository policy text to apply to the repository. For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html
    resource_tags Sequence[RepositoryCreationTemplateTagArgs]
    An array of key-value pairs to apply to this resource.
    appliedFor List<"REPLICATION" | "PULL_THROUGH_CACHE">
    A list of enumerable Strings representing the repository creation scenarios that the template will apply towards.
    prefix String
    The prefix use to match the repository name and apply the template.
    customRoleArn String
    The ARN of the role to be assumed by ECR. This role must be in the same account as the registry that you are configuring.
    description String
    The description of the template.
    encryptionConfiguration Property Map
    The encryption configuration associated with the repository creation template.
    imageTagMutability "MUTABLE" | "IMMUTABLE"
    The image tag mutability setting for the repository.
    lifecyclePolicy String
    The JSON lifecycle policy text to apply to the repository. For information about lifecycle policy syntax, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html
    repositoryPolicy String
    The JSON repository policy text to apply to the repository. For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html
    resourceTags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RepositoryCreationTemplate resource produces the following output properties:

    CreatedAt string
    Create timestamp of the template.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    Update timestamp of the template.
    CreatedAt string
    Create timestamp of the template.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    Update timestamp of the template.
    createdAt String
    Create timestamp of the template.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    Update timestamp of the template.
    createdAt string
    Create timestamp of the template.
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt string
    Update timestamp of the template.
    created_at str
    Create timestamp of the template.
    id str
    The provider-assigned unique ID for this managed resource.
    updated_at str
    Update timestamp of the template.
    createdAt String
    Create timestamp of the template.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    Update timestamp of the template.

    Supporting Types

    RepositoryCreationTemplateAppliedForItem, RepositoryCreationTemplateAppliedForItemArgs

    Replication
    REPLICATION
    PullThroughCache
    PULL_THROUGH_CACHE
    RepositoryCreationTemplateAppliedForItemReplication
    REPLICATION
    RepositoryCreationTemplateAppliedForItemPullThroughCache
    PULL_THROUGH_CACHE
    Replication
    REPLICATION
    PullThroughCache
    PULL_THROUGH_CACHE
    Replication
    REPLICATION
    PullThroughCache
    PULL_THROUGH_CACHE
    REPLICATION
    REPLICATION
    PULL_THROUGH_CACHE
    PULL_THROUGH_CACHE
    "REPLICATION"
    REPLICATION
    "PULL_THROUGH_CACHE"
    PULL_THROUGH_CACHE

    RepositoryCreationTemplateEncryptionConfiguration, RepositoryCreationTemplateEncryptionConfigurationArgs

    EncryptionType Pulumi.AwsNative.Ecr.RepositoryCreationTemplateEncryptionType

    The encryption type to use.

    If you use the KMS encryption type, the contents of the repository will be encrypted using server-side encryption with AWS Key Management Service key stored in AWS KMS . When you use AWS KMS to encrypt your data, you can either use the default AWS managed AWS KMS key for Amazon ECR, or specify your own AWS KMS key, which you already created.

    If you use the KMS_DSSE encryption type, the contents of the repository will be encrypted with two layers of encryption using server-side encryption with the AWS KMS Management Service key stored in AWS KMS . Similar to the KMS encryption type, you can either use the default AWS managed AWS KMS key for Amazon ECR, or specify your own AWS KMS key, which you've already created.

    If you use the AES256 encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES256 encryption algorithm.

    For more information, see Amazon ECR encryption at rest in the Amazon Elastic Container Registry User Guide .

    KmsKey string
    If you use the KMS encryption type, specify the AWS KMS key to use for encryption. The alias, key ID, or full ARN of the AWS KMS key can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed AWS KMS key for Amazon ECR will be used.
    EncryptionType RepositoryCreationTemplateEncryptionType

    The encryption type to use.

    If you use the KMS encryption type, the contents of the repository will be encrypted using server-side encryption with AWS Key Management Service key stored in AWS KMS . When you use AWS KMS to encrypt your data, you can either use the default AWS managed AWS KMS key for Amazon ECR, or specify your own AWS KMS key, which you already created.

    If you use the KMS_DSSE encryption type, the contents of the repository will be encrypted with two layers of encryption using server-side encryption with the AWS KMS Management Service key stored in AWS KMS . Similar to the KMS encryption type, you can either use the default AWS managed AWS KMS key for Amazon ECR, or specify your own AWS KMS key, which you've already created.

    If you use the AES256 encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES256 encryption algorithm.

    For more information, see Amazon ECR encryption at rest in the Amazon Elastic Container Registry User Guide .

    KmsKey string
    If you use the KMS encryption type, specify the AWS KMS key to use for encryption. The alias, key ID, or full ARN of the AWS KMS key can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed AWS KMS key for Amazon ECR will be used.
    encryptionType RepositoryCreationTemplateEncryptionType

    The encryption type to use.

    If you use the KMS encryption type, the contents of the repository will be encrypted using server-side encryption with AWS Key Management Service key stored in AWS KMS . When you use AWS KMS to encrypt your data, you can either use the default AWS managed AWS KMS key for Amazon ECR, or specify your own AWS KMS key, which you already created.

    If you use the KMS_DSSE encryption type, the contents of the repository will be encrypted with two layers of encryption using server-side encryption with the AWS KMS Management Service key stored in AWS KMS . Similar to the KMS encryption type, you can either use the default AWS managed AWS KMS key for Amazon ECR, or specify your own AWS KMS key, which you've already created.

    If you use the AES256 encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES256 encryption algorithm.

    For more information, see Amazon ECR encryption at rest in the Amazon Elastic Container Registry User Guide .

    kmsKey String
    If you use the KMS encryption type, specify the AWS KMS key to use for encryption. The alias, key ID, or full ARN of the AWS KMS key can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed AWS KMS key for Amazon ECR will be used.
    encryptionType RepositoryCreationTemplateEncryptionType

    The encryption type to use.

    If you use the KMS encryption type, the contents of the repository will be encrypted using server-side encryption with AWS Key Management Service key stored in AWS KMS . When you use AWS KMS to encrypt your data, you can either use the default AWS managed AWS KMS key for Amazon ECR, or specify your own AWS KMS key, which you already created.

    If you use the KMS_DSSE encryption type, the contents of the repository will be encrypted with two layers of encryption using server-side encryption with the AWS KMS Management Service key stored in AWS KMS . Similar to the KMS encryption type, you can either use the default AWS managed AWS KMS key for Amazon ECR, or specify your own AWS KMS key, which you've already created.

    If you use the AES256 encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES256 encryption algorithm.

    For more information, see Amazon ECR encryption at rest in the Amazon Elastic Container Registry User Guide .

    kmsKey string
    If you use the KMS encryption type, specify the AWS KMS key to use for encryption. The alias, key ID, or full ARN of the AWS KMS key can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed AWS KMS key for Amazon ECR will be used.
    encryption_type RepositoryCreationTemplateEncryptionType

    The encryption type to use.

    If you use the KMS encryption type, the contents of the repository will be encrypted using server-side encryption with AWS Key Management Service key stored in AWS KMS . When you use AWS KMS to encrypt your data, you can either use the default AWS managed AWS KMS key for Amazon ECR, or specify your own AWS KMS key, which you already created.

    If you use the KMS_DSSE encryption type, the contents of the repository will be encrypted with two layers of encryption using server-side encryption with the AWS KMS Management Service key stored in AWS KMS . Similar to the KMS encryption type, you can either use the default AWS managed AWS KMS key for Amazon ECR, or specify your own AWS KMS key, which you've already created.

    If you use the AES256 encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES256 encryption algorithm.

    For more information, see Amazon ECR encryption at rest in the Amazon Elastic Container Registry User Guide .

    kms_key str
    If you use the KMS encryption type, specify the AWS KMS key to use for encryption. The alias, key ID, or full ARN of the AWS KMS key can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed AWS KMS key for Amazon ECR will be used.
    encryptionType "AES256" | "KMS"

    The encryption type to use.

    If you use the KMS encryption type, the contents of the repository will be encrypted using server-side encryption with AWS Key Management Service key stored in AWS KMS . When you use AWS KMS to encrypt your data, you can either use the default AWS managed AWS KMS key for Amazon ECR, or specify your own AWS KMS key, which you already created.

    If you use the KMS_DSSE encryption type, the contents of the repository will be encrypted with two layers of encryption using server-side encryption with the AWS KMS Management Service key stored in AWS KMS . Similar to the KMS encryption type, you can either use the default AWS managed AWS KMS key for Amazon ECR, or specify your own AWS KMS key, which you've already created.

    If you use the AES256 encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES256 encryption algorithm.

    For more information, see Amazon ECR encryption at rest in the Amazon Elastic Container Registry User Guide .

    kmsKey String
    If you use the KMS encryption type, specify the AWS KMS key to use for encryption. The alias, key ID, or full ARN of the AWS KMS key can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed AWS KMS key for Amazon ECR will be used.

    RepositoryCreationTemplateEncryptionType, RepositoryCreationTemplateEncryptionTypeArgs

    Aes256
    AES256
    Kms
    KMS
    RepositoryCreationTemplateEncryptionTypeAes256
    AES256
    RepositoryCreationTemplateEncryptionTypeKms
    KMS
    Aes256
    AES256
    Kms
    KMS
    Aes256
    AES256
    Kms
    KMS
    AES256
    AES256
    KMS
    KMS
    "AES256"
    AES256
    "KMS"
    KMS

    RepositoryCreationTemplateImageTagMutability, RepositoryCreationTemplateImageTagMutabilityArgs

    Mutable
    MUTABLE
    Immutable
    IMMUTABLE
    RepositoryCreationTemplateImageTagMutabilityMutable
    MUTABLE
    RepositoryCreationTemplateImageTagMutabilityImmutable
    IMMUTABLE
    Mutable
    MUTABLE
    Immutable
    IMMUTABLE
    Mutable
    MUTABLE
    Immutable
    IMMUTABLE
    MUTABLE
    MUTABLE
    IMMUTABLE
    IMMUTABLE
    "MUTABLE"
    MUTABLE
    "IMMUTABLE"
    IMMUTABLE

    RepositoryCreationTemplateTag, RepositoryCreationTemplateTagArgs

    Key string
    The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
    Value string
    The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
    Key string
    The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
    Value string
    The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
    key String
    The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
    value String
    The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
    key string
    The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
    value string
    The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
    key str
    The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
    value str
    The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
    key String
    The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
    value String
    The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi