software.amazon.awscdk.services.codebuild

Class ReportGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.codebuild.ReportGroup

All Implemented Interfaces:

IResource, IReportGroup, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.365Z")
 @Stability(value=Stable)
public class ReportGroup
extends Resource
implements IReportGroup

The ReportGroup resource class.

Example:

 Source source;
 // create a new ReportGroup
 ReportGroup reportGroup = new ReportGroup(this, "ReportGroup");
 Project project = Project.Builder.create(this, "Project")
         .source(source)
         .buildSpec(BuildSpec.fromObject(Map.of(
                 // ...
                 "reports", Map.of(
                         reportGroup.getReportGroupArn(), Map.of(
                                 "files", "**/*",
                                 "base-directory", "build/test-results")))))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReportGroup.Builder A fluent builder for ReportGroup.

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.IReportGroup

IReportGroup.Jsii$Default, IReportGroup.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	ReportGroup(software.constructs.Construct scope, String id)
	ReportGroup(software.constructs.Construct scope, String id, ReportGroupProps props)
protected	ReportGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ReportGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static IReportGroup	fromReportGroupName(software.constructs.Construct scope, String id, String reportGroupName) Reference an existing ReportGroup, defined outside of the CDK code, by name.
protected IBucket	getExportBucket()
String	getReportGroupArn() The ARN of the ReportGroup.
String	getReportGroupName() The name of the ReportGroup.
protected ReportGroupType	getType()
Grant	grantWrite(IGrantable identity) Grants the given entity permissions to write (that is, upload reports to) this report group.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

ReportGroup

protected ReportGroup(software.amazon.jsii.JsiiObjectRef objRef)

ReportGroup

protected ReportGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

ReportGroup

@Stability(value=Stable)
public ReportGroup(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id,
                                            @Nullable
                                            ReportGroupProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

ReportGroup

@Stability(value=Stable)
public ReportGroup(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromReportGroupName

@Stability(value=Stable)
 @NotNull
public static IReportGroup fromReportGroupName(@NotNull
                                                                                  software.constructs.Construct scope,
                                                                                  @NotNull
                                                                                  String id,
                                                                                  @NotNull
                                                                                  String reportGroupName)

Reference an existing ReportGroup, defined outside of the CDK code, by name.

Parameters:

scope - This parameter is required.

id - This parameter is required.

reportGroupName - This parameter is required.

grantWrite

@Stability(value=Stable)
 @NotNull
public Grant grantWrite(@NotNull
                                                           IGrantable identity)

Grants the given entity permissions to write (that is, upload reports to) this report group.

Specified by:

grantWrite in interface IReportGroup

Parameters:

identity - This parameter is required.

getReportGroupArn

@Stability(value=Stable)
 @NotNull
public String getReportGroupArn()

The ARN of the ReportGroup.

Specified by:

getReportGroupArn in interface IReportGroup

getReportGroupName

@Stability(value=Stable)
 @NotNull
public String getReportGroupName()

The name of the ReportGroup.

Specified by:

getReportGroupName in interface IReportGroup

getExportBucket

@Stability(value=Stable)
 @Nullable
protected IBucket getExportBucket()

getType

@Stability(value=Stable)
 @Nullable
protected ReportGroupType getType()