Class Ec2TaskDefinition
The details of a task definition run on an EC2 cluster.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.ECS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class Ec2TaskDefinition : TaskDefinition, IEc2TaskDefinition, ITaskDefinition, IResource
Syntax (vb)
Public Class Ec2TaskDefinition
Inherits TaskDefinition
Implements IEc2TaskDefinition, ITaskDefinition, IResource
Remarks
Resource: AWS::ECS::TaskDefinition
ExampleMetadata: infused
Examples
Secret secret;
// Create a Task Definition for the container to start
var taskDefinition = new Ec2TaskDefinition(this, "TaskDef");
taskDefinition.AddContainer("TheContainer", new ContainerDefinitionOptions {
Image = ContainerImage.FromRegistry("example-image"),
MemoryLimitMiB = 256,
Logging = LogDrivers.Splunk(new SplunkLogDriverProps {
SecretToken = secret,
Url = "my-splunk-url"
})
});
Synopsis
Constructors
Ec2TaskDefinition(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
Ec2TaskDefinition(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Ec2TaskDefinition(Construct, String, IEc2TaskDefinitionProps) | Constructs a new instance of the Ec2TaskDefinition class. |
Methods
AddContainer(String, IContainerDefinitionOptions) | Tasks running in AWSVPC networking mode requires an additional environment variable for the region to be sourced. |
FromEc2TaskDefinitionArn(Construct, String, String) | Imports a task definition from the specified task definition ARN. |
FromEc2TaskDefinitionAttributes(Construct, String, IEc2TaskDefinitionAttributes) | Imports an existing Ec2 task definition from its attributes. |
Constructors
Ec2TaskDefinition(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected Ec2TaskDefinition(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
Ec2TaskDefinition(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected Ec2TaskDefinition(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Ec2TaskDefinition(Construct, String, IEc2TaskDefinitionProps)
Constructs a new instance of the Ec2TaskDefinition class.
public Ec2TaskDefinition(Construct scope, string id, IEc2TaskDefinitionProps props = null)
Parameters
- scope Constructs.Construct
- id System.String
- props IEc2TaskDefinitionProps
Methods
AddContainer(String, IContainerDefinitionOptions)
Tasks running in AWSVPC networking mode requires an additional environment variable for the region to be sourced.
public override ContainerDefinition AddContainer(string id, IContainerDefinitionOptions props)
Parameters
- id System.String
- props IContainerDefinitionOptions
Returns
Overrides
Remarks
This override adds in the additional environment variable as required
FromEc2TaskDefinitionArn(Construct, String, String)
Imports a task definition from the specified task definition ARN.
public static IEc2TaskDefinition FromEc2TaskDefinitionArn(Construct scope, string id, string ec2TaskDefinitionArn)
Parameters
- scope Constructs.Construct
- id System.String
- ec2TaskDefinitionArn System.String
Returns
FromEc2TaskDefinitionAttributes(Construct, String, IEc2TaskDefinitionAttributes)
Imports an existing Ec2 task definition from its attributes.
public static IEc2TaskDefinition FromEc2TaskDefinitionAttributes(Construct scope, string id, IEc2TaskDefinitionAttributes attrs)
Parameters
- scope Constructs.Construct
- id System.String
- attrs IEc2TaskDefinitionAttributes
Returns