@propulsionworks/cloudformation 0.1.30 → 0.1.32

package/out/exports/resources.generated/aws-quicksight-dataset.d.ts

@@ -18,7 +18,7 @@ export type QuickSightDataSetProps = {
      */
     AwsAccountId?: string | undefined;
     /**
-     * Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
+     * Groupings of columns that work together in certain Amazon Quick Sight features. Currently, only geospatial hierarchy is supported.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-columngroups}
      */
     ColumnGroups?: ColumnGroup[] | undefined;
@@ -150,7 +150,7 @@ export type QuickSightDataSetAttribs = {
  */
 export type CalculatedColumn = {
     /**
-     * A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Amazon QuickSight preserves the existing calculated column.
+     * A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Quick Sight preserves the existing calculated column.
      * @minLength 1
      * @maxLength 64
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-calculatedcolumn.html#cfn-quicksight-dataset-calculatedcolumn-columnid}
@@ -184,7 +184,7 @@ export type CastColumnTypeOperation = {
      */
     ColumnName?: string | undefined;
     /**
-     * When casting a column from string to datetime type, you can supply a string in a format supported by Amazon QuickSight to denote the source data format.
+     * When casting a column from string to datetime type, you can supply a string in a format supported by Quick Sight to denote the source data format.
      * @minLength 0
      * @maxLength 32
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-castcolumntypeoperation.html#cfn-quicksight-dataset-castcolumntypeoperation-format}
@@ -223,7 +223,7 @@ export type ColumnDescription = {
     Text?: string | undefined;
 };
 /**
- * Groupings of columns that work together in certain Amazon QuickSight features. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
+ * Groupings of columns that work together in certain Quick Sight features. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columngroup.html}
  */
 export type ColumnGroup = {
@@ -244,7 +244,7 @@ export type ColumnLevelPermissionRule = {
      */
     ColumnNames?: string[] | undefined;
     /**
-     * An array of Amazon Resource Names (ARNs) for QuickSight users or groups.
+     * An array of Amazon Resource Names (ARNs) for Quick Suite users or groups.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columnlevelpermissionrule.html#cfn-quicksight-dataset-columnlevelpermissionrule-principals}
      */
     Principals?: string[] | undefined;
@@ -342,7 +342,7 @@ export type DataSetUsageConfiguration = {
      */
     DisableUseAsDirectQuerySource?: boolean | undefined;
     /**
-     * An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.
+     * An option that controls whether a child dataset that's stored in Quick Sight can use this dataset as a source.
      * @default false
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetusageconfiguration.html#cfn-quicksight-dataset-datasetusageconfiguration-disableuseasimportedsource}
      */
@@ -690,7 +690,7 @@ export type JoinInstruction = {
  */
 export type JoinKeyProperties = {
     /**
-     * A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by QuickSight to optimize query performance.
+     * A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Quick Suite to optimize query performance.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joinkeyproperties.html#cfn-quicksight-dataset-joinkeyproperties-uniquekey}
      */
     UniqueKey?: boolean | undefined;
@@ -974,9 +974,9 @@ export type ResourcePermission = {
     /**
      * The Amazon Resource Name (ARN) of the principal. This can be one of the following:
      *
-     * - The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
-     * - The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
-     * - The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)
+     * - The ARN of an Amazon Quick Suite user or group associated with a data source or dataset. (This is common.)
+     * - The ARN of an Amazon Quick Suite user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
+     * - The ARN of an AWS account root: This is an IAM ARN rather than a Quick Suite ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)
      * @minLength 1
      * @maxLength 256
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-resourcepermission.html#cfn-quicksight-dataset-resourcepermission-principal}
@@ -984,7 +984,7 @@ export type ResourcePermission = {
     Principal: string;
 };
 /**
- * Information about a dataset that contains permissions for row-level security (RLS). The permissions dataset maps fields to users or groups. For more information, see [Using Row-Level Security (RLS) to Restrict Access to a Dataset](https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html) in the *Amazon QuickSight User Guide* .
+ * Information about a dataset that contains permissions for row-level security (RLS). The permissions dataset maps fields to users or groups. For more information, see [Using Row-Level Security (RLS) to Restrict Access to a Dataset](https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html) in the *Quick Sight User Guide* .
  *
  * The option to deny permissions by setting `PermissionPolicy` to `DENY_ACCESS` is not supported for new RLS datasets.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiondataset.html}

package/out/exports/resources.generated/aws-quicksight-datasource.d.ts

@@ -23,7 +23,7 @@ export type QuickSightDataSourceProps = {
      */
     AwsAccountId?: string | undefined;
     /**
-     * The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
+     * The credentials Amazon Quick Sight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-credentials}
      */
     Credentials?: DataSourceCredentials | undefined;
@@ -33,7 +33,7 @@ export type QuickSightDataSourceProps = {
      */
     DataSourceId?: string | undefined;
     /**
-     * The parameters that Amazon QuickSight uses to connect to your underlying source.
+     * The parameters that Amazon Quick Sight uses to connect to your underlying source.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-datasourceparameters}
      */
     DataSourceParameters?: DataSourceParameters | undefined;
@@ -59,7 +59,7 @@ export type QuickSightDataSourceProps = {
      */
     Permissions?: ResourcePermission[] | undefined;
     /**
-     * Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
+     * Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to your underlying source.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-sslproperties}
      */
     SslProperties?: SslProperties | undefined;
@@ -76,7 +76,7 @@ export type QuickSightDataSourceProps = {
      */
     Type: DataSourceType;
     /**
-     * Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
+     * Use this parameter only when you want Amazon Quick Sight to use a VPC connection when connecting to your underlying source.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-vpcconnectionproperties}
      */
     VpcConnectionProperties?: VpcConnectionProperties | undefined;
@@ -140,9 +140,9 @@ export type AmazonOpenSearchParameters = {
  */
 export type AthenaParameters = {
     /**
-     * An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your workgroup.
+     * An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
      *
-     * This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center.
+     * This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-athenaparameters.html#cfn-quicksight-datasource-athenaparameters-identitycenterconfiguration}
      */
     IdentityCenterConfiguration?: IdentityCenterConfiguration | undefined;
@@ -292,7 +292,7 @@ export type DataSourceErrorInfo = {
  */
 export type DataSourceErrorInfoType = "ACCESS_DENIED" | "COPY_SOURCE_NOT_FOUND" | "TIMEOUT" | "ENGINE_VERSION_NOT_SUPPORTED" | "UNKNOWN_HOST" | "GENERIC_SQL_FAILURE" | "CONFLICT" | "UNKNOWN";
 /**
- * The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
+ * The parameters that Quick Sight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html}
  */
 export type DataSourceParameters = {
@@ -660,30 +660,30 @@ export type RdsParameters = {
     InstanceId: string;
 };
 /**
- * A structure that grants Amazon QuickSight access to your cluster and make a call to the `redshift:GetClusterCredentials` API. For more information on the `redshift:GetClusterCredentials` API, see [`GetClusterCredentials`](https://docs.aws.amazon.com/redshift/latest/APIReference/API_GetClusterCredentials.html) .
+ * A structure that grants Quick Sight access to your cluster and make a call to the `redshift:GetClusterCredentials` API. For more information on the `redshift:GetClusterCredentials` API, see [`GetClusterCredentials`](https://docs.aws.amazon.com/redshift/latest/APIReference/API_GetClusterCredentials.html) .
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftiamparameters.html}
  */
 export type RedshiftIAMParameters = {
     /**
-     * Automatically creates a database user. If your database doesn't have a `DatabaseUser` , set this parameter to `True` . If there is no `DatabaseUser` , Amazon QuickSight can't connect to your cluster. The `RoleArn` that you use for this operation must grant access to `redshift:CreateClusterUser` to successfully create the user.
+     * Automatically creates a database user. If your database doesn't have a `DatabaseUser` , set this parameter to `True` . If there is no `DatabaseUser` , Quick Sight can't connect to your cluster. The `RoleArn` that you use for this operation must grant access to `redshift:CreateClusterUser` to successfully create the user.
      * @default false
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftiamparameters.html#cfn-quicksight-datasource-redshiftiamparameters-autocreatedatabaseuser}
      */
     AutoCreateDatabaseUser?: boolean | undefined;
     /**
-     * A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the `DatabaseUser` . If you choose to include this parameter, the `RoleArn` must grant access to `redshift:JoinGroup` .
+     * A list of groups whose permissions will be granted to Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight by the `DatabaseUser` . If you choose to include this parameter, the `RoleArn` must grant access to `redshift:JoinGroup` .
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftiamparameters.html#cfn-quicksight-datasource-redshiftiamparameters-databasegroups}
      */
     DatabaseGroups?: string[] | undefined;
     /**
-     * The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of `AutoCreateDatabaseUser` to `True` to create a new user with PUBLIC permissions.
+     * The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight is granted the same permissions that the user has. If the user doesn't exist, set the value of `AutoCreateDatabaseUser` to `True` to create a new user with PUBLIC permissions.
      * @minLength 1
      * @maxLength 64
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftiamparameters.html#cfn-quicksight-datasource-redshiftiamparameters-databaseuser}
      */
     DatabaseUser?: string | undefined;
     /**
-     * Use the `RoleArn` structure to allow Amazon QuickSight to call `redshift:GetClusterCredentials` on your cluster. The calling principal must have `iam:PassRole` access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
+     * Use the `RoleArn` structure to allow Quick Sight to call `redshift:GetClusterCredentials` on your cluster. The calling principal must have `iam:PassRole` access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
      * @minLength 20
      * @maxLength 2048
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftiamparameters.html#cfn-quicksight-datasource-redshiftiamparameters-rolearn}
@@ -717,14 +717,14 @@ export type RedshiftParameters = {
      */
     Host?: string | undefined;
     /**
-     * An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of [DataSourceCredentials](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DataSourceCredentials.html) .
+     * An optional parameter that uses IAM authentication to grant Quick Sight access to your cluster. This parameter can be used instead of [DataSourceCredentials](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DataSourceCredentials.html) .
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftparameters.html#cfn-quicksight-datasource-redshiftparameters-iamparameters}
      */
     IAMParameters?: RedshiftIAMParameters | undefined;
     /**
-     * An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster.
+     * An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
      *
-     * This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center.
+     * This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftparameters.html#cfn-quicksight-datasource-redshiftparameters-identitycenterconfiguration}
      */
     IdentityCenterConfiguration?: IdentityCenterConfiguration | undefined;
@@ -750,9 +750,9 @@ export type ResourcePermission = {
     /**
      * The Amazon Resource Name (ARN) of the principal. This can be one of the following:
      *
-     * - The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
-     * - The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
-     * - The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)
+     * - The ARN of an Amazon Quick Suite user or group associated with a data source or dataset. (This is common.)
+     * - The ARN of an Amazon Quick Suite user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
+     * - The ARN of an AWS account root: This is an IAM ARN rather than a Quick Suite ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)
      * @minLength 1
      * @maxLength 256
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-resourcepermission.html#cfn-quicksight-datasource-resourcepermission-principal}
@@ -773,7 +773,7 @@ export type ResourceStatus = "CREATION_IN_PROGRESS" | "CREATION_SUCCESSFUL" | "C
  */
 export type S3Parameters = {
     /**
-     * Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
+     * Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Quick Sight.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-s3parameters.html#cfn-quicksight-datasource-s3parameters-manifestfilelocation}
      */
     ManifestFileLocation: ManifestFileLocation;
@@ -817,7 +817,7 @@ export type SnowflakeParameters = {
      */
     Host: string;
     /**
-     * An object that contains information needed to create a data source connection between an Amazon QuickSight account and Snowflake.
+     * An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-snowflakeparameters.html#cfn-quicksight-datasource-snowflakeparameters-oauthparameters}
      */
     OAuthParameters?: OAuthParameters | undefined;
@@ -879,7 +879,7 @@ export type SqlServerParameters = {
     Port: number;
 };
 /**
- * Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying data source.
+ * Secure Socket Layer (SSL) properties that apply when Quick Sight connects to your underlying data source.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-sslproperties.html}
  */
 export type SslProperties = {
@@ -922,7 +922,7 @@ export type StarburstParameters = {
      */
     Host: string;
     /**
-     * An object that contains information needed to create a data source connection between an Amazon QuickSight account and Starburst.
+     * An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-starburstparameters.html#cfn-quicksight-datasource-starburstparameters-oauthparameters}
      */
     OAuthParameters?: OAuthParameters | undefined;

package/out/exports/resources.generated/aws-quicksight-refreshschedule.d.ts

@@ -1,11 +1,11 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
 /**
- * Creates a refresh schedule for a dataset in QuickSight .
+ * Creates a refresh schedule for a dataset in Quick Suite .
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-refreshschedule.html}
  */
 export type QuickSightRefreshSchedule = ResourceDefinitionWithAttributes<"AWS::QuickSight::RefreshSchedule", QuickSightRefreshScheduleProps, QuickSightRefreshScheduleAttribs>;
 /**
- * Creates a refresh schedule for a dataset in QuickSight .
+ * Creates a refresh schedule for a dataset in Quick Suite .
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-refreshschedule.html}
  */
 export type QuickSightRefreshScheduleProps = {
@@ -49,7 +49,7 @@ export type RefreshScheduleMap = {
      * - `FULL_REFRESH` : A complete refresh of a dataset.
      * - `INCREMENTAL_REFRESH` : A partial refresh of some rows of a dataset, based on the time window specified.
      *
-     * For more information on full and incremental refreshes, see [Refreshing SPICE data](https://docs.aws.amazon.com/quicksight/latest/user/refreshing-imported-data.html) in the *QuickSight User Guide* .
+     * For more information on full and incremental refreshes, see [Refreshing SPICE data](https://docs.aws.amazon.com/quicksight/latest/user/refreshing-imported-data.html) in the *Quick Suite User Guide* .
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-refreshschedulemap.html#cfn-quicksight-refreshschedule-refreshschedulemap-refreshtype}
      */
     RefreshType?: "FULL_REFRESH" | "INCREMENTAL_REFRESH" | undefined;