software.amazon.awscdk.services.eks

Class CfnFargateProfile

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.eks.CfnFargateProfile

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.902Z")
 @Stability(value=Stable)
public class CfnFargateProfile
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EKS::FargateProfile`.

Creates an AWS 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 AWS Fargate Profile in the Amazon EKS User Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.eks.*;
 CfnFargateProfile cfnFargateProfile = CfnFargateProfile.Builder.create(this, "MyCfnFargateProfile")
         .clusterName("clusterName")
         .podExecutionRoleArn("podExecutionRoleArn")
         .selectors(List.of(SelectorProperty.builder()
                 .namespace("namespace")
                 // the properties below are optional
                 .labels(List.of(LabelProperty.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .build()))
         // the properties below are optional
         .fargateProfileName("fargateProfileName")
         .subnets(List.of("subnets"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnFargateProfile.Builder A fluent builder for CfnFargateProfile.
static interface	CfnFargateProfile.LabelProperty A key-value pair.
static interface	CfnFargateProfile.SelectorProperty An object representing an AWS Fargate profile selector.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnFargateProfile(software.constructs.Construct scope, String id, CfnFargateProfileProps props) Create a new `AWS::EKS::FargateProfile`.
protected	CfnFargateProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnFargateProfile(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The ARN of the cluster, such as `arn:aws:eks:us-west-2:666666666666:fargateprofile/myCluster/myFargateProfile/1cb1a11a-1dc1-1d11-cf11-1111f11fa111` .
protected Map<String,Object>	getCfnProperties()
String	getClusterName() The name of the Amazon EKS cluster to apply the Fargate profile to.
String	getFargateProfileName() The name of the Fargate profile.
String	getPodExecutionRoleArn() The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate profile.
Object	getSelectors() The selectors to match for pods to use this Fargate profile.
List<String>	getSubnets() The IDs of subnets to launch your pods into.
TagManager	getTags() The metadata to apply to the Fargate profile to assist with categorization and organization.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setClusterName(String value) The name of the Amazon EKS cluster to apply the Fargate profile to.
void	setFargateProfileName(String value) The name of the Fargate profile.
void	setPodExecutionRoleArn(String value) The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate profile.
void	setSelectors(IResolvable value) The selectors to match for pods to use this Fargate profile.
void	setSelectors(List<Object> value) The selectors to match for pods to use this Fargate profile.
void	setSubnets(List<String> value) The IDs of subnets to launch your pods into.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnFargateProfile

protected CfnFargateProfile(software.amazon.jsii.JsiiObjectRef objRef)

CfnFargateProfile

protected CfnFargateProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnFargateProfile

@Stability(value=Stable)
public CfnFargateProfile(@NotNull
                                                  software.constructs.Construct scope,
                                                  @NotNull
                                                  String id,
                                                  @NotNull
                                                  CfnFargateProfileProps props)

Create a new `AWS::EKS::FargateProfile`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The ARN of the cluster, such as `arn:aws:eks:us-west-2:666666666666:fargateprofile/myCluster/myFargateProfile/1cb1a11a-1dc1-1d11-cf11-1111f11fa111` .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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.

getClusterName

@Stability(value=Stable)
 @NotNull
public String getClusterName()

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

setClusterName

@Stability(value=Stable)
public void setClusterName(@NotNull
                                                    String value)

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

getPodExecutionRoleArn

@Stability(value=Stable)
 @NotNull
public String getPodExecutionRoleArn()

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 .

setPodExecutionRoleArn

@Stability(value=Stable)
public void setPodExecutionRoleArn(@NotNull
                                                            String value)

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 .

getSelectors

@Stability(value=Stable)
 @NotNull
public Object getSelectors()

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.

setSelectors

@Stability(value=Stable)
public void setSelectors(@NotNull
                                                  IResolvable value)

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.

setSelectors

@Stability(value=Stable)
public void setSelectors(@NotNull
                                                  List<Object> value)

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.

getFargateProfileName

@Stability(value=Stable)
 @Nullable
public String getFargateProfileName()

The name of the Fargate profile.

setFargateProfileName

@Stability(value=Stable)
public void setFargateProfileName(@Nullable
                                                           String value)

The name of the Fargate profile.

getSubnets

@Stability(value=Stable)
 @Nullable
public List<String> getSubnets()

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.

setSubnets

@Stability(value=Stable)
public void setSubnets(@Nullable
                                                List<String> value)

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.