Class RunEcsFargateTaskProps
(deprecated) Properties to define an ECS service.
Inheritance
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.AWS.StepFunctions.Tasks.dll
Syntax (csharp)
public class RunEcsFargateTaskProps : Object, IRunEcsFargateTaskProps, ICommonEcsRunTaskProps
Syntax (vb)
Public Class RunEcsFargateTaskProps
Inherits Object
Implements IRunEcsFargateTaskProps, ICommonEcsRunTaskProps
Remarks
Stability: Deprecated
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EC2;
using Amazon.CDK.AWS.ECS;
using Amazon.CDK.AWS.StepFunctions;
using Amazon.CDK.AWS.StepFunctions.Tasks;
Cluster cluster;
ContainerDefinition containerDefinition;
SecurityGroup securityGroup;
Subnet subnet;
SubnetFilter subnetFilter;
TaskDefinition taskDefinition;
var runEcsFargateTaskProps = new RunEcsFargateTaskProps {
Cluster = cluster,
TaskDefinition = taskDefinition,
// the properties below are optional
AssignPublicIp = false,
ContainerOverrides = new [] { new ContainerOverride {
ContainerDefinition = containerDefinition,
// the properties below are optional
Command = new [] { "command" },
Cpu = 123,
Environment = new [] { new TaskEnvironmentVariable {
Name = "name",
Value = "value"
} },
MemoryLimit = 123,
MemoryReservation = 123
} },
IntegrationPattern = ServiceIntegrationPattern.FIRE_AND_FORGET,
PlatformVersion = FargatePlatformVersion.LATEST,
SecurityGroup = securityGroup,
Subnets = new SubnetSelection {
AvailabilityZones = new [] { "availabilityZones" },
OnePerAz = false,
SubnetFilters = new [] { subnetFilter },
SubnetGroupName = "subnetGroupName",
SubnetName = "subnetName",
Subnets = new [] { subnet },
SubnetType = SubnetType.ISOLATED
}
};
Synopsis
Constructors
RunEcsFargateTaskProps() |
Properties
AssignPublicIp | (deprecated) Assign public IP addresses to each task. |
Cluster | The topic to run the task on. |
ContainerOverrides | Container setting overrides. |
IntegrationPattern | The service integration pattern indicates different ways to call RunTask in ECS. |
PlatformVersion | (deprecated) Fargate platform version to run this service on. |
SecurityGroup | (deprecated) Existing security group to use for the tasks. |
Subnets | (deprecated) In what subnets to place the task's ENIs. |
TaskDefinition | Task Definition used for running tasks in the service. |
Constructors
RunEcsFargateTaskProps()
public RunEcsFargateTaskProps()
Properties
AssignPublicIp
(deprecated) Assign public IP addresses to each task.
public Nullable<bool> AssignPublicIp { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Stability: Deprecated
Cluster
ContainerOverrides
Container setting overrides.
public IContainerOverride[] ContainerOverrides { get; set; }
Property Value
Remarks
Key is the name of the container to override, value is the values you want to override.
Default: - No overrides
IntegrationPattern
The service integration pattern indicates different ways to call RunTask in ECS.
public Nullable<ServiceIntegrationPattern> IntegrationPattern { get; set; }
Property Value
System.Nullable<ServiceIntegrationPattern>
Remarks
The valid value for Lambda is FIRE_AND_FORGET, SYNC and WAIT_FOR_TASK_TOKEN.
Default: FIRE_AND_FORGET
PlatformVersion
(deprecated) Fargate platform version to run this service on.
public Nullable<FargatePlatformVersion> PlatformVersion { get; set; }
Property Value
System.Nullable<FargatePlatformVersion>
Remarks
Unless you have specific compatibility requirements, you don't need to specify this.
Default: Latest
Stability: Deprecated
SecurityGroup
(deprecated) Existing security group to use for the tasks.
public ISecurityGroup SecurityGroup { get; set; }
Property Value
Remarks
Default: A new security group is created
Stability: Deprecated
Subnets
(deprecated) In what subnets to place the task's ENIs.
public ISubnetSelection Subnets { get; set; }
Property Value
Remarks
Default: Private subnet if assignPublicIp, public subnets otherwise
Stability: Deprecated
TaskDefinition
Task Definition used for running tasks in the service.
public TaskDefinition TaskDefinition { get; set; }
Property Value
Remarks
Note: this must be TaskDefinition, and not ITaskDefinition, as it requires properties that are not known for imported task definitions