@awboost/cfn-resource-types 0.1.25 → 0.1.27

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.
Files changed (59) hide show
  1. package/lib/AWS-ApiGateway-Authorizer.d.ts +1 -1
  2. package/lib/AWS-ApiGateway-Method.d.ts +2 -2
  3. package/lib/AWS-CloudFront-Distribution.d.ts +568 -2
  4. package/lib/AWS-CloudFront-Distribution.js +2 -1
  5. package/lib/AWS-Config-ConfigRule.d.ts +61 -43
  6. package/lib/AWS-Config-ConfigRule.js +4 -1
  7. package/lib/AWS-Connect-Prompt.d.ts +1 -1
  8. package/lib/AWS-ControlTower-EnabledControl.d.ts +25 -0
  9. package/lib/AWS-DynamoDB-Table.d.ts +245 -11
  10. package/lib/AWS-DynamoDB-Table.js +5 -1
  11. package/lib/AWS-EC2-ClientVpnEndpoint.d.ts +0 -8
  12. package/lib/AWS-EC2-EC2Fleet.d.ts +1 -0
  13. package/lib/AWS-EC2-EIP.d.ts +31 -19
  14. package/lib/AWS-EC2-EIP.js +4 -1
  15. package/lib/AWS-EC2-LaunchTemplate.d.ts +422 -205
  16. package/lib/AWS-EC2-LaunchTemplate.js +8 -1
  17. package/lib/AWS-EC2-RouteTable.d.ts +13 -5
  18. package/lib/AWS-EC2-RouteTable.js +3 -1
  19. package/lib/AWS-EC2-SecurityGroupEgress.d.ts +34 -19
  20. package/lib/AWS-EC2-SecurityGroupEgress.js +6 -1
  21. package/lib/AWS-EC2-SpotFleet.d.ts +1 -0
  22. package/lib/AWS-EC2-Volume.d.ts +68 -20
  23. package/lib/AWS-EC2-Volume.js +9 -1
  24. package/lib/AWS-ElasticLoadBalancingV2-Listener.d.ts +200 -2
  25. package/lib/AWS-ElasticLoadBalancingV2-Listener.js +2 -1
  26. package/lib/AWS-ElasticLoadBalancingV2-LoadBalancer.d.ts +64 -29
  27. package/lib/AWS-ElasticLoadBalancingV2-LoadBalancer.js +2 -1
  28. package/lib/AWS-GameLift-Fleet.d.ts +1 -1
  29. package/lib/AWS-Glue-DataCatalogEncryptionSettings.d.ts +1 -0
  30. package/lib/AWS-Glue-TableOptimizer.d.ts +2 -2
  31. package/lib/AWS-IAM-GroupPolicy.d.ts +19 -8
  32. package/lib/AWS-IAM-GroupPolicy.js +3 -1
  33. package/lib/AWS-IAM-RolePolicy.d.ts +19 -8
  34. package/lib/AWS-IAM-RolePolicy.js +3 -1
  35. package/lib/AWS-Lambda-Function.d.ts +78 -62
  36. package/lib/AWS-Lambda-Function.js +3 -1
  37. package/lib/AWS-Lambda-Permission.d.ts +29 -19
  38. package/lib/AWS-Lambda-Permission.js +3 -1
  39. package/lib/AWS-MediaPackageV2-Channel.d.ts +32 -4
  40. package/lib/AWS-MediaPackageV2-Channel.js +2 -1
  41. package/lib/AWS-MediaPackageV2-ChannelGroup.d.ts +18 -3
  42. package/lib/AWS-MediaPackageV2-ChannelGroup.js +2 -1
  43. package/lib/AWS-MediaPackageV2-ChannelPolicy.d.ts +6 -4
  44. package/lib/AWS-MediaPackageV2-ChannelPolicy.js +2 -1
  45. package/lib/AWS-MediaPackageV2-OriginEndpoint.d.ts +4 -4
  46. package/lib/AWS-MediaPackageV2-OriginEndpointPolicy.d.ts +7 -5
  47. package/lib/AWS-MediaPackageV2-OriginEndpointPolicy.js +2 -1
  48. package/lib/AWS-RDS-DBCluster.d.ts +0 -4
  49. package/lib/AWS-RDS-DBInstance.d.ts +490 -181
  50. package/lib/AWS-RDS-DBInstance.js +5 -1
  51. package/lib/AWS-RDS-DBParameterGroup.d.ts +41 -15
  52. package/lib/AWS-RDS-DBParameterGroup.js +5 -1
  53. package/lib/AWS-RDS-DBSubnetGroup.d.ts +20 -8
  54. package/lib/AWS-RDS-DBSubnetGroup.js +2 -1
  55. package/lib/AWS-SSM-PatchBaseline.d.ts +1 -1
  56. package/lib/AWS-SageMaker-FeatureGroup.d.ts +25 -0
  57. package/lib/AWS-SecretsManager-Secret.d.ts +51 -32
  58. package/lib/AWS-SecretsManager-Secret.js +6 -1
  59. package/package.json +1 -1
