Show / Hide Table of Contents

Class CfnPipe

Specifies a pipe.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnPipe
Implements
IInspectable
ITaggable
Inherited Members
CfnResource.IsCfnResource(object)
CfnResource.AddDeletionOverride(string)
CfnResource.AddDependency(CfnResource)
CfnResource.AddDependsOn(CfnResource)
CfnResource.AddMetadata(string, object)
CfnResource.AddOverride(string, object)
CfnResource.AddPropertyDeletionOverride(string)
CfnResource.AddPropertyOverride(string, object)
CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)
CfnResource.GetAtt(string, ResolutionTypeHint?)
CfnResource.GetMetadata(string)
CfnResource.ObtainDependencies()
CfnResource.ObtainResourceDependencies()
CfnResource.RemoveDependency(CfnResource)
CfnResource.ReplaceDependency(CfnResource, CfnResource)
CfnResource.ShouldSynthesize()
CfnResource.ToString()
CfnResource.ValidateProperties(object)
CfnResource.CfnOptions
CfnResource.CfnResourceType
CfnResource.UpdatedProperites
CfnResource.UpdatedProperties
CfnRefElement.Ref
CfnElement.IsCfnElement(object)
CfnElement.OverrideLogicalId(string)
CfnElement.CreationStack
CfnElement.LogicalId
CfnElement.Stack
Namespace: Amazon.CDK.AWS.Pipes
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnPipe : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnPipe Inherits CfnResource Implements IInspectable, ITaggable
Remarks

Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

As an aid to help you jumpstart developing CloudFormation templates, the EventBridge console enables you to create templates from the existing pipes in your account. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-generate-template.html">Generate an CloudFormation template from EventBridge Pipes</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html

