snsTopicSubscription.csharp.md

snsTopicSubscription Submodule

Constructs

SnsTopicSubscription

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

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new SnsTopicSubscription(Construct Scope, string Id, SnsTopicSubscriptionConfig Config);

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.
ResetFilterPolicyScope	No description.
ResetId	No description.
ResetRawMessageDelivery	No description.
ResetRedrivePolicy	No description.
ResetReplayPolicy	No description.
ResetSubscriptionRoleArn	No description.

---

ToString

private string ToString()

Returns a string representation of this construct.

AddOverride

private void AddOverride(string Path, object Value)

Path^Required

• Type: string

---

Value^Required

• Type: object

---

OverrideLogicalId

private void OverrideLogicalId(string NewLogicalId)

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

private void ResetOverrideLogicalId()

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

ToHclTerraform

private object ToHclTerraform()

ToMetadata

private object ToMetadata()

ToTerraform

private object ToTerraform()

Adds this resource to the terraform JSON output.

AddMoveTarget

private void AddMoveTarget(string MoveTarget)

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

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanAttribute

private IResolvable GetBooleanAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanMapAttribute

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetListAttribute

private string[] GetListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberAttribute

private double GetNumberAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberListAttribute

private double[] GetNumberListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberMapAttribute

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringAttribute

private string GetStringAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringMapAttribute

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

HasResourceMove

private object HasResourceMove()

ImportFrom

private void ImportFrom(string Id, TerraformProvider Provider = null)

Id^Required

• Type: string

---

Provider^Optional

• Type: HashiCorp.Cdktf.TerraformProvider

---

InterpolationForAttribute

private IResolvable InterpolationForAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

MoveFromId

private void MoveFromId(string Id)

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

private void MoveTo(string MoveTarget, object Index = null)

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: object

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

---

MoveToId

private void MoveToId(string Id)

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

private void ResetConfirmationTimeoutInMinutes()

ResetDeliveryPolicy

private void ResetDeliveryPolicy()

ResetEndpointAutoConfirms

private void ResetEndpointAutoConfirms()

ResetFilterPolicy

private void ResetFilterPolicy()

ResetFilterPolicyScope

private void ResetFilterPolicyScope()

ResetId

private void ResetId()

ResetRawMessageDelivery

private void ResetRawMessageDelivery()

ResetRedrivePolicy

private void ResetRedrivePolicy()

ResetReplayPolicy

private void ResetReplayPolicy()

ResetSubscriptionRoleArn

private void ResetSubscriptionRoleArn()

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

using HashiCorp.Cdktf.Providers.Aws;

SnsTopicSubscription.IsConstruct(object X);

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: object

Any object.

---

IsTerraformElement

using HashiCorp.Cdktf.Providers.Aws;

SnsTopicSubscription.IsTerraformElement(object X);

X^Required

• Type: object

---

IsTerraformResource

using HashiCorp.Cdktf.Providers.Aws;

SnsTopicSubscription.IsTerraformResource(object X);

X^Required

• Type: object

---

GenerateConfigForImport

using HashiCorp.Cdktf.Providers.Aws;

SnsTopicSubscription.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

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/5.58.0/docs/resources/sns_topic_subscription#import import section} in the documentation of this resource for the id to use

---

Provider^Optional

• Type: HashiCorp.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	HashiCorp.Cdktf.TerraformStack	No description.
Fqn	string	No description.
FriendlyUniqueId	string	No description.
TerraformMetaArguments	System.Collections.Generic.IDictionary<string, object>	No description.
TerraformResourceType	string	No description.
TerraformGeneratorMetadata	HashiCorp.Cdktf.TerraformProviderGeneratorMetadata	No description.
Connection	object	No description.
Count	object	No description.
DependsOn	string[]	No description.
ForEach	HashiCorp.Cdktf.ITerraformIterator	No description.
Lifecycle	HashiCorp.Cdktf.TerraformResourceLifecycle	No description.
Provider	HashiCorp.Cdktf.TerraformProvider	No description.
Provisioners	object[]	No description.
Arn	string	No description.
ConfirmationWasAuthenticated	HashiCorp.Cdktf.IResolvable	No description.
OwnerId	string	No description.
PendingConfirmation	HashiCorp.Cdktf.IResolvable	No description.
ConfirmationTimeoutInMinutesInput	double	No description.
DeliveryPolicyInput	string	No description.
EndpointAutoConfirmsInput	object	No description.
EndpointInput	string	No description.
FilterPolicyInput	string	No description.
FilterPolicyScopeInput	string	No description.
IdInput	string	No description.
ProtocolInput	string	No description.
RawMessageDeliveryInput	object	No description.
RedrivePolicyInput	string	No description.
ReplayPolicyInput	string	No description.
SubscriptionRoleArnInput	string	No description.
TopicArnInput	string	No description.
ConfirmationTimeoutInMinutes	double	No description.
DeliveryPolicy	string	No description.
Endpoint	string	No description.
EndpointAutoConfirms	object	No description.
FilterPolicy	string	No description.
FilterPolicyScope	string	No description.
Id	string	No description.
Protocol	string	No description.
RawMessageDelivery	object	No description.
RedrivePolicy	string	No description.
ReplayPolicy	string	No description.
SubscriptionRoleArn	string	No description.
TopicArn	string	No description.

