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 Amazon Recycle Bin CreateRule API operation.

Syntax

New-RBINRule
-ResourceType <ResourceType>
-Description <String>
-ExcludeResourceTag <ResourceTag[]>
-ResourceTag <ResourceTag[]>
-RetentionPeriod_RetentionPeriodUnit <RetentionPeriodUnit>
-RetentionPeriod_RetentionPeriodValue <Int32>
-Tag <Tag[]>
-UnlockDelay_UnlockDelayUnit <UnlockDelayUnit>
-UnlockDelay_UnlockDelayValue <Int32>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonRecycleBinConfig>

Description

Creates a Recycle Bin retention rule. You can create two types of retention rules:
  • Tag-level retention rules - These retention rules use resource tags to identify the resources to protect. For each retention rule, you specify one or more tag key and value pairs. Resources (of the specified type) that have at least one of these tag key and value pairs are automatically retained in the Recycle Bin upon deletion. Use this type of retention rule to protect specific resources in your account based on their tags.
  • Region-level retention rules - These retention rules, by default, apply to all of the resources (of the specified type) in the Region, even if the resources are not tagged. However, you can specify exclusion tags to exclude resources that have specific tags. Use this type of retention rule to protect all resources of a specific type in a Region.
For more information, see Create Recycle Bin retention rules in the Amazon EBS User Guide.

Parameters

-ClientConfig <AmazonRecycleBinConfig>
Amazon.PowerShell.Cmdlets.RBIN.AmazonRecycleBinClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
The retention rule description.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExcludeResourceTag <ResourceTag[]>
[Region-level retention rules only] Specifies the exclusion tags to use to identify resources that are to be excluded, or ignored, by a Region-level retention rule. Resources that have any of these tags are not retained by the retention rule upon deletion.You can't specify exclusion tags for tag-level retention rules.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExcludeResourceTags
-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)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the ResourceType parameter. The -PassThru parameter is deprecated, use -Select '^ResourceType' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourceTag <ResourceTag[]>
[Tag-level retention rules only] Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.You can add the same tag key and value pair to a maximum or five retention rules.To create a Region-level retention rule, omit this parameter. A Region-level retention rule does not have any resource tags specified. It retains all deleted resources of the specified resource type in the Region in which the rule is created, even if the resources are not tagged.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceTags
-ResourceType <ResourceType>
The resource type to be retained by the retention rule. Currently, only EBS volumes, EBS snapshots, and EBS-backed AMIs are supported.
  • To retain EBS volumes, specify EBS_VOLUME.
  • To retain EBS snapshots, specify EBS_SNAPSHOT
  • To retain EBS-backed AMIs, specify EC2_IMAGE.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-RetentionPeriod_RetentionPeriodUnit <RetentionPeriodUnit>
The unit of time in which the retention period is measured. Currently, only DAYS is supported.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-RetentionPeriod_RetentionPeriodValue <Int32>
The period value for which the retention rule is to retain resources, measured in days. The supported retention periods are:
  • EBS volumes: 1 - 7 days
  • EBS snapshots and EBS-backed AMIs: 1 - 365 days
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.RecycleBin.Model.CreateRuleResponse). Specifying the name of a property of type Amazon.RecycleBin.Model.CreateRuleResponse 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)
-Tag <Tag[]>
Information about the tags to assign to the retention rule.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-UnlockDelay_UnlockDelayUnit <UnlockDelayUnit>
The unit of time in which to measure the unlock delay. Currently, the unlock delay can be measured only in days.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLockConfiguration_UnlockDelay_UnlockDelayUnit
-UnlockDelay_UnlockDelayValue <Int32>
The unlock delay period, measured in the unit specified for UnlockDelayUnit.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLockConfiguration_UnlockDelay_UnlockDelayValue

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.RecycleBin.Model.CreateRuleResponse
This cmdlet returns an Amazon.RecycleBin.Model.CreateRuleResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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