Class CfnPipePropsMixin.PipeTargetParametersProperty

The parameters required to set up a target for your pipe.

Inheritance

object

CfnPipePropsMixin.PipeTargetParametersProperty

Implements

CfnPipePropsMixin.IPipeTargetParametersProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.Pipes

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnPipePropsMixin.PipeTargetParametersProperty : CfnPipePropsMixin.IPipeTargetParametersProperty

Syntax (vb)

Public Class CfnPipePropsMixin.PipeTargetParametersProperty Implements CfnPipePropsMixin.IPipeTargetParametersProperty

Remarks

For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.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.CfnPropertyMixins.AWS.Pipes;

             var pipeTargetParametersProperty = new PipeTargetParametersProperty {
                 BatchJobParameters = 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
                     }
                 },
                 CloudWatchLogsParameters = new PipeTargetCloudWatchLogsParametersProperty {
                     LogStreamName = "logStreamName",
                     Timestamp = "timestamp"
                 },
                 EcsTaskParameters = new PipeTargetEcsTaskParametersProperty {
                     CapacityProviderStrategy = new [] { new CapacityProviderStrategyItemProperty {
                         Base = 123,
                         CapacityProvider = "capacityProvider",
                         Weight = 123
                     } },
                     EnableEcsManagedTags = false,
                     EnableExecuteCommand = false,
                     Group = "group",
                     LaunchType = "launchType",
                     NetworkConfiguration = new NetworkConfigurationProperty {
                         AwsvpcConfiguration = new AwsVpcConfigurationProperty {
                             AssignPublicIp = "assignPublicIp",
                             SecurityGroups = new [] { "securityGroups" },
                             Subnets = new [] { "subnets" }
                         }
                     },
                     Overrides = new EcsTaskOverrideProperty {
                         ContainerOverrides = new [] { new EcsContainerOverrideProperty {
                             Command = new [] { "command" },
                             Cpu = 123,
                             Environment = new [] { new EcsEnvironmentVariableProperty {
                                 Name = "name",
                                 Value = "value"
                             } },
                             EnvironmentFiles = new [] { new EcsEnvironmentFileProperty {
                                 Type = "type",
                                 Value = "value"
                             } },
                             Memory = 123,
                             MemoryReservation = 123,
                             Name = "name",
                             ResourceRequirements = new [] { new EcsResourceRequirementProperty {
                                 Type = "type",
                                 Value = "value"
                             } }
                         } },
                         Cpu = "cpu",
                         EphemeralStorage = new EcsEphemeralStorageProperty {
                             SizeInGiB = 123
                         },
                         ExecutionRoleArn = "executionRoleArn",
                         InferenceAcceleratorOverrides = new [] { new EcsInferenceAcceleratorOverrideProperty {
                             DeviceName = "deviceName",
                             DeviceType = "deviceType"
                         } },
                         Memory = "memory",
                         TaskRoleArn = "taskRoleArn"
                     },
                     PlacementConstraints = new [] { new PlacementConstraintProperty {
                         Expression = "expression",
                         Type = "type"
                     } },
                     PlacementStrategy = new [] { new PlacementStrategyProperty {
                         Field = "field",
                         Type = "type"
                     } },
                     PlatformVersion = "platformVersion",
                     PropagateTags = "propagateTags",
                     ReferenceId = "referenceId",
                     Tags = new [] { new CfnTag {
                         Key = "key",
                         Value = "value"
                     } },
                     TaskCount = 123,
                     TaskDefinitionArn = "taskDefinitionArn"
                 },
                 EventBridgeEventBusParameters = new PipeTargetEventBridgeEventBusParametersProperty {
                     DetailType = "detailType",
                     EndpointId = "endpointId",
                     Resources = new [] { "resources" },
                     Source = "source",
                     Time = "time"
                 },
                 HttpParameters = new PipeTargetHttpParametersProperty {
                     HeaderParameters = new Dictionary<string, string> {
                         { "headerParametersKey", "headerParameters" }
                     },
                     PathParameterValues = new [] { "pathParameterValues" },
                     QueryStringParameters = new Dictionary<string, string> {
                         { "queryStringParametersKey", "queryStringParameters" }
                     }
                 },
                 InputTemplate = "inputTemplate",
                 KinesisStreamParameters = new PipeTargetKinesisStreamParametersProperty {
                     PartitionKey = "partitionKey"
                 },
                 LambdaFunctionParameters = new PipeTargetLambdaFunctionParametersProperty {
                     InvocationType = "invocationType"
                 },
                 RedshiftDataParameters = new PipeTargetRedshiftDataParametersProperty {
                     Database = "database",
                     DbUser = "dbUser",
                     SecretManagerArn = "secretManagerArn",
                     Sqls = new [] { "sqls" },
                     StatementName = "statementName",
                     WithEvent = false
                 },
                 SageMakerPipelineParameters = new PipeTargetSageMakerPipelineParametersProperty {
                     PipelineParameterList = new [] { new SageMakerPipelineParameterProperty {
                         Name = "name",
                         Value = "value"
                     } }
                 },
                 SqsQueueParameters = new PipeTargetSqsQueueParametersProperty {
                     MessageDeduplicationId = "messageDeduplicationId",
                     MessageGroupId = "messageGroupId"
                 },
                 StepFunctionStateMachineParameters = new PipeTargetStateMachineParametersProperty {
                     InvocationType = "invocationType"
                 },
                 TimestreamParameters = new PipeTargetTimestreamParametersProperty {
                     DimensionMappings = new [] { new DimensionMappingProperty {
                         DimensionName = "dimensionName",
                         DimensionValue = "dimensionValue",
                         DimensionValueType = "dimensionValueType"
                     } },
                     EpochTimeUnit = "epochTimeUnit",
                     MultiMeasureMappings = new [] { new MultiMeasureMappingProperty {
                         MultiMeasureAttributeMappings = new [] { new MultiMeasureAttributeMappingProperty {
                             MeasureValue = "measureValue",
                             MeasureValueType = "measureValueType",
                             MultiMeasureAttributeName = "multiMeasureAttributeName"
                         } },
                         MultiMeasureName = "multiMeasureName"
                     } },
                     SingleMeasureMappings = new [] { new SingleMeasureMappingProperty {
                         MeasureName = "measureName",
                         MeasureValue = "measureValue",
                         MeasureValueType = "measureValueType"
                     } },
                     TimeFieldType = "timeFieldType",
                     TimestampFormat = "timestampFormat",
                     TimeValue = "timeValue",
                     VersionValue = "versionValue"
                 }
             };

