Interface CreateFargateProfileRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateFargateProfileRequest.Builder,
,CreateFargateProfileRequest> EksRequest.Builder
,SdkBuilder<CreateFargateProfileRequest.Builder,
,CreateFargateProfileRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateFargateProfileRequest
-
Method Summary
Modifier and TypeMethodDescriptionclientRequestToken
(String clientRequestToken) Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.clusterName
(String clusterName) The name of the Amazon EKS cluster to apply the Fargate profile to.fargateProfileName
(String fargateProfileName) The name of the Fargate profile.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.podExecutionRoleArn
(String podExecutionRoleArn) The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate profile.selectors
(Collection<FargateProfileSelector> selectors) The selectors to match for pods to use this Fargate profile.selectors
(Consumer<FargateProfileSelector.Builder>... selectors) The selectors to match for pods to use this Fargate profile.selectors
(FargateProfileSelector... selectors) The selectors to match for pods to use this Fargate profile.The IDs of subnets to launch your pods into.subnets
(Collection<String> subnets) The IDs of subnets to launch your pods into.The metadata to apply to the Fargate profile to assist with categorization and organization.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.eks.model.EksRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
fargateProfileName
The name of the Fargate profile.
- Parameters:
fargateProfileName
- The name of the Fargate profile.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clusterName
The name of the Amazon EKS cluster to apply the Fargate profile to.
- Parameters:
clusterName
- The name of the Amazon EKS cluster to apply the Fargate profile to.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
podExecutionRoleArn
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.
- Parameters:
podExecutionRoleArn
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
subnets
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.
- Parameters:
subnets
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
subnets
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.
- Parameters:
subnets
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
selectors
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.
- Parameters:
selectors
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
selectors
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.
- Parameters:
selectors
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
selectors
CreateFargateProfileRequest.Builder selectors(Consumer<FargateProfileSelector.Builder>... selectors) 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.
This is a convenience method that creates an instance of theFargateProfileSelector.Builder
avoiding the need to create one manually viaFargateProfileSelector.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toselectors(List<FargateProfileSelector>)
.- Parameters:
selectors
- a consumer that will call methods onFargateProfileSelector.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
clientRequestToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- Parameters:
clientRequestToken
- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
The metadata to apply to the Fargate profile to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Fargate profile tags do not propagate to any other resources associated with the Fargate profile, such as the pods that are scheduled with it.
- Parameters:
tags
- The metadata to apply to the Fargate profile to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. 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:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateFargateProfileRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateFargateProfileRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-