CAST AI v7.73.2 published on Wednesday, Oct 29, 2025 by CAST AI
castai.EksCluster
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,
               name: Optional[str] = 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:aws:EksCluster
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 EksClusterArgs
- 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 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 string
- The unique name of the resource.
- args EksClusterArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EksClusterArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args EksClusterArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
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 string
- ID of AWS account
- Region string
- AWS region where the cluster is placed
- AssumeRole stringArn 
- AWS IAM role ARN that will be assumed by CAST AI user. This role should allow sts:AssumeRoleaction for CAST AI user.
- DeleteNodes boolOn Disconnect 
- Should CAST AI remove nodes managed by CAST AI on disconnect
- Name string
- name of your EKS cluster
- AccountId string
- ID of AWS account
- Region string
- AWS region where the cluster is placed
- AssumeRole stringArn 
- AWS IAM role ARN that will be assumed by CAST AI user. This role should allow sts:AssumeRoleaction for CAST AI user.
- DeleteNodes boolOn Disconnect 
- Should CAST AI remove nodes managed by CAST AI on disconnect
- Name string
- name of your EKS cluster
- accountId String
- ID of AWS account
- region String
- AWS region where the cluster is placed
- assumeRole StringArn 
- AWS IAM role ARN that will be assumed by CAST AI user. This role should allow sts:AssumeRoleaction for CAST AI user.
- deleteNodes BooleanOn Disconnect 
- Should CAST AI remove nodes managed by CAST AI on disconnect
- name String
- name of your EKS cluster
- accountId string
- ID of AWS account
- region string
- AWS region where the cluster is placed
- assumeRole stringArn 
- AWS IAM role ARN that will be assumed by CAST AI user. This role should allow sts:AssumeRoleaction for CAST AI user.
- deleteNodes booleanOn Disconnect 
- Should CAST AI remove nodes managed by CAST AI on disconnect
- name string
- name of your EKS cluster
- account_id str
- ID of AWS account
- region str
- AWS region where the cluster is placed
- assume_role_ strarn 
- AWS IAM role ARN that will be assumed by CAST AI user. This role should allow sts:AssumeRoleaction for CAST AI user.
- delete_nodes_ boolon_ disconnect 
- Should CAST AI remove nodes managed by CAST AI on disconnect
- name str
- name of your EKS cluster
- accountId String
- ID of AWS account
- region String
- AWS region where the cluster is placed
- assumeRole StringArn 
- AWS IAM role ARN that will be assumed by CAST AI user. This role should allow sts:AssumeRoleaction for CAST AI user.
- deleteNodes BooleanOn Disconnect 
- Should CAST AI remove nodes managed by CAST AI on disconnect
- name String
- name of your EKS cluster
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,
        name: Optional[str] = None,
        region: Optional[str] = None) -> EksClusterfunc 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:aws:EksCluster    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.
- AccountId string
- ID of AWS account
- AssumeRole stringArn 
- AWS IAM role ARN that will be assumed by CAST AI user. This role should allow sts:AssumeRoleaction for CAST AI user.
- ClusterToken string
- computed value to store cluster token
- CredentialsId string
- CAST AI internal credentials ID
- DeleteNodes boolOn Disconnect 
- Should CAST AI remove nodes managed by CAST AI on disconnect
- Name string
- name of your EKS cluster
- Region string
- AWS region where the cluster is placed
- AccountId string
- ID of AWS account
- AssumeRole stringArn 
- AWS IAM role ARN that will be assumed by CAST AI user. This role should allow sts:AssumeRoleaction for CAST AI user.
- ClusterToken string
- computed value to store cluster token
- CredentialsId string
- CAST AI internal credentials ID
- DeleteNodes boolOn Disconnect 
- Should CAST AI remove nodes managed by CAST AI on disconnect
- Name string
- name of your EKS cluster
- Region string
- AWS region where the cluster is placed
- accountId String
- ID of AWS account
- assumeRole StringArn 
- AWS IAM role ARN that will be assumed by CAST AI user. This role should allow sts:AssumeRoleaction for CAST AI user.
- clusterToken String
- computed value to store cluster token
- credentialsId String
- CAST AI internal credentials ID
- deleteNodes BooleanOn Disconnect 
- Should CAST AI remove nodes managed by CAST AI on disconnect
- name String
- name of your EKS cluster
- region String
- AWS region where the cluster is placed
- accountId string
- ID of AWS account
- assumeRole stringArn 
- AWS IAM role ARN that will be assumed by CAST AI user. This role should allow sts:AssumeRoleaction for CAST AI user.
- clusterToken string
- computed value to store cluster token
- credentialsId string
- CAST AI internal credentials ID
- deleteNodes booleanOn Disconnect 
- Should CAST AI remove nodes managed by CAST AI on disconnect
- name string
- name of your EKS cluster
- region string
- AWS region where the cluster is placed
- account_id str
- ID of AWS account
- assume_role_ strarn 
- AWS IAM role ARN that will be assumed by CAST AI user. This role should allow sts:AssumeRoleaction for CAST AI user.
- cluster_token str
- computed value to store cluster token
- credentials_id str
- CAST AI internal credentials ID
- delete_nodes_ boolon_ disconnect 
- Should CAST AI remove nodes managed by CAST AI on disconnect
- name str
- name of your EKS cluster
- region str
- AWS region where the cluster is placed
- accountId String
- ID of AWS account
- assumeRole StringArn 
- AWS IAM role ARN that will be assumed by CAST AI user. This role should allow sts:AssumeRoleaction for CAST AI user.
- clusterToken String
- computed value to store cluster token
- credentialsId String
- CAST AI internal credentials ID
- deleteNodes BooleanOn Disconnect 
- Should CAST AI remove nodes managed by CAST AI on disconnect
- name String
- name of your EKS cluster
- region String
- AWS region where the cluster is placed
Package Details
- Repository
- castai castai/pulumi-castai
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the castaiTerraform Provider.
 
