Documentation
¶
Overview ¶
+k8s:deepcopy-gen=package Package v1alpha1 is the v1alpha1 version of the recyclebin.services.k8s.aws API. +groupName=recyclebin.services.k8s.aws
Index ¶
- Variables
- type ConflictExceptionReason
- type LockConfiguration
- type LockState
- type ResourceNotFoundExceptionReason
- type ResourceTag
- type ResourceType
- type RetentionPeriod
- type RetentionPeriodUnit
- type Rule
- type RuleList
- type RuleSpec
- type RuleStatus
- type RuleStatus_SDK
- type RuleSummary
- type ServiceQuotaExceededExceptionReason
- type Tag
- type UnlockDelay
- type UnlockDelayUnit
- type ValidationExceptionReason
Constants ¶
This section is empty.
Variables ¶
var ( // GroupVersion is the API Group Version used to register the objects GroupVersion = schema.GroupVersion{Group: "recyclebin.services.k8s.aws", Version: "v1alpha1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
This section is empty.
Types ¶
type ConflictExceptionReason ¶
type ConflictExceptionReason string
const (
ConflictExceptionReason_INVALID_RULE_STATE ConflictExceptionReason = "INVALID_RULE_STATE"
)
type LockConfiguration ¶
type LockConfiguration struct {
// 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.
UnlockDelay *UnlockDelay `json:"unlockDelay,omitempty"`
}
Information about a retention rule lock configuration.
func (*LockConfiguration) DeepCopy ¶
func (in *LockConfiguration) DeepCopy() *LockConfiguration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LockConfiguration.
func (*LockConfiguration) DeepCopyInto ¶
func (in *LockConfiguration) DeepCopyInto(out *LockConfiguration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ResourceNotFoundExceptionReason ¶
type ResourceNotFoundExceptionReason string
const (
ResourceNotFoundExceptionReason_RULE_NOT_FOUND ResourceNotFoundExceptionReason = "RULE_NOT_FOUND"
)
type ResourceTag ¶
type ResourceTag struct {
ResourceTagKey *string `json:"resourceTagKey,omitempty"`
ResourceTagValue *string `json:"resourceTagValue,omitempty"`
}
[Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention rule.
func (*ResourceTag) DeepCopy ¶
func (in *ResourceTag) DeepCopy() *ResourceTag
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceTag.
func (*ResourceTag) DeepCopyInto ¶
func (in *ResourceTag) DeepCopyInto(out *ResourceTag)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ResourceType ¶
type ResourceType string
const ( ResourceType_EBS_SNAPSHOT ResourceType = "EBS_SNAPSHOT" ResourceType_EC2_IMAGE ResourceType = "EC2_IMAGE" )
type RetentionPeriod ¶
type RetentionPeriod struct {
RetentionPeriodUnit *string `json:"retentionPeriodUnit,omitempty"`
RetentionPeriodValue *int64 `json:"retentionPeriodValue,omitempty"`
}
Information about the retention period for which the retention rule is to retain resources.
func (*RetentionPeriod) DeepCopy ¶
func (in *RetentionPeriod) DeepCopy() *RetentionPeriod
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RetentionPeriod.
func (*RetentionPeriod) DeepCopyInto ¶
func (in *RetentionPeriod) DeepCopyInto(out *RetentionPeriod)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RetentionPeriodUnit ¶
type RetentionPeriodUnit string
const (
RetentionPeriodUnit_DAYS RetentionPeriodUnit = "DAYS"
)
type Rule ¶
type Rule struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec RuleSpec `json:"spec,omitempty"`
Status RuleStatus `json:"status,omitempty"`
}
Rule is the Schema for the Rules API +kubebuilder:object:root=true +kubebuilder:subresource:status
func (*Rule) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Rule.
func (*Rule) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Rule) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type RuleList ¶
type RuleList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Rule `json:"items"`
}
RuleList contains a list of Rule +kubebuilder:object:root=true
func (*RuleList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RuleList.
func (*RuleList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RuleList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type RuleSpec ¶
type RuleSpec struct {
// The retention rule description.
//
// Regex Pattern: `^[\S ]{0,255}$`
Description *string `json:"description,omitempty"`
// Information about the retention rule lock configuration.
LockConfiguration *LockConfiguration `json:"lockConfiguration,omitempty"`
// [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.
ResourceTags []*ResourceTag `json:"resourceTags,omitempty"`
// 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.
// +kubebuilder:validation:Required
ResourceType *string `json:"resourceType"`
// Information about the retention period for which the retention rule is to
// retain resources.
// +kubebuilder:validation:Required
RetentionPeriod *RetentionPeriod `json:"retentionPeriod"`
// Information about the tags to assign to the retention rule.
Tags []*Tag `json:"tags,omitempty"`
}
RuleSpec defines the desired state of Rule.
func (*RuleSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RuleSpec.
func (*RuleSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RuleStatus ¶
type RuleStatus struct {
// All CRs managed by ACK have a common `Status.ACKResourceMetadata` member
// that is used to contain resource sync state, account ownership,
// constructed ARN for the resource
// +kubebuilder:validation:Optional
ACKResourceMetadata *ackv1alpha1.ResourceMetadata `json:"ackResourceMetadata"`
// All CRs managed by ACK have a common `Status.Conditions` member that
// contains a collection of `ackv1alpha1.Condition` objects that describe
// the various terminal states of the CR and its backend AWS service API
// resource
// +kubebuilder:validation:Optional
Conditions []*ackv1alpha1.Condition `json:"conditions"`
// The unique ID of the retention rule.
//
// Regex Pattern: `^[0-9a-zA-Z]{11}$`
// +kubebuilder:validation:Optional
Identifier *string `json:"identifier,omitempty"`
// [Region-level retention rules only] 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.
// +kubebuilder:validation:Optional
LockState *string `json:"lockState,omitempty"`
// The state of the retention rule. Only retention rules that are in the available
// state retain resources.
// +kubebuilder:validation:Optional
Status *string `json:"status,omitempty"`
}
RuleStatus defines the observed state of Rule
func (*RuleStatus) DeepCopy ¶
func (in *RuleStatus) DeepCopy() *RuleStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RuleStatus.
func (*RuleStatus) DeepCopyInto ¶
func (in *RuleStatus) DeepCopyInto(out *RuleStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RuleStatus_SDK ¶
type RuleStatus_SDK string
const ( RuleStatus_SDK_available RuleStatus_SDK = "available" RuleStatus_SDK_pending RuleStatus_SDK = "pending" )
type RuleSummary ¶
type RuleSummary struct {
Description *string `json:"description,omitempty"`
Identifier *string `json:"identifier,omitempty"`
LockState *string `json:"lockState,omitempty"`
// Information about the retention period for which the retention rule is to
// retain resources.
RetentionPeriod *RetentionPeriod `json:"retentionPeriod,omitempty"`
RuleARN *string `json:"ruleARN,omitempty"`
}
Information about a Recycle Bin retention rule.
func (*RuleSummary) DeepCopy ¶
func (in *RuleSummary) DeepCopy() *RuleSummary
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RuleSummary.
func (*RuleSummary) DeepCopyInto ¶
func (in *RuleSummary) DeepCopyInto(out *RuleSummary)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ServiceQuotaExceededExceptionReason ¶
type ServiceQuotaExceededExceptionReason string
const (
ServiceQuotaExceededExceptionReason_SERVICE_QUOTA_EXCEEDED ServiceQuotaExceededExceptionReason = "SERVICE_QUOTA_EXCEEDED"
)
type Tag ¶
Information about the tags to assign to the retention rule.
func (*Tag) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Tag.
func (*Tag) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type UnlockDelay ¶
type UnlockDelay struct {
UnlockDelayUnit *string `json:"unlockDelayUnit,omitempty"`
UnlockDelayValue *int64 `json:"unlockDelayValue,omitempty"`
}
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.
func (*UnlockDelay) DeepCopy ¶
func (in *UnlockDelay) DeepCopy() *UnlockDelay
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UnlockDelay.
func (*UnlockDelay) DeepCopyInto ¶
func (in *UnlockDelay) DeepCopyInto(out *UnlockDelay)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type UnlockDelayUnit ¶
type UnlockDelayUnit string
const (
UnlockDelayUnit_DAYS UnlockDelayUnit = "DAYS"
)
type ValidationExceptionReason ¶
type ValidationExceptionReason string
const ( ValidationExceptionReason_INVALID_PAGE_TOKEN ValidationExceptionReason = "INVALID_PAGE_TOKEN" ValidationExceptionReason_INVALID_PARAMETER_VALUE ValidationExceptionReason = "INVALID_PARAMETER_VALUE" )