Class CfnJobDefinition.EcsPropertiesProperty

An object that contains the properties for the Amazon ECS resources of a job.

Inheritance

object

CfnJobDefinition.EcsPropertiesProperty

Implements

CfnJobDefinition.IEcsPropertiesProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Batch

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnJobDefinition.EcsPropertiesProperty : CfnJobDefinition.IEcsPropertiesProperty

Syntax (vb)

Public Class CfnJobDefinition.EcsPropertiesProperty Implements CfnJobDefinition.IEcsPropertiesProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ecsproperties.html

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.Batch;

             var options;

             var ecsPropertiesProperty = new EcsPropertiesProperty {
                 TaskProperties = new [] { new EcsTaskPropertiesProperty {
                     Containers = new [] { new TaskContainerPropertiesProperty {
                         Image = "image",

                         // the properties below are optional
                         Command = new [] { "command" },
                         DependsOn = new [] { new TaskContainerDependencyProperty {
                             Condition = "condition",
                             ContainerName = "containerName"
                         } },
                         Environment = new [] { new EnvironmentProperty {
                             Name = "name",
                             Value = "value"
                         } },
                         Essential = false,
                         FirelensConfiguration = new FirelensConfigurationProperty {
                             Type = "type",

                             // the properties below are optional
                             Options = new Dictionary<string, string> {
                                 { "optionsKey", "options" }
                             }
                         },
                         LinuxParameters = new LinuxParametersProperty {
                             Devices = new [] { new DeviceProperty {
                                 ContainerPath = "containerPath",
                                 HostPath = "hostPath",
                                 Permissions = new [] { "permissions" }
                             } },
                             InitProcessEnabled = false,
                             MaxSwap = 123,
                             SharedMemorySize = 123,
                             Swappiness = 123,
                             Tmpfs = new [] { new TmpfsProperty {
                                 ContainerPath = "containerPath",
                                 Size = 123,

                                 // the properties below are optional
                                 MountOptions = new [] { "mountOptions" }
                             } }
                         },
                         LogConfiguration = new LogConfigurationProperty {
                             LogDriver = "logDriver",

                             // the properties below are optional
                             Options = options,
                             SecretOptions = new [] { new SecretProperty {
                                 Name = "name",
                                 ValueFrom = "valueFrom"
                             } }
                         },
                         MountPoints = new [] { new MountPointProperty {
                             ContainerPath = "containerPath",
                             ReadOnly = false,
                             SourceVolume = "sourceVolume"
                         } },
                         Name = "name",
                         Privileged = false,
                         ReadonlyRootFilesystem = false,
                         RepositoryCredentials = new RepositoryCredentialsProperty {
                             CredentialsParameter = "credentialsParameter"
                         },
                         ResourceRequirements = new [] { new ResourceRequirementProperty {
                             Type = "type",
                             Value = "value"
                         } },
                         Secrets = new [] { new SecretProperty {
                             Name = "name",
                             ValueFrom = "valueFrom"
                         } },
                         Ulimits = new [] { new UlimitProperty {
                             HardLimit = 123,
                             Name = "name",
                             SoftLimit = 123
                         } },
                         User = "user"
                     } },
                     EnableExecuteCommand = false,
                     EphemeralStorage = new EphemeralStorageProperty {
                         SizeInGiB = 123
                     },
                     ExecutionRoleArn = "executionRoleArn",
                     IpcMode = "ipcMode",
                     NetworkConfiguration = new NetworkConfigurationProperty {
                         AssignPublicIp = "assignPublicIp"
                     },
                     PidMode = "pidMode",
                     PlatformVersion = "platformVersion",
                     RuntimePlatform = new RuntimePlatformProperty {
                         CpuArchitecture = "cpuArchitecture",
                         OperatingSystemFamily = "operatingSystemFamily"
                     },
                     TaskRoleArn = "taskRoleArn",
                     Volumes = new [] { new VolumesProperty {
                         EfsVolumeConfiguration = new EfsVolumeConfigurationProperty {
                             FileSystemId = "fileSystemId",

                             // the properties below are optional
                             AuthorizationConfig = new AuthorizationConfigProperty {
                                 AccessPointId = "accessPointId",
                                 Iam = "iam"
                             },
                             RootDirectory = "rootDirectory",
                             TransitEncryption = "transitEncryption",
                             TransitEncryptionPort = 123
                         },
                         Host = new VolumesHostProperty {
                             SourcePath = "sourcePath"
                         },
                         Name = "name"
                     } }
                 } }
             };

Synopsis

Constructors

EcsPropertiesProperty()

An object that contains the properties for the Amazon ECS resources of a job.

Properties

TaskProperties

