AWS Native is in preview. AWS Classic is fully supported.
aws-native.eks.getCluster
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
An object representing an Amazon EKS cluster.
Using getCluster
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>
def get_cluster(name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]
func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput
> Note: This function is named LookupCluster
in the Go SDK.
public static class GetCluster
{
public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:eks:getCluster
arguments:
# arguments dictionary
The following arguments are supported:
- Name string
The unique name to give to your cluster.
- Name string
The unique name to give to your cluster.
- name String
The unique name to give to your cluster.
- name string
The unique name to give to your cluster.
- name str
The unique name to give to your cluster.
- name String
The unique name to give to your cluster.
getCluster Result
The following output properties are available:
- Arn string
The ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod.
- string
The certificate-authority-data for your cluster.
- Cluster
Security stringGroup Id The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control plane to data plane communication.
- Encryption
Config stringKey Arn Amazon Resource Name (ARN) or alias of the customer master key (CMK).
- Endpoint string
The endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com.
- Id string
The unique ID given to your cluster.
- Logging
Pulumi.
Aws Native. Eks. Outputs. Logging - Open
Id stringConnect Issuer Url The issuer URL for the cluster's OIDC identity provider, such as https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E. If you need to remove https:// from this output value, you can include the following code in your template.
- Resources
Vpc Pulumi.Config Aws Native. Eks. Outputs. Cluster Resources Vpc Config - List<Pulumi.
Aws Native. Eks. Outputs. Cluster Tag> An array of key-value pairs to apply to this resource.
- Version string
The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used.
- Arn string
The ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod.
- string
The certificate-authority-data for your cluster.
- Cluster
Security stringGroup Id The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control plane to data plane communication.
- Encryption
Config stringKey Arn Amazon Resource Name (ARN) or alias of the customer master key (CMK).
- Endpoint string
The endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com.
- Id string
The unique ID given to your cluster.
- Logging Logging
- Open
Id stringConnect Issuer Url The issuer URL for the cluster's OIDC identity provider, such as https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E. If you need to remove https:// from this output value, you can include the following code in your template.
- Resources
Vpc ClusterConfig Resources Vpc Config - []Cluster
Tag An array of key-value pairs to apply to this resource.
- Version string
The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used.
- arn String
The ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod.
- String
The certificate-authority-data for your cluster.
- cluster
Security StringGroup Id The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control plane to data plane communication.
- encryption
Config StringKey Arn Amazon Resource Name (ARN) or alias of the customer master key (CMK).
- endpoint String
The endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com.
- id String
The unique ID given to your cluster.
- logging Logging
- open
Id StringConnect Issuer Url The issuer URL for the cluster's OIDC identity provider, such as https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E. If you need to remove https:// from this output value, you can include the following code in your template.
- resources
Vpc ClusterConfig Resources Vpc Config - List<Cluster
Tag> An array of key-value pairs to apply to this resource.
- version String
The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used.
- arn string
The ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod.
- string
The certificate-authority-data for your cluster.
- cluster
Security stringGroup Id The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control plane to data plane communication.
- encryption
Config stringKey Arn Amazon Resource Name (ARN) or alias of the customer master key (CMK).
- endpoint string
The endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com.
- id string
The unique ID given to your cluster.
- logging Logging
- open
Id stringConnect Issuer Url The issuer URL for the cluster's OIDC identity provider, such as https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E. If you need to remove https:// from this output value, you can include the following code in your template.
- resources
Vpc ClusterConfig Resources Vpc Config - Cluster
Tag[] An array of key-value pairs to apply to this resource.
- version string
The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used.
- arn str
The ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod.
- str
The certificate-authority-data for your cluster.
- cluster_
security_ strgroup_ id The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control plane to data plane communication.
- encryption_
config_ strkey_ arn Amazon Resource Name (ARN) or alias of the customer master key (CMK).
- endpoint str
The endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com.
- id str
The unique ID given to your cluster.
- logging Logging
- open_
id_ strconnect_ issuer_ url The issuer URL for the cluster's OIDC identity provider, such as https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E. If you need to remove https:// from this output value, you can include the following code in your template.
- resources_
vpc_ Clusterconfig Resources Vpc Config - Sequence[Cluster
Tag] An array of key-value pairs to apply to this resource.
- version str
The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used.
- arn String
The ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod.
- String
The certificate-authority-data for your cluster.
- cluster
Security StringGroup Id The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control plane to data plane communication.
- encryption
Config StringKey Arn Amazon Resource Name (ARN) or alias of the customer master key (CMK).
- endpoint String
The endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com.
- id String
The unique ID given to your cluster.
- logging Property Map
- open
Id StringConnect Issuer Url The issuer URL for the cluster's OIDC identity provider, such as https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E. If you need to remove https:// from this output value, you can include the following code in your template.
- resources
Vpc Property MapConfig - List<Property Map>
An array of key-value pairs to apply to this resource.
- version String
The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used.
Supporting Types
ClusterLoggingEnabledTypes
ClusterLoggingTypeConfig
- Type
Pulumi.
Aws Native. Eks. Cluster Logging Type Config Type name of the log type
- Type
Cluster
Logging Type Config Type name of the log type
- type
Cluster
Logging Type Config Type name of the log type
- type
Cluster
Logging Type Config Type name of the log type
- type
Cluster
Logging Type Config Type name of the log type
- type
"api" | "audit" | "authenticator" | "controller
Manager" | "scheduler" name of the log type
ClusterLoggingTypeConfigType
ClusterResourcesVpcConfig
- Subnet
Ids List<string> Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your nodes and the Kubernetes control plane.
- Endpoint
Private boolAccess Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods.
- Endpoint
Public boolAccess Set this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server.
- Public
Access List<string>Cidrs The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks.
- Security
Group List<string>Ids Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify a security group, the default security group for your VPC is used.
- Subnet
Ids []string Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your nodes and the Kubernetes control plane.
- Endpoint
Private boolAccess Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods.
- Endpoint
Public boolAccess Set this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server.
- Public
Access []stringCidrs The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks.
- Security
Group []stringIds Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify a security group, the default security group for your VPC is used.
- subnet
Ids List<String> Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your nodes and the Kubernetes control plane.
- endpoint
Private BooleanAccess Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods.
- endpoint
Public BooleanAccess Set this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server.
- public
Access List<String>Cidrs The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks.
- security
Group List<String>Ids Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify a security group, the default security group for your VPC is used.
- subnet
Ids string[] Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your nodes and the Kubernetes control plane.
- endpoint
Private booleanAccess Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods.
- endpoint
Public booleanAccess Set this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server.
- public
Access string[]Cidrs The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks.
- security
Group string[]Ids Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify a security group, the default security group for your VPC is used.
- subnet_
ids Sequence[str] Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your nodes and the Kubernetes control plane.
- endpoint_
private_ boolaccess Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods.
- endpoint_
public_ boolaccess Set this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server.
- public_
access_ Sequence[str]cidrs The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks.
- security_
group_ Sequence[str]ids Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify a security group, the default security group for your VPC is used.
- subnet
Ids List<String> Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your nodes and the Kubernetes control plane.
- endpoint
Private BooleanAccess Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods.
- endpoint
Public BooleanAccess Set this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server.
- public
Access List<String>Cidrs The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks.
- security
Group List<String>Ids Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify a security group, the default security group for your VPC is used.
ClusterTag
- Key string
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Key string
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key string
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value string
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key str
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value str
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Logging
- Cluster
Logging Pulumi.Value Aws Native. Eks. Inputs. Cluster Logging Enabled Types The cluster control plane logging configuration for your cluster.
- Cluster
Logging ClusterLogging Enabled Types The cluster control plane logging configuration for your cluster.
- cluster
Logging ClusterLogging Enabled Types The cluster control plane logging configuration for your cluster.
- cluster
Logging ClusterLogging Enabled Types The cluster control plane logging configuration for your cluster.
- cluster_
logging ClusterLogging Enabled Types The cluster control plane logging configuration for your cluster.
- cluster
Logging Property Map The cluster control plane logging configuration for your cluster.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.