Class CfnPool

Creates a new pool and associates the specified origination identity to the pool.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnPool

Implements

IInspectable

IPoolRef

IConstruct

IDependable

IEnvironmentAware

ITaggableV2

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.SMSVOICE

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnPool : CfnResource, IInspectable, IPoolRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Syntax (vb)

Public Class CfnPool Inherits CfnResource Implements IInspectable, IPoolRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Remarks

A pool can include one or more phone numbers and SenderIds that are associated with your AWS account.

The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn't inherited from the origination identity and defaults to false.

If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html

CloudformationResource: AWS::SMSVOICE::Pool

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.SMSVOICE;

             var cfnPool = new CfnPool(this, "MyCfnPool", new CfnPoolProps {
                 MandatoryKeywords = new MandatoryKeywordsProperty {
                     Help = new MandatoryKeywordProperty {
                         Message = "message"
                     },
                     Stop = new MandatoryKeywordProperty {
                         Message = "message"
                     }
                 },
                 OriginationIdentities = new [] { "originationIdentities" },

                 // the properties below are optional
                 DeletionProtectionEnabled = false,
                 OptionalKeywords = new [] { new OptionalKeywordProperty {
                     Action = "action",
                     Keyword = "keyword",
                     Message = "message"
                 } },
                 OptOutListName = "optOutListName",
                 SelfManagedOptOutsEnabled = false,
                 SharedRoutesEnabled = false,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TwoWay = new TwoWayProperty {
                     Enabled = false,

                     // the properties below are optional
                     ChannelArn = "channelArn",
                     ChannelRole = "channelRole"
                 }
             });

Synopsis

Constructors

CfnPool(Construct, string, ICfnPoolProps)

Create a new AWS::SMSVOICE::Pool.

Properties

AttrArn	The Amazon Resource Name of the `Pool` .
AttrPoolId	The unique identifier for the pool.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	Creates a new pool and associates the specified origination identity to the pool.
DeletionProtectionEnabled	When set to true the pool can't be deleted.
MandatoryKeywords	Creates or updates the pool's `MandatoryKeyword` configuration.
OptOutListName	The name of the OptOutList associated with the pool.
OptionalKeywords	Specifies any optional keywords to associate with the pool.
OriginationIdentities	The list of origination identities to apply to the pool, either `PhoneNumberArn` or `SenderIdArn` .
PoolRef	A reference to a Pool resource.
SelfManagedOptOutsEnabled	When set to false, an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging automatically replies with a customizable message and adds the end recipient to the OptOutList.
SharedRoutesEnabled	Allows you to enable shared routes on your pool.
Tags	An array of tags (key and value pairs) associated with the pool.
TwoWay	Describes the two-way SMS configuration for a phone number.

Methods

ArnForPool(IPoolRef)	Creates a new pool and associates the specified origination identity to the pool.
FromPoolArn(Construct, string, string)	Creates a new IPoolRef from an ARN.
FromPoolId(Construct, string, string)	Creates a new IPoolRef from a poolId.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnPool(object)	Checks whether the given object is a CfnPool.
RenderProperties(IDictionary<string, object>)	Creates a new pool and associates the specified origination identity to the pool.

Constructors

CfnPool(Construct, string, ICfnPoolProps)

Create a new AWS::SMSVOICE::Pool.

