Class CfnProject
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.codebuild.CfnProject
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-10-31T19:12:54.717Z")
@Stability(Stable)
public class CfnProject
extends CfnResource
implements IInspectable, ITaggable
The
AWS::CodeBuild::Project
resource configures how AWS CodeBuild builds your source code.
For example, it tells CodeBuild where to get the source code and which build environment to use.
To unset or remove a project value via CFN, explicitly provide the attribute with value as empty input.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.codebuild.*; CfnProject cfnProject = CfnProject.Builder.create(this, "MyCfnProject") .artifacts(ArtifactsProperty.builder() .type("type") // the properties below are optional .artifactIdentifier("artifactIdentifier") .encryptionDisabled(false) .location("location") .name("name") .namespaceType("namespaceType") .overrideArtifactName(false) .packaging("packaging") .path("path") .build()) .environment(EnvironmentProperty.builder() .computeType("computeType") .image("image") .type("type") // the properties below are optional .certificate("certificate") .environmentVariables(List.of(EnvironmentVariableProperty.builder() .name("name") .value("value") // the properties below are optional .type("type") .build())) .fleet(ProjectFleetProperty.builder() .fleetArn("fleetArn") .build()) .imagePullCredentialsType("imagePullCredentialsType") .privilegedMode(false) .registryCredential(RegistryCredentialProperty.builder() .credential("credential") .credentialProvider("credentialProvider") .build()) .build()) .serviceRole("serviceRole") .source(SourceProperty.builder() .type("type") // the properties below are optional .auth(SourceAuthProperty.builder() .type("type") // the properties below are optional .resource("resource") .build()) .buildSpec("buildSpec") .buildStatusConfig(BuildStatusConfigProperty.builder() .context("context") .targetUrl("targetUrl") .build()) .gitCloneDepth(123) .gitSubmodulesConfig(GitSubmodulesConfigProperty.builder() .fetchSubmodules(false) .build()) .insecureSsl(false) .location("location") .reportBuildStatus(false) .sourceIdentifier("sourceIdentifier") .build()) // the properties below are optional .badgeEnabled(false) .buildBatchConfig(ProjectBuildBatchConfigProperty.builder() .batchReportMode("batchReportMode") .combineArtifacts(false) .restrictions(BatchRestrictionsProperty.builder() .computeTypesAllowed(List.of("computeTypesAllowed")) .maximumBuildsAllowed(123) .build()) .serviceRole("serviceRole") .timeoutInMins(123) .build()) .cache(ProjectCacheProperty.builder() .type("type") // the properties below are optional .location("location") .modes(List.of("modes")) .build()) .concurrentBuildLimit(123) .description("description") .encryptionKey("encryptionKey") .fileSystemLocations(List.of(ProjectFileSystemLocationProperty.builder() .identifier("identifier") .location("location") .mountPoint("mountPoint") .type("type") // the properties below are optional .mountOptions("mountOptions") .build())) .logsConfig(LogsConfigProperty.builder() .cloudWatchLogs(CloudWatchLogsConfigProperty.builder() .status("status") // the properties below are optional .groupName("groupName") .streamName("streamName") .build()) .s3Logs(S3LogsConfigProperty.builder() .status("status") // the properties below are optional .encryptionDisabled(false) .location("location") .build()) .build()) .name("name") .queuedTimeoutInMinutes(123) .resourceAccessRole("resourceAccessRole") .secondaryArtifacts(List.of(ArtifactsProperty.builder() .type("type") // the properties below are optional .artifactIdentifier("artifactIdentifier") .encryptionDisabled(false) .location("location") .name("name") .namespaceType("namespaceType") .overrideArtifactName(false) .packaging("packaging") .path("path") .build())) .secondarySources(List.of(SourceProperty.builder() .type("type") // the properties below are optional .auth(SourceAuthProperty.builder() .type("type") // the properties below are optional .resource("resource") .build()) .buildSpec("buildSpec") .buildStatusConfig(BuildStatusConfigProperty.builder() .context("context") .targetUrl("targetUrl") .build()) .gitCloneDepth(123) .gitSubmodulesConfig(GitSubmodulesConfigProperty.builder() .fetchSubmodules(false) .build()) .insecureSsl(false) .location("location") .reportBuildStatus(false) .sourceIdentifier("sourceIdentifier") .build())) .secondarySourceVersions(List.of(ProjectSourceVersionProperty.builder() .sourceIdentifier("sourceIdentifier") // the properties below are optional .sourceVersion("sourceVersion") .build())) .sourceVersion("sourceVersion") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .timeoutInMinutes(123) .triggers(ProjectTriggersProperty.builder() .buildType("buildType") .filterGroups(List.of(List.of(WebhookFilterProperty.builder() .pattern("pattern") .type("type") // the properties below are optional .excludeMatchedPattern(false) .build()))) .scopeConfiguration(ScopeConfigurationProperty.builder() .name("name") .build()) .webhook(false) .build()) .visibility("visibility") .vpcConfig(VpcConfigProperty.builder() .securityGroupIds(List.of("securityGroupIds")) .subnets(List.of("subnets")) .vpcId("vpcId") .build()) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
Artifacts
is a property of the AWS::CodeBuild::Project resource that specifies output settings for artifacts generated by an AWS CodeBuild build.static interface
Specifies restrictions for the batch build.static final class
A fluent builder forCfnProject
.static interface
Contains information that defines how the AWS CodeBuild build project reports the build status to the source provider.static interface
CloudWatchLogs
is a property of the AWS CodeBuild Project LogsConfig property type that specifies settings for CloudWatch logs generated by an AWS CodeBuild build.static interface
Environment
is a property of the AWS::CodeBuild::Project resource that specifies the environment for an AWS CodeBuild project.static interface
EnvironmentVariable
is a property of the AWS CodeBuild Project Environment property type that specifies the name and value of an environment variable for an AWS CodeBuild project environment.static interface
GitSubmodulesConfig
is a property of the AWS CodeBuild Project Source property type that specifies information about the Git submodules configuration for the build project.static interface
LogsConfig
is a property of the AWS CodeBuild Project resource that specifies information about logs for a build project.static interface
Contains configuration information about a batch build project.static interface
ProjectCache
is a property of the AWS CodeBuild Project resource that specifies information about the cache for the build project.static interface
Information about a file system created by Amazon Elastic File System (EFS).static interface
Information about the compute fleet of the build project.static interface
A source identifier and its corresponding version.static interface
ProjectTriggers
is a property of the AWS CodeBuild Project resource that specifies webhooks that trigger an AWS CodeBuild build.static interface
RegistryCredential
is a property of the AWS CodeBuild Project Environment property type that specifies information about credentials that provide access to a private Docker registry.static interface
S3Logs
is a property of the AWS CodeBuild Project LogsConfig property type that specifies settings for logs generated by an AWS CodeBuild build in an S3 bucket.static interface
Contains configuration information about the scope for a webhook.static interface
SourceAuth
is a property of the AWS CodeBuild Project Source property type that specifies authorization settings for AWS CodeBuild to access the source code to be built.static interface
Source
is a property of the AWS::CodeBuild::Project resource that specifies the source code settings for the project, such as the source code's repository type and location.static interface
VpcConfig
is a property of the AWS::CodeBuild::Project resource that enable AWS CodeBuild to access resources in an Amazon VPC.static interface
WebhookFilter
is a structure of theFilterGroups
property on the AWS CodeBuild Project ProjectTriggers property type that specifies which webhooks trigger an AWS CodeBuild build.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnProject
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnProject
(software.amazon.jsii.JsiiObjectRef objRef) CfnProject
(software.constructs.Construct scope, String id, CfnProjectProps props) -
Method Summary
Modifier and TypeMethodDescriptionArtifacts
is a property of the AWS::CodeBuild::Project resource that specifies output settings for artifacts generated by an AWS CodeBuild build.The ARN of the AWS CodeBuild project, such asarn:aws:codebuild:us-west-2:123456789012:project/myProjectName
.Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.AProjectBuildBatchConfig
object that defines the batch build options for the project.getCache()
Settings that AWS CodeBuild uses to store and reuse build dependencies.The maximum number of concurrent builds that are allowed for this project.A description that makes the build project easy to identify.The AWS Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.The build environment settings for the project, such as the environment type or the environment variables to use for the build environment.An array ofProjectFileSystemLocation
objects for a CodeBuild build project.Information about logs for the build project.getName()
The name of the build project.The number of minutes a build is allowed to be queued before it times out.The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.A list ofArtifacts
objects.An array ofProjectSource
objects.An array ofProjectSourceVersion
objects.The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.The source code settings for the project, such as the source code's repository type and location.A version of the build input to be built for this project.getTags()
Tag Manager which manages the tags for this resource.An arbitrary set of tags (key-value pairs) for the AWS CodeBuild project.How long, in minutes, from 5 to 2160 (36 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed.For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, enables AWS CodeBuild to begin automatically rebuilding the source code every time a code change is pushed to the repository.Specifies the visibility of the project's builds.VpcConfig
specifies settings that enable AWS CodeBuild to access resources in an Amazon VPC.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setArtifacts
(IResolvable value) Artifacts
is a property of the AWS::CodeBuild::Project resource that specifies output settings for artifacts generated by an AWS CodeBuild build.void
Artifacts
is a property of the AWS::CodeBuild::Project resource that specifies output settings for artifacts generated by an AWS CodeBuild build.void
setBadgeEnabled
(Boolean value) Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.void
setBadgeEnabled
(IResolvable value) Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.void
setBuildBatchConfig
(IResolvable value) AProjectBuildBatchConfig
object that defines the batch build options for the project.void
AProjectBuildBatchConfig
object that defines the batch build options for the project.void
setCache
(IResolvable value) Settings that AWS CodeBuild uses to store and reuse build dependencies.void
Settings that AWS CodeBuild uses to store and reuse build dependencies.void
setConcurrentBuildLimit
(Number value) The maximum number of concurrent builds that are allowed for this project.void
setDescription
(String value) A description that makes the build project easy to identify.void
setEncryptionKey
(String value) The AWS Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.void
setEnvironment
(IResolvable value) The build environment settings for the project, such as the environment type or the environment variables to use for the build environment.void
The build environment settings for the project, such as the environment type or the environment variables to use for the build environment.void
setFileSystemLocations
(List<Object> value) An array ofProjectFileSystemLocation
objects for a CodeBuild build project.void
An array ofProjectFileSystemLocation
objects for a CodeBuild build project.void
setLogsConfig
(IResolvable value) Information about logs for the build project.void
Information about logs for the build project.void
The name of the build project.void
setQueuedTimeoutInMinutes
(Number value) The number of minutes a build is allowed to be queued before it times out.void
setResourceAccessRole
(String value) The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.void
setSecondaryArtifacts
(List<Object> value) A list ofArtifacts
objects.void
setSecondaryArtifacts
(IResolvable value) A list ofArtifacts
objects.void
setSecondarySources
(List<Object> value) An array ofProjectSource
objects.void
setSecondarySources
(IResolvable value) An array ofProjectSource
objects.void
setSecondarySourceVersions
(List<Object> value) An array ofProjectSourceVersion
objects.void
An array ofProjectSourceVersion
objects.void
setServiceRole
(String value) The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.void
setSource
(IResolvable value) The source code settings for the project, such as the source code's repository type and location.void
The source code settings for the project, such as the source code's repository type and location.void
setSourceVersion
(String value) A version of the build input to be built for this project.void
setTagsRaw
(List<CfnTag> value) An arbitrary set of tags (key-value pairs) for the AWS CodeBuild project.void
setTimeoutInMinutes
(Number value) How long, in minutes, from 5 to 2160 (36 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed.void
setTriggers
(IResolvable value) For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, enables AWS CodeBuild to begin automatically rebuilding the source code every time a code change is pushed to the repository.void
For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, enables AWS CodeBuild to begin automatically rebuilding the source code every time a code change is pushed to the repository.void
setVisibility
(String value) Specifies the visibility of the project's builds.void
setVpcConfig
(IResolvable value) VpcConfig
specifies settings that enable AWS CodeBuild to access resources in an Amazon VPC.void
VpcConfig
specifies settings that enable AWS CodeBuild to access resources in an Amazon VPC.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnProject
protected CfnProject(software.amazon.jsii.JsiiObjectRef objRef) -
CfnProject
protected CfnProject(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnProject
@Stability(Stable) public CfnProject(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnProjectProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The ARN of the AWS CodeBuild project, such asarn:aws:codebuild:us-west-2:123456789012:project/myProjectName
. -
getAttrId
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getArtifacts
Artifacts
is a property of the AWS::CodeBuild::Project resource that specifies output settings for artifacts generated by an AWS CodeBuild build. -
setArtifacts
Artifacts
is a property of the AWS::CodeBuild::Project resource that specifies output settings for artifacts generated by an AWS CodeBuild build. -
setArtifacts
Artifacts
is a property of the AWS::CodeBuild::Project resource that specifies output settings for artifacts generated by an AWS CodeBuild build. -
getEnvironment
The build environment settings for the project, such as the environment type or the environment variables to use for the build environment. -
setEnvironment
The build environment settings for the project, such as the environment type or the environment variables to use for the build environment. -
setEnvironment
The build environment settings for the project, such as the environment type or the environment variables to use for the build environment. -
getServiceRole
The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account. -
setServiceRole
The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account. -
getSource
The source code settings for the project, such as the source code's repository type and location. -
setSource
The source code settings for the project, such as the source code's repository type and location. -
setSource
The source code settings for the project, such as the source code's repository type and location. -
getBadgeEnabled
Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge. -
setBadgeEnabled
Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge. -
setBadgeEnabled
Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge. -
getBuildBatchConfig
AProjectBuildBatchConfig
object that defines the batch build options for the project. -
setBuildBatchConfig
AProjectBuildBatchConfig
object that defines the batch build options for the project. -
setBuildBatchConfig
@Stability(Stable) public void setBuildBatchConfig(@Nullable CfnProject.ProjectBuildBatchConfigProperty value) AProjectBuildBatchConfig
object that defines the batch build options for the project. -
getCache
Settings that AWS CodeBuild uses to store and reuse build dependencies. -
setCache
Settings that AWS CodeBuild uses to store and reuse build dependencies. -
setCache
Settings that AWS CodeBuild uses to store and reuse build dependencies. -
getConcurrentBuildLimit
The maximum number of concurrent builds that are allowed for this project. -
setConcurrentBuildLimit
The maximum number of concurrent builds that are allowed for this project. -
getDescription
A description that makes the build project easy to identify. -
setDescription
A description that makes the build project easy to identify. -
getEncryptionKey
The AWS Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts. -
setEncryptionKey
The AWS Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts. -
getFileSystemLocations
An array ofProjectFileSystemLocation
objects for a CodeBuild build project. -
setFileSystemLocations
An array ofProjectFileSystemLocation
objects for a CodeBuild build project. -
setFileSystemLocations
An array ofProjectFileSystemLocation
objects for a CodeBuild build project. -
getLogsConfig
Information about logs for the build project. -
setLogsConfig
Information about logs for the build project. -
setLogsConfig
Information about logs for the build project. -
getName
The name of the build project. -
setName
The name of the build project. -
getQueuedTimeoutInMinutes
The number of minutes a build is allowed to be queued before it times out. -
setQueuedTimeoutInMinutes
The number of minutes a build is allowed to be queued before it times out. -
getResourceAccessRole
The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds. -
setResourceAccessRole
The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds. -
getSecondaryArtifacts
A list ofArtifacts
objects. -
setSecondaryArtifacts
A list ofArtifacts
objects. -
setSecondaryArtifacts
A list ofArtifacts
objects. -
getSecondarySources
An array ofProjectSource
objects. -
setSecondarySources
An array ofProjectSource
objects. -
setSecondarySources
An array ofProjectSource
objects. -
getSecondarySourceVersions
An array ofProjectSourceVersion
objects. -
setSecondarySourceVersions
An array ofProjectSourceVersion
objects. -
setSecondarySourceVersions
An array ofProjectSourceVersion
objects. -
getSourceVersion
A version of the build input to be built for this project. -
setSourceVersion
A version of the build input to be built for this project. -
getTagsRaw
An arbitrary set of tags (key-value pairs) for the AWS CodeBuild project. -
setTagsRaw
An arbitrary set of tags (key-value pairs) for the AWS CodeBuild project. -
getTimeoutInMinutes
How long, in minutes, from 5 to 2160 (36 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed. -
setTimeoutInMinutes
How long, in minutes, from 5 to 2160 (36 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed. -
getTriggers
For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, enables AWS CodeBuild to begin automatically rebuilding the source code every time a code change is pushed to the repository. -
setTriggers
For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, enables AWS CodeBuild to begin automatically rebuilding the source code every time a code change is pushed to the repository. -
setTriggers
For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, enables AWS CodeBuild to begin automatically rebuilding the source code every time a code change is pushed to the repository. -
getVisibility
Specifies the visibility of the project's builds.Possible values are:.
-
setVisibility
Specifies the visibility of the project's builds.Possible values are:.
-
getVpcConfig
VpcConfig
specifies settings that enable AWS CodeBuild to access resources in an Amazon VPC. -
setVpcConfig
VpcConfig
specifies settings that enable AWS CodeBuild to access resources in an Amazon VPC. -
setVpcConfig
VpcConfig
specifies settings that enable AWS CodeBuild to access resources in an Amazon VPC.
-