AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Backup CreateReportPlan API operation.

Syntax

New-BAKReportPlan
-ReportPlanName <String>
-ReportSetting_Account <String[]>
-ReportDeliveryChannel_Format <String[]>
-ReportSetting_FrameworkArn <String[]>
-IdempotencyToken <String>
-ReportSetting_NumberOfFramework <Int32>
-ReportSetting_OrganizationUnit <String[]>
-ReportSetting_Region <String[]>
-ReportPlanDescription <String>
-ReportPlanTag <Hashtable>
-ReportSetting_ReportTemplate <String>
-ReportDeliveryChannel_S3BucketName <String>
-ReportDeliveryChannel_S3KeyPrefix <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonBackupConfig>

Description

Creates a report plan. A report plan is a document that contains information about the contents of the report and where Backup will deliver it. If you call CreateReportPlan with a plan that already exists, you receive an AlreadyExistsException exception.

Parameters

-ClientConfig <AmazonBackupConfig>
Amazon.PowerShell.Cmdlets.BAK.AmazonBackupClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IdempotencyToken <String>
A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateReportPlanInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the ReportPlanName parameter. The -PassThru parameter is deprecated, use -Select '^ReportPlanName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ReportDeliveryChannel_Format <String[]>
The format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesReportDeliveryChannel_Formats
-ReportDeliveryChannel_S3BucketName <String>
The unique name of the S3 bucket that receives your reports.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ReportDeliveryChannel_S3KeyPrefix <String>
The prefix for where 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ReportPlanDescription <String>
An optional description of the report plan with a maximum of 1,024 characters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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 (_).
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ReportPlanTag <Hashtable>
The tags to assign to the report plan.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesReportPlanTags
-ReportSetting_Account <String[]>
These are the accounts to be included in the report.Use string value of ROOT to include all organizational units.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesReportSetting_Accounts
-ReportSetting_FrameworkArn <String[]>
The Amazon Resource Names (ARNs) of the frameworks a report covers.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesReportSetting_FrameworkArns
-ReportSetting_NumberOfFramework <Int32>
The number of frameworks a report covers.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesReportSetting_NumberOfFrameworks
-ReportSetting_OrganizationUnit <String[]>
These are the Organizational Units to be included in the report.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesReportSetting_OrganizationUnits
-ReportSetting_Region <String[]>
These are the Regions to be included in the report.Use the wildcard as the string value to include all Regions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesReportSetting_Regions
-ReportSetting_ReportTemplate <String>
Identifies the report template for the report. Reports are built using a report template. The report templates are:RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT | SCAN_JOB_REPORT
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.CreateReportPlanResponse). Specifying the name of a property of type Amazon.Backup.Model.CreateReportPlanResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.Backup.Model.CreateReportPlanResponse
This cmdlet returns an Amazon.Backup.Model.CreateReportPlanResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z