Class InstanceLaunchTemplate

java.lang.Object
software.amazon.awssdk.services.ecs.model.InstanceLaunchTemplate
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<InstanceLaunchTemplate.Builder,InstanceLaunchTemplate>
@Generated("software.amazon.awssdk:codegen") public final class InstanceLaunchTemplate extends Object implements SdkPojo, Serializable, ToCopyableBuilder<InstanceLaunchTemplate.Builder,InstanceLaunchTemplate>

The launch template configuration for Amazon ECS Managed Instances. This defines how Amazon ECS launches Amazon EC2 instances, including the instance profile for your tasks, network and storage configuration, capacity options, and instance requirements for flexible instance type selection.

See Also:

  • Method Details

    • ec2InstanceProfileArn

      public final 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.

      Returns:
      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.

    • networkConfiguration

      public final ManagedInstancesNetworkConfiguration networkConfiguration()

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

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

    • storageConfiguration

      public final ManagedInstancesStorageConfiguration storageConfiguration()

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

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

    • monitoring

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, monitoring will return ManagedInstancesMonitoringOptions.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from monitoringAsString().

      Returns:
      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.
      See Also:

    • monitoringAsString

      public final String monitoringAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, monitoring will return ManagedInstancesMonitoringOptions.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from monitoringAsString().

      Returns:
      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.
      See Also:

    • instanceRequirements

      public final 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.

      Returns:
      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.

    • toBuilder

      public InstanceLaunchTemplate.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<InstanceLaunchTemplate.Builder,InstanceLaunchTemplate>
      Returns:
      a builder for type T

    • builder

      public static InstanceLaunchTemplate.Builder builder()

    • serializableBuilderClass

      public static Class<? extends InstanceLaunchTemplate.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.