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

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.ecr.RepositoryCreationTemplate

Explore with Pulumi AI

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

The details of the repository creation template associated with the request.

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 This property is required. string
The unique name of the resource.
args This property is required. RepositoryCreationTemplateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. RepositoryCreationTemplateArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. RepositoryCreationTemplateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The RepositoryCreationTemplate resource accepts the following input properties:

AppliedFor This property is required. List<Pulumi.AwsNative.Ecr.RepositoryCreationTemplateAppliedForItem>
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 This property is required. string
The repository namespace prefix associated with the repository creation template.
CustomRoleArn string
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 string
The description associated with the repository creation template.
EncryptionConfiguration Pulumi.AwsNative.Ecr.Inputs.RepositoryCreationTemplateEncryptionConfiguration
The encryption configuration associated with the repository creation template.
ImageTagMutability Pulumi.AwsNative.Ecr.RepositoryCreationTemplateImageTagMutability
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.
LifecyclePolicy string
The lifecycle policy to use for repositories created using the template.
RepositoryPolicy string
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.
ResourceTags List<Pulumi.AwsNative.Ecr.Inputs.RepositoryCreationTemplateTag>
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.
AppliedFor This property is required. []RepositoryCreationTemplateAppliedForItem
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 This property is required. string
The repository namespace prefix associated with the repository creation template.
CustomRoleArn string
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 string
The description associated with the repository creation template.
EncryptionConfiguration RepositoryCreationTemplateEncryptionConfigurationArgs
The encryption configuration associated with the repository creation template.
ImageTagMutability RepositoryCreationTemplateImageTagMutability
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.
LifecyclePolicy string
The lifecycle policy to use for repositories created using the template.
RepositoryPolicy string
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.
ResourceTags []RepositoryCreationTemplateTagArgs
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.
appliedFor This property is required. List<RepositoryCreationTemplateAppliedForItem>
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 This property is required. String
The repository namespace prefix associated with the repository creation template.
customRoleArn String
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 String
The description associated with the repository creation template.
encryptionConfiguration RepositoryCreationTemplateEncryptionConfiguration
The encryption configuration associated with the repository creation template.
imageTagMutability RepositoryCreationTemplateImageTagMutability
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.
lifecyclePolicy String
The lifecycle policy to use for repositories created using the template.
repositoryPolicy String
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.
resourceTags List<RepositoryCreationTemplateTag>
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.
appliedFor This property is required. RepositoryCreationTemplateAppliedForItem[]
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 This property is required. string
The repository namespace prefix associated with the repository creation template.
customRoleArn string
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 string
The description associated with the repository creation template.
encryptionConfiguration RepositoryCreationTemplateEncryptionConfiguration
The encryption configuration associated with the repository creation template.
imageTagMutability RepositoryCreationTemplateImageTagMutability
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.
lifecyclePolicy string
The lifecycle policy to use for repositories created using the template.
repositoryPolicy string
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.
resourceTags RepositoryCreationTemplateTag[]
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.
applied_for This property is required. Sequence[RepositoryCreationTemplateAppliedForItem]
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 This property is required. str
The repository namespace prefix associated with the repository creation template.
custom_role_arn 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 str
The description associated with the repository creation template.
encryption_configuration RepositoryCreationTemplateEncryptionConfigurationArgs
The encryption configuration associated with the repository creation template.
image_tag_mutability RepositoryCreationTemplateImageTagMutability
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 str
The lifecycle policy to use for repositories created using the template.
repository_policy 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 Sequence[RepositoryCreationTemplateTagArgs]
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.
appliedFor This property is required. List<"REPLICATION" | "PULL_THROUGH_CACHE">
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 This property is required. String
The repository namespace prefix associated with the repository creation template.
customRoleArn String
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 String
The description associated with the repository creation template.
encryptionConfiguration Property Map
The encryption configuration associated with the repository creation template.
imageTagMutability "MUTABLE" | "IMMUTABLE"
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.
lifecyclePolicy String
The lifecycle policy to use for repositories created using the template.
repositoryPolicy String
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.
resourceTags List<Property Map>
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.

Outputs

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

