Skip to content

Commit 695471a

Browse files
committed
2025/03/06 Run 'make docs-all'.
1 parent 89f471c commit 695471a

28 files changed

+258
-71
lines changed

docs/data-sources/ce_cost_category.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,12 @@ Data Source schema for AWS::CE::CostCategory
2828
- `rule_version` (String)
2929
- `rules` (String) JSON array format of Expression in Billing and Cost Management API
3030
- `split_charge_rules` (String) Json array format of CostCategorySplitChargeRule in Billing and Cost Management API
31+
- `tags` (Attributes List) Tags to assign to the cost category. (see [below for nested schema](#nestedatt--tags))
32+
33+
<a id="nestedatt--tags"></a>
34+
### Nested Schema for `tags`
35+
36+
Read-Only:
37+
38+
- `key` (String) The key name for the tag.
39+
- `value` (String) The value for the tag.

docs/data-sources/dms_data_provider.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ Data Source schema for AWS::DMS::DataProvider
3737
Read-Only:
3838

3939
- `doc_db_settings` (Attributes) DocDbSettings property identifier. (see [below for nested schema](#nestedatt--settings--doc_db_settings))
40+
- `ibm_db_2_luw_settings` (Attributes) IbmDb2LuwSettings property identifier. (see [below for nested schema](#nestedatt--settings--ibm_db_2_luw_settings))
41+
- `ibm_db_2_z_os_settings` (Attributes) IbmDb2zOsSettings property identifier. (see [below for nested schema](#nestedatt--settings--ibm_db_2_z_os_settings))
4042
- `maria_db_settings` (Attributes) MariaDbSettings property identifier. (see [below for nested schema](#nestedatt--settings--maria_db_settings))
4143
- `microsoft_sql_server_settings` (Attributes) MicrosoftSqlServerSettings property identifier. (see [below for nested schema](#nestedatt--settings--microsoft_sql_server_settings))
4244
- `mongo_db_settings` (Attributes) MongoDbSettings property identifier. (see [below for nested schema](#nestedatt--settings--mongo_db_settings))
@@ -57,6 +59,30 @@ Read-Only:
5759
- `ssl_mode` (String)
5860

5961

62+
<a id="nestedatt--settings--ibm_db_2_luw_settings"></a>
63+
### Nested Schema for `settings.ibm_db_2_luw_settings`
64+
65+
Read-Only:
66+
67+
- `certificate_arn` (String)
68+
- `database_name` (String)
69+
- `port` (Number)
70+
- `server_name` (String)
71+
- `ssl_mode` (String)
72+
73+
74+
<a id="nestedatt--settings--ibm_db_2_z_os_settings"></a>
75+
### Nested Schema for `settings.ibm_db_2_z_os_settings`
76+
77+
Read-Only:
78+
79+
- `certificate_arn` (String)
80+
- `database_name` (String)
81+
- `port` (Number)
82+
- `server_name` (String)
83+
- `ssl_mode` (String)
84+
85+
6086
<a id="nestedatt--settings--maria_db_settings"></a>
6187
### Nested Schema for `settings.maria_db_settings`
6288

docs/data-sources/ecr_public_repository.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,10 @@ Data Source schema for AWS::ECR::PublicRepository
2222
### Read-Only
2323

2424
- `arn` (String)
25-
- `repository_catalog_data` (Attributes) The CatalogData property type specifies Catalog data for ECR Public Repository. For information about Catalog Data, see <link> (see [below for nested schema](#nestedatt--repository_catalog_data))
26-
- `repository_name` (String) The name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the repository name. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html.
27-
- `repository_policy_text` (String) The JSON repository policy text to apply to the repository. For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html in the Amazon Elastic Container Registry User Guide.
25+
- `repository_catalog_data` (Attributes) The details about the repository that are publicly visible in the Amazon ECR Public Gallery. For more information, see [Amazon ECR Public repository catalog data](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-catalog-data.html) in the *Amazon ECR Public User Guide*. (see [below for nested schema](#nestedatt--repository_catalog_data))
26+
- `repository_name` (String) The name to use for the public repository. The repository name may be specified on its own (such as ``nginx-web-app``) or it can be prepended with a namespace to group the repository into a category (such as ``project-a/nginx-web-app``). If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the repository name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
27+
If you specify a name, you cannot 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.
28+
- `repository_policy_text` (String) The JSON repository policy text to apply to the public repository. For more information, see [Amazon ECR Public repository policies](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-policies.html) in the *Amazon ECR Public User Guide*.
2829
- `tags` (Attributes Set) An array of key-value pairs to apply to this resource. (see [below for nested schema](#nestedatt--tags))
2930

3031
<a id="nestedatt--repository_catalog_data"></a>
@@ -44,5 +45,5 @@ Read-Only:
4445

4546
Read-Only:
4647

47-
- `key` (String) The key name of the tag. You can specify a value that is 1 to 127 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 -.
48-
- `value` (String) The value for the tag. You can specify a value that is 1 to 255 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 -.
48+
- `key` (String) One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values.
49+
- `value` (String) A ``value`` acts as a descriptor within a tag category (key).

docs/data-sources/ecr_pull_through_cache_rule.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Data Source schema for AWS::ECR::PullThroughCacheRule
2121

2222
### Read-Only
2323

24-
- `credential_arn` (String) The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that identifies the credentials to authenticate to the upstream registry.
25-
- `ecr_repository_prefix` (String) The ECRRepositoryPrefix is a custom alias for upstream registry url.
26-
- `upstream_registry` (String) The name of the upstream registry.
27-
- `upstream_registry_url` (String) The upstreamRegistryUrl is the endpoint of upstream registry url of the public repository to be cached
24+
- `credential_arn` (String) The ARN of the Secrets Manager secret associated with the pull through cache rule.
25+
- `ecr_repository_prefix` (String) The Amazon ECR repository prefix associated with the pull through cache rule.
26+
- `upstream_registry` (String) The name of the upstream source registry associated with the pull through cache rule.
27+
- `upstream_registry_url` (String) The upstream registry URL associated with the pull through cache rule.

docs/data-sources/ecr_replication_configuration.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,37 +21,37 @@ Data Source schema for AWS::ECR::ReplicationConfiguration
2121

2222
### Read-Only
2323

24-
- `registry_id` (String) The RegistryId associated with the aws account.
25-
- `replication_configuration` (Attributes) An object representing the replication configuration for a registry. (see [below for nested schema](#nestedatt--replication_configuration))
24+
- `registry_id` (String)
25+
- `replication_configuration` (Attributes) The replication configuration for a registry. (see [below for nested schema](#nestedatt--replication_configuration))
2626

2727
<a id="nestedatt--replication_configuration"></a>
2828
### Nested Schema for `replication_configuration`
2929

3030
Read-Only:
3131

32-
- `rules` (Attributes List) An array of objects representing the replication rules for a replication configuration. A replication configuration may contain a maximum of 10 rules. (see [below for nested schema](#nestedatt--replication_configuration--rules))
32+
- `rules` (Attributes List) An array of objects representing the replication destinations and repository filters for a replication configuration. (see [below for nested schema](#nestedatt--replication_configuration--rules))
3333

3434
<a id="nestedatt--replication_configuration--rules"></a>
3535
### Nested Schema for `replication_configuration.rules`
3636

3737
Read-Only:
3838

39-
- `destinations` (Attributes List) An array of objects representing the details of a replication destination. (see [below for nested schema](#nestedatt--replication_configuration--rules--destinations))
40-
- `repository_filters` (Attributes List) An array of objects representing the details of a repository filter. (see [below for nested schema](#nestedatt--replication_configuration--rules--repository_filters))
39+
- `destinations` (Attributes List) An array of objects representing the destination for a replication rule. (see [below for nested schema](#nestedatt--replication_configuration--rules--destinations))
40+
- `repository_filters` (Attributes List) An array of objects representing the filters for a replication rule. Specifying a repository filter for a replication rule provides a method for controlling which repositories in a private registry are replicated. (see [below for nested schema](#nestedatt--replication_configuration--rules--repository_filters))
4141

4242
<a id="nestedatt--replication_configuration--rules--destinations"></a>
4343
### Nested Schema for `replication_configuration.rules.destinations`
4444

4545
Read-Only:
4646

47-
- `region` (String) A Region to replicate to.
48-
- `registry_id` (String) The account ID of the destination registry to replicate to.
47+
- `region` (String) The Region to replicate to.
48+
- `registry_id` (String) The AWS account ID of the Amazon ECR private registry to replicate to. When configuring cross-Region replication within your own registry, specify your own account ID.
4949

5050

5151
<a id="nestedatt--replication_configuration--rules--repository_filters"></a>
5252
### Nested Schema for `replication_configuration.rules.repository_filters`
5353

5454
Read-Only:
5555

56-
- `filter` (String) The repository filter to be applied for replication.
57-
- `filter_type` (String) Type of repository filter
56+
- `filter` (String) The repository filter details. When the ``PREFIX_MATCH`` filter type is specified, this value is required and should be the repository name prefix to configure replication for.
57+
- `filter_type` (String) The repository filter type. The only supported value is ``PREFIX_MATCH``, which is a repository name prefix specified with the ``filter`` parameter.

docs/data-sources/ecr_repository.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,10 @@ Data Source schema for AWS::ECR::Repository
4040
Read-Only:
4141

4242
- `encryption_type` (String) The encryption type to use.
43-
If you use the ``KMS`` encryption type, the contents of the repository will be encrypted using server-side encryption with KMSlong key stored in KMS. When you use KMS to encrypt your data, you can either use the default AWS managed KMS key for Amazon ECR, or specify your own KMS key, which you already created. For more information, see [Protecting data using server-side encryption with an key stored in (SSE-KMS)](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) in the *Amazon Simple Storage Service Console Developer Guide*.
44-
If you use the ``AES256`` encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES-256 encryption algorithm. For more information, see [Protecting data using server-side encryption with Amazon S3-managed encryption keys (SSE-S3)](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html) in the *Amazon Simple Storage Service Console Developer Guide*.
43+
If you use the ``KMS`` encryption type, the contents of the repository will be encrypted using server-side encryption with KMSlong key stored in KMS. When you use KMS to encrypt your data, you can either use the default AWS managed KMS key for Amazon ECR, or specify your own KMS key, which you already created.
44+
If you use the ``KMS_DSSE`` encryption type, the contents of the repository will be encrypted with two layers of encryption using server-side encryption with the KMS Management Service key stored in KMS. Similar to the ``KMS`` encryption type, you can either use the default AWS managed KMS key for Amazon ECR, or specify your own KMS key, which you've already created.
45+
If you use the ``AES256`` encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES256 encryption algorithm.
46+
For more information, see [Amazon ECR encryption at rest](https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html) in the *Amazon Elastic Container Registry User Guide*.
4547
- `kms_key` (String) If you use the ``KMS`` encryption type, specify the KMS key to use for encryption. The alias, key ID, or full ARN of the KMS key can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed KMS key for Amazon ECR will be used.
4648

4749

docs/data-sources/iam_saml_provider.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,25 @@ Data Source schema for AWS::IAM::SAMLProvider
2121

2222
### Read-Only
2323

24+
- `add_private_key` (String) The private key from your external identity provider
2425
- `arn` (String) Amazon Resource Name (ARN) of the SAML provider
26+
- `assertion_encryption_mode` (String) The encryption setting for the SAML provider
2527
- `name` (String)
28+
- `private_key_list` (Attributes List) (see [below for nested schema](#nestedatt--private_key_list))
29+
- `remove_private_key` (String) The Key ID of the private key to remove
2630
- `saml_metadata_document` (String)
31+
- `saml_provider_uuid` (String) The unique identifier assigned to the SAML provider
2732
- `tags` (Attributes List) (see [below for nested schema](#nestedatt--tags))
2833

34+
<a id="nestedatt--private_key_list"></a>
35+
### Nested Schema for `private_key_list`
36+
37+
Read-Only:
38+
39+
- `key_id` (String) The unique identifier for the SAML private key.
40+
- `timestamp` (String) The date and time, in <a href=\"http://www.iso.org/iso/iso8601\">ISO 8601 date-time </a> format, when the private key was uploaded.
41+
42+
2943
<a id="nestedatt--tags"></a>
3044
### Nested Schema for `tags`
3145

docs/data-sources/iot_account_audit_configuration.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,8 @@ Read-Only:
3535
- `ca_certificate_expiring_check` (Attributes) The configuration for a specific audit check. (see [below for nested schema](#nestedatt--audit_check_configurations--ca_certificate_expiring_check))
3636
- `ca_certificate_key_quality_check` (Attributes) The configuration for a specific audit check. (see [below for nested schema](#nestedatt--audit_check_configurations--ca_certificate_key_quality_check))
3737
- `conflicting_client_ids_check` (Attributes) The configuration for a specific audit check. (see [below for nested schema](#nestedatt--audit_check_configurations--conflicting_client_ids_check))
38-
- `device_certificate_expiring_check` (Attributes) The configuration for a specific audit check. (see [below for nested schema](#nestedatt--audit_check_configurations--device_certificate_expiring_check))
38+
- `device_certificate_age_check` (Attributes) A structure containing the configName and corresponding configValue for configuring DeviceCertAgeCheck. (see [below for nested schema](#nestedatt--audit_check_configurations--device_certificate_age_check))
39+
- `device_certificate_expiring_check` (Attributes) A structure containing the configName and corresponding configValue for configuring DeviceCertExpirationCheck. (see [below for nested schema](#nestedatt--audit_check_configurations--device_certificate_expiring_check))
3940
- `device_certificate_key_quality_check` (Attributes) The configuration for a specific audit check. (see [below for nested schema](#nestedatt--audit_check_configurations--device_certificate_key_quality_check))
4041
- `device_certificate_shared_check` (Attributes) The configuration for a specific audit check. (see [below for nested schema](#nestedatt--audit_check_configurations--device_certificate_shared_check))
4142
- `intermediate_ca_revoked_for_active_device_certificates_check` (Attributes) The configuration for a specific audit check. (see [below for nested schema](#nestedatt--audit_check_configurations--intermediate_ca_revoked_for_active_device_certificates_check))
@@ -80,13 +81,39 @@ Read-Only:
8081
- `enabled` (Boolean) True if the check is enabled.
8182

8283

84+
<a id="nestedatt--audit_check_configurations--device_certificate_age_check"></a>
85+
### Nested Schema for `audit_check_configurations.device_certificate_age_check`
86+
87+
Read-Only:
88+
89+
- `configuration` (Attributes) A structure containing the configName and corresponding configValue for configuring audit checks. (see [below for nested schema](#nestedatt--audit_check_configurations--device_certificate_age_check--configuration))
90+
- `enabled` (Boolean) True if the check is enabled.
91+
92+
<a id="nestedatt--audit_check_configurations--device_certificate_age_check--configuration"></a>
93+
### Nested Schema for `audit_check_configurations.device_certificate_age_check.configuration`
94+
95+
Read-Only:
96+
97+
- `cert_age_threshold_in_days` (String) The configValue for configuring audit checks.
98+
99+
100+
83101
<a id="nestedatt--audit_check_configurations--device_certificate_expiring_check"></a>
84102
### Nested Schema for `audit_check_configurations.device_certificate_expiring_check`
85103

86104
Read-Only:
87105

106+
- `configuration` (Attributes) A structure containing the configName and corresponding configValue for configuring audit checks. (see [below for nested schema](#nestedatt--audit_check_configurations--device_certificate_expiring_check--configuration))
88107
- `enabled` (Boolean) True if the check is enabled.
89108

109+
<a id="nestedatt--audit_check_configurations--device_certificate_expiring_check--configuration"></a>
110+
### Nested Schema for `audit_check_configurations.device_certificate_expiring_check.configuration`
111+
112+
Read-Only:
113+
114+
- `cert_expiration_threshold_in_days` (String) The configValue for configuring audit checks.
115+
116+
90117

91118
<a id="nestedatt--audit_check_configurations--device_certificate_key_quality_check"></a>
92119
### Nested Schema for `audit_check_configurations.device_certificate_key_quality_check`

docs/data-sources/rds_db_instance.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,9 @@ Data Source schema for AWS::RDS::DBInstance
6969
+ Web and Express editions: Must be an integer from 20 to 1024.
7070
- `allow_major_version_upgrade` (Boolean) A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
7171
Constraints: Major version upgrades must be allowed when specifying a value for the ``EngineVersion`` parameter that is a different major version than the DB instance's current version.
72-
- `apply_immediately` (Boolean)
72+
- `apply_immediately` (Boolean) Specifies whether changes to the DB instance and any pending modifications are applied immediately, regardless of the ``PreferredMaintenanceWindow`` setting. If set to ``false``, changes are applied during the next maintenance window. Until RDS applies the changes, the DB instance remains in a drift state. As a result, the configuration doesn't fully reflect the requested modifications and temporarily diverges from the intended state.
73+
In addition to the settings described in [Modifying a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html), this property also determines whether the DB instance reboots when a static parameter is modified in the associated DB parameter group.
74+
Default: ``true``
7375
- `associated_roles` (Attributes List) The IAMlong (IAM) roles associated with the DB instance.
7476
*Amazon Aurora*
7577
Not applicable. The associated roles are managed by the DB cluster. (see [below for nested schema](#nestedatt--associated_roles))
@@ -530,7 +532,7 @@ Data Source schema for AWS::RDS::DBInstance
530532
If you specify ``io1``, ``io2``, or ``gp3``, you must also include a value for the ``Iops`` parameter.
531533
This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.
532534
Valid Values: ``gp2 | gp3 | io1 | io2 | standard``
533-
Default: ``io1``, if the ``Iops`` parameter is specified. Otherwise, ``gp2``.
535+
Default: ``io1``, if the ``Iops`` parameter is specified. Otherwise, ``gp3``.
534536
- `tags` (Attributes List) Tags to assign to the DB instance. (see [below for nested schema](#nestedatt--tags))
535537
- `tde_credential_arn` (String)
536538
- `tde_credential_password` (String)

0 commit comments

Comments
 (0)