com.amazonaws.services.cloudwatchevents.model

Class EcsParameters

java.lang.Object

com.amazonaws.services.cloudwatchevents.model.EcsParameters

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class EcsParameters
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
EcsParameters()

Method Summary

Modifier and Type	Method and Description
EcsParameters	clone()
boolean	equals(Object obj)
String	getGroup() Specifies an ECS task group for the task.
String	getLaunchType() Specifies the launch type on which your task is running.
NetworkConfiguration	getNetworkConfiguration() Use this structure if the ECS task uses the awsvpc network mode.
String	getPlatformVersion() Specifies the platform version for the task.
Integer	getTaskCount() The number of tasks to create based on TaskDefinition.
String	getTaskDefinitionArn() The ARN of the task definition to use if the event target is an Amazon ECS task.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setGroup(String group) Specifies an ECS task group for the task.
void	setLaunchType(String launchType) Specifies the launch type on which your task is running.
void	setNetworkConfiguration(NetworkConfiguration networkConfiguration) Use this structure if the ECS task uses the awsvpc network mode.
void	setPlatformVersion(String platformVersion) Specifies the platform version for the task.
void	setTaskCount(Integer taskCount) The number of tasks to create based on TaskDefinition.
void	setTaskDefinitionArn(String taskDefinitionArn) The ARN of the task definition to use if the event target is an Amazon ECS task.
String	toString() Returns a string representation of this object; useful for testing and debugging.
EcsParameters	withGroup(String group) Specifies an ECS task group for the task.
EcsParameters	withLaunchType(LaunchType launchType) Specifies the launch type on which your task is running.
EcsParameters	withLaunchType(String launchType) Specifies the launch type on which your task is running.
EcsParameters	withNetworkConfiguration(NetworkConfiguration networkConfiguration) Use this structure if the ECS task uses the awsvpc network mode.
EcsParameters	withPlatformVersion(String platformVersion) Specifies the platform version for the task.
EcsParameters	withTaskCount(Integer taskCount) The number of tasks to create based on TaskDefinition.
EcsParameters	withTaskDefinitionArn(String taskDefinitionArn) The ARN of the task definition to use if the event target is an Amazon ECS task.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EcsParameters

public EcsParameters()

Method Detail

setTaskDefinitionArn

public void setTaskDefinitionArn(String taskDefinitionArn)

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

Parameters:

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

getTaskDefinitionArn

public String getTaskDefinitionArn()

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.

withTaskDefinitionArn

public EcsParameters withTaskDefinitionArn(String taskDefinitionArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setTaskCount

public void setTaskCount(Integer taskCount)

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

Parameters:

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

getTaskCount

public Integer getTaskCount()

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.

withTaskCount

public EcsParameters withTaskCount(Integer taskCount)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setLaunchType

public void setLaunchType(String 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.

Parameters:

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.

See Also:

LaunchType

getLaunchType

public String getLaunchType()

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.

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

withLaunchType

public EcsParameters withLaunchType(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LaunchType

withLaunchType

public EcsParameters withLaunchType(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LaunchType

setNetworkConfiguration

public void setNetworkConfiguration(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.

Parameters:

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.

getNetworkConfiguration

public NetworkConfiguration getNetworkConfiguration()

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.

withNetworkConfiguration

public EcsParameters withNetworkConfiguration(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setPlatformVersion

public void setPlatformVersion(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.

Parameters:

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.

getPlatformVersion

public String getPlatformVersion()

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.

withPlatformVersion

public EcsParameters withPlatformVersion(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setGroup

public void setGroup(String group)

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

Parameters:

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

getGroup

public String getGroup()

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.

withGroup

public EcsParameters withGroup(String group)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public EcsParameters clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.