@awboost/cfn-resource-types 0.1.516 → 0.1.517
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.
- package/lib/AWS-BedrockAgentCore-Gateway.d.ts +73 -0
- package/lib/AWS-BedrockAgentCore-GatewayTarget.d.ts +10 -0
- package/lib/AWS-ECR-RepositoryCreationTemplate.d.ts +1 -1
- package/lib/AWS-Logs-LogGroup.d.ts +3 -0
- package/lib/AWS-Logs-MetricFilter.d.ts +4 -0
- package/lib/AWS-Logs-SubscriptionFilter.d.ts +4 -0
- package/lib/AWS-MediaPackageV2-OriginEndpoint.d.ts +6 -0
- package/lib/AWS-QuickSight-DataSet.d.ts +12 -12
- package/lib/AWS-QuickSight-DataSource.d.ts +36 -13
- package/package.json +1 -1
|
@@ -83,6 +83,65 @@ export type AuthorizerConfiguration = {
|
|
|
83
83
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-authorizertype.html}
|
|
84
84
|
*/
|
|
85
85
|
export type AuthorizerType = "CUSTOM_JWT" | "AWS_IAM" | "NONE";
|
|
86
|
+
/**
|
|
87
|
+
* Type definition for `AWS::BedrockAgentCore::Gateway.AuthorizingClaimMatchValueType`.
|
|
88
|
+
* The value or values in the custom claim to match and relationship of match
|
|
89
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-authorizingclaimmatchvaluetype.html}
|
|
90
|
+
*/
|
|
91
|
+
export type AuthorizingClaimMatchValueType = {
|
|
92
|
+
/**
|
|
93
|
+
* The relationship between the claim field value and the value or values being matched
|
|
94
|
+
*/
|
|
95
|
+
ClaimMatchOperator: ClaimMatchOperator;
|
|
96
|
+
/**
|
|
97
|
+
* The value or values in the custom claim to match for
|
|
98
|
+
*/
|
|
99
|
+
ClaimMatchValue: ClaimMatchValueType;
|
|
100
|
+
};
|
|
101
|
+
/**
|
|
102
|
+
* Type definition for `AWS::BedrockAgentCore::Gateway.ClaimMatchOperator`.
|
|
103
|
+
* The relationship between the claim field value and the value or values being matched
|
|
104
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-claimmatchoperator.html}
|
|
105
|
+
*/
|
|
106
|
+
export type ClaimMatchOperator = "EQUALS" | "CONTAINS" | "CONTAINS_ANY";
|
|
107
|
+
/**
|
|
108
|
+
* Type definition for `AWS::BedrockAgentCore::Gateway.ClaimMatchValueType`.
|
|
109
|
+
* The value or values in the custom claim to match for
|
|
110
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-claimmatchvaluetype.html}
|
|
111
|
+
*/
|
|
112
|
+
export type ClaimMatchValueType = {
|
|
113
|
+
/**
|
|
114
|
+
* The string value to match for
|
|
115
|
+
* @pattern `[A-Za-z0-9_.-]+`
|
|
116
|
+
*/
|
|
117
|
+
MatchValueString?: string;
|
|
118
|
+
/**
|
|
119
|
+
* The list of strings to check for a match
|
|
120
|
+
* @minLength `1`
|
|
121
|
+
* @maxLength `255`
|
|
122
|
+
*/
|
|
123
|
+
MatchValueStringList?: string[];
|
|
124
|
+
};
|
|
125
|
+
/**
|
|
126
|
+
* Type definition for `AWS::BedrockAgentCore::Gateway.CustomClaimValidationType`.
|
|
127
|
+
* Required custom claim
|
|
128
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-customclaimvalidationtype.html}
|
|
129
|
+
*/
|
|
130
|
+
export type CustomClaimValidationType = {
|
|
131
|
+
/**
|
|
132
|
+
* The value or values in the custom claim to match and relationship of match
|
|
133
|
+
*/
|
|
134
|
+
AuthorizingClaimMatchValue: AuthorizingClaimMatchValueType;
|
|
135
|
+
/**
|
|
136
|
+
* The name of the custom claim to validate
|
|
137
|
+
* @pattern `[A-Za-z0-9_.-:]+`
|
|
138
|
+
*/
|
|
139
|
+
InboundTokenClaimName: string;
|
|
140
|
+
/**
|
|
141
|
+
* Token claim data type
|
|
142
|
+
*/
|
|
143
|
+
InboundTokenClaimValueType: InboundTokenClaimValueType;
|
|
144
|
+
};
|
|
86
145
|
/**
|
|
87
146
|
* Type definition for `AWS::BedrockAgentCore::Gateway.CustomJWTAuthorizerConfiguration`.
|
|
88
147
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-customjwtauthorizerconfiguration.html}
|
|
@@ -96,6 +155,14 @@ export type CustomJWTAuthorizerConfiguration = {
|
|
|
96
155
|
* @minLength `1`
|
|
97
156
|
*/
|
|
98
157
|
AllowedClients?: string[];
|
|
158
|
+
/**
|
|
159
|
+
* @minLength `1`
|
|
160
|
+
*/
|
|
161
|
+
AllowedScopes?: string[];
|
|
162
|
+
/**
|
|
163
|
+
* @minLength `1`
|
|
164
|
+
*/
|
|
165
|
+
CustomClaims?: CustomClaimValidationType[];
|
|
99
166
|
/**
|
|
100
167
|
* @pattern `^.+/\.well-known/openid-configuration$`
|
|
101
168
|
*/
|
|
@@ -141,6 +208,12 @@ export type GatewayProtocolType = "MCP";
|
|
|
141
208
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-gatewaystatus.html}
|
|
142
209
|
*/
|
|
143
210
|
export type GatewayStatus = "CREATING" | "UPDATING" | "UPDATE_UNSUCCESSFUL" | "DELETING" | "READY" | "FAILED";
|
|
211
|
+
/**
|
|
212
|
+
* Type definition for `AWS::BedrockAgentCore::Gateway.InboundTokenClaimValueType`.
|
|
213
|
+
* Token claim data type
|
|
214
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-inboundtokenclaimvaluetype.html}
|
|
215
|
+
*/
|
|
216
|
+
export type InboundTokenClaimValueType = "STRING" | "STRING_ARRAY";
|
|
144
217
|
/**
|
|
145
218
|
* Type definition for `AWS::BedrockAgentCore::Gateway.InterceptorConfiguration`.
|
|
146
219
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-interceptorconfiguration.html}
|
|
@@ -19,6 +19,7 @@ export type BedrockAgentCoreGatewayTargetProperties = {
|
|
|
19
19
|
* @pattern `^([0-9a-z][-]?){1,100}-[0-9a-z]{10}$`
|
|
20
20
|
*/
|
|
21
21
|
GatewayIdentifier?: string;
|
|
22
|
+
MetadataConfiguration?: MetadataConfiguration;
|
|
22
23
|
/**
|
|
23
24
|
* @pattern `^([0-9a-zA-Z][-]?){1,100}$`
|
|
24
25
|
*/
|
|
@@ -140,6 +141,15 @@ export type McpTargetConfiguration = {
|
|
|
140
141
|
} | {
|
|
141
142
|
McpServer: McpServerTargetConfiguration;
|
|
142
143
|
};
|
|
144
|
+
/**
|
|
145
|
+
* Type definition for `AWS::BedrockAgentCore::GatewayTarget.MetadataConfiguration`.
|
|
146
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-metadataconfiguration.html}
|
|
147
|
+
*/
|
|
148
|
+
export type MetadataConfiguration = {
|
|
149
|
+
AllowedQueryParameters?: string[];
|
|
150
|
+
AllowedRequestHeaders?: string[];
|
|
151
|
+
AllowedResponseHeaders?: string[];
|
|
152
|
+
};
|
|
143
153
|
/**
|
|
144
154
|
* Type definition for `AWS::BedrockAgentCore::GatewayTarget.OAuthCredentialProvider`.
|
|
145
155
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html}
|
|
@@ -7,7 +7,7 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
|
|
|
7
7
|
*/
|
|
8
8
|
export type ECRRepositoryCreationTemplateProperties = {
|
|
9
9
|
/**
|
|
10
|
-
* A list of enumerable Strings representing the repository creation scenarios that this template will apply towards. The
|
|
10
|
+
* A list of enumerable Strings representing the repository creation scenarios that this template will apply towards. The supported scenarios are PULL_THROUGH_CACHE, REPLICATION, and CREATE_ON_PUSH
|
|
11
11
|
*/
|
|
12
12
|
AppliedFor: AppliedForItem[];
|
|
13
13
|
/**
|
|
@@ -13,6 +13,9 @@ export type LogsLogGroupProperties = {
|
|
|
13
13
|
* Creates a data protection policy and assigns it to the log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data. When a user who does not have permission to view masked data views a log event that includes masked data, the sensitive data is replaced by asterisks.
|
|
14
14
|
*/
|
|
15
15
|
DataProtectionPolicy?: Record<string, any>;
|
|
16
|
+
/**
|
|
17
|
+
* Indicates whether deletion protection is enabled for this log group. When enabled, deletion protection blocks all deletion operations until it is explicitly disabled.
|
|
18
|
+
*/
|
|
16
19
|
DeletionProtectionEnabled?: boolean;
|
|
17
20
|
/**
|
|
18
21
|
* Creates or updates a *field index policy* for the specified log group. Only log groups in the Standard log class support field index policies. For more information about log classes, see [Log classes](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html).
|
|
@@ -11,8 +11,12 @@ export type LogsMetricFilterProperties = {
|
|
|
11
11
|
If this value is ``true``, the metric filter is applied on the transformed version of the log events instead of the original ingested log events.
|
|
12
12
|
*/
|
|
13
13
|
ApplyOnTransformedLogs?: boolean;
|
|
14
|
+
/**
|
|
15
|
+
* The list of system fields that are emitted as additional dimensions in the generated metrics. Returns the ``emitSystemFieldDimensions`` value if it was specified when the metric filter was created.
|
|
16
|
+
*/
|
|
14
17
|
EmitSystemFieldDimensions?: string[];
|
|
15
18
|
/**
|
|
19
|
+
* The filter expression that specifies which log events are processed by this metric filter based on system fields. Returns the ``fieldSelectionCriteria`` value if it was specified when the metric filter was created.
|
|
16
20
|
* @minLength `0`
|
|
17
21
|
* @maxLength `2000`
|
|
18
22
|
*/
|
|
@@ -24,8 +24,12 @@ export type LogsSubscriptionFilterProperties = {
|
|
|
24
24
|
* The method used to distribute log data to the destination, which can be either random or grouped by log stream.
|
|
25
25
|
*/
|
|
26
26
|
Distribution?: "Random" | "ByLogStream";
|
|
27
|
+
/**
|
|
28
|
+
* The list of system fields that are included in the log events sent to the subscription destination. Returns the ``emitSystemFields`` value if it was specified when the subscription filter was created.
|
|
29
|
+
*/
|
|
27
30
|
EmitSystemFields?: string[];
|
|
28
31
|
/**
|
|
32
|
+
* The filter expression that specifies which log events are processed by this subscription filter based on system fields. Returns the ``fieldSelectionCriteria`` value if it was specified when the subscription filter was created.
|
|
29
33
|
* @minLength `0`
|
|
30
34
|
* @maxLength `2000`
|
|
31
35
|
*/
|
|
@@ -645,6 +645,7 @@ export type Scte = {
|
|
|
645
645
|
* @maxLength `100`
|
|
646
646
|
*/
|
|
647
647
|
ScteFilter?: ScteFilter[];
|
|
648
|
+
ScteInSegments?: ScteInSegments;
|
|
648
649
|
};
|
|
649
650
|
/**
|
|
650
651
|
* Type definition for `AWS::MediaPackageV2::OriginEndpoint.ScteDash`.
|
|
@@ -667,6 +668,11 @@ export type ScteFilter = "SPLICE_INSERT" | "BREAK" | "PROVIDER_ADVERTISEMENT" |
|
|
|
667
668
|
export type ScteHls = {
|
|
668
669
|
AdMarkerHls?: AdMarkerHls;
|
|
669
670
|
};
|
|
671
|
+
/**
|
|
672
|
+
* Type definition for `AWS::MediaPackageV2::OriginEndpoint.ScteInSegments`.
|
|
673
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-scteinsegments.html}
|
|
674
|
+
*/
|
|
675
|
+
export type ScteInSegments = "NONE" | "ALL";
|
|
670
676
|
/**
|
|
671
677
|
* Type definition for `AWS::MediaPackageV2::OriginEndpoint.Segment`.
|
|
672
678
|
* <p>The segment configuration, including the segment name, duration, and other configuration values.</p>
|
|
@@ -12,7 +12,7 @@ export type QuickSightDataSetProperties = {
|
|
|
12
12
|
*/
|
|
13
13
|
AwsAccountId?: string;
|
|
14
14
|
/**
|
|
15
|
-
* <p>Groupings of columns that work together in certain
|
|
15
|
+
* <p>Groupings of columns that work together in certain Quick Suite features. Currently, only geospatial hierarchy is supported.</p>
|
|
16
16
|
* @minLength `1`
|
|
17
17
|
* @maxLength `8`
|
|
18
18
|
*/
|
|
@@ -42,7 +42,7 @@ export type QuickSightDataSetProperties = {
|
|
|
42
42
|
DatasetParameters?: DatasetParameter[];
|
|
43
43
|
FieldFolders?: FieldFolderMap;
|
|
44
44
|
/**
|
|
45
|
-
* <p>When you create the dataset,
|
|
45
|
+
* <p>When you create the dataset, Quick Suite adds the dataset to these folders.</p>
|
|
46
46
|
* @minLength `0`
|
|
47
47
|
* @maxLength `10`
|
|
48
48
|
*/
|
|
@@ -70,7 +70,7 @@ export type QuickSightDataSetProperties = {
|
|
|
70
70
|
/**
|
|
71
71
|
* <p>Information about a dataset that contains permissions for row-level security (RLS).
|
|
72
72
|
The permissions dataset maps fields to users or groups. For more information, see
|
|
73
|
-
<a href="https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html">Using Row-Level Security (RLS) to Restrict Access to a Dataset</a> in the <i>Amazon
|
|
73
|
+
<a href="https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html">Using Row-Level Security (RLS) to Restrict Access to a Dataset</a> in the <i>Amazon Quick Suite User
|
|
74
74
|
Guide</i>.</p>
|
|
75
75
|
<p>The option to deny permissions by setting <code>PermissionPolicy</code> to <code>DENY_ACCESS</code> is
|
|
76
76
|
not supported for new RLS datasets.</p>
|
|
@@ -218,7 +218,7 @@ export type AppendOperation = {
|
|
|
218
218
|
export type CalculatedColumn = {
|
|
219
219
|
/**
|
|
220
220
|
* <p>A unique ID to identify a calculated column. During a dataset update, if the column ID
|
|
221
|
-
of a calculated column matches that of an existing calculated column, Amazon
|
|
221
|
+
of a calculated column matches that of an existing calculated column, Amazon Quick Suite
|
|
222
222
|
preserves the existing calculated column.</p>
|
|
223
223
|
* @minLength `1`
|
|
224
224
|
* @maxLength `64`
|
|
@@ -251,7 +251,7 @@ export type CastColumnTypeOperation = {
|
|
|
251
251
|
ColumnName: string;
|
|
252
252
|
/**
|
|
253
253
|
* <p>When casting a column from string to datetime type, you can supply a string in a
|
|
254
|
-
format supported by Amazon
|
|
254
|
+
format supported by Amazon Quick Suite to denote the source data format.</p>
|
|
255
255
|
* @minLength `0`
|
|
256
256
|
* @maxLength `32`
|
|
257
257
|
*/
|
|
@@ -301,7 +301,7 @@ export type ColumnDescription = {
|
|
|
301
301
|
};
|
|
302
302
|
/**
|
|
303
303
|
* Type definition for `AWS::QuickSight::DataSet.ColumnGroup`.
|
|
304
|
-
* <p>Groupings of columns that work together in certain Amazon
|
|
304
|
+
* <p>Groupings of columns that work together in certain Amazon Quick Suite features. This is
|
|
305
305
|
a variant type structure. For this structure to be valid, only one of the attributes can
|
|
306
306
|
be non-null.</p>
|
|
307
307
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columngroup.html}
|
|
@@ -329,7 +329,7 @@ export type ColumnLevelPermissionRule = {
|
|
|
329
329
|
*/
|
|
330
330
|
ColumnNames?: string[];
|
|
331
331
|
/**
|
|
332
|
-
* <p>An array of Amazon Resource Names (ARNs) for
|
|
332
|
+
* <p>An array of Amazon Resource Names (ARNs) for Quick Suite users or groups.</p>
|
|
333
333
|
* @minLength `1`
|
|
334
334
|
* @maxLength `100`
|
|
335
335
|
*/
|
|
@@ -1083,7 +1083,7 @@ export type JoinInstruction = {
|
|
|
1083
1083
|
export type JoinKeyProperties = {
|
|
1084
1084
|
/**
|
|
1085
1085
|
* <p>A value that indicates that a row in a table is uniquely identified by the columns in
|
|
1086
|
-
a join key. This is used by
|
|
1086
|
+
a join key. This is used by Quick Suite to optimize query performance.</p>
|
|
1087
1087
|
*/
|
|
1088
1088
|
UniqueKey?: boolean;
|
|
1089
1089
|
};
|
|
@@ -1548,10 +1548,10 @@ export type ResourcePermission = {
|
|
|
1548
1548
|
following:</p>
|
|
1549
1549
|
<ul>
|
|
1550
1550
|
<li>
|
|
1551
|
-
<p>The ARN of an Amazon
|
|
1551
|
+
<p>The ARN of an Amazon Quick Suite user or group associated with a data source or dataset. (This is common.)</p>
|
|
1552
1552
|
</li>
|
|
1553
1553
|
<li>
|
|
1554
|
-
<p>The ARN of an Amazon
|
|
1554
|
+
<p>The ARN of an Amazon Quick Suite user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)</p>
|
|
1555
1555
|
</li>
|
|
1556
1556
|
<li>
|
|
1557
1557
|
<p>The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight
|
|
@@ -1572,7 +1572,7 @@ export type RowLevelPermissionConfiguration = {
|
|
|
1572
1572
|
/**
|
|
1573
1573
|
* <p>Information about a dataset that contains permissions for row-level security (RLS).
|
|
1574
1574
|
The permissions dataset maps fields to users or groups. For more information, see
|
|
1575
|
-
<a href="https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html">Using Row-Level Security (RLS) to Restrict Access to a Dataset</a> in the <i>Amazon
|
|
1575
|
+
<a href="https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html">Using Row-Level Security (RLS) to Restrict Access to a Dataset</a> in the <i>Amazon Quick Suite User
|
|
1576
1576
|
Guide</i>.</p>
|
|
1577
1577
|
<p>The option to deny permissions by setting <code>PermissionPolicy</code> to <code>DENY_ACCESS</code> is
|
|
1578
1578
|
not supported for new RLS datasets.</p>
|
|
@@ -1587,7 +1587,7 @@ export type RowLevelPermissionConfiguration = {
|
|
|
1587
1587
|
* Type definition for `AWS::QuickSight::DataSet.RowLevelPermissionDataSet`.
|
|
1588
1588
|
* <p>Information about a dataset that contains permissions for row-level security (RLS).
|
|
1589
1589
|
The permissions dataset maps fields to users or groups. For more information, see
|
|
1590
|
-
<a href="https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html">Using Row-Level Security (RLS) to Restrict Access to a Dataset</a> in the <i>Amazon
|
|
1590
|
+
<a href="https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html">Using Row-Level Security (RLS) to Restrict Access to a Dataset</a> in the <i>Amazon Quick Suite User
|
|
1591
1591
|
Guide</i>.</p>
|
|
1592
1592
|
<p>The option to deny permissions by setting <code>PermissionPolicy</code> to <code>DENY_ACCESS</code> is
|
|
1593
1593
|
not supported for new RLS datasets.</p>
|
|
@@ -32,7 +32,7 @@ export type QuickSightDataSourceProperties = {
|
|
|
32
32
|
Credentials?: DataSourceCredentials;
|
|
33
33
|
DataSourceId?: string;
|
|
34
34
|
/**
|
|
35
|
-
* <p>The parameters that Amazon
|
|
35
|
+
* <p>The parameters that Amazon Quick Suite uses to connect to your underlying data source.
|
|
36
36
|
This is a variant type structure. For this structure to be valid, only one of the
|
|
37
37
|
attributes can be non-null.</p>
|
|
38
38
|
*/
|
|
@@ -57,7 +57,7 @@ export type QuickSightDataSourceProperties = {
|
|
|
57
57
|
*/
|
|
58
58
|
Permissions?: ResourcePermission[];
|
|
59
59
|
/**
|
|
60
|
-
* <p>Secure Socket Layer (SSL) properties that apply when
|
|
60
|
+
* <p>Secure Socket Layer (SSL) properties that apply when Quick Suite connects to your
|
|
61
61
|
underlying data source.</p>
|
|
62
62
|
*/
|
|
63
63
|
SslProperties?: SslProperties;
|
|
@@ -194,7 +194,7 @@ export type AuroraPostgreSqlParameters = {
|
|
|
194
194
|
* Type definition for `AWS::QuickSight::DataSource.AuthenticationType`.
|
|
195
195
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-authenticationtype.html}
|
|
196
196
|
*/
|
|
197
|
-
export type AuthenticationType = "PASSWORD" | "TOKEN" | "X509";
|
|
197
|
+
export type AuthenticationType = "PASSWORD" | "TOKEN" | "X509" | "KEYPAIR";
|
|
198
198
|
/**
|
|
199
199
|
* Type definition for `AWS::QuickSight::DataSource.CredentialPair`.
|
|
200
200
|
* <p>The combination of user name and password that are used as credentials.</p>
|
|
@@ -272,6 +272,7 @@ export type DataSourceCredentials = {
|
|
|
272
272
|
* <p>The combination of user name and password that are used as credentials.</p>
|
|
273
273
|
*/
|
|
274
274
|
CredentialPair?: CredentialPair;
|
|
275
|
+
KeyPairCredentials?: KeyPairCredentials;
|
|
275
276
|
/**
|
|
276
277
|
* <p>The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.</p>
|
|
277
278
|
* @minLength `1`
|
|
@@ -299,7 +300,7 @@ export type DataSourceErrorInfo = {
|
|
|
299
300
|
export type DataSourceErrorInfoType = "ACCESS_DENIED" | "COPY_SOURCE_NOT_FOUND" | "TIMEOUT" | "ENGINE_VERSION_NOT_SUPPORTED" | "UNKNOWN_HOST" | "GENERIC_SQL_FAILURE" | "CONFLICT" | "UNKNOWN";
|
|
300
301
|
/**
|
|
301
302
|
* Type definition for `AWS::QuickSight::DataSource.DataSourceParameters`.
|
|
302
|
-
* <p>The parameters that Amazon
|
|
303
|
+
* <p>The parameters that Amazon Quick Suite uses to connect to your underlying data source.
|
|
303
304
|
This is a variant type structure. For this structure to be valid, only one of the
|
|
304
305
|
attributes can be non-null.</p>
|
|
305
306
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html}
|
|
@@ -403,6 +404,28 @@ export type IdentityCenterConfiguration = {
|
|
|
403
404
|
*/
|
|
404
405
|
EnableIdentityPropagation?: boolean;
|
|
405
406
|
};
|
|
407
|
+
/**
|
|
408
|
+
* Type definition for `AWS::QuickSight::DataSource.KeyPairCredentials`.
|
|
409
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-keypaircredentials.html}
|
|
410
|
+
*/
|
|
411
|
+
export type KeyPairCredentials = {
|
|
412
|
+
/**
|
|
413
|
+
* @minLength `1`
|
|
414
|
+
* @maxLength `64`
|
|
415
|
+
*/
|
|
416
|
+
KeyPairUsername: string;
|
|
417
|
+
/**
|
|
418
|
+
* @minLength `1600`
|
|
419
|
+
* @maxLength `8000`
|
|
420
|
+
* @pattern `^-{5}BEGIN (ENCRYPTED )?PRIVATE KEY-{5}\u000D?\u000A([A-Za-z0-9/+]{64}\u000D?\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\u000D?\u000A-{5}END (ENCRYPTED )?PRIVATE KEY-{5}(\u000D?\u000A)?$`
|
|
421
|
+
*/
|
|
422
|
+
PrivateKey: string;
|
|
423
|
+
/**
|
|
424
|
+
* @minLength `0`
|
|
425
|
+
* @maxLength `256`
|
|
426
|
+
*/
|
|
427
|
+
PrivateKeyPassphrase?: string;
|
|
428
|
+
};
|
|
406
429
|
/**
|
|
407
430
|
* Type definition for `AWS::QuickSight::DataSource.ManifestFileLocation`.
|
|
408
431
|
* <p>Amazon S3 manifest file location.</p>
|
|
@@ -594,30 +617,30 @@ export type RdsParameters = {
|
|
|
594
617
|
};
|
|
595
618
|
/**
|
|
596
619
|
* Type definition for `AWS::QuickSight::DataSource.RedshiftIAMParameters`.
|
|
597
|
-
* <p>A structure that grants
|
|
620
|
+
* <p>A structure that grants Quick Suite access to your cluster and make a call to the <code>redshift:GetClusterCredentials</code> API. For more information on the <code>redshift:GetClusterCredentials</code> API, see <a href="https://docs.aws.amazon.com/redshift/latest/APIReference/API_GetClusterCredentials.html">
|
|
598
621
|
<code>GetClusterCredentials</code>
|
|
599
622
|
</a>.</p>
|
|
600
623
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftiamparameters.html}
|
|
601
624
|
*/
|
|
602
625
|
export type RedshiftIAMParameters = {
|
|
603
626
|
/**
|
|
604
|
-
* <p>Automatically creates a database user. If your database doesn't have a <code>DatabaseUser</code>, set this parameter to <code>True</code>. If there is no <code>DatabaseUser</code>, Amazon
|
|
627
|
+
* <p>Automatically creates a database user. If your database doesn't have a <code>DatabaseUser</code>, set this parameter to <code>True</code>. If there is no <code>DatabaseUser</code>, Amazon Quick Suite can't connect to your cluster. The <code>RoleArn</code> that you use for this operation must grant access to <code>redshift:CreateClusterUser</code> to successfully create the user.</p>
|
|
605
628
|
*/
|
|
606
629
|
AutoCreateDatabaseUser?: boolean;
|
|
607
630
|
/**
|
|
608
|
-
* <p>A list of groups whose permissions will be granted to
|
|
631
|
+
* <p>A list of groups whose permissions will be granted to Quick Suite to access the cluster. These permissions are combined with the permissions granted to Quick Suite by the <code>DatabaseUser</code>. If you choose to include this parameter, the <code>RoleArn</code> must grant access to <code>redshift:JoinGroup</code>.</p>
|
|
609
632
|
* @minLength `1`
|
|
610
633
|
* @maxLength `50`
|
|
611
634
|
*/
|
|
612
635
|
DatabaseGroups?: string[];
|
|
613
636
|
/**
|
|
614
|
-
* <p>The user whose permissions and group memberships will be used by
|
|
637
|
+
* <p>The user whose permissions and group memberships will be used by Quick Suite to access the cluster. If this user already exists in your database, Quick Suite is granted the same permissions that the user has. If the user doesn't exist, set the value of <code>AutoCreateDatabaseUser</code> to <code>True</code> to create a new user with PUBLIC permissions.</p>
|
|
615
638
|
* @minLength `1`
|
|
616
639
|
* @maxLength `64`
|
|
617
640
|
*/
|
|
618
641
|
DatabaseUser?: string;
|
|
619
642
|
/**
|
|
620
|
-
* <p>Use the <code>RoleArn</code> structure to allow
|
|
643
|
+
* <p>Use the <code>RoleArn</code> structure to allow Quick Suite to call <code>redshift:GetClusterCredentials</code> on your cluster. The calling principal must have <code>iam:PassRole</code> access to pass the role to Quick Suite. The role's trust policy must allow the Quick Suite service principal to assume the role.</p>
|
|
621
644
|
* @minLength `20`
|
|
622
645
|
* @maxLength `2048`
|
|
623
646
|
*/
|
|
@@ -650,7 +673,7 @@ export type RedshiftParameters = {
|
|
|
650
673
|
*/
|
|
651
674
|
Host?: string;
|
|
652
675
|
/**
|
|
653
|
-
* <p>A structure that grants
|
|
676
|
+
* <p>A structure that grants Quick Suite access to your cluster and make a call to the <code>redshift:GetClusterCredentials</code> API. For more information on the <code>redshift:GetClusterCredentials</code> API, see <a href="https://docs.aws.amazon.com/redshift/latest/APIReference/API_GetClusterCredentials.html">
|
|
654
677
|
<code>GetClusterCredentials</code>
|
|
655
678
|
</a>.</p>
|
|
656
679
|
*/
|
|
@@ -683,10 +706,10 @@ export type ResourcePermission = {
|
|
|
683
706
|
following:</p>
|
|
684
707
|
<ul>
|
|
685
708
|
<li>
|
|
686
|
-
<p>The ARN of an Amazon
|
|
709
|
+
<p>The ARN of an Amazon Quick Suite user or group associated with a data source or dataset. (This is common.)</p>
|
|
687
710
|
</li>
|
|
688
711
|
<li>
|
|
689
|
-
<p>The ARN of an Amazon
|
|
712
|
+
<p>The ARN of an Amazon Quick Suite user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)</p>
|
|
690
713
|
</li>
|
|
691
714
|
<li>
|
|
692
715
|
<p>The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight
|
|
@@ -800,7 +823,7 @@ export type SqlServerParameters = {
|
|
|
800
823
|
};
|
|
801
824
|
/**
|
|
802
825
|
* Type definition for `AWS::QuickSight::DataSource.SslProperties`.
|
|
803
|
-
* <p>Secure Socket Layer (SSL) properties that apply when
|
|
826
|
+
* <p>Secure Socket Layer (SSL) properties that apply when Quick Suite connects to your
|
|
804
827
|
underlying data source.</p>
|
|
805
828
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-sslproperties.html}
|
|
806
829
|
*/
|