DBInstance

documentdb.services.k8s.aws/v1alpha1

Type	Link
GoDoc	documentdb-controller/apis/v1alpha1#DBInstance

Metadata

Property	Value
Scope	Namespaced
Kind	`DBInstance`
ListKind	`DBInstanceList`
Plural	`dbinstances`
Singular	`dbinstance`

Detailed information about an instance.

Spec

autoMinorVersionUpgrade: boolean
availabilityZone: string
caCertificateIdentifier: string
copyTagsToSnapshot: boolean
dbClusterIdentifier: string
dbInstanceClass: string
dbInstanceIdentifier: string
engine: string
performanceInsightsEnabled: boolean
performanceInsightsKMSKeyID: string
performanceInsightsKMSKeyRef: 
  from: 
    name: string
preferredMaintenanceWindow: string
promotionTier: integer
tags:
- key: string
  value: string

Field	Description
autoMinorVersionUpgrade Optional	boolean This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set. Default: false
availabilityZone Optional	string The Amazon EC2 Availability Zone that the instance is created in. Default: A random, system-chosen Availability Zone in the endpoint’s Amazon Web Services Region. Example: us-east-1d
caCertificateIdentifier Optional	string The CA certificate identifier to use for the DB instance’s server certificate. For more information, see Updating Your Amazon DocumentDB TLS Certificates (https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) and Encrypting Data in Transit (https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) in the Amazon DocumentDB Developer Guide.
copyTagsToSnapshot Optional	boolean A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
dbClusterIdentifier Required	string The identifier of the cluster that the instance will belong to.
dbInstanceClass Required	string The compute and memory capacity of the instance; for example, db.r5.large.
dbInstanceIdentifier Required	string The instance identifier. This parameter is stored as a lowercase string. Constraints: * Must contain from 1 to 63 letters, numbers, or hyphens. * The first character must be a letter. * Cannot end with a hyphen or contain two consecutive hyphens. Example: mydbinstance
engine Required	string The name of the database engine to be used for this instance. Valid value: docdb
performanceInsightsEnabled Optional	boolean A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html).
performanceInsightsKMSKeyID Optional	string The KMS key identifier for encryption of Performance Insights data. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.
performanceInsightsKMSKeyRef 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
performanceInsightsKMSKeyRef.from Optional	object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)
performanceInsightsKMSKeyRef.from.name Optional	string
preferredMaintenanceWindow Optional	string The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window.
promotionTier Optional	integer A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance. Default: 1 Valid values: 0-15
tags Optional	array The tags to be assigned to the instance. You can assign up to 10 tags to an instance.
tags.[] Required	object Metadata assigned to an Amazon DocumentDB resource consisting of a key-value
pair.
tags.[].value Optional	string

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
backupRetentionPeriod: integer
certificateDetails: 
  cAIdentifier: string
  validTill: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
dbInstanceStatus: string
dbSubnetGroup: 
  dbSubnetGroupARN: string
  dbSubnetGroupDescription: string
  dbSubnetGroupName: string
  subnetGroupStatus: string
  subnets:
    subnetAvailabilityZone: 
      name: string
    subnetIdentifier: string
    subnetStatus: string
  vpcID: string
dbiResourceID: string
enabledCloudwatchLogsExports:
- string
endpoint: 
  address: string
  hostedZoneID: string
  port: integer
engineVersion: string
instanceCreateTime: string
kmsKeyID: string
latestRestorableTime: string
pendingModifiedValues: 
  allocatedStorage: integer
  backupRetentionPeriod: integer
  caCertificateIdentifier: string
  dbInstanceClass: string
  dbInstanceIdentifier: string
  dbSubnetGroupName: string
  engineVersion: string
  iops: integer
  licenseModel: string
  masterUserPassword: string
  multiAZ: boolean
  pendingCloudwatchLogsExports: 
    logTypesToDisable:
    - string
    logTypesToEnable:
    - string
  port: integer
  storageType: string
