Class DockerCredential`Abstract`

Represents credentials used to access a Docker registry.

Index

Constructors

Properties

Methods

_applicableForUsage _renderCdkAssetsConfig grantRead customRegistry dockerHub ecr

Constructors

constructor

new DockerCredential(usages?: DockerCredentialUsage[]): DockerCredential
Parameters
- Optionalusages: DockerCredentialUsage[]
Returns DockerCredential
- Defined in node_modules/aws-cdk-lib/pipelines/lib/docker-credentials.d.ts:29

Properties

`Protected` `Optional` `Readonly`usages

usages?: DockerCredentialUsage[]

Methods

_applicableForUsage

_applicableForUsage(usage: DockerCredentialUsage): boolean
Internal
Determines if this credential is relevant to the input usage.
Parameters
- usage: DockerCredentialUsage
Returns boolean
- Defined in node_modules/aws-cdk-lib/pipelines/lib/docker-credentials.d.ts:34

`Abstract`_renderCdkAssetsConfig

_renderCdkAssetsConfig(): DockerCredentialCredentialSource
Internal
Creates and returns the credential configuration, to be used by cdk-assets to support the docker-credential-cdk-assets tool for docker login.

Returns DockerCredentialCredentialSource
- Defined in node_modules/aws-cdk-lib/pipelines/lib/docker-credentials.d.ts:45

`Abstract`grantRead

grantRead(grantee: IGrantable, usage: DockerCredentialUsage): void
Grant read-only access to the registry credentials. This grants read access to any secrets, and pull access to any repositories.
Parameters
- grantee: IGrantable
- usage: DockerCredentialUsage
Returns void
- Defined in node_modules/aws-cdk-lib/pipelines/lib/docker-credentials.d.ts:39

`Static`customRegistry

customRegistry(
    registryDomain: string,
    secret: ISecret,
    opts?: ExternalDockerCredentialOptions,
): DockerCredential
Creates a DockerCredential for a registry, based on its domain name (e.g., 'www.example.com').
Parameters
- registryDomain: string
- secret: ISecret
- Optionalopts: ExternalDockerCredentialOptions
Returns DockerCredential
- Defined in node_modules/aws-cdk-lib/pipelines/lib/docker-credentials.d.ts:18

`Static`dockerHub

dockerHub(
secret: ISecret,
opts?: ExternalDockerCredentialOptions,
): DockerCredential
Creates a DockerCredential for DockerHub. Convenience method for customRegistry('https://index.docker.io/v1/', opts).
Parameters
- secret: ISecret
- Optionalopts: ExternalDockerCredentialOptions
Returns DockerCredential
- Defined in node_modules/aws-cdk-lib/pipelines/lib/docker-credentials.d.ts:14

`Static`ecr

ecr(
repositories: IRepository[],
opts?: EcrDockerCredentialOptions,
): DockerCredential
Creates a DockerCredential for one or more ECR repositories.

NOTE - All ECR repositories in the same account and region share a domain name (e.g., 0123456789012.dkr.ecr.eu-west-1.amazonaws.com), and can only have one associated set of credentials (and DockerCredential). Attempting to associate one set of credentials with one ECR repo and another with another ECR repo in the same account and region will result in failures when using these credentials in the pipeline.
Parameters
- repositories: IRepository[]
- Optionalopts: EcrDockerCredentialOptions
Returns DockerCredential
- Defined in node_modules/aws-cdk-lib/pipelines/lib/docker-credentials.d.ts:28