Package software.amazon.awscdk.services.lambda

Class CapacityProviderProps.Builder

java.lang.Object

software.amazon.awscdk.services.lambda.CapacityProviderProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CapacityProviderProps>

Enclosing interface:

CapacityProviderProps

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

A builder for CapacityProviderProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CapacityProviderProps.Builder	architectures(List<? extends Architecture> architectures)	Sets the value of CapacityProviderProps.getArchitectures()
CapacityProviderProps	build()	Builds the configured instance.
CapacityProviderProps.Builder	capacityProviderName(String capacityProviderName)	Sets the value of CapacityProviderProps.getCapacityProviderName()
CapacityProviderProps.Builder	instanceTypeFilter(InstanceTypeFilter instanceTypeFilter)	Sets the value of CapacityProviderProps.getInstanceTypeFilter()
CapacityProviderProps.Builder	kmsKey(IKey kmsKey)	Sets the value of CapacityProviderProps.getKmsKey()
CapacityProviderProps.Builder	maxVCpuCount(Number maxVCpuCount)	Sets the value of CapacityProviderProps.getMaxVCpuCount()
CapacityProviderProps.Builder	operatorRole(IRole operatorRole)	Sets the value of CapacityProviderProps.getOperatorRole()
CapacityProviderProps.Builder	scalingOptions(ScalingOptions scalingOptions)	Sets the value of CapacityProviderProps.getScalingOptions()
CapacityProviderProps.Builder	securityGroups(List<? extends ISecurityGroup> securityGroups)	Sets the value of CapacityProviderProps.getSecurityGroups()
CapacityProviderProps.Builder	subnets(List<? extends ISubnet> subnets)	Sets the value of CapacityProviderProps.getSubnets()

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

securityGroups

@Stability(Stable)
public CapacityProviderProps.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)

Sets the value of CapacityProviderProps.getSecurityGroups()

Parameters:

securityGroups - A list of security group IDs to associate with EC2 instances launched by the capacity provider. This parameter is required. Up to 5 security groups can be specified.

Returns:

this

subnets

@Stability(Stable)
public CapacityProviderProps.Builder subnets(List<? extends ISubnet> subnets)

Sets the value of CapacityProviderProps.getSubnets()

Parameters:

subnets - A list of subnets where the capacity provider can launch EC2 instances. This parameter is required. At least one subnet must be specified, and up to 16 subnets are supported.

Returns:

this

architectures

@Stability(Stable)
public CapacityProviderProps.Builder architectures(List<? extends Architecture> architectures)

Sets the value of CapacityProviderProps.getArchitectures()

Parameters:

architectures - The instruction set architecture required for compute instances. Only one architecture can be specified per capacity provider.

Returns:

this

capacityProviderName

@Stability(Stable)
public CapacityProviderProps.Builder capacityProviderName(String capacityProviderName)

Sets the value of CapacityProviderProps.getCapacityProviderName()

Parameters:

capacityProviderName - The name of the capacity provider. The name must be unique within the AWS account and region.

Returns:

this

instanceTypeFilter

@Stability(Stable)
public CapacityProviderProps.Builder instanceTypeFilter(InstanceTypeFilter instanceTypeFilter)

Sets the value of CapacityProviderProps.getInstanceTypeFilter()

Parameters:

instanceTypeFilter - Configuration for filtering instance types that the capacity provider can use.

Returns:

this

kmsKey

@Stability(Stable)
public CapacityProviderProps.Builder kmsKey(IKey kmsKey)

Sets the value of CapacityProviderProps.getKmsKey()

Parameters:

kmsKey - The AWS Key Management Service (KMS) key used to encrypt data associated with the capacity provider.

Returns:

this

maxVCpuCount

@Stability(Stable)
public CapacityProviderProps.Builder maxVCpuCount(Number maxVCpuCount)

Sets the value of CapacityProviderProps.getMaxVCpuCount()

Parameters:

maxVCpuCount - The maximum number of vCPUs that the capacity provider can scale up to.

Returns:

this

operatorRole

@Stability(Stable)
public CapacityProviderProps.Builder operatorRole(IRole operatorRole)

Sets the value of CapacityProviderProps.getOperatorRole()

Parameters:

operatorRole - The IAM role that the Lambda service assumes to manage the capacity provider.

Returns:

this

scalingOptions

@Stability(Stable)
public CapacityProviderProps.Builder scalingOptions(ScalingOptions scalingOptions)

Sets the value of CapacityProviderProps.getScalingOptions()

Parameters:

scalingOptions - The options for scaling a capacity provider, including scaling policies.

Returns:

this

build

@Stability(Stable)
public CapacityProviderProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CapacityProviderProps

Throws:

NullPointerException - if any required attribute was not provided