AWS SDK for C++  1.8.93
AWS SDK for C++
Public Member Functions | List of all members
Aws::EventBridge::Model::EcsParameters Class Reference

#include <EcsParameters.h>

Public Member Functions

 EcsParameters ()
 
 EcsParameters (Aws::Utils::Json::JsonView jsonValue)
 
EcsParametersoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetTaskDefinitionArn () const
 
bool TaskDefinitionArnHasBeenSet () const
 
void SetTaskDefinitionArn (const Aws::String &value)
 
void SetTaskDefinitionArn (Aws::String &&value)
 
void SetTaskDefinitionArn (const char *value)
 
EcsParametersWithTaskDefinitionArn (const Aws::String &value)
 
EcsParametersWithTaskDefinitionArn (Aws::String &&value)
 
EcsParametersWithTaskDefinitionArn (const char *value)
 
int GetTaskCount () const
 
bool TaskCountHasBeenSet () const
 
void SetTaskCount (int value)
 
EcsParametersWithTaskCount (int value)
 
const LaunchTypeGetLaunchType () const
 
bool LaunchTypeHasBeenSet () const
 
void SetLaunchType (const LaunchType &value)
 
void SetLaunchType (LaunchType &&value)
 
EcsParametersWithLaunchType (const LaunchType &value)
 
EcsParametersWithLaunchType (LaunchType &&value)
 
const NetworkConfigurationGetNetworkConfiguration () const
 
bool NetworkConfigurationHasBeenSet () const
 
void SetNetworkConfiguration (const NetworkConfiguration &value)
 
void SetNetworkConfiguration (NetworkConfiguration &&value)
 
EcsParametersWithNetworkConfiguration (const NetworkConfiguration &value)
 
EcsParametersWithNetworkConfiguration (NetworkConfiguration &&value)
 
const Aws::StringGetPlatformVersion () const
 
bool PlatformVersionHasBeenSet () const
 
void SetPlatformVersion (const Aws::String &value)
 
void SetPlatformVersion (Aws::String &&value)
 
void SetPlatformVersion (const char *value)
 
EcsParametersWithPlatformVersion (const Aws::String &value)
 
EcsParametersWithPlatformVersion (Aws::String &&value)
 
EcsParametersWithPlatformVersion (const char *value)
 
const Aws::StringGetGroup () const
 
bool GroupHasBeenSet () const
 
void SetGroup (const Aws::String &value)
 
void SetGroup (Aws::String &&value)
 
void SetGroup (const char *value)
 
EcsParametersWithGroup (const Aws::String &value)
 
EcsParametersWithGroup (Aws::String &&value)
 
EcsParametersWithGroup (const char *value)
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 34 of file EcsParameters.h.

Constructor & Destructor Documentation

◆ EcsParameters() [1/2]

Aws::EventBridge::Model::EcsParameters::EcsParameters ( )

◆ EcsParameters() [2/2]

Aws::EventBridge::Model::EcsParameters::EcsParameters ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetGroup()

const Aws::String& Aws::EventBridge::Model::EcsParameters::GetGroup ( ) const
inline

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

Definition at line 344 of file EcsParameters.h.

◆ GetLaunchType()

const LaunchType& Aws::EventBridge::Model::EcsParameters::GetLaunchType ( ) const
inline

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.

Definition at line 126 of file EcsParameters.h.

◆ GetNetworkConfiguration()

const NetworkConfiguration& Aws::EventBridge::Model::EcsParameters::GetNetworkConfiguration ( ) const
inline

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.

Definition at line 193 of file EcsParameters.h.

◆ GetPlatformVersion()

const Aws::String& Aws::EventBridge::Model::EcsParameters::GetPlatformVersion ( ) const
inline

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.

Definition at line 260 of file EcsParameters.h.

◆ GetTaskCount()

int Aws::EventBridge::Model::EcsParameters::GetTaskCount ( ) const
inline

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

Definition at line 96 of file EcsParameters.h.

