@propulsionworks/cloudformation 0.0.1 → 0.1.0

package/out/exports/resources.generated/aws-pinpoint-smschannel.d.ts

@@ -0,0 +1,36 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type PinpointSMSChannel = ResourceDefinitionWithAttributes<"AWS::Pinpoint::SMSChannel", PinpointSMSChannelProps, PinpointSMSChannelAttribs>;
+/**
+ * A *channel* is a type of platform that you can deliver messages to. To send an SMS text message, you send the message through the SMS channel. Before you can use Amazon Pinpoint to send text messages, you have to enable the SMS channel for an Amazon Pinpoint application.
+ *
+ * The SMSChannel resource represents the status, sender ID, and other settings for the SMS channel for an application.
+ */
+export type PinpointSMSChannelProps = {
+    /**
+     * The unique identifier for the Amazon Pinpoint application that the SMS channel applies to.
+     */
+    ApplicationId: string;
+    /**
+     * Specifies whether to enable the SMS channel for the application.
+     */
+    Enabled?: boolean | undefined;
+    /**
+     * The identity that you want to display on recipients' devices when they receive messages from the SMS channel.
+     *
+     * > SenderIDs are only supported in certain countries and regions. For more information, see [Supported Countries and Regions](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-countries.html) in the *Amazon Pinpoint User Guide* .
+     */
+    SenderId?: string | undefined;
+    /**
+     * The registered short code that you want to use when you send messages through the SMS channel.
+     *
+     * > For information about obtaining a dedicated short code for sending SMS messages, see [Requesting Dedicated Short Codes for SMS Messaging with Amazon Pinpoint](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-awssupport-short-code.html) in the *Amazon Pinpoint User Guide* .
+     */
+    ShortCode?: string | undefined;
+};
+export type PinpointSMSChannelAttribs = {
+    /**
+     * (Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.
+     */
+    Id: string;
+};
+//# sourceMappingURL=aws-pinpoint-smschannel.d.ts.map

package/out/exports/resources.generated/aws-pinpoint-smstemplate.d.ts

@@ -0,0 +1,37 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type PinpointSmsTemplate = ResourceDefinitionWithAttributes<"AWS::Pinpoint::SmsTemplate", PinpointSmsTemplateProps, PinpointSmsTemplateAttribs>;
+/**
+ * Creates a message template that you can use in messages that are sent through the SMS channel. A *message template* is a set of content and settings that you can define, save, and reuse in messages for any of your Amazon Pinpoint applications.
+ */
+export type PinpointSmsTemplateProps = {
+    /**
+     * The message body to use in text messages that are based on the message template.
+     */
+    Body: string;
+    /**
+     * A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
+     */
+    DefaultSubstitutions?: string | undefined;
+    /**
+     * An array of key-value pairs to apply to this resource.
+     *
+     * For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
+     */
+    Tags?: Record<string, unknown> | undefined;
+    /**
+     * A custom description of the message template.
+     */
+    TemplateDescription?: string | undefined;
+    /**
+     * The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
+     */
+    TemplateName: string;
+};
+export type PinpointSmsTemplateAttribs = {
+    /**
+     * The Amazon Resource Name (ARN) of the message template.
+     */
+    Arn: string;
+    Id: string;
+};
+//# sourceMappingURL=aws-pinpoint-smstemplate.d.ts.map

package/out/exports/resources.generated/aws-pinpoint-voicechannel.d.ts

@@ -0,0 +1,24 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type PinpointVoiceChannel = ResourceDefinitionWithAttributes<"AWS::Pinpoint::VoiceChannel", PinpointVoiceChannelProps, PinpointVoiceChannelAttribs>;
+/**
+ * A *channel* is a type of platform that you can deliver messages to. To send a voice message, you send the message through the voice channel. Before you can use Amazon Pinpoint to send voice messages, you have to enable the voice channel for an Amazon Pinpoint application.
+ *
+ * The VoiceChannel resource represents the status and other information about the voice channel for an application.
+ */
+export type PinpointVoiceChannelProps = {
+    /**
+     * The unique identifier for the Amazon Pinpoint application that the voice channel applies to.
+     */
+    ApplicationId: string;
+    /**
+     * Specifies whether to enable the voice channel for the application.
+     */
+    Enabled?: boolean | undefined;
+};
+export type PinpointVoiceChannelAttribs = {
+    /**
+     * (Deprecated) An identifier for the voice channel. This property is retained only for backward compatibility.
+     */
+    Id: string;
+};
+//# sourceMappingURL=aws-pinpoint-voicechannel.d.ts.map

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

