snsTopicSubscription.md

snsTopicSubscription Submodule

Constructs

SnsTopicSubscription

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_topic_subscription aws_sns_topic_subscription}.

Initializers

import { snsTopicSubscription } from '@cdktf/aws-cdk'

new snsTopicSubscription.SnsTopicSubscription(scope: Construct, id: string, config: SnsTopicSubscriptionConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	SnsTopicSubscriptionConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: SnsTopicSubscriptionConfig

---

Methods

Name	Description
toString	Returns a string representation of this construct.
addOverride	No description.
overrideLogicalId	Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId	Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform	No description.
toMetadata	No description.
toTerraform	Adds this resource to the terraform JSON output.
addMoveTarget	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
hasResourceMove	No description.
importFrom	No description.
interpolationForAttribute	No description.
moveFromId	Move the resource corresponding to "id" to this resource.
moveTo	Moves this resource to the target resource given by moveTarget.
moveToId	Moves this resource to the resource corresponding to "id".
resetConfirmationTimeoutInMinutes	No description.
resetDeliveryPolicy	No description.
resetEndpointAutoConfirms	No description.
resetFilterPolicy	No description.
resetId	No description.
resetRawMessageDelivery	No description.
resetRedrivePolicy	No description.
resetSubscriptionRoleArn	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

resetOverrideLogicalId

public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform

public toHclTerraform(): any

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget

public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

public importFrom(id: string, provider?: TerraformProvider): void

id^Required

• Type: string

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

moveFromId

public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

id^Required

• Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

---

moveTo

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTarget^Required

• Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

---

index^Optional

• Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

---

moveToId

public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

id^Required

• Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

---

resetConfirmationTimeoutInMinutes

public resetConfirmationTimeoutInMinutes(): void

resetDeliveryPolicy

public resetDeliveryPolicy(): void

resetEndpointAutoConfirms

public resetEndpointAutoConfirms(): void

resetFilterPolicy

public resetFilterPolicy(): void

resetId

public resetId(): void

resetRawMessageDelivery

public resetRawMessageDelivery(): void

resetRedrivePolicy

public resetRedrivePolicy(): void

resetSubscriptionRoleArn

public resetSubscriptionRoleArn(): void

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isTerraformResource	No description.
generateConfigForImport	Generates CDKTF code for importing a SnsTopicSubscription resource upon running "cdktf plan ".

---

isConstruct

import { snsTopicSubscription } from '@cdktf/aws-cdk'

snsTopicSubscription.SnsTopicSubscription.isConstruct(x: any)

Checks if x is a construct.

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.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { snsTopicSubscription } from '@cdktf/aws-cdk'

snsTopicSubscription.SnsTopicSubscription.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { snsTopicSubscription } from '@cdktf/aws-cdk'

snsTopicSubscription.SnsTopicSubscription.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { snsTopicSubscription } from '@cdktf/aws-cdk'

snsTopicSubscription.SnsTopicSubscription.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a SnsTopicSubscription resource upon running "cdktf plan ".

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

The construct id used in the generated config for the SnsTopicSubscription to import.

---

importFromId^Required

• Type: string

The id of the existing SnsTopicSubscription that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_topic_subscription#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: cdktf.TerraformProvider

? Optional instance of the provider where the SnsTopicSubscription to import is found.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	cdktf.TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.
terraformMetaArguments	{[ key: string ]: any}	No description.
terraformResourceType	string	No description.
terraformGeneratorMetadata	cdktf.TerraformProviderGeneratorMetadata	No description.
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	string[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
arn	string	No description.
confirmationWasAuthenticated	cdktf.IResolvable	No description.
ownerId	string	No description.
pendingConfirmation	cdktf.IResolvable	No description.
confirmationTimeoutInMinutesInput	number	No description.
deliveryPolicyInput	string	No description.
endpointAutoConfirmsInput	boolean | cdktf.IResolvable	No description.
endpointInput	string	No description.
filterPolicyInput	string	No description.
idInput	string	No description.
protocolInput	string	No description.
rawMessageDeliveryInput	boolean | cdktf.IResolvable	No description.
redrivePolicyInput	string	No description.
subscriptionRoleArnInput	string	No description.
topicArnInput	string	No description.
confirmationTimeoutInMinutes	number	No description.
deliveryPolicy	string	No description.
endpoint	string	No description.
endpointAutoConfirms	boolean | cdktf.IResolvable	No description.
filterPolicy	string	No description.
id	string	No description.
protocol	string	No description.
rawMessageDelivery	boolean | cdktf.IResolvable	No description.
redrivePolicy	string	No description.
subscriptionRoleArn	string	No description.
topicArn	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

arn^Required

public readonly arn: string;

• Type: string

---

confirmationWasAuthenticated^Required

public readonly confirmationWasAuthenticated: IResolvable;

• Type: cdktf.IResolvable

---

ownerId^Required

public readonly ownerId: string;

• Type: string

---

pendingConfirmation^Required

public readonly pendingConfirmation: IResolvable;

• Type: cdktf.IResolvable

---

confirmationTimeoutInMinutesInput^Optional

public readonly confirmationTimeoutInMinutesInput: number;

• Type: number

---

deliveryPolicyInput^Optional

public readonly deliveryPolicyInput: string;

• Type: string

---

endpointAutoConfirmsInput^Optional

public readonly endpointAutoConfirmsInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

endpointInput^Optional

public readonly endpointInput: string;

• Type: string

---

filterPolicyInput^Optional

public readonly filterPolicyInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

protocolInput^Optional

public readonly protocolInput: string;

• Type: string

---

rawMessageDeliveryInput^Optional

public readonly rawMessageDeliveryInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

redrivePolicyInput^Optional

public readonly redrivePolicyInput: string;

• Type: string

---

subscriptionRoleArnInput^Optional

public readonly subscriptionRoleArnInput: string;

• Type: string

---

topicArnInput^Optional

public readonly topicArnInput: string;

• Type: string

---

confirmationTimeoutInMinutes^Required

public readonly confirmationTimeoutInMinutes: number;

• Type: number

---

deliveryPolicy^Required

public readonly deliveryPolicy: string;

• Type: string

---

endpoint^Required

public readonly endpoint: string;

• Type: string

---

endpointAutoConfirms^Required

public readonly endpointAutoConfirms: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

filterPolicy^Required

public readonly filterPolicy: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

protocol^Required

public readonly protocol: string;

• Type: string

---

rawMessageDelivery^Required

public readonly rawMessageDelivery: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

redrivePolicy^Required

public readonly redrivePolicy: string;

• Type: string

---

subscriptionRoleArn^Required

public readonly subscriptionRoleArn: string;

• Type: string

---

topicArn^Required

public readonly topicArn: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

SnsTopicSubscriptionConfig

Initializer

import { snsTopicSubscription } from '@cdktf/aws-cdk'

const snsTopicSubscriptionConfig: snsTopicSubscription.SnsTopicSubscriptionConfig = { ... }

Properties

Name	Type	Description
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	cdktf.ITerraformDependable[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
endpoint	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_topic_subscription#endpoint SnsTopicSubscription#endpoint}.
protocol	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_topic_subscription#protocol SnsTopicSubscription#protocol}.
topicArn	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_topic_subscription#topic_arn SnsTopicSubscription#topic_arn}.
confirmationTimeoutInMinutes	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_topic_subscription#confirmation_timeout_in_minutes SnsTopicSubscription#confirmation_timeout_in_minutes}.
deliveryPolicy	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_topic_subscription#delivery_policy SnsTopicSubscription#delivery_policy}.
endpointAutoConfirms	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_topic_subscription#endpoint_auto_confirms SnsTopicSubscription#endpoint_auto_confirms}.
filterPolicy	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_topic_subscription#filter_policy SnsTopicSubscription#filter_policy}.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_topic_subscription#id SnsTopicSubscription#id}.
rawMessageDelivery	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_topic_subscription#raw_message_delivery SnsTopicSubscription#raw_message_delivery}.
redrivePolicy	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_topic_subscription#redrive_policy SnsTopicSubscription#redrive_policy}.
subscriptionRoleArn	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_topic_subscription#subscription_role_arn SnsTopicSubscription#subscription_role_arn}.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

endpoint^Required

public readonly endpoint: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_topic_subscription#endpoint SnsTopicSubscription#endpoint}.

---

protocol^Required

public readonly protocol: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_topic_subscription#protocol SnsTopicSubscription#protocol}.

---

topicArn^Required

public readonly topicArn: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_topic_subscription#topic_arn SnsTopicSubscription#topic_arn}.

---

confirmationTimeoutInMinutes^Optional

public readonly confirmationTimeoutInMinutes: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_topic_subscription#confirmation_timeout_in_minutes SnsTopicSubscription#confirmation_timeout_in_minutes}.

---

deliveryPolicy^Optional

public readonly deliveryPolicy: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_topic_subscription#delivery_policy SnsTopicSubscription#delivery_policy}.

---

endpointAutoConfirms^Optional

public readonly endpointAutoConfirms: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_topic_subscription#endpoint_auto_confirms SnsTopicSubscription#endpoint_auto_confirms}.

---

filterPolicy^Optional

public readonly filterPolicy: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_topic_subscription#filter_policy SnsTopicSubscription#filter_policy}.

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_topic_subscription#id SnsTopicSubscription#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

---

rawMessageDelivery^Optional

public readonly rawMessageDelivery: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_topic_subscription#raw_message_delivery SnsTopicSubscription#raw_message_delivery}.

---

redrivePolicy^Optional

public readonly redrivePolicy: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_topic_subscription#redrive_policy SnsTopicSubscription#redrive_policy}.

---

subscriptionRoleArn^Optional

public readonly subscriptionRoleArn: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_topic_subscription#subscription_role_arn SnsTopicSubscription#subscription_role_arn}.

---