Package software.amazon.awscdk.services.ecr

Interface CfnRepositoryCreationTemplateProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRepositoryCreationTemplateProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-11T23:26:32.560Z")
@Stability(Stable)
public interface CfnRepositoryCreationTemplateProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnRepositoryCreationTemplate.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ecr.*;
 CfnRepositoryCreationTemplateProps cfnRepositoryCreationTemplateProps = CfnRepositoryCreationTemplateProps.builder()
         .appliedFor(List.of("appliedFor"))
         .prefix("prefix")
         // the properties below are optional
         .customRoleArn("customRoleArn")
         .description("description")
         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                 .encryptionType("encryptionType")
                 // the properties below are optional
                 .kmsKey("kmsKey")
                 .build())
         .imageTagMutability("imageTagMutability")
         .lifecyclePolicy("lifecyclePolicy")
         .repositoryPolicy("repositoryPolicy")
         .resourceTags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRepositoryCreationTemplateProps.Builder	A builder for CfnRepositoryCreationTemplateProps
static final class	CfnRepositoryCreationTemplateProps.Jsii$Proxy	An implementation for CfnRepositoryCreationTemplateProps

Method Summary

Modifier and Type	Method	Description
static CfnRepositoryCreationTemplateProps.Builder	builder()
List<String>	getAppliedFor()	A list of enumerable Strings representing the repository creation scenarios that this template will apply towards.
default String	getCustomRoleArn()	The ARN of the role to be assumed by Amazon ECR.
default String	getDescription()	The description associated with the repository creation template.
default Object	getEncryptionConfiguration()	The encryption configuration associated with the repository creation template.
default String	getImageTagMutability()	The tag mutability setting for the repository.
default String	getLifecyclePolicy()	The lifecycle policy to use for repositories created using the template.
String	getPrefix()	The repository namespace prefix associated with the repository creation template.
default String	getRepositoryPolicy()	he repository policy to apply to repositories created using the template.
default Object	getResourceTags()	The metadata to apply to the repository to help you categorize and organize.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAppliedFor

@Stability(Stable)
@NotNull
List<String> getAppliedFor()

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 Also:

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

getPrefix

@Stability(Stable)
@NotNull
String getPrefix()

The repository namespace prefix associated with the repository creation template.

See Also:

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

getCustomRoleArn

@Stability(Stable)
@Nullable
default String getCustomRoleArn()

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 Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description associated with the repository creation template.

See Also:

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

getEncryptionConfiguration

@Stability(Stable)
@Nullable
default Object getEncryptionConfiguration()

The encryption configuration associated with the repository creation template.

See Also:

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

getImageTagMutability

@Stability(Stable)
@Nullable
default String getImageTagMutability()

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 Also:

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

getLifecyclePolicy

@Stability(Stable)
@Nullable
default String getLifecyclePolicy()

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

See Also:

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

getRepositoryPolicy

@Stability(Stable)
@Nullable
default String getRepositoryPolicy()

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 Also:

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

getResourceTags

@Stability(Stable)
@Nullable
default Object getResourceTags()

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 Also:

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

builder

@Stability(Stable)
static CfnRepositoryCreationTemplateProps.Builder builder()

Returns:

a CfnRepositoryCreationTemplateProps.Builder of CfnRepositoryCreationTemplateProps