Synopsis

Constructors

PipeTargetParametersProperty()

The parameters required to set up a target for your pipe.

Properties

BatchJobParameters	The parameters for using an AWS Batch job as a target.
CloudWatchLogsParameters	The parameters for using an CloudWatch Logs log stream as a target.
EcsTaskParameters	The parameters for using an Amazon ECS task as a target.
EventBridgeEventBusParameters	The parameters for using an EventBridge event bus as a target.
HttpParameters	These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
InputTemplate	Valid JSON text passed to the target.
KinesisStreamParameters	The parameters for using a Kinesis stream as a target.
LambdaFunctionParameters	The parameters for using a Lambda function as a target.
RedshiftDataParameters	These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.
SageMakerPipelineParameters	The parameters for using a SageMaker AI pipeline as a target.
SqsQueueParameters	The parameters for using a Amazon SQS stream as a target.
StepFunctionStateMachineParameters	The parameters for using a Step Functions state machine as a target.
TimestreamParameters	The parameters for using a Timestream for LiveAnalytics table as a target.

Constructors

PipeTargetParametersProperty()

The parameters required to set up a target for your pipe.

public PipeTargetParametersProperty()

Remarks

For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.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.CfnPropertyMixins.AWS.Pipes;

             var pipeTargetParametersProperty = new PipeTargetParametersProperty {
                 BatchJobParameters = 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
                     }
                 },
                 CloudWatchLogsParameters = new PipeTargetCloudWatchLogsParametersProperty {
                     LogStreamName = "logStreamName",
                     Timestamp = "timestamp"
                 },
                 EcsTaskParameters = new PipeTargetEcsTaskParametersProperty {
                     CapacityProviderStrategy = new [] { new CapacityProviderStrategyItemProperty {
                         Base = 123,
                         CapacityProvider = "capacityProvider",
                         Weight = 123
                     } },
                     EnableEcsManagedTags = false,
                     EnableExecuteCommand = false,
                     Group = "group",
                     LaunchType = "launchType",
                     NetworkConfiguration = new NetworkConfigurationProperty {
                         AwsvpcConfiguration = new AwsVpcConfigurationProperty {
                             AssignPublicIp = "assignPublicIp",
                             SecurityGroups = new [] { "securityGroups" },
                             Subnets = new [] { "subnets" }
                         }
                     },
                     Overrides = new EcsTaskOverrideProperty {
                         ContainerOverrides = new [] { new EcsContainerOverrideProperty {
                             Command = new [] { "command" },
                             Cpu = 123,
                             Environment = new [] { new EcsEnvironmentVariableProperty {
                                 Name = "name",
                                 Value = "value"
                             } },
                             EnvironmentFiles = new [] { new EcsEnvironmentFileProperty {
                                 Type = "type",
                                 Value = "value"
                             } },
                             Memory = 123,
                             MemoryReservation = 123,
                             Name = "name",
                             ResourceRequirements = new [] { new EcsResourceRequirementProperty {
                                 Type = "type",
                                 Value = "value"
                             } }
                         } },
                         Cpu = "cpu",
                         EphemeralStorage = new EcsEphemeralStorageProperty {
                             SizeInGiB = 123
                         },
                         ExecutionRoleArn = "executionRoleArn",
                         InferenceAcceleratorOverrides = new [] { new EcsInferenceAcceleratorOverrideProperty {
                             DeviceName = "deviceName",
                             DeviceType = "deviceType"
                         } },
                         Memory = "memory",
                         TaskRoleArn = "taskRoleArn"
                     },
                     PlacementConstraints = new [] { new PlacementConstraintProperty {
                         Expression = "expression",
                         Type = "type"
                     } },
                     PlacementStrategy = new [] { new PlacementStrategyProperty {
                         Field = "field",
                         Type = "type"
                     } },
                     PlatformVersion = "platformVersion",
                     PropagateTags = "propagateTags",
                     ReferenceId = "referenceId",
                     Tags = new [] { new CfnTag {
                         Key = "key",
                         Value = "value"
                     } },
                     TaskCount = 123,
                     TaskDefinitionArn = "taskDefinitionArn"
                 },
                 EventBridgeEventBusParameters = new PipeTargetEventBridgeEventBusParametersProperty {
                     DetailType = "detailType",
                     EndpointId = "endpointId",
                     Resources = new [] { "resources" },
                     Source = "source",
                     Time = "time"
                 },
                 HttpParameters = new PipeTargetHttpParametersProperty {
                     HeaderParameters = new Dictionary<string, string> {
                         { "headerParametersKey", "headerParameters" }
                     },
                     PathParameterValues = new [] { "pathParameterValues" },
                     QueryStringParameters = new Dictionary<string, string> {
                         { "queryStringParametersKey", "queryStringParameters" }
                     }
                 },
                 InputTemplate = "inputTemplate",
                 KinesisStreamParameters = new PipeTargetKinesisStreamParametersProperty {
                     PartitionKey = "partitionKey"
                 },
                 LambdaFunctionParameters = new PipeTargetLambdaFunctionParametersProperty {
                     InvocationType = "invocationType"
                 },
                 RedshiftDataParameters = new PipeTargetRedshiftDataParametersProperty {
                     Database = "database",
                     DbUser = "dbUser",
                     SecretManagerArn = "secretManagerArn",
                     Sqls = new [] { "sqls" },
                     StatementName = "statementName",
                     WithEvent = false
                 },
                 SageMakerPipelineParameters = new PipeTargetSageMakerPipelineParametersProperty {
                     PipelineParameterList = new [] { new SageMakerPipelineParameterProperty {
                         Name = "name",
                         Value = "value"
                     } }
                 },
                 SqsQueueParameters = new PipeTargetSqsQueueParametersProperty {
                     MessageDeduplicationId = "messageDeduplicationId",
                     MessageGroupId = "messageGroupId"
                 },
                 StepFunctionStateMachineParameters = new PipeTargetStateMachineParametersProperty {
                     InvocationType = "invocationType"
                 },
                 TimestreamParameters = new PipeTargetTimestreamParametersProperty {
                     DimensionMappings = new [] { new DimensionMappingProperty {
                         DimensionName = "dimensionName",
                         DimensionValue = "dimensionValue",
                         DimensionValueType = "dimensionValueType"
                     } },
                     EpochTimeUnit = "epochTimeUnit",
                     MultiMeasureMappings = new [] { new MultiMeasureMappingProperty {
                         MultiMeasureAttributeMappings = new [] { new MultiMeasureAttributeMappingProperty {
                             MeasureValue = "measureValue",
                             MeasureValueType = "measureValueType",
                             MultiMeasureAttributeName = "multiMeasureAttributeName"
                         } },
                         MultiMeasureName = "multiMeasureName"
                     } },
                     SingleMeasureMappings = new [] { new SingleMeasureMappingProperty {
                         MeasureName = "measureName",
                         MeasureValue = "measureValue",
                         MeasureValueType = "measureValueType"
                     } },
                     TimeFieldType = "timeFieldType",
                     TimestampFormat = "timestampFormat",
                     TimeValue = "timeValue",
                     VersionValue = "versionValue"
                 }
             };

