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.101.0 (build b95fe5d)",
           date="2024-08-15T01:32:47.345Z")
@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
         .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 the template will apply towards.
default String	getDescription()	The description of the template.
default Object	getEncryptionConfiguration()	The encryption configuration for the repository.
default String	getImageTagMutability()	The image tag mutability setting for the repository.
default String	getLifecyclePolicy()	The JSON lifecycle policy text to apply to the repository.
String	getPrefix()	The prefix use to match the repository name and apply the template.
default String	getRepositoryPolicy()	The JSON repository policy text to apply to the repository.
default Object	getResourceTags()	The tags attached to the resource.

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 the template will apply towards.

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 prefix use to match the repository name and apply the template.

See Also:

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

getDescription

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

The description of the 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 for the repository. This determines how the contents of your repository are encrypted at rest.

By default, when no encryption configuration is set or the AES256 encryption type is used, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts your data at rest using an AES-256 encryption algorithm. This does not require any action on your part.

For more control over the encryption of the contents of your repository, you can use server-side encryption with AWS Key Management Service key stored in AWS Key Management Service ( AWS KMS ) to encrypt your images. For more information, see Amazon ECR encryption at rest in the Amazon Elastic Container Registry User Guide .

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 image tag mutability setting for the repository.

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

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()

The JSON repository policy text to apply to the repository.

For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html

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 tags attached to the resource.

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