DockerImageOptions

class aws_cdk.aws_codebuild.DockerImageOptions(*, secrets_manager_credentials=None)

Bases: object

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

Parameters:

secrets_manager_credentials (Optional[ISecret]) – 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)

ExampleMetadata:

lit=aws-codebuild/test/integ.docker-registry.lit.ts infused

Example:

environment=cdk.aws_codebuild.BuildEnvironment(
    build_image=codebuild.LinuxBuildImage.from_docker_registry("my-registry/my-repo",
        secrets_manager_credentials=secrets
    )
)

Attributes

secrets_manager_credentials

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)