Recycle Bin
1 resource kind. Generated from the operator's CRD schemas.
API Group:
aws.konfig.io/v1alpha1
RbinRule # CLOUD CONTROL · AWS::Rbin::Rule
RbinRule manages AWS::Rbin::Rule through the AWS Cloud Control API.
kubectl get rbinrules · example on GitHub
Example
# RbinRule — Recycle Bin
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/rbin.html#rbinrule
apiVersion: aws.konfig.io/v1alpha1
kind: RbinRule
metadata:
name: example-rbinrule
namespace: default
spec:
description: Managed by konfig-konector
excludeResourceTags:
- resourceTagKey: example
resourceTagValue: example
lockConfiguration:
unlockDelayUnit: DAYS
unlockDelayValue: 7
providerRef:
name: example-rbinrule
region: us-east-1
resourceTags:
- resourceTagKey: example
resourceTagValue: example
resourceType: EBS_SNAPSHOT
retentionPeriod:
retentionPeriodUnit: DAYS
retentionPeriodValue: 1
status: example
tags:
- key: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
description | string | — | The description of the retention rule. |
excludeResourceTags | array<object> | — | Information about the exclude resource tags used to identify resources that are excluded by the retention rule. |
excludeResourceTags[].resourceTagKey | string | yes | The tag key of the resource. |
excludeResourceTags[].resourceTagValue | string | yes | The tag value of the resource |
lockConfiguration | object | — | Information about the retention rule lock configuration. |
lockConfiguration.unlockDelayUnit | enum | — | The unit of time in which to measure the unlock delay. Allowed: DAYS |
lockConfiguration.unlockDelayValue | integer | — | The unlock delay period, measured in the unit specified for UnlockDelayUnit. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
resourceTags | array<object> | — | Information about the resource tags used to identify resources that are retained by the retention rule. |
resourceTags[].resourceTagKey | string | yes | The tag key of the resource. |
resourceTags[].resourceTagValue | string | yes | The tag value of the resource |
resourceType | enum | yes | The resource type retained by the retention rule. Allowed: EBS_SNAPSHOT, EC2_IMAGE, EBS_VOLUME |
retentionPeriod | object | yes | Information about the retention period for which the retention rule is to retain resources. |
retentionPeriod.retentionPeriodUnit | enum | yes | The retention period unit of the rule Allowed: DAYS |
retentionPeriod.retentionPeriodValue | integer | yes | The retention period value of the rule. |
status | string | — | The state of the retention rule. |
tags | array<object> | — | Information about the tags assigned to the retention rule. |
tags[].key | string | yes | |
tags[].value | string | yes |
Status
| Field | Type | Required | Description |
|---|---|---|---|
arn | string | — | Rule Arn is unique for each rule. |
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
lockState | string | — | The lock state for the retention rule. |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |