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,
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:
- Account
Id string - ID of AWS account
- Region string
- AWS region where the cluster is placed
- Access
Key stringId - AWS access key ID of the CAST AI IAM account
- Assume
Role stringArn - AWS ARN for assume role that should be used instead of IAM account
- Delete
Nodes boolOn Disconnect - Should CAST AI remove nodes managed by CAST AI on disconnect
- Dns
Cluster stringIp - 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 stringArn - AWS ARN of the instance profile to be used by CAST AI
- Name string
- name of your EKS cluster
- Override
Security List<string>Groups - Optional custom security groups for the cluster. If not set security groups from the EKS cluster configuration are used.
- Secret
Access stringKey - AWS secret access key of the CAST AI IAM account
- Ssh
Public stringKey - 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.
- Dictionary<string, string>
- Tags which should be added to CAST AI nodes
- Account
Id string - ID of AWS account
- Region string
- AWS region where the cluster is placed
- Access
Key stringId - AWS access key ID of the CAST AI IAM account
- Assume
Role stringArn - AWS ARN for assume role that should be used instead of IAM account
- Delete
Nodes boolOn Disconnect - Should CAST AI remove nodes managed by CAST AI on disconnect
- Dns
Cluster stringIp - 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 stringArn - AWS ARN of the instance profile to be used by CAST AI
- Name string
- name of your EKS cluster
- Override
Security []stringGroups - Optional custom security groups for the cluster. If not set security groups from the EKS cluster configuration are used.
- Secret
Access stringKey - AWS secret access key of the CAST AI IAM account
- Ssh
Public stringKey - 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.
- map[string]string
- Tags which should be added to CAST AI nodes
- account
Id String - ID of AWS account
- region String
- AWS region where the cluster is placed
- access
Key StringId - AWS access key ID of the CAST AI IAM account
- assume
Role StringArn - AWS ARN for assume role that should be used instead of IAM account
- delete
Nodes BooleanOn Disconnect - Should CAST AI remove nodes managed by CAST AI on disconnect
- dns
Cluster StringIp - 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 StringArn - AWS ARN of the instance profile to be used by CAST AI
- name String
- name of your EKS cluster
- override
Security List<String>Groups - Optional custom security groups for the cluster. If not set security groups from the EKS cluster configuration are used.
- secret
Access StringKey - AWS secret access key of the CAST AI IAM account
- ssh
Public StringKey - 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.
- Map<String,String>
- Tags which should be added to CAST AI nodes
- account
Id string - ID of AWS account
- region string
- AWS region where the cluster is placed
- access
Key stringId - AWS access key ID of the CAST AI IAM account
- assume
Role stringArn - AWS ARN for assume role that should be used instead of IAM account
- delete
Nodes booleanOn Disconnect - Should CAST AI remove nodes managed by CAST AI on disconnect
- dns
Cluster stringIp - 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 stringArn - AWS ARN of the instance profile to be used by CAST AI
- name string
- name of your EKS cluster
- override
Security string[]Groups - Optional custom security groups for the cluster. If not set security groups from the EKS cluster configuration are used.
- secret
Access stringKey - AWS secret access key of the CAST AI IAM account
- ssh
Public stringKey - 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.
- {[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_ strid - AWS access key ID of the CAST AI IAM account
- assume_
role_ strarn - AWS ARN for assume role that should be used instead of IAM account
- delete_
nodes_ boolon_ disconnect - Should CAST AI remove nodes managed by CAST AI on disconnect
- dns_
cluster_ strip - 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_ strarn - AWS ARN of the instance profile to be used by CAST AI
- name str
- name of your EKS cluster
- override_
security_ Sequence[str]groups - Optional custom security groups for the cluster. If not set security groups from the EKS cluster configuration are used.
- secret_
access_ strkey - AWS secret access key of the CAST AI IAM account
- ssh_
public_ strkey - 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.
- Mapping[str, str]
- Tags which should be added to CAST AI nodes
- account
Id String - ID of AWS account
- region String
- AWS region where the cluster is placed
- access
Key StringId - AWS access key ID of the CAST AI IAM account
- assume
Role StringArn - AWS ARN for assume role that should be used instead of IAM account
- delete
Nodes BooleanOn Disconnect - Should CAST AI remove nodes managed by CAST AI on disconnect
- dns
Cluster StringIp - 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 StringArn - AWS ARN of the instance profile to be used by CAST AI
- name String
- name of your EKS cluster
- override
Security List<String>Groups - Optional custom security groups for the cluster. If not set security groups from the EKS cluster configuration are used.
- secret
Access StringKey - AWS secret access key of the CAST AI IAM account
- ssh
Public StringKey - 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.
- 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:
- Agent
Token string - Credentials
Id string - CAST AI internal credentials ID
- Id string
- The provider-assigned unique ID for this managed resource.
- Security
Groups List<string> - IDs of security groups that are used by CAST AI
- Agent
Token string - Credentials
Id string - CAST AI internal credentials ID
- Id string
- The provider-assigned unique ID for this managed resource.
- Security
Groups []string - IDs of security groups that are used by CAST AI
- agent
Token String - credentials
Id String - CAST AI internal credentials ID
- id String
- The provider-assigned unique ID for this managed resource.
- security
Groups List<String> - IDs of security groups that are used by CAST AI
- agent
Token string - credentials
Id string - CAST AI internal credentials ID
- id string
- The provider-assigned unique ID for this managed resource.
- security
Groups string[] - IDs of security groups that are used by CAST AI
- agent_
token str - 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
- agent
Token String - credentials
Id String - CAST AI internal credentials ID
- id String
- The provider-assigned unique ID for this managed resource.
- security
Groups 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.
- Access
Key stringId - AWS access key ID of the CAST AI IAM account
- Account
Id string - ID of AWS account
- Agent
Token string - Assume
Role stringArn - AWS ARN for assume role that should be used instead of IAM account
- Credentials
Id string - CAST AI internal credentials ID
- Delete
Nodes boolOn Disconnect - Should CAST AI remove nodes managed by CAST AI on disconnect
- Dns
Cluster stringIp - 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 stringArn - AWS ARN of the instance profile to be used by CAST AI
- Name string
- name of your EKS cluster
- Override
Security List<string>Groups - 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
- Secret
Access stringKey - AWS secret access key of the CAST AI IAM account
- Security
Groups List<string> - IDs of security groups that are used by CAST AI
- Ssh
Public stringKey - 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.
- Dictionary<string, string>
- Tags which should be added to CAST AI nodes
- Access
Key stringId - AWS access key ID of the CAST AI IAM account
- Account
Id string - ID of AWS account
- Agent
Token string - Assume
Role stringArn - AWS ARN for assume role that should be used instead of IAM account
- Credentials
Id string - CAST AI internal credentials ID
- Delete
Nodes boolOn Disconnect - Should CAST AI remove nodes managed by CAST AI on disconnect
- Dns
Cluster stringIp - 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 stringArn - AWS ARN of the instance profile to be used by CAST AI
- Name string
- name of your EKS cluster
- Override
Security []stringGroups - 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
- Secret
Access stringKey - AWS secret access key of the CAST AI IAM account
- Security
Groups []string - IDs of security groups that are used by CAST AI
- Ssh
Public stringKey - 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.
- map[string]string
- Tags which should be added to CAST AI nodes
- access
Key StringId - AWS access key ID of the CAST AI IAM account
- account
Id String - ID of AWS account
- agent
Token String - assume
Role StringArn - AWS ARN for assume role that should be used instead of IAM account
- credentials
Id String - CAST AI internal credentials ID
- delete
Nodes BooleanOn Disconnect - Should CAST AI remove nodes managed by CAST AI on disconnect
- dns
Cluster StringIp - 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 StringArn - AWS ARN of the instance profile to be used by CAST AI
- name String
- name of your EKS cluster
- override
Security List<String>Groups - 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
- secret
Access StringKey - AWS secret access key of the CAST AI IAM account
- security
Groups List<String> - IDs of security groups that are used by CAST AI
- ssh
Public StringKey - 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.
- Map<String,String>
- Tags which should be added to CAST AI nodes
- access
Key stringId - AWS access key ID of the CAST AI IAM account
- account
Id string - ID of AWS account
- agent
Token string - assume
Role stringArn - AWS ARN for assume role that should be used instead of IAM account
- credentials
Id string - CAST AI internal credentials ID
- delete
Nodes booleanOn Disconnect - Should CAST AI remove nodes managed by CAST AI on disconnect
- dns
Cluster stringIp - 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 stringArn - AWS ARN of the instance profile to be used by CAST AI
- name string
- name of your EKS cluster
- override
Security string[]Groups - 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
- secret
Access stringKey - AWS secret access key of the CAST AI IAM account
- security
Groups string[] - IDs of security groups that are used by CAST AI
- ssh
Public stringKey - 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.
- {[key: string]: string}
- Tags which should be added to CAST AI nodes
- access_
key_ strid - AWS access key ID of the CAST AI IAM account
- account_
id str - ID of AWS account
- agent_
token str - assume_
role_ strarn - AWS ARN for assume role that should be used instead of IAM account
- credentials_
id str - CAST AI internal credentials ID
- delete_
nodes_ boolon_ disconnect - Should CAST AI remove nodes managed by CAST AI on disconnect
- dns_
cluster_ strip - 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_ strarn - AWS ARN of the instance profile to be used by CAST AI
- name str
- name of your EKS cluster
- override_
security_ Sequence[str]groups - 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_ strkey - 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_ strkey - 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.
- Mapping[str, str]
- Tags which should be added to CAST AI nodes
- access
Key StringId - AWS access key ID of the CAST AI IAM account
- account
Id String - ID of AWS account
- agent
Token String - assume
Role StringArn - AWS ARN for assume role that should be used instead of IAM account
- credentials
Id String - CAST AI internal credentials ID
- delete
Nodes BooleanOn Disconnect - Should CAST AI remove nodes managed by CAST AI on disconnect
- dns
Cluster StringIp - 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 StringArn - AWS ARN of the instance profile to be used by CAST AI
- name String
- name of your EKS cluster
- override
Security List<String>Groups - 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
- secret
Access StringKey - AWS secret access key of the CAST AI IAM account
- security
Groups List<String> - IDs of security groups that are used by CAST AI
- ssh
Public StringKey - 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.
- 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.