EksToken
type: "io.kestra.plugin.aws.auth.EksToken"
Fetch an OAuth access token for EKS cluster.
Examples
id: aws_eks_oauth_token
namespace: company.team
tasks:
- id: get_eks_token
type: io.kestra.plugin.aws.auth.EksToken
accessKeyId: "<access-key>"
secretKeyId: "<secret-key>"
region: "eu-central-1"
clusterName: "my-cluster"
Properties
clusterName
- Type: string
- Dynamic: ✔️
- Required: ✔️
EKS cluster name.
expirationDuration
- Type:
- integer
- string
- Dynamic: ✔️
- Required: ✔️
accessKeyId
- Type: string
- Dynamic: ✔️
- Required: ❌
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
- Type: boolean
- Dynamic: ✔️
- Required: ❌
endpointOverride
- Type: string
- Dynamic: ✔️
- Required: ❌
The endpoint with which the SDK should communicate.
This property allows you to use a different S3 compatible storage backend.
region
- Type: string
- Dynamic: ✔️
- Required: ❌
AWS region with which the SDK should communicate.
secretKeyId
- Type: string
- Dynamic: ✔️
- Required: ❌
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
- Type: string
- Dynamic: ✔️
- Required: ❌
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
- Type: string
- Dynamic: ✔️
- Required: ❌
The AWS STS endpoint with which the SDKClient should communicate.
stsRoleArn
- Type: string
- Dynamic: ✔️
- Required: ❌
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
- Type: string
- Dynamic: ✔️
- Required: ❌
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
- Type: string
- Dynamic: ❌
- Required: ❌
- Default:
900.000000000
- Format:
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
- Type: string
- Dynamic: ✔️
- Required: ❌
AWS STS Session name.
This property is only used when an
stsRoleArn
is defined.
Outputs
token
- Type: EksToken-Token
- Required: ✔️
An OAuth access token for the current user.
Definitions
io.kestra.plugin.aws.auth.EksToken-Token
Properties
expirationTime
- Type: string
- Dynamic: ❓
- Required: ❓
- Format:
date-time
tokenValue
- Type: EncryptedString
- Dynamic: ❓
- Required: ❓
OAuth access token value
Will be automatically encrypted and decrypted in the outputs if encryption is configured
io.kestra.core.models.tasks.common.EncryptedString
Properties
type
- Type: string
- Dynamic: ❓
- Required: ❓
value
- Type: string
- Dynamic: ❓
- Required: ❓
Was this page helpful?