PipelineProjectProps¶
-
class
aws_cdk.aws_codebuild.
PipelineProjectProps
(*, allow_all_outbound=None, badge=None, build_spec=None, cache=None, check_secrets_in_plain_text_env_variables=None, description=None, encryption_key=None, environment=None, environment_variables=None, file_system_locations=None, grant_report_group_permissions=None, logging=None, project_name=None, role=None, security_groups=None, subnet_selection=None, timeout=None, vpc=None)¶ Bases:
aws_cdk.aws_codebuild.CommonProjectProps
- Parameters
allow_all_outbound (
Optional
[bool
]) – 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: truebadge (
Optional
[bool
]) – 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: falsebuild_spec (
Optional
[BuildSpec
]) – Filename or contents of buildspec in JSON format. Default: - Empty buildspec.cache (
Optional
[Cache
]) – Caching strategy to use. Default: Cache.nonecheck_secrets_in_plain_text_env_variables (
Optional
[bool
]) – 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: truedescription (
Optional
[str
]) – A description of the project. Use the description to identify the purpose of the project. Default: - No description.encryption_key (
Optional
[IKey
]) – Encryption key to use to read and write artifacts. Default: - The AWS-managed CMK for Amazon Simple Storage Service (Amazon S3) is used.environment (
Optional
[BuildEnvironment
]) – Build environment to use for the build. Default: BuildEnvironment.LinuxBuildImage.STANDARD_1_0environment_variables (
Optional
[Mapping
[str
,BuildEnvironmentVariable
]]) – Additional environment variables to add to the build environment. Default: - No additional environment variables are specified.file_system_locations (
Optional
[List
[IFileSystemLocation
]]) – 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 locationsgrant_report_group_permissions (
Optional
[bool
]) – 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: truelogging (
Optional
[LoggingOptions
]) – 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 setproject_name (
Optional
[str
]) – The physical, human-readable name of the CodeBuild Project. Default: - Name is automatically generated.role (
Optional
[IRole
]) – Service Role to assume while running the build. Default: - A role will be created.security_groups (
Optional
[List
[ISecurityGroup
]]) – 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.subnet_selection (
Optional
[SubnetSelection
]) – Where to place the network interfaces within the VPC. Only used if ‘vpc’ is supplied. Default: - All private subnets.timeout (
Optional
[Duration
]) – 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)vpc (
Optional
[IVpc
]) – 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.
Attributes
-
allow_all_outbound
¶ 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
- Return type
Optional
[bool
]
-
badge
¶ 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
- Return type
Optional
[bool
]
-
build_spec
¶ Filename or contents of buildspec in JSON format.
- Default
Empty buildspec.
- See
https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-example
- Return type
Optional
[BuildSpec
]
-
check_secrets_in_plain_text_env_variables
¶ 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
- Return type
Optional
[bool
]
-
description
¶ A description of the project.
Use the description to identify the purpose of the project.
- Default
No description.
- Return type
Optional
[str
]
-
encryption_key
¶ Encryption key to use to read and write artifacts.
- Default
The AWS-managed CMK for Amazon Simple Storage Service (Amazon S3) is used.
- Return type
Optional
[IKey
]
-
environment
¶ Build environment to use for the build.
- Default
BuildEnvironment.LinuxBuildImage.STANDARD_1_0
- Return type
Optional
[BuildEnvironment
]
-
environment_variables
¶ Additional environment variables to add to the build environment.
- Default
No additional environment variables are specified.
- Return type
Optional
[Mapping
[str
,BuildEnvironmentVariable
]]
-
file_system_locations
¶ 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
- Return type
Optional
[List
[IFileSystemLocation
]]
-
grant_report_group_permissions
¶ 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
https://docs.aws.amazon.com/codebuild/latest/userguide/test-report-group-naming.html
- Return type
Optional
[bool
]
-
logging
¶ 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
- Return type
Optional
[LoggingOptions
]
-
project_name
¶ The physical, human-readable name of the CodeBuild Project.
- Default
Name is automatically generated.
- Return type
Optional
[str
]
-
role
¶ Service Role to assume while running the build.
- Default
A role will be created.
- Return type
Optional
[IRole
]
-
security_groups
¶ 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.
- Return type
Optional
[List
[ISecurityGroup
]]
-
subnet_selection
¶ Where to place the network interfaces within the VPC.
Only used if ‘vpc’ is supplied.
- Default
All private subnets.
- Return type
Optional
[SubnetSelection
]