Class CfnPipePropsMixin.PipeTargetBatchJobParametersProperty
The parameters for using an AWS Batch job as a target.
Inherited Members
Namespace: Amazon.CDK.CfnPropertyMixins.AWS.Pipes
Assembly: Amazon.CDK.CfnPropertyMixins.dll
Syntax (csharp)
public class CfnPipePropsMixin.PipeTargetBatchJobParametersProperty : CfnPipePropsMixin.IPipeTargetBatchJobParametersPropertySyntax (vb)
Public Class CfnPipePropsMixin.PipeTargetBatchJobParametersProperty Implements CfnPipePropsMixin.IPipeTargetBatchJobParametersPropertyRemarks
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.CfnPropertyMixins.AWS.Pipes;
var pipeTargetBatchJobParametersProperty = new PipeTargetBatchJobParametersProperty {
ArrayProperties = new BatchArrayPropertiesProperty {
Size = 123
},
ContainerOverrides = new BatchContainerOverridesProperty {
Command = new [] { "command" },
Environment = new [] { new BatchEnvironmentVariableProperty {
Name = "name",
Value = "value"
} },
InstanceType = "instanceType",
ResourceRequirements = new [] { new BatchResourceRequirementProperty {
Type = "type",
Value = "value"
} }
},
DependsOn = new [] { new BatchJobDependencyProperty {
JobId = "jobId",
Type = "type"
} },
JobDefinition = "jobDefinition",
JobName = "jobName",
Parameters = new Dictionary<string, string> {
{ "parametersKey", "parameters" }
},
RetryStrategy = new BatchRetryStrategyProperty {
Attempts = 123
}
};Synopsis
Constructors
| PipeTargetBatchJobParametersProperty() | The parameters for using an AWS Batch job as a target. |
Properties
| ArrayProperties | The array properties for the submitted job, such as the size of the array. |
| ContainerOverrides | The overrides that are sent to a container. |
| DependsOn | A list of dependencies for the job. |
| JobDefinition | The job definition used by this job. |
| JobName | The name of the job. |
| Parameters | Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. |
| RetryStrategy | The retry strategy to use for failed jobs. |
Constructors
PipeTargetBatchJobParametersProperty()
The parameters for using an AWS Batch job as a target.
public PipeTargetBatchJobParametersProperty()Remarks
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.CfnPropertyMixins.AWS.Pipes;
var pipeTargetBatchJobParametersProperty = new PipeTargetBatchJobParametersProperty {
ArrayProperties = new BatchArrayPropertiesProperty {
Size = 123
},
ContainerOverrides = new BatchContainerOverridesProperty {
Command = new [] { "command" },
Environment = new [] { new BatchEnvironmentVariableProperty {
Name = "name",
Value = "value"
} },
InstanceType = "instanceType",
ResourceRequirements = new [] { new BatchResourceRequirementProperty {
Type = "type",
Value = "value"
} }
},
DependsOn = new [] { new BatchJobDependencyProperty {
JobId = "jobId",
Type = "type"
} },
JobDefinition = "jobDefinition",
JobName = "jobName",
Parameters = new Dictionary<string, string> {
{ "parametersKey", "parameters" }
},
RetryStrategy = new BatchRetryStrategyProperty {
Attempts = 123
}
};Properties
ArrayProperties
The array properties for the submitted job, such as the size of the array.
public object? ArrayProperties { get; set; }Property Value
Remarks
The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job.
Type union: either IResolvable or CfnPipePropsMixin.IBatchArrayPropertiesProperty
ContainerOverrides
The overrides that are sent to a container.
public object? ContainerOverrides { get; set; }Property Value
Remarks
DependsOn
A list of dependencies for the job.
public object? DependsOn { get; set; }Property Value
Remarks
A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.
Type union: either IResolvable or (either IResolvable or CfnPipePropsMixin.IBatchJobDependencyProperty)[]
JobDefinition
The job definition used by this job.
public string? JobDefinition { get; set; }Property Value
Remarks
This value can be one of name , name:revision , or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.
JobName
The name of the job.
public string? JobName { get; set; }Property Value
Remarks
It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
Parameters
Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition.
public object? Parameters { get; set; }Property Value
Remarks
Parameters are specified as a key and value pair mapping. Parameters included here override any corresponding parameter defaults from the job definition.
Type union: either Dictionary<string, string> or IResolvable
RetryStrategy
The retry strategy to use for failed jobs.
public object? RetryStrategy { get; set; }Property Value
Remarks
When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.
Type union: either IResolvable or CfnPipePropsMixin.IBatchRetryStrategyProperty