CfnReportGroupPropsMixin

class aws_cdk.mixins_preview.aws_codebuild.mixins.CfnReportGroupPropsMixin(props, *, strategy=None)

Bases: Mixin

Represents a report group.

A report group contains a collection of reports.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-reportgroup.html
CloudformationResource:: AWS::CodeBuild::ReportGroup
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

cfn_report_group_props_mixin = codebuild_mixins.CfnReportGroupPropsMixin(codebuild_mixins.CfnReportGroupMixinProps(
    delete_reports=False,
    export_config=codebuild_mixins.CfnReportGroupPropsMixin.ReportExportConfigProperty(
        export_config_type="exportConfigType",
        s3_destination=codebuild_mixins.CfnReportGroupPropsMixin.S3ReportExportConfigProperty(
            bucket="bucket",
            bucket_owner="bucketOwner",
            encryption_disabled=False,
            encryption_key="encryptionKey",
            packaging="packaging",
            path="path"
        )
    ),
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    type="type"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::CodeBuild::ReportGroup.

Parameters:

props (Union[CfnReportGroupMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['deleteReports', 'exportConfig', 'name', 'tags', 'type']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ReportExportConfigProperty

class CfnReportGroupPropsMixin.ReportExportConfigProperty(*, export_config_type=None, s3_destination=None)

Bases: object

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

Parameters:

export_config_type (Optional[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.

See:

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.
from aws_cdk.mixins_preview.aws_codebuild import mixins as codebuild_mixins

report_export_config_property = codebuild_mixins.CfnReportGroupPropsMixin.ReportExportConfigProperty(
    export_config_type="exportConfigType",
    s3_destination=codebuild_mixins.CfnReportGroupPropsMixin.S3ReportExportConfigProperty(
        bucket="bucket",
        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.

See:: 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

s3_destination

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

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

S3ReportExportConfigProperty

class CfnReportGroupPropsMixin.S3ReportExportConfigProperty(*, bucket=None, 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 (Optional[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.

See:

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.
from aws_cdk.mixins_preview.aws_codebuild import mixins as codebuild_mixins

s3_report_export_config_property = codebuild_mixins.CfnReportGroupPropsMixin.S3ReportExportConfigProperty(
    bucket="bucket",
    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.

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

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.

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

encryption_disabled

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

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

encryption_key

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

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

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.

See:: 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

path

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

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