DBSnapshot

rds.services.k8s.aws/v1alpha1

Type	Link
GoDoc	rds-controller/apis/v1alpha1#DBSnapshot

Metadata

Property	Value
Scope	Namespaced
Kind	`DBSnapshot`
ListKind	`DBSnapshotList`
Plural	`dbsnapshots`
Singular	`dbsnapshot`

Contains the details of an Amazon RDS DB snapshot.

This data type is used as a response element in the DescribeDBSnapshots action.

Spec

dbInstanceIdentifier: string
dbInstanceIdentifierRef: 
  from: 
    name: string
    namespace: string
dbSnapshotIdentifier: string
tags:
- key: string
  value: string

Field	Description
dbInstanceIdentifier Optional	string The identifier of the DB instance that you want to create the snapshot of. Constraints: * Must match the identifier of an existing DBInstance.
dbInstanceIdentifierRef 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
dbInstanceIdentifierRef.from Optional	object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)
dbInstanceIdentifierRef.from.name Optional	string
dbInstanceIdentifierRef.from.namespace Optional	string
dbSnapshotIdentifier Required	string The identifier for the DB snapshot. Constraints: * Can’t be null, empty, or blank * Must contain from 1 to 255 letters, numbers, or hyphens * First character must be a letter * Can’t end with a hyphen or contain two consecutive hyphens Example: my-snapshot-id
tags Optional	array
tags.[] Required	object Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
allocatedStorage: integer
availabilityZone: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
dbiResourceID: string
encrypted: boolean
engine: string
iamDatabaseAuthenticationEnabled: boolean
instanceCreateTime: string
iops: integer
kmsKeyID: string
licenseModel: string
masterUsername: string
originalSnapshotCreateTime: string
percentProgress: integer
port: integer
processorFeatures:
- name: string
  value: string
snapshotCreateTime: string
snapshotDatabaseTime: string
snapshotTarget: string
snapshotType: string
sourceDBSnapshotIdentifier: string
sourceRegion: string
status: string
storageThroughput: integer
storageType: string
tagList:
- key: string
  value: string
tdeCredentialARN: string
timezone: string
vpcID: string

Field	Description
ackResourceMetadata Optional	object 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
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.
allocatedStorage Optional	integer Specifies the allocated storage size in gibibytes (GiB).
availabilityZone Optional	string Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
conditions Optional	array 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
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
dbiResourceID Optional	string The identifier for the source DB instance, which can’t be changed and which is unique to an Amazon Web Services Region.
encrypted Optional	boolean Specifies whether the DB snapshot is encrypted.
engine Optional	string Specifies the name of the database engine.
iamDatabaseAuthenticationEnabled Optional	boolean True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
instanceCreateTime Optional	string Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.
iops Optional	integer Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
kmsKeyID Optional	string If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB 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 License model information for the restored DB instance.
masterUsername Optional	string Provides the master username for the DB snapshot.
originalSnapshotCreateTime Optional	string Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn’t change when the snapshot is copied.
percentProgress Optional	integer The percentage of the estimated data that has been transferred.
port Optional	integer Specifies the port that the database engine was listening on at the time of the snapshot.
processorFeatures Optional	array The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.
processorFeatures.[] Required	object Contains the processor features of a DB instance class.

To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.

You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:

CreateDBInstance
ModifyDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceFromS3
RestoreDBInstanceToPointInTime

You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.

In addition, you can use the following actions for DB instance class processor information:

DescribeDBInstances
DescribeDBSnapshots
DescribeValidDBInstanceModifications

If you call DescribeDBInstances, ProcessorFeature returns non-null values only if the following conditions are met:

You are accessing an Oracle DB instance.
Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.
The current number CPU cores and threads is set to a non-default value.

For more information, see Configuring the Processor of the DB Instance Class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor) in the Amazon RDS User Guide. || processorFeatures.[].name
Optional | string
| | processorFeatures.[].value
Optional | string
| | snapshotCreateTime
Optional | string
Specifies when the snapshot was taken in Coordinated Universal Time (UTC).
Changes for the copy when the snapshot is copied. | | snapshotDatabaseTime
Optional | string
The timestamp of the most recent transaction applied to the database that
you’re backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime
is the most recent transaction in the restored DB instance. In contrast,
originalSnapshotCreateTime specifies the system time that the snapshot completed.

If you back up a read replica, you can determine the replica lag by comparing
SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime
is two hours later than SnapshotDatabaseTime, then the replica lag is two
hours. | | snapshotTarget
Optional | string
Specifies where manual snapshots are stored: Amazon Web Services Outposts
or the Amazon Web Services Region. | | snapshotType
Optional | string
Provides the type of the DB snapshot. | | sourceDBSnapshotIdentifier
Optional | string
The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied
from. It only has a value in the case of a cross-account or cross-Region
copy. | | sourceRegion
Optional | string
The Amazon Web Services Region that the DB snapshot was created in or copied
from. | | status
Optional | string
Specifies the status of this DB snapshot. | | storageThroughput
Optional | integer
Specifies the storage throughput for the DB snapshot. | | storageType
Optional | string
Specifies the storage type associated with DB snapshot. | | 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
| | tdeCredentialARN
Optional | string
The ARN from the key store with which to associate the instance for TDE encryption. | | timezone
Optional | string
The time zone of the DB snapshot. In most cases, the Timezone element is
empty. Timezone content appears only for snapshots taken from Microsoft SQL
Server DB instances that were created with a time zone specified. | | vpcID
Optional | string
Provides the VPC ID associated with the DB snapshot. |

DBSnapshot

Metadata#

Spec#

Status#

Metadata

Spec

Status