interface ExternalDockerCredentialOptions

Language	Type name
.NET	Amazon.CDK.Pipelines.ExternalDockerCredentialOptions
Go	github.com/aws/aws-cdk-go/awscdk/v2/pipelines#ExternalDockerCredentialOptions
Java	software.amazon.awscdk.pipelines.ExternalDockerCredentialOptions
Python	aws_cdk.pipelines.ExternalDockerCredentialOptions
TypeScript (source)	aws-cdk-lib » pipelines » ExternalDockerCredentialOptions

Options for defining credentials for a Docker Credential.

Example

const dockerHubSecret = secretsmanager.Secret.fromSecretCompleteArn(
  this,
  'DHSecret',
  'arn:aws:...'
);
// Only the image asset publishing actions will be granted read access to the secret.
const creds = pipelines.DockerCredential.dockerHub(dockerHubSecret, {
  usages: [pipelines.DockerCredentialUsage.ASSET_PUBLISHING],
});

Properties

Name	Type	Description
assumeRole?	IRole	An IAM role to assume prior to accessing the secret.
secretPasswordField?	string	The name of the JSON field of the secret which contains the secret/password.
secretUsernameField?	string	The name of the JSON field of the secret which contains the user/login name.
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.

---

secretPasswordField?

Type: string (optional, default: 'secret')

The name of the JSON field of the secret which contains the secret/password.

---

secretUsernameField?

Type: string (optional, default: 'username')

The name of the JSON field of the secret which contains the user/login name.

---

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.