AWS Native

v0.43.0 published on Thursday, Dec 1, 2022 by Pulumi

ReportPlan

Contains detailed information about a report plan in AWS Backup Audit Manager.

Create ReportPlan Resource

new ReportPlan(name: string, args: ReportPlanArgs, opts?: CustomResourceOptions);
@overload
def ReportPlan(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               report_delivery_channel: Optional[ReportDeliveryChannelPropertiesArgs] = None,
               report_plan_description: Optional[str] = None,
               report_plan_name: Optional[str] = None,
               report_plan_tags: Optional[Sequence[ReportPlanTagArgs]] = None,
               report_setting: Optional[ReportSettingPropertiesArgs] = None)
@overload
def ReportPlan(resource_name: str,
               args: ReportPlanArgs,
               opts: Optional[ResourceOptions] = None)
func NewReportPlan(ctx *Context, name string, args ReportPlanArgs, opts ...ResourceOption) (*ReportPlan, error)
public ReportPlan(string name, ReportPlanArgs args, CustomResourceOptions? opts = null)
public ReportPlan(String name, ReportPlanArgs args)
public ReportPlan(String name, ReportPlanArgs args, CustomResourceOptions options)
type: aws-native:backup:ReportPlan
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

ReportPlan Resource Properties

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

Inputs

The ReportPlan resource accepts the following input properties:

ReportDeliveryChannel Pulumi.AwsNative.Backup.Inputs.ReportDeliveryChannelPropertiesArgs

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.

ReportSetting Pulumi.AwsNative.Backup.Inputs.ReportSettingPropertiesArgs

Identifies the report template for the report. Reports are built using a report template.

ReportPlanDescription string

An optional description of the report plan with a maximum of 1,024 characters.

ReportPlanName string

The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

ReportPlanTags List<Pulumi.AwsNative.Backup.Inputs.ReportPlanTagArgs>

Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.

ReportDeliveryChannel ReportDeliveryChannelPropertiesArgs

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.

ReportSetting ReportSettingPropertiesArgs

Identifies the report template for the report. Reports are built using a report template.

ReportPlanDescription string

An optional description of the report plan with a maximum of 1,024 characters.

ReportPlanName string

The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

ReportPlanTags []ReportPlanTagArgs

Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.

reportDeliveryChannel ReportDeliveryChannelPropertiesArgs

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.

reportSetting ReportSettingPropertiesArgs

Identifies the report template for the report. Reports are built using a report template.

reportPlanDescription String

An optional description of the report plan with a maximum of 1,024 characters.

reportPlanName String

The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

reportPlanTags List<ReportPlanTagArgs>

Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.

reportDeliveryChannel ReportDeliveryChannelPropertiesArgs

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.

reportSetting ReportSettingPropertiesArgs

Identifies the report template for the report. Reports are built using a report template.

reportPlanDescription string

An optional description of the report plan with a maximum of 1,024 characters.

reportPlanName string

The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

reportPlanTags ReportPlanTagArgs[]

Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.

report_delivery_channel ReportDeliveryChannelPropertiesArgs

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

Identifies the report template for the report. Reports are built using a report template.

report_plan_description str

An optional description of the report plan with a maximum of 1,024 characters.

report_plan_name str

The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

report_plan_tags Sequence[ReportPlanTagArgs]

Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.

reportDeliveryChannel Property Map

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.

reportSetting Property Map

Identifies the report template for the report. Reports are built using a report template.

reportPlanDescription String

An optional description of the report plan with a maximum of 1,024 characters.

reportPlanName String

The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

reportPlanTags List<Property Map>

Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

ReportPlanArn string

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

Id string

The provider-assigned unique ID for this managed resource.

ReportPlanArn string

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

id String

The provider-assigned unique ID for this managed resource.

reportPlanArn String

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

id string

The provider-assigned unique ID for this managed resource.

reportPlanArn string

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

id str

The provider-assigned unique ID for this managed resource.

report_plan_arn str

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

id String

The provider-assigned unique ID for this managed resource.

reportPlanArn String

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

Supporting Types

ReportDeliveryChannelProperties

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

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

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

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

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

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

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

s3KeyPrefix 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_name str

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

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.

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

s3KeyPrefix 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

ReportTemplate 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

FrameworkArns List<string>

The Amazon Resource Names (ARNs) of the frameworks a report covers.

ReportTemplate 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

FrameworkArns []string

The Amazon Resource Names (ARNs) of the frameworks a report covers.

reportTemplate 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

frameworkArns List<String>

The Amazon Resource Names (ARNs) of the frameworks a report covers.

reportTemplate 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

frameworkArns string[]

The Amazon Resource Names (ARNs) of the frameworks 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

framework_arns Sequence[str]

The Amazon Resource Names (ARNs) of the frameworks a report covers.

reportTemplate 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

frameworkArns List<String>

The Amazon Resource Names (ARNs) of the frameworks a report covers.

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0