◆ GetTaskDefinitionArn()

const Aws::String& Aws::EventBridge::Model::EcsParameters::GetTaskDefinitionArn ( ) const
inline

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

Definition at line 47 of file EcsParameters.h.

◆ GroupHasBeenSet()

bool Aws::EventBridge::Model::EcsParameters::GroupHasBeenSet ( ) const
inline

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

Definition at line 350 of file EcsParameters.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::EventBridge::Model::EcsParameters::Jsonize ( ) const

◆ LaunchTypeHasBeenSet()

bool Aws::EventBridge::Model::EcsParameters::LaunchTypeHasBeenSet ( ) const
inline

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.

Definition at line 137 of file EcsParameters.h.

◆ NetworkConfigurationHasBeenSet()

bool Aws::EventBridge::Model::EcsParameters::NetworkConfigurationHasBeenSet ( ) const
inline

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.

Definition at line 204 of file EcsParameters.h.

◆ operator=()

EcsParameters& Aws::EventBridge::Model::EcsParameters::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PlatformVersionHasBeenSet()

bool Aws::EventBridge::Model::EcsParameters::PlatformVersionHasBeenSet ( ) const
inline

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.

Definition at line 271 of file EcsParameters.h.

◆ SetGroup() [1/3]

void Aws::EventBridge::Model::EcsParameters::SetGroup ( const Aws::String value)
inline

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

Definition at line 356 of file EcsParameters.h.

◆ SetGroup() [2/3]

void Aws::EventBridge::Model::EcsParameters::SetGroup ( Aws::String &&  value)
inline

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

Definition at line 362 of file EcsParameters.h.

◆ SetGroup() [3/3]

void Aws::EventBridge::Model::EcsParameters::SetGroup ( const char *  value)
inline

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

Definition at line 368 of file EcsParameters.h.

◆ SetLaunchType() [1/2]

void Aws::EventBridge::Model::EcsParameters::SetLaunchType ( const LaunchType value)
inline

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.

Definition at line 148 of file EcsParameters.h.

◆ SetLaunchType() [2/2]

void Aws::EventBridge::Model::EcsParameters::SetLaunchType ( LaunchType &&  value)
inline

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.

Definition at line 159 of file EcsParameters.h.

◆ SetNetworkConfiguration() [1/2]

void Aws::EventBridge::Model::EcsParameters::SetNetworkConfiguration ( const NetworkConfiguration value)
inline

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.

Definition at line 215 of file EcsParameters.h.

◆ SetNetworkConfiguration() [2/2]

void Aws::EventBridge::Model::EcsParameters::SetNetworkConfiguration ( NetworkConfiguration &&  value)
inline

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.

Definition at line 226 of file EcsParameters.h.

◆ SetPlatformVersion() [1/3]

void Aws::EventBridge::Model::EcsParameters::SetPlatformVersion ( const Aws::String value)
inline

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.

Definition at line 282 of file EcsParameters.h.

◆ SetPlatformVersion() [2/3]

void Aws::EventBridge::Model::EcsParameters::SetPlatformVersion ( Aws::String &&  value)
inline

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.

Definition at line 293 of file EcsParameters.h.

◆ SetPlatformVersion() [3/3]

void Aws::EventBridge::Model::EcsParameters::SetPlatformVersion ( const char *  value)
inline

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.

Definition at line 304 of file EcsParameters.h.

◆ SetTaskCount()

void Aws::EventBridge::Model::EcsParameters::SetTaskCount ( int  value)
inline

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

Definition at line 108 of file EcsParameters.h.

◆ SetTaskDefinitionArn() [1/3]

void Aws::EventBridge::Model::EcsParameters::SetTaskDefinitionArn ( const Aws::String value)
inline

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

Definition at line 59 of file EcsParameters.h.

◆ SetTaskDefinitionArn() [2/3]

void Aws::EventBridge::Model::EcsParameters::SetTaskDefinitionArn ( Aws::String &&  value)
inline

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

