ReportTemplate

• Implements: IReportTemplate

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

Initializers

import ros_cdk_config
ros_cdk_config.ReportTemplate(
  scope: Construct,
  id: str,
  report_template_name: typing.Union[str, IResolvable],
  report_file_formats: typing.Union[str, IResolvable] = None,
  report_granularity: typing.Union[str, IResolvable] = None,
  report_language: typing.Union[str, IResolvable] = None,
  report_scope: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReportScopeProperty]]] = None,
  report_template_description: typing.Union[str, IResolvable] = None,
  subscription_frequency: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

report_template_name^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property reportTemplateName: Report Template Name.

report_file_formats^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property reportFileFormats: Report Format.

Currently only support excel.

report_granularity^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property reportGranularity: Report Aggregation Granularity.

report_language^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

report_scope^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ReportScopeProperty]]]

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

report_template_description^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property reportTemplateDescription: Report Template Description.

subscription_frequency^Optional

• Type: typing.Union[str, 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.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_config
ros_cdk_config.ReportTemplate.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: 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

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_report_file_formats^Required

attr_report_file_formats: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute ReportFileFormats: Report Format.

Currently only support excel.

attr_report_granularity^Required

attr_report_granularity: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute ReportGranularity: Report Aggregation Granularity.

attr_report_language^Required

attr_report_language: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

attr_report_scope^Required

attr_report_scope: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

attr_report_template_description^Required

attr_report_template_description: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute ReportTemplateDescription: Report Template Description.

attr_report_template_id^Required

attr_report_template_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute ReportTemplateId: Report template Id.

attr_report_template_name^Required

attr_report_template_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute ReportTemplateName: Report Template Name.

attr_subscription_frequency^Required

attr_subscription_frequency: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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

props: ReportTemplateProps

• Type: ReportTemplateProps