We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 28, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
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:
- 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 Pulumi.Aws Native. Pi. Perf Reports Service Type - 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.
-
List<Pulumi.
Aws Native. Inputs. Create Only Tag> - 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 PerfReports Service Type - 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.
-
Create
Only Tag Args - 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.
- list(object)
- 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 PerfReports Service Type - 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.
-
List<Create
Only Tag> - 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 PerfReports Service Type - 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.
-
Create
Only Tag[] - 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 PerfReports Service Type - 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.
-
Sequence[Create
Only Tag Args] - 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.
- 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:
- Analysis
Report stringId - 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
Pulumi.
Aws Native. Pi. Perf Reports Status - The status of the analysis report.
- Analysis
Report stringId - 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
Perf
Reports Status - The status of the analysis report.
- analysis_
report_ stringid - 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.
- analysis
Report StringId - 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
Perf
Reports Status - The status of the analysis report.
- analysis
Report stringId - 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
Perf
Reports Status - The status of the analysis report.
- analysis_
report_ strid - 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
Perf
Reports Status - The status of the analysis report.
- analysis
Report StringId - 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.
Supporting Types
CreateOnlyTag, CreateOnlyTagArgs
A set of tags to apply to the resource.PerfReportsServiceType, PerfReportsServiceTypeArgs
- Rds
RDS- Docdb
DOCDB
- Perf
Reports Service Type Rds RDS- Perf
Reports Service Type Docdb 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
- Perf
Reports Status Running RUNNING- Perf
Reports Status Succeeded SUCCEEDED- Perf
Reports Status 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
- "RUNNING"
RUNNING- "SUCCEEDED"
SUCCEEDED- "FAILED"
FAILED
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 28, 2026 by Pulumi