Skip to content

Commit

Permalink
docs(client-redshift): Update for documentation only. Covers port ran…
Browse files Browse the repository at this point in the history 
…ges, definition updates for data sharing, and definition updates to cluster-snapshot documentation.
  • Loading branch information
awstools committed Mar 6, 2024
1 parent d5a6d35 commit abd8a84
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 32 deletions.
41 changes: 30 additions & 11 deletions clients/client-redshift/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -594,7 +594,7 @@ export interface AquaConfiguration {
export interface AssociateDataShareConsumerMessage {
/**
* @public
* <p>The Amazon Resource Name (ARN) of the datashare that the consumer is to use with the account or the namespace.</p>
* <p>The Amazon Resource Name (ARN) of the datashare that the consumer is to use.</p>
*/
DataShareArn: string | undefined;

Expand All @@ -606,7 +606,7 @@ export interface AssociateDataShareConsumerMessage {

/**
* @public
* <p>The Amazon Resource Name (ARN) of the consumer that is associated with the
* <p>The Amazon Resource Name (ARN) of the consumer namespace associated with the
* datashare.</p>
*/
ConsumerArn?: string;
Expand Down Expand Up @@ -698,13 +698,13 @@ export interface DataShareAssociation {
export interface DataShare {
/**
* @public
* <p>An Amazon Resource Name (ARN) that references the datashare that is owned by a specific namespace of the producer cluster. A datashare ARN is in the <code>arn:aws:redshift:\{region\}:\{account-id\}:\{datashare\}:\{namespace-guid\}/\{datashare-name\}</code> format.</p>
* <p>The Amazon Resource Name (ARN) of the datashare that the consumer is to use.</p>
*/
DataShareArn?: string;

/**
* @public
* <p>The Amazon Resource Name (ARN) of the producer.</p>
* <p>The Amazon Resource Name (ARN) of the producer namespace.</p>
*/
ProducerArn?: string;

Expand Down Expand Up @@ -1204,7 +1204,7 @@ export class InvalidClusterSecurityGroupStateFault extends __BaseException {
export interface AuthorizeDataShareMessage {
/**
* @public
* <p>The Amazon Resource Name (ARN) of the datashare that producers are to authorize
* <p>The Amazon Resource Name (ARN) of the datashare namespace that producers are to authorize
* sharing for.</p>
*/
DataShareArn: string | undefined;
Expand Down Expand Up @@ -1424,9 +1424,19 @@ export interface AuthorizeSnapshotAccessMessage {

/**
* @public
* <p>The identifier of the cluster the snapshot was created from. This parameter is
* required if your IAM user has a policy containing a snapshot resource element that
* specifies anything other than * for the cluster name.</p>
* <p>The identifier of the cluster the snapshot was created from.</p>
* <ul>
* <li>
* <p>
* <i>If the snapshot to access doesn't exist and the associated IAM policy doesn't allow access to all (*) snapshots</i> - This parameter is required. Otherwise, permissions
* aren't available to check if the snapshot exists.</p>
* </li>
* <li>
* <p>
* <i>If the snapshot to access exists</i> - This parameter isn't required. Redshift can retrieve the cluster identifier and use it to
* validate snapshot authorization.</p>
* </li>
* </ul>
*/
SnapshotClusterIdentifier?: string;

Expand Down Expand Up @@ -4640,8 +4650,17 @@ export interface CreateClusterMessage {
* connections.</p>
* <p>Default: <code>5439</code>
* </p>
* <p>Valid Values: <code>1150-65535</code>
* </p>
* <p>Valid Values:
* </p>
* <ul>
* <li>
* <p>For clusters with ra3 nodes - Select a port within the ranges <code>5431-5455</code> or <code>8191-8215</code>. (If you have an existing cluster
* with ra3 nodes, it isn't required that you change the port to these ranges.)</p>
* </li>
* <li>
* <p>For clusters with ds2 or dc2 nodes - Select a port within the range <code>1150-65535</code>.</p>
* </li>
* </ul>
*/
Port?: number;

Expand Down Expand Up @@ -7565,7 +7584,7 @@ export type DataShareStatusForProducer = (typeof DataShareStatusForProducer)[key
export interface DeauthorizeDataShareMessage {
/**
* @public
* <p>The Amazon Resource Name (ARN) of the datashare to remove authorization from.</p>
* <p>The namespace Amazon Resource Name (ARN) of the datashare to remove authorization from.</p>
*/
DataShareArn: string | undefined;

Expand Down
24 changes: 18 additions & 6 deletions clients/client-redshift/src/models/models_1.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ export interface DescribeCustomDomainAssociationsMessage {
export interface DescribeDataSharesMessage {
/**
* @public
* <p>The identifier of the datashare to describe details of.</p>
* <p>The Amazon resource name (ARN) of the datashare to describe details of.</p>
*/
DataShareArn?: string;

Expand Down Expand Up @@ -174,7 +174,7 @@ export interface DescribeDataSharesResult {
export interface DescribeDataSharesForConsumerMessage {
/**
* @public
* <p>The Amazon Resource Name (ARN) of the consumer that returns in the list of datashares.</p>
* <p>The Amazon Resource Name (ARN) of the consumer namespace that returns in the list of datashares.</p>
*/
ConsumerArn?: string;

Expand Down Expand Up @@ -234,7 +234,7 @@ export interface DescribeDataSharesForConsumerResult {
export interface DescribeDataSharesForProducerMessage {
/**
* @public
* <p>The Amazon Resource Name (ARN) of the producer that returns in the list of datashares.</p>
* <p>The Amazon Resource Name (ARN) of the producer namespace that returns in the list of datashares.</p>
*/
ProducerArn?: string;

Expand Down Expand Up @@ -2759,7 +2759,7 @@ export class SnapshotCopyAlreadyDisabledFault extends __BaseException {
export interface DisassociateDataShareConsumerMessage {
/**
* @public
* <p>The Amazon Resource Name (ARN) of the datashare to remove association for. </p>
* <p>The Amazon Resource Name (ARN) of the datashare to remove association for.</p>
*/
DataShareArn: string | undefined;

Expand All @@ -2772,7 +2772,7 @@ export interface DisassociateDataShareConsumerMessage {

/**
* @public
* <p>The Amazon Resource Name (ARN) of the consumer that association for
* <p>The Amazon Resource Name (ARN) of the consumer namespace that association for
* the datashare is removed from.</p>
*/
ConsumerArn?: string;
Expand Down Expand Up @@ -4098,6 +4098,17 @@ export interface ModifyClusterMessage {
/**
* @public
* <p>The option to change the port of an Amazon Redshift cluster.</p>
* <p>Valid Values:
* </p>
* <ul>
* <li>
* <p>For clusters with ra3 nodes - Select a port within the ranges <code>5431-5455</code> or <code>8191-8215</code>. (If you have an existing cluster
* with ra3 nodes, it isn't required that you change the port to these ranges.)</p>
* </li>
* <li>
* <p>For clusters with ds2 or dc2 nodes - Select a port within the range <code>1150-65535</code>.</p>
* </li>
* </ul>
*/
Port?: number;

Expand Down Expand Up @@ -5074,7 +5085,8 @@ export interface RestoreFromClusterSnapshotMessage {
* @public
* <p>The port number on which the cluster accepts connections.</p>
* <p>Default: The same port as the original cluster.</p>
* <p>Constraints: Must be between <code>1115</code> and <code>65535</code>.</p>
* <p>Valid values: For clusters with ds2 or dc2 nodes, must be within the range <code>1150</code>-<code>65535</code>. For clusters with ra3 nodes, must be
* within the ranges <code>5431</code>-<code>5455</code> or <code>8191</code>-<code>8215</code>.</p>
*/
Port?: number;

Expand Down
30 changes: 15 additions & 15 deletions codegen/sdk-codegen/aws-models/redshift.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,7 @@
"target": "com.amazonaws.redshift#String",
"traits": {
"smithy.api#clientOptional": {},
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the datashare that the consumer is to use with the account or the namespace.</p>",
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the datashare that the consumer is to use.</p>",
"smithy.api#required": {}
}
},
Expand All @@ -351,7 +351,7 @@
"ConsumerArn": {
"target": "com.amazonaws.redshift#String",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the consumer that is associated with the\n datashare.</p>"
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the consumer namespace associated with the\n datashare.</p>"
}
},
"ConsumerRegion": {
Expand Down Expand Up @@ -707,7 +707,7 @@
"target": "com.amazonaws.redshift#String",
"traits": {
"smithy.api#clientOptional": {},
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the datashare that producers are to authorize\n sharing for.</p>",
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the datashare namespace that producers are to authorize\n sharing for.</p>",
"smithy.api#required": {}
}
},
Expand Down Expand Up @@ -843,7 +843,7 @@
"SnapshotClusterIdentifier": {
"target": "com.amazonaws.redshift#String",
"traits": {
"smithy.api#documentation": "<p>The identifier of the cluster the snapshot was created from. This parameter is\n required if your IAM user has a policy containing a snapshot resource element that\n specifies anything other than * for the cluster name.</p>"
"smithy.api#documentation": "<p>The identifier of the cluster the snapshot was created from.</p>\n <ul>\n <li>\n <p>\n <i>If the snapshot to access doesn't exist and the associated IAM policy doesn't allow access to all (*) snapshots</i> - This parameter is required. Otherwise, permissions \n aren't available to check if the snapshot exists.</p>\n </li>\n <li>\n <p>\n <i>If the snapshot to access exists</i> - This parameter isn't required. Redshift can retrieve the cluster identifier and use it to \n validate snapshot authorization.</p>\n </li>\n </ul>"
}
},
"AccountWithRestoreAccess": {
Expand Down Expand Up @@ -2883,7 +2883,7 @@
"Port": {
"target": "com.amazonaws.redshift#IntegerOptional",
"traits": {
"smithy.api#documentation": "<p>The port number on which the cluster accepts incoming connections.</p>\n <p>The cluster is accessible only via the JDBC and ODBC connection strings. Part of\n the connection string requires the port on which the cluster will listen for incoming\n connections.</p>\n <p>Default: <code>5439</code>\n </p>\n <p>Valid Values: <code>1150-65535</code>\n </p>"
"smithy.api#documentation": "<p>The port number on which the cluster accepts incoming connections.</p>\n <p>The cluster is accessible only via the JDBC and ODBC connection strings. Part of\n the connection string requires the port on which the cluster will listen for incoming\n connections.</p>\n <p>Default: <code>5439</code>\n </p>\n <p>Valid Values:\n </p>\n <ul>\n <li>\n <p>For clusters with ra3 nodes - Select a port within the ranges <code>5431-5455</code> or <code>8191-8215</code>. (If you have an existing cluster \n with ra3 nodes, it isn't required that you change the port to these ranges.)</p>\n </li>\n <li>\n <p>For clusters with ds2 or dc2 nodes - Select a port within the range <code>1150-65535</code>.</p>\n </li>\n </ul>"
}
},
"ClusterVersion": {
Expand Down Expand Up @@ -4406,13 +4406,13 @@
"DataShareArn": {
"target": "com.amazonaws.redshift#String",
"traits": {
"smithy.api#documentation": "<p>An Amazon Resource Name (ARN) that references the datashare that is owned by a specific namespace of the producer cluster. A datashare ARN is in the <code>arn:aws:redshift:{region}:{account-id}:{datashare}:{namespace-guid}/{datashare-name}</code> format.</p>"
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the datashare that the consumer is to use.</p>"
}
},
"ProducerArn": {
"target": "com.amazonaws.redshift#String",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the producer.</p>"
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the producer namespace.</p>"
}
},
"AllowPubliclyAccessibleConsumers": {
Expand Down Expand Up @@ -4667,7 +4667,7 @@
"target": "com.amazonaws.redshift#String",
"traits": {
"smithy.api#clientOptional": {},
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the datashare to remove authorization from.</p>",
"smithy.api#documentation": "<p>The namespace Amazon Resource Name (ARN) of the datashare to remove authorization from.</p>",
"smithy.api#required": {}
}
},
Expand Down Expand Up @@ -6500,7 +6500,7 @@
"ConsumerArn": {
"target": "com.amazonaws.redshift#String",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the consumer that returns in the list of datashares.</p>"
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the consumer namespace that returns in the list of datashares.</p>"
}
},
"Status": {
Expand Down Expand Up @@ -6575,7 +6575,7 @@
"ProducerArn": {
"target": "com.amazonaws.redshift#String",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the producer that returns in the list of datashares.</p>"
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the producer namespace that returns in the list of datashares.</p>"
}
},
"Status": {
Expand Down Expand Up @@ -6627,7 +6627,7 @@
"DataShareArn": {
"target": "com.amazonaws.redshift#String",
"traits": {
"smithy.api#documentation": "<p>The identifier of the datashare to describe details of.</p>"
"smithy.api#documentation": "<p>The Amazon resource name (ARN) of the datashare to describe details of.</p>"
}
},
"MaxRecords": {
Expand Down Expand Up @@ -8348,7 +8348,7 @@
"target": "com.amazonaws.redshift#String",
"traits": {
"smithy.api#clientOptional": {},
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the datashare to remove association for. </p>",
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the datashare to remove association for.</p>",
"smithy.api#required": {}
}
},
Expand All @@ -8361,7 +8361,7 @@
"ConsumerArn": {
"target": "com.amazonaws.redshift#String",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the consumer that association for\n the datashare is removed from.</p>"
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the consumer namespace that association for\n the datashare is removed from.</p>"
}
},
"ConsumerRegion": {
Expand Down Expand Up @@ -11583,7 +11583,7 @@
"Port": {
"target": "com.amazonaws.redshift#IntegerOptional",
"traits": {
"smithy.api#documentation": "<p>The option to change the port of an Amazon Redshift cluster.</p>"
"smithy.api#documentation": "<p>The option to change the port of an Amazon Redshift cluster.</p>\n <p>Valid Values:\n </p>\n <ul>\n <li>\n <p>For clusters with ra3 nodes - Select a port within the ranges <code>5431-5455</code> or <code>8191-8215</code>. (If you have an existing cluster \n with ra3 nodes, it isn't required that you change the port to these ranges.)</p>\n </li>\n <li>\n <p>For clusters with ds2 or dc2 nodes - Select a port within the range <code>1150-65535</code>.</p>\n </li>\n </ul>"
}
},
"ManageMasterPassword": {
Expand Down Expand Up @@ -16185,7 +16185,7 @@
"Port": {
"target": "com.amazonaws.redshift#IntegerOptional",
"traits": {
"smithy.api#documentation": "<p>The port number on which the cluster accepts connections.</p>\n <p>Default: The same port as the original cluster.</p>\n <p>Constraints: Must be between <code>1115</code> and <code>65535</code>.</p>"
"smithy.api#documentation": "<p>The port number on which the cluster accepts connections.</p>\n <p>Default: The same port as the original cluster.</p>\n <p>Valid values: For clusters with ds2 or dc2 nodes, must be within the range <code>1150</code>-<code>65535</code>. For clusters with ra3 nodes, must be \n within the ranges <code>5431</code>-<code>5455</code> or <code>8191</code>-<code>8215</code>.</p>"
}
},
"AvailabilityZone": {
Expand Down

0 comments on commit abd8a84

Please sign in to comment.