Skip to content

Commit 9b91388

Browse files
author
awstools
committed
feat(client-redshift): Introduces new field 'LoadSampleData' in CreateCluster operation. Customers can now specify 'LoadSampleData' option during creation of a cluster, which results in loading of sample data in the cluster that is created.
1 parent 6c6525c commit 9b91388

File tree

9 files changed

+41
-26
lines changed

9 files changed

+41
-26
lines changed

clients/client-redshift/src/Redshift.ts

+6-6
Original file line numberDiff line numberDiff line change
@@ -751,8 +751,8 @@ export class Redshift extends RedshiftClient {
751751

752752
/**
753753
* <p>From a data producer account, authorizes the sharing of a datashare with one or more
754-
* consumer accounts or managing entities. To authorize a datashare for a data consumer, the producer account
755-
* must have the correct access privileges.</p>
754+
* consumer accounts or managing entities. To authorize a datashare for a data consumer,
755+
* the producer account must have the correct access permissions.</p>
756756
*/
757757
public authorizeDataShare(
758758
args: AuthorizeDataShareCommandInput,
@@ -1536,7 +1536,7 @@ export class Redshift extends RedshiftClient {
15361536
}
15371537

15381538
/**
1539-
* <p>From the producer account, removes authorization from the specified datashare. </p>
1539+
* <p>From a datashare producer account, removes authorization from the specified datashare. </p>
15401540
*/
15411541
public deauthorizeDataShare(
15421542
args: DeauthorizeDataShareCommandInput,
@@ -3559,7 +3559,7 @@ export class Redshift extends RedshiftClient {
35593559
}
35603560

35613561
/**
3562-
* <p>From a consumer account, remove association for the specified datashare.
3562+
* <p>From a datashare consumer account, remove association for the specified datashare.
35633563
* </p>
35643564
*/
35653565
public disassociateDataShareConsumer(
@@ -3676,7 +3676,7 @@ export class Redshift extends RedshiftClient {
36763676
* <code>dbgroups</code>. </p>
36773677
* <p>In addition, if the <code>AutoCreate</code> parameter is set to <code>True</code>,
36783678
* then the policy must include the <code>redshift:CreateClusterUser</code>
3679-
* privilege.</p>
3679+
* permission.</p>
36803680
* <p>If the <code>DbName</code> parameter is specified, the IAM policy must allow access
36813681
* to the resource <code>dbname</code> for the specified database name. </p>
36823682
*/
@@ -4427,7 +4427,7 @@ export class Redshift extends RedshiftClient {
44274427
}
44284428

44294429
/**
4430-
* <p>From the consumer account, rejects the specified datashare.</p>
4430+
* <p>From a datashare consumer account, rejects the specified datashare.</p>
44314431
*/
44324432
public rejectDataShare(
44334433
args: RejectDataShareCommandInput,

clients/client-redshift/src/commands/AuthorizeDataShareCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ export interface AuthorizeDataShareCommandOutput extends DataShare, __MetadataBe
2424

2525
/**
2626
* <p>From a data producer account, authorizes the sharing of a datashare with one or more
27-
* consumer accounts or managing entities. To authorize a datashare for a data consumer, the producer account
28-
* must have the correct access privileges.</p>
27+
* consumer accounts or managing entities. To authorize a datashare for a data consumer,
28+
* the producer account must have the correct access permissions.</p>
2929
* @example
3030
* Use a bare-bones client and the command you need to make an API call.
3131
* ```javascript

clients/client-redshift/src/commands/DeauthorizeDataShareCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export interface DeauthorizeDataShareCommandInput extends DeauthorizeDataShareMe
2323
export interface DeauthorizeDataShareCommandOutput extends DataShare, __MetadataBearer {}
2424

2525
/**
26-
* <p>From the producer account, removes authorization from the specified datashare. </p>
26+
* <p>From a datashare producer account, removes authorization from the specified datashare. </p>
2727
* @example
2828
* Use a bare-bones client and the command you need to make an API call.
2929
* ```javascript

clients/client-redshift/src/commands/DisassociateDataShareConsumerCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ export interface DisassociateDataShareConsumerCommandInput extends DisassociateD
2424
export interface DisassociateDataShareConsumerCommandOutput extends DataShare, __MetadataBearer {}
2525

2626
/**
27-
* <p>From a consumer account, remove association for the specified datashare.
27+
* <p>From a datashare consumer account, remove association for the specified datashare.
2828
* </p>
2929
* @example
3030
* Use a bare-bones client and the command you need to make an API call.

clients/client-redshift/src/commands/GetClusterCredentialsCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ export interface GetClusterCredentialsCommandOutput extends ClusterCredentials,
4242
* <code>dbgroups</code>. </p>
4343
* <p>In addition, if the <code>AutoCreate</code> parameter is set to <code>True</code>,
4444
* then the policy must include the <code>redshift:CreateClusterUser</code>
45-
* privilege.</p>
45+
* permission.</p>
4646
* <p>If the <code>DbName</code> parameter is specified, the IAM policy must allow access
4747
* to the resource <code>dbname</code> for the specified database name. </p>
4848
* @example

clients/client-redshift/src/commands/RejectDataShareCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ export interface RejectDataShareCommandInput extends RejectDataShareMessage {}
2424
export interface RejectDataShareCommandOutput extends DataShare, __MetadataBearer {}
2525

2626
/**
27-
* <p>From the consumer account, rejects the specified datashare.</p>
27+
* <p>From a datashare consumer account, rejects the specified datashare.</p>
2828
* @example
2929
* Use a bare-bones client and the command you need to make an API call.
3030
* ```javascript

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

+13-7
Original file line numberDiff line numberDiff line change
@@ -705,7 +705,8 @@ export interface DataShare {
705705
AllowPubliclyAccessibleConsumers?: boolean;
706706

707707
/**
708-
* <p>A value that specifies when the datashare has an association between a producer and data consumers.</p>
708+
* <p>A value that specifies when the datashare has an association between producer and data
709+
* consumers.</p>
709710
*/
710711
DataShareAssociations?: DataShareAssociation[];
711712

@@ -3308,12 +3309,12 @@ export class ClusterAlreadyExistsFault extends __BaseException {
33083309
*/
33093310
export interface ClusterCredentials {
33103311
/**
3311-
* <p>A database user name that is authorized to log on to the database
3312-
* <code>DbName</code> using the password <code>DbPassword</code>. If the specified
3313-
* DbUser exists in the database, the new user name has the same database privileges as the
3314-
* the user named in DbUser. By default, the user is added to PUBLIC. If the
3315-
* <code>DbGroups</code> parameter is specifed, <code>DbUser</code> is added to the
3316-
* listed groups for any sessions created using these credentials.</p>
3312+
* <p>A database user name that is authorized to log on to the database <code>DbName</code>
3313+
* using the password <code>DbPassword</code>. If the specified DbUser exists in the
3314+
* database, the new user name has the same database permissions as the the user named in
3315+
* DbUser. By default, the user is added to PUBLIC. If the <code>DbGroups</code> parameter
3316+
* is specifed, <code>DbUser</code> is added to the listed groups for any sessions created
3317+
* using these credentials.</p>
33173318
*/
33183319
DbUser?: string;
33193320

@@ -4654,6 +4655,11 @@ export interface CreateClusterMessage {
46544655
* <p>The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created. </p>
46554656
*/
46564657
DefaultIamRoleArn?: string;
4658+
4659+
/**
4660+
* <p>A flag that specifies whether to load sample data once the cluster is created.</p>
4661+
*/
4662+
LoadSampleData?: string;
46574663
}
46584664

46594665
export namespace CreateClusterMessage {

clients/client-redshift/src/protocols/Aws_query.ts

+3
Original file line numberDiff line numberDiff line change
@@ -10736,6 +10736,9 @@ const serializeAws_queryCreateClusterMessage = (input: CreateClusterMessage, con
1073610736
if (input.DefaultIamRoleArn !== undefined && input.DefaultIamRoleArn !== null) {
1073710737
entries["DefaultIamRoleArn"] = input.DefaultIamRoleArn;
1073810738
}
10739+
if (input.LoadSampleData !== undefined && input.LoadSampleData !== null) {
10740+
entries["LoadSampleData"] = input.LoadSampleData;
10741+
}
1073910742
return entries;
1074010743
};
1074110744

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

+13-7
Original file line numberDiff line numberDiff line change
@@ -622,7 +622,7 @@
622622
}
623623
],
624624
"traits": {
625-
"smithy.api#documentation": "<p>From a data producer account, authorizes the sharing of a datashare with one or more\n consumer accounts or managing entities. To authorize a datashare for a data consumer, the producer account\n must have the correct access privileges.</p>"
625+
"smithy.api#documentation": "<p>From a data producer account, authorizes the sharing of a datashare with one or more\n consumer accounts or managing entities. To authorize a datashare for a data consumer,\n the producer account must have the correct access permissions.</p>"
626626
}
627627
},
628628
"com.amazonaws.redshift#AuthorizeDataShareMessage": {
@@ -1383,7 +1383,7 @@
13831383
"DbUser": {
13841384
"target": "com.amazonaws.redshift#String",
13851385
"traits": {
1386-
"smithy.api#documentation": "<p>A database user name that is authorized to log on to the database\n <code>DbName</code> using the password <code>DbPassword</code>. If the specified\n DbUser exists in the database, the new user name has the same database privileges as the\n the user named in DbUser. By default, the user is added to PUBLIC. If the\n <code>DbGroups</code> parameter is specifed, <code>DbUser</code> is added to the\n listed groups for any sessions created using these credentials.</p>"
1386+
"smithy.api#documentation": "<p>A database user name that is authorized to log on to the database <code>DbName</code>\n using the password <code>DbPassword</code>. If the specified DbUser exists in the\n database, the new user name has the same database permissions as the the user named in\n DbUser. By default, the user is added to PUBLIC. If the <code>DbGroups</code> parameter\n is specifed, <code>DbUser</code> is added to the listed groups for any sessions created\n using these credentials.</p>"
13871387
}
13881388
},
13891389
"DbPassword": {
@@ -2678,6 +2678,12 @@
26782678
"traits": {
26792679
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created. </p>"
26802680
}
2681+
},
2682+
"LoadSampleData": {
2683+
"target": "com.amazonaws.redshift#String",
2684+
"traits": {
2685+
"smithy.api#documentation": "<p>A flag that specifies whether to load sample data once the cluster is created.</p>"
2686+
}
26812687
}
26822688
},
26832689
"traits": {
@@ -3724,7 +3730,7 @@
37243730
"DataShareAssociations": {
37253731
"target": "com.amazonaws.redshift#DataShareAssociationList",
37263732
"traits": {
3727-
"smithy.api#documentation": "<p>A value that specifies when the datashare has an association between a producer and data consumers.</p>"
3733+
"smithy.api#documentation": "<p>A value that specifies when the datashare has an association between producer and data\n consumers.</p>"
37283734
}
37293735
},
37303736
"ManagedBy": {
@@ -3925,7 +3931,7 @@
39253931
}
39263932
],
39273933
"traits": {
3928-
"smithy.api#documentation": "<p>From the producer account, removes authorization from the specified datashare. </p>"
3934+
"smithy.api#documentation": "<p>From a datashare producer account, removes authorization from the specified datashare. </p>"
39293935
}
39303936
},
39313937
"com.amazonaws.redshift#DeauthorizeDataShareMessage": {
@@ -7070,7 +7076,7 @@
70707076
}
70717077
],
70727078
"traits": {
7073-
"smithy.api#documentation": "<p>From a consumer account, remove association for the specified datashare.\n </p>"
7079+
"smithy.api#documentation": "<p>From a datashare consumer account, remove association for the specified datashare.\n </p>"
70747080
}
70757081
},
70767082
"com.amazonaws.redshift#DisassociateDataShareConsumerMessage": {
@@ -7978,7 +7984,7 @@
79787984
}
79797985
],
79807986
"traits": {
7981-
"smithy.api#documentation": "<p>Returns a database user name and temporary password with temporary authorization to\n log on to an Amazon Redshift database. The action returns the database user name\n prefixed with <code>IAM:</code> if <code>AutoCreate</code> is <code>False</code> or\n <code>IAMA:</code> if <code>AutoCreate</code> is <code>True</code>. You can\n optionally specify one or more database user groups that the user will join at log on.\n By default, the temporary credentials expire in 900 seconds. You can optionally specify\n a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more\n information, see <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/generating-user-credentials.html\">Using IAM Authentication\n to Generate Database User Credentials</a> in the Amazon Redshift Cluster Management Guide.</p>\n <p>The Identity and Access Management (IAM) user or role that runs\n GetClusterCredentials must have an IAM policy attached that allows access to all\n 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\n Amazon Redshift Cluster Management Guide.</p>\n <p>If the <code>DbGroups</code> parameter is specified, the IAM policy must allow the\n <code>redshift:JoinGroup</code> action with access to the listed\n <code>dbgroups</code>. </p>\n <p>In addition, if the <code>AutoCreate</code> parameter is set to <code>True</code>,\n then the policy must include the <code>redshift:CreateClusterUser</code>\n privilege.</p>\n <p>If the <code>DbName</code> parameter is specified, the IAM policy must allow access\n to the resource <code>dbname</code> for the specified database name. </p>"
7987+
"smithy.api#documentation": "<p>Returns a database user name and temporary password with temporary authorization to\n log on to an Amazon Redshift database. The action returns the database user name\n prefixed with <code>IAM:</code> if <code>AutoCreate</code> is <code>False</code> or\n <code>IAMA:</code> if <code>AutoCreate</code> is <code>True</code>. You can\n optionally specify one or more database user groups that the user will join at log on.\n By default, the temporary credentials expire in 900 seconds. You can optionally specify\n a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more\n information, see <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/generating-user-credentials.html\">Using IAM Authentication\n to Generate Database User Credentials</a> in the Amazon Redshift Cluster Management Guide.</p>\n <p>The Identity and Access Management (IAM) user or role that runs\n GetClusterCredentials must have an IAM policy attached that allows access to all\n 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\n Amazon Redshift Cluster Management Guide.</p>\n <p>If the <code>DbGroups</code> parameter is specified, the IAM policy must allow the\n <code>redshift:JoinGroup</code> action with access to the listed\n <code>dbgroups</code>. </p>\n <p>In addition, if the <code>AutoCreate</code> parameter is set to <code>True</code>,\n then the policy must include the <code>redshift:CreateClusterUser</code>\n permission.</p>\n <p>If the <code>DbName</code> parameter is specified, the IAM policy must allow access\n to the resource <code>dbname</code> for the specified database name. </p>"
79827988
}
79837989
},
79847990
"com.amazonaws.redshift#GetClusterCredentialsMessage": {
@@ -11596,7 +11602,7 @@
1159611602
}
1159711603
],
1159811604
"traits": {
11599-
"smithy.api#documentation": "<p>From the consumer account, rejects the specified datashare.</p>"
11605+
"smithy.api#documentation": "<p>From a datashare consumer account, rejects the specified datashare.</p>"
1160011606
}
1160111607
},
1160211608
"com.amazonaws.redshift#RejectDataShareMessage": {

0 commit comments

Comments
 (0)