Class CreateManagedInstancesProviderConfiguration

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

The configuration for creating a Amazon ECS Managed Instances provider. This specifies how Amazon ECS should manage Amazon EC2 instances, including the infrastructure role, instance launch template, and whether to propagate tags from the capacity provider to the instances.

See Also:

  • Method Details

    • infrastructureRoleArn

      public final String infrastructureRoleArn()

      The Amazon Resource Name (ARN) of the infrastructure role that Amazon ECS uses to manage instances on your behalf. This role must have permissions to launch, terminate, and manage Amazon EC2 instances, as well as access to other Amazon Web Services services required for Amazon ECS Managed Instances functionality.

      For more information, see Amazon ECS infrastructure IAM role in the Amazon ECS Developer Guide.

      Returns:
      The Amazon Resource Name (ARN) of the infrastructure role that Amazon ECS uses to manage instances on your behalf. This role must have permissions to launch, terminate, and manage Amazon EC2 instances, as well as access to other Amazon Web Services services required for Amazon ECS Managed Instances functionality.

      For more information, see Amazon ECS infrastructure IAM role in the Amazon ECS Developer Guide.

    • instanceLaunchTemplate

      public final InstanceLaunchTemplate instanceLaunchTemplate()

      The launch template configuration that specifies how Amazon ECS should launch Amazon EC2 instances. This includes the instance profile, network configuration, storage settings, and instance requirements for attribute-based instance type selection.

      For more information, see Store instance launch parameters in Amazon EC2 launch templates in the Amazon EC2 User Guide.

      Returns:
      The launch template configuration that specifies how Amazon ECS should launch Amazon EC2 instances. This includes the instance profile, network configuration, storage settings, and instance requirements for attribute-based instance type selection.

      For more information, see Store instance launch parameters in Amazon EC2 launch templates in the Amazon EC2 User Guide.

    • propagateTags

      public final PropagateMITags propagateTags()

      Specifies whether to propagate tags from the capacity provider to the Amazon ECS Managed Instances. When enabled, tags applied to the capacity provider are automatically applied to all instances launched by this provider.

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

      Returns:
      Specifies whether to propagate tags from the capacity provider to the Amazon ECS Managed Instances. When enabled, tags applied to the capacity provider are automatically applied to all instances launched by this provider.
      See Also:

    • propagateTagsAsString

      public final String propagateTagsAsString()

      Specifies whether to propagate tags from the capacity provider to the Amazon ECS Managed Instances. When enabled, tags applied to the capacity provider are automatically applied to all instances launched by this provider.

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

      Returns:
      Specifies whether to propagate tags from the capacity provider to the Amazon ECS Managed Instances. When enabled, tags applied to the capacity provider are automatically applied to all instances launched by this provider.
      See Also:

    • toBuilder

      public CreateManagedInstancesProviderConfiguration.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<CreateManagedInstancesProviderConfiguration.Builder,CreateManagedInstancesProviderConfiguration>
      Returns:
      a builder for type T

    • builder

      public static CreateManagedInstancesProviderConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateManagedInstancesProviderConfiguration.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.