Interface CfnProject.IEnvironmentProperty
Environment
is a property of the AWS::CodeBuild::Project resource that specifies the environment for an AWS CodeBuild project.
Namespace: Amazon.CDK.AWS.CodeBuild
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IEnvironmentProperty
Syntax (vb)
Public Interface IEnvironmentProperty
Remarks
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.AWS.CodeBuild;
var environmentProperty = new EnvironmentProperty {
ComputeType = "computeType",
Image = "image",
Type = "type",
// the properties below are optional
Certificate = "certificate",
EnvironmentVariables = new [] { new EnvironmentVariableProperty {
Name = "name",
Value = "value",
// the properties below are optional
Type = "type"
} },
Fleet = new ProjectFleetProperty {
FleetArn = "fleetArn"
},
ImagePullCredentialsType = "imagePullCredentialsType",
PrivilegedMode = false,
RegistryCredential = new RegistryCredentialProperty {
Credential = "credential",
CredentialProvider = "credentialProvider"
}
};
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. |
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.
virtual string Certificate { get; }
Property Value
System.String
Remarks
For more information, see certificate in the AWS CodeBuild User Guide .
ComputeType
The type of compute environment.
string ComputeType { get; }
Property Value
System.String
Remarks
This determines the number of CPU cores and memory the build environment uses. Available values include:
For more information, see Build Environment Compute Types in the AWS CodeBuild User Guide.
EnvironmentVariables
A set of environment variables to make available to builds for this build project.
virtual object EnvironmentVariables { get; }
Property Value
System.Object
Remarks
Fleet
virtual object Fleet { get; }
Property Value
System.Object
Remarks
Image
The image tag or image digest that identifies the Docker image to use for this build project.
string Image { get; }
Property Value
System.String
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:.
virtual string ImagePullCredentialsType { get; }
Property Value
System.String
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.
virtual object PrivilegedMode { get; }
Property Value
System.Object
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"
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:.
virtual object RegistryCredential { get; }
Property Value
System.Object
Remarks
Type
The type of build environment to use for related builds.
string Type { get; }
Property Value
System.String
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 .