Struct aws_sdk_eks::client::fluent_builders::CreateFargateProfile

pub struct CreateFargateProfile { /* private fields */ }

Fluent builder constructing a request to CreateFargateProfile.

Creates an Fargate profile for your Amazon EKS cluster. You must have at least one Fargate profile in a cluster to be able to run pods on Fargate.

The Fargate profile allows an administrator to declare which pods run on Fargate and specify which pods run on which Fargate profile. This declaration is done through the profile’s selectors. Each profile can have up to five selectors that contain a namespace and labels. A namespace is required for every selector. The label field consists of multiple optional key-value pairs. Pods that match the selectors are scheduled on Fargate. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is run on Fargate.

When you create a Fargate profile, you must specify a pod execution role to use with the pods that are scheduled with the profile. This role is added to the cluster's Kubernetes Role Based Access Control (RBAC) for authorization so that the kubelet that is running on the Fargate infrastructure can register with your Amazon EKS cluster so that it can appear in your cluster as a node. The pod execution role also provides IAM permissions to the Fargate infrastructure to allow read access to Amazon ECR image repositories. For more information, see Pod Execution Role in the Amazon EKS User Guide.

Fargate profiles are immutable. However, you can create a new updated profile to replace an existing profile and then delete the original after the updated profile has finished creating.

If any Fargate profiles in a cluster are in the DELETING status, you must wait for that Fargate profile to finish deleting before you can create any other profiles in that cluster.

For more information, see Fargate Profile in the Amazon EKS User Guide.

Implementations

impl CreateFargateProfile

pub async fn send(
    self
) -> Result<CreateFargateProfileOutput, SdkError<CreateFargateProfileError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn fargate_profile_name(self, input: impl Into<String>) -> Self

The name of the Fargate profile.

pub fn set_fargate_profile_name(self, input: Option<String>) -> Self

The name of the Fargate profile.

pub fn cluster_name(self, input: impl Into<String>) -> Self

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

pub fn set_cluster_name(self, input: Option<String>) -> Self

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

pub fn pod_execution_role_arn(self, input: impl Into<String>) -> Self

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.

pub fn set_pod_execution_role_arn(self, input: Option<String>) -> Self

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.

pub fn subnets(self, input: impl Into<String>) -> Self

Appends an item to subnets.

To override the contents of this collection use set_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.

pub fn set_subnets(self, input: Option<Vec<String>>) -> Self

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.

pub fn selectors(self, input: FargateProfileSelector) -> Self

Appends an item to selectors.

To override the contents of this collection use set_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.

pub fn set_selectors(self, input: Option<Vec<FargateProfileSelector>>) -> Self

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.

pub fn client_request_token(self, input: impl Into<String>) -> Self

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

pub fn set_client_request_token(self, input: Option<String>) -> Self

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

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to tags.

To override the contents of this collection use set_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.

pub fn set_tags(self, input: Option<HashMap<String, String>>) -> Self

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.

Trait Implementations

impl Clone for CreateFargateProfile

fn clone(&self) -> CreateFargateProfile

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateFargateProfile

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.