CloudformationResource: AWS::Pipes::Pipe

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

             var cfnPipe = new CfnPipe(this, "MyCfnPipe", new CfnPipeProps {
                 RoleArn = "roleArn",
                 Source = "source",
                 Target = "target",

                 // the properties below are optional
                 Description = "description",
                 DesiredState = "desiredState",
                 Enrichment = "enrichment",
                 EnrichmentParameters = new PipeEnrichmentParametersProperty {
                     HttpParameters = new PipeEnrichmentHttpParametersProperty {
                         HeaderParameters = new Dictionary<string, string> {
                             { "headerParametersKey", "headerParameters" }
                         },
                         PathParameterValues = new [] { "pathParameterValues" },
                         QueryStringParameters = new Dictionary<string, string> {
                             { "queryStringParametersKey", "queryStringParameters" }
                         }
                     },
                     InputTemplate = "inputTemplate"
                 },
                 KmsKeyIdentifier = "kmsKeyIdentifier",
                 LogConfiguration = new PipeLogConfigurationProperty {
                     CloudwatchLogsLogDestination = new CloudwatchLogsLogDestinationProperty {
                         LogGroupArn = "logGroupArn"
                     },
                     FirehoseLogDestination = new FirehoseLogDestinationProperty {
                         DeliveryStreamArn = "deliveryStreamArn"
                     },
                     IncludeExecutionData = new [] { "includeExecutionData" },
                     Level = "level",
                     S3LogDestination = new S3LogDestinationProperty {
                         BucketName = "bucketName",
                         BucketOwner = "bucketOwner",
                         OutputFormat = "outputFormat",
                         Prefix = "prefix"
                     }
                 },
                 Name = "name",
                 SourceParameters = new PipeSourceParametersProperty {
                     ActiveMqBrokerParameters = new PipeSourceActiveMQBrokerParametersProperty {
                         Credentials = new MQBrokerAccessCredentialsProperty {
                             BasicAuth = "basicAuth"
                         },
                         QueueName = "queueName",

                         // the properties below are optional
                         BatchSize = 123,
                         MaximumBatchingWindowInSeconds = 123
                     },
                     DynamoDbStreamParameters = new PipeSourceDynamoDBStreamParametersProperty {
                         StartingPosition = "startingPosition",

                         // the properties below are optional
                         BatchSize = 123,
                         DeadLetterConfig = new DeadLetterConfigProperty {
                             Arn = "arn"
                         },
                         MaximumBatchingWindowInSeconds = 123,
                         MaximumRecordAgeInSeconds = 123,
                         MaximumRetryAttempts = 123,
                         OnPartialBatchItemFailure = "onPartialBatchItemFailure",
                         ParallelizationFactor = 123
                     },
                     FilterCriteria = new FilterCriteriaProperty {
                         Filters = new [] { new FilterProperty {
                             Pattern = "pattern"
                         } }
                     },
                     KinesisStreamParameters = new PipeSourceKinesisStreamParametersProperty {
                         StartingPosition = "startingPosition",

                         // the properties below are optional
                         BatchSize = 123,
                         DeadLetterConfig = new DeadLetterConfigProperty {
                             Arn = "arn"
                         },
                         MaximumBatchingWindowInSeconds = 123,
                         MaximumRecordAgeInSeconds = 123,
                         MaximumRetryAttempts = 123,
                         OnPartialBatchItemFailure = "onPartialBatchItemFailure",
                         ParallelizationFactor = 123,
                         StartingPositionTimestamp = "startingPositionTimestamp"
                     },
                     ManagedStreamingKafkaParameters = new PipeSourceManagedStreamingKafkaParametersProperty {
                         TopicName = "topicName",

                         // the properties below are optional
                         BatchSize = 123,
                         ConsumerGroupId = "consumerGroupId",
                         Credentials = new MSKAccessCredentialsProperty {
                             ClientCertificateTlsAuth = "clientCertificateTlsAuth",
                             SaslScram512Auth = "saslScram512Auth"
                         },
                         MaximumBatchingWindowInSeconds = 123,
                         StartingPosition = "startingPosition"
                     },
                     RabbitMqBrokerParameters = new PipeSourceRabbitMQBrokerParametersProperty {
                         Credentials = new MQBrokerAccessCredentialsProperty {
                             BasicAuth = "basicAuth"
                         },
                         QueueName = "queueName",

                         // the properties below are optional
                         BatchSize = 123,
                         MaximumBatchingWindowInSeconds = 123,
                         VirtualHost = "virtualHost"
                     },
                     SelfManagedKafkaParameters = new PipeSourceSelfManagedKafkaParametersProperty {
                         TopicName = "topicName",

                         // the properties below are optional
                         AdditionalBootstrapServers = new [] { "additionalBootstrapServers" },
                         BatchSize = 123,
                         ConsumerGroupId = "consumerGroupId",
                         Credentials = new SelfManagedKafkaAccessConfigurationCredentialsProperty {
                             BasicAuth = "basicAuth",
                             ClientCertificateTlsAuth = "clientCertificateTlsAuth",
                             SaslScram256Auth = "saslScram256Auth",
                             SaslScram512Auth = "saslScram512Auth"
                         },
                         MaximumBatchingWindowInSeconds = 123,
                         ServerRootCaCertificate = "serverRootCaCertificate",
                         StartingPosition = "startingPosition",
                         Vpc = new SelfManagedKafkaAccessConfigurationVpcProperty {
                             SecurityGroup = new [] { "securityGroup" },
                             Subnets = new [] { "subnets" }
                         }
                     },
                     SqsQueueParameters = new PipeSourceSqsQueueParametersProperty {
                         BatchSize = 123,
                         MaximumBatchingWindowInSeconds = 123
                     }
                 },
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 },
                 TargetParameters = new PipeTargetParametersProperty {
                     BatchJobParameters = new PipeTargetBatchJobParametersProperty {
                         JobDefinition = "jobDefinition",
                         JobName = "jobName",

                         // the properties below are optional
                         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"
                         } },
                         Parameters = new Dictionary<string, string> {
                             { "parametersKey", "parameters" }
                         },
                         RetryStrategy = new BatchRetryStrategyProperty {
                             Attempts = 123
                         }
                     },
                     CloudWatchLogsParameters = new PipeTargetCloudWatchLogsParametersProperty {
                         LogStreamName = "logStreamName",
                         Timestamp = "timestamp"
                     },
                     EcsTaskParameters = new PipeTargetEcsTaskParametersProperty {
                         TaskDefinitionArn = "taskDefinitionArn",

                         // the properties below are optional
                         CapacityProviderStrategy = new [] { new CapacityProviderStrategyItemProperty {
                             CapacityProvider = "capacityProvider",

                             // the properties below are optional
                             Base = 123,
                             Weight = 123
                         } },
                         EnableEcsManagedTags = false,
                         EnableExecuteCommand = false,
                         Group = "group",
                         LaunchType = "launchType",
                         NetworkConfiguration = new NetworkConfigurationProperty {
                             AwsvpcConfiguration = new AwsVpcConfigurationProperty {
                                 Subnets = new [] { "subnets" },

                                 // the properties below are optional
                                 AssignPublicIp = "assignPublicIp",
                                 SecurityGroups = new [] { "securityGroups" }
                             }
                         },
                         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
                     },
                     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",
                         Sqls = new [] { "sqls" },

                         // the properties below are optional
                         DbUser = "dbUser",
                         SecretManagerArn = "secretManagerArn",
                         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"
                         } },
                         TimeValue = "timeValue",
                         VersionValue = "versionValue",

                         // the properties below are optional
                         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"
                     }
                 }
             });

Synopsis

Constructors

CfnPipe(Construct, string, ICfnPipeProps)

Specifies a pipe.

Properties

AttrArn

The ARN of the pipe.

AttrCreationTime

The time the pipe was created.

