PipeState class
Input properties used for looking up and filtering Pipe resources.
Constructors
-
PipeState({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, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>String?> ? target, Input<PipeTargetParameters?> ? targetParameters}) -
Creates a new PipeState.
arnARN of this pipe.descriptionA description of the pipe. At most 512 characters.desiredStateThe state the pipe should be in. One of:RUNNING,STOPPED.enrichmentEnrichment resource of the pipe (typically an ARN). Read more about enrichment in the User Guide.enrichmentParametersParameters to configure enrichment for your pipe. Detailed below.kmsKeyIdentifierIdentifier 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.logConfigurationLogging configuration settings for the pipe. Detailed below.nameName of the pipe. If omitted, the provider will assign a random, unique name. Conflicts withnamePrefix.namePrefixCreates a unique name beginning with the specified prefix. Conflicts withname.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.roleArnARN of the role that allows the pipe to send data to the target.sourceSource 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.sourceParametersParameters to configure a source for the pipe. Detailed below.tagsKey-value mapping of resource tags. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllMap of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.targetTarget resource of the pipe (typically an ARN).targetParametersParameters to configure a target for your pipe. Detailed below.const -
PipeState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
arn
→ Input<
String?> ? -
ARN of this pipe.
final
-
description
→ Input<
String?> ? -
A description of the pipe. At most 512 characters.
final
-
desiredState
→ Input<
String?> ? -
The state the pipe should be in. One of:
RUNNING,STOPPED.final -
enrichment
→ Input<
String?> ? -
Enrichment resource of the pipe (typically an ARN). Read more about enrichment in the User Guide.
final
-
enrichmentParameters
→ Input<
PipeEnrichmentParameters?> ? -
Parameters to configure enrichment for your pipe. Detailed below.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
kmsKeyIdentifier
→ Input<
String?> ? -
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.
final
-
logConfiguration
→ Input<
PipeLogConfiguration?> ? -
Logging configuration settings for the pipe. Detailed below.
final
-
name
→ Input<
String?> ? -
Name of the pipe. If omitted, the provider will assign a random, unique name. Conflicts with
namePrefix.final -
namePrefix
→ Input<
String?> ? -
Creates a unique name beginning with the specified prefix. Conflicts with
name.final -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
-
roleArn
→ Input<
String?> ? -
ARN of the role that allows the pipe to send data to the target.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
source
→ Input<
String?> ? -
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.
final
-
sourceParameters
→ Input<
PipeSourceParameters?> ? -
Parameters to configure a source for the pipe. Detailed below.
final
-
Key-value mapping of resource tags. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
target
→ Input<
String?> ? -
Target resource of the pipe (typically an ARN).
final
-
targetParameters
→ Input<
PipeTargetParameters?> ? -
Parameters to configure a target for your pipe. Detailed below.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited