1. Packages
  2. AWS
  3. API Docs
  4. eks
  5. FargateProfile
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

aws.eks.FargateProfile

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

    Manages an EKS Fargate Profile.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.eks.FargateProfile("example", {
        clusterName: exampleAwsEksCluster.name,
        fargateProfileName: "example",
        podExecutionRoleArn: exampleAwsIamRole.arn,
        subnetIds: exampleAwsSubnet.map(__item => __item.id),
        selectors: [{
            namespace: "example",
        }],
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.eks.FargateProfile("example",
        cluster_name=example_aws_eks_cluster["name"],
        fargate_profile_name="example",
        pod_execution_role_arn=example_aws_iam_role["arn"],
        subnet_ids=[__item["id"] for __item in example_aws_subnet],
        selectors=[{
            "namespace": "example",
        }])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/eks"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
    var splat0 []interface{}
    for _, val0 := range exampleAwsSubnet {
    splat0 = append(splat0, val0.Id)
    }
    _, err := eks.NewFargateProfile(ctx, "example", &eks.FargateProfileArgs{
    ClusterName: pulumi.Any(exampleAwsEksCluster.Name),
    FargateProfileName: pulumi.String("example"),
    PodExecutionRoleArn: pulumi.Any(exampleAwsIamRole.Arn),
    SubnetIds: toPulumiArray(splat0),
    Selectors: eks.FargateProfileSelectorArray{
    &eks.FargateProfileSelectorArgs{
    Namespace: pulumi.String("example"),
    },
    },
    })
    if err != nil {
    return err
    }
    return nil
    })
    }
    func toPulumiArray(arr []) pulumi.Array {
    var pulumiArr pulumi.Array
    for _, v := range arr {
    pulumiArr = append(pulumiArr, pulumi.(v))
    }
    return pulumiArr
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Eks.FargateProfile("example", new()
        {
            ClusterName = exampleAwsEksCluster.Name,
            FargateProfileName = "example",
            PodExecutionRoleArn = exampleAwsIamRole.Arn,
            SubnetIds = exampleAwsSubnet.Select(__item => __item.Id).ToList(),
            Selectors = new[]
            {
                new Aws.Eks.Inputs.FargateProfileSelectorArgs
                {
                    Namespace = "example",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.eks.FargateProfile;
    import com.pulumi.aws.eks.FargateProfileArgs;
    import com.pulumi.aws.eks.inputs.FargateProfileSelectorArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new FargateProfile("example", FargateProfileArgs.builder()
                .clusterName(exampleAwsEksCluster.name())
                .fargateProfileName("example")
                .podExecutionRoleArn(exampleAwsIamRole.arn())
                .subnetIds(exampleAwsSubnet.stream().map(element -> element.id()).collect(toList()))
                .selectors(FargateProfileSelectorArgs.builder()
                    .namespace("example")
                    .build())
                .build());
    
        }
    }
    
    Coming soon!
    

    Example IAM Role for EKS Fargate Profile

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.iam.Role("example", {
        name: "eks-fargate-profile-example",
        assumeRolePolicy: JSON.stringify({
            Statement: [{
                Action: "sts:AssumeRole",
                Effect: "Allow",
                Principal: {
                    Service: "eks-fargate-pods.amazonaws.com",
                },
            }],
            Version: "2012-10-17",
        }),
    });
    const example_AmazonEKSFargatePodExecutionRolePolicy = new aws.iam.RolePolicyAttachment("example-AmazonEKSFargatePodExecutionRolePolicy", {
        policyArn: "arn:aws:iam::aws:policy/AmazonEKSFargatePodExecutionRolePolicy",
        role: example.name,
    });
    
    import pulumi
    import json
    import pulumi_aws as aws
    
    example = aws.iam.Role("example",
        name="eks-fargate-profile-example",
        assume_role_policy=json.dumps({
            "Statement": [{
                "Action": "sts:AssumeRole",
                "Effect": "Allow",
                "Principal": {
                    "Service": "eks-fargate-pods.amazonaws.com",
                },
            }],
            "Version": "2012-10-17",
        }))
    example__amazon_eks_fargate_pod_execution_role_policy = aws.iam.RolePolicyAttachment("example-AmazonEKSFargatePodExecutionRolePolicy",
        policy_arn="arn:aws:iam::aws:policy/AmazonEKSFargatePodExecutionRolePolicy",
        role=example.name)
    
    package main
    
    import (
    	"encoding/json"
    
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iam"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		tmpJSON0, err := json.Marshal(map[string]interface{}{
    			"Statement": []map[string]interface{}{
    				map[string]interface{}{
    					"Action": "sts:AssumeRole",
    					"Effect": "Allow",
    					"Principal": map[string]interface{}{
    						"Service": "eks-fargate-pods.amazonaws.com",
    					},
    				},
    			},
    			"Version": "2012-10-17",
    		})
    		if err != nil {
    			return err
    		}
    		json0 := string(tmpJSON0)
    		example, err := iam.NewRole(ctx, "example", &iam.RoleArgs{
    			Name:             pulumi.String("eks-fargate-profile-example"),
    			AssumeRolePolicy: pulumi.String(json0),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = iam.NewRolePolicyAttachment(ctx, "example-AmazonEKSFargatePodExecutionRolePolicy", &iam.RolePolicyAttachmentArgs{
    			PolicyArn: pulumi.String("arn:aws:iam::aws:policy/AmazonEKSFargatePodExecutionRolePolicy"),
    			Role:      example.Name,
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using System.Text.Json;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Iam.Role("example", new()
        {
            Name = "eks-fargate-profile-example",
            AssumeRolePolicy = JsonSerializer.Serialize(new Dictionary<string, object?>
            {
                ["Statement"] = new[]
                {
                    new Dictionary<string, object?>
                    {
                        ["Action"] = "sts:AssumeRole",
                        ["Effect"] = "Allow",
                        ["Principal"] = new Dictionary<string, object?>
                        {
                            ["Service"] = "eks-fargate-pods.amazonaws.com",
                        },
                    },
                },
                ["Version"] = "2012-10-17",
            }),
        });
    
        var example_AmazonEKSFargatePodExecutionRolePolicy = new Aws.Iam.RolePolicyAttachment("example-AmazonEKSFargatePodExecutionRolePolicy", new()
        {
            PolicyArn = "arn:aws:iam::aws:policy/AmazonEKSFargatePodExecutionRolePolicy",
            Role = example.Name,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.iam.Role;
    import com.pulumi.aws.iam.RoleArgs;
    import com.pulumi.aws.iam.RolePolicyAttachment;
    import com.pulumi.aws.iam.RolePolicyAttachmentArgs;
    import static com.pulumi.codegen.internal.Serialization.*;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new Role("example", RoleArgs.builder()
                .name("eks-fargate-profile-example")
                .assumeRolePolicy(serializeJson(
                    jsonObject(
                        jsonProperty("Statement", jsonArray(jsonObject(
                            jsonProperty("Action", "sts:AssumeRole"),
                            jsonProperty("Effect", "Allow"),
                            jsonProperty("Principal", jsonObject(
                                jsonProperty("Service", "eks-fargate-pods.amazonaws.com")
                            ))
                        ))),
                        jsonProperty("Version", "2012-10-17")
                    )))
                .build());
    
            var example_AmazonEKSFargatePodExecutionRolePolicy = new RolePolicyAttachment("example-AmazonEKSFargatePodExecutionRolePolicy", RolePolicyAttachmentArgs.builder()
                .policyArn("arn:aws:iam::aws:policy/AmazonEKSFargatePodExecutionRolePolicy")
                .role(example.name())
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:iam:Role
        properties:
          name: eks-fargate-profile-example
          assumeRolePolicy:
            fn::toJSON:
              Statement:
                - Action: sts:AssumeRole
                  Effect: Allow
                  Principal:
                    Service: eks-fargate-pods.amazonaws.com
              Version: 2012-10-17
      example-AmazonEKSFargatePodExecutionRolePolicy:
        type: aws:iam:RolePolicyAttachment
        properties:
          policyArn: arn:aws:iam::aws:policy/AmazonEKSFargatePodExecutionRolePolicy
          role: ${example.name}
    

    Create FargateProfile Resource

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

    Constructor syntax

    new FargateProfile(name: string, args: FargateProfileArgs, opts?: CustomResourceOptions);
    @overload
    def FargateProfile(resource_name: str,
                       args: FargateProfileArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def FargateProfile(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       cluster_name: Optional[str] = None,
                       pod_execution_role_arn: Optional[str] = None,
                       selectors: Optional[Sequence[FargateProfileSelectorArgs]] = None,
                       fargate_profile_name: Optional[str] = None,
                       subnet_ids: Optional[Sequence[str]] = None,
                       tags: Optional[Mapping[str, str]] = None)
    func NewFargateProfile(ctx *Context, name string, args FargateProfileArgs, opts ...ResourceOption) (*FargateProfile, error)
    public FargateProfile(string name, FargateProfileArgs args, CustomResourceOptions? opts = null)
    public FargateProfile(String name, FargateProfileArgs args)
    public FargateProfile(String name, FargateProfileArgs args, CustomResourceOptions options)
    
    type: aws:eks:FargateProfile
    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 FargateProfileArgs
    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 FargateProfileArgs
    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 FargateProfileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FargateProfileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FargateProfileArgs
    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 fargateProfileResource = new Aws.Eks.FargateProfile("fargateProfileResource", new()
    {
        ClusterName = "string",
        PodExecutionRoleArn = "string",
        Selectors = new[]
        {
            new Aws.Eks.Inputs.FargateProfileSelectorArgs
            {
                Namespace = "string",
                Labels = 
                {
                    { "string", "string" },
                },
            },
        },
        FargateProfileName = "string",
        SubnetIds = new[]
        {
            "string",
        },
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := eks.NewFargateProfile(ctx, "fargateProfileResource", &eks.FargateProfileArgs{
    	ClusterName:         pulumi.String("string"),
    	PodExecutionRoleArn: pulumi.String("string"),
    	Selectors: eks.FargateProfileSelectorArray{
    		&eks.FargateProfileSelectorArgs{
    			Namespace: pulumi.String("string"),
    			Labels: pulumi.StringMap{
    				"string": pulumi.String("string"),
    			},
    		},
    	},
    	FargateProfileName: pulumi.String("string"),
    	SubnetIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var fargateProfileResource = new FargateProfile("fargateProfileResource", FargateProfileArgs.builder()
        .clusterName("string")
        .podExecutionRoleArn("string")
        .selectors(FargateProfileSelectorArgs.builder()
            .namespace("string")
            .labels(Map.of("string", "string"))
            .build())
        .fargateProfileName("string")
        .subnetIds("string")
        .tags(Map.of("string", "string"))
        .build());
    
    fargate_profile_resource = aws.eks.FargateProfile("fargateProfileResource",
        cluster_name="string",
        pod_execution_role_arn="string",
        selectors=[{
            "namespace": "string",
            "labels": {
                "string": "string",
            },
        }],
        fargate_profile_name="string",
        subnet_ids=["string"],
        tags={
            "string": "string",
        })
    
    const fargateProfileResource = new aws.eks.FargateProfile("fargateProfileResource", {
        clusterName: "string",
        podExecutionRoleArn: "string",
        selectors: [{
            namespace: "string",
            labels: {
                string: "string",
            },
        }],
        fargateProfileName: "string",
        subnetIds: ["string"],
        tags: {
            string: "string",
        },
    });
    
    type: aws:eks:FargateProfile
    properties:
        clusterName: string
        fargateProfileName: string
        podExecutionRoleArn: string
        selectors:
            - labels:
                string: string
              namespace: string
        subnetIds:
            - string
        tags:
            string: string
    

    FargateProfile 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 FargateProfile resource accepts the following input properties:

    ClusterName string
    Name of the EKS Cluster.
    PodExecutionRoleArn string
    Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Fargate Profile.
    Selectors List<FargateProfileSelector>
    Configuration block(s) for selecting Kubernetes Pods to execute with this EKS Fargate Profile. Detailed below.
    FargateProfileName string
    Name of the EKS Fargate Profile.
    SubnetIds List<string>

    Identifiers of private EC2 Subnets to associate with the EKS Fargate Profile. These subnets must have the following resource tag: kubernetes.io/cluster/CLUSTER_NAME (where CLUSTER_NAME is replaced with the name of the EKS Cluster).

    The following arguments are optional:

    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    ClusterName string
    Name of the EKS Cluster.
    PodExecutionRoleArn string
    Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Fargate Profile.
    Selectors []FargateProfileSelectorArgs
    Configuration block(s) for selecting Kubernetes Pods to execute with this EKS Fargate Profile. Detailed below.
    FargateProfileName string
    Name of the EKS Fargate Profile.
    SubnetIds []string

    Identifiers of private EC2 Subnets to associate with the EKS Fargate Profile. These subnets must have the following resource tag: kubernetes.io/cluster/CLUSTER_NAME (where CLUSTER_NAME is replaced with the name of the EKS Cluster).

    The following arguments are optional:

    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    clusterName String
    Name of the EKS Cluster.
    podExecutionRoleArn String
    Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Fargate Profile.
    selectors List<FargateProfileSelector>
    Configuration block(s) for selecting Kubernetes Pods to execute with this EKS Fargate Profile. Detailed below.
    fargateProfileName String
    Name of the EKS Fargate Profile.
    subnetIds List<String>

    Identifiers of private EC2 Subnets to associate with the EKS Fargate Profile. These subnets must have the following resource tag: kubernetes.io/cluster/CLUSTER_NAME (where CLUSTER_NAME is replaced with the name of the EKS Cluster).

    The following arguments are optional:

    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    clusterName string
    Name of the EKS Cluster.
    podExecutionRoleArn string
    Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Fargate Profile.
    selectors FargateProfileSelector[]
    Configuration block(s) for selecting Kubernetes Pods to execute with this EKS Fargate Profile. Detailed below.
    fargateProfileName string
    Name of the EKS Fargate Profile.
    subnetIds string[]

    Identifiers of private EC2 Subnets to associate with the EKS Fargate Profile. These subnets must have the following resource tag: kubernetes.io/cluster/CLUSTER_NAME (where CLUSTER_NAME is replaced with the name of the EKS Cluster).

    The following arguments are optional:

    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    cluster_name str
    Name of the EKS Cluster.
    pod_execution_role_arn str
    Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Fargate Profile.
    selectors Sequence[FargateProfileSelectorArgs]
    Configuration block(s) for selecting Kubernetes Pods to execute with this EKS Fargate Profile. Detailed below.
    fargate_profile_name str
    Name of the EKS Fargate Profile.
    subnet_ids Sequence[str]

    Identifiers of private EC2 Subnets to associate with the EKS Fargate Profile. These subnets must have the following resource tag: kubernetes.io/cluster/CLUSTER_NAME (where CLUSTER_NAME is replaced with the name of the EKS Cluster).

    The following arguments are optional:

    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    clusterName String
    Name of the EKS Cluster.
    podExecutionRoleArn String
    Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Fargate Profile.
    selectors List<Property Map>
    Configuration block(s) for selecting Kubernetes Pods to execute with this EKS Fargate Profile. Detailed below.
    fargateProfileName String
    Name of the EKS Fargate Profile.
    subnetIds List<String>

    Identifiers of private EC2 Subnets to associate with the EKS Fargate Profile. These subnets must have the following resource tag: kubernetes.io/cluster/CLUSTER_NAME (where CLUSTER_NAME is replaced with the name of the EKS Cluster).

    The following arguments are optional:

    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string
    Amazon Resource Name (ARN) of the EKS Fargate Profile.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Status of the EKS Fargate Profile.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    Amazon Resource Name (ARN) of the EKS Fargate Profile.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Status of the EKS Fargate Profile.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) of the EKS Fargate Profile.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Status of the EKS Fargate Profile.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    Amazon Resource Name (ARN) of the EKS Fargate Profile.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    Status of the EKS Fargate Profile.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    Amazon Resource Name (ARN) of the EKS Fargate Profile.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    Status of the EKS Fargate Profile.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) of the EKS Fargate Profile.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Status of the EKS Fargate Profile.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing FargateProfile Resource

    Get an existing FargateProfile 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?: FargateProfileState, opts?: CustomResourceOptions): FargateProfile
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            cluster_name: Optional[str] = None,
            fargate_profile_name: Optional[str] = None,
            pod_execution_role_arn: Optional[str] = None,
            selectors: Optional[Sequence[FargateProfileSelectorArgs]] = None,
            status: Optional[str] = None,
            subnet_ids: Optional[Sequence[str]] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None) -> FargateProfile
    func GetFargateProfile(ctx *Context, name string, id IDInput, state *FargateProfileState, opts ...ResourceOption) (*FargateProfile, error)
    public static FargateProfile Get(string name, Input<string> id, FargateProfileState? state, CustomResourceOptions? opts = null)
    public static FargateProfile get(String name, Output<String> id, FargateProfileState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Arn string
    Amazon Resource Name (ARN) of the EKS Fargate Profile.
    ClusterName string
    Name of the EKS Cluster.
    FargateProfileName string
    Name of the EKS Fargate Profile.
    PodExecutionRoleArn string
    Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Fargate Profile.
    Selectors List<FargateProfileSelector>
    Configuration block(s) for selecting Kubernetes Pods to execute with this EKS Fargate Profile. Detailed below.
    Status string
    Status of the EKS Fargate Profile.
    SubnetIds List<string>

    Identifiers of private EC2 Subnets to associate with the EKS Fargate Profile. These subnets must have the following resource tag: kubernetes.io/cluster/CLUSTER_NAME (where CLUSTER_NAME is replaced with the name of the EKS Cluster).

    The following arguments are optional:

    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    Amazon Resource Name (ARN) of the EKS Fargate Profile.
    ClusterName string
    Name of the EKS Cluster.
    FargateProfileName string
    Name of the EKS Fargate Profile.
    PodExecutionRoleArn string
    Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Fargate Profile.
    Selectors []FargateProfileSelectorArgs
    Configuration block(s) for selecting Kubernetes Pods to execute with this EKS Fargate Profile. Detailed below.
    Status string
    Status of the EKS Fargate Profile.
    SubnetIds []string

    Identifiers of private EC2 Subnets to associate with the EKS Fargate Profile. These subnets must have the following resource tag: kubernetes.io/cluster/CLUSTER_NAME (where CLUSTER_NAME is replaced with the name of the EKS Cluster).

    The following arguments are optional:

    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) of the EKS Fargate Profile.
    clusterName String
    Name of the EKS Cluster.
    fargateProfileName String
    Name of the EKS Fargate Profile.
    podExecutionRoleArn String
    Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Fargate Profile.
    selectors List<FargateProfileSelector>
    Configuration block(s) for selecting Kubernetes Pods to execute with this EKS Fargate Profile. Detailed below.
    status String
    Status of the EKS Fargate Profile.
    subnetIds List<String>

    Identifiers of private EC2 Subnets to associate with the EKS Fargate Profile. These subnets must have the following resource tag: kubernetes.io/cluster/CLUSTER_NAME (where CLUSTER_NAME is replaced with the name of the EKS Cluster).

    The following arguments are optional:

    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    Amazon Resource Name (ARN) of the EKS Fargate Profile.
    clusterName string
    Name of the EKS Cluster.
    fargateProfileName string
    Name of the EKS Fargate Profile.
    podExecutionRoleArn string
    Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Fargate Profile.
    selectors FargateProfileSelector[]
    Configuration block(s) for selecting Kubernetes Pods to execute with this EKS Fargate Profile. Detailed below.
    status string
    Status of the EKS Fargate Profile.
    subnetIds string[]

    Identifiers of private EC2 Subnets to associate with the EKS Fargate Profile. These subnets must have the following resource tag: kubernetes.io/cluster/CLUSTER_NAME (where CLUSTER_NAME is replaced with the name of the EKS Cluster).

    The following arguments are optional:

    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    Amazon Resource Name (ARN) of the EKS Fargate Profile.
    cluster_name str
    Name of the EKS Cluster.
    fargate_profile_name str
    Name of the EKS Fargate Profile.
    pod_execution_role_arn str
    Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Fargate Profile.
    selectors Sequence[FargateProfileSelectorArgs]
    Configuration block(s) for selecting Kubernetes Pods to execute with this EKS Fargate Profile. Detailed below.
    status str
    Status of the EKS Fargate Profile.
    subnet_ids Sequence[str]

    Identifiers of private EC2 Subnets to associate with the EKS Fargate Profile. These subnets must have the following resource tag: kubernetes.io/cluster/CLUSTER_NAME (where CLUSTER_NAME is replaced with the name of the EKS Cluster).

    The following arguments are optional:

    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) of the EKS Fargate Profile.
    clusterName String
    Name of the EKS Cluster.
    fargateProfileName String
    Name of the EKS Fargate Profile.
    podExecutionRoleArn String
    Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Fargate Profile.
    selectors List<Property Map>
    Configuration block(s) for selecting Kubernetes Pods to execute with this EKS Fargate Profile. Detailed below.
    status String
    Status of the EKS Fargate Profile.
    subnetIds List<String>

    Identifiers of private EC2 Subnets to associate with the EKS Fargate Profile. These subnets must have the following resource tag: kubernetes.io/cluster/CLUSTER_NAME (where CLUSTER_NAME is replaced with the name of the EKS Cluster).

    The following arguments are optional:

    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Supporting Types

    FargateProfileSelector, FargateProfileSelectorArgs

    Namespace string

    Kubernetes namespace for selection.

    The following arguments are optional:

    Labels Dictionary<string, string>
    Key-value map of Kubernetes labels for selection.
    Namespace string

    Kubernetes namespace for selection.

    The following arguments are optional:

    Labels map[string]string
    Key-value map of Kubernetes labels for selection.
    namespace String

    Kubernetes namespace for selection.

    The following arguments are optional:

    labels Map<String,String>
    Key-value map of Kubernetes labels for selection.
    namespace string

    Kubernetes namespace for selection.

    The following arguments are optional:

    labels {[key: string]: string}
    Key-value map of Kubernetes labels for selection.
    namespace str

    Kubernetes namespace for selection.

    The following arguments are optional:

    labels Mapping[str, str]
    Key-value map of Kubernetes labels for selection.
    namespace String

    Kubernetes namespace for selection.

    The following arguments are optional:

    labels Map<String>
    Key-value map of Kubernetes labels for selection.

    Import

    Using pulumi import, import EKS Fargate Profiles using the cluster_name and fargate_profile_name separated by a colon (:). For example:

    $ pulumi import aws:eks/fargateProfile:FargateProfile my_fargate_profile my_cluster:my_fargate_profile
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi