Class CfnSubscription

A CloudFormation AWS::SNS::Subscription

AWS::SNS::Subscription external http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html

Synopsis

Constructors

constructor(scope, id, props)

Create a new AWS::SNS::Subscription.

Properties

cfnProperties
deliveryPolicy	AWS::SNS::Subscription.DeliveryPolicy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-deliverypolicy
endpoint	AWS::SNS::Subscription.Endpoint http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-endpoint
filterPolicy	AWS::SNS::Subscription.FilterPolicy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicy
protocol	AWS::SNS::Subscription.Protocol http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-protocol
rawMessageDelivery	AWS::SNS::Subscription.RawMessageDelivery http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-rawmessagedelivery
redrivePolicy	AWS::SNS::Subscription.RedrivePolicy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-redrivepolicy
region	AWS::SNS::Subscription.Region http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-region
topicArn	AWS::SNS::Subscription.TopicArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#topicarn

Methods

fromCloudFormation(scope, id, resourceAttributes, options)	A factory method that creates a new instance of this class from an object containing the CloudFormation properties of this resource. Used in the @aws-cdk/cloudformation-include module.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
renderProperties(props)

Constructors

constructor(scope, id, props)

Create a new AWS::SNS::Subscription.

Declaration

constructor(scope: cdk.Construct, id: string, props: CfnSubscriptionProps);

Parameters

scope cdk.Construct

scope in which this resource is defined

id string

scoped id of the resource

props CfnSubscriptionProps

resource properties

Properties

cfnProperties

Declaration

protected readonly cfnProperties:

Property Value

{ [key: string]: any; }

deliveryPolicy

AWS::SNS::Subscription.DeliveryPolicy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-deliverypolicy

Declaration

deliveryPolicy: any | cdk.IResolvable | undefined;

Property Value

any | cdk.IResolvable | undefined

endpoint

AWS::SNS::Subscription.Endpoint http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-endpoint

Declaration

endpoint: string | undefined;

Property Value

string | undefined

filterPolicy

AWS::SNS::Subscription.FilterPolicy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicy

Declaration

filterPolicy: any | cdk.IResolvable | undefined;

Property Value

any | cdk.IResolvable | undefined

protocol

AWS::SNS::Subscription.Protocol http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-protocol

Declaration

protocol: string;

Property Value

string

rawMessageDelivery

AWS::SNS::Subscription.RawMessageDelivery http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-rawmessagedelivery

Declaration

rawMessageDelivery: boolean | cdk.IResolvable | undefined;

Property Value

boolean | cdk.IResolvable | undefined

redrivePolicy

AWS::SNS::Subscription.RedrivePolicy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-redrivepolicy

Declaration

redrivePolicy: any | cdk.IResolvable | undefined;

Property Value

any | cdk.IResolvable | undefined

region

AWS::SNS::Subscription.Region http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-region

Declaration

region: string | undefined;

Property Value

string | undefined

topicArn

AWS::SNS::Subscription.TopicArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#topicarn

Declaration

topicArn: string;

Property Value

string

Methods

fromCloudFormation(scope, id, resourceAttributes, options)

A factory method that creates a new instance of this class from an object containing the CloudFormation properties of this resource. Used in the @aws-cdk/cloudformation-include module.

Declaration

static fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cdk.FromCloudFormationOptions): CfnSubscription;

Parameters

scope cdk.Construct

id string

resourceAttributes any

options cdk.FromCloudFormationOptions

Returns

CfnSubscription

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Declaration

inspect(inspector: cdk.TreeInspector): void;

Parameters

inspector cdk.TreeInspector

tree inspector to collect and process attributes

experimental

Returns

void

renderProperties(props)

Declaration

protected renderProperties:

Parameters

props { [key: string]: any; }

Returns

{ [key: string]: any; }