AttrCurrentState

The state the pipe is in.

AttrLastModifiedTime

When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

AttrStateReason

The reason the pipe is in its current state.

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

CfnProperties

Specifies a pipe.

Description

A description of the pipe.

DesiredState

The state the pipe should be in.

Enrichment

The ARN of the enrichment resource.

EnrichmentParameters

The parameters required to set up enrichment on your pipe.

KmsKeyIdentifier

The identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data.

LogConfiguration

The logging configuration settings for the pipe.

Name

The name of the pipe.

RoleArn

The ARN of the role that allows the pipe to send data to the target.

Source

The ARN of the source resource.

SourceParameters

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

Tags

Tag Manager which manages the tags for this resource.

TagsRaw

The list of key-value pairs to associate with the pipe.

Target

The ARN of the target resource.

TargetParameters

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

RenderProperties(IDictionary<string, object>)

Specifies a pipe.

Constructors

CfnPipe(Construct, string, ICfnPipeProps)

Specifies a pipe.

public CfnPipe(Construct scope, string id, ICfnPipeProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnPipeProps

Resource properties.

Remarks

Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

As an aid to help you jumpstart developing CloudFormation templates, the EventBridge console enables you to create templates from the existing pipes in your account. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-generate-template.html">Generate an CloudFormation template from EventBridge Pipes</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html

CloudformationResource: AWS::Pipes::Pipe

ExampleMetadata: fixture=_generated

Properties

AttrArn

The ARN of the pipe.

public virtual string AttrArn { get; }
Property Value

string

Remarks

CloudformationAttribute: Arn

AttrCreationTime

The time the pipe was created.

public virtual string AttrCreationTime { get; }
Property Value

string

Remarks

CloudformationAttribute: CreationTime

AttrCurrentState

The state the pipe is in.

public virtual string AttrCurrentState { get; }
Property Value

string

Remarks

CloudformationAttribute: CurrentState

AttrLastModifiedTime

When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

public virtual string AttrLastModifiedTime { get; }
Property Value

string

Remarks

CloudformationAttribute: LastModifiedTime

AttrStateReason

The reason the pipe is in its current state.

public virtual string AttrStateReason { get; }
Property Value

string

Remarks

CloudformationAttribute: StateReason

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

As an aid to help you jumpstart developing CloudFormation templates, the EventBridge console enables you to create templates from the existing pipes in your account. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-generate-template.html">Generate an CloudFormation template from EventBridge Pipes</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html

CloudformationResource: AWS::Pipes::Pipe

ExampleMetadata: fixture=_generated

CfnProperties

Specifies a pipe.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
CfnResource.CfnProperties
Remarks

Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

As an aid to help you jumpstart developing CloudFormation templates, the EventBridge console enables you to create templates from the existing pipes in your account. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-generate-template.html">Generate an CloudFormation template from EventBridge Pipes</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html

CloudformationResource: AWS::Pipes::Pipe

ExampleMetadata: fixture=_generated

Description

A description of the pipe.

public virtual string? Description { get; set; }
Property Value

string

Remarks

Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

As an aid to help you jumpstart developing CloudFormation templates, the EventBridge console enables you to create templates from the existing pipes in your account. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-generate-template.html">Generate an CloudFormation template from EventBridge Pipes</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html

CloudformationResource: AWS::Pipes::Pipe

ExampleMetadata: fixture=_generated

DesiredState

The state the pipe should be in.

public virtual string? DesiredState { get; set; }
Property Value

string

Remarks

Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

As an aid to help you jumpstart developing CloudFormation templates, the EventBridge console enables you to create templates from the existing pipes in your account. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-generate-template.html">Generate an CloudFormation template from EventBridge Pipes</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html

CloudformationResource: AWS::Pipes::Pipe

ExampleMetadata: fixture=_generated

Enrichment

The ARN of the enrichment resource.

public virtual string? Enrichment { get; set; }
Property Value

string

Remarks

Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

As an aid to help you jumpstart developing CloudFormation templates, the EventBridge console enables you to create templates from the existing pipes in your account. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-generate-template.html">Generate an CloudFormation template from EventBridge Pipes</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html

CloudformationResource: AWS::Pipes::Pipe

ExampleMetadata: fixture=_generated

EnrichmentParameters

The parameters required to set up enrichment on your pipe.

public virtual object? EnrichmentParameters { get; set; }
Property Value

object

Remarks

Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

As an aid to help you jumpstart developing CloudFormation templates, the EventBridge console enables you to create templates from the existing pipes in your account. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-generate-template.html">Generate an CloudFormation template from EventBridge Pipes</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html

CloudformationResource: AWS::Pipes::Pipe

ExampleMetadata: fixture=_generated

KmsKeyIdentifier

The identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data.

public virtual string? KmsKeyIdentifier { get; set; }
Property Value

string

Remarks

Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

As an aid to help you jumpstart developing CloudFormation templates, the EventBridge console enables you to create templates from the existing pipes in your account. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-generate-template.html">Generate an CloudFormation template from EventBridge Pipes</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html

CloudformationResource: AWS::Pipes::Pipe

ExampleMetadata: fixture=_generated

LogConfiguration

The logging configuration settings for the pipe.

public virtual object? LogConfiguration { get; set; }
Property Value

object

Remarks

Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

As an aid to help you jumpstart developing CloudFormation templates, the EventBridge console enables you to create templates from the existing pipes in your account. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-generate-template.html">Generate an CloudFormation template from EventBridge Pipes</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html

CloudformationResource: AWS::Pipes::Pipe

ExampleMetadata: fixture=_generated

Name

The name of the pipe.

public virtual string? Name { get; set; }
Property Value

string

Remarks

Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

As an aid to help you jumpstart developing CloudFormation templates, the EventBridge console enables you to create templates from the existing pipes in your account. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-generate-template.html">Generate an CloudFormation template from EventBridge Pipes</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html

CloudformationResource: AWS::Pipes::Pipe

ExampleMetadata: fixture=_generated

RoleArn

The ARN of the role that allows the pipe to send data to the target.

public virtual string RoleArn { get; set; }
Property Value

string

Remarks

Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

As an aid to help you jumpstart developing CloudFormation templates, the EventBridge console enables you to create templates from the existing pipes in your account. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-generate-template.html">Generate an CloudFormation template from EventBridge Pipes</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html

CloudformationResource: AWS::Pipes::Pipe

ExampleMetadata: fixture=_generated

Source

The ARN of the source resource.

public virtual string Source { get; set; }
Property Value

string

Remarks

Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

As an aid to help you jumpstart developing CloudFormation templates, the EventBridge console enables you to create templates from the existing pipes in your account. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-generate-template.html">Generate an CloudFormation template from EventBridge Pipes</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html

CloudformationResource: AWS::Pipes::Pipe

ExampleMetadata: fixture=_generated

SourceParameters

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

public virtual object? SourceParameters { get; set; }
Property Value

object

Remarks

Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

As an aid to help you jumpstart developing CloudFormation templates, the EventBridge console enables you to create templates from the existing pipes in your account. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-generate-template.html">Generate an CloudFormation template from EventBridge Pipes</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html

CloudformationResource: AWS::Pipes::Pipe

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

As an aid to help you jumpstart developing CloudFormation templates, the EventBridge console enables you to create templates from the existing pipes in your account. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-generate-template.html">Generate an CloudFormation template from EventBridge Pipes</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html

CloudformationResource: AWS::Pipes::Pipe

ExampleMetadata: fixture=_generated

TagsRaw

The list of key-value pairs to associate with the pipe.

public virtual IDictionary<string, string>? TagsRaw { get; set; }
Property Value

IDictionary<string, string>

Remarks

Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

As an aid to help you jumpstart developing CloudFormation templates, the EventBridge console enables you to create templates from the existing pipes in your account. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-generate-template.html">Generate an CloudFormation template from EventBridge Pipes</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html

CloudformationResource: AWS::Pipes::Pipe

ExampleMetadata: fixture=_generated

Target

The ARN of the target resource.

public virtual string Target { get; set; }
Property Value

string

Remarks

Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

As an aid to help you jumpstart developing CloudFormation templates, the EventBridge console enables you to create templates from the existing pipes in your account. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-generate-template.html">Generate an CloudFormation template from EventBridge Pipes</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html

CloudformationResource: AWS::Pipes::Pipe

ExampleMetadata: fixture=_generated

TargetParameters

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

public virtual object? TargetParameters { get; set; }
Property Value

object

Remarks

Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

As an aid to help you jumpstart developing CloudFormation templates, the EventBridge console enables you to create templates from the existing pipes in your account. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-generate-template.html">Generate an CloudFormation template from EventBridge Pipes</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html

CloudformationResource: AWS::Pipes::Pipe

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

As an aid to help you jumpstart developing CloudFormation templates, the EventBridge console enables you to create templates from the existing pipes in your account. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-generate-template.html">Generate an CloudFormation template from EventBridge Pipes</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html

CloudformationResource: AWS::Pipes::Pipe

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Specifies a pipe.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
CfnResource.RenderProperties(IDictionary<string, object>)
Remarks

Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

As an aid to help you jumpstart developing CloudFormation templates, the EventBridge console enables you to create templates from the existing pipes in your account. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-generate-template.html">Generate an CloudFormation template from EventBridge Pipes</a> in the <em>Amazon EventBridge User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html

CloudformationResource: AWS::Pipes::Pipe

ExampleMetadata: fixture=_generated

Implements

IInspectable
ITaggable
Back to top Generated by DocFX