aws-cdk-lib.pipelines.EcrDockerCredentialOptions

interface EcrDockerCredentialOptions

LanguageType name
.NETAmazon.CDK.Pipelines.EcrDockerCredentialOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2/pipelines#EcrDockerCredentialOptions
Javasoftware.amazon.awscdk.pipelines.EcrDockerCredentialOptions
Pythonaws_cdk.pipelines.EcrDockerCredentialOptions
TypeScript (source)aws-cdk-lib » pipelines » EcrDockerCredentialOptions

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

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

NameTypeDescription
assumeRole?IRoleAn IAM role to assume prior to accessing the secret.
usages?DockerCredentialUsage[]Defines which stages of the pipeline should be granted access to these credentials.

assumeRole?

Type: IRole (optional, default: none. The current execution role will be used.)

An IAM role to assume prior to accessing the secret.


usages?

Type: DockerCredentialUsage[] (optional, default: all relevant stages (synth, self-update, asset publishing) are granted access.)

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