Package software.amazon.awscdk.services.eks.v2.alpha

Class KubectlProviderProps.Builder

java.lang.Object

software.amazon.awscdk.services.eks.v2.alpha.KubectlProviderProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<KubectlProviderProps>

Enclosing interface:

KubectlProviderProps

@Stability(Experimental)
public static final class KubectlProviderProps.Builder
extends Object
implements software.amazon.jsii.Builder<KubectlProviderProps>

A builder for KubectlProviderProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
KubectlProviderProps.Builder	awscliLayer(ILayerVersion awscliLayer)	Sets the value of KubectlProviderOptions.getAwscliLayer()
KubectlProviderProps	build()	Builds the configured instance.
KubectlProviderProps.Builder	cluster(ICluster cluster)	Sets the value of KubectlProviderProps.getCluster()
KubectlProviderProps.Builder	environment(Map<String,String> environment)	Sets the value of KubectlProviderOptions.getEnvironment()
KubectlProviderProps.Builder	kubectlLayer(ILayerVersion kubectlLayer)	Sets the value of KubectlProviderOptions.getKubectlLayer()
KubectlProviderProps.Builder	memory(Size memory)	Sets the value of KubectlProviderOptions.getMemory()
KubectlProviderProps.Builder	privateSubnets(List<? extends ISubnet> privateSubnets)	Sets the value of KubectlProviderOptions.getPrivateSubnets()
KubectlProviderProps.Builder	removalPolicy(RemovalPolicy removalPolicy)	Sets the value of KubectlProviderOptions.getRemovalPolicy()
KubectlProviderProps.Builder	role(IRole role)	Sets the value of KubectlProviderOptions.getRole()
KubectlProviderProps.Builder	securityGroup(ISecurityGroup securityGroup)	Sets the value of KubectlProviderOptions.getSecurityGroup()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

cluster

@Stability(Experimental)
public KubectlProviderProps.Builder cluster(ICluster cluster)

Sets the value of KubectlProviderProps.getCluster()

Parameters:

cluster - The cluster to control. This parameter is required.

Returns:

this

kubectlLayer

@Stability(Experimental)
public KubectlProviderProps.Builder kubectlLayer(ILayerVersion kubectlLayer)

Sets the value of KubectlProviderOptions.getKubectlLayer()

Parameters:

kubectlLayer - An AWS Lambda layer that includes kubectl and helm. This parameter is required.

Returns:

this

awscliLayer

@Stability(Experimental)
public KubectlProviderProps.Builder awscliLayer(ILayerVersion awscliLayer)

Sets the value of KubectlProviderOptions.getAwscliLayer()

Parameters:

awscliLayer - An AWS Lambda layer that contains the aws CLI. If not defined, a default layer will be used containing the AWS CLI 2.x.

Returns:

this

environment

@Stability(Experimental)
public KubectlProviderProps.Builder environment(Map<String,String> environment)

Sets the value of KubectlProviderOptions.getEnvironment()

Parameters:

environment - Custom environment variables when running kubectl against this cluster.

Returns:

this

memory

@Stability(Experimental)
public KubectlProviderProps.Builder memory(Size memory)

Sets the value of KubectlProviderOptions.getMemory()

Parameters:

memory - The amount of memory allocated to the kubectl provider's lambda function.

Returns:

this

privateSubnets

@Stability(Experimental)
public KubectlProviderProps.Builder privateSubnets(List<? extends ISubnet> privateSubnets)

Sets the value of KubectlProviderOptions.getPrivateSubnets()

Parameters:

privateSubnets - Subnets to host the kubectl compute resources. If not specified, the k8s endpoint is expected to be accessible publicly.

Returns:

this

removalPolicy

@Stability(Experimental)
public KubectlProviderProps.Builder removalPolicy(RemovalPolicy removalPolicy)

Sets the value of KubectlProviderOptions.getRemovalPolicy()

Parameters:

removalPolicy - The removal policy applied to the custom resource that provides kubectl. The removal policy controls what happens to the resource if it stops being managed by CloudFormation. This can happen in one of three situations:

• The resource is removed from the template, so CloudFormation stops managing it
• A change to the resource is made that requires it to be replaced, so CloudFormation stops managing it
• The stack is deleted, so CloudFormation stops managing all resources in it

Returns:

this

role

@Stability(Experimental)
public KubectlProviderProps.Builder role(IRole role)

Sets the value of KubectlProviderOptions.getRole()

Parameters:

role - An IAM role that can perform kubectl operations against this cluster. The role should be mapped to the system:masters Kubernetes RBAC role.

This role is directly passed to the lambda handler that sends Kube Ctl commands to the cluster.

Returns:

this

securityGroup

@Stability(Experimental)
public KubectlProviderProps.Builder securityGroup(ISecurityGroup securityGroup)

Sets the value of KubectlProviderOptions.getSecurityGroup()

Parameters:

securityGroup - A security group to use for kubectl execution.

Returns:

this

build

@Stability(Experimental)
public KubectlProviderProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<KubectlProviderProps>

Returns:

a new instance of KubectlProviderProps

Throws:

NullPointerException - if any required attribute was not provided