DBSubnetGroup
rds.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | rds-controller/apis/v1alpha1#DBSubnetGroup |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | DBSubnetGroup |
| ListKind | DBSubnetGroupList |
| Plural | dbsubnetgroups |
| Singular | dbsubnetgroup |
Contains the details of an Amazon RDS DB subnet group. This data type is used as a response element in the DescribeDBSubnetGroups action.
Spec
description: string
name: string
subnetIDs:
- string
subnetRefs:
from:
name: string
tags:
- key: string
value: string
| Field | Description |
|---|---|
| description Required | string The description for the DB subnet group. |
| name Required | string The name for the DB 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. * First character must be a letter. Example: mydbsubnetgroup |
| subnetIDs Optional | array The EC2 Subnet IDs for the DB 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.name Optional | string |
| tags Optional | array Tags to assign to the DB subnet group. |
| 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.[].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
subnetOutpost:
arn: string
subnetStatus: string
supportedNetworkTypes:
- 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. 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. |
| 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 DB subnet group. |
| subnets Optional | array Contains a list of Subnet elements. |
| subnets.[] Required | object This data type is used as a response element for the DescribeDBSubnetGroups operation. |
| subnets.[].subnetAvailabilityZone.name Optional | string |
| subnets.[].subnetIdentifier Optional | string |
| subnets.[].subnetOutpost Optional | object A data type that represents an Outpost. For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in the Amazon RDS User Guide. |
| subnets.[].subnetOutpost.arn Optional | string |
| subnets.[].subnetStatus Optional | string |
| supportedNetworkTypes Optional | array The network type of the DB subnet group. Valid values: * IPV4 * DUAL A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL). For more information, see Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the Amazon RDS User Guide. |
| supportedNetworkTypes.[] Required | string |