You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::EKS::Types::CreateFargateProfileRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateFargateProfileRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  fargate_profile_name: "String", # required
  cluster_name: "String", # required
  pod_execution_role_arn: "String", # required
  subnets: ["String"],
  selectors: [
    {
      namespace: "String",
      labels: {
        "String" => "String",
      },
    },
  ],
  client_request_token: "String",
  tags: {
    "TagKey" => "TagValue",
  },
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_token ⇒ String

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

  • (String) —

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

#cluster_name ⇒ String

The name of the Amazon EKS cluster to apply the Fargate profile to.

Returns:

  • (String) —

    The name of the Amazon EKS cluster to apply the Fargate profile to.

#fargate_profile_name ⇒ String

The name of the Fargate profile.

Returns:

  • (String) —

    The name of the Fargate profile.

#pod_execution_role_arn ⇒ String

The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate profile. The pod execution role allows Fargate infrastructure to register with your cluster as a node, and it provides read access to Amazon ECR image repositories. For more information, see Pod Execution Role in the Amazon EKS User Guide.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate profile.

#selectors ⇒ Array<Types::FargateProfileSelector>

The selectors to match for pods to use this Fargate profile. Each selector must have an associated namespace. Optionally, you can also specify labels for a namespace. You may specify up to five selectors in a Fargate profile.

Returns:

#subnets ⇒ Array<String>

The IDs of subnets to launch your pods into. At this time, pods running on Fargate are not assigned public IP addresses, so only private subnets (with no direct route to an Internet Gateway) are accepted for this parameter.

Returns:

  • (Array<String>) —

    The IDs of subnets to launch your pods into.

#tags ⇒ Hash<String,String>

The metadata to apply to the Fargate profile to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Fargate profile tags do not propagate to any other resources associated with the Fargate profile, such as the pods that are scheduled with it.

Returns:

  • (Hash<String,String>) —

    The metadata to apply to the Fargate profile to assist with categorization and organization.