kcr_keyspaces_services_k8s_aws 3.20260112.164334

Kubernetes Custom Resource Bindings
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

// WARNING: generated by kopium - manual changes will be overwritten
// kopium command: kopium --docs --derive=Default --derive=PartialEq --smart-derive-elision --filename crd-catalog/aws-controllers-k8s/keyspaces-controller/keyspaces.services.k8s.aws/v1alpha1/keyspaces.yaml
// kopium version: 0.22.5

#[allow(unused_imports)]
mod prelude {
    pub use kube::CustomResource;
    pub use serde::{Serialize, Deserialize};
    pub use k8s_openapi::apimachinery::pkg::apis::meta::v1::Condition;
}
use self::prelude::*;

/// KeyspaceSpec defines the desired state of Keyspace.
#[derive(CustomResource, Serialize, Deserialize, Clone, Debug, Default, PartialEq)]
#[kube(group = "keyspaces.services.k8s.aws", version = "v1alpha1", kind = "Keyspace", plural = "keyspaces")]
#[kube(namespaced)]
#[kube(status = "KeyspaceStatus")]
#[kube(schema = "disabled")]
#[kube(derive="Default")]
#[kube(derive="PartialEq")]
pub struct KeyspaceSpec {
    /// The name of the keyspace to be created.
    /// 
    /// Regex Pattern: `^[a-zA-Z0-9][a-zA-Z0-9_]{0,47}$`
    #[serde(rename = "keyspaceName")]
    pub keyspace_name: String,
    /// The replication specification of the keyspace includes:
    /// 
    ///    * replicationStrategy - the required value is SINGLE_REGION or MULTI_REGION.
    /// 
    ///    * regionList - if the replicationStrategy is MULTI_REGION, the regionList
    ///    requires the current Region and at least one additional Amazon Web Services
    ///    Region where the keyspace is going to be replicated in. The maximum number
    ///    of supported replication Regions including the current Region is six.
    #[serde(default, skip_serializing_if = "Option::is_none", rename = "replicationSpecification")]
    pub replication_specification: Option<KeyspaceReplicationSpecification>,
    /// A list of key-value pair tags to be attached to the keyspace.
    /// 
    /// For more information, see Adding tags and labels to Amazon Keyspaces resources
    /// (<https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html)>
    /// in the Amazon Keyspaces Developer Guide.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub tags: Option<Vec<KeyspaceTags>>,
}

/// The replication specification of the keyspace includes:
/// 
///    * replicationStrategy - the required value is SINGLE_REGION or MULTI_REGION.
/// 
///    * regionList - if the replicationStrategy is MULTI_REGION, the regionList
///    requires the current Region and at least one additional Amazon Web Services
///    Region where the keyspace is going to be replicated in. The maximum number
///    of supported replication Regions including the current Region is six.
#[derive(Serialize, Deserialize, Clone, Debug, Default, PartialEq)]
pub struct KeyspaceReplicationSpecification {
    #[serde(default, skip_serializing_if = "Option::is_none", rename = "regionList")]
    pub region_list: Option<Vec<String>>,
    #[serde(default, skip_serializing_if = "Option::is_none", rename = "replicationStrategy")]
    pub replication_strategy: Option<String>,
}

/// Describes a tag. A tag is a key-value pair. You can add up to 50 tags to
/// a single Amazon Keyspaces resource.
/// 
/// Amazon Web Services-assigned tag names and values are automatically assigned
/// the aws: prefix, which the user cannot assign. Amazon Web Services-assigned
/// tag names do not count towards the tag limit of 50. User-assigned tag names
/// have the prefix user: in the Cost Allocation Report. You cannot backdate
/// the application of a tag.
/// 
/// For more information, see Adding tags and labels to Amazon Keyspaces resources
/// (<https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html)>
/// in the Amazon Keyspaces Developer Guide.
#[derive(Serialize, Deserialize, Clone, Debug, Default, PartialEq)]
pub struct KeyspaceTags {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub key: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub value: Option<String>,
}

/// KeyspaceStatus defines the observed state of Keyspace
#[derive(Serialize, Deserialize, Clone, Debug, Default, PartialEq)]
pub struct KeyspaceStatus {
    /// 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
    #[serde(default, skip_serializing_if = "Option::is_none", rename = "ackResourceMetadata")]
    pub ack_resource_metadata: Option<KeyspaceStatusAckResourceMetadata>,
    /// 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
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub conditions: Option<Vec<Condition>>,
    /// The unique identifier of the keyspace in the format of an Amazon Resource
    /// Name (ARN).
    /// 
    /// Regex Pattern: `^arn:(aws[a-zA-Z0-9-]*):cassandra:.+`
    #[serde(default, skip_serializing_if = "Option::is_none", rename = "resourceARN")]
    pub resource_arn: Option<String>,
}

/// 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
#[derive(Serialize, Deserialize, Clone, Debug, Default, PartialEq)]
pub struct KeyspaceStatusAckResourceMetadata {
    /// 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>
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub arn: Option<String>,
    /// OwnerAccountID is the AWS Account ID of the account that owns the
    /// backend AWS service API resource.
    #[serde(rename = "ownerAccountID")]
    pub owner_account_id: String,
    /// Region is the AWS region in which the resource exists or will exist.
    pub region: String,
}