Properties

BatchJobParameters

The parameters for using an AWS Batch job as a target.

public object? BatchJobParameters { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-batchjobparameters

Type union: either IResolvable or CfnPipePropsMixin.IPipeTargetBatchJobParametersProperty

CloudWatchLogsParameters

The parameters for using an CloudWatch Logs log stream as a target.

public object? CloudWatchLogsParameters { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-cloudwatchlogsparameters

Type union: either IResolvable or CfnPipePropsMixin.IPipeTargetCloudWatchLogsParametersProperty

EcsTaskParameters

The parameters for using an Amazon ECS task as a target.

public object? EcsTaskParameters { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-ecstaskparameters

Type union: either IResolvable or CfnPipePropsMixin.IPipeTargetEcsTaskParametersProperty

EventBridgeEventBusParameters

The parameters for using an EventBridge event bus as a target.

public object? EventBridgeEventBusParameters { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-eventbridgeeventbusparameters

Type union: either IResolvable or CfnPipePropsMixin.IPipeTargetEventBridgeEventBusParametersProperty

HttpParameters

These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.

public object? HttpParameters { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-httpparameters

Type union: either IResolvable or CfnPipePropsMixin.IPipeTargetHttpParametersProperty

InputTemplate

Valid JSON text passed to the target.

public string? InputTemplate { get; set; }

Property Value

string

Remarks

In this case, nothing from the event itself is passed to the target. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format .

To remove an input template, specify an empty string.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-inputtemplate

KinesisStreamParameters

The parameters for using a Kinesis stream as a target.

public object? KinesisStreamParameters { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-kinesisstreamparameters

Type union: either IResolvable or CfnPipePropsMixin.IPipeTargetKinesisStreamParametersProperty

LambdaFunctionParameters

The parameters for using a Lambda function as a target.

public object? LambdaFunctionParameters { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-lambdafunctionparameters

Type union: either IResolvable or CfnPipePropsMixin.IPipeTargetLambdaFunctionParametersProperty

RedshiftDataParameters

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.

public object? RedshiftDataParameters { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-redshiftdataparameters

Type union: either IResolvable or CfnPipePropsMixin.IPipeTargetRedshiftDataParametersProperty

SageMakerPipelineParameters

The parameters for using a SageMaker AI pipeline as a target.

public object? SageMakerPipelineParameters { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-sagemakerpipelineparameters

Type union: either IResolvable or CfnPipePropsMixin.IPipeTargetSageMakerPipelineParametersProperty

SqsQueueParameters

The parameters for using a Amazon SQS stream as a target.

public object? SqsQueueParameters { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-sqsqueueparameters

Type union: either IResolvable or CfnPipePropsMixin.IPipeTargetSqsQueueParametersProperty

StepFunctionStateMachineParameters

The parameters for using a Step Functions state machine as a target.

public object? StepFunctionStateMachineParameters { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-stepfunctionstatemachineparameters

Type union: either IResolvable or CfnPipePropsMixin.IPipeTargetStateMachineParametersProperty

TimestreamParameters

The parameters for using a Timestream for LiveAnalytics table as a target.

public object? TimestreamParameters { get; set; }