@propulsionworks/cloudformation 0.1.26 → 0.1.27

package/out/exports/resources.generated/aws-smsvoice-configurationset.d.ts

@@ -1,16 +1,24 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
 /**
- * Resource Type definition for AWS::SMSVOICE::ConfigurationSet
+ * Creates a new configuration set. After you create the configuration set, you can add one or more event destinations to it.
+ *
+ * A configuration set is a set of rules that you apply to the SMS and voice messages that you send.
+ *
+ * When you send a message, you can optionally specify a single configuration set.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-configurationset.html}
  */
 export type SMSVOICEConfigurationSet = ResourceDefinitionWithAttributes<"AWS::SMSVOICE::ConfigurationSet", SMSVOICEConfigurationSetProps, SMSVOICEConfigurationSetAttribs>;
 /**
- * Resource Type definition for AWS::SMSVOICE::ConfigurationSet
+ * Creates a new configuration set. After you create the configuration set, you can add one or more event destinations to it.
+ *
+ * A configuration set is a set of rules that you apply to the SMS and voice messages that you send.
+ *
+ * When you send a message, you can optionally specify a single configuration set.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-configurationset.html}
  */
 export type SMSVOICEConfigurationSetProps = {
     /**
-     * The name to use for the configuration set.
+     * The name of the ConfigurationSet.
      * @minLength 1
      * @maxLength 64
      * @pattern ^[A-Za-z0-9_-]+$
@@ -18,23 +26,23 @@ export type SMSVOICEConfigurationSetProps = {
      */
     ConfigurationSetName?: string | undefined;
     /**
-     * The default sender ID to set for the ConfigurationSet.
+     * The default sender ID used by the ConfigurationSet.
      * @pattern ^[A-Za-z0-9_-]+$
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-configurationset.html#cfn-smsvoice-configurationset-defaultsenderid}
      */
     DefaultSenderId?: string | undefined;
     /**
-     * An event destination is a location where you send message events.
+     * An array of EventDestination objects that describe any events to log and where to log them.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-configurationset.html#cfn-smsvoice-configurationset-eventdestinations}
      */
     EventDestinations?: EventDestination[] | undefined;
     /**
-     * Set to true to enable message feedback.
+     * Set to true to enable feedback for the message.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-configurationset.html#cfn-smsvoice-configurationset-messagefeedbackenabled}
      */
     MessageFeedbackEnabled?: boolean | undefined;
     /**
-     * The unique identifier for the protect configuration to be associated to the configuration set.
+     * The unique identifier for the protect configuration.
      * @minLength 1
      * @maxLength 256
      * @pattern ^[A-Za-z0-9_:/-]+$
@@ -42,7 +50,7 @@ export type SMSVOICEConfigurationSetProps = {
      */
     ProtectConfigurationId?: string | undefined;
     /**
-     * An array of key-value pairs to apply to this resource.
+     * An array of key and value pair tags that's associated with the new configuration set.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-configurationset.html#cfn-smsvoice-configurationset-tags}
      */
     Tags?: Tag[] | undefined;
@@ -52,11 +60,13 @@ export type SMSVOICEConfigurationSetProps = {
  */
 export type SMSVOICEConfigurationSetAttribs = {
     /**
+     * The Amazon Resource Name (ARN) of the ConfigurationSet.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-configurationset.html#cfn-smsvoice-configurationset-arn}
      */
     Arn: string;
 };
 /**
+ * Contains the destination configuration to use when publishing message sending events.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-cloudwatchlogsdestination.html}
  */
 export type CloudWatchLogsDestination = {
@@ -74,22 +84,24 @@ export type CloudWatchLogsDestination = {
     LogGroupArn: string;
 };
 /**
- * An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
+ * Contains information about an event destination.
+ *
+ * Event destinations are associated with configuration sets, which enable you to publish message sending events to CloudWatch, Firehose, or Amazon SNS.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-eventdestination.html}
  */
 export type EventDestination = {
     /**
-     * An object that contains IamRoleArn and LogGroupArn associated with an Amazon CloudWatch event destination.
+     * An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-eventdestination.html#cfn-smsvoice-configurationset-eventdestination-cloudwatchlogsdestination}
      */
     CloudWatchLogsDestination: CloudWatchLogsDestination;
     /**
-     * When set to true events will be logged. By default this is set to true
+     * When set to true events will be logged.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-eventdestination.html#cfn-smsvoice-configurationset-eventdestination-enabled}
      */
     Enabled: boolean;
     /**
-     * The name that identifies the event destination.
+     * The name of the EventDestination.
      * @minLength 1
      * @maxLength 64
      * @pattern ^[A-Za-z0-9_-]+$
@@ -97,33 +109,35 @@ export type EventDestination = {
      */
     EventDestinationName: string;
     /**
-     * An object that contains IamRoleArn and DeliveryStreamArn associated with an Amazon Kinesis Firehose event destination.
+     * An object that contains information about an event destination for logging to Amazon Data Firehose.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-eventdestination.html#cfn-smsvoice-configurationset-eventdestination-kinesisfirehosedestination}
      */
     KinesisFirehoseDestination?: KinesisFirehoseDestination | undefined;
     /**
-     * An array of event types that determine which events to log. If 'ALL' is used, then AWS End User Messaging SMS and Voice logs every event type.
+     * An array of event types that determine which events to log.
+     *
+     * > The `TEXT_SENT` event type is not supported.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-eventdestination.html#cfn-smsvoice-configurationset-eventdestination-matchingeventtypes}
      */
     MatchingEventTypes: string[];
     /**
-     * An object that contains SNS TopicArn event destination.
+     * An object that contains information about an event destination that sends logging events to Amazon SNS.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-eventdestination.html#cfn-smsvoice-configurationset-eventdestination-snsdestination}
      */
     SnsDestination?: SnsDestination | undefined;
 } | {
     /**
-     * An object that contains IamRoleArn and LogGroupArn associated with an Amazon CloudWatch event destination.
+     * An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-eventdestination.html#cfn-smsvoice-configurationset-eventdestination-cloudwatchlogsdestination}
      */
     CloudWatchLogsDestination?: CloudWatchLogsDestination | undefined;
     /**
-     * When set to true events will be logged. By default this is set to true
+     * When set to true events will be logged.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-eventdestination.html#cfn-smsvoice-configurationset-eventdestination-enabled}
      */
     Enabled: boolean;
     /**
-     * The name that identifies the event destination.
+     * The name of the EventDestination.
      * @minLength 1
      * @maxLength 64
      * @pattern ^[A-Za-z0-9_-]+$
@@ -131,33 +145,35 @@ export type EventDestination = {
      */
     EventDestinationName: string;
     /**
-     * An object that contains IamRoleArn and DeliveryStreamArn associated with an Amazon Kinesis Firehose event destination.
+     * An object that contains information about an event destination for logging to Amazon Data Firehose.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-eventdestination.html#cfn-smsvoice-configurationset-eventdestination-kinesisfirehosedestination}
      */
     KinesisFirehoseDestination: KinesisFirehoseDestination;
     /**
-     * An array of event types that determine which events to log. If 'ALL' is used, then AWS End User Messaging SMS and Voice logs every event type.
+     * An array of event types that determine which events to log.
+     *
+     * > The `TEXT_SENT` event type is not supported.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-eventdestination.html#cfn-smsvoice-configurationset-eventdestination-matchingeventtypes}
      */
     MatchingEventTypes: string[];
     /**
-     * An object that contains SNS TopicArn event destination.
+     * An object that contains information about an event destination that sends logging events to Amazon SNS.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-eventdestination.html#cfn-smsvoice-configurationset-eventdestination-snsdestination}
      */
     SnsDestination?: SnsDestination | undefined;
 } | {
     /**
-     * An object that contains IamRoleArn and LogGroupArn associated with an Amazon CloudWatch event destination.
+     * An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-eventdestination.html#cfn-smsvoice-configurationset-eventdestination-cloudwatchlogsdestination}
      */
     CloudWatchLogsDestination?: CloudWatchLogsDestination | undefined;
     /**
-     * When set to true events will be logged. By default this is set to true
+     * When set to true events will be logged.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-eventdestination.html#cfn-smsvoice-configurationset-eventdestination-enabled}
      */
     Enabled: boolean;
     /**
-     * The name that identifies the event destination.
+     * The name of the EventDestination.
      * @minLength 1
      * @maxLength 64
      * @pattern ^[A-Za-z0-9_-]+$
@@ -165,22 +181,27 @@ export type EventDestination = {
      */
     EventDestinationName: string;
     /**
-     * An object that contains IamRoleArn and DeliveryStreamArn associated with an Amazon Kinesis Firehose event destination.
+     * An object that contains information about an event destination for logging to Amazon Data Firehose.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-eventdestination.html#cfn-smsvoice-configurationset-eventdestination-kinesisfirehosedestination}
      */
     KinesisFirehoseDestination?: KinesisFirehoseDestination | undefined;
     /**
-     * An array of event types that determine which events to log. If 'ALL' is used, then AWS End User Messaging SMS and Voice logs every event type.
+     * An array of event types that determine which events to log.
+     *
+     * > The `TEXT_SENT` event type is not supported.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-eventdestination.html#cfn-smsvoice-configurationset-eventdestination-matchingeventtypes}
      */
     MatchingEventTypes: string[];
     /**
-     * An object that contains SNS TopicArn event destination.
+     * An object that contains information about an event destination that sends logging events to Amazon SNS.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-eventdestination.html#cfn-smsvoice-configurationset-eventdestination-snsdestination}
      */
     SnsDestination: SnsDestination;
 };
 /**
+ * Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the AWS Identity and Access Management (IAM) role associated with a Firehose event destination.
+ *
+ * Event destinations, such as Firehose, are associated with configuration sets, which enable you to publish message sending events.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-kinesisfirehosedestination.html}
  */
 export type KinesisFirehoseDestination = {
@@ -191,13 +212,14 @@ export type KinesisFirehoseDestination = {
      */
     DeliveryStreamArn: string;
     /**
-     * The Amazon Resource Name (ARN) of an AWS Identity and Access Management role that is able to write event data to an Amazon CloudWatch destination.
+     * The ARN of an AWS Identity and Access Management role that is able to write event data to an Amazon Data Firehose destination.
      * @pattern ^arn:\S+$
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-kinesisfirehosedestination.html#cfn-smsvoice-configurationset-kinesisfirehosedestination-iamrolearn}
      */
     IamRoleArn: string;
 };
 /**
+ * An object that defines an Amazon SNS destination for events. You can use Amazon SNS to send notification when certain events occur.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-configurationset-snsdestination.html}
  */
 export type SnsDestination = {

package/out/exports/resources.generated/aws-smsvoice-optoutlist.d.ts

@@ -1,16 +1,24 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
 /**
- * Resource Type definition for AWS::SMSVOICE::OptOutList
+ * Creates a new opt-out list.
+ *
+ * If the opt-out list name already exists, an error is returned.
+ *
+ * An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see [SMS opt out](https://docs.aws.amazon.com/sms-voice/latest/userguide/opt-out-list-keywords.html) in the End User Messaging  User Guide.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-optoutlist.html}
  */
 export type SMSVOICEOptOutList = ResourceDefinitionWithAttributes<"AWS::SMSVOICE::OptOutList", SMSVOICEOptOutListProps, SMSVOICEOptOutListAttribs>;
 /**
- * Resource Type definition for AWS::SMSVOICE::OptOutList
+ * Creates a new opt-out list.
+ *
+ * If the opt-out list name already exists, an error is returned.
+ *
+ * An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see [SMS opt out](https://docs.aws.amazon.com/sms-voice/latest/userguide/opt-out-list-keywords.html) in the End User Messaging  User Guide.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-optoutlist.html}
  */
 export type SMSVOICEOptOutListProps = {
     /**
-     * The name of the new OptOutList.
+     * The name of the OptOutList.
      * @minLength 1
      * @maxLength 64
      * @pattern ^[A-Za-z0-9_-]+$
@@ -18,7 +26,7 @@ export type SMSVOICEOptOutListProps = {
      */
     OptOutListName?: string | undefined;
     /**
-     * An array of key-value pairs to apply to this resource.
+     * An array of tags (key and value pairs) to associate with the new OptOutList.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-optoutlist.html#cfn-smsvoice-optoutlist-tags}
      */
     Tags?: Tag[] | undefined;
@@ -28,7 +36,7 @@ export type SMSVOICEOptOutListProps = {
  */
 export type SMSVOICEOptOutListAttribs = {
     /**
-     * The Amazon Resource Name (ARN) for the OptOutList.
+     * The Amazon Resource Name (ARN) for the `OptOutList` .
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-optoutlist.html#cfn-smsvoice-optoutlist-arn}
      */
     Arn: string;

package/out/exports/resources.generated/aws-smsvoice-phonenumber.d.ts

@@ -1,16 +1,20 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
 /**
- * Resource Type definition for AWS::SMSVOICE::PhoneNumber
+ * Request an origination phone number for use in your account. For more information on phone number request see [Request a phone number](https://docs.aws.amazon.com/sms-voice/latest/userguide/phone-numbers-request.html) in the *End User Messaging  User Guide* .
+ *
+ * > Registering phone numbers is not supported by AWS CloudFormation . You can import phone numbers and sender IDs that are automatically provisioned at registration.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html}
  */
 export type SMSVOICEPhoneNumber = ResourceDefinitionWithAttributes<"AWS::SMSVOICE::PhoneNumber", SMSVOICEPhoneNumberProps, SMSVOICEPhoneNumberAttribs>;
 /**
- * Resource Type definition for AWS::SMSVOICE::PhoneNumber
+ * Request an origination phone number for use in your account. For more information on phone number request see [Request a phone number](https://docs.aws.amazon.com/sms-voice/latest/userguide/phone-numbers-request.html) in the *End User Messaging  User Guide* .
+ *
+ * > Registering phone numbers is not supported by AWS CloudFormation . You can import phone numbers and sender IDs that are automatically provisioned at registration.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html}
  */
 export type SMSVOICEPhoneNumberProps = {
     /**
-     * When set to true the sender ID can't be deleted. By default this is set to false.
+     * By default this is set to false. When set to true the phone number can't be deleted.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-deletionprotectionenabled}
      */
     DeletionProtectionEnabled?: boolean | undefined;
@@ -21,7 +25,7 @@ export type SMSVOICEPhoneNumberProps = {
      */
     IsoCountryCode: string;
     /**
-     * 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, AWS End User Messaging SMS and Voice responds with a customizable message. Keywords "HELP" and "STOP" are mandatory keywords
+     * Creates or updates a `MandatoryKeyword` configuration on an origination phone number For more information, see [Keywords](https://docs.aws.amazon.com/sms-voice/latest/userguide/keywords.html) in the End User Messaging  User Guide.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-mandatorykeywords}
      */
     MandatoryKeywords: {
@@ -35,11 +39,13 @@ export type SMSVOICEPhoneNumberProps = {
     NumberCapabilities: ("SMS" | "VOICE" | "MMS")[];
     /**
      * The type of phone number to request.
+     *
+     * > The `ShortCode` number type is not supported in AWS CloudFormation .
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-numbertype}
      */
     NumberType: "LONG_CODE" | "TOLL_FREE" | "TEN_DLC" | "SIMULATOR";
     /**
-     * The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
+     * The name of the OptOutList associated with the phone number.
      * @minLength 1
      * @maxLength 256
      * @pattern ^[A-Za-z0-9_:/-]+$
@@ -47,22 +53,22 @@ export type SMSVOICEPhoneNumberProps = {
      */
     OptOutListName?: string | undefined;
     /**
-     * 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, AWS End User Messaging SMS and Voice responds with a customizable message.
+     * 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](https://docs.aws.amazon.com/sms-voice/latest/userguide/keywords.html) in the End User Messaging  User Guide.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-optionalkeywords}
      */
     OptionalKeywords?: OptionalKeyword[] | undefined;
     /**
-     * By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice 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 requests.
+     * 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](https://docs.aws.amazon.com/sms-voice/latest/userguide/opt-out-list-self-managed.html)
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-selfmanagedoptoutsenabled}
      */
     SelfManagedOptOutsEnabled?: boolean | undefined;
     /**
-     * An array of key-value pairs to apply to this resource.
+     * An array of tags (key and value pairs) to associate with the requested phone number.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-tags}
      */
     Tags?: Tag[] | undefined;
     /**
-     * When you set up two-way SMS, you can receive incoming messages from your customers. When one of your customers sends a message to your phone number, the message body is sent to an Amazon SNS topic or Amazon Connect for processing.
+     * Describes the two-way SMS configuration for a phone number. For more information, see [Two-way SMS messaging](https://docs.aws.amazon.com/sms-voice/latest/userguide/two-way-sms.html) in the End User Messaging  User Guide.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-twoway}
      */
     TwoWay?: {
@@ -87,24 +93,28 @@ export type SMSVOICEPhoneNumberProps = {
  */
 export type SMSVOICEPhoneNumberAttribs = {
     /**
+     * The `PhoneNumber` 's Amazon Resource Name (ARN)
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-arn}
      */
     Arn: string;
     /**
+     * The phone number in E.164 format.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-phonenumber}
      */
     PhoneNumber: string;
     /**
+     * The unique identifier for the phone number.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-phonenumberid}
      */
     PhoneNumberId: string;
 };
 /**
- * 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, AWS End User Messaging SMS and Voice responds with a customizable message. Keywords "HELP" and "STOP" are mandatory keywords
+ * The keywords `HELP` and `STOP` are mandatory keywords that each phone number must have. For more information, see [Keywords](https://docs.aws.amazon.com/sms-voice/latest/userguide/keywords.html) in the End User Messaging  User Guide.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-mandatorykeyword.html}
  */
 export type MandatoryKeyword = {
     /**
+     * The message associated with the keyword.
      * @maxLength 1600
      * @pattern ^(?!\s*$)[\s\S]+$
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-mandatorykeyword.html#cfn-smsvoice-phonenumber-mandatorykeyword-message}
@@ -112,21 +122,24 @@ export type MandatoryKeyword = {
     Message: string;
 };
 /**
- * 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, AWS End User Messaging SMS and Voice responds with a customizable message.
+ * The `OptionalKeyword` configuration. For more information, see [Keywords](https://docs.aws.amazon.com/sms-voice/latest/userguide/keywords.html) in the End User Messaging  User Guide.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-optionalkeyword.html}
  */
 export type OptionalKeyword = {
     /**
+     * The action to perform when the keyword is used.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-optionalkeyword.html#cfn-smsvoice-phonenumber-optionalkeyword-action}
      */
     Action: "AUTOMATIC_RESPONSE" | "OPT_OUT" | "OPT_IN";
     /**
+     * The new keyword to add.
      * @maxLength 30
      * @pattern ^(?!.*(?i)(stop|help))[ \S]+
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-optionalkeyword.html#cfn-smsvoice-phonenumber-optionalkeyword-keyword}
      */
     Keyword: string;
     /**
+     * The message associated with the keyword.
      * @maxLength 1600
      * @pattern ^(?!\s*$)[\s\S]+$
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-optionalkeyword.html#cfn-smsvoice-phonenumber-optionalkeyword-message}

package/out/exports/resources.generated/aws-smsvoice-pool.d.ts

@@ -1,21 +1,29 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
 /**
- * Resource Type definition for AWS::SMSVOICE::Pool
+ * Creates a new pool and associates the specified origination identity to the pool. 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 {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html}
  */
 export type SMSVOICEPool = ResourceDefinitionWithAttributes<"AWS::SMSVOICE::Pool", SMSVOICEPoolProps, SMSVOICEPoolAttribs>;
 /**
- * Resource Type definition for AWS::SMSVOICE::Pool
+ * Creates a new pool and associates the specified origination identity to the pool. 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 {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html}
  */
 export type SMSVOICEPoolProps = {
     /**
-     * When set to true the pool can't be deleted. By default this is set to false.
+     * When set to true the pool can't be deleted.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html#cfn-smsvoice-pool-deletionprotectionenabled}
      */
     DeletionProtectionEnabled?: boolean | undefined;
     /**
-     * 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, AWS End User Messaging SMS and Voice responds with a customizable message. Keywords "HELP" and "STOP" are mandatory keywords
+     * Creates or updates the pool's `MandatoryKeyword` configuration. For more information, see [Keywords](https://docs.aws.amazon.com/sms-voice/latest/userguide/keywords.html) in the End User Messaging  User Guide.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html#cfn-smsvoice-pool-mandatorykeywords}
      */
     MandatoryKeywords: {
@@ -23,7 +31,7 @@ export type SMSVOICEPoolProps = {
         STOP: MandatoryKeyword;
     };
     /**
-     * The name of the OptOutList to associate with the pool. You can use the OptOutListName or OptOutListArn.
+     * The name of the OptOutList associated with the pool.
      * @minLength 1
      * @maxLength 256
      * @pattern ^[A-Za-z0-9_:/-]+$
@@ -31,32 +39,36 @@ export type SMSVOICEPoolProps = {
      */
     OptOutListName?: string | undefined;
     /**
-     * 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, AWS End User Messaging SMS and Voice responds with a customizable message.
+     * Specifies any optional keywords to associate with the pool. For more information, see [Keywords](https://docs.aws.amazon.com/sms-voice/latest/userguide/keywords.html) in the End User Messaging  User Guide.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html#cfn-smsvoice-pool-optionalkeywords}
      */
     OptionalKeywords?: OptionalKeyword[] | undefined;
     /**
-     * The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn and it's IsoCountryCode.
+     * The list of origination identities to apply to the pool, either `PhoneNumberArn` or `SenderIdArn` . For more information, see [Registrations](https://docs.aws.amazon.com/sms-voice/latest/userguide/registrations.html) in the End User Messaging  User Guide.
+     *
+     * > If you are using a shared End User Messaging  resource then you must use the full Amazon Resource Name (ARN).
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html#cfn-smsvoice-pool-originationidentities}
      */
     OriginationIdentities: string[];
     /**
-     * By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice 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 requests.
+     * 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. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests. For more information see [Self-managed opt-outs](https://docs.aws.amazon.com//pinpoint/latest/userguide/settings-sms-managing.html#settings-account-sms-self-managed-opt-out)
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html#cfn-smsvoice-pool-selfmanagedoptoutsenabled}
      */
     SelfManagedOptOutsEnabled?: boolean | undefined;
     /**
-     * Indicates whether shared routes are enabled for the pool.
+     * Allows you to enable shared routes on your pool.
+     *
+     * By default, this is set to `False` . If you set this value to `True` , your messages are sent using phone numbers or sender IDs (depending on the country) that are shared with other users. In some countries, such as the United States, senders aren't allowed to use shared routes and must use a dedicated phone number or short code.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html#cfn-smsvoice-pool-sharedroutesenabled}
      */
     SharedRoutesEnabled?: boolean | undefined;
     /**
-     * An array of key-value pairs to apply to this resource.
+     * An array of tags (key and value pairs) associated with the pool.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html#cfn-smsvoice-pool-tags}
      */
     Tags?: Tag[] | undefined;
     /**
-     * When you set up two-way SMS, you can receive incoming messages from your customers. When one of your customers sends a message to your phone number, the message body is sent to an Amazon SNS topic or Amazon Connect for processing.
+     * Describes the two-way SMS configuration for a phone number. For more information, see [Two-way SMS messaging](https://docs.aws.amazon.com/sms-voice/latest/userguide/two-way-sms.html) in the End User Messaging  User Guide.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html#cfn-smsvoice-pool-twoway}
      */
     TwoWay?: {
@@ -81,20 +93,23 @@ export type SMSVOICEPoolProps = {
  */
 export type SMSVOICEPoolAttribs = {
     /**
+     * The Amazon Resource Name of the `Pool` .
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html#cfn-smsvoice-pool-arn}
      */
     Arn: string;
     /**
+     * The unique identifier for the pool.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html#cfn-smsvoice-pool-poolid}
      */
     PoolId: string;
 };
 /**
- * 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, AWS End User Messaging SMS and Voice responds with a customizable message. Keywords "HELP" and "STOP" are mandatory keywords
+ * The keywords `HELP` and `STOP` are mandatory keywords that each phone number must have. For more information, see [Keywords](https://docs.aws.amazon.com/sms-voice/latest/userguide/keywords.html) in the End User Messaging  User Guide.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-pool-mandatorykeyword.html}
  */
 export type MandatoryKeyword = {
     /**
+     * The message associated with the keyword.
      * @maxLength 1600
      * @pattern ^(?!\s*$)[\s\S]+$
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-pool-mandatorykeyword.html#cfn-smsvoice-pool-mandatorykeyword-message}
@@ -102,21 +117,24 @@ export type MandatoryKeyword = {
     Message: string;
 };
 /**
- * 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, AWS End User Messaging SMS and Voice responds with a customizable message.
+ * The pool's `OptionalKeyword` configuration. For more information, see [Keywords](https://docs.aws.amazon.com/sms-voice/latest/userguide/keywords.html) in the End User Messaging  User Guide.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-pool-optionalkeyword.html}
  */
 export type OptionalKeyword = {
     /**
+     * The action to perform when the keyword is used.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-pool-optionalkeyword.html#cfn-smsvoice-pool-optionalkeyword-action}
      */
     Action: "AUTOMATIC_RESPONSE" | "OPT_OUT" | "OPT_IN";
     /**
+     * The new keyword to add.
      * @maxLength 30
      * @pattern ^(?!.*(?i)(stop|help))[ \S]+
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-pool-optionalkeyword.html#cfn-smsvoice-pool-optionalkeyword-keyword}
      */
     Keyword: string;
     /**
+     * The message associated with the keyword.
      * @maxLength 1600
      * @pattern ^(?!\s*$)[\s\S]+$
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-pool-optionalkeyword.html#cfn-smsvoice-pool-optionalkeyword-message}