public CfnPool(Construct scope, string id, ICfnPoolProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnPoolProps: Resource properties.

Remarks

A pool can include one or more phone numbers and SenderIds that are associated with your AWS account.

If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html

CloudformationResource: AWS::SMSVOICE::Pool

ExampleMetadata: fixture=_generated

Properties

AttrArn

The Amazon Resource Name of the Pool .

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrPoolId

The unique identifier for the pool.

public virtual string AttrPoolId { get; }

Property Value

string

Remarks

CloudformationAttribute: PoolId

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

A pool can include one or more phone numbers and SenderIds that are associated with your AWS account.

If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html

CloudformationResource: AWS::SMSVOICE::Pool

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

A pool can include one or more phone numbers and SenderIds that are associated with your AWS account.

If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html

CloudformationResource: AWS::SMSVOICE::Pool

ExampleMetadata: fixture=_generated

CfnProperties

Creates a new pool and associates the specified origination identity to the pool.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

A pool can include one or more phone numbers and SenderIds that are associated with your AWS account.

If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html

CloudformationResource: AWS::SMSVOICE::Pool

ExampleMetadata: fixture=_generated

DeletionProtectionEnabled

When set to true the pool can't be deleted.

public virtual object? DeletionProtectionEnabled { get; set; }

Property Value

object

Remarks

Type union: either bool or IResolvable

MandatoryKeywords

Creates or updates the pool's MandatoryKeyword configuration.

public virtual object MandatoryKeywords { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnPool.IMandatoryKeywordsProperty

OptOutListName

The name of the OptOutList associated with the pool.

public virtual string? OptOutListName { get; set; }

Property Value

string

Remarks

A pool can include one or more phone numbers and SenderIds that are associated with your AWS account.

If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html

CloudformationResource: AWS::SMSVOICE::Pool

ExampleMetadata: fixture=_generated

OptionalKeywords

Specifies any optional keywords to associate with the pool.

public virtual object? OptionalKeywords { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnPool.IOptionalKeywordProperty)[]

OriginationIdentities

The list of origination identities to apply to the pool, either PhoneNumberArn or SenderIdArn .

public virtual string[] OriginationIdentities { get; set; }

Property Value

string[]

Remarks

A pool can include one or more phone numbers and SenderIds that are associated with your AWS account.

If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html

CloudformationResource: AWS::SMSVOICE::Pool

ExampleMetadata: fixture=_generated

PoolRef

A reference to a Pool resource.

public virtual IPoolReference PoolRef { get; }

Property Value

IPoolReference

Remarks

A pool can include one or more phone numbers and SenderIds that are associated with your AWS account.

If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html

CloudformationResource: AWS::SMSVOICE::Pool

ExampleMetadata: fixture=_generated

SelfManagedOptOutsEnabled

When set to false, an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging automatically replies with a customizable message and adds the end recipient to the OptOutList.

public virtual object? SelfManagedOptOutsEnabled { get; set; }

Property Value

object

Remarks

Type union: either bool or IResolvable

SharedRoutesEnabled

Allows you to enable shared routes on your pool.

public virtual object? SharedRoutesEnabled { get; set; }

Property Value

object

Remarks

Type union: either bool or IResolvable

TwoWay

Describes the two-way SMS configuration for a phone number.

public virtual object? TwoWay { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnPool.ITwoWayProperty

Methods

ArnForPool(IPoolRef)

Creates a new pool and associates the specified origination identity to the pool.

public static string ArnForPool(IPoolRef resource)

Parameters

resource IPoolRef

Returns

string

Remarks

A pool can include one or more phone numbers and SenderIds that are associated with your AWS account.

If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html

CloudformationResource: AWS::SMSVOICE::Pool

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.SMSVOICE;

             var cfnPool = new CfnPool(this, "MyCfnPool", new CfnPoolProps {
                 MandatoryKeywords = new MandatoryKeywordsProperty {
                     Help = new MandatoryKeywordProperty {
                         Message = "message"
                     },
                     Stop = new MandatoryKeywordProperty {
                         Message = "message"
                     }
                 },
                 OriginationIdentities = new [] { "originationIdentities" },

                 // the properties below are optional
                 DeletionProtectionEnabled = false,
                 OptionalKeywords = new [] { new OptionalKeywordProperty {
                     Action = "action",
                     Keyword = "keyword",
                     Message = "message"
                 } },
                 OptOutListName = "optOutListName",
                 SelfManagedOptOutsEnabled = false,
                 SharedRoutesEnabled = false,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TwoWay = new TwoWayProperty {
                     Enabled = false,

                     // the properties below are optional
                     ChannelArn = "channelArn",
                     ChannelRole = "channelRole"
                 }
             });

FromPoolArn(Construct, string, string)

Creates a new IPoolRef from an ARN.

public static IPoolRef FromPoolArn(Construct scope, string id, string arn)

Parameters

scope Construct
id string
arn string

Returns

IPoolRef

Remarks

A pool can include one or more phone numbers and SenderIds that are associated with your AWS account.

If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html

CloudformationResource: AWS::SMSVOICE::Pool

ExampleMetadata: fixture=_generated

FromPoolId(Construct, string, string)

Creates a new IPoolRef from a poolId.

public static IPoolRef FromPoolId(Construct scope, string id, string poolId)

Parameters

scope Construct
id string
poolId string

Returns

IPoolRef

Remarks

A pool can include one or more phone numbers and SenderIds that are associated with your AWS account.

If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html

CloudformationResource: AWS::SMSVOICE::Pool

ExampleMetadata: fixture=_generated

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector: tree inspector to collect and process attributes.

Remarks

A pool can include one or more phone numbers and SenderIds that are associated with your AWS account.

If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html

CloudformationResource: AWS::SMSVOICE::Pool

ExampleMetadata: fixture=_generated

IsCfnPool(object)

Checks whether the given object is a CfnPool.

public static bool IsCfnPool(object x)

Parameters

x object

Returns

bool

Remarks

A pool can include one or more phone numbers and SenderIds that are associated with your AWS account.

If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html

CloudformationResource: AWS::SMSVOICE::Pool

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a new pool and associates the specified origination identity to the pool.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Remarks

A pool can include one or more phone numbers and SenderIds that are associated with your AWS account.

If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html

CloudformationResource: AWS::SMSVOICE::Pool

ExampleMetadata: fixture=_generated

Implements

IInspectable

IPoolRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggableV2