@awboost/cfn-resource-types 0.1.33 → 0.1.35

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -68,7 +68,7 @@ export type RDSDBInstanceProperties = {
68
68
  BackupRetentionPeriod?: number;
69
69
  /**
70
70
  * The identifier of the CA certificate for this DB instance.
71
- Specifying or updating this property triggers a reboot. For more information about CA certificate identifiers for RDS DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide*. For more information about CA certificate identifiers for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide*.
71
+ For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*.
72
72
  */
73
73
  CACertificateIdentifier?: string;
74
74
  /**
@@ -107,7 +107,7 @@ export type RDSDBInstanceProperties = {
107
107
  */
108
108
  DBClusterIdentifier?: string;
109
109
  /**
110
- * The identifier for the Multi-AZ DB cluster snapshot to restore from.
110
+ * The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from.
111
111
  For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*.
112
112
  Constraints:
113
113
  + Must match the identifier of an existing Multi-AZ DB cluster snapshot.
@@ -115,6 +115,7 @@ export type RDSDBInstanceProperties = {
115
115
  + Must be specified when ``DBSnapshotIdentifier`` isn't specified.
116
116
  + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the ``DBClusterSnapshotIdentifier`` must be the ARN of the shared snapshot.
117
117
  + Can't be the identifier of an Aurora DB cluster snapshot.
118
+ + Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.
118
119
  */
119
120
  DBClusterSnapshotIdentifier?: string;
120
121
  /**
@@ -74,12 +74,6 @@ export type RedshiftServerlessNamespaceProperties = {
74
74
  * The ARN for the Redshift application that integrates with IAM Identity Center.
75
75
  */
76
76
  RedshiftIdcApplicationArn?: string;
77
- /**
78
- * The snapshot copy configurations for the namespace.
79
- * @minLength `0`
80
- * @maxLength `1`
81
- */
82
- SnapshotCopyConfigurations?: SnapshotCopyConfiguration[];
83
77
  /**
84
78
  * The list of tags for the namespace.
85
79
  * @minLength `0`
@@ -141,15 +135,6 @@ export type Namespace = {
141
135
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespacestatus.html}
142
136
  */
143
137
  export type NamespaceStatus = "AVAILABLE" | "MODIFYING" | "DELETING";
144
- /**
145
- * Type definition for `AWS::RedshiftServerless::Namespace.SnapshotCopyConfiguration`.
146
- * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-snapshotcopyconfiguration.html}
147
- */
148
- export type SnapshotCopyConfiguration = {
149
- DestinationKmsKeyId?: string;
150
- DestinationRegion: string;
151
- SnapshotRetentionPeriod?: number;
152
- };
153
138
  /**
154
139
  * Type definition for `AWS::RedshiftServerless::Namespace.Tag`.
155
140
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-tag.html}
@@ -1,36 +1,57 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
3
3
  /**
4
- * Resource schema for AWS::Route53::HostedZone.
4
+ * Resource type definition for `AWS::Route53::HostedZone`.
5
+ * Creates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs).
6
+ You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.
7
+ For more information about charges for hosted zones, see [Amazon Route 53 Pricing](https://docs.aws.amazon.com/route53/pricing/).
8
+ Note the following:
9
+ + You can't create a hosted zone for a top-level domain (TLD) such as .com.
10
+ + If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see [Migrating DNS Service for an Existing Domain to Amazon Route 53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/MigratingDNS.html) in the *Amazon Route 53 Developer Guide*.
11
+
12
+ When you submit a ``CreateHostedZone`` request, the initial status of the hosted zone is ``PENDING``. For public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to ``INSYNC``.
13
+ The ``CreateHostedZone`` request requires the caller to have an ``ec2:DescribeVpcs`` permission.
14
+ When creating private hosted zones, the Amazon VPC must belong to the same partition where the hosted zone is created. A partition is a group of AWS-Regions. Each AWS-account is scoped to one partition.
15
+ The following are the supported partitions:
16
+ + ``aws`` - AWS-Regions
17
+ + ``aws-cn`` - China Regions
18
+ + ``aws-us-gov`` - govcloud-us-region
19
+
20
+ For more information, see [Access Management](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.
5
21
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html}
6
22
  */
7
23
  export type Route53HostedZoneProperties = {
8
24
  /**
9
25
  * A complex type that contains an optional comment.
10
-
11
- If you don't want to specify a comment, omit the HostedZoneConfig and Comment elements.
26
+ If you don't want to specify a comment, omit the ``HostedZoneConfig`` and ``Comment`` elements.
12
27
  */
13
28
  HostedZoneConfig?: HostedZoneConfig;
14
29
  /**
15
30
  * Adds, edits, or deletes tags for a health check or a hosted zone.
16
-
17
- For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
31
+ For information about using tags for cost allocation, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the *User Guide*.
18
32
  */
19
33
  HostedZoneTags?: HostedZoneTag[];
20
34
  /**
21
- * The name of the domain. Specify a fully qualified domain name, for example, www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.
22
-
23
- If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of NameServers that are returned by the Fn::GetAtt intrinsic function.
35
+ * The name of the domain. Specify a fully qualified domain name, for example, *www.example.com*. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats *www.example.com* (without a trailing dot) and *www.example.com.* (with a trailing dot) as identical.
36
+ If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of ``NameServers`` that are returned by the ``Fn::GetAtt`` intrinsic function.
24
37
  * @maxLength `1024`
25
38
  */
26
39
  Name?: string;
27
40
  /**
28
- * A complex type that contains information about a configuration for DNS query logging.
29
- */
41
+ * Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group.
42
+ DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following:
43
+ + Route 53 edge location that responded to the DNS query
44
+ + Domain or subdomain that was requested
45
+ + DNS record type, such as A or AAAA
46
+ + DNS response code, such as ``NoError`` or ``ServFail``
47
+
48
+ + Log Group and Resource Policy Before you create a query logging configuration, perform the following operations. If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following: You must create the log group in the us-east-1 region. You must use the same to create the log group and the hosted zone that you want to configure query logging for. When you create log groups for query logging, we recommend that you use a consistent prefix, for example: /aws/route53/hosted zone name In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging. Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example: arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/* To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values: For aws:SourceArn, supply the hosted zone ARN used in creating the query logging configuration. For example, aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID. For aws:SourceAccount, supply the account ID for the account that creates the query logging configuration. For example, aws:SourceAccount:111111111111. For more information, see The confused deputy problem in the IAM User Guide. You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the SDKs, or the . + Log Streams and Edge Locations When Route 53 finishes creating the configuration for DNS query logging, it does the following: Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location. Begins to send query logs to the applicable log stream. The name of each log stream is in the following format: hosted zone ID/edge location code The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see "The Route 53 Global Network" on the Route 53 Product Details page. + Queries That Are Logged Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide. + Log File Format For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide. + Pricing For information about charges for query logs, see Amazon CloudWatch Pricing. + How to Stop Logging If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig.
49
+ */
30
50
  QueryLoggingConfig?: QueryLoggingConfig;
31
51
  /**
32
- * A complex type that contains information about the VPCs that are associated with the specified hosted zone.
33
- */
52
+ * *Private hosted zones:* A complex type that contains information about the VPCs that are associated with the specified hosted zone.
53
+ For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``.
54
+ */
34
55
  VPCs?: VPC[];
35
56
  };
36
57
  /**
@@ -43,9 +64,7 @@ export type Route53HostedZoneAttributes = {
43
64
  };
44
65
  /**
45
66
  * Type definition for `AWS::Route53::HostedZone.HostedZoneConfig`.
46
- * A complex type that contains an optional comment.
47
-
48
- If you don't want to specify a comment, omit the HostedZoneConfig and Comment elements.
67
+ * A complex type that contains an optional comment about your hosted zone. If you don't want to specify a comment, omit both the ``HostedZoneConfig`` and ``Comment`` elements.
49
68
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzoneconfig.html}
50
69
  */
51
70
  export type HostedZoneConfig = {
@@ -62,14 +81,20 @@ export type HostedZoneConfig = {
62
81
  */
63
82
  export type HostedZoneTag = {
64
83
  /**
65
- * The key name of the tag.
66
- * @maxLength `128`
67
- */
84
+ * The value of ``Key`` depends on the operation that you want to perform:
85
+ + *Add a tag to a health check or hosted zone*: ``Key`` is the name that you want to give the new tag.
86
+ + *Edit a tag*: ``Key`` is the name of the tag that you want to change the ``Value`` for.
87
+ + *Delete a key*: ``Key`` is the name of the tag you want to remove.
88
+ + *Give a name to a health check*: Edit the default ``Name`` tag. In the Amazon Route 53 console, the list of your health checks includes a *Name* column that lets you see the name that you've given to each health check.
89
+ * @maxLength `128`
90
+ */
68
91
  Key: string;
69
92
  /**
70
- * The value for the tag.
71
- * @maxLength `256`
72
- */
93
+ * The value of ``Value`` depends on the operation that you want to perform:
94
+ + *Add a tag to a health check or hosted zone*: ``Value`` is the value that you want to give the new tag.
95
+ + *Edit a tag*: ``Value`` is the new value that you want to assign the tag.
96
+ * @maxLength `256`
97
+ */
73
98
  Value: string;
74
99
  };
75
100
  /**
@@ -85,21 +110,40 @@ export type QueryLoggingConfig = {
85
110
  };
86
111
  /**
87
112
  * Type definition for `AWS::Route53::HostedZone.VPC`.
88
- * A complex type that contains information about an Amazon VPC. Route 53 Resolver uses the records in the private hosted zone to route traffic in that VPC.
113
+ * *Private hosted zones only:* A complex type that contains information about an Amazon VPC. Route 53 Resolver uses the records in the private hosted zone to route traffic in that VPC.
114
+ For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``.
89
115
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-vpc.html}
90
116
  */
91
117
  export type VPC = {
92
118
  /**
93
- * The ID of an Amazon VPC.
94
- */
119
+ * *Private hosted zones only:* The ID of an Amazon VPC.
120
+ For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``.
121
+ */
95
122
  VPCId: string;
96
123
  /**
97
- * The region that an Amazon VPC was created in. See https://docs.aws.amazon.com/general/latest/gr/rande.html for a list of up to date regions.
98
- */
124
+ * *Private hosted zones only:* The region that an Amazon VPC was created in.
125
+ For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``.
126
+ */
99
127
  VPCRegion: string;
100
128
  };
101
129
  /**
102
- * Resource schema for AWS::Route53::HostedZone.
130
+ * Resource type definition for `AWS::Route53::HostedZone`.
131
+ * Creates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs).
132
+ You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.
133
+ For more information about charges for hosted zones, see [Amazon Route 53 Pricing](https://docs.aws.amazon.com/route53/pricing/).
134
+ Note the following:
135
+ + You can't create a hosted zone for a top-level domain (TLD) such as .com.
136
+ + If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see [Migrating DNS Service for an Existing Domain to Amazon Route 53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/MigratingDNS.html) in the *Amazon Route 53 Developer Guide*.
137
+
138
+ When you submit a ``CreateHostedZone`` request, the initial status of the hosted zone is ``PENDING``. For public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to ``INSYNC``.
139
+ The ``CreateHostedZone`` request requires the caller to have an ``ec2:DescribeVpcs`` permission.
140
+ When creating private hosted zones, the Amazon VPC must belong to the same partition where the hosted zone is created. A partition is a group of AWS-Regions. Each AWS-account is scoped to one partition.
141
+ The following are the supported partitions:
142
+ + ``aws`` - AWS-Regions
143
+ + ``aws-cn`` - China Regions
144
+ + ``aws-us-gov`` - govcloud-us-region
145
+
146
+ For more information, see [Access Management](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.
103
147
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html}
104
148
  */
105
149
  export declare class Route53HostedZone extends $Resource<"AWS::Route53::HostedZone", Route53HostedZoneProperties, Route53HostedZoneAttributes> {
@@ -1,6 +1,22 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  /**
3
- * Resource schema for AWS::Route53::HostedZone.
3
+ * Resource type definition for `AWS::Route53::HostedZone`.
4
+ * Creates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs).
5
+ You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.
6
+ For more information about charges for hosted zones, see [Amazon Route 53 Pricing](https://docs.aws.amazon.com/route53/pricing/).
7
+ Note the following:
8
+ + You can't create a hosted zone for a top-level domain (TLD) such as .com.
9
+ + If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see [Migrating DNS Service for an Existing Domain to Amazon Route 53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/MigratingDNS.html) in the *Amazon Route 53 Developer Guide*.
10
+
11
+ When you submit a ``CreateHostedZone`` request, the initial status of the hosted zone is ``PENDING``. For public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to ``INSYNC``.
12
+ The ``CreateHostedZone`` request requires the caller to have an ``ec2:DescribeVpcs`` permission.
13
+ When creating private hosted zones, the Amazon VPC must belong to the same partition where the hosted zone is created. A partition is a group of AWS-Regions. Each AWS-account is scoped to one partition.
14
+ The following are the supported partitions:
15
+ + ``aws`` - AWS-Regions
16
+ + ``aws-cn`` - China Regions
17
+ + ``aws-us-gov`` - govcloud-us-region
18
+
19
+ For more information, see [Access Management](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.
4
20
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html}
5
21
  */
6
22
  export class Route53HostedZone extends $Resource {
@@ -1,40 +1,33 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
3
3
  /**
4
- * Resource Type definition for AWS::SNS::Topic
4
+ * The ``AWS::SNS::Topic`` resource creates a topic to which notifications can be published.
5
+ One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see [endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/sns.html) in the *General Reference*.
6
+ The structure of ``AUTHPARAMS`` depends on the .signature of the API request. For more information, see [Examples of the complete Signature Version 4 signing process](https://docs.aws.amazon.com/general/latest/gr/sigv4-signed-request-examples.html) in the *General Reference*.
5
7
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html}
6
8
  */
7
9
  export type SNSTopicProperties = {
8
10
  /**
9
- * The archive policy determines the number of days Amazon SNS retains messages. You can set a retention period from 1 to 365 days.
11
+ * The archive policy determines the number of days SNS retains messages. You can set a retention period from 1 to 365 days.
10
12
  */
11
13
  ArchivePolicy?: Record<string, any>;
12
14
  /**
13
- * Enables content-based deduplication for FIFO topics. By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.
14
-
15
- When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
16
-
17
- (Optional) To override the generated value, you can specify a value for the the MessageDeduplicationId parameter for the Publish action.
18
-
19
-
15
+ * Enables content-based deduplication for FIFO topics.
16
+ + By default, ``ContentBasedDeduplication`` is set to ``false``. If you create a FIFO topic and this attribute is ``false``, you must specify a value for the ``MessageDeduplicationId`` parameter for the [Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) action.
17
+ + When you set ``ContentBasedDeduplication`` to ``true``, SNS uses a SHA-256 hash to generate the ``MessageDeduplicationId`` using the body of the message (but not the attributes of the message).
18
+ (Optional) To override the generated value, you can specify a value for the the ``MessageDeduplicationId`` parameter for the ``Publish`` action.
20
19
  */
21
20
  ContentBasedDeduplication?: boolean;
22
21
  /**
23
22
  * The body of the policy document you want to use for this topic.
24
-
25
- You can only add one policy per topic.
26
-
27
- The policy must be in JSON string format.
28
-
29
- Length Constraints: Maximum length of 30720
23
+ You can only add one policy per topic.
24
+ The policy must be in JSON string format.
25
+ Length Constraints: Maximum length of 30,720.
30
26
  */
31
27
  DataProtectionPolicy?: Record<string, any>;
32
- /**
33
- * Delivery status logging configuration for supported protocols for an Amazon SNS topic.
34
- */
35
28
  DeliveryStatusLogging?: LoggingConfig[];
36
29
  /**
37
- * The display name to use for an Amazon SNS topic with SMS subscriptions.
30
+ * The display name to use for an SNS topic with SMS subscriptions. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs.
38
31
  */
39
32
  DisplayName?: string;
40
33
  /**
@@ -42,28 +35,32 @@ export type SNSTopicProperties = {
42
35
  */
43
36
  FifoTopic?: boolean;
44
37
  /**
45
- * The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.
46
-
47
- This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html).
38
+ * The ID of an AWS managed customer master key (CMK) for SNS or a custom CMK. For more information, see [Key terms](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). For more examples, see ``KeyId`` in the *API Reference*.
39
+ This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html).
48
40
  */
49
41
  KmsMasterKeyId?: string;
50
42
  /**
51
- * Version of the Amazon SNS signature used. If the SignatureVersion is 1, Signature is a Base64-encoded SHA1withRSA signature of the Message, MessageId, Type, Timestamp, and TopicArn values. If the SignatureVersion is 2, Signature is a Base64-encoded SHA256withRSA signature of the Message, MessageId, Type, Timestamp, and TopicArn values.
43
+ * The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, ``SignatureVersion`` is set to ``1``.
52
44
  */
53
45
  SignatureVersion?: string;
54
46
  /**
55
- * The SNS subscriptions (endpoints) for this topic.
56
- */
47
+ * The SNS subscriptions (endpoints) for this topic.
48
+ If you specify the ``Subscription`` property in the ``AWS::SNS::Topic`` resource and it creates an associated subscription resource, the associated subscription is not deleted when the ``AWS::SNS::Topic`` resource is deleted.
49
+ */
57
50
  Subscription?: Subscription[];
51
+ /**
52
+ * The list of tags to add to a new topic.
53
+ To be able to tag a topic on creation, you must have the ``sns:CreateTopic`` and ``sns:TagResource`` permissions.
54
+ */
58
55
  Tags?: Tag[];
59
56
  /**
60
- * The name of the topic you want to create. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with .fifo.
61
-
62
- If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the topic name. For more information, see Name Type.
57
+ * The name of the topic you want to create. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with ``.fifo``.
58
+ If you don't specify a name, CFN generates a unique physical ID and uses that ID for the topic name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
59
+ If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
63
60
  */
64
61
  TopicName?: string;
65
62
  /**
66
- * Tracing mode of an Amazon SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to Active, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. Only supported on standard topics.
63
+ * Tracing mode of an SNS topic. By default ``TracingConfig`` is set to ``PassThrough``, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to ``Active``, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true.
67
64
  */
68
65
  TracingConfig?: string;
69
66
  };
@@ -79,47 +76,46 @@ export type SNSTopicAttributes = {
79
76
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic-loggingconfig.html}
80
77
  */
81
78
  export type LoggingConfig = {
82
- /**
83
- * The IAM role ARN to be used when logging failed message deliveries in Amazon CloudWatch
84
- */
85
79
  FailureFeedbackRoleArn?: string;
86
- /**
87
- * Indicates one of the supported protocols for the SNS topic
88
- */
89
80
  Protocol: "http/s" | "sqs" | "lambda" | "firehose" | "application";
90
- /**
91
- * The IAM role ARN to be used when logging successful message deliveries in Amazon CloudWatch
92
- */
93
81
  SuccessFeedbackRoleArn?: string;
94
- /**
95
- * The percentage of successful message deliveries to be logged in Amazon CloudWatch. Valid percentage values range from 0 to 100
96
- */
97
82
  SuccessFeedbackSampleRate?: string;
98
83
  };
99
84
  /**
100
85
  * Type definition for `AWS::SNS::Topic.Subscription`.
86
+ * ``Subscription`` is an embedded property that describes the subscription endpoints of an SNS topic.
87
+ For full control over subscription behavior (for example, delivery policy, filtering, raw message delivery, and cross-region subscriptions), use the [AWS::SNS::Subscription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html) resource.
101
88
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic-subscription.html}
102
89
  */
103
90
  export type Subscription = {
91
+ /**
92
+ * The endpoint that receives notifications from the SNS topic. The endpoint value depends on the protocol that you specify. For more information, see the ``Endpoint`` parameter of the ``Subscribe`` action in the *API Reference*.
93
+ */
104
94
  Endpoint: string;
95
+ /**
96
+ * The subscription's protocol. For more information, see the ``Protocol`` parameter of the ``Subscribe`` action in the *API Reference*.
97
+ */
105
98
  Protocol: string;
106
99
  };
107
100
  /**
108
101
  * Type definition for `AWS::SNS::Topic.Tag`.
102
+ * The list of tags to be added to the specified topic.
109
103
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic-tag.html}
110
104
  */
111
105
  export type Tag = {
112
106
  /**
113
- * The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, `_`, `.`, `/`, `=`, `+`, and `-`.
107
+ * The required key portion of the tag.
114
108
  */
115
109
  Key: string;
116
110
  /**
117
- * The value for the tag. You can specify a value that is 0 to 256 characters in length.
111
+ * The optional value portion of the tag.
118
112
  */
119
113
  Value: string;
120
114
  };
121
115
  /**
122
- * Resource Type definition for AWS::SNS::Topic
116
+ * The ``AWS::SNS::Topic`` resource creates a topic to which notifications can be published.
117
+ One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see [endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/sns.html) in the *General Reference*.
118
+ The structure of ``AUTHPARAMS`` depends on the .signature of the API request. For more information, see [Examples of the complete Signature Version 4 signing process](https://docs.aws.amazon.com/general/latest/gr/sigv4-signed-request-examples.html) in the *General Reference*.
123
119
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html}
124
120
  */
125
121
  export declare class SNSTopic extends $Resource<"AWS::SNS::Topic", SNSTopicProperties, SNSTopicAttributes> {
@@ -1,6 +1,8 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  /**
3
- * Resource Type definition for AWS::SNS::Topic
3
+ * The ``AWS::SNS::Topic`` resource creates a topic to which notifications can be published.
4
+ One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see [endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/sns.html) in the *General Reference*.
5
+ The structure of ``AUTHPARAMS`` depends on the .signature of the API request. For more information, see [Examples of the complete Signature Version 4 signing process](https://docs.aws.amazon.com/general/latest/gr/sigv4-signed-request-examples.html) in the *General Reference*.
4
6
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html}
5
7
  */
6
8
  export class SNSTopic extends $Resource {
@@ -1,7 +1,7 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
3
3
  /**
4
- * Schema for AWS::SNS::TopicPolicy
4
+ * The ``AWS::SNS::TopicPolicy`` resource associates SNS topics with a policy. For an example snippet, see [Declaring an policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-sns-policy) in the *User Guide*.
5
5
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topicpolicy.html}
6
6
  */
7
7
  export type SNSTopicPolicyProperties = {
@@ -10,7 +10,7 @@ export type SNSTopicPolicyProperties = {
10
10
  */
11
11
  PolicyDocument: Record<string, any> | string;
12
12
  /**
13
- * The Amazon Resource Names (ARN) of the topics to which you want to add the policy. You can use the [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)` function to specify an [AWS::SNS::Topic](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html) resource.
13
+ * The Amazon Resource Names (ARN) of the topics to which you want to add the policy. You can use the ``Ref`` function to specify an ``AWS::SNS::Topic`` resource.
14
14
  */
15
15
  Topics: string[];
16
16
  };
@@ -19,13 +19,10 @@ export type SNSTopicPolicyProperties = {
19
19
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topicpolicy.html#aws-resource-sns-topicpolicy-return-values}
20
20
  */
21
21
  export type SNSTopicPolicyAttributes = {
22
- /**
23
- * The provider-assigned unique ID for this managed resource.
24
- */
25
22
  Id: string;
26
23
  };
27
24
  /**
28
- * Schema for AWS::SNS::TopicPolicy
25
+ * The ``AWS::SNS::TopicPolicy`` resource associates SNS topics with a policy. For an example snippet, see [Declaring an policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-sns-policy) in the *User Guide*.
29
26
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topicpolicy.html}
30
27
  */
31
28
  export declare class SNSTopicPolicy extends $Resource<"AWS::SNS::TopicPolicy", SNSTopicPolicyProperties, SNSTopicPolicyAttributes> {
@@ -1,6 +1,6 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  /**
3
- * Schema for AWS::SNS::TopicPolicy
3
+ * The ``AWS::SNS::TopicPolicy`` resource associates SNS topics with a policy. For an example snippet, see [Declaring an policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-sns-policy) in the *User Guide*.
4
4
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topicpolicy.html}
5
5
  */
6
6
  export class SNSTopicPolicy extends $Resource {