Package software.amazon.awscdk.services.ecr

Interface CfnRepositoryProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnRepositoryProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:37.424Z") @Stability(Stable) public interface CfnRepositoryProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnRepository.

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.*;
 Object repositoryPolicyText;
 CfnRepositoryProps cfnRepositoryProps = CfnRepositoryProps.builder()
         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                 .encryptionType("encryptionType")
                 // the properties below are optional
                 .kmsKey("kmsKey")
                 .build())
         .imageScanningConfiguration(ImageScanningConfigurationProperty.builder()
                 .scanOnPush(false)
                 .build())
         .imageTagMutability("imageTagMutability")
         .lifecyclePolicy(LifecyclePolicyProperty.builder()
                 .lifecyclePolicyText("lifecyclePolicyText")
                 .registryId("registryId")
                 .build())
         .repositoryName("repositoryName")
         .repositoryPolicyText(repositoryPolicyText)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Method Details

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

    • getImageScanningConfiguration

      @Stability(Stable) @Nullable default Object getImageScanningConfiguration()
      The image scanning configuration for the repository.

      This determines whether images are scanned for known vulnerabilities after being pushed to the repository.

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

    • getLifecyclePolicy

      @Stability(Stable) @Nullable default Object getLifecyclePolicy()
      Creates or updates a lifecycle policy.

      For information about lifecycle policy syntax, see Lifecycle policy template .

    • getRepositoryName

      @Stability(Stable) @Nullable default String getRepositoryName()
      The name to use for the repository.

      The repository name may be specified on its own (such as nginx-web-app ) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app ). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the repository name. For more information, see Name type .

      The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes.

      If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

    • getRepositoryPolicyText

      @Stability(Stable) @Nullable default Object getRepositoryPolicyText()
      The JSON repository policy text to apply to the repository.

      For more information, see Amazon ECR repository policies in the Amazon Elastic Container Registry User Guide .

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

    • builder

      @Stability(Stable) static CfnRepositoryProps.Builder builder()
      Returns:
      a CfnRepositoryProps.Builder of CfnRepositoryProps