An object that contains the properties for the Amazon ECS task definition of a job.

Constructors

EcsPropertiesProperty()

An object that contains the properties for the Amazon ECS resources of a job.

public EcsPropertiesProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ecsproperties.html

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.Batch;

             var options;

             var ecsPropertiesProperty = new EcsPropertiesProperty {
                 TaskProperties = new [] { new EcsTaskPropertiesProperty {
                     Containers = new [] { new TaskContainerPropertiesProperty {
                         Image = "image",

                         // the properties below are optional
                         Command = new [] { "command" },
                         DependsOn = new [] { new TaskContainerDependencyProperty {
                             Condition = "condition",
                             ContainerName = "containerName"
                         } },
                         Environment = new [] { new EnvironmentProperty {
                             Name = "name",
                             Value = "value"
                         } },
                         Essential = false,
                         FirelensConfiguration = new FirelensConfigurationProperty {
                             Type = "type",

                             // the properties below are optional
                             Options = new Dictionary<string, string> {
                                 { "optionsKey", "options" }
                             }
                         },
                         LinuxParameters = new LinuxParametersProperty {
                             Devices = new [] { new DeviceProperty {
                                 ContainerPath = "containerPath",
                                 HostPath = "hostPath",
                                 Permissions = new [] { "permissions" }
                             } },
                             InitProcessEnabled = false,
                             MaxSwap = 123,
                             SharedMemorySize = 123,
                             Swappiness = 123,
                             Tmpfs = new [] { new TmpfsProperty {
                                 ContainerPath = "containerPath",
                                 Size = 123,

                                 // the properties below are optional
                                 MountOptions = new [] { "mountOptions" }
                             } }
                         },
                         LogConfiguration = new LogConfigurationProperty {
                             LogDriver = "logDriver",

                             // the properties below are optional
                             Options = options,
                             SecretOptions = new [] { new SecretProperty {
                                 Name = "name",
                                 ValueFrom = "valueFrom"
                             } }
                         },
                         MountPoints = new [] { new MountPointProperty {
                             ContainerPath = "containerPath",
                             ReadOnly = false,
                             SourceVolume = "sourceVolume"
                         } },
                         Name = "name",
                         Privileged = false,
                         ReadonlyRootFilesystem = false,
                         RepositoryCredentials = new RepositoryCredentialsProperty {
                             CredentialsParameter = "credentialsParameter"
                         },
                         ResourceRequirements = new [] { new ResourceRequirementProperty {
                             Type = "type",
                             Value = "value"
                         } },
                         Secrets = new [] { new SecretProperty {
                             Name = "name",
                             ValueFrom = "valueFrom"
                         } },
                         Ulimits = new [] { new UlimitProperty {
                             HardLimit = 123,
                             Name = "name",
                             SoftLimit = 123
                         } },
                         User = "user"
                     } },
                     EnableExecuteCommand = false,
                     EphemeralStorage = new EphemeralStorageProperty {
                         SizeInGiB = 123
                     },
                     ExecutionRoleArn = "executionRoleArn",
                     IpcMode = "ipcMode",
                     NetworkConfiguration = new NetworkConfigurationProperty {
                         AssignPublicIp = "assignPublicIp"
                     },
                     PidMode = "pidMode",
                     PlatformVersion = "platformVersion",
                     RuntimePlatform = new RuntimePlatformProperty {
                         CpuArchitecture = "cpuArchitecture",
                         OperatingSystemFamily = "operatingSystemFamily"
                     },
                     TaskRoleArn = "taskRoleArn",
                     Volumes = new [] { new VolumesProperty {
                         EfsVolumeConfiguration = new EfsVolumeConfigurationProperty {
                             FileSystemId = "fileSystemId",

                             // the properties below are optional
                             AuthorizationConfig = new AuthorizationConfigProperty {
                                 AccessPointId = "accessPointId",
                                 Iam = "iam"
                             },
                             RootDirectory = "rootDirectory",
                             TransitEncryption = "transitEncryption",
                             TransitEncryptionPort = 123
                         },
                         Host = new VolumesHostProperty {
                             SourcePath = "sourcePath"
                         },
                         Name = "name"
                     } }
                 } }
             };

Properties

TaskProperties

An object that contains the properties for the Amazon ECS task definition of a job.

public object TaskProperties { get; set; }

Property Value

object

Remarks

This object is currently limited to one task element. However, the task element can run up to 10 containers.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ecsproperties.html#cfn-batch-jobdefinition-ecsproperties-taskproperties

Type union: either IResolvable or (either IResolvable or CfnJobDefinition.IEcsTaskPropertiesProperty)[]

Implements

CfnJobDefinition.IEcsPropertiesProperty