Class ImportClusterProvider

constructor

• new ImportClusterProvider(props): ImportClusterProvider

• Parameters

  • props: ImportClusterProviderProps

  Returns ImportClusterProvider

Readonlyid

Readonlyprops

createCluster

• createCluster(scope, vpc, _secretsEncryptionKey?): ClusterInfo

• Implements contract method to create a cluster, by importing an existing cluster.

  Parameters

  • scope: Construct
  • vpc: IVpc
  • Optional_secretsEncryptionKey: IKey

  Returns ClusterInfo

StaticfromClusterAttributes

• fromClusterAttributes(sdkCluster, kubectlRole): ClusterProvider

• Creates a cluster provider for an existing cluster based on the passed result of the describe cluster command.

  Parameters

  • sdkCluster: Cluster
  • kubectlRole: IRole

  Returns ClusterProvider

StaticfromClusterLookup

• fromClusterLookup(clusterName, region, kubectlRole): Promise<ClusterProvider>

• Requires iam permission to eks.DescribeCluster at build time. Retrieves the cluster information using DescribeCluster api and creates an import cluster provider.

  Parameters

  • clusterName: string

    name of the cluster
  • region: string

    target rego
  • kubectlRole: IRole

    iam Role that provides access to the cluster API (kubectl). The CDK custom resource should be able to assume the role which in some cases may require trust policy for the account root principal.

  Returns Promise<ClusterProvider>

  the cluster provider with the import cluster configuration