aws-cdk-lib.pipelines.EcrDockerCredentialOptions

EcrDockerCredentialOptions Struct

Options for defining access for a Docker Credential composed of ECR repos.

Source

pipelines/lib/docker-credentials.ts

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iam as iam } from 'aws-cdk-lib';
import { pipelines } from 'aws-cdk-lib';

declare const role: iam.Role;
const ecrDockerCredentialOptions: pipelines.EcrDockerCredentialOptions = {
  assumeRole: role,
  usages: [pipelines.DockerCredentialUsage.SYNTH],
};

Properties

assumeRole?optionalIRoleassume_role?optionalIRoleassumeRole?optionalIRoleAssumeRole?optionalIRoleAssumeRole?optionalIRole#

An IAM role to assume prior to accessing the secret.

Default: none. The current execution role will be used.

usages?optionalDockerCredentialUsage[]usages?optionaltyping.List[DockerCredentialUsage]usages?optionalList<DockerCredentialUsage>Usages?optionalDockerCredentialUsage[]Usages?optional*[]DockerCredentialUsage#

Defines which stages of the pipeline should be granted access to these credentials.

Default: all relevant stages (synth, self-update, asset publishing) are granted access.