@@ -1,6 +1,10 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  /**
3
- * The AWS::RDS::DBInstance resource creates an Amazon RDS DB instance.
3
+ * The ``AWS::RDS::DBInstance`` resource creates an Amazon DB instance. The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster.
4
+ For more information about creating an RDS DB instance, see [Creating an Amazon RDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) in the *Amazon RDS User Guide*.
5
+ For more information about creating a DB instance in an Aurora DB cluster, see [Creating an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide*.
6
+ If you import an existing DB instance, and the template configuration doesn't match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation.
7
+ If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an
4
8
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html}
5
9
  */
6
10
  export class RDSDBInstance extends $Resource {
@@ -1,54 +1,80 @@
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
- * The AWS::RDS::DBParameterGroup resource creates a custom parameter group for an RDS database family
4
+ * The ``AWS::RDS::DBParameterGroup`` resource creates a custom parameter group for an RDS database family.
5
+ This type can be declared in a template and referenced in the ``DBParameterGroupName`` property of an ``AWS::RDS::DBInstance`` resource.
6
+ For information about configuring parameters for Amazon RDS DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.
7
+ For information about configuring parameters for Amazon Aurora DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
8
+ Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.
5
9
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html}
6
10
  */
7
11
  export type RDSDBParameterGroupProperties = {
8
12
  /**
9
- * Specifies the name of the DB parameter group
10
- * @pattern `^[a-zA-Z]{1}(?:-?[a-zA-Z0-9])*$`
11
- */
13
+ * The name of the DB parameter group.
14
+ Constraints:
15
+ + Must be 1 to 255 letters, numbers, or hyphens.
16
+ + First character must be a letter
17
+ + Can't end with a hyphen or contain two consecutive hyphens
18
+
19
+ If you don't specify a value for ``DBParameterGroupName`` property, a name is automatically created for the DB parameter group.
20
+ This value is stored as a lowercase string.
21
+ * @pattern `^[a-zA-Z]{1}(?:-?[a-zA-Z0-9])*$`
22
+ */
12
23
  DBParameterGroupName?: string;
13
24
  /**
14
25
  * Provides the customer-specified description for this DB parameter group.
15
26
  */
16
27
  Description: string;
17
28
  /**
18
- * The DB parameter group family name.
19
- */
29
+ * The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family.
30
+ The DB parameter group family can't be changed when updating a DB parameter group.
31
+ To list all of the available parameter group families, use the following command:
32
+ ``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"``
33
+ The output contains duplicates.
34
+ For more information, see ``CreateDBParameterGroup``.
35
+ */
20
36
  Family: string;
21
37
  /**
22
- * An array of parameter names and values for the parameter update.
23
- */
38
+ * An array of parameter names and values for the parameter update. At least one parameter name and value must be supplied. Subsequent arguments are optional.
39
+ RDS for Db2 requires you to bring your own Db2 license. You must enter your IBM customer ID (``rds.ibm_customer_id``) and site number (``rds.ibm_site_id``) before starting a Db2 instance.
40
+ For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see [Working with DB Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.
41
+ For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see [Working with DB Parameter Groups and DB Cluster Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
42
+ AWS CloudFormation doesn't support specifying an apply method for each individual
43
+ */
24
44
  Parameters?: Record<string, any>;
25
45
  /**
26
- * An array of key-value pairs to apply to this resource.
27
- * @maxLength `50`
28
- */
46
+ * An optional array of key-value pairs to apply to this DB parameter group.
47
+ Currently, this is the only property that supports drift detection.
48
+ * @maxLength `50`
49
+ */
29
50
  Tags?: Tag[];
30
51
  };
31
52
  /**
32
53
  * Type definition for `AWS::RDS::DBParameterGroup.Tag`.
33
- * A key-value pair to associate with a resource.
54
+ * Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
55
+ For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.*
34
56
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup-tag.html}
35
57
  */
36
58
  export type Tag = {
37
59
  /**
38
- * 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 -.
60
+ * A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").
39
61
  * @minLength `1`
40
62
  * @maxLength `128`
41
63
  */
42
64
  Key: string;
43
65
  /**
44
- * The value for the tag. You can specify a value that is 0 to 256 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 -.
66
+ * A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").
45
67
  * @minLength `0`
46
68
  * @maxLength `256`
47
69
  */
48
70
  Value?: string;
49
71
  };
50
72
  /**
51
- * The AWS::RDS::DBParameterGroup resource creates a custom parameter group for an RDS database family
73
+ * The ``AWS::RDS::DBParameterGroup`` resource creates a custom parameter group for an RDS database family.
74
+ This type can be declared in a template and referenced in the ``DBParameterGroupName`` property of an ``AWS::RDS::DBInstance`` resource.
75
+ For information about configuring parameters for Amazon RDS DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.
76
+ For information about configuring parameters for Amazon Aurora DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
77
+ Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.
52
78
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html}
53
79
  */
54
80
  export declare class RDSDBParameterGroup extends $Resource<"AWS::RDS::DBParameterGroup", RDSDBParameterGroupProperties, Record<string, never>> {
@@ -1,6 +1,10 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  /**
3
- * The AWS::RDS::DBParameterGroup resource creates a custom parameter group for an RDS database family
3
+ * The ``AWS::RDS::DBParameterGroup`` resource creates a custom parameter group for an RDS database family.
4
+ This type can be declared in a template and referenced in the ``DBParameterGroupName`` property of an ``AWS::RDS::DBInstance`` resource.
5
+ For information about configuring parameters for Amazon RDS DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.
6
+ For information about configuring parameters for Amazon Aurora DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
7
+ Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.
4
8
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html}
5
9
  */
6
10
  export class RDSDBParameterGroup extends $Resource {
@@ -1,43 +1,55 @@
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
- * The AWS::RDS::DBSubnetGroup resource creates a database subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region.
4
+ * The ``AWS::RDS::DBSubnetGroup`` resource creates a database subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region.
5
+ For more information, see [Working with DB subnet groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Subnets) in the *Amazon RDS User Guide*.
5
6
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnetgroup.html}
6
7
  */
7
8
  export type RDSDBSubnetGroupProperties = {
8
- DBSubnetGroupDescription: string;
9
9
  /**
10
- * @pattern `^(?!default$)[a-zA-Z]{1}[a-zA-Z0-9-_\.\s]{0,254}$`
10
+ * The description for the DB subnet group.
11
11
  */
12
+ DBSubnetGroupDescription: string;
13
+ /**
14
+ * The name for the DB subnet group. This value is stored as a lowercase string.
15
+ Constraints: Must contain no more than 255 lowercase alphanumeric characters or hyphens. Must not be "Default".
16
+ Example: ``mysubnetgroup``
17
+ * @pattern `^(?!default$)[a-zA-Z]{1}[a-zA-Z0-9-_\.\s]{0,254}$`
18
+ */
12
19
  DBSubnetGroupName?: string;
20
+ /**
21
+ * The EC2 Subnet IDs for the DB subnet group.
22
+ */
13
23
  SubnetIds: string[];
14
24
  /**
15
- * An array of key-value pairs to apply to this resource.
25
+ * An optional array of key-value pairs to apply to this DB subnet group.
16
26
  * @maxLength `50`
17
27
  */
18
28
  Tags?: Tag[];
19
29
  };
20
30
  /**
21
31
  * Type definition for `AWS::RDS::DBSubnetGroup.Tag`.
22
- * A key-value pair to associate with a resource.
32
+ * Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
33
+ For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.*
23
34
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbsubnetgroup-tag.html}
24
35
  */
25
36
  export type Tag = {
26
37
  /**
27
- * 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 -.
38
+ * A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").
28
39
  * @minLength `1`
29
40
  * @maxLength `128`
30
41
  */
31
42
  Key: string;
32
43
  /**
33
- * The value for the tag. You can specify a value that is 0 to 256 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 -.
44
+ * A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").
34
45
  * @minLength `0`
35
46
  * @maxLength `256`
36
47
  */
37
48
  Value?: string;
38
49
  };
39
50
  /**
40
- * The AWS::RDS::DBSubnetGroup resource creates a database subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region.
51
+ * The ``AWS::RDS::DBSubnetGroup`` resource creates a database subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region.
52
+ For more information, see [Working with DB subnet groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Subnets) in the *Amazon RDS User Guide*.
41
53
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnetgroup.html}
42
54
  */
43
55
  export declare class RDSDBSubnetGroup extends $Resource<"AWS::RDS::DBSubnetGroup", RDSDBSubnetGroupProperties, Record<string, never>> {
@@ -1,6 +1,7 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  /**
3
- * The AWS::RDS::DBSubnetGroup resource creates a database subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region.
3
+ * The ``AWS::RDS::DBSubnetGroup`` resource creates a database subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region.
4
+ For more information, see [Working with DB subnet groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Subnets) in the *Amazon RDS User Guide*.
4
5
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnetgroup.html}
5
6
  */
6
7
  export class RDSDBSubnetGroup extends $Resource {
@@ -47,7 +47,7 @@ export type SSMPatchBaselineProperties = {
47
47
  /**
48
48
  * Defines the operating system the patch baseline applies to. The Default value is WINDOWS.
49
49
  */
50
- OperatingSystem?: "WINDOWS" | "AMAZON_LINUX" | "AMAZON_LINUX_2" | "AMAZON_LINUX_2022" | "AMAZON_LINUX_2023" | "UBUNTU" | "REDHAT_ENTERPRISE_LINUX" | "SUSE" | "CENTOS" | "ORACLE_LINUX" | "DEBIAN" | "MACOS" | "RASPBIAN" | "ROCKY_LINUX";
50
+ OperatingSystem?: "WINDOWS" | "AMAZON_LINUX" | "AMAZON_LINUX_2" | "AMAZON_LINUX_2022" | "AMAZON_LINUX_2023" | "UBUNTU" | "REDHAT_ENTERPRISE_LINUX" | "SUSE" | "CENTOS" | "ORACLE_LINUX" | "DEBIAN" | "MACOS" | "RASPBIAN" | "ROCKY_LINUX" | "ALMA_LINUX";
51
51
  /**
52
52
  * PatchGroups is used to associate instances with a specific patch baseline
53
53
  */
@@ -43,6 +43,10 @@ export type SageMakerFeatureGroupProperties = {
43
43
  EnableOnlineStore?: boolean;
44
44
  SecurityConfig?: OnlineStoreSecurityConfig;
45
45
  StorageType?: StorageType;
46
+ /**
47
+ * TTL configuration of the feature group
48
+ */
49
+ TtlDuration?: TtlDuration;
46
50
  };
47
51
  /**
48
52
  * The Record Identifier Feature Name.
@@ -185,6 +189,27 @@ export type ThroughputConfig = {
185
189
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-throughputmode.html}
186
190
  */
187
191
  export type ThroughputMode = "OnDemand" | "Provisioned";
192
+ /**
193
+ * Type definition for `AWS::SageMaker::FeatureGroup.TtlDuration`.
194
+ * TTL configuration of the feature group
195
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-ttlduration.html}
196
+ */
197
+ export type TtlDuration = {
198
+ /**
199
+ * Unit of ttl configuration
200
+ */
201
+ Unit?: Unit;
202
+ /**
203
+ * Value of ttl configuration
204
+ */
205
+ Value?: number;
206
+ };
207
+ /**
208
+ * Type definition for `AWS::SageMaker::FeatureGroup.Unit`.
209
+ * Unit of ttl configuration
210
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-unit.html}
211
+ */
212
+ export type Unit = "Seconds" | "Minutes" | "Hours" | "Days" | "Weeks";
188
213
  /**
189
214
  * Resource Type definition for AWS::SageMaker::FeatureGroup
190
215
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html}
@@ -1,37 +1,52 @@
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::SecretsManager::Secret
4
+ * Resource type definition for `AWS::SecretsManager::Secret`.
5
+ * Creates a new secret. A *secret* can be a password, a set of credentials such as a user name and password, an OAuth token, or other secret information that you store in an encrypted form in Secrets Manager.
6
+ For RDS master user credentials, see [AWS::RDS::DBCluster MasterUserSecret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html).
7
+ To retrieve a secret in a CFNshort template, use a *dynamic reference*. For more information, see [Retrieve a secret in an resource](https://docs.aws.amazon.com/secretsmanager/latest/userguide/cfn-example_reference-secret.html).
8
+ A common scenario is to first create a secret with ``GenerateSecretString``, which generates a password, and then use a dynamic reference to retrieve the username and password from the secret to use as credentials for a new database. See the example *Creating a Redshift cluster and a secret for the admin credentials*.
9
+ For information about creating a secret in the c
5
10
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html}
6
11
  */
7
12
  export type SecretsManagerSecretProperties = {
8
13
  /**
9
- * (Optional) Specifies a user-provided description of the secret.
14
+ * The description of the secret.
10
15
  */
11
16
  Description?: string;
12
17
  /**
13
- * (Optional) Specifies text data that you want to encrypt and store in this new version of the secret.
14
- */
18
+ * A structure that specifies how to generate a password to encrypt and store in the secret. To include a specific string in the secret, use ``SecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created.
19
+ We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.
20
+ */
15
21
  GenerateSecretString?: GenerateSecretString;
16
22
  /**
17
- * (Optional) Specifies the ARN, Key ID, or alias of the AWS KMS customer master key (CMK) used to encrypt the SecretString.
18
- */
23
+ * The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret. An alias is always prefixed by ``alias/``, for example ``alias/aws/secretsmanager``. For more information, see [About aliases](https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html).
24
+ To use a KMS key in a different account, use the key ARN or the alias ARN.
25
+ If you don't specify this value, then Secrets Manager uses the key ``aws/secretsmanager``. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.
26
+ If the secret is in a different AWS account from the credentials calling the API, then you can't use ``aws/secretsmanager`` to encrypt the secret, and you must create and use a customer managed KMS key.
27
+ */
19
28
  KmsKeyId?: string;
20
29
  /**
21
- * The friendly name of the secret. You can use forward slashes in the name to represent a path hierarchy.
22
- */
30
+ * The name of the new secret.
31
+ The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
32
+ Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
33
+ */
23
34
  Name?: string;
24
35
  /**
25
- * (Optional) A list of ReplicaRegion objects. The ReplicaRegion type consists of a Region (required) and the KmsKeyId which can be an ARN, Key ID, or Alias.
36
+ * A custom type that specifies a ``Region`` and the ``KmsKeyId`` for a replica secret.
26
37
  */
27
38
  ReplicaRegions?: ReplicaRegion[];
28
39
  /**
29
- * (Optional) Specifies text data that you want to encrypt and store in this new version of the secret.
40
+ * The text to encrypt and store in the secret. We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, use ``GenerateSecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created.
30
41
  */
31
42
  SecretString?: string;
32
43
  /**
33
- * The list of user-defined tags associated with the secret. Use tags to manage your AWS resources. For additional information about tags, see TagResource.
34
- */
44
+ * A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example:
45
+ ``[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]``
46
+ Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one with key "abc".
47
+ Stack-level tags, tags you apply to the CloudFormation stack, are also attached to the secret.
48
+ If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an ``Access Denied`` error. For more information, see [Control access to secrets using tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac) and [Limit access to identities with tags that match secrets' tags](https://docs.aws.amazo
49
+ */
35
50
  Tags?: Tag[];
36
51
  };
37
52
  /**
@@ -39,89 +54,93 @@ export type SecretsManagerSecretProperties = {
39
54
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html#aws-resource-secretsmanager-secret-return-values}
40
55
  */
41
56
  export type SecretsManagerSecretAttributes = {
42
- /**
43
- * secret Id, the Arn of the resource.
44
- */
45
57
  Id: string;
46
58
  };
47
59
  /**
48
60
  * Type definition for `AWS::SecretsManager::Secret.GenerateSecretString`.
61
+ * Generates a random password. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.
62
+ *Required permissions:* ``secretsmanager:GetRandomPassword``. For more information, see [IAM policy actions for Secrets Manager](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions) and [Authentication and access control in Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html).
49
63
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html}
50
64
  */
51
65
  export type GenerateSecretString = {
52
66
  /**
53
- * A string that excludes characters in the generated password. By default, all characters from the included sets can be used. The string can be a minimum length of 0 characters and a maximum length of 7168 characters.
67
+ * A string of the characters that you don't want in the password.
54
68
  */
55
69
  ExcludeCharacters?: string;
56
70
  /**
57
- * Specifies the generated password should not include lowercase letters. By default, ecrets Manager disables this parameter, and the generated password can include lowercase False, and the generated password can include lowercase letters.
71
+ * Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
58
72
  */
59
73
  ExcludeLowercase?: boolean;
60
74
  /**
61
- * Specifies that the generated password should exclude digits. By default, Secrets Manager does not enable the parameter, False, and the generated password can include digits.
75
+ * Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.
62
76
  */
63
77
  ExcludeNumbers?: boolean;
64
78
  /**
65
- * Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included.
79
+ * Specifies whether to exclude the following punctuation characters from the password: ``! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~``. If you don't include this switch, the password can contain punctuation.
66
80
  */
67
81
  ExcludePunctuation?: boolean;
68
82
  /**
69
- * Specifies that the generated password should not include uppercase letters. The default behavior is False, and the generated password can include uppercase letters.
83
+ * Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
70
84
  */
71
85
  ExcludeUppercase?: boolean;
72
86
  /**
73
- * The JSON key name used to add the generated password to the JSON structure specified by the SecretStringTemplate parameter. If you specify this parameter, then you must also specify SecretStringTemplate.
87
+ * The JSON key name for the key/value pair, where the value is the generated password. This pair is added to the JSON structure specified by the ``SecretStringTemplate`` parameter. If you specify this parameter, then you must also specify ``SecretStringTemplate``.
74
88
  */
75
89
  GenerateStringKey?: string;
76
90
  /**
77
- * Specifies that the generated password can include the space character. By default, Secrets Manager disables this parameter, and the generated password doesn't include space
91
+ * Specifies whether to include the space character. If you include this switch, the password can contain space characters.
78
92
  */
79
93
  IncludeSpace?: boolean;
80
94
  /**
81
- * The desired length of the generated password. The default value if you do not include this parameter is 32 characters.
95
+ * The length of the password. If you don't include this parameter, the default length is 32 characters.
82
96
  */
83
97
  PasswordLength?: number;
84
98
  /**
85
- * Specifies whether the generated password must include at least one of every allowed character type. By default, Secrets Manager enables this parameter, and the generated password includes at least one of every character type.
99
+ * Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.
86
100
  */
87
101
  RequireEachIncludedType?: boolean;
88
102
  /**
89
- * A properly structured JSON string that the generated password can be added to. If you specify this parameter, then you must also specify GenerateStringKey.
103
+ * A template that the generated string must match. When you make a change to this property, a new secret version is created.
90
104
  */
91
105
  SecretStringTemplate?: string;
92
106
  };
93
107
  /**
94
108
  * Type definition for `AWS::SecretsManager::Secret.ReplicaRegion`.
95
- * A custom type that specifies a Region and the KmsKeyId for a replica secret.
109
+ * Specifies a ``Region`` and the ``KmsKeyId`` for a replica secret.
96
110
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-replicaregion.html}
97
111
  */
98
112
  export type ReplicaRegion = {
99
113
  /**
100
- * The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses aws/secretsmanager.
114
+ * The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses ``aws/secretsmanager``.
101
115
  */
102
116
  KmsKeyId?: string;
103
117
  /**
104
- * (Optional) A string that represents a Region, for example "us-east-1".
118
+ * A string that represents a ``Region``, for example "us-east-1".
105
119
  */
106
120
  Region: string;
107
121
  };
108
122
  /**
109
123
  * Type definition for `AWS::SecretsManager::Secret.Tag`.
110
- * A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string.
124
+ * A structure that contains information about a tag.
111
125
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-tag.html}
112
126
  */
113
127
  export type Tag = {
114
128
  /**
115
- * The value for the tag. You can specify a value that's 1 to 256 characters in length.
129
+ * The key identifier, or name, of the tag.
116
130
  */
117
131
  Key: string;
118
132
  /**
119
- * The key name of the tag. You can specify a value that's 1 to 128 Unicode characters in length and can't be prefixed with aws.
133
+ * The string value associated with the key of the tag.
120
134
  */
121
135
  Value: string;
122
136
  };
123
137
  /**
124
- * Resource Type definition for AWS::SecretsManager::Secret
138
+ * Resource type definition for `AWS::SecretsManager::Secret`.
139
+ * Creates a new secret. A *secret* can be a password, a set of credentials such as a user name and password, an OAuth token, or other secret information that you store in an encrypted form in Secrets Manager.
140
+ For RDS master user credentials, see [AWS::RDS::DBCluster MasterUserSecret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html).
141
+ To retrieve a secret in a CFNshort template, use a *dynamic reference*. For more information, see [Retrieve a secret in an resource](https://docs.aws.amazon.com/secretsmanager/latest/userguide/cfn-example_reference-secret.html).
142
+ A common scenario is to first create a secret with ``GenerateSecretString``, which generates a password, and then use a dynamic reference to retrieve the username and password from the secret to use as credentials for a new database. See the example *Creating a Redshift cluster and a secret for the admin credentials*.
143
+ For information about creating a secret in the c
125
144
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html}
126
145
  */
127
146
  export declare class SecretsManagerSecret extends $Resource<"AWS::SecretsManager::Secret", SecretsManagerSecretProperties, SecretsManagerSecretAttributes> {
@@ -1,6 +1,11 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  /**
3
- * Resource Type definition for AWS::SecretsManager::Secret
3
+ * Resource type definition for `AWS::SecretsManager::Secret`.
4
+ * Creates a new secret. A *secret* can be a password, a set of credentials such as a user name and password, an OAuth token, or other secret information that you store in an encrypted form in Secrets Manager.
5
+ For RDS master user credentials, see [AWS::RDS::DBCluster MasterUserSecret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html).
6
+ To retrieve a secret in a CFNshort template, use a *dynamic reference*. For more information, see [Retrieve a secret in an resource](https://docs.aws.amazon.com/secretsmanager/latest/userguide/cfn-example_reference-secret.html).
7
+ A common scenario is to first create a secret with ``GenerateSecretString``, which generates a password, and then use a dynamic reference to retrieve the username and password from the secret to use as credentials for a new database. See the example *Creating a Redshift cluster and a secret for the admin credentials*.
8
+ For information about creating a secret in the c
4
9
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html}
5
10
  */
6
11
  export class SecretsManagerSecret extends $Resource {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@awboost/cfn-resource-types",
3
- "version": "0.1.25",
3
+ "version": "0.1.27",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },