DBClusterSnapshot
rds.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | rds-controller/apis/v1alpha1#DBClusterSnapshot |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | DBClusterSnapshot |
| ListKind | DBClusterSnapshotList |
| Plural | dbclustersnapshots |
| Singular | dbclustersnapshot |
Contains the details for an Amazon RDS DB cluster snapshot
This data type is used as a response element in the DescribeDBClusterSnapshots action.
Spec
dbClusterIdentifier: string
dbClusterIdentifierRef:
from:
name: string
namespace: string
dbClusterSnapshotIdentifier: string
tags:
- key: string
value: string
| Field | Description |
|---|---|
| dbClusterIdentifier Optional | string The identifier of the DB cluster to create a snapshot for. This parameter isn’t case-sensitive. Constraints: * Must match the identifier of an existing DBCluster. Example: my-cluster1 |
| dbClusterIdentifierRef Optional | object AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using ‘from’ field Ex: APIIDRef: from: name: my-api |
| dbClusterIdentifierRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| dbClusterIdentifierRef.from.name Optional | string |
| dbClusterIdentifierRef.from.namespace Optional | string |
| dbClusterSnapshotIdentifier Required | string The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string. Constraints: * Must contain from 1 to 63 letters, numbers, or hyphens. * First character must be a letter. * Can’t end with a hyphen or contain two consecutive hyphens. Example: my-cluster1-snapshot1 |
| tags Optional | array The tags to be assigned to the DB cluster snapshot. |
| tags.[] Required | object Metadata assigned to an Amazon RDS resource consisting of a key-value pair. |
For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)
in the Amazon RDS User Guide. || tags.[].key
Optional | string
|
| tags.[].value
Optional | string
|
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
allocatedStorage: integer
availabilityZones:
- string
clusterCreateTime: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
dbSystemID: string
engine: string
engineMode: string
engineVersion: string
iamDatabaseAuthenticationEnabled: boolean
kmsKeyID: string
licenseModel: string
masterUsername: string
percentProgress: integer
port: integer
snapshotCreateTime: string
snapshotType: string
sourceDBClusterSnapshotARN: string
status: string
storageEncrypted: boolean
tagList:
- key: string
value: string
vpcID: 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. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse 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. |
| allocatedStorage Optional | integer Specifies the allocated storage size in gibibytes (GiB). |
| availabilityZones Optional | array Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored. |
| availabilityZones.[] Required | string |
| 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 |
| dbSystemID Optional | string Reserved for future use. |
| engine Optional | string Specifies the name of the database engine for this DB cluster snapshot. |
| engineMode Optional | string Provides the engine mode of the database engine for this DB cluster snapshot. |
| engineVersion Optional | string Provides the version of the database engine for this DB cluster snapshot. |
| iamDatabaseAuthenticationEnabled Optional | boolean True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false. |
| kmsKeyID Optional | string If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. |
| licenseModel Optional | string Provides the license model information for this DB cluster snapshot. |
| masterUsername Optional | string Provides the master username for this DB cluster snapshot. |
| percentProgress Optional | integer Specifies the percentage of the estimated data that has been transferred. |
| port Optional | integer Specifies the port that the DB cluster was listening on at the time of the snapshot. |
| snapshotCreateTime Optional | string Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC). |
| snapshotType Optional | string Provides the type of the DB cluster snapshot. |
| sourceDBClusterSnapshotARN Optional | string If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value. |
| status Optional | string Specifies the status of this DB cluster snapshot. Valid statuses are the following: * available * copying * creating |
| storageEncrypted Optional | boolean Specifies whether the DB cluster snapshot is encrypted. |
| tagList Optional | array |
| tagList.[] Required | object Metadata assigned to an Amazon RDS resource consisting of a key-value pair. |
For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)
in the Amazon RDS User Guide. || tagList.[].key
Optional | string
|
| tagList.[].value
Optional | string
|
| vpcID
Optional | string
Provides the VPC ID associated with the DB cluster snapshot. |