Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Castai Provider
  3. API Docs
  4. AksCluster
castai 7.45.0 published on Wednesday, Apr 16, 2025 by castai
castai/terraform-provider-castai

castai.AksCluster

Explore with Pulumi AI

castai 7.45.0 published on Wednesday, Apr 16, 2025 by castai
castai/terraform-provider-castai

AKS cluster resource allows connecting an existing AKS 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,
               aks_cluster_id: Optional[str] = None,
               delete_nodes_on_disconnect: Optional[bool] = None,
               http_proxy_config: Optional[AksClusterHttpProxyConfigArgs] = None,
               name: Optional[str] = None,
               timeouts: Optional[AksClusterTimeoutsArgs] = 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:AksCluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AksClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. AksClusterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AksClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AksClusterArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var aksClusterResource = new Castai.AksCluster("aksClusterResource", new()
{
    ClientId = "string",
    ClientSecret = "string",
    NodeResourceGroup = "string",
    Region = "string",
    SubscriptionId = "string",
    TenantId = "string",
    AksClusterId = "string",
    DeleteNodesOnDisconnect = false,
    HttpProxyConfig = new Castai.Inputs.AksClusterHttpProxyConfigArgs
    {
        HttpProxy = "string",
        HttpsProxy = "string",
        NoProxies = new[]
        {
            "string",
        },
    },
    Name = "string",
    Timeouts = new Castai.Inputs.AksClusterTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});
Copy
example, err := castai.NewAksCluster(ctx, "aksClusterResource", &castai.AksClusterArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
NodeResourceGroup: pulumi.String("string"),
Region: pulumi.String("string"),
SubscriptionId: pulumi.String("string"),
TenantId: pulumi.String("string"),
AksClusterId: pulumi.String("string"),
DeleteNodesOnDisconnect: pulumi.Bool(false),
HttpProxyConfig: &.AksClusterHttpProxyConfigArgs{
HttpProxy: pulumi.String("string"),
HttpsProxy: pulumi.String("string"),
NoProxies: pulumi.StringArray{
pulumi.String("string"),
},
},
Name: pulumi.String("string"),
Timeouts: &.AksClusterTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
Update: pulumi.String("string"),
},
})
Copy
var aksClusterResource = new AksCluster("aksClusterResource", AksClusterArgs.builder()
    .clientId("string")
    .clientSecret("string")
    .nodeResourceGroup("string")
    .region("string")
    .subscriptionId("string")
    .tenantId("string")
    .aksClusterId("string")
    .deleteNodesOnDisconnect(false)
    .httpProxyConfig(AksClusterHttpProxyConfigArgs.builder()
        .httpProxy("string")
        .httpsProxy("string")
        .noProxies("string")
        .build())
    .name("string")
    .timeouts(AksClusterTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());
Copy
aks_cluster_resource = castai.AksCluster("aksClusterResource",
    client_id="string",
    client_secret="string",
    node_resource_group="string",
    region="string",
    subscription_id="string",
    tenant_id="string",
    aks_cluster_id="string",
    delete_nodes_on_disconnect=False,
    http_proxy_config={
        "http_proxy": "string",
        "https_proxy": "string",
        "no_proxies": ["string"],
    },
    name="string",
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })
Copy
const aksClusterResource = new castai.AksCluster("aksClusterResource", {
    clientId: "string",
    clientSecret: "string",
    nodeResourceGroup: "string",
    region: "string",
    subscriptionId: "string",
    tenantId: "string",
    aksClusterId: "string",
    deleteNodesOnDisconnect: false,
    httpProxyConfig: {
        httpProxy: "string",
        httpsProxy: "string",
        noProxies: ["string"],
    },
    name: "string",
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});
Copy
type: castai:AksCluster
properties:
    aksClusterId: string
    clientId: string
    clientSecret: string
    deleteNodesOnDisconnect: false
    httpProxyConfig:
        httpProxy: string
        httpsProxy: string
        noProxies:
            - string
    name: string
    nodeResourceGroup: string
    region: string
    subscriptionId: string
    tenantId: string
    timeouts:
        create: string
        delete: string
        update: string
