Class PipelineProjectProps.Jsii$Proxy
- All Implemented Interfaces:
CommonProjectProps
,PipelineProjectProps
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
PipelineProjectProps
PipelineProjectProps
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.codebuild.PipelineProjectProps
PipelineProjectProps.Builder, PipelineProjectProps.Jsii$Proxy
-
Constructor Summary
ModifierConstructorDescriptionprotected
Jsii$Proxy
(PipelineProjectProps.Builder builder) Constructor that initializes the object based on literal property values passed by thePipelineProjectProps.Builder
.protected
Jsii$Proxy
(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final Boolean
Whether to allow the CodeBuild to send all network traffic.final Boolean
getBadge()
Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.final BuildSpec
Filename or contents of buildspec in JSON format.final Cache
getCache()
Caching strategy to use.final Boolean
Whether to check for the presence of any secrets in the environment variables of the default type, BuildEnvironmentVariableType.PLAINTEXT.final Number
Maximum number of concurrent builds.final String
A description of the project.final IKey
Encryption key to use to read and write artifacts.final BuildEnvironment
Build environment to use for the build.final Map<String,
BuildEnvironmentVariable> Additional environment variables to add to the build environment.final List<IFileSystemLocation>
An ProjectFileSystemLocation objects for a CodeBuild build project.final Boolean
Add permissions to this project's role to create and use test report groups with name starting with the name of this project.final LoggingOptions
Information about logs for the build project.final String
The physical, human-readable name of the CodeBuild Project.final Duration
The number of minutes after which AWS CodeBuild stops the build if it's still in queue.final IRole
getRole()
Service Role to assume while running the build.final List<ISecurityGroup>
What security group to associate with the codebuild project's network interfaces.final Boolean
Add the permissions necessary for debugging builds with SSM Session Manager.final SubnetSelection
Where to place the network interfaces within the VPC.final Duration
The number of minutes after which AWS CodeBuild stops the build if it's not complete.final ProjectVisibility
Specifies the visibility of the project's builds.final IVpc
getVpc()
VPC network to place codebuild network interfaces.final int
hashCode()
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef
- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by thePipelineProjectProps.Builder
.
-
-
Method Details
-
getAllowAllOutbound
Description copied from interface:CommonProjectProps
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
- Specified by:
getAllowAllOutbound
in interfaceCommonProjectProps
-
getBadge
Description copied from interface:CommonProjectProps
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
- Specified by:
getBadge
in interfaceCommonProjectProps
-
getBuildSpec
Description copied from interface:CommonProjectProps
Filename or contents of buildspec in JSON format.Default: - Empty buildspec.
- Specified by:
getBuildSpec
in interfaceCommonProjectProps
- See Also:
-
getCache
Description copied from interface:CommonProjectProps
Caching strategy to use.Default: Cache.none
- Specified by:
getCache
in interfaceCommonProjectProps
-
getCheckSecretsInPlainTextEnvVariables
Description copied from interface:CommonProjectProps
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
- Specified by:
getCheckSecretsInPlainTextEnvVariables
in interfaceCommonProjectProps
-
getConcurrentBuildLimit
Description copied from interface:CommonProjectProps
Maximum number of concurrent builds.Minimum value is 1 and maximum is account build limit.
Default: - no explicit limit is set
- Specified by:
getConcurrentBuildLimit
in interfaceCommonProjectProps
-
getDescription
Description copied from interface:CommonProjectProps
A description of the project.Use the description to identify the purpose of the project.
Default: - No description.
- Specified by:
getDescription
in interfaceCommonProjectProps
-
getEncryptionKey
Description copied from interface:CommonProjectProps
Encryption key to use to read and write artifacts.Default: - The AWS-managed CMK for Amazon Simple Storage Service (Amazon S3) is used.
- Specified by:
getEncryptionKey
in interfaceCommonProjectProps
-
getEnvironment
Description copied from interface:CommonProjectProps
Build environment to use for the build.Default: BuildEnvironment.LinuxBuildImage.STANDARD_1_0
- Specified by:
getEnvironment
in interfaceCommonProjectProps
-
getEnvironmentVariables
Description copied from interface:CommonProjectProps
Additional environment variables to add to the build environment.Default: - No additional environment variables are specified.
- Specified by:
getEnvironmentVariables
in interfaceCommonProjectProps
-
getFileSystemLocations
Description copied from interface:CommonProjectProps
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
- Specified by:
getFileSystemLocations
in interfaceCommonProjectProps
-
getGrantReportGroupPermissions
Description copied from interface:CommonProjectProps
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
- Specified by:
getGrantReportGroupPermissions
in interfaceCommonProjectProps
- See Also:
-
getLogging
Description copied from interface:CommonProjectProps
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
- Specified by:
getLogging
in interfaceCommonProjectProps
-
getProjectName
Description copied from interface:CommonProjectProps
The physical, human-readable name of the CodeBuild Project.Default: - Name is automatically generated.
- Specified by:
getProjectName
in interfaceCommonProjectProps
-
getQueuedTimeout
Description copied from interface:CommonProjectProps
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
- Specified by:
getQueuedTimeout
in interfaceCommonProjectProps
-
getRole
Description copied from interface:CommonProjectProps
Service Role to assume while running the build.Default: - A role will be created.
- Specified by:
getRole
in interfaceCommonProjectProps
-
getSecurityGroups
Description copied from interface:CommonProjectProps
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.
- Specified by:
getSecurityGroups
in interfaceCommonProjectProps
-
getSsmSessionPermissions
Description copied from interface:CommonProjectProps
Add the permissions necessary for debugging builds with SSM Session Manager.If the following prerequisites have been met:
- The necessary permissions have been added by setting this flag to true.
- The build image has the SSM agent installed (true for default CodeBuild images).
- The build is started with debugSessionEnabled set to true.
Then the build container can be paused and inspected using Session Manager by invoking the
codebuild-breakpoint
command somewhere during the build.codebuild-breakpoint
commands will be ignored if the build is not started withdebugSessionEnabled=true
.Default: false
- Specified by:
getSsmSessionPermissions
in interfaceCommonProjectProps
- See Also:
-
getSubnetSelection
Description copied from interface:CommonProjectProps
Where to place the network interfaces within the VPC.To access AWS services, your CodeBuild project needs to be in one of the following types of subnets:
- Subnets with access to the internet (of type PRIVATE_WITH_EGRESS).
- Private subnets unconnected to the internet, but with VPC endpoints for the necessary services.
If you don't specify a subnet selection, the default behavior is to use PRIVATE_WITH_EGRESS subnets first if they exist, then PRIVATE_WITHOUT_EGRESS, and finally PUBLIC subnets. If your VPC doesn't have PRIVATE_WITH_EGRESS subnets but you need AWS service access, add VPC Endpoints to your private subnets.
Default: - private subnets if available else public subnets
- Specified by:
getSubnetSelection
in interfaceCommonProjectProps
- See Also:
-
getTimeout
Description copied from interface:CommonProjectProps
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)
- Specified by:
getTimeout
in interfaceCommonProjectProps
-
getVisibility
Description copied from interface:CommonProjectProps
Specifies the visibility of the project's builds.Default: - no visibility is set
- Specified by:
getVisibility
in interfaceCommonProjectProps
-
getVpc
Description copied from interface:CommonProjectProps
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.
- Specified by:
getVpc
in interfaceCommonProjectProps
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-