snsPlatformApplication.md

snsPlatformApplication Submodule

Constructs

SnsPlatformApplication

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

Initializers

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

new snsPlatformApplication.SnsPlatformApplication(scope: Construct, id: string, config: SnsPlatformApplicationConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	SnsPlatformApplicationConfig	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: SnsPlatformApplicationConfig

---

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".
resetEventDeliveryFailureTopicArn	No description.
resetEventEndpointCreatedTopicArn	No description.
resetEventEndpointDeletedTopicArn	No description.
resetEventEndpointUpdatedTopicArn	No description.
resetFailureFeedbackRoleArn	No description.
resetId	No description.
resetPlatformPrincipal	No description.
resetSuccessFeedbackRoleArn	No description.
resetSuccessFeedbackSampleRate	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".

---

resetEventDeliveryFailureTopicArn

public resetEventDeliveryFailureTopicArn(): void

resetEventEndpointCreatedTopicArn

public resetEventEndpointCreatedTopicArn(): void

resetEventEndpointDeletedTopicArn

public resetEventEndpointDeletedTopicArn(): void

resetEventEndpointUpdatedTopicArn

public resetEventEndpointUpdatedTopicArn(): void

resetFailureFeedbackRoleArn

public resetFailureFeedbackRoleArn(): void

resetId

public resetId(): void

resetPlatformPrincipal

public resetPlatformPrincipal(): void

resetSuccessFeedbackRoleArn

public resetSuccessFeedbackRoleArn(): void

resetSuccessFeedbackSampleRate

public resetSuccessFeedbackSampleRate(): 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 SnsPlatformApplication resource upon running "cdktf plan ".

---

isConstruct

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

snsPlatformApplication.SnsPlatformApplication.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

isTerraformElement

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

snsPlatformApplication.SnsPlatformApplication.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

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

snsPlatformApplication.SnsPlatformApplication.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

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

snsPlatformApplication.SnsPlatformApplication.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a SnsPlatformApplication 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 SnsPlatformApplication to import.

---

importFromId^Required

• Type: string

The id of the existing SnsPlatformApplication that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_platform_application#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 SnsPlatformApplication 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.
eventDeliveryFailureTopicArnInput	string	No description.
eventEndpointCreatedTopicArnInput	string	No description.
eventEndpointDeletedTopicArnInput	string	No description.
eventEndpointUpdatedTopicArnInput	string	No description.
failureFeedbackRoleArnInput	string	No description.
idInput	string	No description.
nameInput	string	No description.
platformCredentialInput	string	No description.
platformInput	string	No description.
platformPrincipalInput	string	No description.
successFeedbackRoleArnInput	string	No description.
successFeedbackSampleRateInput	string	No description.
eventDeliveryFailureTopicArn	string	No description.
eventEndpointCreatedTopicArn	string	No description.
eventEndpointDeletedTopicArn	string	No description.
eventEndpointUpdatedTopicArn	string	No description.
failureFeedbackRoleArn	string	No description.
id	string	No description.
name	string	No description.
platform	string	No description.
platformCredential	string	No description.
platformPrincipal	string	No description.
successFeedbackRoleArn	string	No description.
successFeedbackSampleRate	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

---

eventDeliveryFailureTopicArnInput^Optional

public readonly eventDeliveryFailureTopicArnInput: string;

• Type: string

---

eventEndpointCreatedTopicArnInput^Optional

public readonly eventEndpointCreatedTopicArnInput: string;

• Type: string

---

eventEndpointDeletedTopicArnInput^Optional

public readonly eventEndpointDeletedTopicArnInput: string;

• Type: string

---

eventEndpointUpdatedTopicArnInput^Optional

public readonly eventEndpointUpdatedTopicArnInput: string;

• Type: string

---

failureFeedbackRoleArnInput^Optional

public readonly failureFeedbackRoleArnInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

platformCredentialInput^Optional

public readonly platformCredentialInput: string;

• Type: string

---

platformInput^Optional

public readonly platformInput: string;

• Type: string

---

platformPrincipalInput^Optional

public readonly platformPrincipalInput: string;

• Type: string

---

successFeedbackRoleArnInput^Optional

public readonly successFeedbackRoleArnInput: string;

• Type: string

---

successFeedbackSampleRateInput^Optional

public readonly successFeedbackSampleRateInput: string;

• Type: string

---

eventDeliveryFailureTopicArn^Required

public readonly eventDeliveryFailureTopicArn: string;

• Type: string

---

eventEndpointCreatedTopicArn^Required

public readonly eventEndpointCreatedTopicArn: string;

• Type: string

---

eventEndpointDeletedTopicArn^Required

public readonly eventEndpointDeletedTopicArn: string;

• Type: string

---

eventEndpointUpdatedTopicArn^Required

public readonly eventEndpointUpdatedTopicArn: string;

• Type: string

---

failureFeedbackRoleArn^Required

public readonly failureFeedbackRoleArn: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

platform^Required

public readonly platform: string;

• Type: string

---

platformCredential^Required

public readonly platformCredential: string;

• Type: string

---

platformPrincipal^Required

public readonly platformPrincipal: string;

• Type: string

---

successFeedbackRoleArn^Required

public readonly successFeedbackRoleArn: string;

• Type: string

---

successFeedbackSampleRate^Required

public readonly successFeedbackSampleRate: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

SnsPlatformApplicationConfig

Initializer

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

const snsPlatformApplicationConfig: snsPlatformApplication.SnsPlatformApplicationConfig = { ... }

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.
name	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_platform_application#name SnsPlatformApplication#name}.
platform	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_platform_application#platform SnsPlatformApplication#platform}.
platformCredential	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_platform_application#platform_credential SnsPlatformApplication#platform_credential}.
eventDeliveryFailureTopicArn	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_platform_application#event_delivery_failure_topic_arn SnsPlatformApplication#event_delivery_failure_topic_arn}.
eventEndpointCreatedTopicArn	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_platform_application#event_endpoint_created_topic_arn SnsPlatformApplication#event_endpoint_created_topic_arn}.
eventEndpointDeletedTopicArn	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_platform_application#event_endpoint_deleted_topic_arn SnsPlatformApplication#event_endpoint_deleted_topic_arn}.
eventEndpointUpdatedTopicArn	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_platform_application#event_endpoint_updated_topic_arn SnsPlatformApplication#event_endpoint_updated_topic_arn}.
failureFeedbackRoleArn	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_platform_application#failure_feedback_role_arn SnsPlatformApplication#failure_feedback_role_arn}.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_platform_application#id SnsPlatformApplication#id}.
platformPrincipal	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_platform_application#platform_principal SnsPlatformApplication#platform_principal}.
successFeedbackRoleArn	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_platform_application#success_feedback_role_arn SnsPlatformApplication#success_feedback_role_arn}.
successFeedbackSampleRate	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_platform_application#success_feedback_sample_rate SnsPlatformApplication#success_feedback_sample_rate}.

---

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[]

---

name^Required

public readonly name: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_platform_application#name SnsPlatformApplication#name}.

---

platform^Required

public readonly platform: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_platform_application#platform SnsPlatformApplication#platform}.

---

platformCredential^Required

public readonly platformCredential: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_platform_application#platform_credential SnsPlatformApplication#platform_credential}.

---

eventDeliveryFailureTopicArn^Optional

public readonly eventDeliveryFailureTopicArn: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_platform_application#event_delivery_failure_topic_arn SnsPlatformApplication#event_delivery_failure_topic_arn}.

---

eventEndpointCreatedTopicArn^Optional

public readonly eventEndpointCreatedTopicArn: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_platform_application#event_endpoint_created_topic_arn SnsPlatformApplication#event_endpoint_created_topic_arn}.

---

eventEndpointDeletedTopicArn^Optional

public readonly eventEndpointDeletedTopicArn: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_platform_application#event_endpoint_deleted_topic_arn SnsPlatformApplication#event_endpoint_deleted_topic_arn}.

---

eventEndpointUpdatedTopicArn^Optional

public readonly eventEndpointUpdatedTopicArn: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_platform_application#event_endpoint_updated_topic_arn SnsPlatformApplication#event_endpoint_updated_topic_arn}.

---

failureFeedbackRoleArn^Optional

public readonly failureFeedbackRoleArn: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_platform_application#failure_feedback_role_arn SnsPlatformApplication#failure_feedback_role_arn}.

---

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_platform_application#id SnsPlatformApplication#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.

---

platformPrincipal^Optional

public readonly platformPrincipal: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_platform_application#platform_principal SnsPlatformApplication#platform_principal}.

---

successFeedbackRoleArn^Optional

public readonly successFeedbackRoleArn: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_platform_application#success_feedback_role_arn SnsPlatformApplication#success_feedback_role_arn}.

---

successFeedbackSampleRate^Optional

public readonly successFeedbackSampleRate: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/sns_platform_application#success_feedback_sample_rate SnsPlatformApplication#success_feedback_sample_rate}.

---