@@ -0,0 +1,73 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type PinpointEmailConfigurationSet = ResourceDefinitionWithAttributes<"AWS::PinpointEmail::ConfigurationSet", PinpointEmailConfigurationSetProps, PinpointEmailConfigurationSetAttribs>;
+/**
+ * Create a configuration set. *Configuration sets* are groups of rules that you can apply to the emails you send using Amazon Pinpoint. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
+ */
+export type PinpointEmailConfigurationSetProps = {
+    /**
+     * An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.
+     */
+    DeliveryOptions?: DeliveryOptions | undefined;
+    /**
+     * The name of the configuration set.
+     */
+    Name: string;
+    /**
+     * An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send that use the configuration set.
+     */
+    ReputationOptions?: ReputationOptions | undefined;
+    /**
+     * An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set.
+     */
+    SendingOptions?: SendingOptions | undefined;
+    /**
+     * An object that defines the tags (keys and values) that you want to associate with the configuration set.
+     */
+    Tags?: Tag[] | undefined;
+    /**
+     * An object that defines the open and click tracking options for emails that you send using the configuration set.
+     */
+    TrackingOptions?: TrackingOptions | undefined;
+};
+export type PinpointEmailConfigurationSetAttribs = {
+    Id: string;
+};
+/**
+ * Used to associate a configuration set with a dedicated IP pool.
+ */
+export type DeliveryOptions = {
+    /**
+     * The name of the dedicated IP pool that you want to associate with the configuration set.
+     */
+    SendingPoolName?: string | undefined;
+};
+/**
+ * Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current AWS Region.
+ */
+export type ReputationOptions = {
+    /**
+     * If `true` , tracking of reputation metrics is enabled for the configuration set. If `false` , tracking of reputation metrics is disabled for the configuration set.
+     */
+    ReputationMetricsEnabled?: boolean | undefined;
+};
+/**
+ * Used to enable or disable email sending for messages that use this configuration set in the current AWS Region.
+ */
+export type SendingOptions = {
+    /**
+     * If `true` , email sending is enabled for the configuration set. If `false` , email sending is disabled for the configuration set.
+     */
+    SendingEnabled?: boolean | undefined;
+};
+/**
+ * An object that defines the tracking options for a configuration set. When you use Amazon Pinpoint to send an email, it contains an invisible image that's used to track when recipients open your email. If your email contains links, those links are changed slightly in order to track when recipients click them.
+ *
+ * These images and links include references to a domain operated by AWS . You can optionally configure Amazon Pinpoint to use a domain that you operate for these images and links.
+ */
+export type TrackingOptions = {
+    /**
+     * The domain that you want to use for tracking open and click events.
+     */
+    CustomRedirectDomain?: string | undefined;
+};
+//# sourceMappingURL=aws-pinpointemail-configurationset.d.ts.map

package/out/exports/resources.generated/aws-pinpointemail-configurationseteventdestination.d.ts

@@ -0,0 +1,121 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type PinpointEmailConfigurationSetEventDestination = ResourceDefinitionWithAttributes<"AWS::PinpointEmail::ConfigurationSetEventDestination", PinpointEmailConfigurationSetEventDestinationProps, PinpointEmailConfigurationSetEventDestinationAttribs>;
+/**
+ * Create an event destination. In Amazon Pinpoint, *events* include message sends, deliveries, opens, clicks, bounces, and complaints. *Event destinations* are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
+ *
+ * A single configuration set can include more than one event destination.
+ */
+export type PinpointEmailConfigurationSetEventDestinationProps = {
+    /**
+     * The name of the configuration set that contains the event destination that you want to modify.
+     */
+    ConfigurationSetName: string;
+    /**
+     * An object that defines the event destination.
+     */
+    EventDestination?: EventDestination | undefined;
+    /**
+     * The name of the event destination that you want to modify.
+     */
+    EventDestinationName: string;
+};
+export type PinpointEmailConfigurationSetEventDestinationAttribs = {
+    Id: string;
+};
+/**
+ * An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.
+ */
+export type CloudWatchDestination = {
+    /**
+     * An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.
+     */
+    DimensionConfigurations?: DimensionConfiguration[] | undefined;
+};
+/**
+ * An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.
+ */
+export type DimensionConfiguration = {
+    /**
+     * The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:
+     *
+     * - It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
+     * - It can contain no more than 256 characters.
+     */
+    DefaultDimensionValue: string;
+    /**
+     * The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:
+     *
+     * - It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
+     * - It can contain no more than 256 characters.
+     */
+    DimensionName: string;
+    /**
+     * The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. Acceptable values: `MESSAGE_TAG` , `EMAIL_HEADER` , and `LINK_TAG` .
+     *
+     * If you want Amazon Pinpoint to use the message tags that you specify using an `X-SES-MESSAGE-TAGS` header or a parameter to the `SendEmail` API, choose `MESSAGE_TAG` . If you want Amazon Pinpoint to use your own email headers, choose `EMAIL_HEADER` . If you want Amazon Pinpoint to use tags that are specified in your links, choose `LINK_TAG` .
+     */
+    DimensionValueSource: string;
+};
+/**
+ * In Amazon Pinpoint, *events* include message sends, deliveries, opens, clicks, bounces, and complaints. *Event destinations* are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
+ */
+export type EventDestination = {
+    /**
+     * An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.
+     */
+    CloudWatchDestination?: CloudWatchDestination | undefined;
+    /**
+     * If `true` , the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this `EventDestinationDefinition` .
+     *
+     * If `false` , the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.
+     */
+    Enabled?: boolean | undefined;
+    /**
+     * An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
+     */
+    KinesisFirehoseDestination?: KinesisFirehoseDestination | undefined;
+    /**
+     * The types of events that Amazon Pinpoint sends to the specified event destinations. Acceptable values: `SEND` , `REJECT` , `BOUNCE` , `COMPLAINT` , `DELIVERY` , `OPEN` , `CLICK` , and `RENDERING_FAILURE` .
+     */
+    MatchingEventTypes: string[];
+    /**
+     * An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.
+     */
+    PinpointDestination?: PinpointDestination | undefined;
+    /**
+     * An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
+     */
+    SnsDestination?: SnsDestination | undefined;
+};
+/**
+ * An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
+ */
+export type KinesisFirehoseDestination = {
+    /**
+     * The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that Amazon Pinpoint sends email events to.
+     */
+    DeliveryStreamArn: string;
+    /**
+     * The Amazon Resource Name (ARN) of the IAM role that Amazon Pinpoint uses when sending email events to the Amazon Kinesis Data Firehose stream.
+     */
+    IamRoleArn: string;
+};
+/**
+ * An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.
+ */
+export type PinpointDestination = {
+    /**
+     * The Amazon Resource Name (ARN) of the Amazon Pinpoint project that you want to send email events to.
+     */
+    ApplicationArn?: string | undefined;
+};
+/**
+ * An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
+ */
+export type SnsDestination = {
+    /**
+     * The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish email events to. For more information about Amazon SNS topics, see the [Amazon SNS Developer Guide](https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html) .
+     */
+    TopicArn: string;
+};
+//# sourceMappingURL=aws-pinpointemail-configurationseteventdestination.d.ts.map

package/out/exports/resources.generated/aws-pinpointemail-dedicatedippool.d.ts

@@ -0,0 +1,19 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type PinpointEmailDedicatedIpPool = ResourceDefinitionWithAttributes<"AWS::PinpointEmail::DedicatedIpPool", PinpointEmailDedicatedIpPoolProps, PinpointEmailDedicatedIpPoolAttribs>;
+/**
+ * A request to create a new dedicated IP pool.
+ */
+export type PinpointEmailDedicatedIpPoolProps = {
+    /**
+     * The name of the dedicated IP pool.
+     */
+    PoolName?: string | undefined;
+    /**
+     * An object that defines the tags (keys and values) that you want to associate with the dedicated IP pool.
+     */
+    Tags?: Tag[] | undefined;
+};
+export type PinpointEmailDedicatedIpPoolAttribs = {
+    Id: string;
+};
+//# sourceMappingURL=aws-pinpointemail-dedicatedippool.d.ts.map

