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

Class CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationProperty.Builder

java.lang.Object

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

All Implemented Interfaces:

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

Enclosing interface:

CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationProperty

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

A builder for CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationProperty	build()	Builds the configured instance.
CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationProperty.Builder	launchTemplateId(String launchTemplateId)	Sets the value of CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationProperty.getLaunchTemplateId()
CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationProperty.Builder	launchTemplateId(ILaunchTemplateRef launchTemplateId)	Sets the value of CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationProperty.getLaunchTemplateId()
CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationProperty.Builder	launchTemplateName(String launchTemplateName)	Sets the value of CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationProperty.getLaunchTemplateName()
CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationProperty.Builder	overrides(List<? extends Object> overrides)	Sets the value of CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationProperty.getOverrides()
CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationProperty.Builder	overrides(IResolvable overrides)	Sets the value of CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationProperty.getOverrides()
CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationProperty.Builder	userdataType(String userdataType)	Sets the value of CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationProperty.getUserdataType()
CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationProperty.Builder	version(String version)	Sets the value of CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationProperty.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.LaunchTemplateSpecificationProperty.Builder launchTemplateId(String launchTemplateId)

Sets the value of CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationProperty.getLaunchTemplateId()

Parameters:

launchTemplateId - The ID of the launch template.

Returns:

this

launchTemplateId

@Stability(Stable)
public CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationProperty.Builder launchTemplateId(ILaunchTemplateRef launchTemplateId)

Sets the value of CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationProperty.getLaunchTemplateId()

Parameters:

launchTemplateId - The ID of the launch template.

Returns:

this

launchTemplateName

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

Sets the value of CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationProperty.getLaunchTemplateName()

Parameters:

launchTemplateName - The name of the launch template.

Returns:

this

overrides

@Stability(Stable)
public CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationProperty.Builder overrides(IResolvable overrides)

Sets the value of CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationProperty.getOverrides()

Parameters:

overrides - A launch template to use in place of the default launch template. You must specify either the launch template ID or launch template name in the request, but not both.

You can specify up to ten (10) launch template overrides that are associated to unique instance types or families for each compute environment.

To unset all override templates for a compute environment, you can pass an empty array to the UpdateComputeEnvironment.overrides parameter, or not include the overrides parameter when submitting the UpdateComputeEnvironment API operation.

Returns:

this

overrides

@Stability(Stable)
public CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationProperty.Builder overrides(List<? extends Object> overrides)

Sets the value of CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationProperty.getOverrides()

Parameters:

overrides - A launch template to use in place of the default launch template. You must specify either the launch template ID or launch template name in the request, but not both.

You can specify up to ten (10) launch template overrides that are associated to unique instance types or families for each compute environment.

To unset all override templates for a compute environment, you can pass an empty array to the UpdateComputeEnvironment.overrides parameter, or not include the overrides parameter when submitting the UpdateComputeEnvironment API operation.

Returns:

this

userdataType

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

Sets the value of CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationProperty.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.LaunchTemplateSpecificationProperty.Builder version(String version)

Sets the value of CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationProperty.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.LaunchTemplateSpecificationProperty build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnComputeEnvironmentPropsMixin.LaunchTemplateSpecificationProperty

Throws:

NullPointerException - if any required attribute was not provided