software.amazon.awscdk.services.events

Class CfnRule.TargetProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.events.CfnRule.TargetProperty.Jsii$Proxy

All Implemented Interfaces:

CfnRule.TargetProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnRule.TargetProperty

@Stability(value=Stable)
 @Internal
public static final class CfnRule.TargetProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnRule.TargetProperty

An implementation for CfnRule.TargetProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.events.CfnRule.TargetProperty

CfnRule.TargetProperty.Builder, CfnRule.TargetProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(CfnRule.TargetProperty.Builder builder) Constructor that initializes the object based on literal property values passed by the CfnRule.AwsVpcConfigurationProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
String	getArn() The Amazon Resource Name (ARN) of the target.
Object	getBatchParameters() If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters.
Object	getDeadLetterConfig() The `DeadLetterConfig` that defines the target queue to send dead-letter queue events to.
Object	getEcsParameters() Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task.
Object	getHttpParameters() Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.
String	getId() The ID of the target within the specified rule.
String	getInput() Valid JSON text passed to the target.
String	getInputPath() The value of the JSONPath that is used for extracting part of the matched event when passing it to the target.
Object	getInputTransformer() Settings to enable you to provide custom input to a target based on certain event data.
Object	getKinesisParameters() The custom parameter you can use to control the shard assignment, when the target is a Kinesis data stream.
Object	getRedshiftDataParameters() Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster.
Object	getRetryPolicy() The `RetryPolicy` object that contains the retry policy configuration to use for the dead-letter queue.
String	getRoleArn() The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered.
Object	getRunCommandParameters() Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
Object	getSageMakerPipelineParameters() Contains the SageMaker Model Building Pipeline parameters to start execution of a SageMaker Model Building Pipeline.
Object	getSqsParameters() Contains the message group ID to use when the target is a FIFO queue.
int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.services.events.CfnRule.TargetProperty

builder

Constructor Detail

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

protected Jsii$Proxy(CfnRule.TargetProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnRule.AwsVpcConfigurationProperty.Builder.

Method Detail

getArn

public final String getArn()

Description copied from interface: CfnRule.TargetProperty

The Amazon Resource Name (ARN) of the target.

Specified by:

getArn in interface CfnRule.TargetProperty

getId

public final String getId()

Description copied from interface: CfnRule.TargetProperty

The 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:

getId in interface CfnRule.TargetProperty

getBatchParameters

public final Object getBatchParameters()

Description copied from interface: CfnRule.TargetProperty

If 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:

getBatchParameters in interface CfnRule.TargetProperty

getDeadLetterConfig

public final Object getDeadLetterConfig()

Description copied from interface: CfnRule.TargetProperty

The `DeadLetterConfig` that defines the target queue to send dead-letter queue events to.

Specified by:

getDeadLetterConfig in interface CfnRule.TargetProperty

getEcsParameters

public final Object getEcsParameters()

Description copied from interface: CfnRule.TargetProperty

Contains 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:

getEcsParameters in interface CfnRule.TargetProperty

getHttpParameters

public final Object getHttpParameters()

Description copied from interface: CfnRule.TargetProperty

Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.

If you specify an API Gateway REST 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:

getHttpParameters in interface CfnRule.TargetProperty

getInput

public final String getInput()

Description copied from interface: CfnRule.TargetProperty

Valid 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:

getInput in interface CfnRule.TargetProperty

getInputPath

public final String getInputPath()

Description copied from interface: CfnRule.TargetProperty

The value of the JSONPath that is used for extracting part of the matched event when passing it to the target.

You must use JSON dot notation, not bracket notation. For more information about JSON paths, see JSONPath .

Specified by:

getInputPath in interface CfnRule.TargetProperty

getInputTransformer

public final Object getInputTransformer()

Description copied from interface: CfnRule.TargetProperty

Settings 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:

getInputTransformer in interface CfnRule.TargetProperty

getKinesisParameters

public final Object getKinesisParameters()

Description copied from interface: CfnRule.TargetProperty

The 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 eventId as the partition key.

Specified by:

getKinesisParameters in interface CfnRule.TargetProperty

getRedshiftDataParameters

public final Object getRedshiftDataParameters()

Description copied from interface: CfnRule.TargetProperty

Contains 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:

getRedshiftDataParameters in interface CfnRule.TargetProperty

getRetryPolicy

public final Object getRetryPolicy()

Description copied from interface: CfnRule.TargetProperty

The `RetryPolicy` object that contains the retry policy configuration to use for the dead-letter queue.

Specified by:

getRetryPolicy in interface CfnRule.TargetProperty

getRoleArn

public final String getRoleArn()

Description copied from interface: CfnRule.TargetProperty

The 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:

getRoleArn in interface CfnRule.TargetProperty

getRunCommandParameters

public final Object getRunCommandParameters()

Description copied from interface: CfnRule.TargetProperty

Parameters used when you are using the rule to invoke Amazon EC2 Run Command.

Specified by:

getRunCommandParameters in interface CfnRule.TargetProperty

getSageMakerPipelineParameters

public final Object getSageMakerPipelineParameters()

Description copied from interface: CfnRule.TargetProperty

Contains the SageMaker Model Building Pipeline parameters to start execution of a SageMaker Model Building Pipeline.

If you specify a SageMaker Model Building Pipeline as a target, you can use this to specify parameters to start a pipeline execution based on EventBridge events.

Specified by:

getSageMakerPipelineParameters in interface CfnRule.TargetProperty

getSqsParameters

public final Object getSqsParameters()

Description copied from interface: CfnRule.TargetProperty

Contains 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:

getSqsParameters in interface CfnRule.TargetProperty

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object