Package software.amazon.awscdk.services.ecr

Interface RepositoryProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

RepositoryProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:37.438Z")
@Stability(Stable)
public interface RepositoryProps
extends software.amazon.jsii.JsiiSerializable

Example:

 Repository.Builder.create(this, "Repo").imageTagMutability(TagMutability.IMMUTABLE).build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RepositoryProps.Builder	builder()
default RepositoryEncryption	getEncryption()	The kind of server-side encryption to apply to this repository.
default IKey	getEncryptionKey()	External KMS key to use for repository encryption.
default Boolean	getImageScanOnPush()	Enable the scan on push when creating the repository.
default TagMutability	getImageTagMutability()	The tag mutability setting for the repository.
default String	getLifecycleRegistryId()	The AWS account ID associated with the registry that contains the repository.
default List<LifecycleRule>	getLifecycleRules()	Life cycle rules to apply to this registry.
default RemovalPolicy	getRemovalPolicy()	Determine what happens to the repository when the resource/stack is deleted.
default String	getRepositoryName()	Name for this repository.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEncryption

@Stability(Stable)
@Nullable
default RepositoryEncryption getEncryption()

The kind of server-side encryption to apply to this repository.

If you choose KMS, you can specify a KMS key via encryptionKey. If encryptionKey is not specified, an AWS managed KMS key is used.

Default: - `KMS` if `encryptionKey` is specified, or `AES256` otherwise.

getEncryptionKey

@Stability(Stable)
@Nullable
default IKey getEncryptionKey()

External KMS key to use for repository encryption.

The 'encryption' property must be either not specified or set to "KMS". An error will be emitted if encryption is set to "AES256".

Default: - If encryption is set to `KMS` and this property is undefined, an AWS managed KMS key is used.

getImageScanOnPush

@Stability(Stable)
@Nullable
default Boolean getImageScanOnPush()

Enable the scan on push when creating the repository.

Default: false

getImageTagMutability

@Stability(Stable)
@Nullable
default TagMutability 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.

Default: TagMutability.MUTABLE

getLifecycleRegistryId

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

The AWS account ID associated with the registry that contains the repository.

Default: The default registry is assumed.

See Also:

• https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html

getLifecycleRules

@Stability(Stable)
@Nullable
default List<LifecycleRule> getLifecycleRules()

Life cycle rules to apply to this registry.

Default: No life cycle rules

getRemovalPolicy

@Stability(Stable)
@Nullable
default RemovalPolicy getRemovalPolicy()

Determine what happens to the repository when the resource/stack is deleted.

Default: RemovalPolicy.Retain

getRepositoryName

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

Name for this repository.

Default: Automatically generated name.

builder

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

Returns:

a RepositoryProps.Builder of RepositoryProps