Definition at line 65 of file EcsParameters.h.

◆ SetTaskDefinitionArn() [3/3]

void Aws::EventBridge::Model::EcsParameters::SetTaskDefinitionArn ( const char *  value)
inline

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

Definition at line 71 of file EcsParameters.h.

◆ TaskCountHasBeenSet()

bool Aws::EventBridge::Model::EcsParameters::TaskCountHasBeenSet ( ) const
inline

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

Definition at line 102 of file EcsParameters.h.

◆ TaskDefinitionArnHasBeenSet()

bool Aws::EventBridge::Model::EcsParameters::TaskDefinitionArnHasBeenSet ( ) const
inline

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

Definition at line 53 of file EcsParameters.h.

◆ WithGroup() [1/3]

EcsParameters& Aws::EventBridge::Model::EcsParameters::WithGroup ( const Aws::String value)
inline

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

Definition at line 374 of file EcsParameters.h.

◆ WithGroup() [2/3]

EcsParameters& Aws::EventBridge::Model::EcsParameters::WithGroup ( Aws::String &&  value)
inline

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

Definition at line 380 of file EcsParameters.h.

◆ WithGroup() [3/3]

EcsParameters& Aws::EventBridge::Model::EcsParameters::WithGroup ( const char *  value)
inline

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

Definition at line 386 of file EcsParameters.h.

◆ WithLaunchType() [1/2]

EcsParameters& Aws::EventBridge::Model::EcsParameters::WithLaunchType ( const LaunchType value)
inline

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.

Definition at line 170 of file EcsParameters.h.

◆ WithLaunchType() [2/2]

EcsParameters& Aws::EventBridge::Model::EcsParameters::WithLaunchType ( LaunchType &&  value)
inline

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.

Definition at line 181 of file EcsParameters.h.

◆ WithNetworkConfiguration() [1/2]

EcsParameters& Aws::EventBridge::Model::EcsParameters::WithNetworkConfiguration ( const NetworkConfiguration value)
inline

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.

Definition at line 237 of file EcsParameters.h.

◆ WithNetworkConfiguration() [2/2]

EcsParameters& Aws::EventBridge::Model::EcsParameters::WithNetworkConfiguration ( NetworkConfiguration &&  value)
inline

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.

Definition at line 248 of file EcsParameters.h.

◆ WithPlatformVersion() [1/3]

EcsParameters& Aws::EventBridge::Model::EcsParameters::WithPlatformVersion ( const Aws::String value)
inline

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.

Definition at line 315 of file EcsParameters.h.

◆ WithPlatformVersion() [2/3]

EcsParameters& Aws::EventBridge::Model::EcsParameters::WithPlatformVersion ( Aws::String &&  value)
inline

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.

Definition at line 326 of file EcsParameters.h.

◆ WithPlatformVersion() [3/3]

EcsParameters& Aws::EventBridge::Model::EcsParameters::WithPlatformVersion ( const char *  value)
inline

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.

Definition at line 337 of file EcsParameters.h.

◆ WithTaskCount()

EcsParameters& Aws::EventBridge::Model::EcsParameters::WithTaskCount ( int  value)
inline

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

Definition at line 114 of file EcsParameters.h.

◆ WithTaskDefinitionArn() [1/3]

EcsParameters& Aws::EventBridge::Model::EcsParameters::WithTaskDefinitionArn ( const Aws::String value)
inline

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

Definition at line 77 of file EcsParameters.h.

◆ WithTaskDefinitionArn() [2/3]

EcsParameters& Aws::EventBridge::Model::EcsParameters::WithTaskDefinitionArn ( Aws::String &&  value)
inline

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

Definition at line 83 of file EcsParameters.h.

◆ WithTaskDefinitionArn() [3/3]

EcsParameters& Aws::EventBridge::Model::EcsParameters::WithTaskDefinitionArn ( const char *  value)
inline

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

Definition at line 89 of file EcsParameters.h.


The documentation for this class was generated from the following file: