Package software.amazon.awscdk.services.eks

Class KubectlProvider

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Stack

software.amazon.awscdk.NestedStack

software.amazon.awscdk.services.eks.KubectlProvider

All Implemented Interfaces:

ITaggable, IKubectlProvider, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:01.475Z")
@Stability(Stable)
public class KubectlProvider
extends NestedStack
implements IKubectlProvider

Implementation of Kubectl Lambda.

Example:

 IRole handlerRole = Role.fromRoleArn(this, "HandlerRole", "arn:aws:iam::123456789012:role/lambda-role");
 // get the serivceToken from the custom resource provider
 String functionArn = Function.fromFunctionName(this, "ProviderOnEventFunc", "ProviderframeworkonEvent-XXX").getFunctionArn();
 IKubectlProvider kubectlProvider = KubectlProvider.fromKubectlProviderAttributes(this, "KubectlProvider", KubectlProviderAttributes.builder()
         .functionArn(functionArn)
         .kubectlRoleArn("arn:aws:iam::123456789012:role/kubectl-role")
         .handlerRole(handlerRole)
         .build());
 ICluster cluster = Cluster.fromClusterAttributes(this, "Cluster", ClusterAttributes.builder()
         .clusterName("cluster")
         .kubectlProvider(kubectlProvider)
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	KubectlProvider.Builder	A fluent builder for KubectlProvider.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.eks.IKubectlProvider

IKubectlProvider.Jsii$Default, IKubectlProvider.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	KubectlProvider(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	KubectlProvider(software.amazon.jsii.JsiiObjectRef objRef)
	KubectlProvider(software.constructs.Construct scope, String id, KubectlProviderProps props)

Method Summary

Modifier and Type	Method	Description
static IKubectlProvider	fromKubectlProviderAttributes(software.constructs.Construct scope, String id, KubectlProviderAttributes attrs)	Import an existing provider.
IRole	getHandlerRole()	The IAM execution role of the handler.
static IKubectlProvider	getOrCreate(software.constructs.Construct scope, ICluster cluster)	Take existing provider or create new based on cluster.
String	getRoleArn()	The IAM role to assume in order to perform kubectl operations against this cluster.
String	getServiceToken()	The custom resource provider's service token.

Methods inherited from class software.amazon.awscdk.NestedStack

getNestedStackResource, getStackId, getStackName, getTemplateFile, isNestedStack, setParameter

Methods inherited from class software.amazon.awscdk.Stack

addDependency, addDependency, addMetadata, addTransform, allocateLogicalId, exportStringListValue, exportStringListValue, exportValue, exportValue, formatArn, getAccount, getArtifactId, getAvailabilityZones, getBundlingRequired, getDependencies, getEnvironment, getLogicalId, getNested, getNestedStackParent, getNotificationArns, getPartition, getRegion, getSynthesizer, getTags, getTemplateOptions, getTerminationProtection, getUrlSuffix, isStack, of, regionalFact, regionalFact, renameLogicalId, reportMissingContextKey, resolve, setTerminationProtection, splitArn, toJsonString, toJsonString, toYamlString

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

KubectlProvider

protected KubectlProvider(software.amazon.jsii.JsiiObjectRef objRef)

KubectlProvider

protected KubectlProvider(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

KubectlProvider

@Stability(Stable)
public KubectlProvider(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 KubectlProviderProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromKubectlProviderAttributes

@Stability(Stable)
@NotNull
public static IKubectlProvider fromKubectlProviderAttributes(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 KubectlProviderAttributes attrs)

Import an existing provider.

Parameters:

scope - Construct. This parameter is required.

id - an id of resource. This parameter is required.

attrs - attributes for the provider. This parameter is required.

getOrCreate

@Stability(Stable)
@NotNull
public static IKubectlProvider getOrCreate(@NotNull
 software.constructs.Construct scope,
 @NotNull
 ICluster cluster)

Take existing provider or create new based on cluster.

Parameters:

scope - Construct. This parameter is required.

cluster - k8s cluster. This parameter is required.

getHandlerRole

@Stability(Stable)
@NotNull
public IRole getHandlerRole()

The IAM execution role of the handler.

Specified by:

getHandlerRole in interface IKubectlProvider

getRoleArn

@Stability(Stable)
@NotNull
public String getRoleArn()

The IAM role to assume in order to perform kubectl operations against this cluster.

Specified by:

getRoleArn in interface IKubectlProvider

getServiceToken

@Stability(Stable)
@NotNull
public String getServiceToken()

The custom resource provider's service token.

Specified by:

getServiceToken in interface IKubectlProvider