Skip to content

Commit bafdf22

Browse files
author
AWS
committed
Amazon Redshift Update: This release adds support for reserved node exchange with restore/resize
1 parent 4269d00 commit bafdf22

File tree

3 files changed

+285
-2
lines changed

3 files changed

+285
-2
lines changed

‎.changes/next-release/feature-AmazonRedshift-44e822c.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon Redshift",
4+
"contributor": "",
5+
"description": "This release adds support for reserved node exchange with restore/resize"
6+
}

‎services/redshift/src/main/resources/codegen-resources/paginators-1.json

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,24 @@
5454
"output_token": "Marker",
5555
"result_key": "Clusters"
5656
},
57+
"DescribeDataShares": {
58+
"input_token": "Marker",
59+
"limit_key": "MaxRecords",
60+
"output_token": "Marker",
61+
"result_key": "DataShares"
62+
},
63+
"DescribeDataSharesForConsumer": {
64+
"input_token": "Marker",
65+
"limit_key": "MaxRecords",
66+
"output_token": "Marker",
67+
"result_key": "DataShares"
68+
},
69+
"DescribeDataSharesForProducer": {
70+
"input_token": "Marker",
71+
"limit_key": "MaxRecords",
72+
"output_token": "Marker",
73+
"result_key": "DataShares"
74+
},
5775
"DescribeDefaultClusterParameters": {
5876
"input_token": "Marker",
5977
"limit_key": "MaxRecords",
@@ -108,6 +126,12 @@
108126
"output_token": "Marker",
109127
"result_key": "OrderableClusterOptions"
110128
},
129+
"DescribeReservedNodeExchangeStatus": {
130+
"input_token": "Marker",
131+
"limit_key": "MaxRecords",
132+
"output_token": "Marker",
133+
"result_key": "ReservedNodeExchangeStatusDetails"
134+
},
111135
"DescribeReservedNodeOfferings": {
112136
"input_token": "Marker",
113137
"limit_key": "MaxRecords",
@@ -156,6 +180,12 @@
156180
"output_token": "Marker",
157181
"result_key": "UsageLimits"
158182
},
183+
"GetReservedNodeExchangeConfigurationOptions": {
184+
"input_token": "Marker",
185+
"limit_key": "MaxRecords",
186+
"output_token": "Marker",
187+
"result_key": "ReservedNodeConfigurationOptionList"
188+
},
159189
"GetReservedNodeExchangeOfferings": {
160190
"input_token": "Marker",
161191
"limit_key": "MaxRecords",

‎services/redshift/src/main/resources/codegen-resources/service-2.json

Lines changed: 249 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1213,6 +1213,24 @@
12131213
],
12141214
"documentation":"<p>Returns information about the partner integrations defined for a cluster.</p>"
12151215
},
1216+
"DescribeReservedNodeExchangeStatus":{
1217+
"name":"DescribeReservedNodeExchangeStatus",
1218+
"http":{
1219+
"method":"POST",
1220+
"requestUri":"/"
1221+
},
1222+
"input":{"shape":"DescribeReservedNodeExchangeStatusInputMessage"},
1223+
"output":{
1224+
"shape":"DescribeReservedNodeExchangeStatusOutputMessage",
1225+
"resultWrapper":"DescribeReservedNodeExchangeStatusResult"
1226+
},
1227+
"errors":[
1228+
{"shape":"ReservedNodeNotFoundFault"},
1229+
{"shape":"ReservedNodeExchangeNotFoundFault"},
1230+
{"shape":"UnsupportedOperationFault"}
1231+
],
1232+
"documentation":"<p>Returns exchange status details and associated metadata for a reserved-node exchange. Statuses include such values as in progress and requested.</p>"
1233+
},
12161234
"DescribeReservedNodeOfferings":{
12171235
"name":"DescribeReservedNodeOfferings",
12181236
"http":{
@@ -1492,6 +1510,29 @@
14921510
],
14931511
"documentation":"<p>Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database. The action returns the database user name prefixed with <code>IAM:</code> if <code>AutoCreate</code> is <code>False</code> or <code>IAMA:</code> if <code>AutoCreate</code> is <code>True</code>. You can optionally specify one or more database user groups that the user will join at log on. By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more information, see <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/generating-user-credentials.html\">Using IAM Authentication to Generate Database User Credentials</a> in the Amazon Redshift Cluster Management Guide.</p> <p>The Identity and Access Management (IAM) user or role that runs GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html#redshift-policy-resources.getclustercredentials-resources\">Resource Policies for GetClusterCredentials</a> in the Amazon Redshift Cluster Management Guide.</p> <p>If the <code>DbGroups</code> parameter is specified, the IAM policy must allow the <code>redshift:JoinGroup</code> action with access to the listed <code>dbgroups</code>. </p> <p>In addition, if the <code>AutoCreate</code> parameter is set to <code>True</code>, then the policy must include the <code>redshift:CreateClusterUser</code> privilege.</p> <p>If the <code>DbName</code> parameter is specified, the IAM policy must allow access to the resource <code>dbname</code> for the specified database name. </p>"
14941512
},
1513+
"GetReservedNodeExchangeConfigurationOptions":{
1514+
"name":"GetReservedNodeExchangeConfigurationOptions",
1515+
"http":{
1516+
"method":"POST",
1517+
"requestUri":"/"
1518+
},
1519+
"input":{"shape":"GetReservedNodeExchangeConfigurationOptionsInputMessage"},
1520+
"output":{
1521+
"shape":"GetReservedNodeExchangeConfigurationOptionsOutputMessage",
1522+
"resultWrapper":"GetReservedNodeExchangeConfigurationOptionsResult"
1523+
},
1524+
"errors":[
1525+
{"shape":"ReservedNodeNotFoundFault"},
1526+
{"shape":"InvalidReservedNodeStateFault"},
1527+
{"shape":"ReservedNodeAlreadyMigratedFault"},
1528+
{"shape":"ReservedNodeOfferingNotFoundFault"},
1529+
{"shape":"UnsupportedOperationFault"},
1530+
{"shape":"DependentServiceUnavailableFault"},
1531+
{"shape":"ClusterNotFoundFault"},
1532+
{"shape":"ClusterSnapshotNotFoundFault"}
1533+
],
1534+
"documentation":"<p>Gets the configuration options for the reserved-node exchange. These options include information about the source reserved node and target reserved node offering. Details include the node type, the price, the node count, and the offering type.</p>"
1535+
},
14951536
"GetReservedNodeExchangeOfferings":{
14961537
"name":"GetReservedNodeExchangeOfferings",
14971538
"http":{
@@ -1932,7 +1973,13 @@
19321973
{"shape":"UnsupportedOptionFault"},
19331974
{"shape":"UnsupportedOperationFault"},
19341975
{"shape":"UnauthorizedOperation"},
1935-
{"shape":"LimitExceededFault"}
1976+
{"shape":"LimitExceededFault"},
1977+
{"shape":"ReservedNodeNotFoundFault"},
1978+
{"shape":"InvalidReservedNodeStateFault"},
1979+
{"shape":"ReservedNodeAlreadyMigratedFault"},
1980+
{"shape":"ReservedNodeOfferingNotFoundFault"},
1981+
{"shape":"DependentServiceUnavailableFault"},
1982+
{"shape":"ReservedNodeAlreadyExistsFault"}
19361983
],
19371984
"documentation":"<p>Changes the size of the cluster. You can change the cluster's type, or change the number or type of nodes. The default behavior is to use the elastic resize method. With an elastic resize, your cluster is available for read and write operations more quickly than with the classic resize method. </p> <p>Elastic resize operations have the following restrictions:</p> <ul> <li> <p>You can only resize clusters of the following types:</p> <ul> <li> <p>dc1.large (if your cluster is in a VPC)</p> </li> <li> <p>dc1.8xlarge (if your cluster is in a VPC)</p> </li> <li> <p>dc2.large</p> </li> <li> <p>dc2.8xlarge</p> </li> <li> <p>ds2.xlarge</p> </li> <li> <p>ds2.8xlarge</p> </li> <li> <p>ra3.xlplus</p> </li> <li> <p>ra3.4xlarge</p> </li> <li> <p>ra3.16xlarge</p> </li> </ul> </li> <li> <p>The type of nodes that you add must match the node type for the cluster.</p> </li> </ul>"
19381985
},
@@ -1972,7 +2019,14 @@
19722019
{"shape":"InvalidClusterTrackFault"},
19732020
{"shape":"SnapshotScheduleNotFoundFault"},
19742021
{"shape":"TagLimitExceededFault"},
1975-
{"shape":"InvalidTagFault"}
2022+
{"shape":"InvalidTagFault"},
2023+
{"shape":"ReservedNodeNotFoundFault"},
2024+
{"shape":"InvalidReservedNodeStateFault"},
2025+
{"shape":"ReservedNodeAlreadyMigratedFault"},
2026+
{"shape":"ReservedNodeOfferingNotFoundFault"},
2027+
{"shape":"DependentServiceUnavailableFault"},
2028+
{"shape":"ReservedNodeAlreadyExistsFault"},
2029+
{"shape":"UnsupportedOperationFault"}
19762030
],
19772031
"documentation":"<p>Creates a new cluster from a snapshot. By default, Amazon Redshift creates the resulting cluster with the same configuration as the original cluster from which the snapshot was created, except that the new cluster is created with the default cluster security and parameter groups. After Amazon Redshift creates the cluster, you can use the <a>ModifyCluster</a> API to associate a different security group and different parameter group with the restored cluster. If you are using a DS node type, you can also choose to change to another DS node type of the same size during restore.</p> <p>If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster restored.</p> <p> For more information about working with snapshots, go to <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html\">Amazon Redshift Snapshots</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p>"
19782032
},
@@ -2838,6 +2892,10 @@
28382892
"DefaultIamRoleArn":{
28392893
"shape":"String",
28402894
"documentation":"<p>The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.</p>"
2895+
},
2896+
"ReservedNodeExchangeStatus":{
2897+
"shape":"ReservedNodeExchangeStatus",
2898+
"documentation":"<p>The status of the reserved-node exchange request. Statuses include in-progress and requested.</p>"
28412899
}
28422900
},
28432901
"documentation":"<p>Describes a cluster.</p>",
@@ -5226,6 +5284,40 @@
52265284
}
52275285
}
52285286
},
5287+
"DescribeReservedNodeExchangeStatusInputMessage":{
5288+
"type":"structure",
5289+
"members":{
5290+
"ReservedNodeId":{
5291+
"shape":"String",
5292+
"documentation":"<p>The identifier of the source reserved node in a reserved-node exchange request.</p>"
5293+
},
5294+
"ReservedNodeExchangeRequestId":{
5295+
"shape":"String",
5296+
"documentation":"<p>The identifier of the reserved-node exchange request.</p>"
5297+
},
5298+
"MaxRecords":{
5299+
"shape":"IntegerOptional",
5300+
"documentation":"<p>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>Marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.</p>"
5301+
},
5302+
"Marker":{
5303+
"shape":"String",
5304+
"documentation":"<p>An optional pagination token provided by a previous <code>DescribeReservedNodeExchangeStatus</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the <code>MaxRecords</code> parameter. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request.</p>"
5305+
}
5306+
}
5307+
},
5308+
"DescribeReservedNodeExchangeStatusOutputMessage":{
5309+
"type":"structure",
5310+
"members":{
5311+
"ReservedNodeExchangeStatusDetails":{
5312+
"shape":"ReservedNodeExchangeStatusList",
5313+
"documentation":"<p>The details of the reserved-node exchange request, including the status, request time, source reserved-node identifier, and additional details.</p>"
5314+
},
5315+
"Marker":{
5316+
"shape":"String",
5317+
"documentation":"<p>A pagination token provided by a previous <code>DescribeReservedNodeExchangeStatus</code> request.</p>"
5318+
}
5319+
}
5320+
},
52295321
"DescribeReservedNodeOfferingsMessage":{
52305322
"type":"structure",
52315323
"members":{
@@ -6082,6 +6174,45 @@
60826174
},
60836175
"documentation":"<p>The request parameters to get cluster credentials.</p>"
60846176
},
6177+
"GetReservedNodeExchangeConfigurationOptionsInputMessage":{
6178+
"type":"structure",
6179+
"required":["ActionType"],
6180+
"members":{
6181+
"ActionType":{
6182+
"shape":"ReservedNodeExchangeActionType",
6183+
"documentation":"<p>The action type of the reserved-node configuration. The action type can be an exchange initiated from either a snapshot or a resize.</p>"
6184+
},
6185+
"ClusterIdentifier":{
6186+
"shape":"String",
6187+
"documentation":"<p>The identifier for the cluster that is the source for a reserved-node exchange.</p>"
6188+
},
6189+
"SnapshotIdentifier":{
6190+
"shape":"String",
6191+
"documentation":"<p>The identifier for the snapshot that is the source for the reserved-node exchange.</p>"
6192+
},
6193+
"MaxRecords":{
6194+
"shape":"IntegerOptional",
6195+
"documentation":"<p>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>Marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.</p>"
6196+
},
6197+
"Marker":{
6198+
"shape":"String",
6199+
"documentation":"<p>An optional pagination token provided by a previous <code>GetReservedNodeExchangeConfigurationOptions</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the <code>MaxRecords</code> parameter. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request.</p>"
6200+
}
6201+
}
6202+
},
6203+
"GetReservedNodeExchangeConfigurationOptionsOutputMessage":{
6204+
"type":"structure",
6205+
"members":{
6206+
"Marker":{
6207+
"shape":"String",
6208+
"documentation":"<p>A pagination token provided by a previous <code>GetReservedNodeExchangeConfigurationOptions</code> request.</p>"
6209+
},
6210+
"ReservedNodeConfigurationOptionList":{
6211+
"shape":"ReservedNodeConfigurationOptionList",
6212+
"documentation":"<p>the configuration options for the reserved-node exchange. These options include information about the source reserved node and target reserved node. Details include the node type, the price, the node count, and the offering type.</p>"
6213+
}
6214+
}
6215+
},
60856216
"GetReservedNodeExchangeOfferingsInputMessage":{
60866217
"type":"structure",
60876218
"required":["ReservedNodeId"],
@@ -7910,6 +8041,106 @@
79108041
},
79118042
"exception":true
79128043
},
8044+
"ReservedNodeConfigurationOption":{
8045+
"type":"structure",
8046+
"members":{
8047+
"SourceReservedNode":{"shape":"ReservedNode"},
8048+
"TargetReservedNodeCount":{
8049+
"shape":"Integer",
8050+
"documentation":"<p>The target reserved-node count.</p>"
8051+
},
8052+
"TargetReservedNodeOffering":{"shape":"ReservedNodeOffering"}
8053+
},
8054+
"documentation":"<p>Details for a reserved-node exchange. Examples include the node type for a reserved node, the price for a node, the node's state, and other details.</p>",
8055+
"wrapper":true
8056+
},
8057+
"ReservedNodeConfigurationOptionList":{
8058+
"type":"list",
8059+
"member":{
8060+
"shape":"ReservedNodeConfigurationOption",
8061+
"locationName":"ReservedNodeConfigurationOption"
8062+
}
8063+
},
8064+
"ReservedNodeExchangeActionType":{
8065+
"type":"string",
8066+
"enum":[
8067+
"restore-cluster",
8068+
"resize-cluster"
8069+
]
8070+
},
8071+
"ReservedNodeExchangeNotFoundFault":{
8072+
"type":"structure",
8073+
"members":{
8074+
},
8075+
"documentation":"<p>The reserved-node exchange status wasn't found.</p>",
8076+
"error":{
8077+
"code":"ReservedNodeExchangeNotFond",
8078+
"httpStatusCode":404,
8079+
"senderFault":true
8080+
},
8081+
"exception":true
8082+
},
8083+
"ReservedNodeExchangeStatus":{
8084+
"type":"structure",
8085+
"members":{
8086+
"ReservedNodeExchangeRequestId":{
8087+
"shape":"String",
8088+
"documentation":"<p>The identifier of the reserved-node exchange request.</p>"
8089+
},
8090+
"Status":{
8091+
"shape":"ReservedNodeExchangeStatusType",
8092+
"documentation":"<p>The status of the reserved-node exchange request. Statuses include in-progress and requested.</p>"
8093+
},
8094+
"RequestTime":{
8095+
"shape":"TStamp",
8096+
"documentation":"<p>A date and time that indicate when the reserved-node exchange was requested.</p>"
8097+
},
8098+
"SourceReservedNodeId":{
8099+
"shape":"String",
8100+
"documentation":"<p>The identifier of the source reserved node.</p>"
8101+
},
8102+
"SourceReservedNodeType":{
8103+
"shape":"String",
8104+
"documentation":"<p>The source reserved-node type, for example ds2.xlarge.</p>"
8105+
},
8106+
"SourceReservedNodeCount":{
8107+
"shape":"Integer",
8108+
"documentation":"<p>The source reserved-node count in the cluster.</p>"
8109+
},
8110+
"TargetReservedNodeOfferingId":{
8111+
"shape":"String",
8112+
"documentation":"<p>The identifier of the target reserved node offering.</p>"
8113+
},
8114+
"TargetReservedNodeType":{
8115+
"shape":"String",
8116+
"documentation":"<p>The node type of the target reserved node, for example ra3.4xlarge.</p>"
8117+
},
8118+
"TargetReservedNodeCount":{
8119+
"shape":"Integer",
8120+
"documentation":"<p>The count of target reserved nodes in the cluster.</p>"
8121+
}
8122+
},
8123+
"documentation":"<p>Reserved-node status details, such as the source reserved-node identifier, the target reserved-node identifier, the node type, the node count, and other details.</p>",
8124+
"wrapper":true
8125+
},
8126+
"ReservedNodeExchangeStatusList":{
8127+
"type":"list",
8128+
"member":{
8129+
"shape":"ReservedNodeExchangeStatus",
8130+
"locationName":"ReservedNodeExchangeStatus"
8131+
}
8132+
},
8133+
"ReservedNodeExchangeStatusType":{
8134+
"type":"string",
8135+
"enum":[
8136+
"REQUESTED",
8137+
"PENDING",
8138+
"IN_PROGRESS",
8139+
"RETRYING",
8140+
"SUCCEEDED",
8141+
"FAILED"
8142+
]
8143+
},
79138144
"ReservedNodeList":{
79148145
"type":"list",
79158146
"member":{
@@ -8080,6 +8311,14 @@
80808311
"Classic":{
80818312
"shape":"BooleanOptional",
80828313
"documentation":"<p>A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to <code>false</code>, the resize type is elastic. </p>"
8314+
},
8315+
"ReservedNodeId":{
8316+
"shape":"String",
8317+
"documentation":"<p>The identifier of the reserved node.</p>"
8318+
},
8319+
"TargetReservedNodeOfferingId":{
8320+
"shape":"String",
8321+
"documentation":"<p>The identifier of the target reserved node offering.</p>"
80838322
}
80848323
},
80858324
"documentation":"<p>Describes a resize cluster operation. For example, a scheduled action to run the <code>ResizeCluster</code> API operation. </p>"
@@ -8327,6 +8566,14 @@
83278566
"DefaultIamRoleArn":{
83288567
"shape":"String",
83298568
"documentation":"<p>The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was last modified while it was restored from a snapshot.</p>"
8569+
},
8570+
"ReservedNodeId":{
8571+
"shape":"String",
8572+
"documentation":"<p>The identifier of the target reserved node offering.</p>"
8573+
},
8574+
"TargetReservedNodeOfferingId":{
8575+
"shape":"String",
8576+
"documentation":"<p>The identifier of the target reserved node offering.</p>"
83308577
}
83318578
},
83328579
"documentation":"<p/>"

0 commit comments

Comments
 (0)