Skip to content

Commit 05635df

Browse files
author
awstools
committed
docs(client-redshift): Additions to the PubliclyAccessible and Encrypted parameters clarifying what the defaults are.
1 parent a4fb2d4 commit 05635df

File tree

3 files changed

+12
-7
lines changed

3 files changed

+12
-7
lines changed

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3182,6 +3182,7 @@ export interface Cluster {
31823182
/**
31833183
* <p>A boolean value that, if <code>true</code>, indicates that the cluster can be
31843184
* accessed from a public network.</p>
3185+
* <p>Default: false</p>
31853186
* @public
31863187
*/
31873188
PubliclyAccessible?: boolean | undefined;
@@ -4729,13 +4730,15 @@ export interface CreateClusterMessage {
47294730

47304731
/**
47314732
* <p>If <code>true</code>, the cluster can be accessed from a public network. </p>
4733+
* <p>Default: false</p>
47324734
* @public
47334735
*/
47344736
PubliclyAccessible?: boolean | undefined;
47354737

47364738
/**
4737-
* <p>If <code>true</code>, the data in the cluster is encrypted at rest. </p>
4738-
* <p>Default: false</p>
4739+
* <p>If <code>true</code>, the data in the cluster is encrypted at rest.
4740+
* If you set the value on this parameter to <code>false</code>, the request will fail.</p>
4741+
* <p>Default: true</p>
47394742
* @public
47404743
*/
47414744
Encrypted?: boolean | undefined;

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4761,6 +4761,7 @@ export interface ModifyClusterMessage {
47614761
/**
47624762
* <p>If <code>true</code>, the cluster can be accessed from a public network. Only
47634763
* clusters in VPCs can be set to be publicly available.</p>
4764+
* <p>Default: false</p>
47644765
* @public
47654766
*/
47664767
PubliclyAccessible?: boolean | undefined;
@@ -5903,6 +5904,7 @@ export interface RestoreFromClusterSnapshotMessage {
59035904

59045905
/**
59055906
* <p>If <code>true</code>, the cluster can be accessed from a public network. </p>
5907+
* <p>Default: false</p>
59065908
* @public
59075909
*/
59085910
PubliclyAccessible?: boolean | undefined;

codegen/sdk-codegen/aws-models/redshift.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1337,7 +1337,7 @@
13371337
"PubliclyAccessible": {
13381338
"target": "com.amazonaws.redshift#Boolean",
13391339
"traits": {
1340-
"smithy.api#documentation": "<p>A boolean value that, if <code>true</code>, indicates that the cluster can be\n accessed from a public network.</p>"
1340+
"smithy.api#documentation": "<p>A boolean value that, if <code>true</code>, indicates that the cluster can be\n accessed from a public network.</p>\n <p>Default: false</p>"
13411341
}
13421342
},
13431343
"Encrypted": {
@@ -2919,13 +2919,13 @@
29192919
"PubliclyAccessible": {
29202920
"target": "com.amazonaws.redshift#BooleanOptional",
29212921
"traits": {
2922-
"smithy.api#documentation": "<p>If <code>true</code>, the cluster can be accessed from a public network. </p>"
2922+
"smithy.api#documentation": "<p>If <code>true</code>, the cluster can be accessed from a public network. </p>\n <p>Default: false</p>"
29232923
}
29242924
},
29252925
"Encrypted": {
29262926
"target": "com.amazonaws.redshift#BooleanOptional",
29272927
"traits": {
2928-
"smithy.api#documentation": "<p>If <code>true</code>, the data in the cluster is encrypted at rest. </p>\n <p>Default: false</p>"
2928+
"smithy.api#documentation": "<p>If <code>true</code>, the data in the cluster is encrypted at rest. \n If you set the value on this parameter to <code>false</code>, the request will fail.</p>\n <p>Default: true</p>"
29292929
}
29302930
},
29312931
"HsmClientCertificateIdentifier": {
@@ -12154,7 +12154,7 @@
1215412154
"PubliclyAccessible": {
1215512155
"target": "com.amazonaws.redshift#BooleanOptional",
1215612156
"traits": {
12157-
"smithy.api#documentation": "<p>If <code>true</code>, the cluster can be accessed from a public network. Only\n clusters in VPCs can be set to be publicly available.</p>"
12157+
"smithy.api#documentation": "<p>If <code>true</code>, the cluster can be accessed from a public network. Only\n clusters in VPCs can be set to be publicly available.</p>\n <p>Default: false</p>"
1215812158
}
1215912159
},
1216012160
"ElasticIp": {
@@ -17033,7 +17033,7 @@
1703317033
"PubliclyAccessible": {
1703417034
"target": "com.amazonaws.redshift#BooleanOptional",
1703517035
"traits": {
17036-
"smithy.api#documentation": "<p>If <code>true</code>, the cluster can be accessed from a public network. </p>"
17036+
"smithy.api#documentation": "<p>If <code>true</code>, the cluster can be accessed from a public network. </p>\n <p>Default: false</p>"
1703717037
}
1703817038
},
1703917039
"OwnerAccount": {

0 commit comments

Comments
 (0)