CfnProject

class aws_cdk.aws_codebuild.CfnProject(scope, id, *, artifacts, environment, service_role, source, badge_enabled=None, build_batch_config=None, cache=None, description=None, encryption_key=None, file_system_locations=None, logs_config=None, name=None, queued_timeout_in_minutes=None, secondary_artifacts=None, secondary_sources=None, secondary_source_versions=None, source_version=None, tags=None, timeout_in_minutes=None, triggers=None, vpc_config=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::CodeBuild::Project.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html

CloudformationResource

AWS::CodeBuild::Project

Create a new AWS::CodeBuild::Project.

Parameters

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

(experimental) Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Stability

experimental

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::CodeBuild::Project'
artifacts

AWS::CodeBuild::Project.Artifacts.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-artifacts

Return type

Union[ArtifactsProperty, IResolvable]

attr_arn

Arn

Type

cloudformationAttribute

Return type

str

badge_enabled

AWS::CodeBuild::Project.BadgeEnabled.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-badgeenabled

Return type

Union[bool, IResolvable, None]

build_batch_config

AWS::CodeBuild::Project.BuildBatchConfig.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-buildbatchconfig

Return type

Union[IResolvable, ProjectBuildBatchConfigProperty, None]

cache

AWS::CodeBuild::Project.Cache.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-cache

Return type

Union[IResolvable, ProjectCacheProperty, None]

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

description

AWS::CodeBuild::Project.Description.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-description

Return type

Optional[str]

encryption_key

AWS::CodeBuild::Project.EncryptionKey.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-encryptionkey

Return type

Optional[str]

environment

AWS::CodeBuild::Project.Environment.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-environment

Return type

Union[IResolvable, EnvironmentProperty]

file_system_locations

AWS::CodeBuild::Project.FileSystemLocations.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-filesystemlocations

Return type

Union[IResolvable, List[Union[ProjectFileSystemLocationProperty, IResolvable]], None]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

logs_config

AWS::CodeBuild::Project.LogsConfig.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-logsconfig

Return type

Union[IResolvable, LogsConfigProperty, None]

name

AWS::CodeBuild::Project.Name.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-name

Return type

Optional[str]

node

The construct tree node associated with this construct.

Return type

ConstructNode

queued_timeout_in_minutes

AWS::CodeBuild::Project.QueuedTimeoutInMinutes.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-queuedtimeoutinminutes

Return type

Union[int, float, None]

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

secondary_artifacts

AWS::CodeBuild::Project.SecondaryArtifacts.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-secondaryartifacts

Return type

Union[IResolvable, List[Union[ArtifactsProperty, IResolvable]], None]

secondary_source_versions

AWS::CodeBuild::Project.SecondarySourceVersions.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-secondarysourceversions

Return type

Union[IResolvable, List[Union[IResolvable, ProjectSourceVersionProperty]], None]

secondary_sources

AWS::CodeBuild::Project.SecondarySources.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-secondarysources

Return type

Union[IResolvable, List[Union[SourceProperty, IResolvable]], None]

service_role

AWS::CodeBuild::Project.ServiceRole.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-servicerole

Return type

str

source

AWS::CodeBuild::Project.Source.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-source

Return type

Union[SourceProperty, IResolvable]

source_version

AWS::CodeBuild::Project.SourceVersion.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-sourceversion

Return type

Optional[str]

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

tags

AWS::CodeBuild::Project.Tags.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-tags

Return type

TagManager

timeout_in_minutes

AWS::CodeBuild::Project.TimeoutInMinutes.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-timeoutinminutes

Return type

Union[int, float, None]

triggers

AWS::CodeBuild::Project.Triggers.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-triggers

Return type

Union[IResolvable, ProjectTriggersProperty, None]

vpc_config

AWS::CodeBuild::Project.VpcConfig.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-vpcconfig

Return type

Union[IResolvable, VpcConfigProperty, None]

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

ArtifactsProperty

class CfnProject.ArtifactsProperty(*, type, artifact_identifier=None, encryption_disabled=None, location=None, name=None, namespace_type=None, override_artifact_name=None, packaging=None, path=None)

Bases: object

Parameters
  • type (str) – CfnProject.ArtifactsProperty.Type.

  • artifact_identifier (Optional[str]) – CfnProject.ArtifactsProperty.ArtifactIdentifier.

  • encryption_disabled (Union[bool, IResolvable, None]) – CfnProject.ArtifactsProperty.EncryptionDisabled.

  • location (Optional[str]) – CfnProject.ArtifactsProperty.Location.

  • name (Optional[str]) – CfnProject.ArtifactsProperty.Name.

  • namespace_type (Optional[str]) – CfnProject.ArtifactsProperty.NamespaceType.

  • override_artifact_name (Union[bool, IResolvable, None]) – CfnProject.ArtifactsProperty.OverrideArtifactName.

  • packaging (Optional[str]) – CfnProject.ArtifactsProperty.Packaging.

  • path (Optional[str]) – CfnProject.ArtifactsProperty.Path.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html

Attributes

artifact_identifier

CfnProject.ArtifactsProperty.ArtifactIdentifier.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-artifactidentifier

Return type

Optional[str]

encryption_disabled

CfnProject.ArtifactsProperty.EncryptionDisabled.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-encryptiondisabled

Return type

Union[bool, IResolvable, None]

location

CfnProject.ArtifactsProperty.Location.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-location

Return type

Optional[str]

name

CfnProject.ArtifactsProperty.Name.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-name

Return type

Optional[str]

namespace_type

CfnProject.ArtifactsProperty.NamespaceType.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-namespacetype

Return type

Optional[str]

override_artifact_name

CfnProject.ArtifactsProperty.OverrideArtifactName.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-overrideartifactname

Return type

Union[bool, IResolvable, None]

packaging

CfnProject.ArtifactsProperty.Packaging.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-packaging

Return type

Optional[str]

path

CfnProject.ArtifactsProperty.Path.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-path

Return type

Optional[str]

type

CfnProject.ArtifactsProperty.Type.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-type

Return type

str

BatchRestrictionsProperty

class CfnProject.BatchRestrictionsProperty(*, compute_types_allowed=None, maximum_builds_allowed=None)

Bases: object

Parameters
  • compute_types_allowed (Optional[List[str]]) – CfnProject.BatchRestrictionsProperty.ComputeTypesAllowed.

  • maximum_builds_allowed (Union[int, float, None]) – CfnProject.BatchRestrictionsProperty.MaximumBuildsAllowed.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-batchrestrictions.html

Attributes

compute_types_allowed

CfnProject.BatchRestrictionsProperty.ComputeTypesAllowed.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-batchrestrictions.html#cfn-codebuild-project-batchrestrictions-computetypesallowed

Return type

Optional[List[str]]

maximum_builds_allowed

CfnProject.BatchRestrictionsProperty.MaximumBuildsAllowed.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-batchrestrictions.html#cfn-codebuild-project-batchrestrictions-maximumbuildsallowed

Return type

Union[int, float, None]

BuildStatusConfigProperty

class CfnProject.BuildStatusConfigProperty(*, context=None, target_url=None)

Bases: object

Parameters
  • context (Optional[str]) – CfnProject.BuildStatusConfigProperty.Context.

  • target_url (Optional[str]) – CfnProject.BuildStatusConfigProperty.TargetUrl.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-buildstatusconfig.html

Attributes

context

CfnProject.BuildStatusConfigProperty.Context.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-buildstatusconfig.html#cfn-codebuild-project-buildstatusconfig-context

Return type

Optional[str]

target_url

CfnProject.BuildStatusConfigProperty.TargetUrl.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-buildstatusconfig.html#cfn-codebuild-project-buildstatusconfig-targeturl

Return type

Optional[str]

CloudWatchLogsConfigProperty

class CfnProject.CloudWatchLogsConfigProperty(*, status, group_name=None, stream_name=None)

Bases: object

Parameters
  • status (str) – CfnProject.CloudWatchLogsConfigProperty.Status.

  • group_name (Optional[str]) – CfnProject.CloudWatchLogsConfigProperty.GroupName.

  • stream_name (Optional[str]) – CfnProject.CloudWatchLogsConfigProperty.StreamName.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-cloudwatchlogsconfig.html

Attributes

group_name

CfnProject.CloudWatchLogsConfigProperty.GroupName.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-cloudwatchlogsconfig.html#cfn-codebuild-project-cloudwatchlogsconfig-groupname

Return type

Optional[str]

status

CfnProject.CloudWatchLogsConfigProperty.Status.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-cloudwatchlogsconfig.html#cfn-codebuild-project-cloudwatchlogsconfig-status

Return type

str

stream_name

CfnProject.CloudWatchLogsConfigProperty.StreamName.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-cloudwatchlogsconfig.html#cfn-codebuild-project-cloudwatchlogsconfig-streamname

Return type

Optional[str]

EnvironmentProperty

class CfnProject.EnvironmentProperty(*, compute_type, image, type, certificate=None, environment_variables=None, image_pull_credentials_type=None, privileged_mode=None, registry_credential=None)

Bases: object

Parameters
  • compute_type (str) – CfnProject.EnvironmentProperty.ComputeType.

  • image (str) – CfnProject.EnvironmentProperty.Image.

  • type (str) – CfnProject.EnvironmentProperty.Type.

  • certificate (Optional[str]) – CfnProject.EnvironmentProperty.Certificate.

  • environment_variables (Union[IResolvable, List[Union[IResolvable, EnvironmentVariableProperty]], None]) – CfnProject.EnvironmentProperty.EnvironmentVariables.

  • image_pull_credentials_type (Optional[str]) – CfnProject.EnvironmentProperty.ImagePullCredentialsType.

  • privileged_mode (Union[bool, IResolvable, None]) – CfnProject.EnvironmentProperty.PrivilegedMode.

  • registry_credential (Union[IResolvable, RegistryCredentialProperty, None]) – CfnProject.EnvironmentProperty.RegistryCredential.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html

Attributes

certificate

CfnProject.EnvironmentProperty.Certificate.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-certificate

Return type

Optional[str]

compute_type

CfnProject.EnvironmentProperty.ComputeType.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-computetype

Return type

str

environment_variables

CfnProject.EnvironmentProperty.EnvironmentVariables.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-environmentvariables

Return type

Union[IResolvable, List[Union[IResolvable, EnvironmentVariableProperty]], None]

image

CfnProject.EnvironmentProperty.Image.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-image

Return type

str

image_pull_credentials_type

CfnProject.EnvironmentProperty.ImagePullCredentialsType.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-imagepullcredentialstype

Return type

Optional[str]

privileged_mode

CfnProject.EnvironmentProperty.PrivilegedMode.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-privilegedmode

Return type

Union[bool, IResolvable, None]

registry_credential

CfnProject.EnvironmentProperty.RegistryCredential.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-registrycredential

Return type

Union[IResolvable, RegistryCredentialProperty, None]

type

CfnProject.EnvironmentProperty.Type.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-type

Return type

str

EnvironmentVariableProperty

class CfnProject.EnvironmentVariableProperty(*, name, value, type=None)

Bases: object

Parameters
  • name (str) – CfnProject.EnvironmentVariableProperty.Name.

  • value (str) – CfnProject.EnvironmentVariableProperty.Value.

  • type (Optional[str]) – CfnProject.EnvironmentVariableProperty.Type.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environmentvariable.html

Attributes

name

CfnProject.EnvironmentVariableProperty.Name.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environmentvariable.html#cfn-codebuild-project-environmentvariable-name

Return type

str

type

CfnProject.EnvironmentVariableProperty.Type.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environmentvariable.html#cfn-codebuild-project-environmentvariable-type

Return type

Optional[str]

value

CfnProject.EnvironmentVariableProperty.Value.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environmentvariable.html#cfn-codebuild-project-environmentvariable-value

Return type

str

GitSubmodulesConfigProperty

class CfnProject.GitSubmodulesConfigProperty(*, fetch_submodules)

Bases: object

Parameters

fetch_submodules (Union[bool, IResolvable]) – CfnProject.GitSubmodulesConfigProperty.FetchSubmodules.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-gitsubmodulesconfig.html

Attributes

fetch_submodules

CfnProject.GitSubmodulesConfigProperty.FetchSubmodules.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-gitsubmodulesconfig.html#cfn-codebuild-project-gitsubmodulesconfig-fetchsubmodules

Return type

Union[bool, IResolvable]

LogsConfigProperty

class CfnProject.LogsConfigProperty(*, cloud_watch_logs=None, s3_logs=None)

Bases: object

Parameters
See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-logsconfig.html

Attributes

cloud_watch_logs

CfnProject.LogsConfigProperty.CloudWatchLogs.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-logsconfig.html#cfn-codebuild-project-logsconfig-cloudwatchlogs

Return type

Union[IResolvable, CloudWatchLogsConfigProperty, None]

s3_logs

CfnProject.LogsConfigProperty.S3Logs.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-logsconfig.html#cfn-codebuild-project-logsconfig-s3logs

Return type

Union[IResolvable, S3LogsConfigProperty, None]

ProjectBuildBatchConfigProperty

class CfnProject.ProjectBuildBatchConfigProperty(*, combine_artifacts=None, restrictions=None, service_role=None, timeout_in_mins=None)

Bases: object

Parameters
  • combine_artifacts (Union[bool, IResolvable, None]) – CfnProject.ProjectBuildBatchConfigProperty.CombineArtifacts.

  • restrictions (Union[IResolvable, BatchRestrictionsProperty, None]) – CfnProject.ProjectBuildBatchConfigProperty.Restrictions.

  • service_role (Optional[str]) – CfnProject.ProjectBuildBatchConfigProperty.ServiceRole.

  • timeout_in_mins (Union[int, float, None]) – CfnProject.ProjectBuildBatchConfigProperty.TimeoutInMins.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectbuildbatchconfig.html

Attributes

combine_artifacts

CfnProject.ProjectBuildBatchConfigProperty.CombineArtifacts.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectbuildbatchconfig.html#cfn-codebuild-project-projectbuildbatchconfig-combineartifacts

Return type

Union[bool, IResolvable, None]

restrictions

CfnProject.ProjectBuildBatchConfigProperty.Restrictions.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectbuildbatchconfig.html#cfn-codebuild-project-projectbuildbatchconfig-restrictions

Return type

Union[IResolvable, BatchRestrictionsProperty, None]

service_role

CfnProject.ProjectBuildBatchConfigProperty.ServiceRole.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectbuildbatchconfig.html#cfn-codebuild-project-projectbuildbatchconfig-servicerole

Return type

Optional[str]

timeout_in_mins

CfnProject.ProjectBuildBatchConfigProperty.TimeoutInMins.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectbuildbatchconfig.html#cfn-codebuild-project-projectbuildbatchconfig-timeoutinmins

Return type

Union[int, float, None]

ProjectCacheProperty

class CfnProject.ProjectCacheProperty(*, type, location=None, modes=None)

Bases: object

Parameters
  • type (str) – CfnProject.ProjectCacheProperty.Type.

  • location (Optional[str]) – CfnProject.ProjectCacheProperty.Location.

  • modes (Optional[List[str]]) – CfnProject.ProjectCacheProperty.Modes.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectcache.html

Attributes

location

CfnProject.ProjectCacheProperty.Location.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectcache.html#cfn-codebuild-project-projectcache-location

Return type

Optional[str]

modes

CfnProject.ProjectCacheProperty.Modes.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectcache.html#cfn-codebuild-project-projectcache-modes

Return type

Optional[List[str]]

type

CfnProject.ProjectCacheProperty.Type.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectcache.html#cfn-codebuild-project-projectcache-type

Return type

str

ProjectFileSystemLocationProperty

class CfnProject.ProjectFileSystemLocationProperty(*, identifier, location, mount_point, type, mount_options=None)

Bases: object

Parameters
  • identifier (str) – CfnProject.ProjectFileSystemLocationProperty.Identifier.

  • location (str) – CfnProject.ProjectFileSystemLocationProperty.Location.

  • mount_point (str) – CfnProject.ProjectFileSystemLocationProperty.MountPoint.

  • type (str) – CfnProject.ProjectFileSystemLocationProperty.Type.

  • mount_options (Optional[str]) – CfnProject.ProjectFileSystemLocationProperty.MountOptions.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfilesystemlocation.html

Attributes

identifier

CfnProject.ProjectFileSystemLocationProperty.Identifier.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfilesystemlocation.html#cfn-codebuild-project-projectfilesystemlocation-identifier

Return type

str

location

CfnProject.ProjectFileSystemLocationProperty.Location.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfilesystemlocation.html#cfn-codebuild-project-projectfilesystemlocation-location

Return type

str

mount_options

CfnProject.ProjectFileSystemLocationProperty.MountOptions.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfilesystemlocation.html#cfn-codebuild-project-projectfilesystemlocation-mountoptions

Return type

Optional[str]

mount_point

CfnProject.ProjectFileSystemLocationProperty.MountPoint.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfilesystemlocation.html#cfn-codebuild-project-projectfilesystemlocation-mountpoint

Return type

str

type

CfnProject.ProjectFileSystemLocationProperty.Type.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfilesystemlocation.html#cfn-codebuild-project-projectfilesystemlocation-type

Return type

str

ProjectSourceVersionProperty

class CfnProject.ProjectSourceVersionProperty(*, source_identifier, source_version=None)

Bases: object

Parameters
  • source_identifier (str) – CfnProject.ProjectSourceVersionProperty.SourceIdentifier.

  • source_version (Optional[str]) – CfnProject.ProjectSourceVersionProperty.SourceVersion.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectsourceversion.html

Attributes

source_identifier

CfnProject.ProjectSourceVersionProperty.SourceIdentifier.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectsourceversion.html#cfn-codebuild-project-projectsourceversion-sourceidentifier

Return type

str

source_version

CfnProject.ProjectSourceVersionProperty.SourceVersion.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectsourceversion.html#cfn-codebuild-project-projectsourceversion-sourceversion

Return type

Optional[str]

ProjectTriggersProperty

class CfnProject.ProjectTriggersProperty(*, build_type=None, filter_groups=None, webhook=None)

Bases: object

Parameters
  • build_type (Optional[str]) – CfnProject.ProjectTriggersProperty.BuildType.

  • filter_groups (Union[IResolvable, List[Union[IResolvable, List[Union[IResolvable, WebhookFilterProperty]]]], None]) – CfnProject.ProjectTriggersProperty.FilterGroups.

  • webhook (Union[bool, IResolvable, None]) – CfnProject.ProjectTriggersProperty.Webhook.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projecttriggers.html

Attributes

build_type

CfnProject.ProjectTriggersProperty.BuildType.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projecttriggers.html#cfn-codebuild-project-projecttriggers-buildtype

Return type

Optional[str]

filter_groups

CfnProject.ProjectTriggersProperty.FilterGroups.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projecttriggers.html#cfn-codebuild-project-projecttriggers-filtergroups

Return type

Union[IResolvable, List[Union[IResolvable, List[Union[IResolvable, WebhookFilterProperty]]]], None]

webhook

CfnProject.ProjectTriggersProperty.Webhook.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projecttriggers.html#cfn-codebuild-project-projecttriggers-webhook

Return type

Union[bool, IResolvable, None]

RegistryCredentialProperty

class CfnProject.RegistryCredentialProperty(*, credential, credential_provider)

Bases: object

Parameters
  • credential (str) – CfnProject.RegistryCredentialProperty.Credential.

  • credential_provider (str) – CfnProject.RegistryCredentialProperty.CredentialProvider.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-registrycredential.html

Attributes

credential

CfnProject.RegistryCredentialProperty.Credential.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-registrycredential.html#cfn-codebuild-project-registrycredential-credential

Return type

str

credential_provider

CfnProject.RegistryCredentialProperty.CredentialProvider.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-registrycredential.html#cfn-codebuild-project-registrycredential-credentialprovider

Return type

str

S3LogsConfigProperty

class CfnProject.S3LogsConfigProperty(*, status, encryption_disabled=None, location=None)

Bases: object

Parameters
  • status (str) – CfnProject.S3LogsConfigProperty.Status.

  • encryption_disabled (Union[bool, IResolvable, None]) – CfnProject.S3LogsConfigProperty.EncryptionDisabled.

  • location (Optional[str]) – CfnProject.S3LogsConfigProperty.Location.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-s3logsconfig.html

Attributes

encryption_disabled

CfnProject.S3LogsConfigProperty.EncryptionDisabled.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-s3logsconfig.html#cfn-codebuild-project-s3logsconfig-encryptiondisabled

Return type

Union[bool, IResolvable, None]

location

CfnProject.S3LogsConfigProperty.Location.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-s3logsconfig.html#cfn-codebuild-project-s3logsconfig-location

Return type

Optional[str]

status

CfnProject.S3LogsConfigProperty.Status.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-s3logsconfig.html#cfn-codebuild-project-s3logsconfig-status

Return type

str

SourceAuthProperty

class CfnProject.SourceAuthProperty(*, type, resource=None)

Bases: object

Parameters
  • type (str) – CfnProject.SourceAuthProperty.Type.

  • resource (Optional[str]) – CfnProject.SourceAuthProperty.Resource.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-sourceauth.html

Attributes

resource

CfnProject.SourceAuthProperty.Resource.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-sourceauth.html#cfn-codebuild-project-sourceauth-resource

Return type

Optional[str]

type

CfnProject.SourceAuthProperty.Type.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-sourceauth.html#cfn-codebuild-project-sourceauth-type

Return type

str

SourceProperty

class CfnProject.SourceProperty(*, type, auth=None, build_spec=None, build_status_config=None, git_clone_depth=None, git_submodules_config=None, insecure_ssl=None, location=None, report_build_status=None, source_identifier=None)

Bases: object

Parameters
  • type (str) – CfnProject.SourceProperty.Type.

  • auth (Union[IResolvable, SourceAuthProperty, None]) – CfnProject.SourceProperty.Auth.

  • build_spec (Optional[str]) – CfnProject.SourceProperty.BuildSpec.

  • build_status_config (Union[IResolvable, BuildStatusConfigProperty, None]) – CfnProject.SourceProperty.BuildStatusConfig.

  • git_clone_depth (Union[int, float, None]) – CfnProject.SourceProperty.GitCloneDepth.

  • git_submodules_config (Union[IResolvable, GitSubmodulesConfigProperty, None]) – CfnProject.SourceProperty.GitSubmodulesConfig.

  • insecure_ssl (Union[bool, IResolvable, None]) – CfnProject.SourceProperty.InsecureSsl.

  • location (Optional[str]) – CfnProject.SourceProperty.Location.

  • report_build_status (Union[bool, IResolvable, None]) – CfnProject.SourceProperty.ReportBuildStatus.

  • source_identifier (Optional[str]) – CfnProject.SourceProperty.SourceIdentifier.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html

Attributes

auth

CfnProject.SourceProperty.Auth.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-auth

Return type

Union[IResolvable, SourceAuthProperty, None]

build_spec

CfnProject.SourceProperty.BuildSpec.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-buildspec

Return type

Optional[str]

build_status_config

CfnProject.SourceProperty.BuildStatusConfig.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-buildstatusconfig

Return type

Union[IResolvable, BuildStatusConfigProperty, None]

git_clone_depth

CfnProject.SourceProperty.GitCloneDepth.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-gitclonedepth

Return type

Union[int, float, None]

git_submodules_config

CfnProject.SourceProperty.GitSubmodulesConfig.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-gitsubmodulesconfig

Return type

Union[IResolvable, GitSubmodulesConfigProperty, None]

insecure_ssl

CfnProject.SourceProperty.InsecureSsl.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-insecuressl

Return type

Union[bool, IResolvable, None]

location

CfnProject.SourceProperty.Location.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-location

Return type

Optional[str]

report_build_status

CfnProject.SourceProperty.ReportBuildStatus.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-reportbuildstatus

Return type

Union[bool, IResolvable, None]

source_identifier

CfnProject.SourceProperty.SourceIdentifier.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-sourceidentifier

Return type

Optional[str]

type

CfnProject.SourceProperty.Type.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-type

Return type

str

VpcConfigProperty

class CfnProject.VpcConfigProperty(*, security_group_ids=None, subnets=None, vpc_id=None)

Bases: object

Parameters
  • security_group_ids (Optional[List[str]]) – CfnProject.VpcConfigProperty.SecurityGroupIds.

  • subnets (Optional[List[str]]) – CfnProject.VpcConfigProperty.Subnets.

  • vpc_id (Optional[str]) – CfnProject.VpcConfigProperty.VpcId.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-vpcconfig.html

Attributes

security_group_ids

CfnProject.VpcConfigProperty.SecurityGroupIds.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-vpcconfig.html#cfn-codebuild-project-vpcconfig-securitygroupids

Return type

Optional[List[str]]

subnets

CfnProject.VpcConfigProperty.Subnets.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-vpcconfig.html#cfn-codebuild-project-vpcconfig-subnets

Return type

Optional[List[str]]

vpc_id

CfnProject.VpcConfigProperty.VpcId.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-vpcconfig.html#cfn-codebuild-project-vpcconfig-vpcid

Return type

Optional[str]

WebhookFilterProperty

class CfnProject.WebhookFilterProperty(*, pattern, type, exclude_matched_pattern=None)

Bases: object

Parameters
  • pattern (str) – CfnProject.WebhookFilterProperty.Pattern.

  • type (str) – CfnProject.WebhookFilterProperty.Type.

  • exclude_matched_pattern (Union[bool, IResolvable, None]) – CfnProject.WebhookFilterProperty.ExcludeMatchedPattern.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-webhookfilter.html

Attributes

exclude_matched_pattern

CfnProject.WebhookFilterProperty.ExcludeMatchedPattern.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-webhookfilter.html#cfn-codebuild-project-webhookfilter-excludematchedpattern

Return type

Union[bool, IResolvable, None]

pattern

CfnProject.WebhookFilterProperty.Pattern.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-webhookfilter.html#cfn-codebuild-project-webhookfilter-pattern

Return type

str

type

CfnProject.WebhookFilterProperty.Type.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-webhookfilter.html#cfn-codebuild-project-webhookfilter-type

Return type

str