@propulsionworks/cloudformation 0.1.0 → 0.1.2

package/out/exports/resources.generated/aws-s3-accessgrantslocation.d.ts

@@ -1,4 +1,17 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * The `AWS::S3::AccessGrantsLocation` resource creates the S3 data location that you would like to register in your S3 Access Grants instance. Your S3 data must be in the same Region as your S3 Access Grants instance. The location can be one of the following:
+ *
+ * - The default S3 location `s3://`
+ * - A bucket - `S3://<bucket-name>`
+ * - A bucket and prefix - `S3://<bucket-name>/<prefix>`
+ *
+ * When you register a location, you must include the IAM role that has permission to manage the S3 location that you are registering. Give S3 Access Grants permission to assume this role [using a policy](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-grants-location.html) . S3 Access Grants assumes this role to manage access to the location and to vend temporary credentials to grantees or client applications.
+ *
+ * - **Permissions** - You must have the `s3:CreateAccessGrantsLocation` permission to use this resource.
+ * - **Additional Permissions** - You must also have the following permission for the specified IAM role: `iam:PassRole`
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html}
+ */
 export type S3AccessGrantsLocation = ResourceDefinitionWithAttributes<"AWS::S3::AccessGrantsLocation", S3AccessGrantsLocationProps, S3AccessGrantsLocationAttribs>;
 /**
  * The `AWS::S3::AccessGrantsLocation` resource creates the S3 data location that you would like to register in your S3 Access Grants instance. Your S3 data must be in the same Region as your S3 Access Grants instance. The location can be one of the following:
@@ -11,31 +24,40 @@ export type S3AccessGrantsLocation = ResourceDefinitionWithAttributes<"AWS::S3::
  *
  * - **Permissions** - You must have the `s3:CreateAccessGrantsLocation` permission to use this resource.
  * - **Additional Permissions** - You must also have the following permission for the specified IAM role: `iam:PassRole`
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html}
  */
 export type S3AccessGrantsLocationProps = {
     /**
      * The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this role to manage access to the registered location.
      * @example "arn:aws:iamw::123456789012:role/rolename"
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html#cfn-s3-accessgrantslocation-iamrolearn}
      */
     IamRoleArn?: string | undefined;
     /**
      * The S3 URI path to the location that you are registering. The location scope can be the default S3 location `s3://` , the S3 path to a bucket, or the S3 path to a bucket and prefix. A prefix in S3 is a string of characters at the beginning of an object key name used to organize the objects that you store in your S3 buckets. For example, object key names that start with the `engineering/` prefix or object key names that start with the `marketing/campaigns/` prefix.
      * @example "s3://test-bucket-access-grants-cmh/prefixA"
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html#cfn-s3-accessgrantslocation-locationscope}
      */
     LocationScope?: string | undefined;
     /**
      * The AWS resource tags that you are adding to the S3 Access Grants location. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html#cfn-s3-accessgrantslocation-tags}
      */
     Tags?: Tag[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html#aws-resource-s3-accessgrantslocation-return-values}
+ */
 export type S3AccessGrantsLocationAttribs = {
     /**
      * The ARN of the location you are registering.
      * @example "arn:aws:s3:us-east-2:479290226168:access-grants/default/location/125f332b-a499-4eb6-806f-8a6a1aa4cb96"
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html#cfn-s3-accessgrantslocation-accessgrantslocationarn}
      */
     AccessGrantsLocationArn: string;
     /**
      * The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID `default` to the default location `s3://` and assigns an auto-generated ID to other locations that you register.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html#cfn-s3-accessgrantslocation-accessgrantslocationid}
      */
     AccessGrantsLocationId: string;
 };

package/out/exports/resources.generated/aws-s3-accesspoint.d.ts

@@ -1,19 +1,26 @@
 import type { ResourceDefinitionWithAttributes, TemplatePolicyDocument } from "../main.ts";
+/**
+ * The AWS::S3::AccessPoint resource is an Amazon S3 resource type that you can use to access buckets.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html}
+ */
 export type S3AccessPoint = ResourceDefinitionWithAttributes<"AWS::S3::AccessPoint", S3AccessPointProps, S3AccessPointAttribs>;
 /**
  * The AWS::S3::AccessPoint resource is an Amazon S3 resource type that you can use to access buckets.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html}
  */
 export type S3AccessPointProps = {
     /**
      * The name of the bucket associated with this access point.
      * @minLength 3
      * @maxLength 255
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-bucket}
      */
     Bucket: string;
     /**
      * The AWS account ID associated with the S3 bucket associated with this access point.
      * @maxLength 64
      * @pattern ^\d{12}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-bucketaccountid}
      */
     BucketAccountId?: string | undefined;
     /**
@@ -21,33 +28,41 @@ export type S3AccessPointProps = {
      * @minLength 3
      * @maxLength 50
      * @pattern ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-name}
      */
     Name?: string | undefined;
     /**
      * The access point policy associated with this access point.
-     * @policy
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-policy}
      */
     Policy?: TemplatePolicyDocument | undefined;
     /**
      * The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see [The Meaning of "Public"](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) in the *Amazon S3 User Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-publicaccessblockconfiguration}
      */
     PublicAccessBlockConfiguration?: PublicAccessBlockConfiguration | undefined;
     /**
      * The Virtual Private Cloud (VPC) configuration for this access point, if one exists.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-vpcconfiguration}
      */
     VpcConfiguration?: VpcConfiguration | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#aws-resource-s3-accesspoint-return-values}
+ */
 export type S3AccessPointAttribs = {
     /**
      * The alias for this access point.
      * @minLength 3
      * @maxLength 63
      * @pattern ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-alias}
      */
     Alias: string;
     /**
      * This property contains the details of the ARN for the access point.
      * @example "arn:aws:s3:us-west-2:123456789012:accesspoint/test"
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-arn}
      */
     Arn: string;
     /**
@@ -55,17 +70,20 @@ export type S3AccessPointAttribs = {
      * @minLength 3
      * @maxLength 50
      * @pattern ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-name}
      */
     Name: string;
     /**
      * Indicates whether this access point allows access from the internet. If `VpcConfiguration` is specified for this access point, then `NetworkOrigin` is `VPC` , and the access point doesn't allow access from the internet. Otherwise, `NetworkOrigin` is `Internet` , and the access point allows access from the internet, subject to the access point and bucket access policies.
      *
      * *Allowed values* : `VPC` | `Internet`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-networkorigin}
      */
     NetworkOrigin: "Internet" | "VPC";
 };
 /**
  * The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see [The Meaning of "Public"](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) in the *Amazon S3 User Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-publicaccessblockconfiguration.html}
  */
 export type PublicAccessBlockConfiguration = {
     /**
@@ -76,35 +94,41 @@ export type PublicAccessBlockConfiguration = {
      * - PUT Bucket calls fail if the request includes a public ACL.
      *
      * Enabling this setting doesn't affect existing policies or ACLs.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-publicaccessblockconfiguration.html#cfn-s3-accesspoint-publicaccessblockconfiguration-blockpublicacls}
      */
     BlockPublicAcls?: boolean | undefined;
     /**
      * Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to `TRUE` causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.
      *
      * Enabling this setting doesn't affect existing bucket policies.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-publicaccessblockconfiguration.html#cfn-s3-accesspoint-publicaccessblockconfiguration-blockpublicpolicy}
      */
     BlockPublicPolicy?: boolean | undefined;
     /**
      * Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to `TRUE` causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket.
      *
      * Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-publicaccessblockconfiguration.html#cfn-s3-accesspoint-publicaccessblockconfiguration-ignorepublicacls}
      */
     IgnorePublicAcls?: boolean | undefined;
     /**
      * Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to `TRUE` restricts access to this bucket to only AWS service principals and authorized users within this account if the bucket has a public policy.
      *
      * Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-publicaccessblockconfiguration.html#cfn-s3-accesspoint-publicaccessblockconfiguration-restrictpublicbuckets}
      */
     RestrictPublicBuckets?: boolean | undefined;
 };
 /**
  * The Virtual Private Cloud (VPC) configuration for this access point.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-vpcconfiguration.html}
  */
 export type VpcConfiguration = {
     /**
      * If this field is specified, the access point will only allow connections from the specified VPC ID.
      * @minLength 1
      * @maxLength 1024
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-vpcconfiguration.html#cfn-s3-accesspoint-vpcconfiguration-vpcid}
      */
     VpcId?: string | undefined;
 };