Class PipelineProjectProps
Inheritance
Namespace: Amazon.CDK.AWS.CodeBuild
Assembly: Amazon.CDK.AWS.CodeBuild.dll
Syntax (csharp)
public class PipelineProjectProps : Object, IPipelineProjectProps, ICommonProjectProps
Syntax (vb)
Public Class PipelineProjectProps
Inherits Object
Implements IPipelineProjectProps, ICommonProjectProps
Remarks
stability: Stable
Synopsis
Constructors
PipelineProjectProps() |
Properties
AllowAllOutbound | Whether to allow the CodeBuild to send all network traffic. |
Badge | Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge. |
BuildSpec | Filename or contents of buildspec in JSON format. |
Cache | Caching strategy to use. |
Description | A description of the project. |
EncryptionKey | Encryption key to use to read and write artifacts. |
Environment | Build environment to use for the build. |
EnvironmentVariables | Additional environment variables to add to the build environment. |
ProjectName | The physical, human-readable name of the CodeBuild Project. |
Role | Service Role to assume while running the build. |
SecurityGroups | What security group to associate with the codebuild project's network interfaces. If no security group is identified, one will be created automatically. |
SubnetSelection | Where to place the network interfaces within the VPC. |
Timeout | The number of minutes after which AWS CodeBuild stops the build if it's not complete. |
Vpc | VPC network to place codebuild network interfaces. |
Constructors
PipelineProjectProps()
public PipelineProjectProps()
Properties
AllowAllOutbound
Whether to allow the CodeBuild to send all network traffic.
public Nullable<bool> AllowAllOutbound { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
If set to false, you must individually add traffic rules to allow the CodeBuild project to connect to network targets.
Only used if 'vpc' is supplied. default: true stability: Stable
Badge
Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.
public Nullable<bool> Badge { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
For more information, see Build Badges Sample in the AWS CodeBuild User Guide. default: false stability: Stable
BuildSpec
Filename or contents of buildspec in JSON format.
public BuildSpec BuildSpec { get; set; }
Property Value
Remarks
default:
- Empty buildspec. stability: Stable see: https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-example
Cache
Caching strategy to use.
public Cache Cache { get; set; }
Property Value
Remarks
default: Cache.none stability: Stable
Description
A description of the project.
public string Description { get; set; }
Property Value
System.String
Remarks
Use the description to identify the purpose of the project. default:
- No description. stability: Stable
EncryptionKey
Encryption key to use to read and write artifacts.
public IKey EncryptionKey { get; set; }
Property Value
Remarks
default:
- The AWS-managed CMK for Amazon Simple Storage Service (Amazon S3) is used. stability: Stable
Environment
Build environment to use for the build.
public IBuildEnvironment Environment { get; set; }
Property Value
Remarks
default: BuildEnvironment.LinuxBuildImage.STANDARD_1_0 stability: Stable
EnvironmentVariables
Additional environment variables to add to the build environment.
public IDictionary<string, IBuildEnvironmentVariable> EnvironmentVariables { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, IBuildEnvironmentVariable>
Remarks
default:
- No additional environment variables are specified. stability: Stable
ProjectName
The physical, human-readable name of the CodeBuild Project.
public string ProjectName { get; set; }
Property Value
System.String
Remarks
default:
- Name is automatically generated. stability: Stable
Role
Service Role to assume while running the build.
public IRole Role { get; set; }
Property Value
Remarks
default:
- A role will be created. stability: Stable
SecurityGroups
What security group to associate with the codebuild project's network interfaces. If no security group is identified, one will be created automatically.
public ISecurityGroup[] SecurityGroups { get; set; }
Property Value
Remarks
Only used if 'vpc' is supplied. default:
- Security group will be automatically created. stability: Stable
SubnetSelection
Where to place the network interfaces within the VPC.
public ISubnetSelection SubnetSelection { get; set; }
Property Value
Remarks
Only used if 'vpc' is supplied. default:
- All private subnets. stability: Stable
Timeout
The number of minutes after which AWS CodeBuild stops the build if it's not complete.
public Duration Timeout { get; set; }
Property Value
Remarks
For valid values, see the timeoutInMinutes field in the AWS CodeBuild User Guide. default: Duration.hours(1) stability: Stable
Vpc
VPC network to place codebuild network interfaces.
public IVpc Vpc { get; set; }
Property Value
Remarks
Specify this if the codebuild project needs to access resources in a VPC. default:
- No VPC is specified. stability: Stable