Creates a Recycle Bin retention rule. For more information, see Create Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
create-rule
--retention-period <value>
[--description <value>]
[--tags <value>]
--resource-type <value>
[--resource-tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--retention-period
(structure)
Information about the retention period for which the retention rule is to retain resources.
RetentionPeriodValue -> (integer)
The period value for which the retention rule is to retain resources. The period is measured using the unit specified for RetentionPeriodUnit .
RetentionPeriodUnit -> (string)
The unit of time in which the retention period is measured. Currently, only
DAYS
is supported.
Shorthand Syntax:
RetentionPeriodValue=integer,RetentionPeriodUnit=string
JSON Syntax:
{
"RetentionPeriodValue": integer,
"RetentionPeriodUnit": "DAYS"
}
--description
(string)
The retention rule description.
--tags
(list)
Information about the tags to assign to the retention rule.
(structure)
Information about the tags to assign to the retention rule.
Key -> (string)
The tag key.
Value -> (string)
The tag value.
Shorthand Syntax:
Key=string,Value=string ...
JSON Syntax:
[
{
"Key": "string",
"Value": "string"
}
...
]
--resource-type
(string)
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
EBS_SNAPSHOT
. To retain EBS-backed AMIs, specifyEC2_IMAGE
.Possible values:
EBS_SNAPSHOT
EC2_IMAGE
--resource-tags
(list)
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.
(structure)
Information about the resource tags used to identify resources that are retained by the retention rule.
ResourceTagKey -> (string)
The tag key.
ResourceTagValue -> (string)
The tag value.
Shorthand Syntax:
ResourceTagKey=string,ResourceTagValue=string ...
JSON Syntax:
[
{
"ResourceTagKey": "string",
"ResourceTagValue": "string"
}
...
]
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
See ‘aws help’ for descriptions of global parameters.
Identifier -> (string)
The unique ID of the retention rule.
RetentionPeriod -> (structure)
Information about the retention period for which the retention rule is to retain resources.
RetentionPeriodValue -> (integer)
The period value for which the retention rule is to retain resources. The period is measured using the unit specified for RetentionPeriodUnit .
RetentionPeriodUnit -> (string)
The unit of time in which the retention period is measured. Currently, only
DAYS
is supported.
Description -> (string)
The retention rule description.
Tags -> (list)
Information about the tags assigned to the retention rule.
(structure)
Information about the tags to assign to the retention rule.
Key -> (string)
The tag key.
Value -> (string)
The tag value.
ResourceType -> (string)
The resource type retained by the retention rule.
ResourceTags -> (list)
Information about the resource tags used to identify resources that are retained by the retention rule.
(structure)
Information about the resource tags used to identify resources that are retained by the retention rule.
ResourceTagKey -> (string)
The tag key.
ResourceTagValue -> (string)
The tag value.
Status -> (string)
The state of the retention rule. Only retention rules that are in the
available
state retain resources.