Package software.amazon.awscdk.cfnpropertymixins.services.batch

Class CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationOverrideProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.batch.CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationOverrideProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationOverrideProperty>

Enclosing interface:

CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationOverrideProperty

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

A builder for CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationOverrideProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationOverrideProperty	build()	Builds the configured instance.
CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationOverrideProperty.Builder	launchTemplateId(String launchTemplateId)	Sets the value of CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationOverrideProperty.getLaunchTemplateId()
CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationOverrideProperty.Builder	launchTemplateName(String launchTemplateName)	Sets the value of CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationOverrideProperty.getLaunchTemplateName()
CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationOverrideProperty.Builder	targetInstanceTypes(List<String> targetInstanceTypes)	Sets the value of CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationOverrideProperty.getTargetInstanceTypes()
CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationOverrideProperty.Builder	userdataType(String userdataType)	Sets the value of CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationOverrideProperty.getUserdataType()
CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationOverrideProperty.Builder	version(String version)	Sets the value of CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationOverrideProperty.getVersion()

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

launchTemplateId

@Stability(Stable)
public CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationOverrideProperty.Builder launchTemplateId(String launchTemplateId)

Sets the value of CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationOverrideProperty.getLaunchTemplateId()

Parameters:

launchTemplateId - The ID of the launch template. Note: If you specify the launchTemplateId you can't specify the launchTemplateName as well.

Returns:

this

launchTemplateName

@Stability(Stable)
public CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationOverrideProperty.Builder launchTemplateName(String launchTemplateName)

Sets the value of CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationOverrideProperty.getLaunchTemplateName()

Parameters:

launchTemplateName - The name of the launch template. Note: If you specify the launchTemplateName you can't specify the launchTemplateId as well.

Returns:

this

targetInstanceTypes

@Stability(Stable)
public CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationOverrideProperty.Builder targetInstanceTypes(List<String> targetInstanceTypes)

Sets the value of CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationOverrideProperty.getTargetInstanceTypes()

Parameters:

targetInstanceTypes - The instance type or family that this override launch template should be applied to. This parameter is required when defining a launch template override.

Information included in this parameter must meet the following requirements:

• Must be a valid Amazon EC2 instance type or family.
• The following AWS Batch InstanceTypes are not allowed: optimal , default_x86_64 , and default_arm64 .
• targetInstanceTypes can target only instance types and families that are included within the ComputeResource.instanceTypes set. targetInstanceTypes doesn't need to include all of the instances from the instanceType set, but at least a subset. For example, if ComputeResource.instanceTypes includes [m5, g5] , targetInstanceTypes can include [m5.2xlarge] and [m5.large] but not [c5.large] .
• targetInstanceTypes included within the same launch template override or across launch template overrides can't overlap for the same compute environment. For example, you can't define one launch template override to target an instance family and another define an instance type within this same family.

Returns:

this

userdataType

@Stability(Stable)
public CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationOverrideProperty.Builder userdataType(String userdataType)

Sets the value of CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationOverrideProperty.getUserdataType()

Parameters:

userdataType - The EKS node initialization process to use. You only need to specify this value if you are using a custom AMI. The default value is EKS_BOOTSTRAP_SH . If imageType is a custom AMI based on EKS_AL2023 or EKS_AL2023_NVIDIA then you must choose EKS_NODEADM .

Returns:

this

version

@Stability(Stable)
public CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationOverrideProperty.Builder version(String version)

Sets the value of CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationOverrideProperty.getVersion()

Parameters:

version - The version number of the launch template, $Default , or $Latest . If the value is $Default , the default version of the launch template is used. If the value is $Latest , the latest version of the launch template is used.

If the AMI ID that's used in a compute environment is from the launch template, the AMI isn't changed when the compute environment is updated. It's only changed if the updateToLatestImageVersion parameter for the compute environment is set to true . During an infrastructure update, if either $Default or $Latest is specified, AWS Batch re-evaluates the launch template version, and it might use a different version of the launch template. This is the case even if the launch template isn't specified in the update. When updating a compute environment, changing the launch template requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the AWS Batch User Guide .

Default: $Default

Latest: $Latest

Returns:

this

build

@Stability(Stable)
public CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationOverrideProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationOverrideProperty>

Returns:

a new instance of CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationOverrideProperty

Throws:

NullPointerException - if any required attribute was not provided