ReportTemplate

• Implements: IReportTemplate

This class encapsulates and extends the ROS resource type ALIYUN::Config::ReportTemplate.

Initializers

import com.aliyun.ros.cdk.config.ReportTemplate;
ReportTemplate.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .reportTemplateName(java.lang.String)
    .reportTemplateName(IResolvable)
//  .reportFileFormats(java.lang.String)
//  .reportFileFormats(IResolvable)
//  .reportGranularity(java.lang.String)
//  .reportGranularity(IResolvable)
//  .reportLanguage(java.lang.String)
//  .reportLanguage(IResolvable)
//  .reportScope(IResolvable)
//  .reportScope(java.util.List<IResolvable)
//  .reportScope(ReportScopeProperty>)
//  .reportTemplateDescription(java.lang.String)
//  .reportTemplateDescription(IResolvable)
//  .subscriptionFrequency(java.lang.String)
//  .subscriptionFrequency(IResolvable)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

reportTemplateName^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property reportTemplateName: Report Template Name.

reportFileFormats^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property reportFileFormats: Report Format.

Currently only support excel.

reportGranularity^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property reportGranularity: Report Aggregation Granularity.

reportLanguage^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property reportLanguage: Report Content Language, Currently only support zh-CN or en-US.

reportScope^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListReportScopeProperty>

Property reportScope: Report range, yes and logic between multiple sets of k-v pairs.

reportTemplateDescription^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property reportTemplateDescription: Report Template Description.

subscriptionFrequency^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property subscriptionFrequency: Report subscription frequency.

If this field is not empty, it is a Cron expression in Quartz format triggered by the subscription notification. The format is: Seconds, time, day, month, week. The following are examples of commonly used Cron expressions:

• Execute at 0 o'clock every day: 0 0 0 * *?
• Every Monday at 15: 30: 0 30 15? * MON
• Execute at 2 o'clock on the 1st of each month: 0 0 2 1 *? Among them:
• "*" Indicates any value
• What-? Used for day and week fields, indicating that no specific value is specified
• MON means Monday

The trigger time is UTC +8, and the settings of the cron expression can be converted according to the time zone. It can only be triggered according to the cron expression time as much as possible. The cron expression limits the same template to trigger at most one notification per day.

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.config.ReportTemplate;
ReportTemplate.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.ros.cdk.core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrReportFileFormats^Required

public java.lang.Object getAttrReportFileFormats();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ReportFileFormats: Report Format.

Currently only support excel.

attrReportGranularity^Required

public java.lang.Object getAttrReportGranularity();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ReportGranularity: Report Aggregation Granularity.

attrReportLanguage^Required

public java.lang.Object getAttrReportLanguage();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ReportLanguage: Report Content Language, Currently only support zh-CN or en-US.

attrReportScope^Required

public java.lang.Object getAttrReportScope();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ReportScope: Report range, yes and logic between multiple sets of k-v pairs.

attrReportTemplateDescription^Required

public java.lang.Object getAttrReportTemplateDescription();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ReportTemplateDescription: Report Template Description.

attrReportTemplateId^Required

public java.lang.Object getAttrReportTemplateId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ReportTemplateId: Report template Id.

attrReportTemplateName^Required

public java.lang.Object getAttrReportTemplateName();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ReportTemplateName: Report Template Name.

attrSubscriptionFrequency^Required

public java.lang.Object getAttrSubscriptionFrequency();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute SubscriptionFrequency: Report subscription frequency.

If this field is not empty, it is a Cron expression in Quartz format triggered by the subscription notification.

props^Required

public ReportTemplateProps getProps();

• Type: ReportTemplateProps