Package software.amazon.awscdk.pipelines

Interface ExternalDockerCredentialOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ExternalDockerCredentialOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:50.930Z")
@Stability(Stable)
public interface ExternalDockerCredentialOptions
extends software.amazon.jsii.JsiiSerializable

Options for defining credentials for a Docker Credential.

Example:

 ISecret dockerHubSecret = Secret.fromSecretCompleteArn(this, "DHSecret", "arn:aws:...");
 // Only the image asset publishing actions will be granted read access to the secret.
 DockerCredential creds = DockerCredential.dockerHub(dockerHubSecret, ExternalDockerCredentialOptions.builder()
         .usages(List.of(DockerCredentialUsage.ASSET_PUBLISHING))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ExternalDockerCredentialOptions.Builder	A builder for ExternalDockerCredentialOptions
static final class	ExternalDockerCredentialOptions.Jsii$Proxy	An implementation for ExternalDockerCredentialOptions

Method Summary

Modifier and Type	Method	Description
static ExternalDockerCredentialOptions.Builder	builder()
default IRole	getAssumeRole()	An IAM role to assume prior to accessing the secret.
default String	getSecretPasswordField()	The name of the JSON field of the secret which contains the secret/password.
default String	getSecretUsernameField()	The name of the JSON field of the secret which contains the user/login name.
default List<DockerCredentialUsage>	getUsages()	Defines which stages of the pipeline should be granted access to these credentials.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAssumeRole

@Stability(Stable)
@Nullable
default IRole getAssumeRole()

An IAM role to assume prior to accessing the secret.

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

getSecretPasswordField

@Stability(Stable)
@Nullable
default String getSecretPasswordField()

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

Default: 'secret'

getSecretUsernameField

@Stability(Stable)
@Nullable
default String getSecretUsernameField()

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

Default: 'username'

getUsages

@Stability(Stable)
@Nullable
default List<DockerCredentialUsage> getUsages()

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.

builder

@Stability(Stable)
static ExternalDockerCredentialOptions.Builder builder()

Returns:

a ExternalDockerCredentialOptions.Builder of ExternalDockerCredentialOptions