Interface ExternalDockerCredentialOptions

All Superinterfaces:
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:49.825Z") @Stability(Stable) public interface ExternalDockerCredentialOptions extends
Options for defining credentials for a Docker Credential.


 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());
  • 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()
      a ExternalDockerCredentialOptions.Builder of ExternalDockerCredentialOptions