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

castai.EksCluster

Explore with Pulumi AI

castai logo
CAST AI v0.1.45 published on Thursday, Apr 17, 2025 by CAST 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,
                   region: Optional[str] = None,
                   account_id: Optional[str] = None,
                   name: Optional[str] = None,
                   delete_nodes_on_disconnect: Optional[bool] = None,
                   dns_cluster_ip: Optional[str] = None,
                   instance_profile_arn: Optional[str] = None,
                   access_key_id: Optional[str] = None,
                   override_security_groups: Optional[Sequence[str]] = None,
                   assume_role_arn: Optional[str] = None,
                   secret_access_key: Optional[str] = None,
                   ssh_public_key: Optional[str] = None,
                   subnets: Optional[Sequence[str]] = None,
                   tags: Optional[Mapping[str, 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
    AccessKeyId string
    AWS access key ID of the CAST AI IAM account
    AssumeRoleArn string
    AWS ARN for assume role that should be used instead of IAM account
    DeleteNodesOnDisconnect bool
    Should CAST AI remove nodes managed by CAST AI on disconnect
    DnsClusterIp string
    Overrides the IP address to use for DNS queries within the cluster. Defaults to 10.100.0.10 or 172.20.0.10 based on the IP address of the primary interface
    InstanceProfileArn string
    AWS ARN of the instance profile to be used by CAST AI
    Name string
    name of your EKS cluster
    OverrideSecurityGroups List<string>
    Optional custom security groups for the cluster. If not set security groups from the EKS cluster configuration are used.
    SecretAccessKey string
    AWS secret access key of the CAST AI IAM account
    SshPublicKey string
    Accepted values are base64 encoded SSH public key or AWS key pair ID.
    Subnets List<string>
    Custom subnets for the cluster. If not set subnets from the EKS cluster configuration are used.
    Tags Dictionary<string, string>
    Tags which should be added to CAST AI nodes
    AccountId string
    ID of AWS account
    Region string
    AWS region where the cluster is placed
    AccessKeyId string
    AWS access key ID of the CAST AI IAM account
    AssumeRoleArn string
    AWS ARN for assume role that should be used instead of IAM account
    DeleteNodesOnDisconnect bool
    Should CAST AI remove nodes managed by CAST AI on disconnect
    DnsClusterIp string
    Overrides the IP address to use for DNS queries within the cluster. Defaults to 10.100.0.10 or 172.20.0.10 based on the IP address of the primary interface
    InstanceProfileArn string
    AWS ARN of the instance profile to be used by CAST AI
    Name string
    name of your EKS cluster
    OverrideSecurityGroups []string
    Optional custom security groups for the cluster. If not set security groups from the EKS cluster configuration are used.
    SecretAccessKey string
    AWS secret access key of the CAST AI IAM account
    SshPublicKey string
    Accepted values are base64 encoded SSH public key or AWS key pair ID.
    Subnets []string
    Custom subnets for the cluster. If not set subnets from the EKS cluster configuration are used.
    Tags map[string]string
    Tags which should be added to CAST AI nodes
    accountId String
    ID of AWS account
    region String
    AWS region where the cluster is placed
    accessKeyId String
    AWS access key ID of the CAST AI IAM account
    assumeRoleArn String
    AWS ARN for assume role that should be used instead of IAM account
    deleteNodesOnDisconnect Boolean
    Should CAST AI remove nodes managed by CAST AI on disconnect
    dnsClusterIp String
    Overrides the IP address to use for DNS queries within the cluster. Defaults to 10.100.0.10 or 172.20.0.10 based on the IP address of the primary interface
    instanceProfileArn String
    AWS ARN of the instance profile to be used by CAST AI
    name String
    name of your EKS cluster
    overrideSecurityGroups List<String>
    Optional custom security groups for the cluster. If not set security groups from the EKS cluster configuration are used.
    secretAccessKey String
    AWS secret access key of the CAST AI IAM account
    sshPublicKey String
    Accepted values are base64 encoded SSH public key or AWS key pair ID.
    subnets List<String>
    Custom subnets for the cluster. If not set subnets from the EKS cluster configuration are used.
    tags Map<String,String>
    Tags which should be added to CAST AI nodes
    accountId string
    ID of AWS account
    region string
    AWS region where the cluster is placed
    accessKeyId string
    AWS access key ID of the CAST AI IAM account
    assumeRoleArn string
    AWS ARN for assume role that should be used instead of IAM account
    deleteNodesOnDisconnect boolean
    Should CAST AI remove nodes managed by CAST AI on disconnect
    dnsClusterIp string
    Overrides the IP address to use for DNS queries within the cluster. Defaults to 10.100.0.10 or 172.20.0.10 based on the IP address of the primary interface
    instanceProfileArn string
    AWS ARN of the instance profile to be used by CAST AI
    name string
    name of your EKS cluster
    overrideSecurityGroups string[]
    Optional custom security groups for the cluster. If not set security groups from the EKS cluster configuration are used.
    secretAccessKey string
    AWS secret access key of the CAST AI IAM account
    sshPublicKey string
    Accepted values are base64 encoded SSH public key or AWS key pair ID.
    subnets string[]
    Custom subnets for the cluster. If not set subnets from the EKS cluster configuration are used.
    tags {[key: string]: string}
    Tags which should be added to CAST AI nodes
    account_id str
    ID of AWS account
    region str
    AWS region where the cluster is placed
    access_key_id str
    AWS access key ID of the CAST AI IAM account
    assume_role_arn str
    AWS ARN for assume role that should be used instead of IAM account
    delete_nodes_on_disconnect bool
    Should CAST AI remove nodes managed by CAST AI on disconnect
    dns_cluster_ip str
    Overrides the IP address to use for DNS queries within the cluster. Defaults to 10.100.0.10 or 172.20.0.10 based on the IP address of the primary interface
    instance_profile_arn str
    AWS ARN of the instance profile to be used by CAST AI
    name str
    name of your EKS cluster
    override_security_groups Sequence[str]
    Optional custom security groups for the cluster. If not set security groups from the EKS cluster configuration are used.
    secret_access_key str
    AWS secret access key of the CAST AI IAM account
    ssh_public_key str
    Accepted values are base64 encoded SSH public key or AWS key pair ID.
    subnets Sequence[str]
    Custom subnets for the cluster. If not set subnets from the EKS cluster configuration are used.
    tags Mapping[str, str]
    Tags which should be added to CAST AI nodes
    accountId String
    ID of AWS account
    region String
    AWS region where the cluster is placed
    accessKeyId String
    AWS access key ID of the CAST AI IAM account
    assumeRoleArn String
    AWS ARN for assume role that should be used instead of IAM account
    deleteNodesOnDisconnect Boolean
    Should CAST AI remove nodes managed by CAST AI on disconnect
    dnsClusterIp String
    Overrides the IP address to use for DNS queries within the cluster. Defaults to 10.100.0.10 or 172.20.0.10 based on the IP address of the primary interface
    instanceProfileArn String
    AWS ARN of the instance profile to be used by CAST AI
    name String
    name of your EKS cluster
    overrideSecurityGroups List<String>
    Optional custom security groups for the cluster. If not set security groups from the EKS cluster configuration are used.
    secretAccessKey String
    AWS secret access key of the CAST AI IAM account
    sshPublicKey String
    Accepted values are base64 encoded SSH public key or AWS key pair ID.
    subnets List<String>
    Custom subnets for the cluster. If not set subnets from the EKS cluster configuration are used.
    tags Map<String>
    Tags which should be added to CAST AI nodes

    Outputs

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

    AgentToken string

    Deprecated: agent_token is deprecated, use cluster_token instead

    CredentialsId string
    CAST AI internal credentials ID
    Id string
    The provider-assigned unique ID for this managed resource.
    SecurityGroups List<string>
    IDs of security groups that are used by CAST AI
    AgentToken string

    Deprecated: agent_token is deprecated, use cluster_token instead

    CredentialsId string
    CAST AI internal credentials ID
    Id string
    The provider-assigned unique ID for this managed resource.
    SecurityGroups []string
    IDs of security groups that are used by CAST AI
    agentToken String

    Deprecated: agent_token is deprecated, use cluster_token instead

    credentialsId String
    CAST AI internal credentials ID
    id String
    The provider-assigned unique ID for this managed resource.
    securityGroups List<String>
    IDs of security groups that are used by CAST AI
    agentToken string

    Deprecated: agent_token is deprecated, use cluster_token instead

    credentialsId string
    CAST AI internal credentials ID
    id string
    The provider-assigned unique ID for this managed resource.
    securityGroups string[]
    IDs of security groups that are used by CAST AI
    agent_token str

    Deprecated: agent_token is deprecated, use cluster_token instead

    credentials_id str
    CAST AI internal credentials ID
    id str
    The provider-assigned unique ID for this managed resource.
    security_groups Sequence[str]
    IDs of security groups that are used by CAST AI
    agentToken String

    Deprecated: agent_token is deprecated, use cluster_token instead

    credentialsId String
    CAST AI internal credentials ID
    id String
    The provider-assigned unique ID for this managed resource.
    securityGroups List<String>
    IDs of security groups that are used by CAST AI

    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,
            access_key_id: Optional[str] = None,
            account_id: Optional[str] = None,
            agent_token: Optional[str] = None,
            assume_role_arn: Optional[str] = None,
            credentials_id: Optional[str] = None,
            delete_nodes_on_disconnect: Optional[bool] = None,
            dns_cluster_ip: Optional[str] = None,
            instance_profile_arn: Optional[str] = None,
            name: Optional[str] = None,
            override_security_groups: Optional[Sequence[str]] = None,
            region: Optional[str] = None,
            secret_access_key: Optional[str] = None,
            security_groups: Optional[Sequence[str]] = None,
            ssh_public_key: Optional[str] = None,
            subnets: Optional[Sequence[str]] = None,
            tags: Optional[Mapping[str, str]] = 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: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.
    The following state arguments are supported:
    AccessKeyId string
    AWS access key ID of the CAST AI IAM account
    AccountId string
    ID of AWS account
    AgentToken string

    Deprecated: agent_token is deprecated, use cluster_token instead

    AssumeRoleArn string
    AWS ARN for assume role that should be used instead of IAM account
    CredentialsId string
    CAST AI internal credentials ID
    DeleteNodesOnDisconnect bool
    Should CAST AI remove nodes managed by CAST AI on disconnect
    DnsClusterIp string
    Overrides the IP address to use for DNS queries within the cluster. Defaults to 10.100.0.10 or 172.20.0.10 based on the IP address of the primary interface
    InstanceProfileArn string
    AWS ARN of the instance profile to be used by CAST AI
    Name string
    name of your EKS cluster
    OverrideSecurityGroups List<string>
    Optional custom security groups for the cluster. If not set security groups from the EKS cluster configuration are used.
    Region string
    AWS region where the cluster is placed
    SecretAccessKey string
    AWS secret access key of the CAST AI IAM account
    SecurityGroups List<string>
    IDs of security groups that are used by CAST AI
    SshPublicKey string
    Accepted values are base64 encoded SSH public key or AWS key pair ID.
    Subnets List<string>
    Custom subnets for the cluster. If not set subnets from the EKS cluster configuration are used.
    Tags Dictionary<string, string>
    Tags which should be added to CAST AI nodes
    AccessKeyId string
    AWS access key ID of the CAST AI IAM account
    AccountId string
    ID of AWS account
    AgentToken string

    Deprecated: agent_token is deprecated, use cluster_token instead

    AssumeRoleArn string
    AWS ARN for assume role that should be used instead of IAM account
    CredentialsId string
    CAST AI internal credentials ID
    DeleteNodesOnDisconnect bool
    Should CAST AI remove nodes managed by CAST AI on disconnect
    DnsClusterIp string
    Overrides the IP address to use for DNS queries within the cluster. Defaults to 10.100.0.10 or 172.20.0.10 based on the IP address of the primary interface
    InstanceProfileArn string
    AWS ARN of the instance profile to be used by CAST AI
    Name string
    name of your EKS cluster
    OverrideSecurityGroups []string
    Optional custom security groups for the cluster. If not set security groups from the EKS cluster configuration are used.
    Region string
    AWS region where the cluster is placed
    SecretAccessKey string
    AWS secret access key of the CAST AI IAM account
    SecurityGroups []string
    IDs of security groups that are used by CAST AI
    SshPublicKey string
    Accepted values are base64 encoded SSH public key or AWS key pair ID.
    Subnets []string
    Custom subnets for the cluster. If not set subnets from the EKS cluster configuration are used.
    Tags map[string]string
    Tags which should be added to CAST AI nodes
    accessKeyId String
    AWS access key ID of the CAST AI IAM account
    accountId String
    ID of AWS account
    agentToken String

    Deprecated: agent_token is deprecated, use cluster_token instead

    assumeRoleArn String
    AWS ARN for assume role that should be used instead of IAM account
    credentialsId String
    CAST AI internal credentials ID
    deleteNodesOnDisconnect Boolean
    Should CAST AI remove nodes managed by CAST AI on disconnect
    dnsClusterIp String
    Overrides the IP address to use for DNS queries within the cluster. Defaults to 10.100.0.10 or 172.20.0.10 based on the IP address of the primary interface
    instanceProfileArn String
    AWS ARN of the instance profile to be used by CAST AI
    name String
    name of your EKS cluster
    overrideSecurityGroups List<String>
    Optional custom security groups for the cluster. If not set security groups from the EKS cluster configuration are used.
    region String
    AWS region where the cluster is placed
    secretAccessKey String
    AWS secret access key of the CAST AI IAM account
    securityGroups List<String>
    IDs of security groups that are used by CAST AI
    sshPublicKey String
    Accepted values are base64 encoded SSH public key or AWS key pair ID.
    subnets List<String>
    Custom subnets for the cluster. If not set subnets from the EKS cluster configuration are used.
    tags Map<String,String>
    Tags which should be added to CAST AI nodes
    accessKeyId string
    AWS access key ID of the CAST AI IAM account
    accountId string
    ID of AWS account
    agentToken string

    Deprecated: agent_token is deprecated, use cluster_token instead

    assumeRoleArn string
    AWS ARN for assume role that should be used instead of IAM account
    credentialsId string
    CAST AI internal credentials ID
    deleteNodesOnDisconnect boolean
    Should CAST AI remove nodes managed by CAST AI on disconnect
    dnsClusterIp string
    Overrides the IP address to use for DNS queries within the cluster. Defaults to 10.100.0.10 or 172.20.0.10 based on the IP address of the primary interface
    instanceProfileArn string
    AWS ARN of the instance profile to be used by CAST AI
    name string
    name of your EKS cluster
    overrideSecurityGroups string[]
    Optional custom security groups for the cluster. If not set security groups from the EKS cluster configuration are used.
    region string
    AWS region where the cluster is placed
    secretAccessKey string
    AWS secret access key of the CAST AI IAM account
    securityGroups string[]
    IDs of security groups that are used by CAST AI
    sshPublicKey string
    Accepted values are base64 encoded SSH public key or AWS key pair ID.
    subnets string[]
    Custom subnets for the cluster. If not set subnets from the EKS cluster configuration are used.
    tags {[key: string]: string}
    Tags which should be added to CAST AI nodes
    access_key_id str
    AWS access key ID of the CAST AI IAM account
    account_id str
    ID of AWS account
    agent_token str

    Deprecated: agent_token is deprecated, use cluster_token instead

    assume_role_arn str
    AWS ARN for assume role that should be used instead of IAM account
    credentials_id str
    CAST AI internal credentials ID
    delete_nodes_on_disconnect bool
    Should CAST AI remove nodes managed by CAST AI on disconnect
    dns_cluster_ip str
    Overrides the IP address to use for DNS queries within the cluster. Defaults to 10.100.0.10 or 172.20.0.10 based on the IP address of the primary interface
    instance_profile_arn str
    AWS ARN of the instance profile to be used by CAST AI
    name str
    name of your EKS cluster
    override_security_groups Sequence[str]
    Optional custom security groups for the cluster. If not set security groups from the EKS cluster configuration are used.
    region str
    AWS region where the cluster is placed
    secret_access_key str
    AWS secret access key of the CAST AI IAM account
    security_groups Sequence[str]
    IDs of security groups that are used by CAST AI
    ssh_public_key str
    Accepted values are base64 encoded SSH public key or AWS key pair ID.
    subnets Sequence[str]
    Custom subnets for the cluster. If not set subnets from the EKS cluster configuration are used.
    tags Mapping[str, str]
    Tags which should be added to CAST AI nodes
    accessKeyId String
    AWS access key ID of the CAST AI IAM account
    accountId String
    ID of AWS account
    agentToken String

    Deprecated: agent_token is deprecated, use cluster_token instead

    assumeRoleArn String
    AWS ARN for assume role that should be used instead of IAM account
    credentialsId String
    CAST AI internal credentials ID
    deleteNodesOnDisconnect Boolean
    Should CAST AI remove nodes managed by CAST AI on disconnect
    dnsClusterIp String
    Overrides the IP address to use for DNS queries within the cluster. Defaults to 10.100.0.10 or 172.20.0.10 based on the IP address of the primary interface
    instanceProfileArn String
    AWS ARN of the instance profile to be used by CAST AI
    name String
    name of your EKS cluster
    overrideSecurityGroups List<String>
    Optional custom security groups for the cluster. If not set security groups from the EKS cluster configuration are used.
    region String
    AWS region where the cluster is placed
    secretAccessKey String
    AWS secret access key of the CAST AI IAM account
    securityGroups List<String>
    IDs of security groups that are used by CAST AI
    sshPublicKey String
    Accepted values are base64 encoded SSH public key or AWS key pair ID.
    subnets List<String>
    Custom subnets for the cluster. If not set subnets from the EKS cluster configuration are used.
    tags Map<String>
    Tags which should be added to CAST AI 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