PipeState constructor
- Input<
String?> ? arn, - Input<
String?> ? description, - Input<
String?> ? desiredState, - Input<
String?> ? enrichment, - Input<
PipeEnrichmentParameters?> ? enrichmentParameters, - Input<
String?> ? kmsKeyIdentifier, - Input<
PipeLogConfiguration?> ? logConfiguration, - Input<
String?> ? name, - Input<
String?> ? namePrefix, - Input<
String?> ? region, - Input<
String?> ? roleArn, - Input<
String?> ? source, - Input<
PipeSourceParameters?> ? sourceParameters, - Input<
Map< ? tags,String, String> ?> - Input<
Map< ? tagsAll,String, String> ?> - Input<
String?> ? target, - Input<
PipeTargetParameters?> ? targetParameters,
Creates a new PipeState.
arn ARN of this pipe.
description A description of the pipe. At most 512 characters.
desiredState The state the pipe should be in. One of: RUNNING, STOPPED.
enrichment Enrichment resource of the pipe (typically an ARN). Read more about enrichment in the User Guide.
enrichmentParameters Parameters to configure enrichment for your pipe. Detailed below.
kmsKeyIdentifier 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 ARN, KeyId, key alias, or key alias ARN. If not set, EventBridge uses an AWS owned key to encrypt pipe data.
logConfiguration Logging configuration settings for the pipe. Detailed below.
name Name of the pipe. If omitted, the provider will assign a random, unique name. Conflicts with namePrefix.
namePrefix Creates a unique name beginning with the specified prefix. Conflicts with name.
region Region where this resource will be managed. Defaults to the Region set in the provider configuration.
roleArn ARN of the role that allows the pipe to send data to the target.
source Source resource of the pipe. This field typically requires an ARN. However, when using a self-managed Kafka cluster, you should use a different format. Instead of an ARN, use 'smk://' followed by the bootstrap server's address.
sourceParameters Parameters to configure a source for the pipe. Detailed below.
tags Key-value mapping of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
target Target resource of the pipe (typically an ARN).
targetParameters Parameters to configure a target for your pipe. Detailed below.
Implementation
const PipeState({
this.arn,
this.description,
this.desiredState,
this.enrichment,
this.enrichmentParameters,
this.kmsKeyIdentifier,
this.logConfiguration,
this.name,
this.namePrefix,
this.region,
this.roleArn,
this.source,
this.sourceParameters,
this.tags,
this.tagsAll,
this.target,
this.targetParameters,
});