package/out/exports/resources.generated/aws-pinpointemail-identity.d.ts

@@ -0,0 +1,84 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type PinpointEmailIdentity = ResourceDefinitionWithAttributes<"AWS::PinpointEmail::Identity", PinpointEmailIdentityProps, PinpointEmailIdentityAttribs>;
+/**
+ * Specifies an identity to use for sending email through Amazon Pinpoint. In Amazon Pinpoint, an *identity* is an email address or domain that you use when you send email. Before you can use Amazon Pinpoint to send an email from an identity, you first have to verify it. By verifying an identity, you demonstrate that you're the owner of the address or domain, and that you've given Amazon Pinpoint permission to send email from that identity.
+ *
+ * When you verify an email address, Amazon Pinpoint sends an email to the address. Your email address is verified as soon as you follow the link in the verification email.
+ *
+ * When you verify a domain, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process.
+ *
+ * > When you use CloudFormation to specify an identity, CloudFormation might indicate that the identity was created successfully. However, you have to verify the identity before you can use it to send email.
+ */
+export type PinpointEmailIdentityProps = {
+    /**
+     * For domain identities, this attribute is used to enable or disable DomainKeys Identified Mail (DKIM) signing for the domain.
+     *
+     * If the value is `true` , then the messages that you send from the domain are signed using both the DKIM keys for your domain, as well as the keys for the `amazonses.com` domain. If the value is `false` , then the messages that you send are only signed using the DKIM keys for the `amazonses.com` domain.
+     */
+    DkimSigningEnabled?: boolean | undefined;
+    /**
+     * Used to enable or disable feedback forwarding for an identity. This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event.
+     *
+     * When you enable feedback forwarding, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.
+     *
+     * When you disable feedback forwarding, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).
+     */
+    FeedbackForwardingEnabled?: boolean | undefined;
+    /**
+     * Used to enable or disable the custom Mail-From domain configuration for an email identity.
+     */
+    MailFromAttributes?: MailFromAttributes | undefined;
+    /**
+     * The address or domain of the identity, such as *sender@example.com* or *example.co.uk* .
+     */
+    Name: string;
+    /**
+     * An object that defines the tags (keys and values) that you want to associate with the email identity.
+     */
+    Tags?: Tag[] | undefined;
+};
+export type PinpointEmailIdentityAttribs = {
+    Id: string;
+    /**
+     * The host name for the first token that you have to add to the DNS configuration for your domain.
+     *
+     * For more information, see [Verifying a Domain](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html#channels-email-manage-verify-domain) in the Amazon Pinpoint User Guide.
+     */
+    IdentityDNSRecordName1: string;
+    /**
+     * The host name for the second token that you have to add to the DNS configuration for your domain.
+     */
+    IdentityDNSRecordName2: string;
+    /**
+     * The host name for the third token that you have to add to the DNS configuration for your domain.
+     */
+    IdentityDNSRecordName3: string;
+    /**
+     * The record value for the first token that you have to add to the DNS configuration for your domain.
+     */
+    IdentityDNSRecordValue1: string;
+    /**
+     * The record value for the second token that you have to add to the DNS configuration for your domain.
+     */
+    IdentityDNSRecordValue2: string;
+    /**
+     * The record value for the third token that you have to add to the DNS configuration for your domain.
+     */
+    IdentityDNSRecordValue3: string;
+};
+/**
+ * A list of attributes that are associated with a MAIL FROM domain.
+ */
+export type MailFromAttributes = {
+    /**
+     * The action that Amazon Pinpoint to takes if it can't read the required MX record for a custom MAIL FROM domain. When you set this value to `UseDefaultValue` , Amazon Pinpoint uses *amazonses.com* as the MAIL FROM domain. When you set this value to `RejectMessage` , Amazon Pinpoint returns a `MailFromDomainNotVerified` error, and doesn't attempt to deliver the email.
+     *
+     * These behaviors are taken when the custom MAIL FROM domain configuration is in the `Pending` , `Failed` , and `TemporaryFailure` states.
+     */
+    BehaviorOnMxFailure?: string | undefined;
+    /**
+     * The name of a domain that an email identity uses as a custom MAIL FROM domain.
+     */
+    MailFromDomain?: string | undefined;
+};
+//# sourceMappingURL=aws-pinpointemail-identity.d.ts.map