---

Node^Required

public Node Node { get; }

• Type: Constructs.Node

The tree node.

---

CdktfStack^Required

public TerraformStack CdktfStack { get; }

• Type: HashiCorp.Cdktf.TerraformStack

---

Fqn^Required

public string Fqn { get; }

• Type: string

---

FriendlyUniqueId^Required

public string FriendlyUniqueId { get; }

• Type: string

---

TerraformMetaArguments^Required

public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }

• Type: System.Collections.Generic.IDictionary<string, object>

---

TerraformResourceType^Required

public string TerraformResourceType { get; }

• Type: string

---

TerraformGeneratorMetadata^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

• Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

---

Connection^Optional

public object Connection { get; }

• Type: object

---

Count^Optional

public object Count { get; }

• Type: object

---

DependsOn^Optional

public string[] DependsOn { get; }

• Type: string[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; }

• Type: HashiCorp.Cdktf.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; }

• Type: HashiCorp.Cdktf.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; }

• Type: HashiCorp.Cdktf.TerraformProvider

---

Provisioners^Optional

public object[] Provisioners { get; }

• Type: object[]

---

Arn^Required

public string Arn { get; }

• Type: string

---

ConfirmationWasAuthenticated^Required

public IResolvable ConfirmationWasAuthenticated { get; }

• Type: HashiCorp.Cdktf.IResolvable

---

OwnerId^Required

public string OwnerId { get; }

• Type: string

---

PendingConfirmation^Required

public IResolvable PendingConfirmation { get; }

• Type: HashiCorp.Cdktf.IResolvable

---

ConfirmationTimeoutInMinutesInput^Optional

public double ConfirmationTimeoutInMinutesInput { get; }

• Type: double

---

DeliveryPolicyInput^Optional

public string DeliveryPolicyInput { get; }

• Type: string

---

EndpointAutoConfirmsInput^Optional

public object EndpointAutoConfirmsInput { get; }

• Type: object

---

EndpointInput^Optional

public string EndpointInput { get; }

• Type: string

---

FilterPolicyInput^Optional

public string FilterPolicyInput { get; }

• Type: string

---

FilterPolicyScopeInput^Optional

public string FilterPolicyScopeInput { get; }

• Type: string

---

IdInput^Optional

public string IdInput { get; }

• Type: string

---

ProtocolInput^Optional

public string ProtocolInput { get; }

• Type: string

---

RawMessageDeliveryInput^Optional

public object RawMessageDeliveryInput { get; }

• Type: object

---

RedrivePolicyInput^Optional

public string RedrivePolicyInput { get; }

• Type: string

---

ReplayPolicyInput^Optional

public string ReplayPolicyInput { get; }

• Type: string

---

SubscriptionRoleArnInput^Optional

public string SubscriptionRoleArnInput { get; }

• Type: string

---

TopicArnInput^Optional

public string TopicArnInput { get; }

• Type: string

---

ConfirmationTimeoutInMinutes^Required

public double ConfirmationTimeoutInMinutes { get; }

• Type: double

---

DeliveryPolicy^Required

public string DeliveryPolicy { get; }

• Type: string

---

Endpoint^Required

public string Endpoint { get; }

• Type: string

---

EndpointAutoConfirms^Required

public object EndpointAutoConfirms { get; }

• Type: object

---

FilterPolicy^Required

public string FilterPolicy { get; }

• Type: string

---

FilterPolicyScope^Required

public string FilterPolicyScope { get; }

• Type: string

---

Id^Required

public string Id { get; }

• Type: string

---

Protocol^Required

public string Protocol { get; }

• Type: string

---

RawMessageDelivery^Required

public object RawMessageDelivery { get; }

• Type: object

---

RedrivePolicy^Required

public string RedrivePolicy { get; }

• Type: string

---

ReplayPolicy^Required

public string ReplayPolicy { get; }

• Type: string

---

SubscriptionRoleArn^Required

public string SubscriptionRoleArn { get; }

• Type: string

---

TopicArn^Required

public string TopicArn { get; }

• Type: string

---

Constants

Name	Type	Description
TfResourceType	string	No description.

---

TfResourceType^Required

public string TfResourceType { get; }

• Type: string

---

Structs

SnsTopicSubscriptionConfig

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new SnsTopicSubscriptionConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Endpoint,
    string Protocol,
    string TopicArn,
    double ConfirmationTimeoutInMinutes = null,
    string DeliveryPolicy = null,
    object EndpointAutoConfirms = null,
    string FilterPolicy = null,
    string FilterPolicyScope = null,
    string Id = null,
    object RawMessageDelivery = null,
    string RedrivePolicy = null,
    string ReplayPolicy = null,
    string SubscriptionRoleArn = null
};

Properties

Name	Type	Description
Connection	object	No description.
Count	object	No description.
DependsOn	HashiCorp.Cdktf.ITerraformDependable[]	No description.
ForEach	HashiCorp.Cdktf.ITerraformIterator	No description.
Lifecycle	HashiCorp.Cdktf.TerraformResourceLifecycle	No description.
Provider	HashiCorp.Cdktf.TerraformProvider	No description.
Provisioners	object[]	No description.
Endpoint	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/sns_topic_subscription#endpoint SnsTopicSubscription#endpoint}.
Protocol	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/sns_topic_subscription#protocol SnsTopicSubscription#protocol}.
TopicArn	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/sns_topic_subscription#topic_arn SnsTopicSubscription#topic_arn}.
ConfirmationTimeoutInMinutes	double	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/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/5.58.0/docs/resources/sns_topic_subscription#delivery_policy SnsTopicSubscription#delivery_policy}.
EndpointAutoConfirms	object	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/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/5.58.0/docs/resources/sns_topic_subscription#filter_policy SnsTopicSubscription#filter_policy}.
FilterPolicyScope	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/sns_topic_subscription#filter_policy_scope SnsTopicSubscription#filter_policy_scope}.
Id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/sns_topic_subscription#id SnsTopicSubscription#id}.
RawMessageDelivery	object	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/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/5.58.0/docs/resources/sns_topic_subscription#redrive_policy SnsTopicSubscription#redrive_policy}.
ReplayPolicy	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/sns_topic_subscription#replay_policy SnsTopicSubscription#replay_policy}.
SubscriptionRoleArn	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/docs/resources/sns_topic_subscription#subscription_role_arn SnsTopicSubscription#subscription_role_arn}.

---

Connection^Optional

public object Connection { get; set; }

• Type: object

---

Count^Optional

public object Count { get; set; }

• Type: object

---

DependsOn^Optional

public ITerraformDependable[] DependsOn { get; set; }

• Type: HashiCorp.Cdktf.ITerraformDependable[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; set; }

• Type: HashiCorp.Cdktf.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

• Type: HashiCorp.Cdktf.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; set; }

• Type: HashiCorp.Cdktf.TerraformProvider

---

Provisioners^Optional

public object[] Provisioners { get; set; }

• Type: object[]

---

Endpoint^Required

public string Endpoint { get; set; }

• Type: string

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

---

Protocol^Required

public string Protocol { get; set; }

• Type: string

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

---

TopicArn^Required

public string TopicArn { get; set; }

• Type: string

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

---

ConfirmationTimeoutInMinutes^Optional

public double ConfirmationTimeoutInMinutes { get; set; }

• Type: double

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

---

DeliveryPolicy^Optional

public string DeliveryPolicy { get; set; }

• Type: string

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

---

EndpointAutoConfirms^Optional

public object EndpointAutoConfirms { get; set; }

• Type: object

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

---

FilterPolicy^Optional

public string FilterPolicy { get; set; }

• Type: string

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

---

FilterPolicyScope^Optional

public string FilterPolicyScope { get; set; }

• Type: string

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

---

Id^Optional

public string Id { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.58.0/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 object RawMessageDelivery { get; set; }

• Type: object

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

---

RedrivePolicy^Optional

public string RedrivePolicy { get; set; }

• Type: string

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

---

ReplayPolicy^Optional

public string ReplayPolicy { get; set; }

• Type: string

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

---

SubscriptionRoleArn^Optional

public string SubscriptionRoleArn { get; set; }

• Type: string

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

---