preferredBackupWindow: string
publiclyAccessible: boolean
statusInfos:
- message: string
  normal: boolean
  status: string
  statusType: string
storageEncrypted: boolean
vpcSecurityGroups:
- status: string
  vpcSecurityGroupID: 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. 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.
backupRetentionPeriod Optional	integer Specifies the number of days for which automatic snapshots are retained.
certificateDetails Optional	object The details of the DB instance’s server certificate.
certificateDetails.cAIdentifier Optional	string
certificateDetails.validTill Optional	string
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
dbInstanceStatus Optional	string Specifies the current state of this database.
dbSubnetGroup Optional	object Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.
dbSubnetGroup.dbSubnetGroupARN Optional	string
dbSubnetGroup.dbSubnetGroupDescription Optional	string
dbSubnetGroup.dbSubnetGroupName Optional	string
dbSubnetGroup.subnetGroupStatus Optional	string
dbSubnetGroup.subnets Optional	array
dbSubnetGroup.subnets.[] Required	object Detailed information about a subnet.
dbSubnetGroup.subnets.[].subnetAvailabilityZone.name Optional	string
dbSubnetGroup.subnets.[].subnetIdentifier Optional	string
dbSubnetGroup.subnets.[].subnetStatus Optional	string
dbSubnetGroup.vpcID Optional	string
dbiResourceID Optional	string The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.
enabledCloudwatchLogsExports Optional	array A list of log types that this instance is configured to export to CloudWatch Logs.
enabledCloudwatchLogsExports.[] Required	string
endpoint.address Optional	string
endpoint.hostedZoneID Optional	string
endpoint.port Optional	integer
engineVersion Optional	string Indicates the database engine version.
instanceCreateTime Optional	string Provides the date and time that the instance was created.
kmsKeyID Optional	string If StorageEncrypted is true, the KMS key identifier for the encrypted instance.
latestRestorableTime Optional	string Specifies the latest time to which a database can be restored with point-in-time restore.
pendingModifiedValues Optional	object Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.
pendingModifiedValues.allocatedStorage Optional	integer
pendingModifiedValues.backupRetentionPeriod Optional	integer
pendingModifiedValues.caCertificateIdentifier Optional	string
pendingModifiedValues.dbInstanceClass Optional	string
pendingModifiedValues.dbInstanceIdentifier Optional	string
pendingModifiedValues.dbSubnetGroupName Optional	string
pendingModifiedValues.engineVersion Optional	string
pendingModifiedValues.iops Optional	integer
pendingModifiedValues.licenseModel Optional	string
pendingModifiedValues.masterUserPassword Optional	string
pendingModifiedValues.multiAZ Optional	boolean
pendingModifiedValues.pendingCloudwatchLogsExports Optional	object A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.
pendingModifiedValues.pendingCloudwatchLogsExports.logTypesToDisable Optional	array
pendingModifiedValues.pendingCloudwatchLogsExports.logTypesToDisable.[] Required	string
pendingModifiedValues.pendingCloudwatchLogsExports.logTypesToEnable.[] Required	string
pendingModifiedValues.storageType Optional	string
preferredBackupWindow Optional	string Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
publiclyAccessible Optional	boolean Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.
statusInfos Optional	array The status of a read replica. If the instance is not a read replica, this is blank.
statusInfos.[] Required	object Provides a list of status information for an instance.
statusInfos.[].normal Optional	boolean
statusInfos.[].status Optional	string
statusInfos.[].statusType Optional	string
storageEncrypted Optional	boolean Specifies whether or not the instance is encrypted.
vpcSecurityGroups Optional	array Provides a list of VPC security group elements that the instance belongs to.
vpcSecurityGroups.[] Required	object Used as a response element for queries on virtual private cloud (VPC) security
group membership.
vpcSecurityGroups.[].vpcSecurityGroupID Optional	string

DBInstance

Metadata#

Spec#

Status#

Metadata

Spec

Status