CfnPhoneNumber

class aws_cdk.aws_smsvoice.CfnPhoneNumber(scope, id, *, iso_country_code, mandatory_keywords, number_capabilities, number_type, deletion_protection_enabled=None, optional_keywords=None, opt_out_list_name=None, self_managed_opt_outs_enabled=None, tags=None, two_way=None)

Bases: CfnResource

Request an origination phone number for use in your account.

For more information on phone number request see Request a phone number in the End User Messaging User Guide . .. epigraph:

Registering phone numbers is not supported by AWS CloudFormation . You can import phone numbers and sender IDs that are automatically provisioned at registration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html
CloudformationResource:: AWS::SMSVOICE::PhoneNumber
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_smsvoice as smsvoice

cfn_phone_number = smsvoice.CfnPhoneNumber(self, "MyCfnPhoneNumber",
    iso_country_code="isoCountryCode",
    mandatory_keywords=smsvoice.CfnPhoneNumber.MandatoryKeywordsProperty(
        help=smsvoice.CfnPhoneNumber.MandatoryKeywordProperty(
            message="message"
        ),
        stop=smsvoice.CfnPhoneNumber.MandatoryKeywordProperty(
            message="message"
        )
    ),
    number_capabilities=["numberCapabilities"],
    number_type="numberType",

    # the properties below are optional
    deletion_protection_enabled=False,
    optional_keywords=[smsvoice.CfnPhoneNumber.OptionalKeywordProperty(
        action="action",
        keyword="keyword",
        message="message"
    )],
    opt_out_list_name="optOutListName",
    self_managed_opt_outs_enabled=False,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    two_way=smsvoice.CfnPhoneNumber.TwoWayProperty(
        enabled=False,

        # the properties below are optional
        channel_arn="channelArn",
        channel_role="channelRole"
    )
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
iso_country_code (str) – The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
mandatory_keywords (Union[IResolvable, MandatoryKeywordsProperty, Dict[str, Any]]) – Creates or updates a MandatoryKeyword configuration on an origination phone number For more information, see Keywords in the End User Messaging User Guide.
number_capabilities (Sequence[str]) – Indicates if the phone number will be used for text messages, voice messages, or both.
number_type (str) – The type of phone number to request. .. epigraph:: The ShortCode number type is not supported in AWS CloudFormation .
deletion_protection_enabled (Union[bool, IResolvable, None]) – By default this is set to false. When set to true the phone number can’t be deleted.
optional_keywords (Union[IResolvable, Sequence[Union[IResolvable, OptionalKeywordProperty, Dict[str, Any]]], None]) –
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, End User Messaging responds with a customizable message. Optional keywords are differentiated from mandatory keywords. For more information, see Keywords in the End User Messaging User Guide.
opt_out_list_name (Optional[str]) – The name of the OptOutList associated with the phone number.
self_managed_opt_outs_enabled (Union[bool, IResolvable, None]) – When set to false and 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. When set to true you’re responsible for responding to HELP and STOP requests. You’re also responsible for tracking and honoring opt-out request. For more information see Self-managed opt-outs
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of tags (key and value pairs) to associate with the requested phone number.
two_way (Union[IResolvable, TwoWayProperty, Dict[str, Any], None]) – Describes the two-way SMS configuration for a phone number. For more information, see Two-way SMS messaging in the End User Messaging User Guide.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:: target (CfnResource)
Deprecated:: use addDependency
Stability:: deprecated
Return type:: None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str)
value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy])
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:: key (str)
See:
Return type:: Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

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

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::SMSVOICE::PhoneNumber'

attr_arn

The PhoneNumber ‘s Amazon Resource Name (ARN).

CloudformationAttribute:: Arn

attr_phone_number

The phone number in E.164 format.

CloudformationAttribute:: PhoneNumber

attr_phone_number_id

The unique identifier for the phone number.

CloudformationAttribute:: PhoneNumberId

cdk_tag_manager: Tag Manager which manages the tags for this resource.

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

deletion_protection_enabled: By default this is set to false.

iso_country_code: The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

mandatory_keywords: Creates or updates a MandatoryKeyword configuration on an origination phone number For more information, see Keywords in the End User Messaging User Guide.

node: The tree node.

number_capabilities: Indicates if the phone number will be used for text messages, voice messages, or both.

number_type: The type of phone number to request.

opt_out_list_name: The name of the OptOutList associated with the phone number.

optional_keywords: A keyword is a word that you can search for on a particular phone number or pool.

phone_number_ref: A reference to a PhoneNumber resource.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

