PipeArgs

data class PipeArgs(val description: Output<String>? = null, val desiredState: Output<PipeRequestedPipeState>? = null, val enrichment: Output<String>? = null, val enrichmentParameters: Output<PipeEnrichmentParametersArgs>? = null, val kmsKeyIdentifier: Output<String>? = null, val logConfiguration: Output<PipeLogConfigurationArgs>? = null, val name: Output<String>? = null, val roleArn: Output<String>? = null, val source: Output<String>? = null, val sourceParameters: Output<PipeSourceParametersArgs>? = null, val tags: Output<Map<String, String>>? = null, val target: Output<String>? = null, val targetParameters: Output<PipeTargetParametersArgs>? = null) : ConvertibleToJava<PipeArgs>

Definition of AWS::Pipes::Pipe Resource Type

Example Usage

Example

No Java example available.

Example

No Java example available.

Constructors

Link copied to clipboard
constructor(description: Output<String>? = null, desiredState: Output<PipeRequestedPipeState>? = null, enrichment: Output<String>? = null, enrichmentParameters: Output<PipeEnrichmentParametersArgs>? = null, kmsKeyIdentifier: Output<String>? = null, logConfiguration: Output<PipeLogConfigurationArgs>? = null, name: Output<String>? = null, roleArn: Output<String>? = null, source: Output<String>? = null, sourceParameters: Output<PipeSourceParametersArgs>? = null, tags: Output<Map<String, String>>? = null, target: Output<String>? = null, targetParameters: Output<PipeTargetParametersArgs>? = null)

Properties

Link copied to clipboard
val description: Output<String>? = null

A description of the pipe.

Link copied to clipboard

The state the pipe should be in.

Link copied to clipboard
val enrichment: Output<String>? = null

The ARN of the enrichment resource.

Link copied to clipboard

The parameters required to set up enrichment on your pipe.

Link copied to clipboard
val kmsKeyIdentifier: Output<String>? = null

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. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN. To update a pipe that is using the default AWS owned key to use a customer managed key instead, or update a pipe that is using a customer managed key to use a different customer managed key, specify a customer managed key identifier. To update a pipe that is using a customer managed key to use the default AWS owned key , specify an empty string. For more information, see Managing keys in the AWS Key Management Service Developer Guide .

Link copied to clipboard

The logging configuration settings for the pipe.

Link copied to clipboard
val name: Output<String>? = null

The name of the pipe.

Link copied to clipboard
val roleArn: Output<String>? = null

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

Link copied to clipboard
val source: Output<String>? = null

The ARN of the source resource.

Link copied to clipboard

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

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

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

Link copied to clipboard
val target: Output<String>? = null

The ARN of the target resource.

Link copied to clipboard

The parameters required to set up a target for your pipe. For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide .

Functions

Link copied to clipboard
open override fun toJava(): PipeArgs