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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateManagedInstancesProviderConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static CreateManagedInstancesProviderConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
InfrastructureOptimization	infrastructureOptimization()	Defines how Amazon ECS Managed Instances optimizes the infrastastructure in your capacity provider.
String	infrastructureRoleArn()	The Amazon Resource Name (ARN) of the infrastructure role that Amazon ECS uses to manage instances on your behalf.
InstanceLaunchTemplate	instanceLaunchTemplate()	The launch template configuration that specifies how Amazon ECS should launch Amazon EC2 instances.
PropagateMITags	propagateTags()	Specifies whether to propagate tags from the capacity provider to the Amazon ECS Managed Instances.
String	propagateTagsAsString()	Specifies whether to propagate tags from the capacity provider to the Amazon ECS Managed Instances.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateManagedInstancesProviderConfiguration.Builder>	serializableBuilderClass()
CreateManagedInstancesProviderConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

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:

PropagateMITags

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:

PropagateMITags

infrastructureOptimization

public final InfrastructureOptimization infrastructureOptimization()

Defines how Amazon ECS Managed Instances optimizes the infrastastructure in your capacity provider. Provides control over the delay between when EC2 instances become idle or underutilized and when Amazon ECS optimizes them.

Returns:

Defines how Amazon ECS Managed Instances optimizes the infrastastructure in your capacity provider. Provides control over the delay between when EC2 instances become idle or underutilized and when Amazon ECS optimizes them.

toBuilder

public CreateManagedInstancesProviderConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateManagedInstancesProviderConfiguration.Builder,CreateManagedInstancesProviderConfiguration>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo