@awboost/cfn-resource-types 0.1.273 → 0.1.274

package/lib/AWS-ECR-PublicRepository.d.ts

@@ -1,12 +1,12 @@
 import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
 import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
 /**
- * The AWS::ECR::PublicRepository resource specifies an Amazon Elastic Container Public Registry (Amazon Public ECR) repository, where users can push and pull Docker images. For more information, see https://docs.aws.amazon.com/AmazonECR
+ * The ``AWS::ECR::PublicRepository`` resource specifies an Amazon Elastic Container Registry Public (Amazon ECR Public) repository, where users can push and pull Docker images, Open Container Initiative (OCI) images, and OCI compatible artifacts. For more information, see [Amazon ECR public repositories](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repositories.html) in the *Amazon ECR Public User Guide*.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html}
  */
 export type ECRPublicRepositoryProperties = {
     /**
-     * The CatalogData property type specifies Catalog data for ECR Public Repository. For information about Catalog Data, see <link>
+     * 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*.
      */
     RepositoryCatalogData?: {
         /**
@@ -36,14 +36,15 @@ export type ECRPublicRepositoryProperties = {
         UsageText?: 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.
-     * @minLength `2`
-     * @maxLength `256`
-     * @pattern `^(?=.{2,256}$)((?:[a-z0-9]+(?:[._-][a-z0-9]+)/‍*)*[a-z0-9]+(?:[._-][a-z0-9]+)*)$`
-     */
+       * 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).
+        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.
+       * @minLength `2`
+       * @maxLength `256`
+       * @pattern `^(?=.{2,256}$)((?:[a-z0-9]+(?:[._-][a-z0-9]+)/‍*)*[a-z0-9]+(?:[._-][a-z0-9]+)*)$`
+       */
     RepositoryName?: 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.
+     * 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*.
      */
     RepositoryPolicyText?: Record<string, any> | string;
     /**
@@ -61,25 +62,25 @@ export type ECRPublicRepositoryAttributes = {
 };
 /**
  * Type definition for `AWS::ECR::PublicRepository.Tag`.
- * A key-value pair to associate with a resource.
+ * The metadata to apply to a resource to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-publicrepository-tag.html}
  */
 export type Tag = {
     /**
-     * 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 -.
+     * 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.
      * @minLength `1`
      * @maxLength `127`
      */
     Key: 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 -.
+     * A ``value`` acts as a descriptor within a tag category (key).
      * @minLength `1`
      * @maxLength `255`
      */
     Value: string;
 };
 /**
- * The AWS::ECR::PublicRepository resource specifies an Amazon Elastic Container Public Registry (Amazon Public ECR) repository, where users can push and pull Docker images. For more information, see https://docs.aws.amazon.com/AmazonECR
+ * The ``AWS::ECR::PublicRepository`` resource specifies an Amazon Elastic Container Registry Public (Amazon ECR Public) repository, where users can push and pull Docker images, Open Container Initiative (OCI) images, and OCI compatible artifacts. For more information, see [Amazon ECR public repositories](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repositories.html) in the *Amazon ECR Public User Guide*.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html}
  */
 export declare class ECRPublicRepository extends $Resource<"AWS::ECR::PublicRepository", ECRPublicRepositoryProperties, ECRPublicRepositoryAttributes> {

package/lib/AWS-ECR-PublicRepository.js

@@ -1,6 +1,6 @@
 import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
 /**
- * The AWS::ECR::PublicRepository resource specifies an Amazon Elastic Container Public Registry (Amazon Public ECR) repository, where users can push and pull Docker images. For more information, see https://docs.aws.amazon.com/AmazonECR
+ * The ``AWS::ECR::PublicRepository`` resource specifies an Amazon Elastic Container Registry Public (Amazon ECR Public) repository, where users can push and pull Docker images, Open Container Initiative (OCI) images, and OCI compatible artifacts. For more information, see [Amazon ECR public repositories](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repositories.html) in the *Amazon ECR Public User Guide*.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html}
  */
 export class ECRPublicRepository extends $Resource {

package/lib/AWS-ECR-PullThroughCacheRule.d.ts

@@ -1,35 +1,35 @@
 import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
 import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
 /**
- * The AWS::ECR::PullThroughCacheRule resource configures the upstream registry configuration details for an Amazon Elastic Container Registry (Amazon Private ECR) pull-through cache.
+ * The ``AWS::ECR::PullThroughCacheRule`` resource creates or updates a pull through cache rule. A pull through cache rule provides a way to cache images from an upstream registry in your Amazon ECR private registry.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-pullthroughcacherule.html}
  */
 export type ECRPullThroughCacheRuleProperties = {
     /**
-     * The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that identifies the credentials to authenticate to the upstream registry.
+     * The ARN of the Secrets Manager secret associated with the pull through cache rule.
      * @minLength `50`
      * @maxLength `612`
      * @pattern `^arn:aws:secretsmanager:[a-zA-Z0-9-:]+:secret:ecr\-pullthroughcache\/[a-zA-Z0-9\/_+=.@-]+$`
      */
     CredentialArn?: string;
     /**
-     * The ECRRepositoryPrefix is a custom alias for upstream registry url.
+     * The Amazon ECR repository prefix associated with the pull through cache rule.
      * @minLength `2`
      * @maxLength `30`
      * @pattern `(?:[a-z0-9]+(?:[._-][a-z0-9]+)/‍*)*[a-z0-9]+(?:[._-][a-z0-9]+)*`
      */
     EcrRepositoryPrefix?: string;
     /**
-     * The name of the upstream registry.
+     * The name of the upstream source registry associated with the pull through cache rule.
      */
     UpstreamRegistry?: string;
     /**
-     * The upstreamRegistryUrl is the endpoint of upstream registry url of the public repository to be cached
+     * The upstream registry URL associated with the pull through cache rule.
      */
     UpstreamRegistryUrl?: string;
 };
 /**
- * The AWS::ECR::PullThroughCacheRule resource configures the upstream registry configuration details for an Amazon Elastic Container Registry (Amazon Private ECR) pull-through cache.
+ * The ``AWS::ECR::PullThroughCacheRule`` resource creates or updates a pull through cache rule. A pull through cache rule provides a way to cache images from an upstream registry in your Amazon ECR private registry.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-pullthroughcacherule.html}
  */
 export declare class ECRPullThroughCacheRule extends $Resource<"AWS::ECR::PullThroughCacheRule", ECRPullThroughCacheRuleProperties, Record<string, never>> {

package/lib/AWS-ECR-PullThroughCacheRule.js

@@ -1,6 +1,6 @@
 import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
 /**
- * The AWS::ECR::PullThroughCacheRule resource configures the upstream registry configuration details for an Amazon Elastic Container Registry (Amazon Private ECR) pull-through cache.
+ * The ``AWS::ECR::PullThroughCacheRule`` resource creates or updates a pull through cache rule. A pull through cache rule provides a way to cache images from an upstream registry in your Amazon ECR private registry.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-pullthroughcacherule.html}
  */
 export class ECRPullThroughCacheRule extends $Resource {

package/lib/AWS-ECR-ReplicationConfiguration.d.ts

@@ -1,12 +1,13 @@
 import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
 import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
 /**
- * The AWS::ECR::ReplicationConfiguration resource configures the replication destinations for an Amazon Elastic Container Registry (Amazon Private ECR). For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/replication.html
+ * The ``AWS::ECR::ReplicationConfiguration`` resource creates or updates the replication configuration for a private registry. The first time a replication configuration is applied to a private registry, a service-linked IAM role is created in your account for the replication process. For more information, see [Using Service-Linked Roles for Amazon ECR](https://docs.aws.amazon.com/AmazonECR/latest/userguide/using-service-linked-roles.html) in the *Amazon Elastic Container Registry User Guide*.
+  When configuring cross-account replication, the destination account must grant the source account permission to replicate. This permission is controlled using a private registry permissions policy. For more information, see ``AWS::ECR::RegistryPolicy``.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html}
  */
 export type ECRReplicationConfigurationProperties = {
     /**
-     * An object representing the replication configuration for a registry.
+     * The replication configuration for a registry.
      */
     ReplicationConfiguration: ReplicationConfiguration;
 };
@@ -15,9 +16,6 @@ export type ECRReplicationConfigurationProperties = {
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html#aws-resource-ecr-replicationconfiguration-return-values}
  */
 export type ECRReplicationConfigurationAttributes = {
-    /**
-     * The RegistryId associated with the aws account.
-     */
     RegistryId: string;
 };
 /**
@@ -28,12 +26,12 @@ export type ECRReplicationConfigurationAttributes = {
 export type FilterType = "PREFIX_MATCH";
 /**
  * Type definition for `AWS::ECR::ReplicationConfiguration.ReplicationConfiguration`.
- * An object representing the replication configuration for a registry.
+ * The replication configuration for a registry.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html}
  */
 export type ReplicationConfiguration = {
     /**
-     * An array of objects representing the replication rules for a replication configuration. A replication configuration may contain a maximum of 10 rules.
+     * An array of objects representing the replication destinations and repository filters for a replication configuration.
      * @minLength `0`
      * @maxLength `10`
      */
@@ -41,35 +39,35 @@ export type ReplicationConfiguration = {
 };
 /**
  * Type definition for `AWS::ECR::ReplicationConfiguration.ReplicationDestination`.
- * An array of objects representing the details of a replication destination.
+ * An array of objects representing the destination for a replication rule.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html}
  */
 export type ReplicationDestination = {
     /**
-     * A Region to replicate to.
+     * The Region to replicate to.
      * @pattern `[0-9a-z-]{2,25}`
      */
     Region: string;
     /**
-     * The account ID of the destination registry to replicate to.
+     * 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.
      * @pattern `^[0-9]{12}$`
      */
     RegistryId: string;
 };
 /**
  * Type definition for `AWS::ECR::ReplicationConfiguration.ReplicationRule`.
- * An array of objects representing the details of a replication destination.
+ * An array of objects representing the replication destinations and repository filters for a replication configuration.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html}
  */
 export type ReplicationRule = {
     /**
-     * An array of objects representing the details of a replication destination.
+     * An array of objects representing the destination for a replication rule.
      * @minLength `1`
      * @maxLength `25`
      */
     Destinations: ReplicationDestination[];
     /**
-     * An array of objects representing the details of a repository filter.
+     * 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.
      * @minLength `0`
      * @maxLength `100`
      */
@@ -77,22 +75,23 @@ export type ReplicationRule = {
 };
 /**
  * Type definition for `AWS::ECR::ReplicationConfiguration.RepositoryFilter`.
- * An array of objects representing the details of a repository filter.
+ * The filter settings used with image replication. Specifying a repository filter to a replication rule provides a method for controlling which repositories in a private registry are replicated. If no filters are added, the contents of all repositories are replicated.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-repositoryfilter.html}
  */
 export type RepositoryFilter = {
     /**
-     * The repository filter to be applied for replication.
+     * 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.
      * @pattern `^(?:[a-z0-9]+(?:[._-][a-z0-9]*)/‍*)*[a-z0-9]*(?:[._-][a-z0-9]*)*$`
      */
     Filter: string;
     /**
-     * Type of repository filter
+     * The repository filter type. The only supported value is ``PREFIX_MATCH``, which is a repository name prefix specified with the ``filter`` parameter.
      */
     FilterType: FilterType;
 };
 /**
- * The AWS::ECR::ReplicationConfiguration resource configures the replication destinations for an Amazon Elastic Container Registry (Amazon Private ECR). For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/replication.html
+ * The ``AWS::ECR::ReplicationConfiguration`` resource creates or updates the replication configuration for a private registry. The first time a replication configuration is applied to a private registry, a service-linked IAM role is created in your account for the replication process. For more information, see [Using Service-Linked Roles for Amazon ECR](https://docs.aws.amazon.com/AmazonECR/latest/userguide/using-service-linked-roles.html) in the *Amazon Elastic Container Registry User Guide*.
+  When configuring cross-account replication, the destination account must grant the source account permission to replicate. This permission is controlled using a private registry permissions policy. For more information, see ``AWS::ECR::RegistryPolicy``.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html}
  */
 export declare class ECRReplicationConfiguration extends $Resource<"AWS::ECR::ReplicationConfiguration", ECRReplicationConfigurationProperties, ECRReplicationConfigurationAttributes> {

package/lib/AWS-ECR-ReplicationConfiguration.js

@@ -1,6 +1,7 @@
 import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
 /**
- * The AWS::ECR::ReplicationConfiguration resource configures the replication destinations for an Amazon Elastic Container Registry (Amazon Private ECR). For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/replication.html
+ * The ``AWS::ECR::ReplicationConfiguration`` resource creates or updates the replication configuration for a private registry. The first time a replication configuration is applied to a private registry, a service-linked IAM role is created in your account for the replication process. For more information, see [Using Service-Linked Roles for Amazon ECR](https://docs.aws.amazon.com/AmazonECR/latest/userguide/using-service-linked-roles.html) in the *Amazon Elastic Container Registry User Guide*.
+  When configuring cross-account replication, the destination account must grant the source account permission to replicate. This permission is controlled using a private registry permissions policy. For more information, see ``AWS::ECR::RegistryPolicy``.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html}
  */
 export class ECRReplicationConfiguration extends $Resource {

package/lib/AWS-ECR-Repository.d.ts

@@ -55,15 +55,17 @@ export type ECRRepositoryAttributes = {
 /**
  * Type definition for `AWS::ECR::Repository.EncryptionConfiguration`.
  * The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.
- By default, when no encryption configuration is set or the ``AES256`` encryption type is used, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts your data at rest using an AES-256 encryption algorithm. This does not require any action on your part.
+ By default, when no encryption configuration is set or the ``AES256`` encryption type is used, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts your data at rest using an AES256 encryption algorithm. This does not require any action on your part.
  For more control over the encryption of the contents of your repository, you can use server-side encryption with KMSlong key stored in KMSlong (KMS) to encrypt your images. 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*.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-encryptionconfiguration.html}
  */
 export type EncryptionConfiguration = {
     /**
        * The encryption type to use.
-       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*.
-       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*.
+       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.
+       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.
+       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.
+       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*.
        */
     EncryptionType: EncryptionType;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awboost/cfn-resource-types",
-  "version": "0.1.273",
+  "version": "0.1.274",
   "publishConfig": {
     "access": "public"
   },