software.amazon.awscdk.services.codebuild

Interface CommonProjectProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

PipelineProjectProps, ProjectProps

All Known Implementing Classes:

CommonProjectProps.Jsii$Proxy, PipelineProjectProps.Jsii$Proxy, ProjectProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:00:53.036Z")
 @Stability(value=Experimental)
public interface CommonProjectProps
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CommonProjectProps.Builder A builder for CommonProjectProps
static class	CommonProjectProps.Jsii$Proxy An implementation for CommonProjectProps

Method Summary

Modifier and Type	Method and Description
static CommonProjectProps.Builder	builder()
default Boolean	getAllowAllOutbound() (experimental) Whether to allow the CodeBuild to send all network traffic.
default Boolean	getBadge() (experimental) Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.
default BuildSpec	getBuildSpec() (experimental) Filename or contents of buildspec in JSON format.
default Cache	getCache() (experimental) Caching strategy to use.
default Boolean	getCheckSecretsInPlainTextEnvVariables() (experimental) Whether to check for the presence of any secrets in the environment variables of the default type, BuildEnvironmentVariableType.PLAINTEXT.
default Number	getConcurrentBuildLimit() (experimental) Maximum number of concurrent builds.
default String	getDescription() (experimental) A description of the project.
default IKey	getEncryptionKey() (experimental) Encryption key to use to read and write artifacts.
default BuildEnvironment	getEnvironment() (experimental) Build environment to use for the build.
default Map<String,BuildEnvironmentVariable>	getEnvironmentVariables() (experimental) Additional environment variables to add to the build environment.
default List<IFileSystemLocation>	getFileSystemLocations() (experimental) An ProjectFileSystemLocation objects for a CodeBuild build project.
default Boolean	getGrantReportGroupPermissions() (experimental) Add permissions to this project's role to create and use test report groups with name starting with the name of this project.
default LoggingOptions	getLogging() (experimental) Information about logs for the build project.
default String	getProjectName() (experimental) The physical, human-readable name of the CodeBuild Project.
default Duration	getQueuedTimeout() (experimental) The number of minutes after which AWS CodeBuild stops the build if it's still in queue.
default IRole	getRole() (experimental) Service Role to assume while running the build.
default List<ISecurityGroup>	getSecurityGroups() (experimental) What security group to associate with the codebuild project's network interfaces.
default SubnetSelection	getSubnetSelection() (experimental) Where to place the network interfaces within the VPC.
default Duration	getTimeout() (experimental) The number of minutes after which AWS CodeBuild stops the build if it's not complete.
default IVpc	getVpc() (experimental) VPC network to place codebuild network interfaces.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAllowAllOutbound

@Stability(value=Experimental)
 @Nullable
default Boolean getAllowAllOutbound()

(experimental) Whether to allow the CodeBuild to send all network traffic.

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

getBadge

@Stability(value=Experimental)
 @Nullable
default Boolean getBadge()

(experimental) Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.

For more information, see Build Badges Sample in the AWS CodeBuild User Guide.

Default: false

getBuildSpec

@Stability(value=Experimental)
 @Nullable
default BuildSpec getBuildSpec()

(experimental) Filename or contents of buildspec in JSON format.

Default: - Empty buildspec.

See Also:

https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-example

getCache

@Stability(value=Experimental)
 @Nullable
default Cache getCache()

(experimental) Caching strategy to use.

Default: Cache.none

getCheckSecretsInPlainTextEnvVariables

@Stability(value=Experimental)
 @Nullable
default Boolean getCheckSecretsInPlainTextEnvVariables()

(experimental) Whether to check for the presence of any secrets in the environment variables of the default type, BuildEnvironmentVariableType.PLAINTEXT. Since using a secret for the value of that kind of variable would result in it being displayed in plain text in the AWS Console, the construct will throw an exception if it detects a secret was passed there. Pass this property as false if you want to skip this validation, and keep using a secret in a plain text environment variable.

Default: true

getConcurrentBuildLimit

@Stability(value=Experimental)
 @Nullable
