software.amazon.awssdk.services.eventbridge.model

Class EcsParameters

java.lang.Object

software.amazon.awssdk.services.eventbridge.model.EcsParameters

All Implemented Interfaces:

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

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

The custom parameters to be used when the target is an Amazon ECS task.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EcsParameters.Builder

Method Summary

Modifier and Type	Method and Description
static EcsParameters.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	group() Specifies an ECS task group for the task.
int	hashCode()
LaunchType	launchType() Specifies the launch type on which your task is running.
String	launchTypeAsString() Specifies the launch type on which your task is running.
NetworkConfiguration	networkConfiguration() Use this structure if the ECS task uses the awsvpc network mode.
String	platformVersion() Specifies the platform version for the task.
List<SdkField<?>>	sdkFields()
static Class<? extends EcsParameters.Builder>	serializableBuilderClass()
Integer	taskCount() The number of tasks to create based on TaskDefinition.
String	taskDefinitionArn() The ARN of the task definition to use if the event target is an Amazon ECS task.
EcsParameters.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

taskDefinitionArn

public final String taskDefinitionArn()

The ARN of the task definition to use if the event target is an Amazon ECS task.

Returns:

The ARN of the task definition to use if the event target is an Amazon ECS task.

taskCount

public final Integer taskCount()

The number of tasks to create based on TaskDefinition. The default is 1.

Returns:

The number of tasks to create based on TaskDefinition. The default is 1.

launchType

public final LaunchType launchType()

Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where AWS Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

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

Returns:

Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where AWS Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

See Also:

LaunchType

launchTypeAsString

public final String launchTypeAsString()

Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where AWS Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

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

Returns:

Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where AWS Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

See Also:

LaunchType

networkConfiguration

public final NetworkConfiguration networkConfiguration()

Use this structure if the ECS task uses the awsvpc network mode. This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This structure is required if LaunchType is FARGATE because the awsvpc mode is required for Fargate tasks.

If you specify NetworkConfiguration when the target ECS task does not use the awsvpc network mode, the task fails.

Returns:

Use this structure if the ECS task uses the awsvpc network mode. This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This structure is required if LaunchType is FARGATE because the awsvpc mode is required for Fargate tasks.

If you specify NetworkConfiguration when the target ECS task does not use the awsvpc network mode, the task fails.

platformVersion

public final String platformVersion()

Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.

This structure is used only if LaunchType is FARGATE. For more information about valid platform versions, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Returns:

Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.

This structure is used only if LaunchType is FARGATE. For more information about valid platform versions, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

group

public final String group()

Specifies an ECS task group for the task. The maximum length is 255 characters.

Returns:

Specifies an ECS task group for the task. The maximum length is 255 characters.

toBuilder

public EcsParameters.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<EcsParameters.Builder,EcsParameters>

Returns:

a builder for type T

builder

public static EcsParameters.Builder builder()

serializableBuilderClass

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