@aws-quickstart/eks-blueprints
    Preparing search index...

    Interface FargateClusterProviderProps

    Configuration options for the cluster provider.

    interface FargateClusterProviderProps {
        clusterName?: string;
        fargateProfiles?:
            | { [key: string]: FargateProfileOptions }
            | Map<string, FargateProfileOptions>;
        isolatedCluster?: boolean;
        name?: string;
        outputClusterName?: boolean;
        outputConfigCommand?: boolean;
        privateCluster?: boolean;
        role?: IRole;
        securityGroup?: ISecurityGroup;
        tags?: { [key: string]: string };
        version?: KubernetesVersion;
        vpc?: IVpc;
        vpcSubnets?: SubnetSelection[];
    }

    Hierarchy

    • Partial<eks.CommonClusterOptions>
      • FargateClusterProviderProps
    Index

    Properties

    clusterName? fargateProfiles? isolatedCluster? name? outputClusterName? outputConfigCommand? privateCluster? role? securityGroup? tags? version? vpc? vpcSubnets?

    Properties

    clusterName?: string

    Name for the cluster.

    - Automatically generated name
    fargateProfiles?:
        | { [key: string]: FargateProfileOptions }
        | Map<string, FargateProfileOptions>

    The Fargate profiles associated with the cluster.

    Note The Map<> form is deprecated and will be removed from a future release.

    isolatedCluster?: boolean

    Is the EKS Cluster in isolated subnets?

    false
    name?: string

    The name for the cluster.

    outputClusterName?: boolean

    Determines whether a CloudFormation output with the name of the cluster will be synthesized.

    false
    outputConfigCommand?: boolean

    Determines whether a CloudFormation output with the aws eks update-kubeconfig command will be synthesized. This command will include the cluster name and the ARN of the masters IAM role.

    Note: If mastersRole is not specified, this property will be ignored and no config command will be emitted.

    https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_eks-readme.html#masters-role

    true
    privateCluster?: boolean

    Is it a private only EKS Cluster? Defaults to private_and_public cluster, set to true for private cluster

    false
    role?: IRole

    Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.

    - A role is automatically created for you
    securityGroup?: ISecurityGroup

    Security Group to use for Control Plane ENIs

    - A security group is automatically created
    tags?: { [key: string]: string }

    Tags for the cluster

    version?: KubernetesVersion

    The Kubernetes version to run in the cluster

    vpc?: IVpc

    The VPC in which to create the Cluster.

    • a VPC with default configuration will be created and can be accessed through cluster.vpc.
    vpcSubnets?: SubnetSelection[]

    Subnets are passed to the cluster configuration.

    Settings

    Member Visibility

    On This Page

    Properties