1. Registry
  2. Packages
  3. CAST AI
  4. API Docs
  5. CacheGroup
Viewing docs for CAST AI v8.60.0
published on Wednesday, Aug 19, 2026 by CAST AI
castai logo
Viewing docs for CAST AI v8.60.0
published on Wednesday, Aug 19, 2026 by CAST AI

    Create CacheGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new CacheGroup(name: string, args: CacheGroupArgs, opts?: CustomResourceOptions);
    @overload
    def CacheGroup(resource_name: str,
                   args: CacheGroupArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def CacheGroup(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   protocol_type: Optional[str] = None,
                   direct_mode: Optional[bool] = None,
                   endpoints: Optional[Sequence[_cache.CacheGroupEndpointArgs]] = None,
                   name: Optional[str] = None)
    func NewCacheGroup(ctx *Context, name string, args CacheGroupArgs, opts ...ResourceOption) (*CacheGroup, error)
    public CacheGroup(string name, CacheGroupArgs args, CustomResourceOptions? opts = null)
    public CacheGroup(String name, CacheGroupArgs args)
    public CacheGroup(String name, CacheGroupArgs args, CustomResourceOptions options)
    
    type: castai:cache:CacheGroup
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "castai_cache_group" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args CacheGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CacheGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CacheGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CacheGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CacheGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    CacheGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The CacheGroup resource accepts the following input properties:

    ProtocolType string
    Database protocol type. Valid values: MySQL or PostgreSQL
    DirectMode bool
    Enable direct mode for the cache group.
    Endpoints List<Pulumi.CastAI.Cache.Inputs.CacheGroupEndpoint>
    Connection endpoints for the cache group. At least one endpoint is required when specified.
    Name string
    Display name for the cache group.
    ProtocolType string
    Database protocol type. Valid values: MySQL or PostgreSQL
    DirectMode bool
    Enable direct mode for the cache group.
    Endpoints CacheGroupEndpointArgs
    Connection endpoints for the cache group. At least one endpoint is required when specified.
    Name string
    Display name for the cache group.
    protocol_type string
    Database protocol type. Valid values: MySQL or PostgreSQL
    direct_mode bool
    Enable direct mode for the cache group.
    endpoints list(object)
    Connection endpoints for the cache group. At least one endpoint is required when specified.
    name string
    Display name for the cache group.
    protocolType String
    Database protocol type. Valid values: MySQL or PostgreSQL
    directMode Boolean
    Enable direct mode for the cache group.
    endpoints List<CacheGroupEndpoint>
    Connection endpoints for the cache group. At least one endpoint is required when specified.
    name String
    Display name for the cache group.
    protocolType string
    Database protocol type. Valid values: MySQL or PostgreSQL
    directMode boolean
    Enable direct mode for the cache group.
    endpoints cacheCacheGroupEndpoint[]
    Connection endpoints for the cache group. At least one endpoint is required when specified.
    name string
    Display name for the cache group.
    protocol_type str
    Database protocol type. Valid values: MySQL or PostgreSQL
    direct_mode bool
    Enable direct mode for the cache group.
    endpoints Sequence[cache.CacheGroupEndpointArgs]
    Connection endpoints for the cache group. At least one endpoint is required when specified.
    name str
    Display name for the cache group.
    protocolType String
    Database protocol type. Valid values: MySQL or PostgreSQL
    directMode Boolean
    Enable direct mode for the cache group.
    endpoints List<Property Map>
    Connection endpoints for the cache group. At least one endpoint is required when specified.
    name String
    Display name for the cache group.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CacheGroup resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing CacheGroup Resource

    Get an existing CacheGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: CacheGroupState, opts?: CustomResourceOptions): CacheGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            direct_mode: Optional[bool] = None,
            endpoints: Optional[Sequence[_cache.CacheGroupEndpointArgs]] = None,
            name: Optional[str] = None,
            protocol_type: Optional[str] = None) -> CacheGroup
    func GetCacheGroup(ctx *Context, name string, id IDInput, state *CacheGroupState, opts ...ResourceOption) (*CacheGroup, error)
    public static CacheGroup Get(string name, Input<string> id, CacheGroupState? state, CustomResourceOptions? opts = null)
    public static CacheGroup get(String name, Output<String> id, CacheGroupState state, CustomResourceOptions options)
    resources:  _:    type: castai:cache:CacheGroup    get:      id: ${id}
    import {
      to = castai_cache_group.example
      id = "${id}"
    }
    
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DirectMode bool
    Enable direct mode for the cache group.
    Endpoints List<Pulumi.CastAI.Cache.Inputs.CacheGroupEndpoint>
    Connection endpoints for the cache group. At least one endpoint is required when specified.
    Name string
    Display name for the cache group.
    ProtocolType string
    Database protocol type. Valid values: MySQL or PostgreSQL
    DirectMode bool
    Enable direct mode for the cache group.
    Endpoints CacheGroupEndpointArgs
    Connection endpoints for the cache group. At least one endpoint is required when specified.
    Name string
    Display name for the cache group.
    ProtocolType string
    Database protocol type. Valid values: MySQL or PostgreSQL
    direct_mode bool
    Enable direct mode for the cache group.
    endpoints list(object)
    Connection endpoints for the cache group. At least one endpoint is required when specified.
    name string
    Display name for the cache group.
    protocol_type string
    Database protocol type. Valid values: MySQL or PostgreSQL
    directMode Boolean
    Enable direct mode for the cache group.
    endpoints List<CacheGroupEndpoint>
    Connection endpoints for the cache group. At least one endpoint is required when specified.
    name String
    Display name for the cache group.
    protocolType String
    Database protocol type. Valid values: MySQL or PostgreSQL
    directMode boolean
    Enable direct mode for the cache group.
    endpoints cacheCacheGroupEndpoint[]
    Connection endpoints for the cache group. At least one endpoint is required when specified.
    name string
    Display name for the cache group.
    protocolType string
    Database protocol type. Valid values: MySQL or PostgreSQL
    direct_mode bool
    Enable direct mode for the cache group.
    endpoints Sequence[cache.CacheGroupEndpointArgs]
    Connection endpoints for the cache group. At least one endpoint is required when specified.
    name str
    Display name for the cache group.
    protocol_type str
    Database protocol type. Valid values: MySQL or PostgreSQL
    directMode Boolean
    Enable direct mode for the cache group.
    endpoints List<Property Map>
    Connection endpoints for the cache group. At least one endpoint is required when specified.
    name String
    Display name for the cache group.
    protocolType String
    Database protocol type. Valid values: MySQL or PostgreSQL

    Supporting Types

    CacheGroupEndpoint, CacheGroupEndpointArgs

    Hostname string
    Database instance hostname.
    Name string
    Name for the endpoint.
    Port int
    Database instance port.
    Hostname string
    Database instance hostname.
    Name string
    Name for the endpoint.
    Port int
    Database instance port.
    hostname string
    Database instance hostname.
    name string
    Name for the endpoint.
    port number
    Database instance port.
    hostname String
    Database instance hostname.
    name String
    Name for the endpoint.
    port Integer
    Database instance port.
    hostname string
    Database instance hostname.
    name string
    Name for the endpoint.
    port number
    Database instance port.
    hostname str
    Database instance hostname.
    name str
    Name for the endpoint.
    port int
    Database instance port.
    hostname String
    Database instance hostname.
    name String
    Name for the endpoint.
    port Number
    Database instance port.

    Package Details

    Repository
    castai castai/pulumi-castai
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the castai Terraform Provider.
    castai logo
    Viewing docs for CAST AI v8.60.0
    published on Wednesday, Aug 19, 2026 by CAST AI

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial