Package software.amazon.awssdk.services.ecs.model

Interface InstanceLaunchTemplate.Builder

All Superinterfaces:

Buildable, CopyableBuilder<InstanceLaunchTemplate.Builder,InstanceLaunchTemplate>, SdkBuilder<InstanceLaunchTemplate.Builder,InstanceLaunchTemplate>, SdkPojo

Enclosing class:

InstanceLaunchTemplate

@Mutable
@NotThreadSafe
public static interface InstanceLaunchTemplate.Builder
extends SdkPojo, CopyableBuilder<InstanceLaunchTemplate.Builder,InstanceLaunchTemplate>

Method Summary

Modifier and Type	Method	Description
InstanceLaunchTemplate.Builder	capacityOptionType(String capacityOptionType)	The capacity option type.
InstanceLaunchTemplate.Builder	capacityOptionType(CapacityOptionType capacityOptionType)	The capacity option type.
default InstanceLaunchTemplate.Builder	capacityReservations(Consumer<CapacityReservationRequest.Builder> capacityReservations)	Capacity reservation specifications.
InstanceLaunchTemplate.Builder	capacityReservations(CapacityReservationRequest capacityReservations)	Capacity reservation specifications.
InstanceLaunchTemplate.Builder	ec2InstanceProfileArn(String ec2InstanceProfileArn)	The Amazon Resource Name (ARN) of the instance profile that Amazon ECS applies to Amazon ECS Managed Instances.
InstanceLaunchTemplate.Builder	fipsEnabled(Boolean fipsEnabled)	Determines whether to enable FIPS 140-2 validated cryptographic modules on EC2 instances launched by the capacity provider.
InstanceLaunchTemplate.Builder	instanceMetadataTagsPropagation(Boolean instanceMetadataTagsPropagation)	Determines whether tags are propagated to the instance metadata service (IMDS) for Amazon EC2 instances launched by the Managed Instances capacity provider.
default InstanceLaunchTemplate.Builder	instanceRequirements(Consumer<InstanceRequirementsRequest.Builder> instanceRequirements)	The instance requirements.
InstanceLaunchTemplate.Builder	instanceRequirements(InstanceRequirementsRequest instanceRequirements)	The instance requirements.
InstanceLaunchTemplate.Builder	monitoring(String monitoring)	CloudWatch provides two categories of monitoring: basic monitoring and detailed monitoring.
InstanceLaunchTemplate.Builder	monitoring(ManagedInstancesMonitoringOptions monitoring)	CloudWatch provides two categories of monitoring: basic monitoring and detailed monitoring.
default InstanceLaunchTemplate.Builder	networkConfiguration(Consumer<ManagedInstancesNetworkConfiguration.Builder> networkConfiguration)	The network configuration for Amazon ECS Managed Instances.
InstanceLaunchTemplate.Builder	networkConfiguration(ManagedInstancesNetworkConfiguration networkConfiguration)	The network configuration for Amazon ECS Managed Instances.
default InstanceLaunchTemplate.Builder	storageConfiguration(Consumer<ManagedInstancesStorageConfiguration.Builder> storageConfiguration)	The storage configuration for Amazon ECS Managed Instances.
InstanceLaunchTemplate.Builder	storageConfiguration(ManagedInstancesStorageConfiguration storageConfiguration)	The storage configuration for Amazon ECS Managed Instances.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

ec2InstanceProfileArn

InstanceLaunchTemplate.Builder ec2InstanceProfileArn(String ec2InstanceProfileArn)

The Amazon Resource Name (ARN) of the instance profile that Amazon ECS applies to Amazon ECS Managed Instances. This instance profile must include the necessary permissions for your tasks to access Amazon Web Services services and resources.

For more information, see Amazon ECS instance profile for Managed Instances in the Amazon ECS Developer Guide.

Parameters:

ec2InstanceProfileArn - The Amazon Resource Name (ARN) of the instance profile that Amazon ECS applies to Amazon ECS Managed Instances. This instance profile must include the necessary permissions for your tasks to access Amazon Web Services services and resources.

For more information, see Amazon ECS instance profile for Managed Instances in the Amazon ECS Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

networkConfiguration

InstanceLaunchTemplate.Builder networkConfiguration(ManagedInstancesNetworkConfiguration networkConfiguration)

The network configuration for Amazon ECS Managed Instances. This specifies the subnets and security groups that instances use for network connectivity.

Parameters:

networkConfiguration - The network configuration for Amazon ECS Managed Instances. This specifies the subnets and security groups that instances use for network connectivity.

Returns:

Returns a reference to this object so that method calls can be chained together.

networkConfiguration

default InstanceLaunchTemplate.Builder networkConfiguration(Consumer<ManagedInstancesNetworkConfiguration.Builder> networkConfiguration)

The network configuration for Amazon ECS Managed Instances. This specifies the subnets and security groups that instances use for network connectivity.

This is a convenience method that creates an instance of the ManagedInstancesNetworkConfiguration.Builder avoiding the need to create one manually via ManagedInstancesNetworkConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to networkConfiguration(ManagedInstancesNetworkConfiguration).

Parameters:

networkConfiguration - a consumer that will call methods on ManagedInstancesNetworkConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

networkConfiguration(ManagedInstancesNetworkConfiguration)

storageConfiguration

InstanceLaunchTemplate.Builder storageConfiguration(ManagedInstancesStorageConfiguration storageConfiguration)

The storage configuration for Amazon ECS Managed Instances. This defines the root volume size and type for the instances.

Parameters:

storageConfiguration - The storage configuration for Amazon ECS Managed Instances. This defines the root volume size and type for the instances.

Returns:

Returns a reference to this object so that method calls can be chained together.

storageConfiguration

default InstanceLaunchTemplate.Builder storageConfiguration(Consumer<ManagedInstancesStorageConfiguration.Builder> storageConfiguration)

The storage configuration for Amazon ECS Managed Instances. This defines the root volume size and type for the instances.

This is a convenience method that creates an instance of the ManagedInstancesStorageConfiguration.Builder avoiding the need to create one manually via ManagedInstancesStorageConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to storageConfiguration(ManagedInstancesStorageConfiguration).

Parameters:

storageConfiguration - a consumer that will call methods on ManagedInstancesStorageConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

storageConfiguration(ManagedInstancesStorageConfiguration)

monitoring

InstanceLaunchTemplate.Builder monitoring(String monitoring)

CloudWatch provides two categories of monitoring: basic monitoring and detailed monitoring. By default, your managed instance is configured for basic monitoring. You can optionally enable detailed monitoring to help you more quickly identify and act on operational issues. You can enable or turn off detailed monitoring at launch or when the managed instance is running or stopped. For more information, see Detailed monitoring for Amazon ECS Managed Instances in the Amazon ECS Developer Guide.

Parameters:

monitoring - CloudWatch provides two categories of monitoring: basic monitoring and detailed monitoring. By default, your managed instance is configured for basic monitoring. You can optionally enable detailed monitoring to help you more quickly identify and act on operational issues. You can enable or turn off detailed monitoring at launch or when the managed instance is running or stopped. For more information, see Detailed monitoring for Amazon ECS Managed Instances in the Amazon ECS Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ManagedInstancesMonitoringOptions, ManagedInstancesMonitoringOptions

monitoring

InstanceLaunchTemplate.Builder monitoring(ManagedInstancesMonitoringOptions monitoring)

CloudWatch provides two categories of monitoring: basic monitoring and detailed monitoring. By default, your managed instance is configured for basic monitoring. You can optionally enable detailed monitoring to help you more quickly identify and act on operational issues. You can enable or turn off detailed monitoring at launch or when the managed instance is running or stopped. For more information, see Detailed monitoring for Amazon ECS Managed Instances in the Amazon ECS Developer Guide.

Parameters:

monitoring - CloudWatch provides two categories of monitoring: basic monitoring and detailed monitoring. By default, your managed instance is configured for basic monitoring. You can optionally enable detailed monitoring to help you more quickly identify and act on operational issues. You can enable or turn off detailed monitoring at launch or when the managed instance is running or stopped. For more information, see Detailed monitoring for Amazon ECS Managed Instances in the Amazon ECS Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ManagedInstancesMonitoringOptions, ManagedInstancesMonitoringOptions

capacityOptionType

InstanceLaunchTemplate.Builder capacityOptionType(String capacityOptionType)

The capacity option type. This determines whether Amazon ECS launches On-Demand, Spot or Capacity Reservation Instances for your managed instance capacity provider.

Valid values are:

• ON_DEMAND - Launches standard On-Demand Instances. On-Demand Instances provide predictable pricing and availability.

• SPOT - Launches Spot Instances that use spare Amazon EC2 capacity at reduced cost. Spot Instances can be interrupted by Amazon EC2 with a two-minute notification when the capacity is needed back.

• RESERVED - Launches Instances using Amazon EC2 Capacity Reservations. Capacity Reservations allow you to reserve compute capacity for Amazon EC2 instances in a specific Availability Zone.

The default is On-Demand

For more information about Amazon EC2 capacity options, see Instance purchasing options in the Amazon EC2 User Guide.

Parameters:

capacityOptionType - The capacity option type. This determines whether Amazon ECS launches On-Demand, Spot or Capacity Reservation Instances for your managed instance capacity provider.

Valid values are:

• ON_DEMAND - Launches standard On-Demand Instances. On-Demand Instances provide predictable pricing and availability.

• SPOT - Launches Spot Instances that use spare Amazon EC2 capacity at reduced cost. Spot Instances can be interrupted by Amazon EC2 with a two-minute notification when the capacity is needed back.

• RESERVED - Launches Instances using Amazon EC2 Capacity Reservations. Capacity Reservations allow you to reserve compute capacity for Amazon EC2 instances in a specific Availability Zone.

The default is On-Demand

For more information about Amazon EC2 capacity options, see Instance purchasing options in the Amazon EC2 User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CapacityOptionType, CapacityOptionType

capacityOptionType

InstanceLaunchTemplate.Builder capacityOptionType(CapacityOptionType capacityOptionType)

The capacity option type. This determines whether Amazon ECS launches On-Demand, Spot or Capacity Reservation Instances for your managed instance capacity provider.

Valid values are:

• ON_DEMAND - Launches standard On-Demand Instances. On-Demand Instances provide predictable pricing and availability.

• SPOT - Launches Spot Instances that use spare Amazon EC2 capacity at reduced cost. Spot Instances can be interrupted by Amazon EC2 with a two-minute notification when the capacity is needed back.

• RESERVED - Launches Instances using Amazon EC2 Capacity Reservations. Capacity Reservations allow you to reserve compute capacity for Amazon EC2 instances in a specific Availability Zone.

The default is On-Demand

For more information about Amazon EC2 capacity options, see Instance purchasing options in the Amazon EC2 User Guide.

Parameters:

capacityOptionType - The capacity option type. This determines whether Amazon ECS launches On-Demand, Spot or Capacity Reservation Instances for your managed instance capacity provider.

Valid values are:

• ON_DEMAND - Launches standard On-Demand Instances. On-Demand Instances provide predictable pricing and availability.

• SPOT - Launches Spot Instances that use spare Amazon EC2 capacity at reduced cost. Spot Instances can be interrupted by Amazon EC2 with a two-minute notification when the capacity is needed back.

• RESERVED - Launches Instances using Amazon EC2 Capacity Reservations. Capacity Reservations allow you to reserve compute capacity for Amazon EC2 instances in a specific Availability Zone.

The default is On-Demand

For more information about Amazon EC2 capacity options, see Instance purchasing options in the Amazon EC2 User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CapacityOptionType, CapacityOptionType

instanceMetadataTagsPropagation

InstanceLaunchTemplate.Builder instanceMetadataTagsPropagation(Boolean instanceMetadataTagsPropagation)

Determines whether tags are propagated to the instance metadata service (IMDS) for Amazon EC2 instances launched by the Managed Instances capacity provider. When enabled, all tags associated with the instance are available through the instance metadata service. When disabled, tags are not propagated to IMDS.

Disable this setting if your tags contain characters that are not compatible with IMDS, such as /. IMDS requires tag keys to match the pattern [0-9a-zA-Z\-_+=,.@:]{1,255}.

The default value is true.

For more information, see Work with instance tags in instance metadata in the Amazon EC2 User Guide.

Parameters:

instanceMetadataTagsPropagation - Determines whether tags are propagated to the instance metadata service (IMDS) for Amazon EC2 instances launched by the Managed Instances capacity provider. When enabled, all tags associated with the instance are available through the instance metadata service. When disabled, tags are not propagated to IMDS.

Disable this setting if your tags contain characters that are not compatible with IMDS, such as /. IMDS requires tag keys to match the pattern [0-9a-zA-Z\-_+=,.@:]{1,255}.

The default value is true.

For more information, see Work with instance tags in instance metadata in the Amazon EC2 User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceRequirements

InstanceLaunchTemplate.Builder instanceRequirements(InstanceRequirementsRequest instanceRequirements)

The instance requirements. You can specify:

• The instance types

• Instance requirements such as vCPU count, memory, network performance, and accelerator specifications

Amazon ECS automatically selects the instances that match the specified criteria.

Parameters:

instanceRequirements - The instance requirements. You can specify:

• The instance types

• Instance requirements such as vCPU count, memory, network performance, and accelerator specifications

Amazon ECS automatically selects the instances that match the specified criteria.

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceRequirements

default InstanceLaunchTemplate.Builder instanceRequirements(Consumer<InstanceRequirementsRequest.Builder> instanceRequirements)

The instance requirements. You can specify:

• The instance types

• Instance requirements such as vCPU count, memory, network performance, and accelerator specifications

Amazon ECS automatically selects the instances that match the specified criteria.

This is a convenience method that creates an instance of the InstanceRequirementsRequest.Builder avoiding the need to create one manually via InstanceRequirementsRequest.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to instanceRequirements(InstanceRequirementsRequest).

Parameters:

instanceRequirements - a consumer that will call methods on InstanceRequirementsRequest.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

instanceRequirements(InstanceRequirementsRequest)

fipsEnabled

InstanceLaunchTemplate.Builder fipsEnabled(Boolean fipsEnabled)

Determines whether to enable FIPS 140-2 validated cryptographic modules on EC2 instances launched by the capacity provider. If true, instances use FIPS-compliant cryptographic algorithms and modules for enhanced security compliance. If false, instances use standard cryptographic implementations.

If not specified, instances are launched with FIPS enabled in AWS GovCloud (US) regions and FIPS disabled in other regions.

Parameters:

fipsEnabled - Determines whether to enable FIPS 140-2 validated cryptographic modules on EC2 instances launched by the capacity provider. If true, instances use FIPS-compliant cryptographic algorithms and modules for enhanced security compliance. If false, instances use standard cryptographic implementations.

If not specified, instances are launched with FIPS enabled in AWS GovCloud (US) regions and FIPS disabled in other regions.

Returns:

Returns a reference to this object so that method calls can be chained together.

capacityReservations

InstanceLaunchTemplate.Builder capacityReservations(CapacityReservationRequest capacityReservations)

Capacity reservation specifications. You can specify:

• Capacity reservation preference

• Reservation resource group to be used for targeted capacity reservations

Amazon ECS will launch instances according to the specified criteria.

Parameters:

capacityReservations - Capacity reservation specifications. You can specify:

• Capacity reservation preference

• Reservation resource group to be used for targeted capacity reservations

Amazon ECS will launch instances according to the specified criteria.

Returns:

Returns a reference to this object so that method calls can be chained together.

capacityReservations

default InstanceLaunchTemplate.Builder capacityReservations(Consumer<CapacityReservationRequest.Builder> capacityReservations)

Capacity reservation specifications. You can specify:

• Capacity reservation preference

• Reservation resource group to be used for targeted capacity reservations

Amazon ECS will launch instances according to the specified criteria.

This is a convenience method that creates an instance of the CapacityReservationRequest.Builder avoiding the need to create one manually via CapacityReservationRequest.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to capacityReservations(CapacityReservationRequest).

Parameters:

capacityReservations - a consumer that will call methods on CapacityReservationRequest.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

capacityReservations(CapacityReservationRequest)