CacheSubnetGroup

elasticache.services.k8s.aws/v1alpha1

TypeLink
GoDocelasticache-controller/apis/v1alpha1#CacheSubnetGroup

Metadata

PropertyValue
ScopeNamespaced
KindCacheSubnetGroup
ListKindCacheSubnetGroupList
Pluralcachesubnetgroups
Singularcachesubnetgroup

Represents the output of one of the following operations:

  • CreateCacheSubnetGroup

  • ModifyCacheSubnetGroup

Spec

cacheSubnetGroupDescription: string
cacheSubnetGroupName: string
subnetIDs:
- string
subnetRefs:
  from: 
    name: string
tags:
- key: string
  value: string
FieldDescription
cacheSubnetGroupDescription
Required
string
A description for the cache subnet group.
cacheSubnetGroupName
Required
string
A name for the cache subnet group. This value is stored as a lowercase string.


Constraints: Must contain no more than 255 alphanumeric characters or hyphens.


Example: mysubnetgroup
subnetIDs
Optional
array
A list of VPC subnet IDs for the cache 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
| | 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 ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. A tag with a null Value is permitted. || 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
events:
- date: string
  message: string
  sourceIdentifier: string
  sourceType: string
subnets:
  subnetAvailabilityZone: 
    name: string
  subnetIdentifier: string
  subnetOutpost: 
    subnetOutpostARN: 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
events
Optional
array
A list of events. Each element in the list contains detailed information
about one event.
events.[]
Required
object
Represents a single occurrence of something interesting within the system.
Some examples of events are creating a cluster, adding or removing a cache
node, or rebooting a node.
events.[].message
Optional
string
events.[].sourceIdentifier
Optional
string
events.[].sourceType
Optional
string
subnets
Optional
array
A list of subnets associated with the cache 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
ElastiCache.
subnets.[].subnetAvailabilityZone.name
Optional
string
subnets.[].subnetIdentifier
Optional
string
subnets.[].subnetOutpost
Optional
object
The ID of the outpost subnet.
subnets.[].subnetOutpost.subnetOutpostARN
Optional
string
vpcID
Optional
string
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet
group.