ManagedCacheAddOnConfigResponse

object

Configuration for managed cache add-on.

* Additional properties are NOT allowed.
kindstringrequired

Type of add-on configuration.

Allowed values:managed-cache.v0

capacity_configOne Of
objectrequired

Configuration for managed cache capacity and performance characteristics.

TieredCapacityConfigobject

Capacity tiers with pre-configured size and performance characteristics.

Example:{"kind":"tiered","tier":"small"}

* Additional properties are NOT allowed.
Show Child Parameters
data_plane_groupsarray[object]required

Object that describes a data-plane group where managed cache add-on is deployed.

* Additional properties are NOT allowed.
Show Child Parameters
state_metadataobjectrequired

Metadata describing the state of the managed cache add-on.

* Additional properties are NOT allowed.
Show Child Parameters
Example

ManagedCacheAddOnDataPlaneGroup

object

Object that describes a data-plane group where managed cache add-on is deployed.

* Additional properties are NOT allowed.
idstring(uuid)required

ID of the data-plane group.

Example:1150820b-c69f-4a2a-b9be-bbcdbc5cd618

cloud_gateway_network_idstring(uuid)required

Network ID this data-plane group is attached to.

Example:36ae63d3-efd1-4bec-b246-62aa5d3f5695

providerstringrequired

Name of cloud provider.

Allowed values:awsazuregcp

Example:aws

regionstringrequired

Region of cloud provider the data-plane group is deployed to.

Example:us-east-1

statestringrequiredread-only

The current state of the managed cache add-on in the data-plane group. Possible values:

  • initializing - The add-on is in the process of being initialized/updated and is setting up necessary resources for this data-plane group.
  • ready - The add-on is fully operational for this data-plane group.
  • error - The add-on is in an error state, and is not operational for this data-plane group.
  • terminating - The add-on is in the process of being deleted for this data-plane group.

Allowed values:initializingreadyerrorterminating

state_metadataobjectrequired

Metadata describing the state of the managed cache add-on in the data-plane group.

* Additional properties are NOT allowed.
Show Child Parameters
Example

Add-On State

string

The current state of the add-on. Possible values:

  • initializing - The add-on is in the process of being initialized/updated.
  • ready - The add-on is fully operational.
  • terminating - The add-on is in the process of being deleted.

Allowed values:initializingreadyterminating

AddOnResponse

object

Object containing information about an add-on.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Example:550e8400-e29b-41d4-a716-446655440000

namestringrequired

Unique human-readable name of the add-on.

>= 1 characters<= 70 characters

Example:my-add-on

ownerOne Of
objectrequired

Owner for the add-on.

ControlPlaneAddOnOwnerobject

Control Plane is the owner for the add-on.

* Additional properties are NOT allowed.
Show Child Parameters
configOne Of
objectrequired

Configuration object for different types of add-ons.

ManagedCacheAddOnConfigResponseobject

Configuration for managed cache add-on.

* Additional properties are NOT allowed.
Show Child Parameters
entity_versionintegerrequiredread-only

Monotonically-increasing version count of the add-on, to indicate the order of updates to the add-on.

Example:1

statestringrequiredread-only

The current state of the add-on. Possible values:

  • initializing - The add-on is in the process of being initialized/updated.
  • ready - The add-on is fully operational.
  • terminating - The add-on is in the process of being deleted.

Allowed values:initializingreadyterminating

created_atstring(date-time)requiredread-only

RFC-3339 timestamp representation of add-on creation date.

Example:2025-08-26T06:56:41Z

updated_atstring(date-time)requiredread-only

RFC-3339 timestamp representation of add-on update date.

Example:2025-08-26T06:56:41Z

Example

CreateAddOnRequest

object

Request schema for creating an add-on.

* Additional properties are NOT allowed.
namestringrequired

Unique human-readable name of the add-on.

>= 1 characters<= 70 characters

Example:my-add-on

ownerOne Of
objectrequired

Owner for the add-on.

ControlPlaneAddOnOwnerobject

Control Plane is the owner for the add-on.

* Additional properties are NOT allowed.
Show Child Parameters
configOne Of
objectrequired

Configuration for creating different types of add-ons.

CreateManagedCacheAddOnConfigobject

Configuration for creating a managed cache add-on.

* Additional properties are NOT allowed.
Show Child Parameters
Example