GetPipeResult

data class GetPipeResult(val arn: String? = null, val creationTime: String? = null, val currentState: PipeState? = null, val description: String? = null, val desiredState: PipeRequestedPipeState? = null, val enrichment: String? = null, val enrichmentParameters: PipeEnrichmentParameters? = null, val kmsKeyIdentifier: String? = null, val lastModifiedTime: String? = null, val logConfiguration: PipeLogConfiguration? = null, val roleArn: String? = null, val stateReason: String? = null, val tags: Map<String, String>? = null, val target: String? = null)

Constructors

Link copied to clipboard
constructor(arn: String? = null, creationTime: String? = null, currentState: PipeState? = null, description: String? = null, desiredState: PipeRequestedPipeState? = null, enrichment: String? = null, enrichmentParameters: PipeEnrichmentParameters? = null, kmsKeyIdentifier: String? = null, lastModifiedTime: String? = null, logConfiguration: PipeLogConfiguration? = null, roleArn: String? = null, stateReason: String? = null, tags: Map<String, String>? = null, target: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val arn: String? = null

The ARN of the pipe.

Link copied to clipboard
val creationTime: String? = null

The time the pipe was created.

Link copied to clipboard
val currentState: PipeState? = null

The state the pipe is in.

Link copied to clipboard
val description: String? = null

A description of the pipe.

Link copied to clipboard

The state the pipe should be in.

Link copied to clipboard
val enrichment: 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

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

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

Link copied to clipboard

The logging configuration settings for the pipe.

Link copied to clipboard
val roleArn: String? = null

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

Link copied to clipboard
val stateReason: String? = null

The reason the pipe is in its current state.

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

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

Link copied to clipboard
val target: String? = null

The ARN of the target resource.