@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-14T16:25:34.937Z") public class CfnFargateProfile extends CfnResource implements IInspectable
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.legacy.*; 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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnFargateProfile(Construct scope,
java.lang.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) |
Modifier and Type | Method and Description |
---|---|
java.lang.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 java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getClusterName()
The name of the Amazon EKS cluster to apply the Fargate profile to.
|
java.lang.String |
getFargateProfileName()
The name of the Fargate profile.
|
java.lang.String |
getPodExecutionRoleArn()
The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate profile.
|
java.lang.Object |
getSelectors()
The selectors to match for pods to use this Fargate profile.
|
java.util.List<java.lang.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 java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setClusterName(java.lang.String value)
The name of the Amazon EKS cluster to apply the Fargate profile to.
|
void |
setFargateProfileName(java.lang.String value)
The name of the Fargate profile.
|
void |
setPodExecutionRoleArn(java.lang.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(java.util.List<java.lang.Object> value)
The selectors to match for pods to use this Fargate profile.
|
void |
setSubnets(java.util.List<java.lang.String> value)
The IDs of subnets to launch your pods into.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnFargateProfile(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnFargateProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnFargateProfile(Construct scope, java.lang.String id, CfnFargateProfileProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
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.
public java.lang.String getClusterName()
public void setClusterName(java.lang.String value)
public java.lang.String getPodExecutionRoleArn()
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 .
public void setPodExecutionRoleArn(java.lang.String value)
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 .
public java.lang.Object getSelectors()
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.
public void setSelectors(IResolvable value)
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.
public void setSelectors(java.util.List<java.lang.Object> value)
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.
public java.lang.String getFargateProfileName()
public void setFargateProfileName(java.lang.String value)
public java.util.List<java.lang.String> getSubnets()
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.
public void setSubnets(java.util.List<java.lang.String> value)
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.