SubnetGroup

memorydb.services.k8s.aws/v1alpha1

TypeLink
GoDocmemorydb-controller/apis/v1alpha1#SubnetGroup

Metadata

PropertyValue
ScopeNamespaced
KindSubnetGroup
ListKindSubnetGroupList
Pluralsubnetgroups
Singularsubnetgroup

Represents the output of one of the following operations:

  • CreateSubnetGroup
  • UpdateSubnetGroup A subnet group is a collection of subnets (typically private) that you can designate for your clusters running in an Amazon Virtual Private Cloud (VPC) environment.

Spec

description: string
name: string
subnetIDs:
- string
subnetRefs:
  from: 
    name: string
tags:
- key: string
  value: string
FieldDescription
description
Optional
string
A description for the subnet group.
name
Required
string
The name of the subnet group.
subnetIDs
Optional
array
A list of VPC 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.name
Optional
string
tags
Optional
array
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
tags.[]
Required
object
A tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources (https://docs.aws.amazon.com/MemoryDB/latest/devguide/tagging-resources.html)
tags.[].value
Optional
string

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
subnets:
  availabilityZone: 
    name: string
  identifier: string
vpcID: string
FieldDescription
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
subnets
Optional
array
A list of subnets associated with the subnet group.
subnets.[]
Required
object
Represents the subnet associated with a cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with MemoryDB.
subnets.[].availabilityZone.name
Optional
string
subnets.[].identifier
Optional
string
vpcID
Optional
string
The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.