Interface CfnProjectPropsMixin.IEnvironmentProperty
Environment is a property of the AWS::CodeBuild::Project resource that specifies the environment for an AWS CodeBuild project.
Namespace: Amazon.CDK.Mixins.Preview.AWS.CodeBuild.Mixins
Assembly: Amazon.CDK.Mixins.Preview.dll
Syntax (csharp)
public interface CfnProjectPropsMixin.IEnvironmentPropertySyntax (vb)
Public Interface CfnProjectPropsMixin.IEnvironmentPropertyRemarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.Mixins.Preview.AWS.CodeBuild.Mixins;
var environmentProperty = new EnvironmentProperty {
Certificate = "certificate",
ComputeType = "computeType",
DockerServer = new DockerServerProperty {
ComputeType = "computeType",
SecurityGroupIds = new [] { "securityGroupIds" }
},
EnvironmentVariables = new [] { new EnvironmentVariableProperty {
Name = "name",
Type = "type",
Value = "value"
} },
Fleet = new ProjectFleetProperty {
FleetArn = "fleetArn"
},
Image = "image",
ImagePullCredentialsType = "imagePullCredentialsType",
PrivilegedMode = false,
RegistryCredential = new RegistryCredentialProperty {
Credential = "credential",
CredentialProvider = "credentialProvider"
},
Type = "type"
};Synopsis
Properties
| Certificate | The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project. |
| ComputeType | The type of compute environment. |
| DockerServer |
|
| EnvironmentVariables | A set of environment variables to make available to builds for this build project. |
| Fleet |
|
| Image | The image tag or image digest that identifies the Docker image to use for this build project. |
| ImagePullCredentialsType | The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:. |
| PrivilegedMode | Enables running the Docker daemon inside a Docker container. |
| RegistryCredential |
|
| Type | The type of build environment to use for related builds. |
Properties
Certificate
The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project.
string? Certificate { get; }Property Value
Remarks
For more information, see certificate in the AWS CodeBuild User Guide .
ComputeType
The type of compute environment.
string? ComputeType { get; }Property Value
Remarks
This determines the number of CPU cores and memory the build environment uses. Available values include:
If you use <code>ATTRIBUTE_BASED_COMPUTE</code> , you must define your attributes by using <code>computeConfiguration</code> . AWS CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html#environment-reserved-capacity.types">Reserved capacity environment types</a> in the <em>AWS CodeBuild User Guide</em> .
If you use BUILD_GENERAL1_SMALL :
If you use BUILD_GENERAL1_LARGE :
For more information, see On-demand environment types in the AWS CodeBuild User Guide.
DockerServer
Environment is a property of the AWS::CodeBuild::Project resource that specifies the environment for an AWS CodeBuild project.
object? DockerServer { get; }Property Value
Remarks
EnvironmentVariables
A set of environment variables to make available to builds for this build project.
object? EnvironmentVariables { get; }Property Value
Remarks
Fleet
Environment is a property of the AWS::CodeBuild::Project resource that specifies the environment for an AWS CodeBuild project.
object? Fleet { get; }Property Value
Remarks
Image
The image tag or image digest that identifies the Docker image to use for this build project.
string? Image { get; }Property Value
Remarks
Use the following formats:
For more information, see Docker images provided by CodeBuild in the AWS CodeBuild user guide .
ImagePullCredentialsType
The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:.
string? ImagePullCredentialsType { get; }Property Value
Remarks
When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials.
PrivilegedMode
Enables running the Docker daemon inside a Docker container.
object? PrivilegedMode { get; }Property Value
Remarks
Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. The default setting is false .
You can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands to the install phase of your buildspec file:
If the operating system's base image is Ubuntu Linux:
- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&
- timeout 15 sh -c "until docker info; do echo .; sleep 1; done"
If the operating system's base image is Alpine Linux and the previous command does not work, add the -t argument to timeout :
- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&
- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"
Type union: either bool or IResolvable
RegistryCredential
RegistryCredential is a property of the AWS::CodeBuild::Project Environment property that specifies information about credentials that provide access to a private Docker registry. When this is set:.
object? RegistryCredential { get; }Property Value
Remarks
Type
The type of build environment to use for related builds.
string? Type { get; }Property Value
Remarks
If you're using compute fleets during project creation, <code>type</code> will be ignored.
For more information, see Build environment compute types in the AWS CodeBuild user guide .