software.amazon.awssdk.services.cloudwatchevents.model

Interface EcsParameters.Builder

All Superinterfaces:

Buildable, CopyableBuilder<EcsParameters.Builder,EcsParameters>, SdkBuilder<EcsParameters.Builder,EcsParameters>, SdkPojo

Enclosing class:

EcsParameters

public static interface EcsParameters.Builder
extends SdkPojo, CopyableBuilder<EcsParameters.Builder,EcsParameters>

Method Summary

Modifier and Type	Method and Description
EcsParameters.Builder	group(String group) Specifies an ECS task group for the task.
EcsParameters.Builder	launchType(LaunchType launchType) Specifies the launch type on which your task is running.
EcsParameters.Builder	launchType(String launchType) Specifies the launch type on which your task is running.
default EcsParameters.Builder	networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration) Use this structure if the ECS task uses the awsvpc network mode.
EcsParameters.Builder	networkConfiguration(NetworkConfiguration networkConfiguration) Use this structure if the ECS task uses the awsvpc network mode.
EcsParameters.Builder	platformVersion(String platformVersion) Specifies the platform version for the task.
EcsParameters.Builder	taskCount(Integer taskCount) The number of tasks to create based on TaskDefinition.
EcsParameters.Builder	taskDefinitionArn(String taskDefinitionArn) The ARN of the task definition to use if the event target is an Amazon ECS task.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

copy

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

applyMutation, build

Method Detail

taskDefinitionArn

EcsParameters.Builder taskDefinitionArn(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.

taskCount

EcsParameters.Builder taskCount(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.

launchType

EcsParameters.Builder launchType(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, LaunchType

launchType

EcsParameters.Builder launchType(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, LaunchType

networkConfiguration

EcsParameters.Builder networkConfiguration(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.

networkConfiguration

default EcsParameters.Builder networkConfiguration(Consumer<NetworkConfiguration.Builder> 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.

This is a convenience that creates an instance of the NetworkConfiguration.Builder avoiding the need to create one manually via NetworkConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to networkConfiguration(NetworkConfiguration).

Parameters:

networkConfiguration - a consumer that will call methods on NetworkConfiguration.Builder

Returns:

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

See Also:

networkConfiguration(NetworkConfiguration)

platformVersion

EcsParameters.Builder platformVersion(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.

group

EcsParameters.Builder group(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.