CreatedAt string
The date and time, in JavaScript date format, when the repository creation template was created.
Id string
The provider-assigned unique ID for this managed resource.
UpdatedAt string
The date and time, in JavaScript date format, when the repository creation template was last updated.
CreatedAt string
The date and time, in JavaScript date format, when the repository creation template was created.
Id string
The provider-assigned unique ID for this managed resource.
UpdatedAt string
The date and time, in JavaScript date format, when the repository creation template was last updated.
createdAt String
The date and time, in JavaScript date format, when the repository creation template was created.
id String
The provider-assigned unique ID for this managed resource.
updatedAt String
The date and time, in JavaScript date format, when the repository creation template was last updated.
createdAt string
The date and time, in JavaScript date format, when the repository creation template was created.
id string
The provider-assigned unique ID for this managed resource.
updatedAt string
The date and time, in JavaScript date format, when the repository creation template was last updated.
created_at str
The date and time, in JavaScript date format, when the repository creation template was created.
id str
The provider-assigned unique ID for this managed resource.
updated_at str
The date and time, in JavaScript date format, when the repository creation template was last updated.
createdAt String
The date and time, in JavaScript date format, when the repository creation template was created.
id String
The provider-assigned unique ID for this managed resource.
updatedAt String
The date and time, in JavaScript date format, when the repository creation template was last updated.

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 This property is required. 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 KMSlong key stored in KMS. When you use KMS to encrypt your data, you can either use the default AWS managed KMS key for Amazon ECR, or specify your own 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 KMS Management Service key stored in KMS. Similar to the KMS encryption type, you can either use the default AWS managed KMS key for Amazon ECR, or specify your own 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 KMS key to use for encryption. The alias, key ID, or full ARN of the 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 KMS key for Amazon ECR will be used.
EncryptionType This property is required. 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 KMSlong key stored in KMS. When you use KMS to encrypt your data, you can either use the default AWS managed KMS key for Amazon ECR, or specify your own 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 KMS Management Service key stored in KMS. Similar to the KMS encryption type, you can either use the default AWS managed KMS key for Amazon ECR, or specify your own 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 KMS key to use for encryption. The alias, key ID, or full ARN of the 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 KMS key for Amazon ECR will be used.
encryptionType This property is required. 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 KMSlong key stored in KMS. When you use KMS to encrypt your data, you can either use the default AWS managed KMS key for Amazon ECR, or specify your own 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 KMS Management Service key stored in KMS. Similar to the KMS encryption type, you can either use the default AWS managed KMS key for Amazon ECR, or specify your own 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 KMS key to use for encryption. The alias, key ID, or full ARN of the 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 KMS key for Amazon ECR will be used.
encryptionType This property is required. 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 KMSlong key stored in KMS. When you use KMS to encrypt your data, you can either use the default AWS managed KMS key for Amazon ECR, or specify your own 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 KMS Management Service key stored in KMS. Similar to the KMS encryption type, you can either use the default AWS managed KMS key for Amazon ECR, or specify your own 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 KMS key to use for encryption. The alias, key ID, or full ARN of the 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 KMS key for Amazon ECR will be used.
encryption_type This property is required. 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 KMSlong key stored in KMS. When you use KMS to encrypt your data, you can either use the default AWS managed KMS key for Amazon ECR, or specify your own 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 KMS Management Service key stored in KMS. Similar to the KMS encryption type, you can either use the default AWS managed KMS key for Amazon ECR, or specify your own 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 KMS key to use for encryption. The alias, key ID, or full ARN of the 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 KMS key for Amazon ECR will be used.
encryptionType This property is required. "AES256" | "KMS" | "KMS_DSSE"
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 KMSlong key stored in KMS. When you use KMS to encrypt your data, you can either use the default AWS managed KMS key for Amazon ECR, or specify your own 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 KMS Management Service key stored in KMS. Similar to the KMS encryption type, you can either use the default AWS managed KMS key for Amazon ECR, or specify your own 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 KMS key to use for encryption. The alias, key ID, or full ARN of the 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 KMS key for Amazon ECR will be used.

RepositoryCreationTemplateEncryptionType
, RepositoryCreationTemplateEncryptionTypeArgs

Aes256
AES256
Kms
KMS
KmsDsse
KMS_DSSE
RepositoryCreationTemplateEncryptionTypeAes256
AES256
RepositoryCreationTemplateEncryptionTypeKms
KMS
RepositoryCreationTemplateEncryptionTypeKmsDsse
KMS_DSSE
Aes256
AES256
Kms
KMS
KmsDsse
KMS_DSSE
Aes256
AES256
Kms
KMS
KmsDsse
KMS_DSSE
AES256
AES256
KMS
KMS
KMS_DSSE
KMS_DSSE
"AES256"
AES256
"KMS"
KMS
"KMS_DSSE"
KMS_DSSE

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 This property is required. string
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
Value This property is required. string
A value acts as a descriptor within a tag category (key).
Key This property is required. string
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
Value This property is required. string
A value acts as a descriptor within a tag category (key).
key This property is required. String
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
value This property is required. String
A value acts as a descriptor within a tag category (key).
key This property is required. string
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
value This property is required. string
A value acts as a descriptor within a tag category (key).
key This property is required. str
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
value This property is required. str
A value acts as a descriptor within a tag category (key).
key This property is required. String
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
value This property is required. String
A value acts as a descriptor within a tag category (key).

Package Details

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

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi