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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-eks/types.rb

Overview

Note:

When making an API call, you may pass CreateFargateProfileRequest data as a 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",
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

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

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

  • (String)

828
829
830
831
832
833
834
835
836
837
838
# File 'lib/aws-sdk-eks/types.rb', line 828

class CreateFargateProfileRequest < Struct.new(
  :fargate_profile_name,
  :cluster_name,
  :pod_execution_role_arn,
  :subnets,
  :selectors,
  :client_request_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_nameString

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

Returns:

  • (String)

828
829
830
831
832
833
834
835
836
837
838
# File 'lib/aws-sdk-eks/types.rb', line 828

class CreateFargateProfileRequest < Struct.new(
  :fargate_profile_name,
  :cluster_name,
  :pod_execution_role_arn,
  :subnets,
  :selectors,
  :client_request_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#fargate_profile_nameString

The name of the Fargate profile.

Returns:

  • (String)

828
829
830
831
832
833
834
835
836
837
838
# File 'lib/aws-sdk-eks/types.rb', line 828

class CreateFargateProfileRequest < Struct.new(
  :fargate_profile_name,
  :cluster_name,
  :pod_execution_role_arn,
  :subnets,
  :selectors,
  :client_request_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#pod_execution_role_arnString

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*.

[1]: docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html

Returns:

  • (String)

828
829
830
831
832
833
834
835
836
837
838
# File 'lib/aws-sdk-eks/types.rb', line 828

class CreateFargateProfileRequest < Struct.new(
  :fargate_profile_name,
  :cluster_name,
  :pod_execution_role_arn,
  :subnets,
  :selectors,
  :client_request_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#selectorsArray<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:


828
829
830
831
832
833
834
835
836
837
838
# File 'lib/aws-sdk-eks/types.rb', line 828

class CreateFargateProfileRequest < Struct.new(
  :fargate_profile_name,
  :cluster_name,
  :pod_execution_role_arn,
  :subnets,
  :selectors,
  :client_request_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#subnetsArray<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>)

828
829
830
831
832
833
834
835
836
837
838
# File 'lib/aws-sdk-eks/types.rb', line 828

class CreateFargateProfileRequest < Struct.new(
  :fargate_profile_name,
  :cluster_name,
  :pod_execution_role_arn,
  :subnets,
  :selectors,
  :client_request_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<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>)

828
829
830
831
832
833
834
835
836
837
838
# File 'lib/aws-sdk-eks/types.rb', line 828

class CreateFargateProfileRequest < Struct.new(
  :fargate_profile_name,
  :cluster_name,
  :pod_execution_role_arn,
  :subnets,
  :selectors,
  :client_request_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end