getCluster
Retrieve information about an EKS Cluster.
Using getCluster
function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
def get_cluster(name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
opts: Optional[InvokeOptions] = None) -> GetClusterResult
func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
Note: This function is named
LookupCluster
in the Go SDK.
public static class GetCluster {
public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
}
The following arguments are supported:
- Name string
- The name of the cluster
- Dictionary<string, string>
- Key-value map of resource tags.
- Name string
- The name of the cluster
- map[string]string
- Key-value map of resource tags.
- name string
- The name of the cluster
- {[key: string]: string}
- Key-value map of resource tags.
- name str
- The name of the cluster
- Mapping[str, str]
- Key-value map of resource tags.
getCluster Result
The following output properties are available:
- Arn string
- The Amazon Resource Name (ARN) of the cluster.
- Get
Cluster Certificate Authority - Nested attribute containing
certificate-authority-data
for your cluster. - Created
At string - The Unix epoch time stamp in seconds for when the cluster was created.
- Enabled
Cluster List<string>Log Types - The enabled control plane logs.
- Endpoint string
- The endpoint for your Kubernetes API server.
- Id string
- The provider-assigned unique ID for this managed resource.
- Identities
List<Get
Cluster Identity> - Nested attribute containing identity provider information for your cluster. Only available on Kubernetes version 1.13 and 1.14 clusters created or upgraded on or after September 3, 2019. For an example using this information to enable IAM Roles for Service Accounts, see the
aws.eks.Cluster
resource documentation. - Kubernetes
Network List<GetConfigs Cluster Kubernetes Network Config> - Nested list containing Kubernetes Network Configuration.
- Name string
- Platform
Version string - The platform version for the cluster.
- Role
Arn string - The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
- Status string
- The status of the EKS cluster. One of
CREATING
,ACTIVE
,DELETING
,FAILED
. - Dictionary<string, string>
- Key-value map of resource tags.
- Version string
- The Kubernetes server version for the cluster.
- Vpc
Config GetCluster Vpc Config - Nested list containing VPC configuration for the cluster.
- Arn string
- The Amazon Resource Name (ARN) of the cluster.
- Get
Cluster Certificate Authority - Nested attribute containing
certificate-authority-data
for your cluster. - Created
At string - The Unix epoch time stamp in seconds for when the cluster was created.
- Enabled
Cluster []stringLog Types - The enabled control plane logs.
- Endpoint string
- The endpoint for your Kubernetes API server.
- Id string
- The provider-assigned unique ID for this managed resource.
- Identities
[]Get
Cluster Identity - Nested attribute containing identity provider information for your cluster. Only available on Kubernetes version 1.13 and 1.14 clusters created or upgraded on or after September 3, 2019. For an example using this information to enable IAM Roles for Service Accounts, see the
aws.eks.Cluster
resource documentation. - Kubernetes
Network []GetConfigs Cluster Kubernetes Network Config - Nested list containing Kubernetes Network Configuration.
- Name string
- Platform
Version string - The platform version for the cluster.
- Role
Arn string - The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
- Status string
- The status of the EKS cluster. One of
CREATING
,ACTIVE
,DELETING
,FAILED
. - map[string]string
- Key-value map of resource tags.
- Version string
- The Kubernetes server version for the cluster.
- Vpc
Config GetCluster Vpc Config - Nested list containing VPC configuration for the cluster.
- arn string
- The Amazon Resource Name (ARN) of the cluster.
- Get
Cluster Certificate Authority - Nested attribute containing
certificate-authority-data
for your cluster. - created
At string - The Unix epoch time stamp in seconds for when the cluster was created.
- enabled
Cluster string[]Log Types - The enabled control plane logs.
- endpoint string
- The endpoint for your Kubernetes API server.
- id string
- The provider-assigned unique ID for this managed resource.
- identities
Get
Cluster Identity[] - Nested attribute containing identity provider information for your cluster. Only available on Kubernetes version 1.13 and 1.14 clusters created or upgraded on or after September 3, 2019. For an example using this information to enable IAM Roles for Service Accounts, see the
aws.eks.Cluster
resource documentation. - kubernetes
Network GetConfigs Cluster Kubernetes Network Config[] - Nested list containing Kubernetes Network Configuration.
- name string
- platform
Version string - The platform version for the cluster.
- role
Arn string - The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
- status string
- The status of the EKS cluster. One of
CREATING
,ACTIVE
,DELETING
,FAILED
. - {[key: string]: string}
- Key-value map of resource tags.
- version string
- The Kubernetes server version for the cluster.
- vpc
Config GetCluster Vpc Config - Nested list containing VPC configuration for the cluster.
- arn str
- The Amazon Resource Name (ARN) of the cluster.
- Get
Cluster Certificate Authority - Nested attribute containing
certificate-authority-data
for your cluster. - created_
at str - The Unix epoch time stamp in seconds for when the cluster was created.
- enabled_
cluster_ Sequence[str]log_ types - The enabled control plane logs.
- endpoint str
- The endpoint for your Kubernetes API server.
- id str
- The provider-assigned unique ID for this managed resource.
- identities
Sequence[Get
Cluster Identity] - Nested attribute containing identity provider information for your cluster. Only available on Kubernetes version 1.13 and 1.14 clusters created or upgraded on or after September 3, 2019. For an example using this information to enable IAM Roles for Service Accounts, see the
aws.eks.Cluster
resource documentation. - kubernetes_
network_ Sequence[Getconfigs Cluster Kubernetes Network Config] - Nested list containing Kubernetes Network Configuration.
- name str
- platform_
version str - The platform version for the cluster.
- role_
arn str - The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
- status str
- The status of the EKS cluster. One of
CREATING
,ACTIVE
,DELETING
,FAILED
. - Mapping[str, str]
- Key-value map of resource tags.
- version str
- The Kubernetes server version for the cluster.
- vpc_
config GetCluster Vpc Config - Nested list containing VPC configuration for the cluster.
Supporting Types
GetClusterCertificateAuthority
- Data string
- The base64 encoded certificate data required to communicate with your cluster. Add this to the
certificate-authority-data
section of thekubeconfig
file for your cluster.
- Data string
- The base64 encoded certificate data required to communicate with your cluster. Add this to the
certificate-authority-data
section of thekubeconfig
file for your cluster.
- data string
- The base64 encoded certificate data required to communicate with your cluster. Add this to the
certificate-authority-data
section of thekubeconfig
file for your cluster.
- data str
- The base64 encoded certificate data required to communicate with your cluster. Add this to the
certificate-authority-data
section of thekubeconfig
file for your cluster.
GetClusterIdentity
- Oidcs
List<Get
Cluster Identity Oidc> - Nested attribute containing OpenID Connect identity provider information for the cluster.
- Oidcs
[]Get
Cluster Identity Oidc - Nested attribute containing OpenID Connect identity provider information for the cluster.
- oidcs
Get
Cluster Identity Oidc[] - Nested attribute containing OpenID Connect identity provider information for the cluster.
- oidcs
Sequence[Get
Cluster Identity Oidc] - Nested attribute containing OpenID Connect identity provider information for the cluster.
GetClusterIdentityOidc
- Issuer string
- Issuer URL for the OpenID Connect identity provider.
- Issuer string
- Issuer URL for the OpenID Connect identity provider.
- issuer string
- Issuer URL for the OpenID Connect identity provider.
- issuer str
- Issuer URL for the OpenID Connect identity provider.
GetClusterKubernetesNetworkConfig
- Service
Ipv4Cidr string - The CIDR block to assign Kubernetes service IP addresses from.
- Service
Ipv4Cidr string - The CIDR block to assign Kubernetes service IP addresses from.
- service
Ipv4Cidr string - The CIDR block to assign Kubernetes service IP addresses from.
- service_
ipv4_ strcidr - The CIDR block to assign Kubernetes service IP addresses from.
GetClusterVpcConfig
- Cluster
Security stringGroup Id - The cluster security group that was created by Amazon EKS for the cluster.
- Endpoint
Private boolAccess - Indicates whether or not the Amazon EKS private API server endpoint is enabled.
- Endpoint
Public boolAccess - Indicates whether or not the Amazon EKS public API server endpoint is enabled.
- Public
Access List<string>Cidrs - List of CIDR blocks. Indicates which CIDR blocks can access the Amazon EKS public API server endpoint.
- Security
Group List<string>Ids - List of security group IDs
- Subnet
Ids List<string> - List of subnet IDs
- Vpc
Id string - The VPC associated with your cluster.
- Cluster
Security stringGroup Id - The cluster security group that was created by Amazon EKS for the cluster.
- Endpoint
Private boolAccess - Indicates whether or not the Amazon EKS private API server endpoint is enabled.
- Endpoint
Public boolAccess - Indicates whether or not the Amazon EKS public API server endpoint is enabled.
- Public
Access []stringCidrs - List of CIDR blocks. Indicates which CIDR blocks can access the Amazon EKS public API server endpoint.
- Security
Group []stringIds - List of security group IDs
- Subnet
Ids []string - List of subnet IDs
- Vpc
Id string - The VPC associated with your cluster.
- cluster
Security stringGroup Id - The cluster security group that was created by Amazon EKS for the cluster.
- endpoint
Private booleanAccess - Indicates whether or not the Amazon EKS private API server endpoint is enabled.
- endpoint
Public booleanAccess - Indicates whether or not the Amazon EKS public API server endpoint is enabled.
- public
Access string[]Cidrs - List of CIDR blocks. Indicates which CIDR blocks can access the Amazon EKS public API server endpoint.
- security
Group string[]Ids - List of security group IDs
- subnet
Ids string[] - List of subnet IDs
- vpc
Id string - The VPC associated with your cluster.
- cluster_
security_ strgroup_ id - The cluster security group that was created by Amazon EKS for the cluster.
- endpoint_
private_ boolaccess - Indicates whether or not the Amazon EKS private API server endpoint is enabled.
- endpoint_
public_ boolaccess - Indicates whether or not the Amazon EKS public API server endpoint is enabled.
- public_
access_ Sequence[str]cidrs - List of CIDR blocks. Indicates which CIDR blocks can access the Amazon EKS public API server endpoint.
- security_
group_ Sequence[str]ids - List of security group IDs
- subnet_
ids Sequence[str] - List of subnet IDs
- vpc_
id str - The VPC associated with your cluster.
Package Details
- Repository
- https://github.com/pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.