AWS Redshift #Action=ModifyCluster API
The #Action=ModifyCluster API from AWS Redshift — 1 operation(s) for #action=modifycluster.
The #Action=ModifyCluster API from AWS Redshift — 1 operation(s) for #action=modifycluster.
openapi: 3.0.0
info:
version: '2019-12-20'
x-release: v4
title: 'Redshift Data API Service #Action=AcceptReservedNodeExchange #Action=AcceptReservedNodeExchange #Action=ModifyCluster API'
description: <p>You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You can run SQL statements, which are committed if the statement succeeds. </p> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: redshift-data
x-aws-signingName: redshift-data
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/redshift-data-2019-12-20.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://redshift-data.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Redshift Data API Service multi-region endpoint
- url: https://redshift-data.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Redshift Data API Service multi-region endpoint
- url: http://redshift-data.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Redshift Data API Service endpoint for China (Beijing) and China (Ningxia)
- url: https://redshift-data.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Redshift Data API Service endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#Action=ModifyCluster'
paths:
/#Action=ModifyCluster:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
x-aws-operation-name: ModifyCluster
operationId: GET_ModifyCluster
description: <p>Modifies the settings for a cluster.</p> <p>You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change.</p> <p>You can add another security or parameter group, or change the admin user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyClusterResult'
'480':
description: InvalidClusterStateFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidClusterStateFault'
'481':
description: InvalidClusterSecurityGroupStateFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidClusterSecurityGroupStateFault'
'482':
description: ClusterNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ClusterNotFoundFault'
'483':
description: NumberOfNodesQuotaExceededFault
content:
text/xml:
schema:
$ref: '#/components/schemas/NumberOfNodesQuotaExceededFault'
'484':
description: NumberOfNodesPerClusterLimitExceededFault
content:
text/xml:
schema:
$ref: '#/components/schemas/NumberOfNodesPerClusterLimitExceededFault'
'485':
description: ClusterSecurityGroupNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ClusterSecurityGroupNotFoundFault'
'486':
description: ClusterParameterGroupNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ClusterParameterGroupNotFoundFault'
'487':
description: InsufficientClusterCapacityFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InsufficientClusterCapacityFault'
'488':
description: UnsupportedOptionFault
content:
text/xml:
schema:
$ref: '#/components/schemas/UnsupportedOptionFault'
'489':
description: UnauthorizedOperation
content:
text/xml:
schema:
$ref: '#/components/schemas/UnauthorizedOperation'
'490':
description: HsmClientCertificateNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/HsmClientCertificateNotFoundFault'
'491':
description: HsmConfigurationNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/HsmConfigurationNotFoundFault'
'492':
description: ClusterAlreadyExistsFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ClusterAlreadyExistsFault'
'493':
description: LimitExceededFault
content:
text/xml:
schema:
$ref: '#/components/schemas/LimitExceededFault'
'494':
description: DependentServiceRequestThrottlingFault
content:
text/xml:
schema:
$ref: '#/components/schemas/DependentServiceRequestThrottlingFault'
'495':
description: InvalidElasticIpFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidElasticIpFault'
'496':
description: TableLimitExceededFault
content:
text/xml:
schema:
$ref: '#/components/schemas/TableLimitExceededFault'
'497':
description: InvalidClusterTrackFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidClusterTrackFault'
'498':
description: InvalidRetentionPeriodFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidRetentionPeriodFault'
parameters:
- name: ClusterIdentifier
in: query
required: true
description: '<p>The unique identifier of the cluster to be modified.</p> <p>Example: <code>examplecluster</code> </p>'
schema:
type: string
maxLength: 2147483647
- name: ClusterType
in: query
required: false
description: '<p>The new cluster type.</p> <p>When you submit your cluster resize request, your existing cluster goes into a read-only mode. After Amazon Redshift provisions a new cluster based on your resize requirements, there will be outage for a period while the old cluster is deleted and your connection is switched to the new cluster. You can use <a>DescribeResize</a> to track the progress of the resize request. </p> <p>Valid Values: <code> multi-node | single-node </code> </p>'
schema:
type: string
maxLength: 2147483647
- name: NodeType
in: query
required: false
description: '<p>The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter.</p> <p> For more information about resizing clusters, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/rs-resize-tutorial.html">Resizing Clusters in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p> <p>Valid Values: <code>ds2.xlarge</code> | <code>ds2.8xlarge</code> | <code>dc1.large</code> | <code>dc1.8xlarge</code> | <code>dc2.large</code> | <code>dc2.8xlarge</code> | <code>ra3.xlplus</code> | <code>ra3.4xlarge</code> | <code>ra3.16xlarge</code> </p>'
schema:
type: string
maxLength: 2147483647
- name: NumberOfNodes
in: query
required: false
description: '<p>The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter.</p> <p> For more information about resizing clusters, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/rs-resize-tutorial.html">Resizing Clusters in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p> <p>Valid Values: Integer greater than <code>0</code>.</p>'
schema:
type: integer
- name: ClusterSecurityGroups
in: query
required: false
description: <p>A list of cluster security groups to be authorized on this cluster. This change is asynchronously applied as soon as possible.</p> <p>Security groups currently associated with the cluster, and not in the list of groups to apply, will be revoked from the cluster.</p> <p>Constraints:</p> <ul> <li> <p>Must be 1 to 255 alphanumeric characters or hyphens</p> </li> <li> <p>First character must be a letter</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens</p> </li> </ul>
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ClusterSecurityGroupName
- name: VpcSecurityGroupIds
in: query
required: false
description: A list of virtual private cloud (VPC) security groups to be associated with the cluster. This change is asynchronously applied as soon as possible.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: VpcSecurityGroupId
- name: MasterUserPassword
in: query
required: false
description: '<p>The new password for the cluster admin user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the <code>MasterUserPassword</code> element exists in the <code>PendingModifiedValues</code> element of the operation response. </p> <note> <p>Operations never return the password, so this operation provides a way to regain access to the admin user for a cluster if the password is lost.</p> </note> <p>Default: Uses existing setting.</p> <p>Constraints:</p> <ul> <li> <p>Must be between 8 and 64 characters in length.</p> </li> <li> <p>Must contain at least one uppercase letter.</p> </li> <li> <p>Must contain at least one lowercase letter.</p> </li> <li> <p>Must contain one number.</p> </li> <li> <p>Can be any printable ASCII character (ASCII code 33-126) except <code>''</code> (single quote), <code>"</code> (double quote), <code>\</code>, <code>/</code>, or <code>@</code>.</p> </li> </ul>'
schema:
type: string
maxLength: 2147483647
- name: ClusterParameterGroupName
in: query
required: false
description: '<p>The name of the cluster parameter group to apply to this cluster. This change is applied only after the cluster is rebooted. To reboot a cluster use <a>RebootCluster</a>. </p> <p>Default: Uses existing setting.</p> <p>Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.</p>'
schema:
type: string
maxLength: 2147483647
- name: AutomatedSnapshotRetentionPeriod
in: query
required: false
description: '<p>The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with <a>CreateClusterSnapshot</a>. </p> <p>If you decrease the automated snapshot retention period from its current value, existing automated snapshots that fall outside of the new retention period will be immediately deleted.</p> <p>You can''t disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.</p> <p>Default: Uses existing setting.</p> <p>Constraints: Must be a value from 0 to 35.</p>'
schema:
type: integer
- name: ManualSnapshotRetentionPeriod
in: query
required: false
description: <p>The default for number of days that a newly created manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. This value doesn't retroactively change the retention periods of existing manual snapshots.</p> <p>The value must be either -1 or an integer between 1 and 3,653.</p> <p>The default value is -1.</p>
schema:
type: integer
- name: PreferredMaintenanceWindow
in: query
required: false
description: '<p>The weekly time range (in UTC) during which system maintenance can occur, if necessary. If system maintenance is necessary during the window, it may result in an outage.</p> <p>This maintenance window change is made immediately. If the new maintenance window indicates the current time, there must be at least 120 minutes between the current time and end of the window in order to ensure that pending changes are applied.</p> <p>Default: Uses existing setting.</p> <p>Format: ddd:hh24:mi-ddd:hh24:mi, for example <code>wed:07:30-wed:08:00</code>.</p> <p>Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun</p> <p>Constraints: Must be at least 30 minutes.</p>'
schema:
type: string
maxLength: 2147483647
- name: ClusterVersion
in: query
required: false
description: '<p>The new version number of the Amazon Redshift engine to upgrade to.</p> <p>For major version upgrades, if a non-default cluster parameter group is currently in use, a new cluster parameter group in the cluster parameter group family for the new version must be specified. The new cluster parameter group can be the default for that cluster parameter group family. For more information about parameters and parameter groups, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p> <p>Example: <code>1.0</code> </p>'
schema:
type: string
maxLength: 2147483647
- name: AllowVersionUpgrade
in: query
required: false
description: '<p>If <code>true</code>, major version upgrades will be applied automatically to the cluster during the maintenance window. </p> <p>Default: <code>false</code> </p>'
schema:
type: boolean
- name: HsmClientCertificateIdentifier
in: query
required: false
description: Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
schema:
type: string
maxLength: 2147483647
- name: HsmConfigurationIdentifier
in: query
required: false
description: Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
schema:
type: string
maxLength: 2147483647
- name: NewClusterIdentifier
in: query
required: false
description: '<p>The new identifier for the cluster.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 alphanumeric characters or hyphens.</p> </li> <li> <p>Alphabetic characters must be lowercase.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> <li> <p>Must be unique for all clusters within an Amazon Web Services account.</p> </li> </ul> <p>Example: <code>examplecluster</code> </p>'
schema:
type: string
maxLength: 2147483647
- name: PubliclyAccessible
in: query
required: false
description: If <code>true</code>, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.
schema:
type: boolean
- name: ElasticIp
in: query
required: false
description: '<p>The Elastic IP (EIP) address for the cluster.</p> <p>Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms">Supported Platforms to Launch Your Cluster</a> in the Amazon Redshift Cluster Management Guide.</p>'
schema:
type: string
maxLength: 2147483647
- name: EnhancedVpcRouting
in: query
required: false
description: '<p>An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html">Enhanced VPC Routing</a> in the Amazon Redshift Cluster Management Guide.</p> <p>If this option is <code>true</code>, enhanced VPC routing is enabled. </p> <p>Default: false</p>'
schema:
type: boolean
- name: MaintenanceTrackName
in: query
required: false
description: The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the <code>PendingModifiedValues</code> for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied.
schema:
type: string
maxLength: 2147483647
- name: Encrypted
in: query
required: false
description: <p>Indicates whether the cluster is encrypted. If the value is encrypted (true) and you provide a value for the <code>KmsKeyId</code> parameter, we encrypt the cluster with the provided <code>KmsKeyId</code>. If you don't provide a <code>KmsKeyId</code>, we encrypt with the default key. </p> <p>If the value is not encrypted (false), then the cluster is decrypted. </p>
schema:
type: boolean
- name: KmsKeyId
in: query
required: false
description: The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
schema:
type: string
maxLength: 2147483647
- name: AvailabilityZoneRelocation
in: query
required: false
description: The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.
schema:
type: boolean
- name: AvailabilityZone
in: query
required: false
description: The option to initiate relocation for an Amazon Redshift cluster to the target Availability Zone.
schema:
type: string
maxLength: 2147483647
- name: Port
in: query
required: false
description: The option to change the port of an Amazon Redshift cluster.
schema:
type: integer
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyCluster
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2012-12-01'
summary: Amazon Redshift - G E T_ Modify Cluster
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#Action=ModifyCluster'
post:
x-aws-operation-name: ModifyCluster
operationId: POST_ModifyCluster
description: <p>Modifies the settings for a cluster.</p> <p>You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change.</p> <p>You can add another security or parameter group, or change the admin user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyClusterResult'
'480':
description: InvalidClusterStateFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidClusterStateFault'
'481':
description: InvalidClusterSecurityGroupStateFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidClusterSecurityGroupStateFault'
'482':
description: ClusterNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ClusterNotFoundFault'
'483':
description: NumberOfNodesQuotaExceededFault
content:
text/xml:
schema:
$ref: '#/components/schemas/NumberOfNodesQuotaExceededFault'
'484':
description: NumberOfNodesPerClusterLimitExceededFault
content:
text/xml:
schema:
$ref: '#/components/schemas/NumberOfNodesPerClusterLimitExceededFault'
'485':
description: ClusterSecurityGroupNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ClusterSecurityGroupNotFoundFault'
'486':
description: ClusterParameterGroupNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ClusterParameterGroupNotFoundFault'
'487':
description: InsufficientClusterCapacityFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InsufficientClusterCapacityFault'
'488':
description: UnsupportedOptionFault
content:
text/xml:
schema:
$ref: '#/components/schemas/UnsupportedOptionFault'
'489':
description: UnauthorizedOperation
content:
text/xml:
schema:
$ref: '#/components/schemas/UnauthorizedOperation'
'490':
description: HsmClientCertificateNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/HsmClientCertificateNotFoundFault'
'491':
description: HsmConfigurationNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/HsmConfigurationNotFoundFault'
'492':
description: ClusterAlreadyExistsFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ClusterAlreadyExistsFault'
'493':
description: LimitExceededFault
content:
text/xml:
schema:
$ref: '#/components/schemas/LimitExceededFault'
'494':
description: DependentServiceRequestThrottlingFault
content:
text/xml:
schema:
$ref: '#/components/schemas/DependentServiceRequestThrottlingFault'
'495':
description: InvalidElasticIpFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidElasticIpFault'
'496':
description: TableLimitExceededFault
content:
text/xml:
schema:
$ref: '#/components/schemas/TableLimitExceededFault'
'497':
description: InvalidClusterTrackFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidClusterTrackFault'
'498':
description: InvalidRetentionPeriodFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidRetentionPeriodFault'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyClusterMessage'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyCluster
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2012-12-01'
summary: Amazon Redshift - P O S T_ Modify Cluster
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#Action=ModifyCluster'
components:
schemas:
ScheduleState:
type: string
enum:
- MODIFYING
- ACTIVE
- FAILED
NetworkInterface:
type: object
properties:
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The network interface identifier. '
SubnetId:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The subnet identifier. '
PrivateIpAddress:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The IPv4 address of the network interface within the subnet. '
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The Availability Zone. '
description: 'Describes a network interface. '
HsmClientCertificateNotFoundFault: {}
PendingActionsList:
type: array
items:
$ref: '#/components/schemas/String'
ClusterParameterStatus:
type: object
properties:
ParameterName:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the parameter.
ParameterApplyStatus:
allOf:
- $ref: '#/components/schemas/String'
- description: '<p>The status of the parameter that indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when being applied.</p> <p>The following are possible statuses and descriptions.</p> <ul> <li> <p> <code>in-sync</code>: The parameter value is in sync with the database.</p> </li> <li> <p> <code>pending-reboot</code>: The parameter value will be applied after the cluster reboots.</p> </li> <li> <p> <code>applying</code>: The parameter value is being applied to the database.</p> </li> <li> <p> <code>invalid-parameter</code>: Cannot apply the parameter value because it has an invalid value or syntax.</p> </li> <li> <p> <code>apply-deferred</code>: The parameter contains static property changes. The changes are deferred until the cluster reboots.</p> </li> <li> <p> <code>apply-error</code>: Cannot connect to the cluster. The parameter change will be applied after the cluster reboots.</p> </li> <li> <p> <code>unknown-error</code>: Cannot apply the parameter change right now. The change will be applied after the cluster reboots.</p> </li> </ul>'
ParameterApplyErrorDescription:
allOf:
- $ref: '#/components/schemas/String'
- description: The error that prevented the parameter from being applied to the database.
description: Describes the status of a parameter group.
Tag:
type: object
properties:
Key:
allOf:
- $ref: '#/components/schemas/String'
- description: The key, or name, for the resource tag.
Value:
allOf:
- $ref: '#/components/schemas/String'
- description: The value for the resource tag.
description: A tag consisting of a name/value pair for a resource.
BooleanOptional:
type: boolean
ReservedNodeExchangeStatusType:
type: string
enum:
- REQUESTED
- PENDING
- IN_PROGRESS
- RETRYING
- SUCCEEDED
- FAILED
Double:
type: number
format: double
TStamp:
type: string
format: date-time
VpcEndpointsList:
type: array
items:
allOf:
- $ref: '#/components/schemas/VpcEndpoint'
- xml:
name: VpcEndpoint
InvalidElasticIpFault: {}
NumberOfNodesPerClusterLimitExceededFault: {}
Integer:
type: integer
ClusterSecurityGroupMembershipList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ClusterSecurityGroupMembership'
- xml:
name: ClusterSecurityGroup
AquaConfiguration:
type: object
properties:
AquaStatus:
allOf:
- $ref: '#/components/schemas/AquaStatus'
- description: This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaConfigurationStatus:
allOf:
- $ref: '#/components/schemas/AquaConfigurationStatus'
- description: This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
description: The operation that uses this structure is retired. Amazon Redshift automatically det
# --- truncated at 32 KB (77 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aws-redshift/refs/heads/main/openapi/aws-redshift-action-modifycluster-api-openapi.yml