@propulsionworks/cloudformation 0.0.1 → 0.1.0

package/out/exports/resources.generated/aws-wisdom-messagetemplate.d.ts

@@ -0,0 +1,615 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type WisdomMessageTemplate = ResourceDefinitionWithAttributes<"AWS::Wisdom::MessageTemplate", WisdomMessageTemplateProps, WisdomMessageTemplateAttribs>;
+/**
+ * Creates an Amazon Q in Connect message template. The name of the message template has to be unique for each knowledge base. The channel subtype of the message template is immutable and cannot be modified after creation. After the message template is created, you can use the `$LATEST` qualifier to reference the created message template.
+ */
+export type WisdomMessageTemplateProps = {
+    /**
+     * The channel subtype this message template applies to.
+     */
+    ChannelSubtype: ChannelSubtype;
+    /**
+     * The content of the message template.
+     */
+    Content: Content;
+    /**
+     * An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.
+     */
+    DefaultAttributes?: MessageTemplateAttributes | undefined;
+    /**
+     * The description of the message template.
+     * @minLength 1
+     * @maxLength 255
+     * @pattern ^[a-zA-Z0-9\\s_.,-]+
+     */
+    Description?: string | undefined;
+    /**
+     * The configuration information of the external data source.
+     */
+    GroupingConfiguration?: GroupingConfiguration | undefined;
+    /**
+     * The Amazon Resource Name (ARN) of the knowledge base.
+     * @pattern ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$
+     */
+    KnowledgeBaseArn: string;
+    /**
+     * The language code value for the language in which the quick response is written. The supported language codes include `de_DE` , `en_US` , `es_ES` , `fr_FR` , `id_ID` , `it_IT` , `ja_JP` , `ko_KR` , `pt_BR` , `zh_CN` , `zh_TW`
+     * @minLength 2
+     * @maxLength 5
+     */
+    Language?: string | undefined;
+    /**
+     * The name of the message template.
+     * @minLength 1
+     * @maxLength 255
+     * @pattern ^[a-zA-Z0-9\\s_.,-]+
+     */
+    Name: string;
+    /**
+     * The tags used to organize, track, or control access for this resource.
+     */
+    Tags?: Tag[] | undefined;
+};
+export type WisdomMessageTemplateAttribs = {
+    /**
+     * The Amazon Resource Name (ARN) of the message template.
+     * @pattern ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$
+     */
+    MessageTemplateArn: string;
+    /**
+     * The checksum value of the message template content that is referenced by the `$LATEST` qualifier. It can be returned in `MessageTemplateData` or `ExtendedMessageTemplateData` . It’s calculated by content, language, `defaultAttributes` and `Attachments` of the message template.
+     * @minLength 1
+     * @maxLength 64
+     */
+    MessageTemplateContentSha256: string;
+    /**
+     * The identifier of the message template.
+     * @pattern ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
+     */
+    MessageTemplateId: string;
+};
+/**
+ * Information about an agent.
+ */
+export type AgentAttributes = {
+    /**
+     * The agent’s first name as entered in their Amazon Connect user account.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    FirstName?: string | undefined;
+    /**
+     * The agent’s last name as entered in their Amazon Connect user account.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    LastName?: string | undefined;
+};
+/**
+ * The channel subtype this message template applies to.
+ */
+export type ChannelSubtype = "EMAIL" | "SMS";
+/**
+ * The content of the message template.
+ */
+export type Content = {
+    /**
+     * The content of the message template that applies to the email channel subtype.
+     */
+    EmailMessageTemplateContent: EmailMessageTemplateContent;
+    /**
+     * The content of message template that applies to SMS channel subtype.
+     */
+    SmsMessageTemplateContent?: SmsMessageTemplateContent | undefined;
+} | {
+    /**
+     * The content of the message template that applies to the email channel subtype.
+     */
+    EmailMessageTemplateContent?: EmailMessageTemplateContent | undefined;
+    /**
+     * The content of message template that applies to SMS channel subtype.
+     */
+    SmsMessageTemplateContent: SmsMessageTemplateContent;
+};
+/**
+ * The customer profile attributes that are used with the message template.
+ */
+export type CustomerProfileAttributes = {
+    /**
+     * A unique account number that you have given to the customer.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    AccountNumber?: string | undefined;
+    /**
+     * Any additional information relevant to the customer's profile.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    AdditionalInformation?: string | undefined;
+    /**
+     * The first line of a customer address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    Address1?: string | undefined;
+    /**
+     * The second line of a customer address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    Address2?: string | undefined;
+    /**
+     * The third line of a customer address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    Address3?: string | undefined;
+    /**
+     * The fourth line of a customer address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    Address4?: string | undefined;
+    /**
+     * The first line of a customer’s billing address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    BillingAddress1?: string | undefined;
+    /**
+     * The second line of a customer’s billing address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    BillingAddress2?: string | undefined;
+    /**
+     * The third line of a customer’s billing address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    BillingAddress3?: string | undefined;
+    /**
+     * The fourth line of a customer’s billing address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    BillingAddress4?: string | undefined;
+    /**
+     * The city of a customer’s billing address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    BillingCity?: string | undefined;
+    /**
+     * The country of a customer’s billing address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    BillingCountry?: string | undefined;
+    /**
+     * The county of a customer’s billing address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    BillingCounty?: string | undefined;
+    /**
+     * The postal code of a customer’s billing address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    BillingPostalCode?: string | undefined;
+    /**
+     * The province of a customer’s billing address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    BillingProvince?: string | undefined;
+    /**
+     * The state of a customer’s billing address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    BillingState?: string | undefined;
+    /**
+     * The customer's birth date.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    BirthDate?: string | undefined;
+    /**
+     * The customer's business email address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    BusinessEmailAddress?: string | undefined;
+    /**
+     * The name of the customer's business.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    BusinessName?: string | undefined;
+    /**
+     * The customer's business phone number.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    BusinessPhoneNumber?: string | undefined;
+    /**
+     * The city in which a customer lives.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    City?: string | undefined;
+    /**
+     * The country in which a customer lives.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    Country?: string | undefined;
+    /**
+     * The county in which a customer lives.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    County?: string | undefined;
+    /**
+     * The custom attributes in customer profile attributes.
+     */
+    Custom?: Record<string, string> | undefined;
+    /**
+     * The customer's email address, which has not been specified as a personal or business address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    EmailAddress?: string | undefined;
+    /**
+     * The customer's first name.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    FirstName?: string | undefined;
+    /**
+     * The customer's gender.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    Gender?: string | undefined;
+    /**
+     * The customer's mobile phone number.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    HomePhoneNumber?: string | undefined;
+    /**
+     * The customer's last name.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    LastName?: string | undefined;
+    /**
+     * The first line of a customer’s mailing address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    MailingAddress1?: string | undefined;
+    /**
+     * The second line of a customer’s mailing address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    MailingAddress2?: string | undefined;
+    /**
+     * The third line of a customer’s mailing address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    MailingAddress3?: string | undefined;
+    /**
+     * The fourth line of a customer’s mailing address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    MailingAddress4?: string | undefined;
+    /**
+     * The city of a customer’s mailing address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    MailingCity?: string | undefined;
+    /**
+     * The country of a customer’s mailing address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    MailingCountry?: string | undefined;
+    /**
+     * The county of a customer’s mailing address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    MailingCounty?: string | undefined;
+    /**
+     * The postal code of a customer’s mailing address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    MailingPostalCode?: string | undefined;
+    /**
+     * The province of a customer’s mailing address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    MailingProvince?: string | undefined;
+    /**
+     * The state of a customer’s mailing address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    MailingState?: string | undefined;
+    /**
+     * The customer's middle name.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    MiddleName?: string | undefined;
+    /**
+     * The customer's mobile phone number.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    MobilePhoneNumber?: string | undefined;
+    /**
+     * The customer's party type.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    PartyType?: string | undefined;
+    /**
+     * The customer's phone number, which has not been specified as a mobile, home, or business number.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    PhoneNumber?: string | undefined;
+    /**
+     * The postal code of a customer address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    PostalCode?: string | undefined;
+    /**
+     * The ARN of a customer profile.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    ProfileARN?: string | undefined;
+    /**
+     * The unique identifier of a customer profile.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    ProfileId?: string | undefined;
+    /**
+     * The province in which a customer lives.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    Province?: string | undefined;
+    /**
+     * The first line of a customer’s shipping address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    ShippingAddress1?: string | undefined;
+    /**
+     * The second line of a customer’s shipping address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    ShippingAddress2?: string | undefined;
+    /**
+     * The third line of a customer’s shipping address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    ShippingAddress3?: string | undefined;
+    /**
+     * The fourth line of a customer’s shipping address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    ShippingAddress4?: string | undefined;
+    /**
+     * The city of a customer’s shipping address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    ShippingCity?: string | undefined;
+    /**
+     * The country of a customer’s shipping address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    ShippingCountry?: string | undefined;
+    /**
+     * The county of a customer’s shipping address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    ShippingCounty?: string | undefined;
+    /**
+     * The postal code of a customer’s shipping address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    ShippingPostalCode?: string | undefined;
+    /**
+     * The province of a customer’s shipping address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    ShippingProvince?: string | undefined;
+    /**
+     * The state of a customer’s shipping address.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    ShippingState?: string | undefined;
+    /**
+     * The state in which a customer lives.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    State?: string | undefined;
+};
+/**
+ * The content of the message template that applies to the email channel subtype.
+ */
+export type EmailMessageTemplateContent = {
+    /**
+     * The body to use in email messages.
+     */
+    Body: EmailMessageTemplateContentBody;
+    /**
+     * The email headers to include in email messages.
+     */
+    Headers: EmailMessageTemplateHeader[];
+    /**
+     * The subject line, or title, to use in email messages.
+     * @minLength 1
+     */
+    Subject: string;
+};
+/**
+ * The body to use in email messages.
+ */
+export type EmailMessageTemplateContentBody = {
+    /**
+     * The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
+     */
+    Html?: MessageTemplateBodyContentProvider | undefined;
+    /**
+     * The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.
+     */
+    PlainText?: MessageTemplateBodyContentProvider | undefined;
+};
+/**
+ * The email headers to include in email messages.
+ */
+export type EmailMessageTemplateHeader = {
+    /**
+     * The name of the email header.
+     * @minLength 1
+     * @maxLength 126
+     * @pattern ^[!-9;-@A-~]+$
+     */
+    Name?: string | undefined;
+    /**
+     * The value of the email header.
+     * @minLength 1
+     * @maxLength 870
+     * @pattern [ -~]*
+     */
+    Value?: string | undefined;
+};
+/**
+ * The configuration information of the grouping of Amazon Q in Connect users.
+ */
+export type GroupingConfiguration = {
+    /**
+     * The criteria used for grouping Amazon Q in Connect users.
+     *
+     * The following is the list of supported criteria values.
+     *
+     * - `RoutingProfileArn` : Grouping the users by their [Amazon Connect routing profile ARN](https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html) . User should have [SearchRoutingProfile](https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchRoutingProfiles.html) and [DescribeRoutingProfile](https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeRoutingProfile.html) permissions when setting criteria to this value.
+     * @minLength 1
+     * @maxLength 100
+     */
+    Criteria: string;
+    /**
+     * The list of values that define different groups of Amazon Q in Connect users.
+     *
+     * - When setting `criteria` to `RoutingProfileArn` , you need to provide a list of ARNs of [Amazon Connect routing profiles](https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html) as values of this parameter.
+     */
+    Values: string[];
+};
+/**
+ * The attributes that are used with the message template.
+ */
+export type MessageTemplateAttributes = {
+    /**
+     * The agent attributes that are used with the message template.
+     */
+    AgentAttributes?: AgentAttributes | undefined;
+    /**
+     * The custom attributes that are used with the message template.
+     */
+    CustomAttributes?: Record<string, string> | undefined;
+    /**
+     * The customer profile attributes that are used with the message template.
+     */
+    CustomerProfileAttributes?: CustomerProfileAttributes | undefined;
+    /**
+     * The system attributes that are used with the message template.
+     */
+    SystemAttributes?: SystemAttributes | undefined;
+};
+/**
+ * The container of the message template body.
+ */
+export type MessageTemplateBodyContentProvider = {
+    /**
+     * The content of the message template.
+     * @minLength 1
+     */
+    Content?: string | undefined;
+};
+/**
+ * The content of the message template that applies to the SMS channel subtype.
+ */
+export type SmsMessageTemplateContent = {
+    /**
+     * The body to use in SMS messages.
+     */
+    Body: SmsMessageTemplateContentBody;
+};
+/**
+ * The body to use in SMS messages.
+ */
+export type SmsMessageTemplateContentBody = {
+    /**
+     * The message body to use in SMS messages.
+     */
+    PlainText?: MessageTemplateBodyContentProvider | undefined;
+};
+/**
+ * The system attributes that are used with the message template.
+ */
+export type SystemAttributes = {
+    /**
+     * The CustomerEndpoint attribute.
+     */
+    CustomerEndpoint?: SystemEndpointAttributes | undefined;
+    /**
+     * The name of the task.
+     * @minLength 1
+     * @maxLength 32767
+     */
+    Name?: string | undefined;
+    /**
+     * The SystemEndpoint attribute.
+     */
+    SystemEndpoint?: SystemEndpointAttributes | undefined;
+};
+/**
+ * The system endpoint attributes that are used with the message template.
+ */
+export type SystemEndpointAttributes = {
+    /**
+     * The customer's phone number if used with `customerEndpoint` , or the number the customer dialed to call your contact center if used with `systemEndpoint` .
+     * @minLength 1
+     * @maxLength 32767
+     */
+    Address?: string | undefined;
+};
+//# sourceMappingURL=aws-wisdom-messagetemplate.d.ts.map

package/out/exports/resources.generated/aws-wisdom-messagetemplateversion.d.ts

@@ -0,0 +1,30 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type WisdomMessageTemplateVersion = ResourceDefinitionWithAttributes<"AWS::Wisdom::MessageTemplateVersion", WisdomMessageTemplateVersionProps, WisdomMessageTemplateVersionAttribs>;
+/**
+ * Creates a new Amazon Q in Connect message template version from the current content and configuration of a message template. Versions are immutable and monotonically increasing. Once a version is created, you can reference a specific version of the message template by passing in `<messageTemplateArn>:<versionNumber>` as the message template identifier. An error is displayed if the supplied `messageTemplateContentSha256` is different from the `messageTemplateContentSha256` of the message template with `$LATEST` qualifier. If multiple `CreateMessageTemplateVersion` requests are made while the message template remains the same, only the first invocation creates a new version and the succeeding requests will return the same response as the first invocation.
+ */
+export type WisdomMessageTemplateVersionProps = {
+    /**
+     * The Amazon Resource Name (ARN) of the message template.
+     * @pattern ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$
+     */
+    MessageTemplateArn: string;
+    /**
+     * The content SHA256 of the message template.
+     * @minLength 1
+     * @maxLength 64
+     */
+    MessageTemplateContentSha256?: string | undefined;
+};
+export type WisdomMessageTemplateVersionAttribs = {
+    /**
+     * The Amazon Resource Name (ARN) of the Message Template Version.
+     * @pattern ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}):[0-9]+?$
+     */
+    MessageTemplateVersionArn: string;
+    /**
+     * The version number for this Message Template Version.
+     */
+    MessageTemplateVersionNumber: number;
+};
+//# sourceMappingURL=aws-wisdom-messagetemplateversion.d.ts.map

package/out/exports/resources.generated/aws-workspaces-connectionalias.d.ts

@@ -0,0 +1,32 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type WorkSpacesConnectionAlias = ResourceDefinitionWithAttributes<"AWS::WorkSpaces::ConnectionAlias", WorkSpacesConnectionAliasProps, WorkSpacesConnectionAliasAttribs>;
+/**
+ * The `AWS::WorkSpaces::ConnectionAlias` resource specifies a connection alias. Connection aliases are used for cross-Region redirection. For more information, see [Cross-Region Redirection for Amazon WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html) .
+ */
+export type WorkSpacesConnectionAliasProps = {
+    /**
+     * The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as `www.example.com` .
+     * @minLength 1
+     * @maxLength 255
+     * @pattern ^[.0-9a-zA-Z\-]{1,255}$
+     */
+    ConnectionString: string;
+    /**
+     * The tags to associate with the connection alias.
+     */
+    Tags?: Tag[] | undefined;
+};
+export type WorkSpacesConnectionAliasAttribs = {
+    /**
+     * The identifier of the connection alias, returned as a string.
+     * @minLength 13
+     * @maxLength 68
+     * @pattern ^wsca-[0-9a-z]{8,63}$
+     */
+    AliasId: string;
+    /**
+     * The current state of the connection alias, returned as a string.
+     */
+    ConnectionAliasState: "CREATING" | "CREATED" | "DELETING";
+};
+//# sourceMappingURL=aws-workspaces-connectionalias.d.ts.map