Package software.amazon.awscdk.services.codebuild

Interface DockerImageOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DockerImageOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:05.894Z")
@Stability(Stable)
public interface DockerImageOptions
extends software.amazon.jsii.JsiiSerializable

The options when creating a CodeBuild Docker build image using LinuxBuildImage.fromDockerRegistry, WindowsBuildImage.fromDockerRegistry, or MacBuildImage.fromDockerRegistry.

Example:

 .environment(BuildEnvironment.builder()
         .buildImage(LinuxBuildImage.fromDockerRegistry("my-registry/my-repo", DockerImageOptions.builder()
                 .secretsManagerCredentials(secrets)
                 .build()))
         .build())
 .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DockerImageOptions.Builder	builder()
default ISecret	getSecretsManagerCredentials()	The credentials, stored in Secrets Manager, used for accessing the repository holding the image, if the repository is private.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSecretsManagerCredentials

@Stability(Stable)
@Nullable
default ISecret getSecretsManagerCredentials()

The credentials, stored in Secrets Manager, used for accessing the repository holding the image, if the repository is private.

Default: no credentials will be used (we assume the repository is public)

builder

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

Returns:

a DockerImageOptions.Builder of DockerImageOptions