Interface DockerServerOptions
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
DockerServerOptions.Jsii$Proxy
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
date="2025-11-13T16:10:00.996Z")
@Stability(Stable)
public interface DockerServerOptions
extends software.amazon.jsii.JsiiSerializable
The Docker server configuration CodeBuild use to build your Docker image.
Example:
Vpc vpc;
SecurityGroup mySecurityGroup;
CodeBuildStep.Builder.create("Synth")
// ...standard ShellStep props...
.commands(List.of())
.env(Map.of())
// If you are using a CodeBuildStep explicitly, set the 'cdk.out' directory
// to be the synth step's output.
.primaryOutputDirectory("cdk.out")
// Control the name of the project
.projectName("MyProject")
// Control parts of the BuildSpec other than the regular 'build' and 'install' commands
.partialBuildSpec(BuildSpec.fromObject(Map.of(
"version", "0.2")))
// Control the build environment
.buildEnvironment(BuildEnvironment.builder()
.computeType(ComputeType.LARGE)
.privileged(true)
.dockerServer(DockerServerOptions.builder()
.computeType(DockerServerComputeType.SMALL)
.securityGroups(List.of(mySecurityGroup))
.build())
.build())
.timeout(Duration.minutes(90))
.fileSystemLocations(List.of(FileSystemLocation.efs(EfsFileSystemLocationProps.builder()
.identifier("myidentifier2")
.location("myclodation.mydnsroot.com:/loc")
.mountPoint("/media")
.mountOptions("opts")
.build())))
// Control Elastic Network Interface creation
.vpc(vpc)
.subnetSelection(SubnetSelection.builder().subnetType(SubnetType.PRIVATE_WITH_EGRESS).build())
.securityGroups(List.of(mySecurityGroup))
// Control caching
.cache(Cache.bucket(new Bucket(this, "Cache")))
// Additional policy statements for the execution role
.rolePolicyStatements(List.of(
PolicyStatement.Builder.create().build()))
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forDockerServerOptionsstatic final classAn implementation forDockerServerOptions -
Method Summary
Modifier and TypeMethodDescriptionstatic DockerServerOptions.Builderbuilder()The type of compute to use for the docker server.default List<ISecurityGroup> A list of maximum 5 security groups.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getComputeType
The type of compute to use for the docker server.See the
DockerServerComputeTypeenum for the possible values. -
getSecurityGroups
A list of maximum 5 security groups.Default: - no security group
-
builder
- Returns:
- a
DockerServerOptions.BuilderofDockerServerOptions
-