default Number getConcurrentBuildLimit()

(experimental) Maximum number of concurrent builds.

Minimum value is 1 and maximum is account build limit.

Default: - no explicit limit is set

getDescription

@Stability(value=Experimental)
 @Nullable
default String getDescription()

(experimental) A description of the project.

Use the description to identify the purpose of the project.

Default: - No description.

getEncryptionKey

@Stability(value=Experimental)
 @Nullable
default IKey getEncryptionKey()

(experimental) Encryption key to use to read and write artifacts.

Default: - The AWS-managed CMK for Amazon Simple Storage Service (Amazon S3) is used.

getEnvironment

@Stability(value=Experimental)
 @Nullable
default BuildEnvironment getEnvironment()

(experimental) Build environment to use for the build.

Default: BuildEnvironment.LinuxBuildImage.STANDARD_1_0

getEnvironmentVariables

@Stability(value=Experimental)
 @Nullable
default Map<String,BuildEnvironmentVariable> getEnvironmentVariables()

(experimental) Additional environment variables to add to the build environment.

Default: - No additional environment variables are specified.

getFileSystemLocations

@Stability(value=Experimental)
 @Nullable
default List<IFileSystemLocation> getFileSystemLocations()

(experimental) An ProjectFileSystemLocation objects for a CodeBuild build project.

A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.

Default: - no file system locations

getGrantReportGroupPermissions

@Stability(value=Experimental)
 @Nullable
default Boolean getGrantReportGroupPermissions()

(experimental) Add permissions to this project's role to create and use test report groups with name starting with the name of this project.

That is the standard report group that gets created when a simple name (in contrast to an ARN) is used in the 'reports' section of the buildspec of this project. This is usually harmless, but you can turn these off if you don't plan on using test reports in this project.

Default: true

See Also:

https://docs.aws.amazon.com/codebuild/latest/userguide/test-report-group-naming.html

getLogging

@Stability(value=Experimental)
 @Nullable
default LoggingOptions getLogging()

(experimental) Information about logs for the build project.

A project can create logs in Amazon CloudWatch Logs, an S3 bucket, or both.

Default: - no log configuration is set

getProjectName

@Stability(value=Experimental)
 @Nullable
default String getProjectName()

(experimental) The physical, human-readable name of the CodeBuild Project.

Default: - Name is automatically generated.

getQueuedTimeout

@Stability(value=Experimental)
 @Nullable
default Duration getQueuedTimeout()

(experimental) The number of minutes after which AWS CodeBuild stops the build if it's still in queue.

For valid values, see the timeoutInMinutes field in the AWS CodeBuild User Guide.

Default: - no queue timeout is set

getRole

@Stability(value=Experimental)
 @Nullable
default IRole getRole()

(experimental) Service Role to assume while running the build.

Default: - A role will be created.

getSecurityGroups

@Stability(value=Experimental)
 @Nullable
default List<ISecurityGroup> getSecurityGroups()

(experimental) What security group to associate with the codebuild project's network interfaces.

If no security group is identified, one will be created automatically.

Only used if 'vpc' is supplied.

Default: - Security group will be automatically created.

getSubnetSelection

@Stability(value=Experimental)
 @Nullable
default SubnetSelection getSubnetSelection()

(experimental) Where to place the network interfaces within the VPC.

Only used if 'vpc' is supplied.

Default: - All private subnets.

getTimeout

@Stability(value=Experimental)
 @Nullable
default Duration getTimeout()

(experimental) The number of minutes after which AWS CodeBuild stops the build if it's not complete.

For valid values, see the timeoutInMinutes field in the AWS CodeBuild User Guide.

Default: Duration.hours(1)

getVpc

@Stability(value=Experimental)
 @Nullable
default IVpc getVpc()

(experimental) VPC network to place codebuild network interfaces.

Specify this if the codebuild project needs to access resources in a VPC.

Default: - No VPC is specified.

builder

@Stability(value=Experimental)
static CommonProjectProps.Builder builder()

Returns:

a CommonProjectProps.Builder of CommonProjectProps