Class CfnRule.TargetProperty.Jsii$Proxy
- All Implemented Interfaces:
CfnRule.TargetProperty,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnRule.TargetProperty
CfnRule.TargetProperty-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.services.events.CfnRule.TargetProperty
CfnRule.TargetProperty.Builder, CfnRule.TargetProperty.Jsii$Proxy -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedJsii$Proxy(CfnRule.TargetProperty.Builder builder) Constructor that initializes the object based on literal property values passed by theCfnRule.TargetProperty.Builder.protectedJsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNodefinal booleanfinal ObjectContains the GraphQL operation to be parsed and executed, if the event target is an AWS AppSync API.final StringgetArn()The Amazon Resource Name (ARN) of the target.final ObjectIf the event target is an AWS Batch job, this contains the job definition, job name, and other parameters.final ObjectTheDeadLetterConfigthat defines the target queue to send dead-letter queue events to.final ObjectContains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task.final ObjectContains the HTTP parameters to use when the target is a API Gateway endpoint or EventBridge ApiDestination.final StringgetId()The ID of the target within the specified rule.final StringgetInput()Valid JSON text passed to the target.final StringThe value of the JSONPath that is used for extracting part of the matched event when passing it to the target.final ObjectSettings to enable you to provide custom input to a target based on certain event data.final ObjectThe custom parameter you can use to control the shard assignment, when the target is a Kinesis data stream.final ObjectContains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster.final ObjectThe retry policy configuration to use for the dead-letter queue.final StringThe Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered.final ObjectParameters used when you are using the rule to invoke Amazon EC2 Run Command.final ObjectContains the SageMaker AI Model Building Pipeline parameters to start execution of a SageMaker AI Model Building Pipeline.final ObjectContains the message group ID to use when the target is a FIFO queue.final inthashCode()Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theCfnRule.TargetProperty.Builder.
-
-
Method Details
-
getArn
Description copied from interface:CfnRule.TargetPropertyThe Amazon Resource Name (ARN) of the target.- Specified by:
getArnin interfaceCfnRule.TargetProperty- See Also:
-
getId
Description copied from interface:CfnRule.TargetPropertyThe ID of the target within the specified rule.Use this ID to reference the target when updating the rule. We recommend using a memorable and unique string.
- Specified by:
getIdin interfaceCfnRule.TargetProperty- See Also:
-
getAppSyncParameters
Description copied from interface:CfnRule.TargetPropertyContains the GraphQL operation to be parsed and executed, if the event target is an AWS AppSync API.- Specified by:
getAppSyncParametersin interfaceCfnRule.TargetProperty- See Also:
-
getBatchParameters
Description copied from interface:CfnRule.TargetPropertyIf the event target is an AWS Batch job, this contains the job definition, job name, and other parameters.For more information, see Jobs in the AWS Batch User Guide .
- Specified by:
getBatchParametersin interfaceCfnRule.TargetProperty- See Also:
-
getDeadLetterConfig
Description copied from interface:CfnRule.TargetPropertyTheDeadLetterConfigthat defines the target queue to send dead-letter queue events to.- Specified by:
getDeadLetterConfigin interfaceCfnRule.TargetProperty- See Also:
-
getEcsParameters
Description copied from interface:CfnRule.TargetPropertyContains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task.For more information about Amazon ECS tasks, see Task Definitions in the Amazon EC2 Container Service Developer Guide .
- Specified by:
getEcsParametersin interfaceCfnRule.TargetProperty- See Also:
-
getHttpParameters
Description copied from interface:CfnRule.TargetPropertyContains the HTTP parameters to use when the target is a API Gateway endpoint or EventBridge ApiDestination.If you specify an API Gateway API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.
- Specified by:
getHttpParametersin interfaceCfnRule.TargetProperty- See Also:
-
getInput
Description copied from interface:CfnRule.TargetPropertyValid JSON text passed to the target.In this case, nothing from the event itself is passed to the target. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format .
- Specified by:
getInputin interfaceCfnRule.TargetProperty- See Also:
-
getInputPath
Description copied from interface:CfnRule.TargetPropertyThe value of the JSONPath that is used for extracting part of the matched event when passing it to the target.You may use JSON dot notation or bracket notation. For more information about JSON paths, see JSONPath .
- Specified by:
getInputPathin interfaceCfnRule.TargetProperty- See Also:
-
getInputTransformer
Description copied from interface:CfnRule.TargetPropertySettings to enable you to provide custom input to a target based on certain event data.You can extract one or more key-value pairs from the event and then use that data to send customized input to the target.
- Specified by:
getInputTransformerin interfaceCfnRule.TargetProperty- See Also:
-
getKinesisParameters
Description copied from interface:CfnRule.TargetPropertyThe custom parameter you can use to control the shard assignment, when the target is a Kinesis data stream.If you do not include this parameter, the default is to use the
eventIdas the partition key.- Specified by:
getKinesisParametersin interfaceCfnRule.TargetProperty- See Also:
-
getRedshiftDataParameters
Description copied from interface:CfnRule.TargetPropertyContains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster.If you specify a Amazon Redshift Cluster as a Target, you can use this to specify parameters to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.
- Specified by:
getRedshiftDataParametersin interfaceCfnRule.TargetProperty- See Also:
-
getRetryPolicy
Description copied from interface:CfnRule.TargetPropertyThe retry policy configuration to use for the dead-letter queue.- Specified by:
getRetryPolicyin interfaceCfnRule.TargetProperty- See Also:
-
getRoleArn
Description copied from interface:CfnRule.TargetPropertyThe Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered.If one rule triggers multiple targets, you can use a different IAM role for each target.
- Specified by:
getRoleArnin interfaceCfnRule.TargetProperty- See Also:
-
getRunCommandParameters
Description copied from interface:CfnRule.TargetPropertyParameters used when you are using the rule to invoke Amazon EC2 Run Command.- Specified by:
getRunCommandParametersin interfaceCfnRule.TargetProperty- See Also:
-
getSageMakerPipelineParameters
Description copied from interface:CfnRule.TargetPropertyContains the SageMaker AI Model Building Pipeline parameters to start execution of a SageMaker AI Model Building Pipeline.If you specify a SageMaker AI Model Building Pipeline as a target, you can use this to specify parameters to start a pipeline execution based on EventBridge events.
- Specified by:
getSageMakerPipelineParametersin interfaceCfnRule.TargetProperty- See Also:
-
getSqsParameters
Description copied from interface:CfnRule.TargetPropertyContains the message group ID to use when the target is a FIFO queue.If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled.
- Specified by:
getSqsParametersin interfaceCfnRule.TargetProperty- See Also:
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-