AWS.Tools.RecycleBin.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.RecycleBin</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.RBIN.AddRBINResourceTagCmdlet"> <summary> Assigns tags to the specified retention rule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.AddRBINResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the retention rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.AddRBINResourceTagCmdlet.Tag"> <summary> <para> <para>Information about the tags to assign to the retention rule.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.AddRBINResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.RecycleBin.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.AddRBINResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RBIN.GetRBINResourceTagCmdlet"> <summary> Lists the tags assigned to a retention rule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.GetRBINResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the retention rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.GetRBINResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.RecycleBin.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.RecycleBin.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RBIN.GetRBINRuleCmdlet"> <summary> Gets information about a Recycle Bin retention rule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.GetRBINRuleCmdlet.Identifier"> <summary> <para> <para>The unique ID of the retention rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.GetRBINRuleCmdlet.Select"> <summary> 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.GetRuleResponse). Specifying the name of a property of type Amazon.RecycleBin.Model.GetRuleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RBIN.GetRBINRuleListCmdlet"> <summary> Lists the Recycle Bin retention rules in the Region.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. This cmdlet didn't autopaginate in V4, auto-pagination support was added in V5. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.GetRBINRuleListCmdlet.ExcludeResourceTag"> <summary> <para> <para>[Region-level retention rules only] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.GetRBINRuleListCmdlet.LockState"> <summary> <para> <para>The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.GetRBINRuleListCmdlet.ResourceTag"> <summary> <para> <para>[Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention rule.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.GetRBINRuleListCmdlet.ResourceType"> <summary> <para> <para>The resource type retained by the retention rule. Only retention rules that retain the specified resource type are listed. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To list retention rules that retain snapshots, specify <c>EBS_SNAPSHOT</c>. To list retention rules that retain EBS-backed AMIs, specify <c>EC2_IMAGE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.GetRBINRuleListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <c>NextToken</c> value.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.GetRBINRuleListCmdlet.NextToken"> <summary> <para> <para>The token for the next page of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.GetRBINRuleListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Rules'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.RecycleBin.Model.ListRulesResponse). Specifying the name of a property of type Amazon.RecycleBin.Model.ListRulesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.GetRBINRuleListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. This cmdlet didn't autopaginate in V4. To preserve the V4 autopagination behavior for all cmdlets, run Set-AWSAutoIterationMode -IterationMode v4. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RBIN.LockRBINRuleCmdlet"> <summary> Locks a Region-level retention rule. A locked retention rule can't be modified or deleted. <note><para> You can't lock tag-level retention rules, or Region-level retention rules that have exclusion tags. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.LockRBINRuleCmdlet.Identifier"> <summary> <para> <para>The unique ID of the retention rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.LockRBINRuleCmdlet.UnlockDelay_UnlockDelayUnit"> <summary> <para> <para>The unit of time in which to measure the unlock delay. Currently, the unlock delay can be measure only in days.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.LockRBINRuleCmdlet.UnlockDelay_UnlockDelayValue"> <summary> <para> <para>The unlock delay period, measured in the unit specified for <b> UnlockDelayUnit</b>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.LockRBINRuleCmdlet.Select"> <summary> 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.LockRuleResponse). Specifying the name of a property of type Amazon.RecycleBin.Model.LockRuleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.LockRBINRuleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RBIN.NewRBINRuleCmdlet"> <summary> Creates a Recycle Bin retention rule. You can create two types of retention rules: <ul><li><para><b>Tag-level retention rules</b> - 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. </para></li><li><para><b>Region-level retention rules</b> - 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. </para></li></ul><para> For more information, see <a href="https://docs.aws.amazon.com/ebs/latest/userguide/recycle-bin.html"> Create Recycle Bin retention rules</a> in the <i>Amazon EBS User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.NewRBINRuleCmdlet.Description"> <summary> <para> <para>The retention rule description.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.NewRBINRuleCmdlet.ExcludeResourceTag"> <summary> <para> <para>[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.</para><para>You can't specify exclusion tags for tag-level retention rules.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.NewRBINRuleCmdlet.ResourceTag"> <summary> <para> <para>[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.</para><para>You can add the same tag key and value pair to a maximum or five retention rules.</para><para>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.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.NewRBINRuleCmdlet.ResourceType"> <summary> <para> <para>The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To retain snapshots, specify <c>EBS_SNAPSHOT</c>. To retain EBS-backed AMIs, specify <c>EC2_IMAGE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.NewRBINRuleCmdlet.RetentionPeriod_RetentionPeriodUnit"> <summary> <para> <para>The unit of time in which the retention period is measured. Currently, only <c>DAYS</c> is supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.NewRBINRuleCmdlet.RetentionPeriod_RetentionPeriodValue"> <summary> <para> <para>The period value for which the retention rule is to retain resources. The period is measured using the unit specified for <b>RetentionPeriodUnit</b>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.NewRBINRuleCmdlet.Tag"> <summary> <para> <para>Information about the tags to assign to the retention rule.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.NewRBINRuleCmdlet.UnlockDelay_UnlockDelayUnit"> <summary> <para> <para>The unit of time in which to measure the unlock delay. Currently, the unlock delay can be measure only in days.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.NewRBINRuleCmdlet.UnlockDelay_UnlockDelayValue"> <summary> <para> <para>The unlock delay period, measured in the unit specified for <b> UnlockDelayUnit</b>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.NewRBINRuleCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.NewRBINRuleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RBIN.RemoveRBINResourceTagCmdlet"> <summary> Unassigns a tag from a retention rule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.RemoveRBINResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the retention rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.RemoveRBINResourceTagCmdlet.TagKey"> <summary> <para> <para>The tag keys of the tags to unassign. All tags that have the specified tag key are unassigned.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.RemoveRBINResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.RecycleBin.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.RemoveRBINResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RBIN.RemoveRBINRuleCmdlet"> <summary> Deletes a Recycle Bin retention rule. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin-working-with-rules.html#recycle-bin-delete-rule"> Delete Recycle Bin retention rules</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.RemoveRBINRuleCmdlet.Identifier"> <summary> <para> <para>The unique ID of the retention rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.RemoveRBINRuleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.RecycleBin.Model.DeleteRuleResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.RemoveRBINRuleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RBIN.UnlockRBINRuleCmdlet"> <summary> Unlocks a retention rule. After a retention rule is unlocked, it can be modified or deleted only after the unlock delay period expires. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.UnlockRBINRuleCmdlet.Identifier"> <summary> <para> <para>The unique ID of the retention rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.UnlockRBINRuleCmdlet.Select"> <summary> 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.UnlockRuleResponse). Specifying the name of a property of type Amazon.RecycleBin.Model.UnlockRuleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.UnlockRBINRuleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RBIN.UpdateRBINRuleCmdlet"> <summary> Updates an existing Recycle Bin retention rule. You can update a retention rule's description, resource tags, and retention period at any time after creation. You can't update a retention rule's resource type after creation. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin-working-with-rules.html#recycle-bin-update-rule"> Update Recycle Bin retention rules</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.UpdateRBINRuleCmdlet.Description"> <summary> <para> <para>The retention rule description.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.UpdateRBINRuleCmdlet.ExcludeResourceTag"> <summary> <para> <para>[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.</para><para>You can't specify exclusion tags for tag-level retention rules.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.UpdateRBINRuleCmdlet.Identifier"> <summary> <para> <para>The unique ID of the retention rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.UpdateRBINRuleCmdlet.ResourceTag"> <summary> <para> <para>[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.</para><para>You can add the same tag key and value pair to a maximum or five retention rules.</para><para>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.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.UpdateRBINRuleCmdlet.ResourceType"> <summary> <para> <note><para>This parameter is currently not supported. You can't update a retention rule's resource type after creation.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.UpdateRBINRuleCmdlet.RetentionPeriod_RetentionPeriodUnit"> <summary> <para> <para>The unit of time in which the retention period is measured. Currently, only <c>DAYS</c> is supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.UpdateRBINRuleCmdlet.RetentionPeriod_RetentionPeriodValue"> <summary> <para> <para>The period value for which the retention rule is to retain resources. The period is measured using the unit specified for <b>RetentionPeriodUnit</b>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.UpdateRBINRuleCmdlet.Select"> <summary> 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.UpdateRuleResponse). Specifying the name of a property of type Amazon.RecycleBin.Model.UpdateRuleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.UpdateRBINRuleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |