DBSubnetGroup

documentdb.services.k8s.aws/v1alpha1

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

Metadata

Property	Value
Scope	Namespaced
Kind	`DBSubnetGroup`
ListKind	`DBSubnetGroupList`
Plural	`dbsubnetgroups`
Singular	`dbsubnetgroup`

Detailed information about a subnet group.

Spec

description: string
name: string
subnetIDs:
- string
subnetRefs:
  from: 
    name: string
    namespace: string
tags:
- key: string
  value: string

Field	Description
description Required	string The description for the subnet group.
name Required	string The name for the subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default. Example: mySubnetgroup
subnetIDs Optional	array The Amazon EC2 subnet IDs for the subnet group.
subnetIDs.[] Required	string
subnetRefs.[] Required	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 || **subnetRefs.[].from**<br/>Optional | **object**<br/>AWSResourceReference provides all the values necessary to reference another<br/>k8s resource for finding the identifier(Id/ARN/Name) |

| subnetRefs.[].from.name
Optional | string
| | subnetRefs.[].from.namespace
Optional | string
| | tags
Optional | array
The tags to be assigned to the subnet group. | | tags.[]
Required | object
Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair. || tags.[].key
Optional | string
| | tags.[].value
Optional | string
|

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
subnetGroupStatus: string
subnets:
  subnetAvailabilityZone: 
    name: string
  subnetIdentifier: string
  subnetStatus: 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.
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
subnetGroupStatus Optional	string Provides the status of the subnet group.
subnets Optional	array Detailed information about one or more subnets within a subnet group.
subnets.[] Required	object Detailed information about a subnet.
subnets.[].subnetAvailabilityZone.name Optional	string
subnets.[].subnetIdentifier Optional	string
subnets.[].subnetStatus Optional	string
vpcID Optional	string Provides the virtual private cloud (VPC) ID of the subnet group.

DBSubnetGroup

Metadata#

Spec#

Status#

Metadata

Spec

Status