Rule
recyclebin.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | recyclebin-controller/apis/v1alpha1#Rule |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | Rule |
| ListKind | RuleList |
| Plural | rules |
| Singular | rule |
Spec
description: string
lockConfiguration:
unlockDelay:
unlockDelayUnit: string
unlockDelayValue: integer
resourceTags:
- resourceTagKey: string
resourceTagValue: string
resourceType: string
retentionPeriod:
retentionPeriodUnit: string
retentionPeriodValue: integer
tags:
- key: string
value: string
| Field | Description |
|---|---|
| description Optional | string The retention rule description. |
| lockConfiguration Optional | object Information about the retention rule lock configuration. |
| lockConfiguration.unlockDelay Optional | object Information about the retention rule unlock delay. The unlock delay is the period after which a retention rule can be modified or edited after it has been unlocked by a user with the required permissions. The retention rule can’t be modified or deleted during the unlock delay. |
| lockConfiguration.unlockDelay.unlockDelayUnit Optional | string |
| lockConfiguration.unlockDelay.unlockDelayValue Optional | integer |
| resourceTags Optional | array 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. |
| resourceTags.[] Required | object Information about the resource tags used to identify resources that are retained |
| by the retention rule. | |
| resourceTags.[].resourceTagValue Optional | string |
| resourceType Required | 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, specify EC2_IMAGE. |
| retentionPeriod Required | object Information about the retention period for which the retention rule is to retain resources. |
| retentionPeriod.retentionPeriodUnit Optional | string |
| retentionPeriod.retentionPeriodValue Optional | integer |
| tags Optional | array Information about the tags to assign to the retention rule. |
| tags.[] Required | object Information about the tags to assign to the retention rule. |
| tags.[].value Optional | string |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
identifier: string
lockState: string
status: string
| Field | Description |
|---|---|
| ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata memberthat is used to contain resource sync state, account ownership, constructed ARN for the resource |
| ackResourceMetadata.arn Optional | string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. https://github.com/aws/aws-controllers-k8s/issues/270 |
| ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
| ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
| conditions Optional | array All CRS managed by ACK have a common Status.Conditions member thatcontains a collection of ackv1alpha1.Condition objects that describethe various terminal states of the CR and its backend AWS service API resource |
| conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service |
| controllers to indicate terminal states of the CR and its backend AWS | |
| service API resource | |
| conditions.[].message Optional | string A human readable message indicating details about the transition. |
| conditions.[].reason Optional | string The reason for the condition’s last transition. |
| conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
| conditions.[].type Optional | string Type is the type of the Condition |
| identifier Optional | string The unique ID of the retention rule. |
| lockState Optional | string The lock state for the retention rule. * locked - The retention rule is locked and can’t be modified or deleted. * pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired. * unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions. * null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null. |
| status Optional | string The state of the retention rule. Only retention rules that are in the available state retain resources. |