CfnScheduledReportPropsMixin

class aws_cdk.cfn_property_mixins.aws_bcm.CfnScheduledReportPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates and manages a scheduled report for an AWS Billing and Cost Management Dashboards dashboard.

A scheduled report renders a snapshot of the dashboard on a cron schedule, using an IAM role that the service assumes to read the underlying cost and usage data.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bcm-scheduledreport.html
CloudformationResource:: AWS::BCM::ScheduledReport
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.cfn_property_mixins import aws_bcm as bcm
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_scheduled_report_props_mixin = bcm.CfnScheduledReportPropsMixin(bcm.CfnScheduledReportMixinProps(
    dashboard_arn="dashboardArn",
    description="description",
    name="name",
    schedule_config=bcm.CfnScheduledReportPropsMixin.ScheduleConfigProperty(
        schedule_expression="scheduleExpression",
        schedule_expression_time_zone="scheduleExpressionTimeZone",
        schedule_period=bcm.CfnScheduledReportPropsMixin.SchedulePeriodProperty(
            end_time="endTime",
            start_time="startTime"
        ),
        state="state"
    ),
    scheduled_report_execution_role_arn="scheduledReportExecutionRoleArn",
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )],
    widget_date_range_override=bcm.CfnScheduledReportPropsMixin.DateTimeRangeProperty(
        end_time=bcm.CfnScheduledReportPropsMixin.DateTimeValueProperty(
            type="type",
            value="value"
        ),
        start_time=bcm.CfnScheduledReportPropsMixin.DateTimeValueProperty(
            type="type",
            value="value"
        )
    ),
    widget_ids=["widgetIds"]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::BCM::ScheduledReport.

Parameters:

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

Methods

apply_to(construct)

Apply the mixin properties to the construct.

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

supports(construct)

Check if this mixin supports the given construct.

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

Attributes

CFN_PROPERTY_KEYS = ['dashboardArn', 'description', 'name', 'scheduleConfig', 'scheduledReportExecutionRoleArn', 'tags', 'widgetDateRangeOverride', 'widgetIds']

Static Methods

classmethod is_mixin(x)

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.

DateTimeRangeProperty

class CfnScheduledReportPropsMixin.DateTimeRangeProperty(*, end_time=None, start_time=None)

Bases: object

An absolute or relative date range.

Parameters:

end_time (Union[IResolvable, DateTimeValueProperty, Dict[str, Any], None]) – A date expressed either as an absolute instant or as an offset from now.
start_time (Union[IResolvable, DateTimeValueProperty, Dict[str, Any], None]) – A date expressed either as an absolute instant or as an offset from now.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcm-scheduledreport-datetimerange.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.cfn_property_mixins import aws_bcm as bcm

date_time_range_property = bcm.CfnScheduledReportPropsMixin.DateTimeRangeProperty(
    end_time=bcm.CfnScheduledReportPropsMixin.DateTimeValueProperty(
        type="type",
        value="value"
    ),
    start_time=bcm.CfnScheduledReportPropsMixin.DateTimeValueProperty(
        type="type",
        value="value"
    )
)

Attributes

end_time

A date expressed either as an absolute instant or as an offset from now.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcm-scheduledreport-datetimerange.html#cfn-bcm-scheduledreport-datetimerange-endtime

start_time

A date expressed either as an absolute instant or as an offset from now.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcm-scheduledreport-datetimerange.html#cfn-bcm-scheduledreport-datetimerange-starttime

DateTimeValueProperty

class CfnScheduledReportPropsMixin.DateTimeValueProperty(*, type=None, value=None)

Bases: object

A date expressed either as an absolute instant or as an offset from now.

Parameters:

type (Optional[str]) – Whether a date value is absolute or relative.
value (Optional[str]) – The date, or an ISO 8601 duration when Type is RELATIVE.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcm-scheduledreport-datetimevalue.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.cfn_property_mixins import aws_bcm as bcm

date_time_value_property = bcm.CfnScheduledReportPropsMixin.DateTimeValueProperty(
    type="type",
    value="value"
)

Attributes

type

Whether a date value is absolute or relative.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcm-scheduledreport-datetimevalue.html#cfn-bcm-scheduledreport-datetimevalue-type

value

The date, or an ISO 8601 duration when Type is RELATIVE.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcm-scheduledreport-datetimevalue.html#cfn-bcm-scheduledreport-datetimevalue-value

