EksToken
Fetch an OAuth access token for an AWS EKS cluster.
type: "io.kestra.plugin.aws.auth.EksToken"
Examples
id: aws_eks_oauth_token
namespace: company.team
tasks:
- id: get_eks_token
type: io.kestra.plugin.aws.auth.EksToken
accessKeyId: "{{ secret('AWS_ACCESS_KEY_ID') }}"
secretKeyId: "{{ secret('AWS_SECRET_KEY_ID') }}"
region: "eu-central-1"
clusterName: "my-cluster"
Properties
clusterName *Requiredstring
EKS cluster name.
accessKeyId string
Access Key Id in order to connect to AWS.
If no credentials are defined, we will use the default credentials provider chain to fetch credentials.
compatibilityMode booleanstring
Enable compatibility mode.
Use it to connect to S3 bucket with S3 compatible services that don't support the new transport client.
endpointOverride string
The endpoint with which the SDK should communicate.
This property allows you to use a different S3 compatible storage backend.
expirationDuration integerstring
600
Token expiration duration in seconds
forcePathStyle booleanstring
Force path style access.
Must only be used when compatibilityMode
is enabled.
region string
AWS region with which the SDK should communicate.
secretKeyId string
Secret Key Id in order to connect to AWS.
If no credentials are defined, we will use the default credentials provider chain to fetch credentials.
sessionToken string
AWS session token, retrieved from an AWS token service, used for authenticating that this user has received temporary permissions to access a given resource.
If no credentials are defined, we will use the default credentials provider chain to fetch credentials.
stsEndpointOverride string
The AWS STS endpoint with which the SDKClient should communicate.
stsRoleArn string
AWS STS Role.
The Amazon Resource Name (ARN) of the role to assume. If set the task will use the StsAssumeRoleCredentialsProvider
. If no credentials are defined, we will use the default credentials provider chain to fetch credentials.
stsRoleExternalId string
AWS STS External Id.
A unique identifier that might be required when you assume a role in another account. This property is only used when an stsRoleArn
is defined.
stsRoleSessionDuration string
PT15M
duration
AWS STS Session duration.
The duration of the role session (default: 15 minutes, i.e., PT15M). This property is only used when an stsRoleArn
is defined.
stsRoleSessionName string
AWS STS Session name.
This property is only used when an stsRoleArn
is defined.
Outputs
token *RequiredEksToken-Token
An OAuth access token for the current user.
Definitions
io.kestra.plugin.aws.auth.EksToken-Token
expirationTime string
date-time
tokenValue string
OAuth access token value
Will be automatically encrypted and decrypted in the outputs if encryption is configured