1. Packages
  2. Akeyless Provider
  3. API Docs
  4. TargetEks
akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community

akeyless.TargetEks

Explore with Pulumi AI

akeyless logo
akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community

    EKS Target resource

    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_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_secret_access_key: Optional[str] = None,
                  description: Optional[str] = None,
                  eks_region: Optional[str] = None,
                  key: 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()
    {
        EksAccessKeyId = "string",
        EksClusterCaCert = "string",
        EksClusterEndpoint = "string",
        EksClusterName = "string",
        EksSecretAccessKey = "string",
        Description = "string",
        EksRegion = "string",
        Key = "string",
        Name = "string",
        TargetEksId = "string",
        UseGwCloudIdentity = false,
    });
    
    example, err := akeyless.NewTargetEks(ctx, "targetEksResource", &akeyless.TargetEksArgs{
    	EksAccessKeyId:     pulumi.String("string"),
    	EksClusterCaCert:   pulumi.String("string"),
    	EksClusterEndpoint: pulumi.String("string"),
    	EksClusterName:     pulumi.String("string"),
    	EksSecretAccessKey: pulumi.String("string"),
    	Description:        pulumi.String("string"),
    	EksRegion:          pulumi.String("string"),
    	Key:                pulumi.String("string"),
    	Name:               pulumi.String("string"),
    	TargetEksId:        pulumi.String("string"),
    	UseGwCloudIdentity: pulumi.Bool(false),
    })
    
    var targetEksResource = new TargetEks("targetEksResource", TargetEksArgs.builder()
        .eksAccessKeyId("string")
        .eksClusterCaCert("string")
        .eksClusterEndpoint("string")
        .eksClusterName("string")
        .eksSecretAccessKey("string")
        .description("string")
        .eksRegion("string")
        .key("string")
        .name("string")
        .targetEksId("string")
        .useGwCloudIdentity(false)
        .build());
    
    target_eks_resource = akeyless.TargetEks("targetEksResource",
        eks_access_key_id="string",
        eks_cluster_ca_cert="string",
        eks_cluster_endpoint="string",
        eks_cluster_name="string",
        eks_secret_access_key="string",
        description="string",
        eks_region="string",
        key="string",
        name="string",
        target_eks_id="string",
        use_gw_cloud_identity=False)
    
    const targetEksResource = new akeyless.TargetEks("targetEksResource", {
        eksAccessKeyId: "string",
        eksClusterCaCert: "string",
        eksClusterEndpoint: "string",
        eksClusterName: "string",
        eksSecretAccessKey: "string",
        description: "string",
        eksRegion: "string",
        key: "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
        key: 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
    EKS access key ID
    EksClusterCaCert string
    EKS cluster base-64 encoded certificate
    EksClusterEndpoint string
    EKS cluster endpoint (i.e., https://\n\n of the cluster)
    EksClusterName string
    EKS cluster name
    EksSecretAccessKey string
    EKS secret access key
    Description string
    Description of the object
    EksRegion string
    EKS region
    Key string
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used.
    Name string
    Target name
    TargetEksId string
    The ID of this resource.
    UseGwCloudIdentity bool
    Use the GW's Cloud IAM
    EksAccessKeyId string
    EKS access key ID
    EksClusterCaCert string
    EKS cluster base-64 encoded certificate
    EksClusterEndpoint string
    EKS cluster endpoint (i.e., https://\n\n of the cluster)
    EksClusterName string
    EKS cluster name
    EksSecretAccessKey string
    EKS secret access key
    Description string
    Description of the object
    EksRegion string
    EKS region
    Key string
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used.
    Name string
    Target name
    TargetEksId string
    The ID of this resource.
    UseGwCloudIdentity bool
    Use the GW's Cloud IAM
    eksAccessKeyId String
    EKS access key ID
    eksClusterCaCert String
    EKS cluster base-64 encoded certificate
    eksClusterEndpoint String
    EKS cluster endpoint (i.e., https://\n\n of the cluster)
    eksClusterName String
    EKS cluster name
    eksSecretAccessKey String
    EKS secret access key
    description String
    Description of the object
    eksRegion String
    EKS region
    key String
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used.
    name String
    Target name
    targetEksId String
    The ID of this resource.
    useGwCloudIdentity Boolean
    Use the GW's Cloud IAM
    eksAccessKeyId string
    EKS access key ID
    eksClusterCaCert string
    EKS cluster base-64 encoded certificate
    eksClusterEndpoint string
    EKS cluster endpoint (i.e., https://\n\n of the cluster)
    eksClusterName string
    EKS cluster name
    eksSecretAccessKey string
    EKS secret access key
    description string
    Description of the object
    eksRegion string
    EKS region
    key string
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used.
    name string
    Target name
    targetEksId string
    The ID of this resource.
    useGwCloudIdentity boolean
    Use the GW's Cloud IAM
    eks_access_key_id str
    EKS access key ID
    eks_cluster_ca_cert str
    EKS cluster base-64 encoded certificate
    eks_cluster_endpoint str
    EKS cluster endpoint (i.e., https://\n\n of the cluster)
    eks_cluster_name str
    EKS cluster name
    eks_secret_access_key str
    EKS secret access key
    description str
    Description of the object
    eks_region str
    EKS region
    key str
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used.
    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
    EKS access key ID
    eksClusterCaCert String
    EKS cluster base-64 encoded certificate
    eksClusterEndpoint String
    EKS cluster endpoint (i.e., https://\n\n of the cluster)
    eksClusterName String
    EKS cluster name
    eksSecretAccessKey String
    EKS secret access key
    description String
    Description of the object
    eksRegion String
    EKS region
    key String
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used.
    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,
            key: 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
    EKS access key ID
    EksClusterCaCert string
    EKS cluster base-64 encoded certificate
    EksClusterEndpoint string
    EKS cluster endpoint (i.e., https://\n\n of the cluster)
    EksClusterName string
    EKS cluster name
    EksRegion string
    EKS region
    EksSecretAccessKey string
    EKS secret access key
    Key string
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used.
    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
    EKS access key ID
    EksClusterCaCert string
    EKS cluster base-64 encoded certificate
    EksClusterEndpoint string
    EKS cluster endpoint (i.e., https://\n\n of the cluster)
    EksClusterName string
    EKS cluster name
    EksRegion string
    EKS region
    EksSecretAccessKey string
    EKS secret access key
    Key string
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used.
    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
    EKS access key ID
    eksClusterCaCert String
    EKS cluster base-64 encoded certificate
    eksClusterEndpoint String
    EKS cluster endpoint (i.e., https://\n\n of the cluster)
    eksClusterName String
    EKS cluster name
    eksRegion String
    EKS region
    eksSecretAccessKey String
    EKS secret access key
    key String
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used.
    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
    EKS access key ID
    eksClusterCaCert string
    EKS cluster base-64 encoded certificate
    eksClusterEndpoint string
    EKS cluster endpoint (i.e., https://\n\n of the cluster)
    eksClusterName string
    EKS cluster name
    eksRegion string
    EKS region
    eksSecretAccessKey string
    EKS secret access key
    key string
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used.
    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
    EKS access key ID
    eks_cluster_ca_cert str
    EKS cluster base-64 encoded certificate
    eks_cluster_endpoint str
    EKS cluster endpoint (i.e., https://\n\n of the cluster)
    eks_cluster_name str
    EKS cluster name
    eks_region str
    EKS region
    eks_secret_access_key str
    EKS secret access key
    key str
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used.
    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
    EKS access key ID
    eksClusterCaCert String
    EKS cluster base-64 encoded certificate
    eksClusterEndpoint String
    EKS cluster endpoint (i.e., https://\n\n of the cluster)
    eksClusterName String
    EKS cluster name
    eksRegion String
    EKS region
    eksSecretAccessKey String
    EKS secret access key
    key String
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used.
    name String
    Target name
    targetEksId String
    The ID of this resource.
    useGwCloudIdentity Boolean
    Use the GW's Cloud IAM

    Package Details

    Repository
    akeyless akeyless-community/terraform-provider-akeyless
    License
    Notes
    This Pulumi package is based on the akeyless Terraform Provider.
    akeyless logo
    akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community