software.amazon.awscdk.pipelines

Interface EcrDockerCredentialOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EcrDockerCredentialOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.938Z")
 @Stability(value=Stable)
public interface EcrDockerCredentialOptions
extends software.amazon.jsii.JsiiSerializable

Options for defining access for a Docker Credential composed of ECR repos.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.pipelines.*;
 Role role;
 EcrDockerCredentialOptions ecrDockerCredentialOptions = EcrDockerCredentialOptions.builder()
         .assumeRole(role)
         .usages(List.of(DockerCredentialUsage.SYNTH))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static EcrDockerCredentialOptions.Builder	builder()
default IRole	getAssumeRole() An IAM role to assume prior to accessing the secret.
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 Detail

getAssumeRole

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

An IAM role to assume prior to accessing the secret.

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

getUsages

@Stability(value=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(value=Stable)
static EcrDockerCredentialOptions.Builder builder()

Returns:

a EcrDockerCredentialOptions.Builder of EcrDockerCredentialOptions