Class CfnSubscriptionProps.Jsii$Proxy
- All Implemented Interfaces:
CfnSubscriptionProps,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
- CfnSubscriptionProps
CfnSubscriptionProps-
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.sns.CfnSubscriptionProps
CfnSubscriptionProps.Builder, CfnSubscriptionProps.Jsii$Proxy -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedJsii$Proxy(CfnSubscriptionProps.Builder builder) Constructor that initializes the object based on literal property values passed by theCfnSubscriptionProps.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 ObjectThe delivery policy JSON assigned to the subscription.final StringThe subscription's endpoint.final ObjectThe filter policy JSON assigned to the subscription.final StringThis attribute lets you choose the filtering scope by using one of the following string value types:.final StringThe subscription's protocol.final ObjectWhen set totrue, enables raw message delivery.final ObjectWhen specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue.final StringFor cross-region subscriptions, the region in which the topic resides.final StringThis property applies only to Amazon Kinesis Data Firehose delivery stream subscriptions.final StringThe ARN of the topic to subscribe to.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 theCfnSubscriptionProps.Builder.
-
-
Method Details
-
getProtocol
Description copied from interface:CfnSubscriptionPropsThe subscription's protocol.For more information, see the
Protocolparameter of the[Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html)action in the Amazon SNS API Reference .- Specified by:
getProtocolin interfaceCfnSubscriptionProps
-
getTopicArn
Description copied from interface:CfnSubscriptionPropsThe ARN of the topic to subscribe to.- Specified by:
getTopicArnin interfaceCfnSubscriptionProps
-
getDeliveryPolicy
Description copied from interface:CfnSubscriptionPropsThe delivery policy JSON assigned to the subscription.Enables the subscriber to define the message delivery retry strategy in the case of an HTTP/S endpoint subscribed to the topic. For more information, see
[GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html)in the Amazon SNS API Reference and Message delivery retries in the Amazon SNS Developer Guide .- Specified by:
getDeliveryPolicyin interfaceCfnSubscriptionProps
-
getEndpoint
Description copied from interface:CfnSubscriptionPropsThe subscription's endpoint.The endpoint value depends on the protocol that you specify. For more information, see the
Endpointparameter of the[Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html)action in the Amazon SNS API Reference .- Specified by:
getEndpointin interfaceCfnSubscriptionProps
-
getFilterPolicy
Description copied from interface:CfnSubscriptionPropsThe filter policy JSON assigned to the subscription.Enables the subscriber to filter out unwanted messages. For more information, see
[GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html)in the Amazon SNS API Reference and Message filtering in the Amazon SNS Developer Guide .- Specified by:
getFilterPolicyin interfaceCfnSubscriptionProps
-
getFilterPolicyScope
Description copied from interface:CfnSubscriptionPropsThis attribute lets you choose the filtering scope by using one of the following string value types:.MessageAttributes(default) - The filter is applied on the message attributes.MessageBody- The filter is applied on the message body.
- Specified by:
getFilterPolicyScopein interfaceCfnSubscriptionProps
-
getRawMessageDelivery
Description copied from interface:CfnSubscriptionPropsWhen set totrue, enables raw message delivery.Raw messages don't contain any JSON formatting and can be sent to Amazon SQS and HTTP/S endpoints. For more information, see
[GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html)in the Amazon SNS API Reference .- Specified by:
getRawMessageDeliveryin interfaceCfnSubscriptionProps
-
getRedrivePolicy
Description copied from interface:CfnSubscriptionPropsWhen specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue.Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
For more information about the redrive policy and dead-letter queues, see Amazon SQS dead-letter queues in the Amazon SQS Developer Guide .
- Specified by:
getRedrivePolicyin interfaceCfnSubscriptionProps
-
getRegion
Description copied from interface:CfnSubscriptionPropsFor cross-region subscriptions, the region in which the topic resides.If no region is specified, AWS CloudFormation uses the region of the caller as the default.
If you perform an update operation that only updates the
Regionproperty of aAWS::SNS::Subscriptionresource, that operation will fail unless you are either:- Updating the
RegionfromNULLto the caller region. - Updating the
Regionfrom the caller region toNULL.
- Specified by:
getRegionin interfaceCfnSubscriptionProps
- Updating the
-
getSubscriptionRoleArn
Description copied from interface:CfnSubscriptionPropsThis property applies only to Amazon Kinesis Data Firehose delivery stream subscriptions.Specify the ARN of the IAM role that has the following:
- Permission to write to the Amazon Kinesis Data Firehose delivery stream
- Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Amazon Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.
- Specified by:
getSubscriptionRoleArnin interfaceCfnSubscriptionProps
-
$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()
-