self_managed_opt_outs_enabled: When set to false and 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.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags: An array of tags (key and value pairs) to associate with the requested phone number.

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

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:: x (Any)
Return type:: bool
Returns:: The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:: x (Any)
Return type:: bool

classmethod is_construct(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.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

MandatoryKeywordProperty

class CfnPhoneNumber.MandatoryKeywordProperty(*, message)

Bases: object

The keywords HELP and STOP are mandatory keywords that each phone number must have.

For more information, see Keywords in the End User Messaging User Guide.

Parameters:: message (str) – The message associated with the keyword.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-mandatorykeyword.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_smsvoice as smsvoice

mandatory_keyword_property = smsvoice.CfnPhoneNumber.MandatoryKeywordProperty(
    message="message"
)

Attributes

message

The message associated with the keyword.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-mandatorykeyword.html#cfn-smsvoice-phonenumber-mandatorykeyword-message

MandatoryKeywordsProperty

class CfnPhoneNumber.MandatoryKeywordsProperty(*, help, stop)

Bases: object

The keywords HELP and STOP are mandatory keywords that each phone number must have.

For more information, see Keywords in the End User Messaging User Guide.

Parameters:

help (Union[IResolvable, MandatoryKeywordProperty, Dict[str, Any]]) –
Specifies the HELP keyword that customers use to obtain customer support for this phone number. For more information, see Keywords in the End User Messaging User Guide.
stop (Union[IResolvable, MandatoryKeywordProperty, Dict[str, Any]]) – Specifies the STOP keyword that customers use to opt out of receiving messages from this phone number. For more information, see Required opt-out keywords in the End User Messaging User Guide.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-mandatorykeywords.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_smsvoice as smsvoice

mandatory_keywords_property = smsvoice.CfnPhoneNumber.MandatoryKeywordsProperty(
    help=smsvoice.CfnPhoneNumber.MandatoryKeywordProperty(
        message="message"
    ),
    stop=smsvoice.CfnPhoneNumber.MandatoryKeywordProperty(
        message="message"
    )
)

Attributes

help

Specifies the HELP keyword that customers use to obtain customer support for this phone number.

For more information, see Keywords in the End User Messaging User Guide.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-mandatorykeywords.html#cfn-smsvoice-phonenumber-mandatorykeywords-help

stop

Specifies the STOP keyword that customers use to opt out of receiving messages from this phone number.

For more information, see Required opt-out keywords in the End User Messaging User Guide.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-mandatorykeywords.html#cfn-smsvoice-phonenumber-mandatorykeywords-stop

OptionalKeywordProperty

class CfnPhoneNumber.OptionalKeywordProperty(*, action, keyword, message)

Bases: object

The OptionalKeyword configuration.

For more information, see Keywords in the End User Messaging User Guide.

Parameters:

action (str) – The action to perform when the keyword is used.
keyword (str) – The new keyword to add.
message (str) – The message associated with the keyword.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-optionalkeyword.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_smsvoice as smsvoice

optional_keyword_property = smsvoice.CfnPhoneNumber.OptionalKeywordProperty(
    action="action",
    keyword="keyword",
    message="message"
)

Attributes

action

The action to perform when the keyword is used.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-optionalkeyword.html#cfn-smsvoice-phonenumber-optionalkeyword-action

keyword

The new keyword to add.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-optionalkeyword.html#cfn-smsvoice-phonenumber-optionalkeyword-keyword

message

The message associated with the keyword.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-optionalkeyword.html#cfn-smsvoice-phonenumber-optionalkeyword-message

TwoWayProperty

class CfnPhoneNumber.TwoWayProperty(*, enabled, channel_arn=None, channel_role=None)

Bases: object

The phone number’s two-way SMS configuration object.

Parameters:

enabled (Union[bool, IResolvable]) – By default this is set to false. When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
channel_arn (Optional[str]) – The Amazon Resource Name (ARN) of the two way channel.
channel_role (Optional[str]) – An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-twoway.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_smsvoice as smsvoice

two_way_property = smsvoice.CfnPhoneNumber.TwoWayProperty(
    enabled=False,

    # the properties below are optional
    channel_arn="channelArn",
    channel_role="channelRole"
)

Attributes

channel_arn

The Amazon Resource Name (ARN) of the two way channel.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-twoway.html#cfn-smsvoice-phonenumber-twoway-channelarn

channel_role

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-twoway.html#cfn-smsvoice-phonenumber-twoway-channelrole

enabled

By default this is set to false.

When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-twoway.html#cfn-smsvoice-phonenumber-twoway-enabled