Skip to content
v2.277.0

DockerImageOptions Struct ​

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

Example ​

ts
environment: {
  buildImage: codebuild.LinuxBuildImage.fromDockerRegistry('my-registry/my-repo', {
    secretsManagerCredentials: secrets,
  }),
},
python
environment=cdk.aws_codebuild.BuildEnvironment(
    build_image=codebuild.LinuxBuildImage.from_docker_registry("my-registry/my-repo",
        secrets_manager_credentials=secrets
    )
)
java
.environment(BuildEnvironment.builder()
        .buildImage(LinuxBuildImage.fromDockerRegistry("my-registry/my-repo", DockerImageOptions.builder()
                .secretsManagerCredentials(secrets)
                .build()))
        .build())
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
Environment = new BuildEnvironment {
    BuildImage = LinuxBuildImage.FromDockerRegistry("my-registry/my-repo", new DockerImageOptions {
        SecretsManagerCredentials = secrets
    })
}
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
Environment: &BuildEnvironment{
	BuildImage: codebuild.LinuxBuildImage_FromDockerRegistry(jsii.String("my-registry/my-repo"), &DockerImageOptions{
		SecretsManagerCredentials: secrets,
	}),
},

Properties ​

secretsManagerCredentialsoptionalISecretsecrets_manager_credentialsoptionalISecretsecretsManagerCredentialsoptionalISecretSecretsManagerCredentialsoptionalISecretSecretsManagerCredentialsoptionalISecret #
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)