AWS EKS
AWS EKS is a managed Kubernetes service that simplifies deploying, managing, and scaling containerized applications using Kubernetes on AWS.
Amazon Elastic Kubernetes Service (EKS) is a managed service that simplifies running Kubernetes on AWS without needing to install and operate your own Kubernetes control plane or nodes. The AWS EKS connector for Swimlane Turbine enables seamless integration with Amazon EKS, allowing users to automate the management of Kubernetes clusters and resources. This integration empowers security teams to efficiently create, update, and manage EKS clusters, enhancing operational efficiency and reducing manual intervention. By leveraging this connector, users can streamline their security automation workflows, ensuring robust and scalable Kubernetes environments within their AWS infrastructure.
Limitations
None to date.
Supported Versions
This connector supports the AWS EKS API version used by boto3.
Additional Docs
For more information, refer to the AWS EKS API Documentation.
Configuration
Prerequisites
Before you can use the AWS EKS connector for Turbine, you'll need access to AWS credentials. This requires the following:
- AWS authentication using the following parameters:
- Access Key: A unique identifier associated with your AWS account.
- Secret Key: A secret access key used in conjunction with the access key to sign programmatic requests.
- Region Name: The AWS region where your EKS clusters are hosted.
Authentication Methods
This connector supports the following authentication methods:
Setup Instructions:
Obtaining AWS Credentials
To use this integration, you will need to have an AWS account and obtain the necessary AWS credentials. You can obtain these credentials by following the steps below:
- Log in to your AWS account and navigate to the IAM console.
- In the left navigation pane, click on the "Users" tab and select the user for which you want to create credentials.
- Click on the "Security credentials" tab, and then click on "Create access key".
- Make sure to save the access key ID and secret access key in a secure location, as you will not be able to see the secret access key again after this step.
- If you want to use an AWS IAM Role to access the Secrets Manager, you will need to have the ARN of the role and an optional External ID, if one was specified by the AWS account administrator.
Permissions
- Open the IAM Management Console.
- Navigate to the user or role that requires the permission.
- Click on the permissions tab and then click on the add permissions button at the right side top corner of the permissions block.
- Click on Attach Policies and search for SecretsManagerReadWrite permissions policies.
- Select the box of SecretsManagerReadWrite and then click on the Add Permissions button at the right side bottom corner.
Troubleshooting Tips:
- Verify that the provided credentials are correct and have the necessary permissions.
Capabilities
This connector provides the following capabilities:
- Create Cluster
- Delete Cluster
- Describe Cluster
- List Clusters
- Create Access Entry
- Register Cluster
- Update Cluster Config
Action 1: Create Cluster
Additional Information:
- Creates an Amazon EKS control plane.
Action 2: Delete Cluster
Additional Information:
- Deletes an Amazon EKS cluster control plane.
Action 3: Describe Cluster
Additional Information:
- Describes an Amazon EKS cluster.
Action 4: List Clusters
Additional Information:
- Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Amazon Web Services Region.
Action 5: Create Access Entry
Additional Information:
- Creates an access entry.
Action 6: Register Cluster
Additional Information:
- Connects a Kubernetes cluster to the Amazon EKS control plane.
Action 7: Update Cluster Config
Additional Information:
- Updates an Amazon EKS cluster configuration. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with DescribeUpdate.
...
For more detailed information on each action, refer to the AWS EKS API Documentation. boto3
Additional Documentation
Configurations
AWS EKS Authentication
Authenticates using AWS credentials
Configuration Parameters
Parameter | Description | Type | Required |
|---|---|---|---|
access_key | AWS Access Key. | string | Required |
secret_key | AWS Secret Key . | string | Required |
region_name | The AWS Region where you want to create new connections | string | Required |
role_arn | Optional Role ARN to assume. Leave blank unless tasks need to assume a different role. | string | Optional |
external_id | External ID to assume IAM Role. Optional value used for assuming roles. Can be added, or removed in Trusted Relationships of target role. | string | Optional |
session_token | Use if a session token is provided when switching roles | string | Optional |
role_session_name | Defaults to SessionFromSwimlane_<HASH> when no value is provide | string | Optional |
Actions
Create Access Entry
Create an access entry in AWS EKS for a specified cluster and principal ARN, using inputs like clusterName and principalArn.
Endpoint
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
clusterName | string | Required | The name of your cluster. |
principalArn | string | Required | The ARN of the IAM principal for the AccessEntry. You can specify one ARN for each access entry. You cannot specify the same ARN in more than one access entry. This value cannot be changed after access entry creation. |
kubernetesGroups | array | Optional | The value for name that you have specified for kind - Group as a subject in a Kubernetes RoleBinding or ClusterRoleBinding object. Amazon EKS does not confirm that the value for name exists in any bindings on your cluster. You can specify one or more names. |
tags | object | Optional | Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags do not propagate to any other cluster or Amazon Web Services resources. |
tags.string | string | Optional | One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values. |
clientRequestToken | string | Optional | A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This field is autopopulated if not provided. |
username | string | Optional | The username to authenticate to Kubernetes with. We recommend not specifying a username and letting Amazon EKS specify it for you. |
type | string | Optional | The type of the new access entry. Valid values are Standard, FARGATE_LINUX, EC2_LINUX, and EC2_WINDOWS. |
Input Example
{"clusterName":"string","principalArn":"string","kubernetesGroups":["string"],"tags":{"string":"string"},"clientRequestToken":"string","username":"string","type":"string"}
Output
Parameter | Type | Description |
|---|---|---|
accessEntry | object | Output field: accessEntry |
accessEntry.clusterName | string | Name of the resource |
accessEntry.principalArn | string | Output field: accessEntry.principalArn |
accessEntry.kubernetesGroups | array | Output field: accessEntry.kubernetesGroups |
accessEntry.accessEntryArn | string | Output field: accessEntry.accessEntryArn |
accessEntry.createdAt | string | Output field: accessEntry.createdAt |
accessEntry.modifiedAt | string | Output field: accessEntry.modifiedAt |
accessEntry.tags | object | Output field: accessEntry.tags |
accessEntry.tags.string | string | Output field: accessEntry.tags.string |
accessEntry.username | string | Name of the resource |
accessEntry.type | string | Type of the resource |
Output Example
{"accessEntry":{"clusterName":"string","principalArn":"string","kubernetesGroups":["string"],"accessEntryArn":"string","createdAt":"2015-01-01T00:00:00","modifiedAt":"2015-01-01T00:00:00","tags":{"string":"string"},"username":"string","type":"string"}}
Create Cluster
Create an Amazon EKS control plane using specified name, role ARN, and VPC configuration.
Endpoint
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
name | string | Required | The unique name to give to your cluster. |
version | string | Optional | The desired Kubernetes version for your cluster. If not specified, the default version available in Amazon EKS is used. |
roleArn | string | Required | 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. |
resourcesVpcConfig | object | Required | The VPC configuration that's used by the cluster control plane. |
resourcesVpcConfig.subnetIds | array | Optional | A list of subnet IDs. |
resourcesVpcConfig.securityGroupIds | array | Optional | A list of security group IDs. |
resourcesVpcConfig.endpointPublicAccess | boolean | Optional | Indicates whether the endpoint is publicly accessible. |
resourcesVpcConfig.endpointPrivateAccess | boolean | Optional | Indicates whether the endpoint is privately accessible. |
resourcesVpcConfig.publicAccessCidrs | array | Optional | A list of CIDR blocks for public access. |
kubernetesNetworkConfig | object | Optional | The Kubernetes network configuration for the cluster. |
kubernetesNetworkConfig.serviceIpv4Cidr | string | Optional | The CIDR block for the Kubernetes service IP addresses. |
kubernetesNetworkConfig.ipFamily | string | Optional | The IP family used for the cluster. |
logging | object | Optional | Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. |
logging.clusterLogging | array | Optional | The cluster logging configuration. |
logging.clusterLogging.types | array | Optional | The types of logs to export. |
logging.clusterLogging.enabled | boolean | Optional | Indicates whether the logging is enabled. |
clientRequestToken | string | Optional | A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. |
tags | object | Optional | Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. |
tags.string | string | Optional | The tag value. |
encryptionConfig | array | Optional | The encryption configuration for the cluster. |
encryptionConfig.resources | array | Optional | The resources to be encrypted. |
encryptionConfig.provider | object | Optional | The encryption provider. |
encryptionConfig.provider.keyArn | string | Optional | The ARN of the key. |
outpostConfig | object | Optional | An object representing the configuration of your local Amazon EKS cluster on an AWS Outpost. |
outpostConfig.outpostArns | array | Optional | A list of Outpost ARNs. |
Input Example
{"name":"string","version":"string","roleArn":"string","resourcesVpcConfig":{"subnetIds":["string"],"securityGroupIds":["string"],"endpointPublicAccess":true,"endpointPrivateAccess":true,"publicAccessCidrs":["string"]},"kubernetesNetworkConfig":{"serviceIpv4Cidr":"string","ipFamily":"ipv4"},"logging":{"clusterLogging":[{"types":["api","audit","authenticator","controllerManager","scheduler"],"enabled":true}]},"clientRequestToken":"string","tags":{"string":"string"},"encryptionConfig":[{"resources":["string"],"provider":{"keyArn":"string"}}],"outpostConfig":{"outpostArns":["string"],"controlPlaneInstanceType":"string","controlPlanePlacement":{"groupName":"string"}},"accessConfig":{"bootstrapClusterCreatorAdminPermissions":true,"authenticationMode":"API"},"bootstrapSelfManagedAddons":true,"upgradePolicy":{"supportType":"STANDARD"}}
Output
Parameter | Type | Description |
|---|---|---|
cluster | object | Output field: cluster |
cluster.name | string | Name of the resource |
cluster.arn | string | Output field: cluster.arn |
cluster.createdAt | string | Output field: cluster.createdAt |
cluster.version | string | Output field: cluster.version |
cluster.endpoint | string | Output field: cluster.endpoint |
cluster.roleArn | string | Output field: cluster.roleArn |
cluster.resourcesVpcConfig | object | Output field: cluster.resourcesVpcConfig |
cluster.resourcesVpcConfig.subnetIds | array | Unique identifier |
cluster.resourcesVpcConfig.securityGroupIds | array | Unique identifier |
cluster.resourcesVpcConfig.clusterSecurityGroupId | string | Unique identifier |
cluster.resourcesVpcConfig.vpcId | string | Unique identifier |
cluster.resourcesVpcConfig.endpointPublicAccess | boolean | Output field: cluster.resourcesVpcConfig.endpointPublicAccess |
cluster.resourcesVpcConfig.endpointPrivateAccess | boolean | Output field: cluster.resourcesVpcConfig.endpointPrivateAccess |
cluster.resourcesVpcConfig.publicAccessCidrs | array | Unique identifier |
cluster.kubernetesNetworkConfig | object | Output field: cluster.kubernetesNetworkConfig |
cluster.kubernetesNetworkConfig.serviceIpv4Cidr | string | Unique identifier |
cluster.kubernetesNetworkConfig.serviceIpv6Cidr | string | Unique identifier |
cluster.kubernetesNetworkConfig.ipFamily | string | Output field: cluster.kubernetesNetworkConfig.ipFamily |
cluster.logging | object | Output field: cluster.logging |
cluster.logging.clusterLogging | array | Output field: cluster.logging.clusterLogging |
cluster.logging.clusterLogging.types | array | Type of the resource |
cluster.logging.clusterLogging.enabled | boolean | Output field: cluster.logging.clusterLogging.enabled |
cluster.identity | object | Unique identifier |
cluster.identity.oidc | object | Unique identifier |
Output Example
{"cluster":{"name":"string","arn":"string","createdAt":"datetime(2015, 1, 1)","version":"string","endpoint":"string","roleArn":"string","resourcesVpcConfig":{"subnetIds":[],"securityGroupIds":[],"clusterSecurityGroupId":"string","vpcId":"string","endpointPublicAccess":true,"endpointPrivateAccess":false,"publicAccessCidrs":[]},"kubernetesNetworkConfig":{"serviceIpv4Cidr":"string","serviceIpv6Cidr":"string","ipFamily":"ipv4"},"logging":{"clusterLogging":[]},"identity":{"oidc":{}},"status":"CREATIN...
Delete Cluster
Remove an Amazon EKS cluster control plane by name, terminating all associated resources.
Endpoint
- Method: DELETE
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
name | string | Required | The name of the cluster to delete. |
Input Example
{"name":"string"}
Output
Parameter | Type | Description |
|---|---|---|
cluster | object | Output field: cluster |
cluster.name | string | Name of the resource |
cluster.arn | string | Output field: cluster.arn |
cluster.createdAt | string | Output field: cluster.createdAt |
cluster.version | string | Output field: cluster.version |
cluster.endpoint | string | Output field: cluster.endpoint |
cluster.roleArn | string | Output field: cluster.roleArn |
cluster.resourcesVpcConfig | object | Output field: cluster.resourcesVpcConfig |
cluster.resourcesVpcConfig.subnetIds | array | Unique identifier |
cluster.resourcesVpcConfig.securityGroupIds | array | Unique identifier |
cluster.resourcesVpcConfig.clusterSecurityGroupId | string | Unique identifier |
cluster.resourcesVpcConfig.vpcId | string | Unique identifier |
cluster.resourcesVpcConfig.endpointPublicAccess | boolean | Output field: cluster.resourcesVpcConfig.endpointPublicAccess |
cluster.resourcesVpcConfig.endpointPrivateAccess | boolean | Output field: cluster.resourcesVpcConfig.endpointPrivateAccess |
cluster.resourcesVpcConfig.publicAccessCidrs | array | Unique identifier |
cluster.kubernetesNetworkConfig | object | Output field: cluster.kubernetesNetworkConfig |
cluster.kubernetesNetworkConfig.serviceIpv4Cidr | string | Unique identifier |
cluster.kubernetesNetworkConfig.serviceIpv6Cidr | string | Unique identifier |
cluster.kubernetesNetworkConfig.ipFamily | string | Output field: cluster.kubernetesNetworkConfig.ipFamily |
cluster.logging | object | Output field: cluster.logging |
cluster.logging.clusterLogging | array | Output field: cluster.logging.clusterLogging |
cluster.logging.clusterLogging.types | array | Type of the resource |
cluster.logging.clusterLogging.enabled | boolean | Output field: cluster.logging.clusterLogging.enabled |
cluster.identity | object | Unique identifier |
cluster.identity.oidc | object | Unique identifier |
Output Example
{"cluster":{"name":"string","arn":"string","createdAt":"datetime(2015, 1, 1)","version":"string","endpoint":"string","roleArn":"string","resourcesVpcConfig":{"subnetIds":[],"securityGroupIds":[],"clusterSecurityGroupId":"string","vpcId":"string","endpointPublicAccess":true,"endpointPrivateAccess":true,"publicAccessCidrs":[]},"kubernetesNetworkConfig":{"serviceIpv4Cidr":"string","serviceIpv6Cidr":"string","ipFamily":"ipv4"},"logging":{"clusterLogging":[]},"identity":{"oidc":{}},"status":"CREATING...
Describe Cluster
Retrieve detailed information about an Amazon EKS cluster by specifying the cluster name.
Endpoint
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
name | string | Required | The name of the Amazon EKS cluster to update. |
Input Example
{"name":"string"}
Output
Parameter | Type | Description |
|---|---|---|
cluster | object | Output field: cluster |
cluster.name | string | Name of the resource |
cluster.arn | string | Output field: cluster.arn |
cluster.createdAt | string | Output field: cluster.createdAt |
cluster.version | string | Output field: cluster.version |
cluster.endpoint | string | Output field: cluster.endpoint |
cluster.roleArn | string | Output field: cluster.roleArn |
cluster.resourcesVpcConfig | object | Output field: cluster.resourcesVpcConfig |
cluster.resourcesVpcConfig.subnetIds | array | Unique identifier |
cluster.resourcesVpcConfig.securityGroupIds | array | Unique identifier |
cluster.resourcesVpcConfig.clusterSecurityGroupId | string | Unique identifier |
cluster.resourcesVpcConfig.vpcId | string | Unique identifier |
cluster.resourcesVpcConfig.endpointPublicAccess | string | Output field: cluster.resourcesVpcConfig.endpointPublicAccess |
cluster.resourcesVpcConfig.endpointPrivateAccess | string | Output field: cluster.resourcesVpcConfig.endpointPrivateAccess |
cluster.resourcesVpcConfig.publicAccessCidrs | array | Unique identifier |
cluster.kubernetesNetworkConfig | object | Output field: cluster.kubernetesNetworkConfig |
cluster.kubernetesNetworkConfig.serviceIpv4Cidr | string | Unique identifier |
cluster.kubernetesNetworkConfig.serviceIpv6Cidr | string | Unique identifier |
cluster.kubernetesNetworkConfig.ipFamily | string | Output field: cluster.kubernetesNetworkConfig.ipFamily |
cluster.logging | object | Output field: cluster.logging |
cluster.logging.clusterLogging | array | Output field: cluster.logging.clusterLogging |
cluster.logging.clusterLogging.types | array | Type of the resource |
cluster.logging.clusterLogging.enabled | string | Output field: cluster.logging.clusterLogging.enabled |
cluster.identity | object | Unique identifier |
cluster.identity.oidc | object | Unique identifier |
Output Example
{"cluster":{"name":"string","arn":"string","createdAt":"datetime(2015, 1, 1)","version":"string","endpoint":"string","roleArn":"string","resourcesVpcConfig":{"subnetIds":[],"securityGroupIds":[],"clusterSecurityGroupId":"string","vpcId":"string","endpointPublicAccess":"True|False","endpointPrivateAccess":"True|False","publicAccessCidrs":[]},"kubernetesNetworkConfig":{"serviceIpv4Cidr":"string","serviceIpv6Cidr":"string","ipFamily":"ipv4|ipv6"},"logging":{"clusterLogging":[]},"identity":{"oidc":{...
List Clusters
Retrieve a list of Amazon EKS clusters available in the specified AWS Region within your account.
Endpoint
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
maxResults | number | Optional | The maximum number of results, returned in paginated output. You receive maxResults in a single page, along with a nextToken response element. You can see the remaining results of the initial request by sending another request with the returned nextToken value. This value can be between 1 and 100. If you donβt use this parameter, 100 results and a nextToken value, if applicable, are returned. |
nextToken | string | Optional | The nextToken value returned from a previous paginated request, where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. Note: This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes. |
include | array | Optional | Indicates whether external clusters are included in the returned list. Use βallβ to return connected clusters, or blank to return only Amazon EKS clusters. βallβ must be in lowercase otherwise an error occurs. |
Input Example
{"maxResults":123,"nextToken":"string","include":["string"]}
Output
Parameter | Type | Description |
|---|---|---|
clusters | array | Output field: clusters |
nextToken | string | Output field: nextToken |
Output Example
{"clusters":["string"],"nextToken":"string"}
Register Cluster
Connect A Kubernetes Cluster To The Amazon EKS Control Plane Using The Cluster Name And Connector Configuration.
Endpoint
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
name | string | Required | A unique name for this cluster in your AWS Region. |
connectorConfig | object | Required | The configuration settings required to connect the Kubernetes cluster to the Amazon EKS control plane. |
connectorConfig.roleArn | string | Required | The Amazon Resource Name (ARN) of the role to assume when connecting to the cluster. |
connectorConfig.provider | string | Required | The provider of the Kubernetes cluster. |
clientRequestToken | string | Optional | A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. |
tags | object | Optional | Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. |
tags.string | string | Optional | Parameter for Register Cluster |
Input Example
{"name":"string","connectorConfig":{"roleArn":"string","provider":"EKS_ANYWHERE"},"clientRequestToken":"string","tags":{"string":"string"}}
Output
Parameter | Type | Description |
|---|---|---|
cluster | object | Output field: cluster |
cluster.name | string | Name of the resource |
cluster.arn | string | Output field: cluster.arn |
cluster.createdAt | string | Output field: cluster.createdAt |
cluster.version | string | Output field: cluster.version |
cluster.endpoint | string | Output field: cluster.endpoint |
cluster.roleArn | string | Output field: cluster.roleArn |
cluster.resourcesVpcConfig | object | Output field: cluster.resourcesVpcConfig |
cluster.resourcesVpcConfig.subnetIds | array | Unique identifier |
cluster.resourcesVpcConfig.securityGroupIds | array | Unique identifier |
cluster.resourcesVpcConfig.clusterSecurityGroupId | string | Unique identifier |
cluster.resourcesVpcConfig.vpcId | string | Unique identifier |
cluster.resourcesVpcConfig.endpointPublicAccess | boolean | Output field: cluster.resourcesVpcConfig.endpointPublicAccess |
cluster.resourcesVpcConfig.endpointPrivateAccess | boolean | Output field: cluster.resourcesVpcConfig.endpointPrivateAccess |
cluster.resourcesVpcConfig.publicAccessCidrs | array | Unique identifier |
cluster.kubernetesNetworkConfig | object | Output field: cluster.kubernetesNetworkConfig |
cluster.kubernetesNetworkConfig.serviceIpv4Cidr | string | Unique identifier |
cluster.kubernetesNetworkConfig.serviceIpv6Cidr | string | Unique identifier |
cluster.kubernetesNetworkConfig.ipFamily | string | Output field: cluster.kubernetesNetworkConfig.ipFamily |
cluster.logging | object | Output field: cluster.logging |
cluster.logging.clusterLogging | array | Output field: cluster.logging.clusterLogging |
cluster.logging.clusterLogging.types | array | Type of the resource |
cluster.logging.clusterLogging.enabled | boolean | Output field: cluster.logging.clusterLogging.enabled |
cluster.identity | object | Unique identifier |
cluster.identity.oidc | object | Unique identifier |
Output Example
{"cluster":{"name":"string","arn":"string","createdAt":"datetime(2015, 1, 1)","version":"string","endpoint":"string","roleArn":"string","resourcesVpcConfig":{"subnetIds":[],"securityGroupIds":[],"clusterSecurityGroupId":"string","vpcId":"string","endpointPublicAccess":true,"endpointPrivateAccess":true,"publicAccessCidrs":[]},"kubernetesNetworkConfig":{"serviceIpv4Cidr":"string","serviceIpv6Cidr":"string","ipFamily":"ipv4"},"logging":{"clusterLogging":[]},"identity":{"oidc":{}},"status":"CREATING...
Update Cluster Config
Update an Amazon EKS cluster configuration and receive an update ID for status tracking. Requires the cluster name.
Endpoint
- Method: PUT
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
name | string | Required | The name of the Amazon EKS cluster to update. |
resourcesVpcConfig | object | Optional | An object representing the VPC configuration to use for an Amazon EKS cluster. |
resourcesVpcConfig.subnetIds | array | Optional | The subnets associated with your cluster. |
resourcesVpcConfig.securityGroupIds | array | Optional | The security groups associated with your cluster. |
resourcesVpcConfig.endpointPublicAccess | boolean | Optional | Indicates whether the Amazon EKS public API server endpoint is enabled. |
resourcesVpcConfig.endpointPrivateAccess | boolean | Optional | Indicates whether the Amazon EKS private API server endpoint is enabled. |
resourcesVpcConfig.publicAccessCidrs | array | Optional | The CIDR blocks that are allowed access to your cluster's public API server endpoint. |
logging | object | Optional | Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. |
logging.clusterLogging | array | Optional | The cluster control plane logging configuration for your cluster. |
logging.clusterLogging.types | array | Optional | The types of logs to enable. |
logging.clusterLogging.enabled | boolean | Optional | Indicates whether the logging types are enabled. |
clientRequestToken | string | Optional | A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. |
accessConfig | object | Optional | The access configuration for the cluster. |
accessConfig.authenticationMode | string | Optional | The authentication mode for the cluster. |
upgradePolicy | object | Optional | You can enable or disable extended support for clusters currently on standard support. |
upgradePolicy.supportType | string | Optional | The support type for the cluster. |
Input Example
{"name":"string","resourcesVpcConfig":{"subnetIds":["string"],"securityGroupIds":["string"],"endpointPublicAccess":true,"endpointPrivateAccess":true,"publicAccessCidrs":["string"]},"logging":{"clusterLogging":[{"types":["api","audit","authenticator","controllerManager","scheduler"],"enabled":true}]},"clientRequestToken":"string","accessConfig":{"authenticationMode":"API"},"upgradePolicy":{"supportType":"STANDARD"}}
Output
Parameter | Type | Description |
|---|---|---|
update | object | Date value |
update.id | string | Unique identifier |
update.status | string | Status value |
update.type | string | Type of the resource |
update.params | array | Output field: update.params |
update.params.type | string | Type of the resource |
update.params.value | string | Value for the parameter |
update.createdAt | string | Output field: update.createdAt |
update.errors | array | Error message if any |
update.errors.errorCode | string | Error message if any |
update.errors.errorMessage | string | Response message |
update.errors.resourceIds | array | Unique identifier |
Output Example
{"update":{"id":"string","status":"InProgress","type":"VersionUpdate","params":[{}],"createdAt":"2015-01-01T00:00:00Z","errors":[{}]}}
Response Headers
Header | Description | Example |
|---|---|---|
Content-Type | The media type of the resource | application/json |
Date | The date and time at which the message was originated | Thu, 01 Jan 2024 00:00:00 GMT |