software.amazon.awscdk.pipelines

Interface ExternalDockerCredentialOptions

All Known Implementing Classes:

ExternalDockerCredentialOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:37.685Z")
public interface ExternalDockerCredentialOptions

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 and Description
static class	ExternalDockerCredentialOptions.Builder A builder for ExternalDockerCredentialOptions
static class	ExternalDockerCredentialOptions.Jsii$Proxy An implementation for ExternalDockerCredentialOptions

Method Summary

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

Method Detail

getAssumeRole

default IRole getAssumeRole()

An IAM role to assume prior to accessing the secret.

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

getSecretPasswordField

default java.lang.String getSecretPasswordField()

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

Default: 'secret'

getSecretUsernameField

default java.lang.String getSecretUsernameField()

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

Default: 'username'

getUsages

default java.util.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

static ExternalDockerCredentialOptions.Builder builder()

Returns:

a ExternalDockerCredentialOptions.Builder of ExternalDockerCredentialOptions