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

castai.AksCluster

Explore with Pulumi AI

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

    AKS cluster resource allows connecting an existing EKS cluster to CAST AI.

    Create AksCluster Resource

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

    Constructor syntax

    new AksCluster(name: string, args: AksClusterArgs, opts?: CustomResourceOptions);
    @overload
    def AksCluster(resource_name: str,
                   args: AksClusterArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def AksCluster(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   client_id: Optional[str] = None,
                   client_secret: Optional[str] = None,
                   node_resource_group: Optional[str] = None,
                   region: Optional[str] = None,
                   subscription_id: Optional[str] = None,
                   tenant_id: Optional[str] = None,
                   delete_nodes_on_disconnect: Optional[bool] = None,
                   name: Optional[str] = None)
    func NewAksCluster(ctx *Context, name string, args AksClusterArgs, opts ...ResourceOption) (*AksCluster, error)
    public AksCluster(string name, AksClusterArgs args, CustomResourceOptions? opts = null)
    public AksCluster(String name, AksClusterArgs args)
    public AksCluster(String name, AksClusterArgs args, CustomResourceOptions options)
    
    type: castai:azure:AksCluster
    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 AksClusterArgs
    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 AksClusterArgs
    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 AksClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AksClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AksClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    ClientId string
    Azure AD application ID that is created and used by CAST AI.
    ClientSecret string
    Azure AD application password that will be used by CAST AI.
    NodeResourceGroup string
    Azure resource group in which nodes are and will be created.
    Region string
    AKS cluster region.
    SubscriptionId string
    ID of the Azure subscription.
    TenantId string
    Azure AD tenant ID from the used subscription.
    DeleteNodesOnDisconnect bool
    Should CAST AI remove nodes managed by CAST.AI on disconnect.
    Name string
    AKS cluster name.
    ClientId string
    Azure AD application ID that is created and used by CAST AI.
    ClientSecret string
    Azure AD application password that will be used by CAST AI.
    NodeResourceGroup string
    Azure resource group in which nodes are and will be created.
    Region string
    AKS cluster region.
    SubscriptionId string
    ID of the Azure subscription.
    TenantId string
    Azure AD tenant ID from the used subscription.
    DeleteNodesOnDisconnect bool
    Should CAST AI remove nodes managed by CAST.AI on disconnect.
    Name string
    AKS cluster name.
    clientId String
    Azure AD application ID that is created and used by CAST AI.
    clientSecret String
    Azure AD application password that will be used by CAST AI.
    nodeResourceGroup String
    Azure resource group in which nodes are and will be created.
    region String
    AKS cluster region.
    subscriptionId String
    ID of the Azure subscription.
    tenantId String
    Azure AD tenant ID from the used subscription.
    deleteNodesOnDisconnect Boolean
    Should CAST AI remove nodes managed by CAST.AI on disconnect.
    name String
    AKS cluster name.
    clientId string
    Azure AD application ID that is created and used by CAST AI.
    clientSecret string
    Azure AD application password that will be used by CAST AI.
    nodeResourceGroup string
    Azure resource group in which nodes are and will be created.
    region string
    AKS cluster region.
    subscriptionId string
    ID of the Azure subscription.
    tenantId string
    Azure AD tenant ID from the used subscription.
    deleteNodesOnDisconnect boolean
    Should CAST AI remove nodes managed by CAST.AI on disconnect.
    name string
    AKS cluster name.
    client_id str
    Azure AD application ID that is created and used by CAST AI.
    client_secret str
    Azure AD application password that will be used by CAST AI.
    node_resource_group str
    Azure resource group in which nodes are and will be created.
    region str
    AKS cluster region.
    subscription_id str
    ID of the Azure subscription.
    tenant_id str
    Azure AD tenant ID from the used subscription.
    delete_nodes_on_disconnect bool
    Should CAST AI remove nodes managed by CAST.AI on disconnect.
    name str
    AKS cluster name.
    clientId String
    Azure AD application ID that is created and used by CAST AI.
    clientSecret String
    Azure AD application password that will be used by CAST AI.
    nodeResourceGroup String
    Azure resource group in which nodes are and will be created.
    region String
    AKS cluster region.
    subscriptionId String
    ID of the Azure subscription.
    tenantId String
    Azure AD tenant ID from the used subscription.
    deleteNodesOnDisconnect Boolean
    Should CAST AI remove nodes managed by CAST.AI on disconnect.
    name String
    AKS cluster name.

    Outputs

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

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

    Look up Existing AksCluster Resource

    Get an existing AksCluster 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?: AksClusterState, opts?: CustomResourceOptions): AksCluster
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            client_id: Optional[str] = None,
            client_secret: Optional[str] = None,
            cluster_token: Optional[str] = None,
            delete_nodes_on_disconnect: Optional[bool] = None,
            name: Optional[str] = None,
            node_resource_group: Optional[str] = None,
            region: Optional[str] = None,
            subscription_id: Optional[str] = None,
            tenant_id: Optional[str] = None) -> AksCluster
    func GetAksCluster(ctx *Context, name string, id IDInput, state *AksClusterState, opts ...ResourceOption) (*AksCluster, error)
    public static AksCluster Get(string name, Input<string> id, AksClusterState? state, CustomResourceOptions? opts = null)
    public static AksCluster get(String name, Output<String> id, AksClusterState state, CustomResourceOptions options)
    resources:  _:    type: castai:azure:AksCluster    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:
    ClientId string
    Azure AD application ID that is created and used by CAST AI.
    ClientSecret string
    Azure AD application password that will be used by CAST AI.
    ClusterToken string
    CAST AI cluster token.
    DeleteNodesOnDisconnect bool
    Should CAST AI remove nodes managed by CAST.AI on disconnect.
    Name string
    AKS cluster name.
    NodeResourceGroup string
    Azure resource group in which nodes are and will be created.
    Region string
    AKS cluster region.
    SubscriptionId string
    ID of the Azure subscription.
    TenantId string
    Azure AD tenant ID from the used subscription.
    ClientId string
    Azure AD application ID that is created and used by CAST AI.
    ClientSecret string
    Azure AD application password that will be used by CAST AI.
    ClusterToken string
    CAST AI cluster token.
    DeleteNodesOnDisconnect bool
    Should CAST AI remove nodes managed by CAST.AI on disconnect.
    Name string
    AKS cluster name.
    NodeResourceGroup string
    Azure resource group in which nodes are and will be created.
    Region string
    AKS cluster region.
    SubscriptionId string
    ID of the Azure subscription.
    TenantId string
    Azure AD tenant ID from the used subscription.
    clientId String
    Azure AD application ID that is created and used by CAST AI.
    clientSecret String
    Azure AD application password that will be used by CAST AI.
    clusterToken String
    CAST AI cluster token.
    deleteNodesOnDisconnect Boolean
    Should CAST AI remove nodes managed by CAST.AI on disconnect.
    name String
    AKS cluster name.
    nodeResourceGroup String
    Azure resource group in which nodes are and will be created.
    region String
    AKS cluster region.
    subscriptionId String
    ID of the Azure subscription.
    tenantId String
    Azure AD tenant ID from the used subscription.
    clientId string
    Azure AD application ID that is created and used by CAST AI.
    clientSecret string
    Azure AD application password that will be used by CAST AI.
    clusterToken string
    CAST AI cluster token.
    deleteNodesOnDisconnect boolean
    Should CAST AI remove nodes managed by CAST.AI on disconnect.
    name string
    AKS cluster name.
    nodeResourceGroup string
    Azure resource group in which nodes are and will be created.
    region string
    AKS cluster region.
    subscriptionId string
    ID of the Azure subscription.
    tenantId string
    Azure AD tenant ID from the used subscription.
    client_id str
    Azure AD application ID that is created and used by CAST AI.
    client_secret str
    Azure AD application password that will be used by CAST AI.
    cluster_token str
    CAST AI cluster token.
    delete_nodes_on_disconnect bool
    Should CAST AI remove nodes managed by CAST.AI on disconnect.
    name str
    AKS cluster name.
    node_resource_group str
    Azure resource group in which nodes are and will be created.
    region str
    AKS cluster region.
    subscription_id str
    ID of the Azure subscription.
    tenant_id str
    Azure AD tenant ID from the used subscription.
    clientId String
    Azure AD application ID that is created and used by CAST AI.
    clientSecret String
    Azure AD application password that will be used by CAST AI.
    clusterToken String
    CAST AI cluster token.
    deleteNodesOnDisconnect Boolean
    Should CAST AI remove nodes managed by CAST.AI on disconnect.
    name String
    AKS cluster name.
    nodeResourceGroup String
    Azure resource group in which nodes are and will be created.
    region String
    AKS cluster region.
    subscriptionId String
    ID of the Azure subscription.
    tenantId String
    Azure AD tenant ID from the used subscription.

    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