software.amazon.awscdk.services.events.targets

Class SqsQueue

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.events.targets.SqsQueue

All Implemented Interfaces:

IRuleTarget, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:31.257Z")
 @Stability(value=Experimental)
public class SqsQueue
extends software.amazon.jsii.JsiiObject
implements IRuleTarget

(experimental) Use an SQS Queue as a target for Amazon EventBridge rules.

Example:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 // publish to an SQS queue every time code is committed
 // to a CodeCommit repository
 repository.onCommit(new SqsQueue(queue));

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SqsQueue.Builder (experimental) A fluent builder for SqsQueue.

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.IRuleTarget

IRuleTarget.Jsii$Default, IRuleTarget.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	SqsQueue(IQueue queue)
	SqsQueue(IQueue queue, SqsQueueProps props)
protected	SqsQueue(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	SqsQueue(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
RuleTargetConfig	bind(IRule rule) (experimental) Returns a RuleTarget that can be used to trigger this SQS queue as a result from an EventBridge event.
RuleTargetConfig	bind(IRule rule, String _id) (experimental) Returns a RuleTarget that can be used to trigger this SQS queue as a result from an EventBridge event.
IQueue	getQueue()

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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

SqsQueue

protected SqsQueue(software.amazon.jsii.JsiiObjectRef objRef)

SqsQueue

protected SqsQueue(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

SqsQueue

@Stability(value=Experimental)
public SqsQueue(@NotNull
                                               IQueue queue,
                                               @Nullable
                                               SqsQueueProps props)

Parameters:

queue - This parameter is required.

props -

SqsQueue

@Stability(value=Experimental)
public SqsQueue(@NotNull
                                               IQueue queue)

Parameters:

queue - This parameter is required.

Method Detail

bind

@Stability(value=Experimental)
 @NotNull
public RuleTargetConfig bind(@NotNull
                                                                      IRule rule,
                                                                      @Nullable
                                                                      String _id)

(experimental) Returns a RuleTarget that can be used to trigger this SQS queue as a result from an EventBridge event.

Specified by:

bind in interface IRuleTarget

Parameters:

rule - This parameter is required.

_id -

See Also:

https://docs.aws.amazon.com/eventbridge/latest/userguide/resource-based-policies-eventbridge.html#sqs-permissions

bind

@Stability(value=Experimental)
 @NotNull
public RuleTargetConfig bind(@NotNull
                                                                      IRule rule)

(experimental) Returns a RuleTarget that can be used to trigger this SQS queue as a result from an EventBridge event.

Specified by:

bind in interface IRuleTarget

Parameters:

rule - This parameter is required.

See Also:

https://docs.aws.amazon.com/eventbridge/latest/userguide/resource-based-policies-eventbridge.html#sqs-permissions

getQueue

@Stability(value=Experimental)
 @NotNull
public IQueue getQueue()