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 CreateBackupSelection API operation.

Syntax

New-BAKBackupSelection
-BackupPlanId <String>
-CreatorRequestId <String>
-BackupSelection_IamRoleArn <String>
-BackupSelection_ListOfTag <Condition[]>
-BackupSelection_NotResource <String[]>
-BackupSelection_Resource <String[]>
-BackupSelection_SelectionName <String>
-Conditions_StringEqual <ConditionParameter[]>
-Conditions_StringLike <ConditionParameter[]>
-Conditions_StringNotEqual <ConditionParameter[]>
-Conditions_StringNotLike <ConditionParameter[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Creates a JSON document that specifies a set of resources to assign to a backup plan. For examples, see Assigning resources programmatically.

Parameters

-BackupPlanId <String>
Uniquely identifies the backup plan to be associated with the selection of resources.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-BackupSelection_IamRoleArn <String>
The ARN of the IAM role that Backup uses to authenticate when backing up the target resource; for example, arn:aws:iam::123456789012:role/S3Access.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-BackupSelection_ListOfTag <Condition[]>
A list of conditions that you define to assign resources to your backup plans using tags. For example, "StringEquals": {"Department": "accounting". Condition operators are case sensitive.ListOfTags differs from Conditions as follows:
  • When you specify more than one condition, you assign all resources that match AT LEAST ONE condition (using OR logic).
  • ListOfTags only supports StringEquals. Conditions supports StringEquals, StringLike, StringNotEquals, and StringNotLike.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesBackupSelection_ListOfTags
-BackupSelection_NotResource <String[]>
A list of Amazon Resource Names (ARNs) to exclude from a backup plan. The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards.If you need to exclude many resources from a backup plan, consider a different resource selection strategy, such as assigning only one or a few resource types or refining your resource selection using tags.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesBackupSelection_NotResources
-BackupSelection_Resource <String[]>
A list of Amazon Resource Names (ARNs) to assign to a backup plan. The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards.If you need to assign many resources to a backup plan, consider a different resource selection strategy, such as assigning all resources of a resource type or refining your resource selection using tags.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesBackupSelection_Resources
-BackupSelection_SelectionName <String>
The display name of a resource selection document. Must contain 1 to 50 alphanumeric or '-_.' characters.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Conditions_StringEqual <ConditionParameter[]>
Filters the values of your tagged resources for only those resources that you tagged with the same value. Also called "exact matching."
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesBackupSelection_Conditions_StringEquals
-Conditions_StringLike <ConditionParameter[]>
Filters the values of your tagged resources for matching tag values with the use of a wildcard character (*) anywhere in the string. For example, "prod*" or "*rod*" matches the tag value "production".
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesBackupSelection_Conditions_StringLike
-Conditions_StringNotEqual <ConditionParameter[]>
Filters the values of your tagged resources for only those resources that you tagged that do not have the same value. Also called "negated matching."
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesBackupSelection_Conditions_StringNotEquals
-Conditions_StringNotLike <ConditionParameter[]>
Filters the values of your tagged resources for non-matching tag values with the use of a wildcard character (*) anywhere in the string.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesBackupSelection_Conditions_StringNotLike
-CreatorRequestId <String>
A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
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)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the BackupPlanId parameter. The -PassThru parameter is deprecated, use -Select '^BackupPlanId' instead. This parameter will be removed in a future version.
Required?False
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.CreateBackupSelectionResponse). Specifying the name of a property of type Amazon.Backup.Model.CreateBackupSelectionResponse 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

This cmdlet returns an Amazon.Backup.Model.CreateBackupSelectionResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

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