DBSnapshotList (rds.services.k8s.aws/v1alpha1)

Type: object

DBSnapshotList is a list of DBSnapshot

Type: string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

Type: array

List of dbsnapshots. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

No Additional Items

Each item of this array must be:

aws.k8s.services.rds.v1alpha1.DBSnapshot

Type: object

DBSnapshot is the Schema for the DBSnapshots API

Type: string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

Type: string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Type: object

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: object

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations

Each additional property must conform to the following schema

Type: string

io.k8s.apimachinery.pkg.apis.meta.v1.Time

Type: string

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: integerFormat: int64

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

io.k8s.apimachinery.pkg.apis.meta.v1.Time

Type: string

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Same definition as creationTimestamp

Type: array of string

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

No Additional Items

Each item of this array must be:

Type: string

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

Type: integerFormat: int64

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

Type: object

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels

Each additional property must conform to the following schema

Type: string

Type: array

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

No Additional Items

Each item of this array must be:

io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Type: object

ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.

Type: string

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

Type: string

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

io.k8s.apimachinery.pkg.apis.meta.v1.FieldsV1

Type: object

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

Type: string

Manager is an identifier of the workflow managing these fields.

Type: string

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

Type: string

Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.

io.k8s.apimachinery.pkg.apis.meta.v1.Time

Type: string

Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

Same definition as creationTimestamp

Type: string

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

Type: string

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

Type: array

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

No Additional Items

Each item of this array must be:

io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Type: object

OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.

Type: boolean

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

Type: string

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Type: string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

Type: string

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Type: string

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

Type: string

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Type: object

DBSnapshotSpec defines the desired state of DBSnapshot.

Contains the details of an Amazon RDS DB snapshot.

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

Type: string

The identifier of the DB instance that you want to create the snapshot of.

Constraints:

  • Must match the identifier of an existing DBInstance.

Type: 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

Type: object

AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name)

Type: 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

Type: array of object
No Additional Items

Each item of this array must be:

Type: 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/USERTagging.html)
in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources
(https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER
Tagging.html)
in the Amazon Aurora User Guide.

Type: object

DBSnapshotStatus defines the observed state of DBSnapshot

Type: 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

Type: 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

Type: string

OwnerAccountID is the AWS Account ID of the account that owns the
backend AWS service API resource.

Type: string

Partition is the AWS partition in which the resource exists or will exist

Type: string

Region is the AWS region in which the resource exists or will exist.

Type: integerFormat: int64

Specifies the allocated storage size in gibibytes (GiB).

Type: string

Specifies the name of the Availability Zone the DB instance was located in
at the time of the DB snapshot.

Type: array of object

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

No Additional Items

Each item of this array must be:

Type: 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

Type: stringFormat: date-time

Last time the condition transitioned from one status to another.

Type: string

A human readable message indicating details about the transition.

Type: string

The reason for the condition's last transition.

Type: string

Status of the condition, one of True, False, Unknown.

Type: string

Type is the type of the Condition

Type: string

The identifier for the source DB instance, which can't be changed and which
is unique to an Amazon Web Services Region.

Type: boolean

Indicates whether the DB snapshot is encrypted.

Type: string

Specifies the name of the database engine.

Type: boolean

Indicates whether mapping of Amazon Web Services Identity and Access Management
(IAM) accounts to database accounts is enabled.

Type: stringFormat: date-time

Specifies the time in Coordinated Universal Time (UTC) when the DB instance,
from which the snapshot was taken, was created.

Type: integerFormat: int64

Specifies the Provisioned IOPS (I/O operations per second) value of the DB
instance at the time of the snapshot.

Type: 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.

Type: string

License model information for the restored DB instance.

Type: string

Provides the master username for the DB snapshot.

Type: stringFormat: date-time

Specifies the time of the CreateDBSnapshot operation in Coordinated Universal
Time (UTC). Doesn't change when the snapshot is copied.

Type: integerFormat: int64

The percentage of the estimated data that has been transferred.

Type: integerFormat: int64

Specifies the port that the database engine was listening on at the time
of the snapshot.

Type: array of object

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.

No Additional Items

Each item of this array must be:

Type: 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 for a DB instance class
in RDS for Oracle (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor)
in the Amazon RDS User Guide.

Type: stringFormat: date-time

Specifies when the snapshot was taken in Coordinated Universal Time (UTC).
Changes for the copy when the snapshot is copied.

Type: stringFormat: date-time

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.

Type: string

Specifies where manual snapshots are stored: Amazon Web Services Outposts
or the Amazon Web Services Region.

Type: string

Provides the type of the DB snapshot.

Type: 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.

Type: string

The Amazon Web Services Region that the DB snapshot was created in or copied
from.

Type: string

Specifies the status of this DB snapshot.

Type: integerFormat: int64

Specifies the storage throughput for the DB snapshot.

Type: string

Specifies the storage type associated with DB snapshot.

Type: array of object
No Additional Items

Each item of this array must be:

Type: 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/USERTagging.html)
in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources
(https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER
Tagging.html)
in the Amazon Aurora User Guide.

Type: string

The ARN from the key store with which to associate the instance for TDE encryption.

Type: 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.

Type: string

Provides the VPC ID associated with the DB snapshot.

Type: string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta

Type: object

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Type: string

continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.

Type: integerFormat: int64

remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.

Type: string

String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency