Subscription L2 construct
A new subscription.
Prefer to use the ITopic.addSubscription() methods to create instances of this class.
Example
// producerStack defines an SNS topic
declare const topic: sns.Topic;
// consumerStack subscribes to it with a weak reference,
// so the producer can be torn down without blocking on this consumer
const consumerStack = new Stack(app, 'Consumer', {
env: { account: '123456789012', region: 'us-east-1' },
});
new sns.Subscription(consumerStack, 'Subscription', {
topic: sns.Topic.fromTopicArn(consumerStack, 'Topic', Stack.consumeReference(topic.topicArn)),
endpoint: 'https://example.com/webhook',
protocol: sns.SubscriptionProtocol.HTTPS,
});
from aws_cdk import Environment
# producerStack defines an SNS topic
# topic: sns.Topic
# consumerStack subscribes to it with a weak reference,
# so the producer can be torn down without blocking on this consumer
consumer_stack = Stack(app, "Consumer",
env=Environment(account="123456789012", region="us-east-1")
)
sns.Subscription(consumer_stack, "Subscription",
topic=sns.Topic.from_topic_arn(consumer_stack, "Topic", Stack.consume_reference(topic.topic_arn)),
endpoint="https://example.com/webhook",
protocol=sns.SubscriptionProtocol.HTTPS
)
// producerStack defines an SNS topic
Topic topic;
// consumerStack subscribes to it with a weak reference,
// so the producer can be torn down without blocking on this consumer
Stack consumerStack = Stack.Builder.create(app, "Consumer")
.env(Environment.builder().account("123456789012").region("us-east-1").build())
.build();
Subscription.Builder.create(consumerStack, "Subscription")
.topic(Topic.fromTopicArn(consumerStack, "Topic", Stack.consumeReference(topic.getTopicArn())))
.endpoint("https://example.com/webhook")
.protocol(SubscriptionProtocol.HTTPS)
.build();
// Install: dotnet add package Amazon.CDK.Lib
// producerStack defines an SNS topic
Topic topic;
// consumerStack subscribes to it with a weak reference,
// so the producer can be torn down without blocking on this consumer
var consumerStack = new Stack(app, "Consumer", new StackProps {
Env = new Environment { Account = "123456789012", Region = "us-east-1" }
});
new Subscription(consumerStack, "Subscription", new SubscriptionProps {
Topic = Topic.FromTopicArn(consumerStack, "Topic", Stack.ConsumeReference(topic.TopicArn)),
Endpoint = "https://example.com/webhook",
Protocol = SubscriptionProtocol.HTTPS
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// producerStack defines an SNS topic
var topic Topic
// consumerStack subscribes to it with a weak reference,
// so the producer can be torn down without blocking on this consumer
consumerStack := awscdk.Newstack(app, jsii.String("Consumer"), &StackProps{
Env: &Environment{
Account: jsii.String("123456789012"),
Region: jsii.String("us-east-1"),
},
})
sns.NewSubscription(consumerStack, jsii.String("Subscription"), &SubscriptionProps{
Topic: sns.Topic_FromTopicArn(consumerStack, jsii.String("Topic"), awscdk.*stack_ConsumeReference(topic.topicArn)),
Endpoint: jsii.String("https://example.com/webhook"),
Protocol: sns.SubscriptionProtocol_HTTPS,
})
Initializer
new Subscription(scope: Construct, id: string, props: SubscriptionProps)
Subscription(scope: Construct, id: str, props: SubscriptionProps)
new Subscription(Construct scope, String id, SubscriptionProps props)
new Subscription(Construct scope, string id, SubscriptionProps props)
NewSubscription(Scope Construct, Id *string, Props SubscriptionProps)
Construct Props
deadLetterQueueoptionalIQueuedead_letter_queueoptionalIQueuedeadLetterQueueoptionalIQueueDeadLetterQueueoptionalIQueueDeadLetterQueueoptionalIQueue#Default: No dead letter queue enabled.
If not passed no dead letter queue is enabled.
deliveryPolicyoptionalDeliveryPolicydelivery_policyoptionalDeliveryPolicydeliveryPolicyoptionalDeliveryPolicyDeliveryPolicyoptionalDeliveryPolicyDeliveryPolicyoptionalDeliveryPolicy#Default: if the initial delivery of the message fails, three retries with a delay between failed attempts set at 20 seconds
The meaning of this value depends on the value for 'protocol'.
filterPolicyoptional{ [key: string]: SubscriptionFilter }filter_policyoptionaltyping.Mapping[str, SubscriptionFilter]filterPolicyoptionalMap<String, SubscriptionFilter>FilterPolicyoptionalIDictionary<string, SubscriptionFilter>FilterPolicyoptional*map[string]SubscriptionFilter#Default: all messages are delivered
filterPolicyWithMessageBodyoptional{ [key: string]: FilterOrPolicy }filter_policy_with_message_bodyoptionaltyping.Mapping[str, FilterOrPolicy]filterPolicyWithMessageBodyoptionalMap<String, FilterOrPolicy>FilterPolicyWithMessageBodyoptionalIDictionary<string, FilterOrPolicy>FilterPolicyWithMessageBodyoptional*map[string]FilterOrPolicy#Default: all messages are delivered
To apply a filter policy to the message attributes, use filterPolicy. A maximum of one of filterPolicyWithMessageBody and filterPolicy may be used.
protocolSubscriptionProtocolprotocolSubscriptionProtocolprotocolSubscriptionProtocolProtocolSubscriptionProtocolProtocolSubscriptionProtocolrequired#rawMessageDeliveryoptionalbooleanraw_message_deliveryoptionalboolrawMessageDeliveryoptionalBooleanRawMessageDeliveryoptionalboolRawMessageDeliveryoptional*bool= false#Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints. For more information, see GetSubscriptionAttributes in the Amazon Simple Notification Service API Reference.
Default: the region where the CloudFormation stack is being deployed.
subscriptionRoleArnoptionalstringsubscription_role_arnoptionalstrsubscriptionRoleArnoptionalStringSubscriptionRoleArnoptionalstringSubscriptionRoleArnoptional*string#Default: No subscription role is provided
Required for a firehose subscription protocol.
Properties
deadLetterQueuemay be undefinedIQueuedead_letter_queuemay be undefinedIQueuedeadLetterQueuemay be undefinedIQueueDeadLetterQueuemay be undefinedIQueueDeadLetterQueuemay be undefinedIQueue#envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.