1. Packages
  2. Castai Provider
  3. API Docs
  4. EksCluster
castai 7.48.1 published on Wednesday, Apr 23, 2025 by castai

castai.EksCluster

Explore with Pulumi AI

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

Create EksCluster Resource

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

Constructor syntax

new EksCluster(name: string, args: EksClusterArgs, opts?: CustomResourceOptions);
@overload
def EksCluster(resource_name: str,
               args: EksClusterArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def EksCluster(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               account_id: Optional[str] = None,
               region: Optional[str] = None,
               assume_role_arn: Optional[str] = None,
               delete_nodes_on_disconnect: Optional[bool] = None,
               eks_cluster_id: Optional[str] = None,
               name: Optional[str] = None,
               timeouts: Optional[EksClusterTimeoutsArgs] = None)
func NewEksCluster(ctx *Context, name string, args EksClusterArgs, opts ...ResourceOption) (*EksCluster, error)
public EksCluster(string name, EksClusterArgs args, CustomResourceOptions? opts = null)
public EksCluster(String name, EksClusterArgs args)
public EksCluster(String name, EksClusterArgs args, CustomResourceOptions options)
type: castai:EksCluster
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. EksClusterArgs
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. EksClusterArgs
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. EksClusterArgs
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. EksClusterArgs
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. EksClusterArgs
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 eksClusterResource = new Castai.EksCluster("eksClusterResource", new()
{
    AccountId = "string",
    Region = "string",
    AssumeRoleArn = "string",
    DeleteNodesOnDisconnect = false,
    EksClusterId = "string",
    Name = "string",
    Timeouts = new Castai.Inputs.EksClusterTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});
Copy
example, err := castai.NewEksCluster(ctx, "eksClusterResource", &castai.EksClusterArgs{
	AccountId:               pulumi.String("string"),
	Region:                  pulumi.String("string"),
	AssumeRoleArn:           pulumi.String("string"),
	DeleteNodesOnDisconnect: pulumi.Bool(false),
	EksClusterId:            pulumi.String("string"),
	Name:                    pulumi.String("string"),
	Timeouts: &castai.EksClusterTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})
Copy
var eksClusterResource = new EksCluster("eksClusterResource", EksClusterArgs.builder()
    .accountId("string")
    .region("string")
    .assumeRoleArn("string")
    .deleteNodesOnDisconnect(false)
    .eksClusterId("string")
    .name("string")
    .timeouts(EksClusterTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());
Copy
eks_cluster_resource = castai.EksCluster("eksClusterResource",
    account_id="string",
    region="string",
    assume_role_arn="string",
    delete_nodes_on_disconnect=False,
    eks_cluster_id="string",
    name="string",
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })
Copy
const eksClusterResource = new castai.EksCluster("eksClusterResource", {
    accountId: "string",
    region: "string",
    assumeRoleArn: "string",
    deleteNodesOnDisconnect: false,
    eksClusterId: "string",
    name: "string",
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});
Copy
type: castai:EksCluster
properties:
    accountId: string
    assumeRoleArn: string
    deleteNodesOnDisconnect: false
    eksClusterId: string
    name: string
    region: string
    timeouts:
        create: string
        delete: string
        update: string
Copy

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

AccountId This property is required. string
ID of AWS account
Region This property is required. string
AWS region where the cluster is placed
AssumeRoleArn string
AWS IAM role ARN that will be assumed by CAST AI user. This role should allow sts:AssumeRole action for CAST AI user that can be retrieved using castai.EksUserArn data source
DeleteNodesOnDisconnect bool
Should CAST AI remove nodes managed by CAST AI on disconnect
EksClusterId string
The ID of this resource.
Name string
name of your EKS cluster
Timeouts EksClusterTimeouts
AccountId This property is required. string
ID of AWS account
Region This property is required. string
AWS region where the cluster is placed
AssumeRoleArn string
AWS IAM role ARN that will be assumed by CAST AI user. This role should allow sts:AssumeRole action for CAST AI user that can be retrieved using castai.EksUserArn data source
DeleteNodesOnDisconnect bool
Should CAST AI remove nodes managed by CAST AI on disconnect
EksClusterId string
The ID of this resource.
Name string
name of your EKS cluster
Timeouts EksClusterTimeoutsArgs
accountId This property is required. String
ID of AWS account
region This property is required. String
AWS region where the cluster is placed
assumeRoleArn String
AWS IAM role ARN that will be assumed by CAST AI user. This role should allow sts:AssumeRole action for CAST AI user that can be retrieved using castai.EksUserArn data source
deleteNodesOnDisconnect Boolean
Should CAST AI remove nodes managed by CAST AI on disconnect
eksClusterId String
The ID of this resource.
name String
name of your EKS cluster
timeouts EksClusterTimeouts
accountId This property is required. string
ID of AWS account
region This property is required. string
AWS region where the cluster is placed
assumeRoleArn string
AWS IAM role ARN that will be assumed by CAST AI user. This role should allow sts:AssumeRole action for CAST AI user that can be retrieved using castai.EksUserArn data source
deleteNodesOnDisconnect boolean
Should CAST AI remove nodes managed by CAST AI on disconnect
eksClusterId string
The ID of this resource.
name string
name of your EKS cluster
timeouts EksClusterTimeouts
account_id This property is required. str
ID of AWS account
region This property is required. str
AWS region where the cluster is placed
assume_role_arn str
AWS IAM role ARN that will be assumed by CAST AI user. This role should allow sts:AssumeRole action for CAST AI user that can be retrieved using castai.EksUserArn data source
delete_nodes_on_disconnect bool
Should CAST AI remove nodes managed by CAST AI on disconnect
eks_cluster_id str
The ID of this resource.
name str
name of your EKS cluster
timeouts EksClusterTimeoutsArgs
accountId This property is required. String
ID of AWS account
region This property is required. String
AWS region where the cluster is placed
assumeRoleArn String
AWS IAM role ARN that will be assumed by CAST AI user. This role should allow sts:AssumeRole action for CAST AI user that can be retrieved using castai.EksUserArn data source
deleteNodesOnDisconnect Boolean
Should CAST AI remove nodes managed by CAST AI on disconnect
eksClusterId String
The ID of this resource.
name String
name of your EKS cluster
timeouts Property Map

Outputs

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

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

Look up Existing EksCluster Resource

Get an existing EksCluster 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?: EksClusterState, opts?: CustomResourceOptions): EksCluster
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        assume_role_arn: Optional[str] = None,
        cluster_token: Optional[str] = None,
        credentials_id: Optional[str] = None,
        delete_nodes_on_disconnect: Optional[bool] = None,
        eks_cluster_id: Optional[str] = None,
        name: Optional[str] = None,
        region: Optional[str] = None,
        timeouts: Optional[EksClusterTimeoutsArgs] = None) -> EksCluster
func GetEksCluster(ctx *Context, name string, id IDInput, state *EksClusterState, opts ...ResourceOption) (*EksCluster, error)
public static EksCluster Get(string name, Input<string> id, EksClusterState? state, CustomResourceOptions? opts = null)
public static EksCluster get(String name, Output<String> id, EksClusterState state, CustomResourceOptions options)
resources:  _:    type: castai:EksCluster    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:
AccountId string
ID of AWS account
AssumeRoleArn string
AWS IAM role ARN that will be assumed by CAST AI user. This role should allow sts:AssumeRole action for CAST AI user that can be retrieved using castai.EksUserArn data source
ClusterToken string
computed value to store cluster token
CredentialsId string
CAST AI internal credentials ID
DeleteNodesOnDisconnect bool
Should CAST AI remove nodes managed by CAST AI on disconnect
EksClusterId string
The ID of this resource.
Name string
name of your EKS cluster
Region string
AWS region where the cluster is placed
Timeouts EksClusterTimeouts
AccountId string
ID of AWS account
AssumeRoleArn string
AWS IAM role ARN that will be assumed by CAST AI user. This role should allow sts:AssumeRole action for CAST AI user that can be retrieved using castai.EksUserArn data source
ClusterToken string
computed value to store cluster token
CredentialsId string
CAST AI internal credentials ID
DeleteNodesOnDisconnect bool
Should CAST AI remove nodes managed by CAST AI on disconnect
EksClusterId string
The ID of this resource.
Name string
name of your EKS cluster
Region string
AWS region where the cluster is placed
Timeouts EksClusterTimeoutsArgs
accountId String
ID of AWS account
assumeRoleArn String
AWS IAM role ARN that will be assumed by CAST AI user. This role should allow sts:AssumeRole action for CAST AI user that can be retrieved using castai.EksUserArn data source
clusterToken String
computed value to store cluster token
credentialsId String
CAST AI internal credentials ID
deleteNodesOnDisconnect Boolean
Should CAST AI remove nodes managed by CAST AI on disconnect
eksClusterId String
The ID of this resource.
name String
name of your EKS cluster
region String
AWS region where the cluster is placed
timeouts EksClusterTimeouts
accountId string
ID of AWS account
assumeRoleArn string
AWS IAM role ARN that will be assumed by CAST AI user. This role should allow sts:AssumeRole action for CAST AI user that can be retrieved using castai.EksUserArn data source
clusterToken string
computed value to store cluster token
credentialsId string
CAST AI internal credentials ID
deleteNodesOnDisconnect boolean
Should CAST AI remove nodes managed by CAST AI on disconnect
eksClusterId string
The ID of this resource.
name string
name of your EKS cluster
region string
AWS region where the cluster is placed
timeouts EksClusterTimeouts
account_id str
ID of AWS account
assume_role_arn str
AWS IAM role ARN that will be assumed by CAST AI user. This role should allow sts:AssumeRole action for CAST AI user that can be retrieved using castai.EksUserArn data source
cluster_token str
computed value to store 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
eks_cluster_id str
The ID of this resource.
name str
name of your EKS cluster
region str
AWS region where the cluster is placed
timeouts EksClusterTimeoutsArgs
accountId String
ID of AWS account
assumeRoleArn String
AWS IAM role ARN that will be assumed by CAST AI user. This role should allow sts:AssumeRole action for CAST AI user that can be retrieved using castai.EksUserArn data source
clusterToken String
computed value to store cluster token
credentialsId String
CAST AI internal credentials ID
deleteNodesOnDisconnect Boolean
Should CAST AI remove nodes managed by CAST AI on disconnect
eksClusterId String
The ID of this resource.
name String
name of your EKS cluster
region String
AWS region where the cluster is placed
timeouts Property Map

Supporting Types

EksClusterTimeouts
, EksClusterTimeoutsArgs

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.