Copy

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 This property is required. string
Azure AD application ID that is created and used by CAST AI.
ClientSecret This property is required. string
Azure AD application password that will be used by CAST AI.
NodeResourceGroup This property is required. string
Azure resource group in which nodes are and will be created.
Region This property is required. string
AKS cluster region.
SubscriptionId This property is required. string
ID of the Azure subscription.
TenantId This property is required. string
Azure AD tenant ID from the used subscription.
AksClusterId string
The ID of this resource.
DeleteNodesOnDisconnect bool
Should CAST AI remove nodes managed by CAST.AI on disconnect.
HttpProxyConfig AksClusterHttpProxyConfig
HTTP proxy configuration for CAST AI nodes and node components.
Name string
AKS cluster name.
Timeouts AksClusterTimeouts
ClientId This property is required. string
Azure AD application ID that is created and used by CAST AI.
ClientSecret This property is required. string
Azure AD application password that will be used by CAST AI.
NodeResourceGroup This property is required. string
Azure resource group in which nodes are and will be created.
Region This property is required. string
AKS cluster region.
SubscriptionId This property is required. string
ID of the Azure subscription.
TenantId This property is required. string
Azure AD tenant ID from the used subscription.
AksClusterId string
The ID of this resource.
DeleteNodesOnDisconnect bool
Should CAST AI remove nodes managed by CAST.AI on disconnect.
HttpProxyConfig AksClusterHttpProxyConfigArgs
HTTP proxy configuration for CAST AI nodes and node components.
Name string
AKS cluster name.
Timeouts AksClusterTimeoutsArgs
clientId This property is required. String
Azure AD application ID that is created and used by CAST AI.
clientSecret This property is required. String
Azure AD application password that will be used by CAST AI.
nodeResourceGroup This property is required. String
Azure resource group in which nodes are and will be created.
region This property is required. String
AKS cluster region.
subscriptionId This property is required. String
ID of the Azure subscription.
tenantId This property is required. String
Azure AD tenant ID from the used subscription.
aksClusterId String
The ID of this resource.
deleteNodesOnDisconnect Boolean
Should CAST AI remove nodes managed by CAST.AI on disconnect.
httpProxyConfig AksClusterHttpProxyConfig
HTTP proxy configuration for CAST AI nodes and node components.
name String
AKS cluster name.
timeouts AksClusterTimeouts
clientId This property is required. string
Azure AD application ID that is created and used by CAST AI.
clientSecret This property is required. string
Azure AD application password that will be used by CAST AI.
nodeResourceGroup This property is required. string
Azure resource group in which nodes are and will be created.
region This property is required. string
AKS cluster region.
subscriptionId This property is required. string
ID of the Azure subscription.
tenantId This property is required. string
Azure AD tenant ID from the used subscription.
aksClusterId string
The ID of this resource.
deleteNodesOnDisconnect boolean
Should CAST AI remove nodes managed by CAST.AI on disconnect.
httpProxyConfig AksClusterHttpProxyConfig
HTTP proxy configuration for CAST AI nodes and node components.
name string
AKS cluster name.
timeouts AksClusterTimeouts
client_id This property is required. str
Azure AD application ID that is created and used by CAST AI.
client_secret This property is required. str
Azure AD application password that will be used by CAST AI.
node_resource_group This property is required. str
Azure resource group in which nodes are and will be created.
region This property is required. str
AKS cluster region.
subscription_id This property is required. str
ID of the Azure subscription.
tenant_id This property is required. str
Azure AD tenant ID from the used subscription.
aks_cluster_id str
The ID of this resource.
delete_nodes_on_disconnect bool
Should CAST AI remove nodes managed by CAST.AI on disconnect.
http_proxy_config AksClusterHttpProxyConfigArgs
HTTP proxy configuration for CAST AI nodes and node components.
name str
AKS cluster name.
timeouts AksClusterTimeoutsArgs
clientId This property is required. String
Azure AD application ID that is created and used by CAST AI.
clientSecret This property is required. String
Azure AD application password that will be used by CAST AI.
nodeResourceGroup This property is required. String
Azure resource group in which nodes are and will be created.
region This property is required. String
AKS cluster region.
subscriptionId This property is required. String
ID of the Azure subscription.
tenantId This property is required. String
Azure AD tenant ID from the used subscription.
aksClusterId String
The ID of this resource.
deleteNodesOnDisconnect Boolean
Should CAST AI remove nodes managed by CAST.AI on disconnect.
httpProxyConfig Property Map
HTTP proxy configuration for CAST AI nodes and node components.
name String
AKS cluster name.
timeouts Property Map

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.
CredentialsId string
CAST AI internal credentials ID
Id string
The provider-assigned unique ID for this managed resource.
ClusterToken string
CAST AI cluster token.
CredentialsId string
CAST AI internal credentials ID
Id string
The provider-assigned unique ID for this managed resource.
clusterToken String
CAST AI cluster token.
credentialsId String
CAST AI internal credentials ID
id String
The provider-assigned unique ID for this managed resource.
clusterToken string
CAST AI cluster token.
credentialsId string
CAST AI internal credentials ID
id string
The provider-assigned unique ID for this managed resource.
cluster_token str
CAST AI cluster token.
credentials_id str
CAST AI internal credentials ID
id str
The provider-assigned unique ID for this managed resource.
clusterToken String
CAST AI cluster token.
credentialsId String
CAST AI internal credentials ID
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,
        aks_cluster_id: Optional[str] = None,
        client_id: Optional[str] = None,
        client_secret: Optional[str] = None,
        cluster_token: Optional[str] = None,
        credentials_id: Optional[str] = None,
        delete_nodes_on_disconnect: Optional[bool] = None,
        http_proxy_config: Optional[AksClusterHttpProxyConfigArgs] = 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,
        timeouts: Optional[AksClusterTimeoutsArgs] = 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:AksCluster    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AksClusterId string
The ID of this resource.
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.
CredentialsId string
CAST AI internal credentials ID
DeleteNodesOnDisconnect bool
Should CAST AI remove nodes managed by CAST.AI on disconnect.
HttpProxyConfig AksClusterHttpProxyConfig
HTTP proxy configuration for CAST AI nodes and node components.
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.
Timeouts AksClusterTimeouts
AksClusterId string
The ID of this resource.
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.
CredentialsId string
CAST AI internal credentials ID
DeleteNodesOnDisconnect bool
Should CAST AI remove nodes managed by CAST.AI on disconnect.
HttpProxyConfig AksClusterHttpProxyConfigArgs
HTTP proxy configuration for CAST AI nodes and node components.
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.
Timeouts AksClusterTimeoutsArgs
aksClusterId String
The ID of this resource.
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.
credentialsId String
CAST AI internal credentials ID
deleteNodesOnDisconnect Boolean
Should CAST AI remove nodes managed by CAST.AI on disconnect.
httpProxyConfig AksClusterHttpProxyConfig
HTTP proxy configuration for CAST AI nodes and node components.
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.
timeouts AksClusterTimeouts
aksClusterId string
The ID of this resource.
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.
credentialsId string
CAST AI internal credentials ID
deleteNodesOnDisconnect boolean
Should CAST AI remove nodes managed by CAST.AI on disconnect.
httpProxyConfig AksClusterHttpProxyConfig
HTTP proxy configuration for CAST AI nodes and node components.
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.
timeouts AksClusterTimeouts
aks_cluster_id str
The ID of this resource.
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.
credentials_id str
CAST AI internal credentials ID
delete_nodes_on_disconnect bool
Should CAST AI remove nodes managed by CAST.AI on disconnect.
http_proxy_config AksClusterHttpProxyConfigArgs
HTTP proxy configuration for CAST AI nodes and node components.
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.
timeouts AksClusterTimeoutsArgs
aksClusterId String
The ID of this resource.
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.
credentialsId String
CAST AI internal credentials ID
deleteNodesOnDisconnect Boolean
Should CAST AI remove nodes managed by CAST.AI on disconnect.
httpProxyConfig Property Map
HTTP proxy configuration for CAST AI nodes and node components.
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.
timeouts Property Map

Supporting Types

AksClusterHttpProxyConfig
, AksClusterHttpProxyConfigArgs

HttpProxy string
Address to use for proxying HTTP requests.
HttpsProxy string
Address to use for proxying HTTPS/TLS requests.
NoProxies List<string>
List of destinations that should not go through proxy.
HttpProxy string
Address to use for proxying HTTP requests.
HttpsProxy string
Address to use for proxying HTTPS/TLS requests.
NoProxies []string
List of destinations that should not go through proxy.
httpProxy String
Address to use for proxying HTTP requests.
httpsProxy String
Address to use for proxying HTTPS/TLS requests.
noProxies List<String>
List of destinations that should not go through proxy.
httpProxy string
Address to use for proxying HTTP requests.
httpsProxy string
Address to use for proxying HTTPS/TLS requests.
noProxies string[]
List of destinations that should not go through proxy.
http_proxy str
Address to use for proxying HTTP requests.
https_proxy str
Address to use for proxying HTTPS/TLS requests.
no_proxies Sequence[str]
List of destinations that should not go through proxy.
httpProxy String
Address to use for proxying HTTP requests.
httpsProxy String
Address to use for proxying HTTPS/TLS requests.
noProxies List<String>
List of destinations that should not go through proxy.

AksClusterTimeouts
, AksClusterTimeoutsArgs

Create string
Delete string
Update string
Create string
Delete string
Update string
create String
delete String
update String
create string
delete string
update string
create str
delete str
update str
create String
delete String
update String

Package Details

Repository
castai castai/terraform-provider-castai
License
Notes
This Pulumi package is based on the castai Terraform Provider.
castai 7.45.0 published on Wednesday, Apr 16, 2025 by castai
castai/terraform-provider-castai