Package software.amazon.awscdk.services.events

Class CfnRule.EcsParametersProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.events.CfnRule.EcsParametersProperty.Jsii$Proxy

All Implemented Interfaces:

CfnRule.EcsParametersProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnRule.EcsParametersProperty

@Stability(Stable)
@Internal
public static final class CfnRule.EcsParametersProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnRule.EcsParametersProperty

An implementation for CfnRule.EcsParametersProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.events.CfnRule.EcsParametersProperty

CfnRule.EcsParametersProperty.Builder, CfnRule.EcsParametersProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnRule.EcsParametersProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnRule.EcsParametersProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getCapacityProviderStrategy()	The capacity provider strategy to use for the task.
final Object	getEnableEcsManagedTags()	Specifies whether to enable Amazon ECS managed tags for the task.
final Object	getEnableExecuteCommand()	Whether or not to enable the execute command functionality for the containers in this task.
final String	getGroup()	Specifies an ECS task group for the task.
final String	getLaunchType()	Specifies the launch type on which your task is running.
final Object	getNetworkConfiguration()	Use this structure if the Amazon ECS task uses the awsvpc network mode.
final Object	getPlacementConstraints()	An array of placement constraint objects to use for the task.
final Object	getPlacementStrategies()	The placement strategy objects to use for the task.
final String	getPlatformVersion()	Specifies the platform version for the task.
final String	getPropagateTags()	Specifies whether to propagate the tags from the task definition to the task.
final String	getReferenceId()	The reference ID to use for the task.
final Object	getTagList()	The metadata that you apply to the task to help you categorize and organize them.
final Number	getTaskCount()	The number of tasks to create based on TaskDefinition .
final String	getTaskDefinitionArn()	The ARN of the task definition to use if the event target is an Amazon ECS task.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnRule.EcsParametersProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnRule.EcsParametersProperty.Builder.

Method Details

getTaskDefinitionArn

public final String getTaskDefinitionArn()

Description copied from interface: CfnRule.EcsParametersProperty

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

Specified by:

getTaskDefinitionArn in interface CfnRule.EcsParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-taskdefinitionarn

getCapacityProviderStrategy

public final Object getCapacityProviderStrategy()

Description copied from interface: CfnRule.EcsParametersProperty

The capacity provider strategy to use for the task.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnRule.CapacityProviderStrategyItemProperty>

Specified by:

getCapacityProviderStrategy in interface CfnRule.EcsParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-capacityproviderstrategy

getEnableEcsManagedTags

public final Object getEnableEcsManagedTags()

Description copied from interface: CfnRule.EcsParametersProperty

Specifies whether to enable Amazon ECS managed tags for the task.

For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

Returns union: either Boolean or IResolvable

Specified by:

getEnableEcsManagedTags in interface CfnRule.EcsParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-enableecsmanagedtags

getEnableExecuteCommand

public final Object getEnableExecuteCommand()

Description copied from interface: CfnRule.EcsParametersProperty

Whether or not to enable the execute command functionality for the containers in this task.

If true, this enables execute command functionality on all containers in the task.

Returns union: either Boolean or IResolvable

Specified by:

getEnableExecuteCommand in interface CfnRule.EcsParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-enableexecutecommand

getGroup

public final String getGroup()

Description copied from interface: CfnRule.EcsParametersProperty

Specifies an ECS task group for the task.

The maximum length is 255 characters.

Specified by:

getGroup in interface CfnRule.EcsParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-group

getLaunchType

public final String getLaunchType()

Description copied from interface: CfnRule.EcsParametersProperty

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 .

Specified by:

getLaunchType in interface CfnRule.EcsParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-launchtype

getNetworkConfiguration

public final Object getNetworkConfiguration()

Description copied from interface: CfnRule.EcsParametersProperty

Use this structure if the Amazon 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 union: either IResolvable or CfnRule.NetworkConfigurationProperty

Specified by:

getNetworkConfiguration in interface CfnRule.EcsParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-networkconfiguration

getPlacementConstraints

public final Object getPlacementConstraints()

Description copied from interface: CfnRule.EcsParametersProperty

An array of placement constraint objects to use for the task.

You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnRule.PlacementConstraintProperty>

Specified by:

getPlacementConstraints in interface CfnRule.EcsParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-placementconstraints

getPlacementStrategies

public final Object getPlacementStrategies()

Description copied from interface: CfnRule.EcsParametersProperty

The placement strategy objects to use for the task.

You can specify a maximum of five strategy rules per task.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnRule.PlacementStrategyProperty>

Specified by:

getPlacementStrategies in interface CfnRule.EcsParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-placementstrategies

getPlatformVersion

public final String getPlatformVersion()

Description copied from interface: CfnRule.EcsParametersProperty

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 .

Specified by:

getPlatformVersion in interface CfnRule.EcsParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-platformversion

getPropagateTags

public final String getPropagateTags()

Description copied from interface: CfnRule.EcsParametersProperty

Specifies whether to propagate the tags from the task definition to the task.

If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.

Specified by:

getPropagateTags in interface CfnRule.EcsParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-propagatetags

getReferenceId

public final String getReferenceId()

Description copied from interface: CfnRule.EcsParametersProperty

The reference ID to use for the task.

Specified by:

getReferenceId in interface CfnRule.EcsParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-referenceid

getTagList

public final Object getTagList()

Description copied from interface: CfnRule.EcsParametersProperty

The metadata that you apply to the task to help you categorize and organize them.

Each tag consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTag>

Specified by:

getTagList in interface CfnRule.EcsParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-taglist

getTaskCount

public final Number getTaskCount()

Description copied from interface: CfnRule.EcsParametersProperty

The number of tasks to create based on TaskDefinition .

The default is 1.

Specified by:

getTaskCount in interface CfnRule.EcsParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-taskcount

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object