Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. bcm
  6. ScheduledReport

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.81.0
published on Monday, Sep 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.bcm.ScheduledReport

aws-native logo aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.81.0
published on Monday, Sep 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    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.

    Create ScheduledReport Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ScheduledReport(name: string, args: ScheduledReportArgs, opts?: CustomResourceOptions);
    @overload
def ScheduledReport(resource_name: str,
                    args: ScheduledReportArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def ScheduledReport(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    dashboard_arn: Optional[str] = None,
                    schedule_config: Optional[ScheduledReportScheduleConfigArgs] = None,
                    scheduled_report_execution_role_arn: Optional[str] = None,
                    description: Optional[str] = None,
                    name: Optional[str] = None,
                    tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                    widget_date_range_override: Optional[ScheduledReportDateTimeRangeArgs] = None,
                    widget_ids: Optional[Sequence[str]] = None)
    func NewScheduledReport(ctx *Context, name string, args ScheduledReportArgs, opts ...ResourceOption) (*ScheduledReport, error)
    public ScheduledReport(string name, ScheduledReportArgs args, CustomResourceOptions? opts = null)
    public ScheduledReport(String name, ScheduledReportArgs args)
public ScheduledReport(String name, ScheduledReportArgs args, CustomResourceOptions options)

    type: aws-native:bcm:ScheduledReport
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "aws-native_bcm_scheduled_report" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ScheduledReportArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ScheduledReportArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ScheduledReportArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScheduledReportArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ScheduledReportArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ScheduledReport Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ScheduledReport resource accepts the following input properties:

    DashboardArn string
    The ARN of the dashboard associated with the scheduled report. Managed dashboards cannot be used.
    ScheduleConfig Pulumi.AwsNative.Bcm.Inputs.ScheduledReportScheduleConfig
    The schedule configuration that defines when and how often the report is generated.
    ScheduledReportExecutionRoleArn string
    The ARN of the IAM role that the scheduled report uses to execute. AWS Billing and Cost Management Dashboards assumes this IAM role while executing the scheduled report.
    Description string
    A description of the scheduled report's purpose or contents.
    Name string
    The name of the scheduled report.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    The tags applied to the scheduled report.
    WidgetDateRangeOverride Pulumi.AwsNative.Bcm.Inputs.ScheduledReportDateTimeRange
    The date range override applied to widgets in the scheduled report.
    WidgetIds List<string>
    The list of widget identifiers included in the scheduled report. If not specified, all widgets in the dashboard are included.
    DashboardArn string
    The ARN of the dashboard associated with the scheduled report. Managed dashboards cannot be used.
    ScheduleConfig ScheduledReportScheduleConfigArgs
    The schedule configuration that defines when and how often the report is generated.
    ScheduledReportExecutionRoleArn string
    The ARN of the IAM role that the scheduled report uses to execute. AWS Billing and Cost Management Dashboards assumes this IAM role while executing the scheduled report.
    Description string
    A description of the scheduled report's purpose or contents.
    Name string
    The name of the scheduled report.
    Tags TagArgs
    The tags applied to the scheduled report.
    WidgetDateRangeOverride ScheduledReportDateTimeRangeArgs
    The date range override applied to widgets in the scheduled report.
    WidgetIds []string
    The list of widget identifiers included in the scheduled report. If not specified, all widgets in the dashboard are included.
    dashboard_arn string
    The ARN of the dashboard associated with the scheduled report. Managed dashboards cannot be used.
    schedule_config object
    The schedule configuration that defines when and how often the report is generated.
    scheduled_report_execution_role_arn string
    The ARN of the IAM role that the scheduled report uses to execute. AWS Billing and Cost Management Dashboards assumes this IAM role while executing the scheduled report.
    description string
    A description of the scheduled report's purpose or contents.
    name string
    The name of the scheduled report.
    tags list(object)
    The tags applied to the scheduled report.
    widget_date_range_override object
    The date range override applied to widgets in the scheduled report.
    widget_ids list(string)
    The list of widget identifiers included in the scheduled report. If not specified, all widgets in the dashboard are included.
    dashboardArn String
    The ARN of the dashboard associated with the scheduled report. Managed dashboards cannot be used.
    scheduleConfig ScheduledReportScheduleConfig
    The schedule configuration that defines when and how often the report is generated.
    scheduledReportExecutionRoleArn String
    The ARN of the IAM role that the scheduled report uses to execute. AWS Billing and Cost Management Dashboards assumes this IAM role while executing the scheduled report.
    description String
    A description of the scheduled report's purpose or contents.
    name String
    The name of the scheduled report.
    tags List<Tag>
    The tags applied to the scheduled report.
    widgetDateRangeOverride ScheduledReportDateTimeRange
    The date range override applied to widgets in the scheduled report.
    widgetIds List<String>
    The list of widget identifiers included in the scheduled report. If not specified, all widgets in the dashboard are included.
    dashboardArn string
    The ARN of the dashboard associated with the scheduled report. Managed dashboards cannot be used.
    scheduleConfig ScheduledReportScheduleConfig
    The schedule configuration that defines when and how often the report is generated.
    scheduledReportExecutionRoleArn string
    The ARN of the IAM role that the scheduled report uses to execute. AWS Billing and Cost Management Dashboards assumes this IAM role while executing the scheduled report.
    description string
    A description of the scheduled report's purpose or contents.
    name string
    The name of the scheduled report.
    tags Tag[]
    The tags applied to the scheduled report.
    widgetDateRangeOverride ScheduledReportDateTimeRange
    The date range override applied to widgets in the scheduled report.
    widgetIds string[]
    The list of widget identifiers included in the scheduled report. If not specified, all widgets in the dashboard are included.
    dashboard_arn str
    The ARN of the dashboard associated with the scheduled report. Managed dashboards cannot be used.
    schedule_config ScheduledReportScheduleConfigArgs
    The schedule configuration that defines when and how often the report is generated.
    scheduled_report_execution_role_arn str
    The ARN of the IAM role that the scheduled report uses to execute. AWS Billing and Cost Management Dashboards assumes this IAM role while executing the scheduled report.
    description str
    A description of the scheduled report's purpose or contents.
    name str
    The name of the scheduled report.
    tags Sequence[TagArgs]
    The tags applied to the scheduled report.
    widget_date_range_override ScheduledReportDateTimeRangeArgs
    The date range override applied to widgets in the scheduled report.
    widget_ids Sequence[str]
    The list of widget identifiers included in the scheduled report. If not specified, all widgets in the dashboard are included.
    dashboardArn String
    The ARN of the dashboard associated with the scheduled report. Managed dashboards cannot be used.
    scheduleConfig Property Map
    The schedule configuration that defines when and how often the report is generated.
    scheduledReportExecutionRoleArn String
    The ARN of the IAM role that the scheduled report uses to execute. AWS Billing and Cost Management Dashboards assumes this IAM role while executing the scheduled report.
    description String
    A description of the scheduled report's purpose or contents.
    name String
    The name of the scheduled report.
    tags List<Property Map>
    The tags applied to the scheduled report.
    widgetDateRangeOverride Property Map
    The date range override applied to widgets in the scheduled report.
    widgetIds List<String>
    The list of widget identifiers included in the scheduled report. If not specified, all widgets in the dashboard are included.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ScheduledReport resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) of the scheduled report.
    CreatedAt string
    The timestamp when the scheduled report was created.
    HealthStatus Pulumi.AwsNative.Bcm.Outputs.ScheduledReportHealthStatus
    The health status of the scheduled report at its last refresh time.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    The timestamp when the scheduled report was last modified.
    Arn string
    The Amazon Resource Name (ARN) of the scheduled report.
    CreatedAt string
    The timestamp when the scheduled report was created.
    HealthStatus ScheduledReportHealthStatus
    The health status of the scheduled report at its last refresh time.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    The timestamp when the scheduled report was last modified.
    arn string
    The Amazon Resource Name (ARN) of the scheduled report.
    created_at string
    The timestamp when the scheduled report was created.
    health_status object
    The health status of the scheduled report at its last refresh time.
    id string
    The provider-assigned unique ID for this managed resource.
    updated_at string
    The timestamp when the scheduled report was last modified.
    arn String
    The Amazon Resource Name (ARN) of the scheduled report.
    createdAt String
    The timestamp when the scheduled report was created.
    healthStatus ScheduledReportHealthStatus
    The health status of the scheduled report at its last refresh time.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    The timestamp when the scheduled report was last modified.
    arn string
    The Amazon Resource Name (ARN) of the scheduled report.
    createdAt string
    The timestamp when the scheduled report was created.
    healthStatus ScheduledReportHealthStatus
    The health status of the scheduled report at its last refresh time.
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt string
    The timestamp when the scheduled report was last modified.
    arn str
    The Amazon Resource Name (ARN) of the scheduled report.
    created_at str
    The timestamp when the scheduled report was created.
    health_status ScheduledReportHealthStatus
    The health status of the scheduled report at its last refresh time.
    id str
    The provider-assigned unique ID for this managed resource.
    updated_at str
    The timestamp when the scheduled report was last modified.
    arn String
    The Amazon Resource Name (ARN) of the scheduled report.
    createdAt String
    The timestamp when the scheduled report was created.
    healthStatus Property Map
    The health status of the scheduled report at its last refresh time.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    The timestamp when the scheduled report was last modified.

    Supporting Types

    ScheduledReportDateTimeRange, ScheduledReportDateTimeRangeArgs

    An absolute or relative date range.
    end_time object
    The end of the range.
    start_time object
    The start of the range.
    endTime Property Map
    The end of the range.
    startTime Property Map
    The start of the range.

    ScheduledReportDateTimeType, ScheduledReportDateTimeTypeArgs

    Absolute
    ABSOLUTE
    Relative
    RELATIVE
    ScheduledReportDateTimeTypeAbsolute
    ABSOLUTE
    ScheduledReportDateTimeTypeRelative
    RELATIVE
    "ABSOLUTE"
    ABSOLUTE
    "RELATIVE"
    RELATIVE
    Absolute
    ABSOLUTE
    Relative
    RELATIVE
    Absolute
    ABSOLUTE
    Relative
    RELATIVE
    ABSOLUTE
    ABSOLUTE
    RELATIVE
    RELATIVE
    "ABSOLUTE"
    ABSOLUTE
    "RELATIVE"
    RELATIVE

    ScheduledReportDateTimeValue, ScheduledReportDateTimeValueArgs

    A date expressed either as an absolute instant or as an offset from now.
    Type Pulumi.AwsNative.Bcm.ScheduledReportDateTimeType
    Whether Value is an absolute date or a duration relative to now.
    Value string
    The date, or an ISO 8601 duration when Type is RELATIVE.
    Type ScheduledReportDateTimeType
    Whether Value is an absolute date or a duration relative to now.
    Value string
    The date, or an ISO 8601 duration when Type is RELATIVE.
    type "ABSOLUTE" | "RELATIVE"
    Whether Value is an absolute date or a duration relative to now.
    value string
    The date, or an ISO 8601 duration when Type is RELATIVE.
    type ScheduledReportDateTimeType
    Whether Value is an absolute date or a duration relative to now.
    value String
    The date, or an ISO 8601 duration when Type is RELATIVE.
    type ScheduledReportDateTimeType
    Whether Value is an absolute date or a duration relative to now.
    value string
    The date, or an ISO 8601 duration when Type is RELATIVE.
    type ScheduledReportDateTimeType
    Whether Value is an absolute date or a duration relative to now.
    value str
    The date, or an ISO 8601 duration when Type is RELATIVE.
    type "ABSOLUTE" | "RELATIVE"
    Whether Value is an absolute date or a duration relative to now.
    value String
    The date, or an ISO 8601 duration when Type is RELATIVE.

    ScheduledReportHealthStatus, ScheduledReportHealthStatusArgs

    The health of the scheduled report as of its last refresh.
    StatusCode Pulumi.AwsNative.Bcm.ScheduledReportHealthStatusCode
    Whether the scheduled report is healthy.
    LastRefreshedAt string
    The time at which the health status was last refreshed.
    StatusCode ScheduledReportHealthStatusCode
    Whether the scheduled report is healthy.
    LastRefreshedAt string
    The time at which the health status was last refreshed.
    status_code "HEALTHY" | "UNHEALTHY"
    Whether the scheduled report is healthy.
    last_refreshed_at string
    The time at which the health status was last refreshed.
    statusCode ScheduledReportHealthStatusCode
    Whether the scheduled report is healthy.
    lastRefreshedAt String
    The time at which the health status was last refreshed.
    statusCode ScheduledReportHealthStatusCode
    Whether the scheduled report is healthy.
    lastRefreshedAt string
    The time at which the health status was last refreshed.
    status_code ScheduledReportHealthStatusCode
    Whether the scheduled report is healthy.
    last_refreshed_at str
    The time at which the health status was last refreshed.
    statusCode "HEALTHY" | "UNHEALTHY"
    Whether the scheduled report is healthy.
    lastRefreshedAt String
    The time at which the health status was last refreshed.

    ScheduledReportHealthStatusCode, ScheduledReportHealthStatusCodeArgs

    Healthy
    HEALTHY
    Unhealthy
    UNHEALTHY
    ScheduledReportHealthStatusCodeHealthy
    HEALTHY
    ScheduledReportHealthStatusCodeUnhealthy
    UNHEALTHY
    "HEALTHY"
    HEALTHY
    "UNHEALTHY"
    UNHEALTHY
    Healthy
    HEALTHY
    Unhealthy
    UNHEALTHY
    Healthy
    HEALTHY
    Unhealthy
    UNHEALTHY
    HEALTHY
    HEALTHY
    UNHEALTHY
    UNHEALTHY
    "HEALTHY"
    HEALTHY
    "UNHEALTHY"
    UNHEALTHY

    ScheduledReportScheduleConfig, ScheduledReportScheduleConfigArgs

    Defines when and how often a scheduled report runs.
    ScheduleExpression string
    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).
    ScheduleExpressionTimeZone string
    The time zone for the schedule expression, for example, UTC.
    SchedulePeriod Pulumi.AwsNative.Bcm.Inputs.ScheduledReportSchedulePeriod
    The time period during which the schedule is active.
    State Pulumi.AwsNative.Bcm.ScheduledReportScheduleState
    The state of the schedule. ENABLED means the scheduled report runs according to its schedule expression. DISABLED means the scheduled report is paused and will not run until re-enabled.
    ScheduleExpression string
    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).
    ScheduleExpressionTimeZone string
    The time zone for the schedule expression, for example, UTC.
    SchedulePeriod ScheduledReportSchedulePeriod
    The time period during which the schedule is active.
    State ScheduledReportScheduleState
    The state of the schedule. ENABLED means the scheduled report runs according to its schedule expression. DISABLED means the scheduled report is paused and will not run until re-enabled.
    schedule_expression string
    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 string
    The time zone for the schedule expression, for example, UTC.
    schedule_period object
    The time period during which the schedule is active.
    state "ENABLED" | "DISABLED"
    The state of the schedule. ENABLED means the scheduled report runs according to its schedule expression. DISABLED means the scheduled report is paused and will not run until re-enabled.
    scheduleExpression String
    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).
    scheduleExpressionTimeZone String
    The time zone for the schedule expression, for example, UTC.
    schedulePeriod ScheduledReportSchedulePeriod
    The time period during which the schedule is active.
    state ScheduledReportScheduleState
    The state of the schedule. ENABLED means the scheduled report runs according to its schedule expression. DISABLED means the scheduled report is paused and will not run until re-enabled.
    scheduleExpression string
    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).
    scheduleExpressionTimeZone string
    The time zone for the schedule expression, for example, UTC.
    schedulePeriod ScheduledReportSchedulePeriod
    The time period during which the schedule is active.
    state ScheduledReportScheduleState
    The state of the schedule. ENABLED means the scheduled report runs according to its schedule expression. DISABLED means the scheduled report is paused and will not run until re-enabled.
    schedule_expression 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 str
    The time zone for the schedule expression, for example, UTC.
    schedule_period ScheduledReportSchedulePeriod
    The time period during which the schedule is active.
    state ScheduledReportScheduleState
    The state of the schedule. ENABLED means the scheduled report runs according to its schedule expression. DISABLED means the scheduled report is paused and will not run until re-enabled.
    scheduleExpression String
    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).
    scheduleExpressionTimeZone String
    The time zone for the schedule expression, for example, UTC.
    schedulePeriod Property Map
    The time period during which the schedule is active.
    state "ENABLED" | "DISABLED"
    The state of the schedule. ENABLED means the scheduled report runs according to its schedule expression. DISABLED means the scheduled report is paused and will not run until re-enabled.

    ScheduledReportSchedulePeriod, ScheduledReportSchedulePeriodArgs

    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.
    EndTime string
    The time at which the schedule stops being active.
    StartTime string
    The time at which the schedule becomes active.
    EndTime string
    The time at which the schedule stops being active.
    StartTime string
    The time at which the schedule becomes active.
    end_time string
    The time at which the schedule stops being active.
    start_time string
    The time at which the schedule becomes active.
    endTime String
    The time at which the schedule stops being active.
    startTime String
    The time at which the schedule becomes active.
    endTime string
    The time at which the schedule stops being active.
    startTime string
    The time at which the schedule becomes active.
    end_time str
    The time at which the schedule stops being active.
    start_time str
    The time at which the schedule becomes active.
    endTime String
    The time at which the schedule stops being active.
    startTime String
    The time at which the schedule becomes active.

    ScheduledReportScheduleState, ScheduledReportScheduleStateArgs

    Enabled
    ENABLED
    Disabled
    DISABLED
    ScheduledReportScheduleStateEnabled
    ENABLED
    ScheduledReportScheduleStateDisabled
    DISABLED
    "ENABLED"
    ENABLED
    "DISABLED"
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    ENABLED
    ENABLED
    DISABLED
    DISABLED
    "ENABLED"
    ENABLED
    "DISABLED"
    DISABLED

    Tag, TagArgs

    A set of tags to apply to the resource.
    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.81.0
    published on Monday, Sep 28, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial