TargetEks

akeyless 2.0.1, Apr 27 26

Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community

akeyless-community/terraform-provider-akeyless

Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community

akeyless-community/terraform-provider-akeyless

Create TargetEks Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new TargetEks(name: string, args: TargetEksArgs, opts?: CustomResourceOptions);

@overload
def TargetEks(resource_name: str,
              args: TargetEksArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def TargetEks(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              eks_secret_access_key: Optional[str] = None,
              eks_access_key_id: Optional[str] = None,
              eks_cluster_ca_cert: Optional[str] = None,
              eks_cluster_endpoint: Optional[str] = None,
              eks_cluster_name: Optional[str] = None,
              eks_region: Optional[str] = None,
              description: Optional[str] = None,
              keep_prev_version: Optional[str] = None,
              key: Optional[str] = None,
              max_versions: Optional[str] = None,
              name: Optional[str] = None,
              target_eks_id: Optional[str] = None,
              use_gw_cloud_identity: Optional[bool] = None)

func NewTargetEks(ctx *Context, name string, args TargetEksArgs, opts ...ResourceOption) (*TargetEks, error)

public TargetEks(string name, TargetEksArgs args, CustomResourceOptions? opts = null)

public TargetEks(String name, TargetEksArgs args)
public TargetEks(String name, TargetEksArgs args, CustomResourceOptions options)

type: akeyless:TargetEks
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args TargetEksArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args TargetEksArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args TargetEksArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args TargetEksArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args TargetEksArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var targetEksResource = new Akeyless.TargetEks("targetEksResource", new()
{
    EksSecretAccessKey = "string",
    EksAccessKeyId = "string",
    EksClusterCaCert = "string",
    EksClusterEndpoint = "string",
    EksClusterName = "string",
    EksRegion = "string",
    Description = "string",
    KeepPrevVersion = "string",
    Key = "string",
    MaxVersions = "string",
    Name = "string",
    TargetEksId = "string",
    UseGwCloudIdentity = false,
});

example, err := akeyless.NewTargetEks(ctx, "targetEksResource", &akeyless.TargetEksArgs{
	EksSecretAccessKey: pulumi.String("string"),
	EksAccessKeyId:     pulumi.String("string"),
	EksClusterCaCert:   pulumi.String("string"),
	EksClusterEndpoint: pulumi.String("string"),
	EksClusterName:     pulumi.String("string"),
	EksRegion:          pulumi.String("string"),
	Description:        pulumi.String("string"),
	KeepPrevVersion:    pulumi.String("string"),
	Key:                pulumi.String("string"),
	MaxVersions:        pulumi.String("string"),
	Name:               pulumi.String("string"),
	TargetEksId:        pulumi.String("string"),
	UseGwCloudIdentity: pulumi.Bool(false),
})

var targetEksResource = new TargetEks("targetEksResource", TargetEksArgs.builder()
    .eksSecretAccessKey("string")
    .eksAccessKeyId("string")
    .eksClusterCaCert("string")
    .eksClusterEndpoint("string")
    .eksClusterName("string")
    .eksRegion("string")
    .description("string")
    .keepPrevVersion("string")
    .key("string")
    .maxVersions("string")
    .name("string")
    .targetEksId("string")
    .useGwCloudIdentity(false)
    .build());

target_eks_resource = akeyless.TargetEks("targetEksResource",
    eks_secret_access_key="string",
    eks_access_key_id="string",
    eks_cluster_ca_cert="string",
    eks_cluster_endpoint="string",
    eks_cluster_name="string",
    eks_region="string",
    description="string",
    keep_prev_version="string",
    key="string",
    max_versions="string",
    name="string",
    target_eks_id="string",
    use_gw_cloud_identity=False)

const targetEksResource = new akeyless.TargetEks("targetEksResource", {
    eksSecretAccessKey: "string",
    eksAccessKeyId: "string",
    eksClusterCaCert: "string",
    eksClusterEndpoint: "string",
    eksClusterName: "string",
    eksRegion: "string",
    description: "string",
    keepPrevVersion: "string",
    key: "string",
    maxVersions: "string",
    name: "string",
    targetEksId: "string",
    useGwCloudIdentity: false,
});

type: akeyless:TargetEks
properties:
    description: string
    eksAccessKeyId: string
    eksClusterCaCert: string
    eksClusterEndpoint: string
    eksClusterName: string
    eksRegion: string
    eksSecretAccessKey: string
    keepPrevVersion: string
    key: string
    maxVersions: string
    name: string
    targetEksId: string
    useGwCloudIdentity: false

TargetEks Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The TargetEks resource accepts the following input properties:

EksAccessKeyId string: Access Key ID
EksClusterCaCert string: EKS cluster CA certificate
EksClusterEndpoint string: EKS cluster URL endpoint
EksClusterName string: EKS cluster name
EksSecretAccessKey string: Secret Access Key
Description string: Description of the object
EksRegion string: Region
KeepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
Key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
MaxVersions string: Set the maximum number of versions, limited by the account settings defaults.
Name string: Target name
TargetEksId string: The ID of this resource.
UseGwCloudIdentity bool: Use the GW's Cloud IAM

EksAccessKeyId string: Access Key ID
EksClusterCaCert string: EKS cluster CA certificate
EksClusterEndpoint string: EKS cluster URL endpoint
EksClusterName string: EKS cluster name
EksSecretAccessKey string: Secret Access Key
Description string: Description of the object
EksRegion string: Region
KeepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
Key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
MaxVersions string: Set the maximum number of versions, limited by the account settings defaults.
Name string: Target name
TargetEksId string: The ID of this resource.
UseGwCloudIdentity bool: Use the GW's Cloud IAM

eksAccessKeyId String: Access Key ID
eksClusterCaCert String: EKS cluster CA certificate
eksClusterEndpoint String: EKS cluster URL endpoint
eksClusterName String: EKS cluster name
eksSecretAccessKey String: Secret Access Key
description String: Description of the object
eksRegion String: Region
keepPrevVersion String: Whether to keep previous version [true/false]. If not set, use default according to account settings
key String: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
maxVersions String: Set the maximum number of versions, limited by the account settings defaults.
name String: Target name
targetEksId String: The ID of this resource.
useGwCloudIdentity Boolean: Use the GW's Cloud IAM

eksAccessKeyId string: Access Key ID
eksClusterCaCert string: EKS cluster CA certificate
eksClusterEndpoint string: EKS cluster URL endpoint
eksClusterName string: EKS cluster name
eksSecretAccessKey string: Secret Access Key
description string: Description of the object
eksRegion string: Region
keepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
maxVersions string: Set the maximum number of versions, limited by the account settings defaults.
name string: Target name
targetEksId string: The ID of this resource.
useGwCloudIdentity boolean: Use the GW's Cloud IAM

eks_access_key_id str: Access Key ID
eks_cluster_ca_cert str: EKS cluster CA certificate
eks_cluster_endpoint str: EKS cluster URL endpoint
eks_cluster_name str: EKS cluster name
eks_secret_access_key str: Secret Access Key
description str: Description of the object
eks_region str: Region
keep_prev_version str: Whether to keep previous version [true/false]. If not set, use default according to account settings
key str: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
max_versions str: Set the maximum number of versions, limited by the account settings defaults.
name str: Target name
target_eks_id str: The ID of this resource.
use_gw_cloud_identity bool: Use the GW's Cloud IAM

eksAccessKeyId String: Access Key ID
eksClusterCaCert String: EKS cluster CA certificate
eksClusterEndpoint String: EKS cluster URL endpoint
eksClusterName String: EKS cluster name
eksSecretAccessKey String: Secret Access Key
description String: Description of the object
eksRegion String: Region
keepPrevVersion String: Whether to keep previous version [true/false]. If not set, use default according to account settings
key String: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
maxVersions String: Set the maximum number of versions, limited by the account settings defaults.
name String: Target name
targetEksId String: The ID of this resource.
useGwCloudIdentity Boolean: Use the GW's Cloud IAM

Outputs

All input properties are implicitly available as output properties. Additionally, the TargetEks resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing TargetEks Resource

Get an existing TargetEks resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: TargetEksState, opts?: CustomResourceOptions): TargetEks

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        eks_access_key_id: Optional[str] = None,
        eks_cluster_ca_cert: Optional[str] = None,
        eks_cluster_endpoint: Optional[str] = None,
        eks_cluster_name: Optional[str] = None,
        eks_region: Optional[str] = None,
        eks_secret_access_key: Optional[str] = None,
        keep_prev_version: Optional[str] = None,
        key: Optional[str] = None,
        max_versions: Optional[str] = None,
        name: Optional[str] = None,
        target_eks_id: Optional[str] = None,
        use_gw_cloud_identity: Optional[bool] = None) -> TargetEks

func GetTargetEks(ctx *Context, name string, id IDInput, state *TargetEksState, opts ...ResourceOption) (*TargetEks, error)

public static TargetEks Get(string name, Input<string> id, TargetEksState? state, CustomResourceOptions? opts = null)

public static TargetEks get(String name, Output<String> id, TargetEksState state, CustomResourceOptions options)

resources:  _:    type: akeyless:TargetEks    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Description string: Description of the object
EksAccessKeyId string: Access Key ID
EksClusterCaCert string: EKS cluster CA certificate
EksClusterEndpoint string: EKS cluster URL endpoint
EksClusterName string: EKS cluster name
EksRegion string: Region
EksSecretAccessKey string: Secret Access Key
KeepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
Key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
MaxVersions string: Set the maximum number of versions, limited by the account settings defaults.
Name string: Target name
TargetEksId string: The ID of this resource.
UseGwCloudIdentity bool: Use the GW's Cloud IAM

Description string: Description of the object
EksAccessKeyId string: Access Key ID
EksClusterCaCert string: EKS cluster CA certificate
EksClusterEndpoint string: EKS cluster URL endpoint
EksClusterName string: EKS cluster name
EksRegion string: Region
EksSecretAccessKey string: Secret Access Key
KeepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
Key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
MaxVersions string: Set the maximum number of versions, limited by the account settings defaults.
Name string: Target name
TargetEksId string: The ID of this resource.
UseGwCloudIdentity bool: Use the GW's Cloud IAM

description String: Description of the object
eksAccessKeyId String: Access Key ID
eksClusterCaCert String: EKS cluster CA certificate
eksClusterEndpoint String: EKS cluster URL endpoint
eksClusterName String: EKS cluster name
eksRegion String: Region
eksSecretAccessKey String: Secret Access Key
keepPrevVersion String: Whether to keep previous version [true/false]. If not set, use default according to account settings
key String: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
maxVersions String: Set the maximum number of versions, limited by the account settings defaults.
name String: Target name
targetEksId String: The ID of this resource.
useGwCloudIdentity Boolean: Use the GW's Cloud IAM

description string: Description of the object
eksAccessKeyId string: Access Key ID
eksClusterCaCert string: EKS cluster CA certificate
eksClusterEndpoint string: EKS cluster URL endpoint
eksClusterName string: EKS cluster name
eksRegion string: Region
eksSecretAccessKey string: Secret Access Key
keepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
maxVersions string: Set the maximum number of versions, limited by the account settings defaults.
name string: Target name
targetEksId string: The ID of this resource.
useGwCloudIdentity boolean: Use the GW's Cloud IAM

description str: Description of the object
eks_access_key_id str: Access Key ID
eks_cluster_ca_cert str: EKS cluster CA certificate
eks_cluster_endpoint str: EKS cluster URL endpoint
eks_cluster_name str: EKS cluster name
eks_region str: Region
eks_secret_access_key str: Secret Access Key
keep_prev_version str: Whether to keep previous version [true/false]. If not set, use default according to account settings
key str: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
max_versions str: Set the maximum number of versions, limited by the account settings defaults.
name str: Target name
target_eks_id str: The ID of this resource.
use_gw_cloud_identity bool: Use the GW's Cloud IAM

description String: Description of the object
eksAccessKeyId String: Access Key ID
eksClusterCaCert String: EKS cluster CA certificate
eksClusterEndpoint String: EKS cluster URL endpoint
eksClusterName String: EKS cluster name
eksRegion String: Region
eksSecretAccessKey String: Secret Access Key
keepPrevVersion String: Whether to keep previous version [true/false]. If not set, use default according to account settings
key String: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
maxVersions String: Set the maximum number of versions, limited by the account settings defaults.
name String: Target name
targetEksId String: The ID of this resource.
useGwCloudIdentity Boolean: Use the GW's Cloud IAM