Show / Hide Table of Contents

Class CfnPoolPropsMixin

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

Inheritance
object
Mixin
CfnPoolPropsMixin
Implements
IMixin
Inherited Members
Mixin.IsMixin(object)
Namespace: Amazon.CDK.Mixins.Preview.AWS.SMSVOICE.Mixins
Assembly: Amazon.CDK.Mixins.Preview.dll
Syntax (csharp)
public class CfnPoolPropsMixin : Mixin, IMixin
Syntax (vb)
Public Class CfnPoolPropsMixin Inherits Mixin Implements IMixin
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

Mixin: true

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.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.SMSVOICE.Mixins;

             var cfnPoolPropsMixin = new CfnPoolPropsMixin(new CfnPoolMixinProps {
                 DeletionProtectionEnabled = false,
                 MandatoryKeywords = new MandatoryKeywordsProperty {
                     Help = new MandatoryKeywordProperty {
                         Message = "message"
                     },
                     Stop = new MandatoryKeywordProperty {
                         Message = "message"
                     }
                 },
                 OptionalKeywords = new [] { new OptionalKeywordProperty {
                     Action = "action",
                     Keyword = "keyword",
                     Message = "message"
                 } },
                 OptOutListName = "optOutListName",
                 OriginationIdentities = new [] { "originationIdentities" },
                 SelfManagedOptOutsEnabled = false,
                 SharedRoutesEnabled = false,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TwoWay = new TwoWayProperty {
                     ChannelArn = "channelArn",
                     ChannelRole = "channelRole",
                     Enabled = false
                 }
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Synopsis

Constructors

CfnPoolPropsMixin(ICfnPoolMixinProps, ICfnPropertyMixinOptions?)

Create a mixin to apply properties to AWS::SMSVOICE::Pool.

Properties

CFN_PROPERTY_KEYS

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

Props

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

Strategy

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

Methods

ApplyTo(IConstruct)

Apply the mixin properties to the construct.

Supports(IConstruct)

Check if this mixin supports the given construct.

Constructors

CfnPoolPropsMixin(ICfnPoolMixinProps, ICfnPropertyMixinOptions?)

Create a mixin to apply properties to AWS::SMSVOICE::Pool.

public CfnPoolPropsMixin(ICfnPoolMixinProps props, ICfnPropertyMixinOptions? options = null)
Parameters
props ICfnPoolMixinProps

L1 properties to apply.

options ICfnPropertyMixinOptions

Mixin options.

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

Mixin: true

ExampleMetadata: fixture=_generated

Properties

CFN_PROPERTY_KEYS

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

protected static string[] CFN_PROPERTY_KEYS { get; }
Property Value

string[]

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

Mixin: true

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.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.SMSVOICE.Mixins;

             var cfnPoolPropsMixin = new CfnPoolPropsMixin(new CfnPoolMixinProps {
                 DeletionProtectionEnabled = false,
                 MandatoryKeywords = new MandatoryKeywordsProperty {
                     Help = new MandatoryKeywordProperty {
                         Message = "message"
                     },
                     Stop = new MandatoryKeywordProperty {
                         Message = "message"
                     }
                 },
                 OptionalKeywords = new [] { new OptionalKeywordProperty {
                     Action = "action",
                     Keyword = "keyword",
                     Message = "message"
                 } },
                 OptOutListName = "optOutListName",
                 OriginationIdentities = new [] { "originationIdentities" },
                 SelfManagedOptOutsEnabled = false,
                 SharedRoutesEnabled = false,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TwoWay = new TwoWayProperty {
                     ChannelArn = "channelArn",
                     ChannelRole = "channelRole",
                     Enabled = false
                 }
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Props

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

protected virtual ICfnPoolMixinProps Props { get; }
Property Value

ICfnPoolMixinProps

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

Mixin: true

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.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.SMSVOICE.Mixins;

             var cfnPoolPropsMixin = new CfnPoolPropsMixin(new CfnPoolMixinProps {
                 DeletionProtectionEnabled = false,
                 MandatoryKeywords = new MandatoryKeywordsProperty {
                     Help = new MandatoryKeywordProperty {
                         Message = "message"
                     },
                     Stop = new MandatoryKeywordProperty {
                         Message = "message"
                     }
                 },
                 OptionalKeywords = new [] { new OptionalKeywordProperty {
                     Action = "action",
                     Keyword = "keyword",
                     Message = "message"
                 } },
                 OptOutListName = "optOutListName",
                 OriginationIdentities = new [] { "originationIdentities" },
                 SelfManagedOptOutsEnabled = false,
                 SharedRoutesEnabled = false,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TwoWay = new TwoWayProperty {
                     ChannelArn = "channelArn",
                     ChannelRole = "channelRole",
                     Enabled = false
                 }
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Strategy

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

protected virtual PropertyMergeStrategy Strategy { get; }
Property Value

PropertyMergeStrategy

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

Mixin: true

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.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.SMSVOICE.Mixins;

             var cfnPoolPropsMixin = new CfnPoolPropsMixin(new CfnPoolMixinProps {
                 DeletionProtectionEnabled = false,
                 MandatoryKeywords = new MandatoryKeywordsProperty {
                     Help = new MandatoryKeywordProperty {
                         Message = "message"
                     },
                     Stop = new MandatoryKeywordProperty {
                         Message = "message"
                     }
                 },
                 OptionalKeywords = new [] { new OptionalKeywordProperty {
                     Action = "action",
                     Keyword = "keyword",
                     Message = "message"
                 } },
                 OptOutListName = "optOutListName",
                 OriginationIdentities = new [] { "originationIdentities" },
                 SelfManagedOptOutsEnabled = false,
                 SharedRoutesEnabled = false,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TwoWay = new TwoWayProperty {
                     ChannelArn = "channelArn",
                     ChannelRole = "channelRole",
                     Enabled = false
                 }
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Methods

ApplyTo(IConstruct)

Apply the mixin properties to the construct.

public override IConstruct ApplyTo(IConstruct construct)
Parameters
construct IConstruct
Returns

IConstruct

Overrides
Mixin.ApplyTo(IConstruct)
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

Mixin: true

ExampleMetadata: fixture=_generated

Supports(IConstruct)

Check if this mixin supports the given construct.

public override bool Supports(IConstruct construct)
Parameters
construct IConstruct
Returns

bool

Overrides
Mixin.Supports(IConstruct)
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

Mixin: true

ExampleMetadata: fixture=_generated

Implements

IMixin
Back to top Generated by DocFX