EventTargetState class

Input properties used for looking up and filtering EventTarget resources.

Constructors

EventTargetState({Input<EventTargetAppsyncTarget?>? appsyncTarget, Input<String?>? arn, Input<EventTargetBatchTarget?>? batchTarget, Input<EventTargetDeadLetterConfig?>? deadLetterConfig, Input<EventTargetEcsTarget?>? ecsTarget, Input<String?>? eventBusName, Input<bool?>? forceDestroy, Input<EventTargetHttpTarget?>? httpTarget, Input<String?>? input, Input<String?>? inputPath, Input<EventTargetInputTransformer?>? inputTransformer, Input<EventTargetKinesisTarget?>? kinesisTarget, Input<EventTargetRedshiftTarget?>? redshiftTarget, Input<String?>? region, Input<EventTargetRetryPolicy?>? retryPolicy, Input<String?>? roleArn, Input<String?>? rule, Input<List<EventTargetRunCommandTarget>?>? runCommandTargets, Input<EventTargetSagemakerPipelineTarget?>? sagemakerPipelineTarget, Input<EventTargetSqsTarget?>? sqsTarget, Input<String?>? targetId})
Creates a new EventTargetState. appsyncTarget Parameters used when you are using the rule to invoke an AppSync GraphQL API mutation. Documented below. A maximum of 1 are allowed. arn ARN of the target. batchTarget Parameters used when you are using the rule to invoke an Amazon Batch Job. Documented below. A maximum of 1 are allowed. deadLetterConfig Parameters used when you are providing a dead letter config. Documented below. A maximum of 1 are allowed. ecsTarget Parameters used when you are using the rule to invoke Amazon ECS Task. Documented below. A maximum of 1 are allowed. eventBusName The name or ARN of the event bus to associate with the rule. forceDestroy Used to delete managed rules created by AWS. Defaults to false. httpTarget Parameters used when you are using the rule to invoke an API Gateway REST endpoint. Documented below. A maximum of 1 is allowed. input Valid JSON text passed to the target. Conflicts with inputPath and inputTransformer. inputPath The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. Conflicts with input and inputTransformer. inputTransformer Parameters used when you are providing a custom input to a target based on certain event data. Conflicts with input and inputPath. kinesisTarget Parameters used when you are using the rule to invoke an Amazon Kinesis Stream. Documented below. A maximum of 1 are allowed. redshiftTarget Parameters used when you are using the rule to invoke an Amazon Redshift Statement. Documented below. A maximum of 1 are allowed. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. retryPolicy Parameters used when you are providing retry policies. Documented below. A maximum of 1 are allowed. roleArn ARN of the IAM role to be used for this target when the rule is triggered. Required if ecsTarget is used or target in arn is EC2 instance, Kinesis data stream, Step Functions state machine, or Event Bus in different account or region. rule The name of the rule you want to add targets to. runCommandTargets Parameters used when you are using the rule to invoke Amazon EC2 Run Command. Documented below. A maximum of 5 are allowed. sagemakerPipelineTarget Parameters used when you are using the rule to invoke an Amazon SageMaker AI Pipeline. Documented below. A maximum of 1 are allowed. sqsTarget Parameters used when you are using the rule to invoke an Amazon SQS Queue. Documented below. A maximum of 1 are allowed. targetId The unique target assignment ID. If missing, will generate a random, unique id.
const
EventTargetState.fromMap(Map<String, dynamic> map)
factory

Properties

appsyncTarget → Input<EventTargetAppsyncTarget?>?
Parameters used when you are using the rule to invoke an AppSync GraphQL API mutation. Documented below. A maximum of 1 are allowed.
final
arn → Input<String?>?
ARN of the target.
final
batchTarget → Input<EventTargetBatchTarget?>?
Parameters used when you are using the rule to invoke an Amazon Batch Job. Documented below. A maximum of 1 are allowed.
final
deadLetterConfig → Input<EventTargetDeadLetterConfig?>?
Parameters used when you are providing a dead letter config. Documented below. A maximum of 1 are allowed.
final
ecsTarget → Input<EventTargetEcsTarget?>?
Parameters used when you are using the rule to invoke Amazon ECS Task. Documented below. A maximum of 1 are allowed.
final
eventBusName → Input<String?>?
The name or ARN of the event bus to associate with the rule. If you omit this, the default event bus is used.
final
forceDestroy → Input<bool?>?
Used to delete managed rules created by AWS. Defaults to false.
final
hashCode → int
The hash code for this object.
no setterinherited
httpTarget → Input<EventTargetHttpTarget?>?
Parameters used when you are using the rule to invoke an API Gateway REST endpoint. Documented below. A maximum of 1 is allowed.
final
input → Input<String?>?
Valid JSON text passed to the target. Conflicts with inputPath and inputTransformer.
final
inputPath → Input<String?>?
The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. Conflicts with input and inputTransformer.
final
inputTransformer → Input<EventTargetInputTransformer?>?
Parameters used when you are providing a custom input to a target based on certain event data. Conflicts with input and inputPath.
final
kinesisTarget → Input<EventTargetKinesisTarget?>?
Parameters used when you are using the rule to invoke an Amazon Kinesis Stream. Documented below. A maximum of 1 are allowed.
final
redshiftTarget → Input<EventTargetRedshiftTarget?>?
Parameters used when you are using the rule to invoke an Amazon Redshift Statement. Documented below. A maximum of 1 are allowed.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
retryPolicy → Input<EventTargetRetryPolicy?>?
Parameters used when you are providing retry policies. Documented below. A maximum of 1 are allowed.
final
roleArn → Input<String?>?
ARN of the IAM role to be used for this target when the rule is triggered. Required if ecsTarget is used or target in arn is EC2 instance, Kinesis data stream, Step Functions state machine, or Event Bus in different account or region.
final
rule → Input<String?>?
The name of the rule you want to add targets to.
final
runCommandTargets → Input<List<EventTargetRunCommandTarget>?>?
Parameters used when you are using the rule to invoke Amazon EC2 Run Command. Documented below. A maximum of 5 are allowed.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sagemakerPipelineTarget → Input<EventTargetSagemakerPipelineTarget?>?
Parameters used when you are using the rule to invoke an Amazon SageMaker AI Pipeline. Documented below. A maximum of 1 are allowed.
final
sqsTarget → Input<EventTargetSqsTarget?>?
Parameters used when you are using the rule to invoke an Amazon SQS Queue. Documented below. A maximum of 1 are allowed.
final
targetId → Input<String?>?
The unique target assignment ID. If missing, will generate a random, unique id.
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