1. Packages
  2. CAST AI
  3. API Docs
  4. GkeCluster
CAST AI v0.1.45 published on Thursday, Apr 17, 2025 by CAST AI

castai.GkeCluster

Explore with Pulumi AI

castai logo
CAST AI v0.1.45 published on Thursday, Apr 17, 2025 by CAST AI

    GKE cluster resource allows connecting an existing GEK cluster to CAST AI.

    Create GkeCluster Resource

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

    Constructor syntax

    new GkeCluster(name: string, args: GkeClusterArgs, opts?: CustomResourceOptions);
    @overload
    def GkeCluster(resource_name: str,
                   args: GkeClusterArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def GkeCluster(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   location: Optional[str] = None,
                   project_id: Optional[str] = None,
                   credentials_json: Optional[str] = None,
                   delete_nodes_on_disconnect: Optional[bool] = None,
                   name: Optional[str] = None,
                   ssh_public_key: Optional[str] = None)
    func NewGkeCluster(ctx *Context, name string, args GkeClusterArgs, opts ...ResourceOption) (*GkeCluster, error)
    public GkeCluster(string name, GkeClusterArgs args, CustomResourceOptions? opts = null)
    public GkeCluster(String name, GkeClusterArgs args)
    public GkeCluster(String name, GkeClusterArgs args, CustomResourceOptions options)
    
    type: castai:gcp:GkeCluster
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args GkeClusterArgs
    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 GkeClusterArgs
    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 GkeClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GkeClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GkeClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    GkeCluster 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 GkeCluster resource accepts the following input properties:

    Location string
    GCP cluster zone in case of zonal or region in case of regional cluster
    ProjectId string
    GCP project id
    CredentialsJson string
    GCP credentials.json from ServiceAccount with credentials for CAST AI
    DeleteNodesOnDisconnect bool
    Should CAST AI remove nodes managed by CAST.AI on disconnect
    Name string
    GKE cluster name
    SshPublicKey string
    SSHPublicKey for nodes
    Location string
    GCP cluster zone in case of zonal or region in case of regional cluster
    ProjectId string
    GCP project id
    CredentialsJson string
    GCP credentials.json from ServiceAccount with credentials for CAST AI
    DeleteNodesOnDisconnect bool
    Should CAST AI remove nodes managed by CAST.AI on disconnect
    Name string
    GKE cluster name
    SshPublicKey string
    SSHPublicKey for nodes
    location String
    GCP cluster zone in case of zonal or region in case of regional cluster
    projectId String
    GCP project id
    credentialsJson String
    GCP credentials.json from ServiceAccount with credentials for CAST AI
    deleteNodesOnDisconnect Boolean
    Should CAST AI remove nodes managed by CAST.AI on disconnect
    name String
    GKE cluster name
    sshPublicKey String
    SSHPublicKey for nodes
    location string
    GCP cluster zone in case of zonal or region in case of regional cluster
    projectId string
    GCP project id
    credentialsJson string
    GCP credentials.json from ServiceAccount with credentials for CAST AI
    deleteNodesOnDisconnect boolean
    Should CAST AI remove nodes managed by CAST.AI on disconnect
    name string
    GKE cluster name
    sshPublicKey string
    SSHPublicKey for nodes
    location str
    GCP cluster zone in case of zonal or region in case of regional cluster
    project_id str
    GCP project id
    credentials_json str
    GCP credentials.json from ServiceAccount with credentials for CAST AI
    delete_nodes_on_disconnect bool
    Should CAST AI remove nodes managed by CAST.AI on disconnect
    name str
    GKE cluster name
    ssh_public_key str
    SSHPublicKey for nodes
    location String
    GCP cluster zone in case of zonal or region in case of regional cluster
    projectId String
    GCP project id
    credentialsJson String
    GCP credentials.json from ServiceAccount with credentials for CAST AI
    deleteNodesOnDisconnect Boolean
    Should CAST AI remove nodes managed by CAST.AI on disconnect
    name String
    GKE cluster name
    sshPublicKey String
    SSHPublicKey for nodes

    Outputs

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

    ClusterToken string
    CAST.AI agent cluster token
    CredentialsId string
    CAST AI credentials id for cluster
    Id string
    The provider-assigned unique ID for this managed resource.
    ClusterToken string
    CAST.AI agent cluster token
    CredentialsId string
    CAST AI credentials id for cluster
    Id string
    The provider-assigned unique ID for this managed resource.
    clusterToken String
    CAST.AI agent cluster token
    credentialsId String
    CAST AI credentials id for cluster
    id String
    The provider-assigned unique ID for this managed resource.
    clusterToken string
    CAST.AI agent cluster token
    credentialsId string
    CAST AI credentials id for cluster
    id string
    The provider-assigned unique ID for this managed resource.
    cluster_token str
    CAST.AI agent cluster token
    credentials_id str
    CAST AI credentials id for cluster
    id str
    The provider-assigned unique ID for this managed resource.
    clusterToken String
    CAST.AI agent cluster token
    credentialsId String
    CAST AI credentials id for cluster
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing GkeCluster Resource

    Get an existing GkeCluster 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?: GkeClusterState, opts?: CustomResourceOptions): GkeCluster
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            cluster_token: Optional[str] = None,
            credentials_id: Optional[str] = None,
            credentials_json: Optional[str] = None,
            delete_nodes_on_disconnect: Optional[bool] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            project_id: Optional[str] = None,
            ssh_public_key: Optional[str] = None) -> GkeCluster
    func GetGkeCluster(ctx *Context, name string, id IDInput, state *GkeClusterState, opts ...ResourceOption) (*GkeCluster, error)
    public static GkeCluster Get(string name, Input<string> id, GkeClusterState? state, CustomResourceOptions? opts = null)
    public static GkeCluster get(String name, Output<String> id, GkeClusterState state, CustomResourceOptions options)
    resources:  _:    type: castai:gcp:GkeCluster    get:      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:
    ClusterToken string
    CAST.AI agent cluster token
    CredentialsId string
    CAST AI credentials id for cluster
    CredentialsJson string
    GCP credentials.json from ServiceAccount with credentials for CAST AI
    DeleteNodesOnDisconnect bool
    Should CAST AI remove nodes managed by CAST.AI on disconnect
    Location string
    GCP cluster zone in case of zonal or region in case of regional cluster
    Name string
    GKE cluster name
    ProjectId string
    GCP project id
    SshPublicKey string
    SSHPublicKey for nodes
    ClusterToken string
    CAST.AI agent cluster token
    CredentialsId string
    CAST AI credentials id for cluster
    CredentialsJson string
    GCP credentials.json from ServiceAccount with credentials for CAST AI
    DeleteNodesOnDisconnect bool
    Should CAST AI remove nodes managed by CAST.AI on disconnect
    Location string
    GCP cluster zone in case of zonal or region in case of regional cluster
    Name string
    GKE cluster name
    ProjectId string
    GCP project id
    SshPublicKey string
    SSHPublicKey for nodes
    clusterToken String
    CAST.AI agent cluster token
    credentialsId String
    CAST AI credentials id for cluster
    credentialsJson String
    GCP credentials.json from ServiceAccount with credentials for CAST AI
    deleteNodesOnDisconnect Boolean
    Should CAST AI remove nodes managed by CAST.AI on disconnect
    location String
    GCP cluster zone in case of zonal or region in case of regional cluster
    name String
    GKE cluster name
    projectId String
    GCP project id
    sshPublicKey String
    SSHPublicKey for nodes
    clusterToken string
    CAST.AI agent cluster token
    credentialsId string
    CAST AI credentials id for cluster
    credentialsJson string
    GCP credentials.json from ServiceAccount with credentials for CAST AI
    deleteNodesOnDisconnect boolean
    Should CAST AI remove nodes managed by CAST.AI on disconnect
    location string
    GCP cluster zone in case of zonal or region in case of regional cluster
    name string
    GKE cluster name
    projectId string
    GCP project id
    sshPublicKey string
    SSHPublicKey for nodes
    cluster_token str
    CAST.AI agent cluster token
    credentials_id str
    CAST AI credentials id for cluster
    credentials_json str
    GCP credentials.json from ServiceAccount with credentials for CAST AI
    delete_nodes_on_disconnect bool
    Should CAST AI remove nodes managed by CAST.AI on disconnect
    location str
    GCP cluster zone in case of zonal or region in case of regional cluster
    name str
    GKE cluster name
    project_id str
    GCP project id
    ssh_public_key str
    SSHPublicKey for nodes
    clusterToken String
    CAST.AI agent cluster token
    credentialsId String
    CAST AI credentials id for cluster
    credentialsJson String
    GCP credentials.json from ServiceAccount with credentials for CAST AI
    deleteNodesOnDisconnect Boolean
    Should CAST AI remove nodes managed by CAST.AI on disconnect
    location String
    GCP cluster zone in case of zonal or region in case of regional cluster
    name String
    GKE cluster name
    projectId String
    GCP project id
    sshPublicKey String
    SSHPublicKey for nodes

    Package Details

    Repository
    castai castai/pulumi-castai
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the castai Terraform Provider.
    castai logo
    CAST AI v0.1.45 published on Thursday, Apr 17, 2025 by CAST AI