Package software.amazon.awscdk.services.artifact

Class CfnReport

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.artifact.CfnReport
All Implemented Interfaces:
IInspectable, IReportRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)", date="2026-08-10T14:50:57.154Z") @Stability(Stable) public class CfnReport extends CfnResource implements IInspectable, IReportRef
Resource schema for AWS Artifact Report.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.artifact.*;
 CfnReport cfnReport = CfnReport.Builder.create(this, "MyCfnReport").build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnReport

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

    • CfnReport

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

    • CfnReport

      @Stability(Stable) public CfnReport(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnReportProps props)
      Create a new AWS::Artifact::Report.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnReport

      @Stability(Stable) public CfnReport(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::Artifact::Report.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • arnForReport

      @Stability(Stable) @NotNull public static String arnForReport(@NotNull IReportRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnReport

      @Stability(Stable) @NotNull public static Boolean isCfnReport(@NotNull Object x)
      Checks whether the given object is a CfnReport.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrAcceptanceType

      @Stability(Stable) @NotNull public String getAttrAcceptanceType()
      Acceptance type for report.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the report.

    • getAttrCategory

      @Stability(Stable) @NotNull public String getAttrCategory()
      Category for the report resource.

    • getAttrCompanyName

      @Stability(Stable) @NotNull public String getAttrCompanyName()
      Associated company name for the report resource.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      Timestamp indicating when the report resource was created.

    • getAttrDescription

      @Stability(Stable) @NotNull public String getAttrDescription()
      Description for the report resource.

    • getAttrName

      @Stability(Stable) @NotNull public String getAttrName()
      Name for the report resource.

    • getAttrPeriodEnd

      @Stability(Stable) @NotNull public String getAttrPeriodEnd()
      Timestamp indicating the report resource effective end.

    • getAttrPeriodStart

      @Stability(Stable) @NotNull public String getAttrPeriodStart()
      Timestamp indicating the report resource effective start.

    • getAttrProductName

      @Stability(Stable) @NotNull public String getAttrProductName()
      Associated product name for the report resource.

    • getAttrReportId

      @Stability(Stable) @NotNull public String getAttrReportId()
      Unique resource ID for the report resource.

    • getAttrSequenceNumber

      @Stability(Stable) @NotNull public Number getAttrSequenceNumber()
      Sequence number to enforce optimistic locking.

    • getAttrSeries

      @Stability(Stable) @NotNull public String getAttrSeries()
      Series for the report resource.

    • getAttrState

      @Stability(Stable) @NotNull public String getAttrState()
      Current state of the report resource.

    • getAttrTermArn

      @Stability(Stable) @NotNull public String getAttrTermArn()
      Unique resource ARN for term resource.

    • getAttrVersion

      @Stability(Stable) @NotNull public String getAttrVersion()
      Version for the report resource.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getReportRef

      @Stability(Stable) @NotNull public ReportReference getReportRef()
      A reference to a Report resource.
      Specified by:
      getReportRef in interface IReportRef