software.amazon.awssdk.services.securityhub.model

Class AwsEcsTaskDefinitionDetails

java.lang.Object

software.amazon.awssdk.services.securityhub.model.AwsEcsTaskDefinitionDetails

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AwsEcsTaskDefinitionDetails.Builder,AwsEcsTaskDefinitionDetails>

@Generated(value="software.amazon.awssdk:codegen")
public final class AwsEcsTaskDefinitionDetails
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AwsEcsTaskDefinitionDetails.Builder,AwsEcsTaskDefinitionDetails>

Details about a task definition. A task definition describes the container and volume definitions of an Amazon Elastic Container Service task.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AwsEcsTaskDefinitionDetails.Builder

Method Summary

Modifier and Type	Method and Description
static AwsEcsTaskDefinitionDetails.Builder	builder()
List<AwsEcsTaskDefinitionContainerDefinitionsDetails>	containerDefinitions() The container definitions that describe the containers that make up the task.
String	cpu() The number of CPU units used by the task.Valid values are as follows:
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	executionRoleArn() The ARN of the task execution role that grants the container agent permission to make API calls on behalf of the container user.
String	family() The name of a family that this task definition is registered to.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasContainerDefinitions() For responses, this returns true if the service returned a value for the ContainerDefinitions property.
int	hashCode()
boolean	hasInferenceAccelerators() For responses, this returns true if the service returned a value for the InferenceAccelerators property.
boolean	hasPlacementConstraints() For responses, this returns true if the service returned a value for the PlacementConstraints property.
boolean	hasRequiresCompatibilities() For responses, this returns true if the service returned a value for the RequiresCompatibilities property.
boolean	hasVolumes() For responses, this returns true if the service returned a value for the Volumes property.
List<AwsEcsTaskDefinitionInferenceAcceleratorsDetails>	inferenceAccelerators() The Elastic Inference accelerators to use for the containers in the task.
String	ipcMode() The inter-process communication (IPC) resource namespace to use for the containers in the task.
String	memory() The amount (in MiB) of memory used by the task.
String	networkMode() The Docker networking mode to use for the containers in the task.
String	pidMode() The process namespace to use for the containers in the task.
List<AwsEcsTaskDefinitionPlacementConstraintsDetails>	placementConstraints() The placement constraint objects to use for tasks.
AwsEcsTaskDefinitionProxyConfigurationDetails	proxyConfiguration() The configuration details for the App Mesh proxy.
List<String>	requiresCompatibilities() The task launch types that the task definition was validated against.
List<SdkField<?>>	sdkFields()
static Class<? extends AwsEcsTaskDefinitionDetails.Builder>	serializableBuilderClass()
String	taskRoleArn() The short name or ARN of the IAM role that grants containers in the task permission to call Amazon Web Services API operations on your behalf.
AwsEcsTaskDefinitionDetails.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<AwsEcsTaskDefinitionVolumesDetails>	volumes() The data volume definitions for the task.

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

hasContainerDefinitions

public final boolean hasContainerDefinitions()

For responses, this returns true if the service returned a value for the ContainerDefinitions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

containerDefinitions

public final List<AwsEcsTaskDefinitionContainerDefinitionsDetails> containerDefinitions()

The container definitions that describe the containers that make up the task.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasContainerDefinitions() method.

Returns:

The container definitions that describe the containers that make up the task.

cpu

public final String cpu()

The number of CPU units used by the task.Valid values are as follows:

• 256 (.25 vCPU)

• 512 (.5 vCPU)

• 1024 (1 vCPU)

• 2048 (2 vCPU)

• 4096 (4 vCPU)

Returns:

The number of CPU units used by the task.Valid values are as follows:

• 256 (.25 vCPU)

• 512 (.5 vCPU)

• 1024 (1 vCPU)

• 2048 (2 vCPU)

• 4096 (4 vCPU)

executionRoleArn

public final String executionRoleArn()

The ARN of the task execution role that grants the container agent permission to make API calls on behalf of the container user.

Returns:

The ARN of the task execution role that grants the container agent permission to make API calls on behalf of the container user.

family

public final String family()

The name of a family that this task definition is registered to.

Returns:

The name of a family that this task definition is registered to.

hasInferenceAccelerators

public final boolean hasInferenceAccelerators()

For responses, this returns true if the service returned a value for the InferenceAccelerators property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

inferenceAccelerators

public final List<AwsEcsTaskDefinitionInferenceAcceleratorsDetails> inferenceAccelerators()

The Elastic Inference accelerators to use for the containers in the task.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInferenceAccelerators() method.

Returns:

The Elastic Inference accelerators to use for the containers in the task.

ipcMode

public final String ipcMode()

The inter-process communication (IPC) resource namespace to use for the containers in the task. Valid values are as follows:

• host

• none

• task

Returns:

The inter-process communication (IPC) resource namespace to use for the containers in the task. Valid values are as follows:

• host

• none

• task

memory

public final String memory()

The amount (in MiB) of memory used by the task.

For tasks that are hosted on Amazon EC2, you can provide a task-level memory value or a container-level memory value. For tasks that are hosted on Fargate, you must use one of the specified values in the Amazon Elastic Container Service Developer Guide , which determines your range of supported values for the Cpu and Memory parameters.

Returns:

The amount (in MiB) of memory used by the task.

For tasks that are hosted on Amazon EC2, you can provide a task-level memory value or a container-level memory value. For tasks that are hosted on Fargate, you must use one of the specified values in the Amazon Elastic Container Service Developer Guide , which determines your range of supported values for the Cpu and Memory parameters.

networkMode

public final String networkMode()

The Docker networking mode to use for the containers in the task. Valid values are as follows:

• awsvpc

• bridge

• host

• none

Returns:

The Docker networking mode to use for the containers in the task. Valid values are as follows:

• awsvpc

• bridge

• host

• none

pidMode

public final String pidMode()

The process namespace to use for the containers in the task. Valid values are host or task.

Returns:

The process namespace to use for the containers in the task. Valid values are host or task.

hasPlacementConstraints

public final boolean hasPlacementConstraints()

For responses, this returns true if the service returned a value for the PlacementConstraints property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

placementConstraints

public final List<AwsEcsTaskDefinitionPlacementConstraintsDetails> placementConstraints()

The placement constraint objects to use for tasks.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPlacementConstraints() method.

Returns:

The placement constraint objects to use for tasks.

proxyConfiguration

public final AwsEcsTaskDefinitionProxyConfigurationDetails proxyConfiguration()

The configuration details for the App Mesh proxy.

Returns:

The configuration details for the App Mesh proxy.

hasRequiresCompatibilities

public final boolean hasRequiresCompatibilities()

For responses, this returns true if the service returned a value for the RequiresCompatibilities property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

requiresCompatibilities

public final List<String> requiresCompatibilities()

The task launch types that the task definition was validated against.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRequiresCompatibilities() method.

Returns:

The task launch types that the task definition was validated against.

taskRoleArn

public final String taskRoleArn()

The short name or ARN of the IAM role that grants containers in the task permission to call Amazon Web Services API operations on your behalf.

Returns:

The short name or ARN of the IAM role that grants containers in the task permission to call Amazon Web Services API operations on your behalf.

hasVolumes

public final boolean hasVolumes()

For responses, this returns true if the service returned a value for the Volumes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

volumes

public final List<AwsEcsTaskDefinitionVolumesDetails> volumes()

The data volume definitions for the task.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVolumes() method.

Returns:

The data volume definitions for the task.

toBuilder

public AwsEcsTaskDefinitionDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AwsEcsTaskDefinitionDetails.Builder,AwsEcsTaskDefinitionDetails>

builder

public static AwsEcsTaskDefinitionDetails.Builder builder()

serializableBuilderClass

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