Interface ExternalDockerCredentialOptions

Options for defining credentials for a Docker Credential

interface ExternalDockerCredentialOptions {
    assumeRole?: IRole;
    secretPasswordField?: string;
    secretUsernameField?: string;
    usages?: DockerCredentialUsage[];
}

Properties

assumeRole? secretPasswordField? secretUsernameField? usages?

Properties

Optional ReadonlyassumeRole

assumeRole?: IRole

An IAM role to assume prior to accessing the secret.

Default

- none. The current execution role will be used.

Optional ReadonlysecretPasswordField

secretPasswordField?: string

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

Default

'secret'

Optional ReadonlysecretUsernameField

secretUsernameField?: string

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

Default

'username'

Optional Readonlyusages

usages?: 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.

Settings

Member Visibility

On This Page

Properties