Skip to content

Commit 736c297

Browse files
author
awstools
committed
docs(client-redshift): This release updates documentation for AQUA features and other description updates.
1 parent 3c7cfa2 commit 736c297

File tree

5 files changed

+32
-88
lines changed

5 files changed

+32
-88
lines changed

‎clients/client-redshift/src/Redshift.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3825,7 +3825,7 @@ export class Redshift extends RedshiftClient {
38253825
}
38263826

38273827
/**
3828-
* <p>Modifies whether a cluster can use AQUA (Advanced Query Accelerator). </p>
3828+
* <p>This operation is retired. Calling this operation does not change AQUA configuration. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator). </p>
38293829
*/
38303830
public modifyAquaConfiguration(
38313831
args: ModifyAquaConfigurationCommandInput,

‎clients/client-redshift/src/commands/ModifyAquaConfigurationCommand.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface ModifyAquaConfigurationCommandInput extends ModifyAquaInputMess
2828
export interface ModifyAquaConfigurationCommandOutput extends ModifyAquaOutputMessage, __MetadataBearer {}
2929

3030
/**
31-
* <p>Modifies whether a cluster can use AQUA (Advanced Query Accelerator). </p>
31+
* <p>This operation is retired. Calling this operation does not change AQUA configuration. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator). </p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

‎clients/client-redshift/src/models/models_0.ts‎

Lines changed: 6 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -470,38 +470,16 @@ export enum AquaStatus {
470470
}
471471

472472
/**
473-
* <p>The AQUA (Advanced Query Accelerator) configuration of the cluster.</p>
473+
* <p>The operation that uses this structure is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).</p>
474474
*/
475475
export interface AquaConfiguration {
476476
/**
477-
* <p>The value indicates the status of AQUA on the cluster. Possible values include the following.</p>
478-
* <ul>
479-
* <li>
480-
* <p>enabled - AQUA is enabled.</p>
481-
* </li>
482-
* <li>
483-
* <p>disabled - AQUA is not enabled. </p>
484-
* </li>
485-
* <li>
486-
* <p>applying - AQUA status is being applied. </p>
487-
* </li>
488-
* </ul>
477+
* <p>This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).</p>
489478
*/
490479
AquaStatus?: AquaStatus | string;
491480

492481
/**
493-
* <p>The value represents how the cluster is configured to use AQUA. Possible values include the following.</p>
494-
* <ul>
495-
* <li>
496-
* <p>enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.</p>
497-
* </li>
498-
* <li>
499-
* <p>disabled - Don't use AQUA. </p>
500-
* </li>
501-
* <li>
502-
* <p>auto - Amazon Redshift determines whether to use AQUA.</p>
503-
* </li>
504-
* </ul>
482+
* <p>This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).</p>
505483
*/
506484
AquaConfigurationStatus?: AquaConfigurationStatus | string;
507485
}
@@ -2760,7 +2738,7 @@ export interface Cluster {
27602738
TotalStorageCapacityInMegaBytes?: number;
27612739

27622740
/**
2763-
* <p>The AQUA (Advanced Query Accelerator) configuration of the cluster.</p>
2741+
* <p>This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).</p>
27642742
*/
27652743
AquaConfiguration?: AquaConfiguration;
27662744

@@ -3906,8 +3884,7 @@ export interface CreateClusterMessage {
39063884
HsmConfigurationIdentifier?: string;
39073885

39083886
/**
3909-
* <p>The Elastic IP (EIP) address for the cluster. You don't have to specify the EIP for a
3910-
* publicly accessible cluster with AvailabilityZoneRelocation turned on.</p>
3887+
* <p>The Elastic IP (EIP) address for the cluster.</p>
39113888
* <p>Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible
39123889
* through an Internet gateway. For more information about provisioning clusters in
39133890
* EC2-VPC, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms">Supported
@@ -3969,18 +3946,7 @@ export interface CreateClusterMessage {
39693946
AvailabilityZoneRelocation?: boolean;
39703947

39713948
/**
3972-
* <p>The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) when it is created. Possible values include the following.</p>
3973-
* <ul>
3974-
* <li>
3975-
* <p>enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.</p>
3976-
* </li>
3977-
* <li>
3978-
* <p>disabled - Don't use AQUA. </p>
3979-
* </li>
3980-
* <li>
3981-
* <p>auto - Amazon Redshift determines whether to use AQUA.</p>
3982-
* </li>
3983-
* </ul>
3949+
* <p>This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).</p>
39843950
*/
39853951
AquaConfigurationStatus?: AquaConfigurationStatus | string;
39863952

‎clients/client-redshift/src/models/models_1.ts‎

Lines changed: 9 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1663,7 +1663,7 @@ export interface GetClusterCredentialsMessage {
16631663
* <code>PUBLIC</code>.</p>
16641664
* </li>
16651665
* <li>
1666-
* <p>Must contain only lowercase letters, numbers, underscore, plus sign, period
1666+
* <p>Must contain uppercase or lowercase letters, numbers, underscore, plus sign, period
16671667
* (dot), at symbol (@), or hyphen.</p>
16681668
* </li>
16691669
* <li>
@@ -1690,7 +1690,7 @@ export interface GetClusterCredentialsMessage {
16901690
* <p>Must be 1 to 64 alphanumeric characters or hyphens</p>
16911691
* </li>
16921692
* <li>
1693-
* <p>Must contain only lowercase letters, numbers, underscore, plus sign, period
1693+
* <p>Must contain uppercase or lowercase letters, numbers, underscore, plus sign, period
16941694
* (dot), at symbol (@), or hyphen.</p>
16951695
* </li>
16961696
* <li>
@@ -1959,25 +1959,14 @@ export interface ModifyAquaInputMessage {
19591959
ClusterIdentifier: string | undefined;
19601960

19611961
/**
1962-
* <p>The new value of AQUA configuration status. Possible values include the following.</p>
1963-
* <ul>
1964-
* <li>
1965-
* <p>enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.</p>
1966-
* </li>
1967-
* <li>
1968-
* <p>disabled - Don't use AQUA. </p>
1969-
* </li>
1970-
* <li>
1971-
* <p>auto - Amazon Redshift determines whether to use AQUA.</p>
1972-
* </li>
1973-
* </ul>
1962+
* <p>This parameter is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).</p>
19741963
*/
19751964
AquaConfigurationStatus?: AquaConfigurationStatus | string;
19761965
}
19771966

19781967
export interface ModifyAquaOutputMessage {
19791968
/**
1980-
* <p>The updated AQUA configuration of the cluster. </p>
1969+
* <p>This parameter is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator). </p>
19811970
*/
19821971
AquaConfiguration?: AquaConfiguration;
19831972
}
@@ -2926,14 +2915,15 @@ export interface RestoreFromClusterSnapshotMessage {
29262915

29272916
/**
29282917
* <p>The name of the snapshot from which to create the new cluster. This parameter isn't
2929-
* case sensitive.</p>
2918+
* case sensitive. You can specify this parameter or <code>snapshotArn</code>, but not both.</p>
29302919
* <p>Example: <code>my-snapshot-id</code>
29312920
* </p>
29322921
*/
29332922
SnapshotIdentifier?: string;
29342923

29352924
/**
2936-
* <p>The Amazon Resource Name (ARN) of the snapshot associated with the message to restore from a cluster.</p>
2925+
* <p>The Amazon Resource Name (ARN) of the snapshot associated with the message to restore from a cluster. You can specify
2926+
* this parameter or <code>snapshotIdentifier</code>, but not both.</p>
29372927
*/
29382928
SnapshotArn?: string;
29392929

@@ -2998,8 +2988,7 @@ export interface RestoreFromClusterSnapshotMessage {
29982988
HsmConfigurationIdentifier?: string;
29992989

30002990
/**
3001-
* <p>The elastic IP (EIP) address for the cluster. You don't have to specify the EIP for a
3002-
* publicly accessible cluster with AvailabilityZoneRelocation turned on.</p>
2991+
* <p>The elastic IP (EIP) address for the cluster.</p>
30032992
*/
30042993
ElasticIp?: string;
30052994

@@ -3146,18 +3135,7 @@ export interface RestoreFromClusterSnapshotMessage {
31463135
AvailabilityZoneRelocation?: boolean;
31473136

31483137
/**
3149-
* <p>The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.</p>
3150-
* <ul>
3151-
* <li>
3152-
* <p>enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.</p>
3153-
* </li>
3154-
* <li>
3155-
* <p>disabled - Don't use AQUA. </p>
3156-
* </li>
3157-
* <li>
3158-
* <p>auto - Amazon Redshift determines whether to use AQUA.</p>
3159-
* </li>
3160-
* </ul>
3138+
* <p>This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).</p>
31613139
*/
31623140
AquaConfigurationStatus?: AquaConfigurationStatus | string;
31633141

0 commit comments

Comments
 (0)