Class FargateProfileOptions
Options for defining EKS Fargate Profiles.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.EKS
Assembly: Amazon.CDK.AWS.EKS.dll
Syntax (csharp)
public class FargateProfileOptions : Object, IFargateProfileOptions
Syntax (vb)
Public Class FargateProfileOptions
Inherits Object
Implements IFargateProfileOptions
Remarks
ExampleMetadata: infused
Examples
Cluster cluster;
cluster.AddFargateProfile("MyProfile", new FargateProfileOptions {
Selectors = new [] { new Selector { Namespace = "default" } }
});
Synopsis
Constructors
FargateProfileOptions() |
Properties
FargateProfileName | The name of the Fargate profile. |
PodExecutionRole | The pod execution role to use for pods that match the selectors in the Fargate profile. |
Selectors | The selectors to match for pods to use this Fargate profile. |
SubnetSelection | Select which subnets to launch your pods into. |
Vpc | The VPC from which to select subnets to launch your pods into. |
Constructors
FargateProfileOptions()
public FargateProfileOptions()
Properties
FargateProfileName
The name of the Fargate profile.
public string FargateProfileName { get; set; }
Property Value
System.String
Remarks
Default: - generated
PodExecutionRole
The pod execution role to use for pods that match the selectors in the Fargate profile.
public IRole PodExecutionRole { get; set; }
Property Value
Remarks
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.
Default: - a role will be automatically created
See: https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html
Selectors
The selectors to match for pods to use this Fargate profile.
public ISelector[] Selectors { get; set; }
Property Value
Remarks
Each selector must have an associated namespace. Optionally, you can also specify labels for a namespace.
At least one selector is required and you may specify up to five selectors.
SubnetSelection
Select which subnets to launch your pods into.
public ISubnetSelection SubnetSelection { get; set; }
Property Value
Remarks
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 allowed.
You must specify the VPC to customize the subnet selection
Default: - all private subnets of the VPC are selected.
Vpc
The VPC from which to select subnets to launch your pods into.
public IVpc Vpc { get; set; }
Property Value
Remarks
By default, all private subnets are selected. You can customize this using
subnetSelection
.
Default: - all private subnets used by the EKS cluster