CfnReportGroup

class aws_cdk.aws_codebuild.CfnReportGroup(scope, id, *, export_config, type, delete_reports=None, name=None, tags=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::CodeBuild::ReportGroup.

Represents a report group. A report group contains a collection of reports.

CloudformationResource

AWS::CodeBuild::ReportGroup

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_codebuild as codebuild

cfn_report_group = codebuild.CfnReportGroup(self, "MyCfnReportGroup",
    export_config=codebuild.CfnReportGroup.ReportExportConfigProperty(
        export_config_type="exportConfigType",

        # the properties below are optional
        s3_destination=codebuild.CfnReportGroup.S3ReportExportConfigProperty(
            bucket="bucket",

            # the properties below are optional
            bucket_owner="bucketOwner",
            encryption_disabled=False,
            encryption_key="encryptionKey",
            packaging="packaging",
            path="path"
        )
    ),
    type="type",

    # the properties below are optional
    delete_reports=False,
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Create a new AWS::CodeBuild::ReportGroup.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • export_config (Union[IResolvable, ReportExportConfigProperty, Dict[str, Any]]) – Information about the destination where the raw data of this ReportGroup is exported.

  • type (str) – The type of the ReportGroup . This can be one of the following values:. - CODE_COVERAGE - The report group contains code coverage reports. - TEST - The report group contains test reports.

  • delete_reports (Union[bool, IResolvable, None]) – When deleting a report group, specifies if reports within the report group should be deleted. - true - Deletes any reports that belong to the report group before deleting the report group. - false - You must delete any reports in the report group. This is the default value. If you delete a report group that contains one or more reports, an exception is thrown.

  • name (Optional[str]) – The name of the ReportGroup .

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A list of tag key and value pairs associated with this report group. These tags are available for use by AWS services that support AWS CodeBuild report group tags.

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:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

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.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

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)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

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::ReportGroup'
attr_arn

The ARN of the AWS CodeBuild report group, such as arn:aws:codebuild:region:123456789012:report-group/myReportGroupName .

CloudformationAttribute

Arn

Return type

str

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]

delete_reports

When deleting a report group, specifies if reports within the report group should be deleted.

  • true - Deletes any reports that belong to the report group before deleting the report group.

  • false - You must delete any reports in the report group. This is the default value. If you delete a report group that contains one or more reports, an exception is thrown.

Link

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

Return type

Union[bool, IResolvable, None]

export_config

Information about the destination where the raw data of this ReportGroup is exported.

Link

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

Return type

Union[IResolvable, ReportExportConfigProperty]

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.

name

The name of the ReportGroup .

Link

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

Return type

Optional[str]

node

The construct tree node associated with this construct.

Return type

ConstructNode

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

stack

The stack in which this element is defined.

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

Return type

Stack

tags

A list of tag key and value pairs associated with this report group.

These tags are available for use by AWS services that support AWS CodeBuild report group tags.

Link

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

Return type

TagManager

type

.

  • CODE_COVERAGE - The report group contains code coverage reports.

  • TEST - The report group contains test reports.

Link

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

Type

The type of the ReportGroup . This can be one of the following values

Return type

str

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

ReportExportConfigProperty

class CfnReportGroup.ReportExportConfigProperty(*, export_config_type, s3_destination=None)

Bases: object

Information about the location where the run of a report is exported.

Parameters
  • export_config_type (str) – The export configuration type. Valid values are:. - S3 : The report results are exported to an S3 bucket. - NO_EXPORT : The report results are not exported.

  • s3_destination (Union[IResolvable, S3ReportExportConfigProperty, Dict[str, Any], None]) – A S3ReportExportConfig object that contains information about the S3 bucket where the run of a report is exported.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-reportgroup-reportexportconfig.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_codebuild as codebuild

report_export_config_property = codebuild.CfnReportGroup.ReportExportConfigProperty(
    export_config_type="exportConfigType",

    # the properties below are optional
    s3_destination=codebuild.CfnReportGroup.S3ReportExportConfigProperty(
        bucket="bucket",

        # the properties below are optional
        bucket_owner="bucketOwner",
        encryption_disabled=False,
        encryption_key="encryptionKey",
        packaging="packaging",
        path="path"
    )
)

Attributes

export_config_type

.

  • S3 : The report results are exported to an S3 bucket.

  • NO_EXPORT : The report results are not exported.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-reportgroup-reportexportconfig.html#cfn-codebuild-reportgroup-reportexportconfig-exportconfigtype

Type

The export configuration type. Valid values are

Return type

str

s3_destination

A S3ReportExportConfig object that contains information about the S3 bucket where the run of a report is exported.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-reportgroup-reportexportconfig.html#cfn-codebuild-reportgroup-reportexportconfig-s3destination

Return type

Union[IResolvable, S3ReportExportConfigProperty, None]

S3ReportExportConfigProperty

class CfnReportGroup.S3ReportExportConfigProperty(*, bucket, bucket_owner=None, encryption_disabled=None, encryption_key=None, packaging=None, path=None)

Bases: object

Information about the S3 bucket where the raw data of a report are exported.

Parameters
  • bucket (str) – The name of the S3 bucket where the raw data of a report are exported.

  • bucket_owner (Optional[str]) – The AWS account identifier of the owner of the Amazon S3 bucket. This allows report data to be exported to an Amazon S3 bucket that is owned by an account other than the account running the build.

  • encryption_disabled (Union[bool, IResolvable, None]) – A boolean value that specifies if the results of a report are encrypted.

  • encryption_key (Optional[str]) – The encryption key for the report’s encrypted raw data.

  • packaging (Optional[str]) – The type of build output artifact to create. Valid values include:. - NONE : CodeBuild creates the raw data in the output bucket. This is the default if packaging is not specified. - ZIP : CodeBuild creates a ZIP file with the raw data in the output bucket.

  • path (Optional[str]) – The path to the exported report’s raw data results.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-reportgroup-s3reportexportconfig.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_codebuild as codebuild

s3_report_export_config_property = codebuild.CfnReportGroup.S3ReportExportConfigProperty(
    bucket="bucket",

    # the properties below are optional
    bucket_owner="bucketOwner",
    encryption_disabled=False,
    encryption_key="encryptionKey",
    packaging="packaging",
    path="path"
)

Attributes

bucket

The name of the S3 bucket where the raw data of a report are exported.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-reportgroup-s3reportexportconfig.html#cfn-codebuild-reportgroup-s3reportexportconfig-bucket

Return type

str

bucket_owner

The AWS account identifier of the owner of the Amazon S3 bucket.

This allows report data to be exported to an Amazon S3 bucket that is owned by an account other than the account running the build.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-reportgroup-s3reportexportconfig.html#cfn-codebuild-reportgroup-s3reportexportconfig-bucketowner

Return type

Optional[str]

encryption_disabled

A boolean value that specifies if the results of a report are encrypted.

Link

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

Return type

Union[bool, IResolvable, None]

encryption_key

The encryption key for the report’s encrypted raw data.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-reportgroup-s3reportexportconfig.html#cfn-codebuild-reportgroup-s3reportexportconfig-encryptionkey

Return type

Optional[str]

packaging

.

  • NONE : CodeBuild creates the raw data in the output bucket. This is the default if packaging is not specified.

  • ZIP : CodeBuild creates a ZIP file with the raw data in the output bucket.

Link

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

Type

The type of build output artifact to create. Valid values include

Return type

Optional[str]

path

The path to the exported report’s raw data results.

Link

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

Return type

Optional[str]