software.amazon.awscdk.services.ecr

Class Repository.Builder

java.lang.Object

software.amazon.awscdk.services.ecr.Repository.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Repository>

Enclosing class:

Repository

@Stability(value=Stable)
public static final class Repository.Builder
extends Object
implements software.amazon.jsii.Builder<Repository>

A fluent builder for Repository.

Method Summary

Modifier and Type	Method and Description
Repository	build()
static Repository.Builder	create(software.constructs.Construct scope, String id)
Repository.Builder	encryption(RepositoryEncryption encryption) The kind of server-side encryption to apply to this repository.
Repository.Builder	encryptionKey(IKey encryptionKey) External KMS key to use for repository encryption.
Repository.Builder	imageScanOnPush(Boolean imageScanOnPush) Enable the scan on push when creating the repository.
Repository.Builder	imageTagMutability(TagMutability imageTagMutability) The tag mutability setting for the repository.
Repository.Builder	lifecycleRegistryId(String lifecycleRegistryId) The AWS account ID associated with the registry that contains the repository.
Repository.Builder	lifecycleRules(List<? extends LifecycleRule> lifecycleRules) Life cycle rules to apply to this registry.
Repository.Builder	removalPolicy(RemovalPolicy removalPolicy) Determine what happens to the repository when the resource/stack is deleted.
Repository.Builder	repositoryName(String repositoryName) Name for this repository.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static Repository.Builder create(software.constructs.Construct scope,
                                                                 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Repository.Builder.

encryption

@Stability(value=Stable)
public Repository.Builder encryption(RepositoryEncryption encryption)

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.

Parameters:

encryption - The kind of server-side encryption to apply to this repository. This parameter is required.

Returns:

this

encryptionKey

@Stability(value=Stable)
public Repository.Builder encryptionKey(IKey encryptionKey)

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.

Parameters:

encryptionKey - External KMS key to use for repository encryption. This parameter is required.

Returns:

this

imageScanOnPush

@Stability(value=Stable)
public Repository.Builder imageScanOnPush(Boolean imageScanOnPush)

Enable the scan on push when creating the repository.

Default: false

Parameters:

imageScanOnPush - Enable the scan on push when creating the repository. This parameter is required.

Returns:

this

imageTagMutability

@Stability(value=Stable)
public Repository.Builder imageTagMutability(TagMutability imageTagMutability)

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

Parameters:

imageTagMutability - The tag mutability setting for the repository. This parameter is required.

Returns:

this

lifecycleRegistryId

@Stability(value=Stable)
public Repository.Builder lifecycleRegistryId(String lifecycleRegistryId)

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

Default: The default registry is assumed.

Parameters:

lifecycleRegistryId - The AWS account ID associated with the registry that contains the repository. This parameter is required.

Returns:

this

See Also:

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

lifecycleRules

@Stability(value=Stable)
public Repository.Builder lifecycleRules(List<? extends LifecycleRule> lifecycleRules)

Life cycle rules to apply to this registry.

Default: No life cycle rules

Parameters:

lifecycleRules - Life cycle rules to apply to this registry. This parameter is required.

Returns:

this

removalPolicy

@Stability(value=Stable)
public Repository.Builder removalPolicy(RemovalPolicy removalPolicy)

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

Default: RemovalPolicy.Retain

Parameters:

removalPolicy - Determine what happens to the repository when the resource/stack is deleted. This parameter is required.

Returns:

this

repositoryName

@Stability(value=Stable)
public Repository.Builder repositoryName(String repositoryName)

Name for this repository.

Default: Automatically generated name.

Parameters:

repositoryName - Name for this repository. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public Repository build()

Specified by:

build in interface software.amazon.jsii.Builder<Repository>