HealthStatusProperty

class CfnScheduledReportPropsMixin.HealthStatusProperty(*, last_refreshed_at=None, status_code=None)

Bases: object

The health of the scheduled report as of its last refresh.

Parameters:

last_refreshed_at (Optional[str]) – The time at which the health status was last refreshed.
status_code (Optional[str]) – The health status of a scheduled report.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcm-scheduledreport-healthstatus.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.cfn_property_mixins import aws_bcm as bcm

health_status_property = bcm.CfnScheduledReportPropsMixin.HealthStatusProperty(
    last_refreshed_at="lastRefreshedAt",
    status_code="statusCode"
)

Attributes

last_refreshed_at

The time at which the health status was last refreshed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcm-scheduledreport-healthstatus.html#cfn-bcm-scheduledreport-healthstatus-lastrefreshedat

status_code

The health status of a scheduled report.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcm-scheduledreport-healthstatus.html#cfn-bcm-scheduledreport-healthstatus-statuscode

ScheduleConfigProperty

class CfnScheduledReportPropsMixin.ScheduleConfigProperty(*, schedule_expression=None, schedule_expression_time_zone=None, schedule_period=None, state=None)

Bases: object

Defines when and how often a scheduled report runs.

Parameters:

schedule_expression (Optional[str]) – The schedule expression that specifies when to trigger the scheduled report run. This value must be a cron expression consisting of six fields separated by white spaces: cron(minutes hours day_of_month month day_of_week year).
schedule_expression_time_zone (Optional[str]) – The time zone for the schedule expression, for example, UTC.
schedule_period (Union[IResolvable, SchedulePeriodProperty, Dict[str, Any], None]) – The window during which the schedule is active. When omitted the service defaults it. EndTime must be within three years of the time of the request.
state (Optional[str]) – Whether the schedule is active.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcm-scheduledreport-scheduleconfig.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.cfn_property_mixins import aws_bcm as bcm

schedule_config_property = bcm.CfnScheduledReportPropsMixin.ScheduleConfigProperty(
    schedule_expression="scheduleExpression",
    schedule_expression_time_zone="scheduleExpressionTimeZone",
    schedule_period=bcm.CfnScheduledReportPropsMixin.SchedulePeriodProperty(
        end_time="endTime",
        start_time="startTime"
    ),
    state="state"
)

Attributes

schedule_expression

The schedule expression that specifies when to trigger the scheduled report run.

This value must be a cron expression consisting of six fields separated by white spaces: cron(minutes hours day_of_month month day_of_week year).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcm-scheduledreport-scheduleconfig.html#cfn-bcm-scheduledreport-scheduleconfig-scheduleexpression

schedule_expression_time_zone

The time zone for the schedule expression, for example, UTC.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcm-scheduledreport-scheduleconfig.html#cfn-bcm-scheduledreport-scheduleconfig-scheduleexpressiontimezone

schedule_period

The window during which the schedule is active.

When omitted the service defaults it. EndTime must be within three years of the time of the request.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcm-scheduledreport-scheduleconfig.html#cfn-bcm-scheduledreport-scheduleconfig-scheduleperiod

state

Whether the schedule is active.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcm-scheduledreport-scheduleconfig.html#cfn-bcm-scheduledreport-scheduleconfig-state

SchedulePeriodProperty

class CfnScheduledReportPropsMixin.SchedulePeriodProperty(*, end_time=None, start_time=None)

Bases: object

The window during which the schedule is active.

When omitted the service defaults it. EndTime must be within three years of the time of the request.

Parameters:

end_time (Optional[str]) – The time at which the schedule stops being active.
start_time (Optional[str]) – The time at which the schedule becomes active.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcm-scheduledreport-scheduleperiod.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.cfn_property_mixins import aws_bcm as bcm

schedule_period_property = bcm.CfnScheduledReportPropsMixin.SchedulePeriodProperty(
    end_time="endTime",
    start_time="startTime"
)

Attributes

end_time

The time at which the schedule stops being active.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcm-scheduledreport-scheduleperiod.html#cfn-bcm-scheduledreport-scheduleperiod-endtime

start_time

The time at which the schedule becomes active.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcm-scheduledreport-scheduleperiod.html#cfn-bcm-scheduledreport-scheduleperiod-starttime