AWS Native is in preview. AWS Classic is fully supported.
aws-native.backup.getReportPlan
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
Contains detailed information about a report plan in AWS Backup Audit Manager.
Using getReportPlan
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getReportPlan(args: GetReportPlanArgs, opts?: InvokeOptions): Promise<GetReportPlanResult>
function getReportPlanOutput(args: GetReportPlanOutputArgs, opts?: InvokeOptions): Output<GetReportPlanResult>
def get_report_plan(report_plan_arn: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetReportPlanResult
def get_report_plan_output(report_plan_arn: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetReportPlanResult]
func LookupReportPlan(ctx *Context, args *LookupReportPlanArgs, opts ...InvokeOption) (*LookupReportPlanResult, error)
func LookupReportPlanOutput(ctx *Context, args *LookupReportPlanOutputArgs, opts ...InvokeOption) LookupReportPlanResultOutput
> Note: This function is named LookupReportPlan
in the Go SDK.
public static class GetReportPlan
{
public static Task<GetReportPlanResult> InvokeAsync(GetReportPlanArgs args, InvokeOptions? opts = null)
public static Output<GetReportPlanResult> Invoke(GetReportPlanInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetReportPlanResult> getReportPlan(GetReportPlanArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:backup:getReportPlan
arguments:
# arguments dictionary
The following arguments are supported:
- Report
Plan stringArn An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
- Report
Plan stringArn An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
- report
Plan StringArn An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
- report
Plan stringArn An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
- report_
plan_ strarn An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
- report
Plan StringArn An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
getReportPlan Result
The following output properties are available:
- Report
Delivery Pulumi.Channel Aws Native. Backup. Outputs. Report Delivery Channel Properties A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
- Report
Plan stringArn An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
- Report
Plan stringDescription An optional description of the report plan with a maximum of 1,024 characters.
- List<Pulumi.
Aws Native. Backup. Outputs. Report Plan Tag> Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
- Report
Setting Pulumi.Aws Native. Backup. Outputs. Report Setting Properties Identifies the report template for the report. Reports are built using a report template.
- Report
Delivery ReportChannel Delivery Channel Properties A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
- Report
Plan stringArn An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
- Report
Plan stringDescription An optional description of the report plan with a maximum of 1,024 characters.
- []Report
Plan Tag Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
- Report
Setting ReportSetting Properties Identifies the report template for the report. Reports are built using a report template.
- report
Delivery ReportChannel Delivery Channel Properties A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
- report
Plan StringArn An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
- report
Plan StringDescription An optional description of the report plan with a maximum of 1,024 characters.
- List<Report
Plan Tag> Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
- report
Setting ReportSetting Properties Identifies the report template for the report. Reports are built using a report template.
- report
Delivery ReportChannel Delivery Channel Properties A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
- report
Plan stringArn An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
- report
Plan stringDescription An optional description of the report plan with a maximum of 1,024 characters.
- Report
Plan Tag[] Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
- report
Setting ReportSetting Properties Identifies the report template for the report. Reports are built using a report template.
- report_
delivery_ Reportchannel Delivery Channel Properties A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
- report_
plan_ strarn An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
- report_
plan_ strdescription An optional description of the report plan with a maximum of 1,024 characters.
- Sequence[Report
Plan Tag] Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
- report_
setting ReportSetting Properties Identifies the report template for the report. Reports are built using a report template.
- report
Delivery Property MapChannel A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
- report
Plan StringArn An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
- report
Plan StringDescription An optional description of the report plan with a maximum of 1,024 characters.
- List<Property Map>
Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
- report
Setting Property Map Identifies the report template for the report. Reports are built using a report template.
Supporting Types
ReportDeliveryChannelProperties
- S3Bucket
Name string The unique name of the S3 bucket that receives your reports.
- Formats List<string>
A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.
- S3Key
Prefix string The prefix for where AWS Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.
- S3Bucket
Name string The unique name of the S3 bucket that receives your reports.
- Formats []string
A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.
- S3Key
Prefix string The prefix for where AWS Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.
- s3Bucket
Name String The unique name of the S3 bucket that receives your reports.
- formats List<String>
A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.
- s3Key
Prefix String The prefix for where AWS Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.
- s3Bucket
Name string The unique name of the S3 bucket that receives your reports.
- formats string[]
A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.
- s3Key
Prefix string The prefix for where AWS Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.
- s3_
bucket_ strname The unique name of the S3 bucket that receives your reports.
- formats Sequence[str]
A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.
- s3_
key_ strprefix The prefix for where AWS Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.
- s3Bucket
Name String The unique name of the S3 bucket that receives your reports.
- formats List<String>
A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.
- s3Key
Prefix String The prefix for where AWS Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.
ReportPlanTag
- Key string
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Key string
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key string
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value string
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key str
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value str
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
ReportSettingProperties
- Report
Template string Identifies the report template for the report. Reports are built using a report template. The report templates are:
BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
- Accounts List<string>
The list of AWS accounts that a report covers.
- Framework
Arns List<string> The Amazon Resource Names (ARNs) of the frameworks a report covers.
- Organization
Units List<string> The list of AWS organization units that a report covers.
- Regions List<string>
The list of AWS regions that a report covers.
- Report
Template string Identifies the report template for the report. Reports are built using a report template. The report templates are:
BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
- Accounts []string
The list of AWS accounts that a report covers.
- Framework
Arns []string The Amazon Resource Names (ARNs) of the frameworks a report covers.
- Organization
Units []string The list of AWS organization units that a report covers.
- Regions []string
The list of AWS regions that a report covers.
- report
Template String Identifies the report template for the report. Reports are built using a report template. The report templates are:
BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
- accounts List<String>
The list of AWS accounts that a report covers.
- framework
Arns List<String> The Amazon Resource Names (ARNs) of the frameworks a report covers.
- organization
Units List<String> The list of AWS organization units that a report covers.
- regions List<String>
The list of AWS regions that a report covers.
- report
Template string Identifies the report template for the report. Reports are built using a report template. The report templates are:
BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
- accounts string[]
The list of AWS accounts that a report covers.
- framework
Arns string[] The Amazon Resource Names (ARNs) of the frameworks a report covers.
- organization
Units string[] The list of AWS organization units that a report covers.
- regions string[]
The list of AWS regions that a report covers.
- report_
template str Identifies the report template for the report. Reports are built using a report template. The report templates are:
BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
- accounts Sequence[str]
The list of AWS accounts that a report covers.
- framework_
arns Sequence[str] The Amazon Resource Names (ARNs) of the frameworks a report covers.
- organization_
units Sequence[str] The list of AWS organization units that a report covers.
- regions Sequence[str]
The list of AWS regions that a report covers.
- report
Template String Identifies the report template for the report. Reports are built using a report template. The report templates are:
BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
- accounts List<String>
The list of AWS accounts that a report covers.
- framework
Arns List<String> The Amazon Resource Names (ARNs) of the frameworks a report covers.
- organization
Units List<String> The list of AWS organization units that a report covers.
- regions List<String>
The list of AWS regions that a report covers.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.