Package software.amazon.awscdk.services.eks

Interface CfnFargateProfileProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnFargateProfileProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:46.531Z") @Stability(Stable) public interface CfnFargateProfileProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnFargateProfile.

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.*;
 CfnFargateProfileProps cfnFargateProfileProps = CfnFargateProfileProps.builder()
         .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();

  • Method Details

    • getClusterName

      @Stability(Stable) @NotNull String getClusterName()
      The name of the Amazon EKS cluster to apply the Fargate profile to.

    • getPodExecutionRoleArn

      @Stability(Stable) @NotNull 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 .

    • getSelectors

      @Stability(Stable) @NotNull 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.

    • getFargateProfileName

      @Stability(Stable) @Nullable default String getFargateProfileName()
      The name of the Fargate profile.

    • getSubnets

      @Stability(Stable) @Nullable default 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.

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> 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.

    • builder

      @Stability(Stable) static CfnFargateProfileProps.Builder builder()
      Returns:
      a CfnFargateProfileProps.Builder of CfnFargateProfileProps