1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. pi
  6. PerfReports

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
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

    Creates and manages a Performance Insights performance analysis report for a specified DB instance.

    Create PerfReports Resource

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

    Constructor syntax

    new PerfReports(name: string, args: PerfReportsArgs, opts?: CustomResourceOptions);
    @overload
    def PerfReports(resource_name: str,
                    args: PerfReportsArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def PerfReports(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    end_time: Optional[str] = None,
                    identifier: Optional[str] = None,
                    service_type: Optional[PerfReportsServiceType] = None,
                    start_time: Optional[str] = None,
                    tags: Optional[Sequence[_root_inputs.CreateOnlyTagArgs]] = None)
    func NewPerfReports(ctx *Context, name string, args PerfReportsArgs, opts ...ResourceOption) (*PerfReports, error)
    public PerfReports(string name, PerfReportsArgs args, CustomResourceOptions? opts = null)
    public PerfReports(String name, PerfReportsArgs args)
    public PerfReports(String name, PerfReportsArgs args, CustomResourceOptions options)
    
    type: aws-native:pi:PerfReports
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws-native_pi_perf_reports" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args PerfReportsArgs
    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 PerfReportsArgs
    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 PerfReportsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PerfReportsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PerfReportsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    PerfReports 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 PerfReports resource accepts the following input properties:

    EndTime string
    The end time defined for the analysis report in ISO 8601 format.
    Identifier string
    An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source. To use an Amazon RDS instance as a data source, specify its DbiResourceId value.
    ServiceType Pulumi.AwsNative.Pi.PerfReportsServiceType
    The AWS service for which Performance Insights returns metrics. Valid values are RDS and DOCDB.
    StartTime string
    The start time defined for the analysis report in ISO 8601 format.
    Tags List<Pulumi.AwsNative.Inputs.CreateOnlyTag>
    An array of key-value pairs to apply to this resource.
    EndTime string
    The end time defined for the analysis report in ISO 8601 format.
    Identifier string
    An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source. To use an Amazon RDS instance as a data source, specify its DbiResourceId value.
    ServiceType PerfReportsServiceType
    The AWS service for which Performance Insights returns metrics. Valid values are RDS and DOCDB.
    StartTime string
    The start time defined for the analysis report in ISO 8601 format.
    Tags CreateOnlyTagArgs
    An array of key-value pairs to apply to this resource.
    end_time string
    The end time defined for the analysis report in ISO 8601 format.
    identifier string
    An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source. To use an Amazon RDS instance as a data source, specify its DbiResourceId value.
    service_type "RDS" | "DOCDB"
    The AWS service for which Performance Insights returns metrics. Valid values are RDS and DOCDB.
    start_time string
    The start time defined for the analysis report in ISO 8601 format.
    tags list(object)
    An array of key-value pairs to apply to this resource.
    endTime String
    The end time defined for the analysis report in ISO 8601 format.
    identifier String
    An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source. To use an Amazon RDS instance as a data source, specify its DbiResourceId value.
    serviceType PerfReportsServiceType
    The AWS service for which Performance Insights returns metrics. Valid values are RDS and DOCDB.
    startTime String
    The start time defined for the analysis report in ISO 8601 format.
    tags List<CreateOnlyTag>
    An array of key-value pairs to apply to this resource.
    endTime string
    The end time defined for the analysis report in ISO 8601 format.
    identifier string
    An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source. To use an Amazon RDS instance as a data source, specify its DbiResourceId value.
    serviceType PerfReportsServiceType
    The AWS service for which Performance Insights returns metrics. Valid values are RDS and DOCDB.
    startTime string
    The start time defined for the analysis report in ISO 8601 format.
    tags CreateOnlyTag[]
    An array of key-value pairs to apply to this resource.
    end_time str
    The end time defined for the analysis report in ISO 8601 format.
    identifier str
    An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source. To use an Amazon RDS instance as a data source, specify its DbiResourceId value.
    service_type PerfReportsServiceType
    The AWS service for which Performance Insights returns metrics. Valid values are RDS and DOCDB.
    start_time str
    The start time defined for the analysis report in ISO 8601 format.
    tags Sequence[CreateOnlyTagArgs]
    An array of key-value pairs to apply to this resource.
    endTime String
    The end time defined for the analysis report in ISO 8601 format.
    identifier String
    An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source. To use an Amazon RDS instance as a data source, specify its DbiResourceId value.
    serviceType "RDS" | "DOCDB"
    The AWS service for which Performance Insights returns metrics. Valid values are RDS and DOCDB.
    startTime String
    The start time defined for the analysis report in ISO 8601 format.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Outputs

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

    AnalysisReportId string
    A unique identifier for the analysis report.
    Arn string
    The Amazon Resource Name (ARN) of the performance analysis report.
    CreateTime string
    The time the analysis report was created in ISO 8601 format.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status Pulumi.AwsNative.Pi.PerfReportsStatus
    The status of the analysis report.
    AnalysisReportId string
    A unique identifier for the analysis report.
    Arn string
    The Amazon Resource Name (ARN) of the performance analysis report.
    CreateTime string
    The time the analysis report was created in ISO 8601 format.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status PerfReportsStatus
    The status of the analysis report.
    analysis_report_id string
    A unique identifier for the analysis report.
    arn string
    The Amazon Resource Name (ARN) of the performance analysis report.
    create_time string
    The time the analysis report was created in ISO 8601 format.
    id string
    The provider-assigned unique ID for this managed resource.
    status "RUNNING" | "SUCCEEDED" | "FAILED"
    The status of the analysis report.
    analysisReportId String
    A unique identifier for the analysis report.
    arn String
    The Amazon Resource Name (ARN) of the performance analysis report.
    createTime String
    The time the analysis report was created in ISO 8601 format.
    id String
    The provider-assigned unique ID for this managed resource.
    status PerfReportsStatus
    The status of the analysis report.
    analysisReportId string
    A unique identifier for the analysis report.
    arn string
    The Amazon Resource Name (ARN) of the performance analysis report.
    createTime string
    The time the analysis report was created in ISO 8601 format.
    id string
    The provider-assigned unique ID for this managed resource.
    status PerfReportsStatus
    The status of the analysis report.
    analysis_report_id str
    A unique identifier for the analysis report.
    arn str
    The Amazon Resource Name (ARN) of the performance analysis report.
    create_time str
    The time the analysis report was created in ISO 8601 format.
    id str
    The provider-assigned unique ID for this managed resource.
    status PerfReportsStatus
    The status of the analysis report.
    analysisReportId String
    A unique identifier for the analysis report.
    arn String
    The Amazon Resource Name (ARN) of the performance analysis report.
    createTime String
    The time the analysis report was created in ISO 8601 format.
    id String
    The provider-assigned unique ID for this managed resource.
    status "RUNNING" | "SUCCEEDED" | "FAILED"
    The status of the analysis report.

    Supporting Types

    CreateOnlyTag, CreateOnlyTagArgs

    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

    PerfReportsServiceType, PerfReportsServiceTypeArgs

    Rds
    RDS
    Docdb
    DOCDB
    PerfReportsServiceTypeRds
    RDS
    PerfReportsServiceTypeDocdb
    DOCDB
    "RDS"
    RDS
    "DOCDB"
    DOCDB
    Rds
    RDS
    Docdb
    DOCDB
    Rds
    RDS
    Docdb
    DOCDB
    RDS
    RDS
    DOCDB
    DOCDB
    "RDS"
    RDS
    "DOCDB"
    DOCDB

    PerfReportsStatus, PerfReportsStatusArgs

    Running
    RUNNING
    Succeeded
    SUCCEEDED
    Failed
    FAILED
    PerfReportsStatusRunning
    RUNNING
    PerfReportsStatusSucceeded
    SUCCEEDED
    PerfReportsStatusFailed
    FAILED
    "RUNNING"
    RUNNING
    "SUCCEEDED"
    SUCCEEDED
    "FAILED"
    FAILED
    Running
    RUNNING
    Succeeded
    SUCCEEDED
    Failed
    FAILED
    Running
    RUNNING
    Succeeded
    SUCCEEDED
    Failed
    FAILED
    RUNNING
    RUNNING
    SUCCEEDED
    SUCCEEDED
    FAILED
    FAILED
    "RUNNING"
    RUNNING
    "SUCCEEDED"
    SUCCEEDED
    "FAILED"
    FAILED

    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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial