openapi: 3.0.0 info: version: '2019-12-20' x-release: v4 title: 'Redshift Data API Service #Action=AcceptReservedNodeExchange #Action=AcceptReservedNodeExchange #Action=CreateCluster API' description:

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.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

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=CreateCluster' paths: /#Action=CreateCluster: 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: CreateCluster operationId: GET_CreateCluster description:

Creates a new cluster with the specified parameters.

To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateClusterResult' '480': description: ClusterAlreadyExistsFault content: text/xml: schema: $ref: '#/components/schemas/ClusterAlreadyExistsFault' '481': description: InsufficientClusterCapacityFault content: text/xml: schema: $ref: '#/components/schemas/InsufficientClusterCapacityFault' '482': description: ClusterParameterGroupNotFoundFault content: text/xml: schema: $ref: '#/components/schemas/ClusterParameterGroupNotFoundFault' '483': description: ClusterSecurityGroupNotFoundFault content: text/xml: schema: $ref: '#/components/schemas/ClusterSecurityGroupNotFoundFault' '484': description: ClusterQuotaExceededFault content: text/xml: schema: $ref: '#/components/schemas/ClusterQuotaExceededFault' '485': description: NumberOfNodesQuotaExceededFault content: text/xml: schema: $ref: '#/components/schemas/NumberOfNodesQuotaExceededFault' '486': description: NumberOfNodesPerClusterLimitExceededFault content: text/xml: schema: $ref: '#/components/schemas/NumberOfNodesPerClusterLimitExceededFault' '487': description: ClusterSubnetGroupNotFoundFault content: text/xml: schema: $ref: '#/components/schemas/ClusterSubnetGroupNotFoundFault' '488': description: InvalidVPCNetworkStateFault content: text/xml: schema: $ref: '#/components/schemas/InvalidVPCNetworkStateFault' '489': description: InvalidClusterSubnetGroupStateFault content: text/xml: schema: $ref: '#/components/schemas/InvalidClusterSubnetGroupStateFault' '490': description: InvalidSubnet content: text/xml: schema: $ref: '#/components/schemas/InvalidSubnet' '491': description: UnauthorizedOperation content: text/xml: schema: $ref: '#/components/schemas/UnauthorizedOperation' '492': description: HsmClientCertificateNotFoundFault content: text/xml: schema: $ref: '#/components/schemas/HsmClientCertificateNotFoundFault' '493': description: HsmConfigurationNotFoundFault content: text/xml: schema: $ref: '#/components/schemas/HsmConfigurationNotFoundFault' '494': description: InvalidElasticIpFault content: text/xml: schema: $ref: '#/components/schemas/InvalidElasticIpFault' '495': description: TagLimitExceededFault content: text/xml: schema: $ref: '#/components/schemas/TagLimitExceededFault' '496': description: InvalidTagFault content: text/xml: schema: $ref: '#/components/schemas/InvalidTagFault' '497': description: LimitExceededFault content: text/xml: schema: $ref: '#/components/schemas/LimitExceededFault' '498': description: DependentServiceRequestThrottlingFault content: text/xml: schema: $ref: '#/components/schemas/DependentServiceRequestThrottlingFault' '499': description: InvalidClusterTrackFault content: text/xml: schema: $ref: '#/components/schemas/InvalidClusterTrackFault' '500': description: SnapshotScheduleNotFoundFault content: text/xml: schema: $ref: '#/components/schemas/SnapshotScheduleNotFoundFault' '501': description: InvalidRetentionPeriodFault content: text/xml: schema: $ref: '#/components/schemas/InvalidRetentionPeriodFault' parameters: - name: DBName in: query required: false description: '

The name of the first database to be created when the cluster is created.

To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.

Default: dev

Constraints:

' schema: type: string maxLength: 2147483647 - name: ClusterIdentifier in: query required: true description: '

A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.

Constraints:

Example: myexamplecluster

' schema: type: string maxLength: 2147483647 - name: ClusterType in: query required: false description: '

The type of the cluster. When cluster type is specified as

Valid Values: multi-node | single-node

Default: multi-node

' schema: type: string maxLength: 2147483647 - name: NodeType in: query required: true description: '

The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.

Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.xlplus | ra3.4xlarge | ra3.16xlarge

' schema: type: string maxLength: 2147483647 - name: MasterUsername in: query required: true description:

The user name associated with the admin user for the cluster that is being created.

Constraints:

schema: type: string maxLength: 2147483647 - name: MasterUserPassword in: query required: true description:

The password associated with the admin user for the cluster that is being created.

Constraints:

schema: type: string maxLength: 2147483647 - name: ClusterSecurityGroups in: query required: false description: '

A list of security groups to be associated with this cluster.

Default: The default cluster security group for Amazon Redshift.

' 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.

Default: The default VPC security group is associated with the cluster.

' schema: type: array items: allOf: - $ref: '#/components/schemas/String' - xml: name: VpcSecurityGroupId - name: ClusterSubnetGroupName in: query required: false description:

The name of a cluster subnet group to be associated with this cluster.

If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).

schema: type: string maxLength: 2147483647 - name: AvailabilityZone in: query required: false description: '

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.

Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.

Example: us-east-2d

Constraint: The specified Availability Zone must be in the same region as the current endpoint.

' schema: type: string maxLength: 2147483647 - name: PreferredMaintenanceWindow in: query required: false description: '

The weekly time range (in UTC) during which automated cluster maintenance can occur.

Format: ddd:hh24:mi-ddd:hh24:mi

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Minimum 30-minute window.

' schema: type: string maxLength: 2147483647 - name: ClusterParameterGroupName in: query required: false description: '

The name of the parameter group to be associated with this cluster.

Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups

Constraints:

' schema: type: string maxLength: 2147483647 - name: AutomatedSnapshotRetentionPeriod in: query required: false description: '

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 CreateClusterSnapshot.

You can''t disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.

Default: 1

Constraints: Must be a value from 0 to 35.

' schema: type: integer - name: ManualSnapshotRetentionPeriod in: query required: false description:

The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

The value must be either -1 or an integer between 1 and 3,653.

schema: type: integer - name: Port in: query required: false description: '

The port number on which the cluster accepts incoming connections.

The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections.

Default: 5439

Valid Values: 1150-65535

' schema: type: integer - name: ClusterVersion in: query required: false description: '

The version of the Amazon Redshift engine software that you want to deploy on the cluster.

The version selected runs on all the nodes in the cluster.

Constraints: Only version 1.0 is currently available.

Example: 1.0

' schema: type: string maxLength: 2147483647 - name: AllowVersionUpgrade in: query required: false description: '

If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.

Default: true

' schema: type: boolean - name: NumberOfNodes in: query required: false description: '

The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.

For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.

If you don''t specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.

Default: 1

Constraints: Value must be at least 1 and no more than 100.

' schema: type: integer - name: PubliclyAccessible in: query required: false description: 'If true, the cluster can be accessed from a public network. ' schema: type: boolean - name: Encrypted in: query required: false description: '

If true, the data in the cluster is encrypted at rest.

Default: false

' 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: ElasticIp in: query required: false description: '

The Elastic IP (EIP) address for the cluster.

Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. Don''t specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.

' schema: type: string maxLength: 2147483647 - name: Tags in: query required: false description: A list of tag instances. schema: type: array items: allOf: - $ref: '#/components/schemas/Tag' - xml: name: Tag - 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: EnhancedVpcRouting in: query required: false description: '

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 Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

If this option is true, enhanced VPC routing is enabled.

Default: false

' schema: type: boolean - name: AdditionalInfo in: query required: false description: Reserved. schema: type: string maxLength: 2147483647 - name: IamRoles in: query required: false description:

A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format.

The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.

schema: type: array items: allOf: - $ref: '#/components/schemas/String' - xml: name: IamRoleArn - name: MaintenanceTrackName in: query required: false description: An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the current track. schema: type: string maxLength: 2147483647 - name: SnapshotScheduleIdentifier in: query required: false description: A unique identifier for the snapshot schedule. 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 is created. schema: type: boolean - name: AquaConfigurationStatus in: query required: false description: This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator). schema: type: string enum: - enabled - disabled - auto - name: DefaultIamRoleArn in: query required: false description: 'The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created. ' schema: type: string maxLength: 2147483647 - name: LoadSampleData in: query required: false description: A flag that specifies whether to load sample data once the cluster is created. schema: type: string maxLength: 2147483647 - name: Action in: query required: true schema: type: string enum: - CreateCluster - name: Version in: query required: true schema: type: string enum: - '2012-12-01' summary: Amazon Redshift - G E T_ Create Cluster x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - '#Action=CreateCluster' post: x-aws-operation-name: CreateCluster operationId: POST_CreateCluster description:

Creates a new cluster with the specified parameters.

To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateClusterResult' '480': description: ClusterAlreadyExistsFault content: text/xml: schema: $ref: '#/components/schemas/ClusterAlreadyExistsFault' '481': description: InsufficientClusterCapacityFault content: text/xml: schema: $ref: '#/components/schemas/InsufficientClusterCapacityFault' '482': description: ClusterParameterGroupNotFoundFault content: text/xml: schema: $ref: '#/components/schemas/ClusterParameterGroupNotFoundFault' '483': description: ClusterSecurityGroupNotFoundFault content: text/xml: schema: $ref: '#/components/schemas/ClusterSecurityGroupNotFoundFault' '484': description: ClusterQuotaExceededFault content: text/xml: schema: $ref: '#/components/schemas/ClusterQuotaExceededFault' '485': description: NumberOfNodesQuotaExceededFault content: text/xml: schema: $ref: '#/components/schemas/NumberOfNodesQuotaExceededFault' '486': description: NumberOfNodesPerClusterLimitExceededFault content: text/xml: schema: $ref: '#/components/schemas/NumberOfNodesPerClusterLimitExceededFault' '487': description: ClusterSubnetGroupNotFoundFault content: text/xml: schema: $ref: '#/components/schemas/ClusterSubnetGroupNotFoundFault' '488': description: InvalidVPCNetworkStateFault content: text/xml: schema: $ref: '#/components/schemas/InvalidVPCNetworkStateFault' '489': description: InvalidClusterSubnetGroupStateFault content: text/xml: schema: $ref: '#/components/schemas/InvalidClusterSubnetGroupStateFault' '490': description: InvalidSubnet content: text/xml: schema: $ref: '#/components/schemas/InvalidSubnet' '491': description: UnauthorizedOperation content: text/xml: schema: $ref: '#/components/schemas/UnauthorizedOperation' '492': description: HsmClientCertificateNotFoundFault content: text/xml: schema: $ref: '#/components/schemas/HsmClientCertificateNotFoundFault' '493': description: HsmConfigurationNotFoundFault content: text/xml: schema: $ref: '#/components/schemas/HsmConfigurationNotFoundFault' '494': description: InvalidElasticIpFault content: text/xml: schema: $ref: '#/components/schemas/InvalidElasticIpFault' '495': description: TagLimitExceededFault content: text/xml: schema: $ref: '#/components/schemas/TagLimitExceededFault' '496': description: InvalidTagFault content: text/xml: schema: $ref: '#/components/schemas/InvalidTagFault' '497': description: LimitExceededFault content: text/xml: schema: $ref: '#/components/schemas/LimitExceededFault' '498': description: DependentServiceRequestThrottlingFault content: text/xml: schema: $ref: '#/components/schemas/DependentServiceRequestThrottlingFault' '499': description: InvalidClusterTrackFault content: text/xml: schema: $ref: '#/components/schemas/InvalidClusterTrackFault' '500': description: SnapshotScheduleNotFoundFault content: text/xml: schema: $ref: '#/components/schemas/SnapshotScheduleNotFoundFault' '501': description: InvalidRetentionPeriodFault content: text/xml: schema: $ref: '#/components/schemas/InvalidRetentionPeriodFault' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateClusterMessage' parameters: - name: Action in: query required: true schema: type: string enum: - CreateCluster - name: Version in: query required: true schema: type: string enum: - '2012-12-01' summary: Amazon Redshift - P O S T_ Create Cluster x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - '#Action=CreateCluster' components: schemas: 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: '

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.

The following are possible statuses and descriptions.

' 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. Double: type: number format: double DeferredMaintenanceWindowsList: type: array items: allOf: - $ref: '#/components/schemas/DeferredMaintenanceWindow' - xml: name: DeferredMaintenanceWindow SnapshotScheduleNotFoundFault: {} RestoreStatus: type: object properties: Status: allOf: - $ref: '#/components/schemas/String' - description: The status of the restore action. Returns starting, restoring, completed, or failed. CurrentRestoreRateInMegaBytesPerSecond: allOf: - $ref: '#/components/schemas/Double' - description: 'The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 and DS2 node types. ' SnapshotSizeInMegaBytes: allOf: - $ref: '#/components/schemas/Long' - description: 'The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types. ' ProgressInMegaBytes: allOf: - $ref: '#/components/schemas/Long' - description: 'The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types. ' ElapsedTimeInSeconds: allOf: - $ref: '#/components/schemas/Long' - description: 'The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 and DS2 node types. ' EstimatedTimeToCompletionInSeconds: allOf: - $ref: '#/components/schemas/Long' - description: 'The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types. ' description: Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot. ClusterParameterGroupNotFoundFault: {} VpcEndpoint: type: object properties: VpcEndpointId: allOf: - $ref: '#/components/schemas/String' - description: The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy. VpcId: allOf: - $ref: '#/components/schemas/String' - description: 'The VPC identifier that the endpoint is associated. ' NetworkInterfaces: allOf: - $ref: '#/components/schemas/NetworkInterfaceList' - description: 'One or more network interfaces of the endpoint. Also known as an interface endpoint. ' description: The connection endpoint for connecting to an Amazon Redshift cluster through the proxy. ClusterNode: type: object properties: NodeRole: allOf: - $ref: '#/components/schemas/String' - description: Whether the node is a leader node or a compute node. PrivateIPAddress: allOf: - $ref: '#/components/schemas/String' - description: The private IP address of a node within a cluster. PublicIPAddress: allOf: - $ref: '#/components/schemas/String' - description: The public IP address of a node within a cluster. description: The identifier of a node in a cluster. PendingModifiedValues: type: object properties: MasterUserPassword: allOf: - $ref: '#/components/schemas/String' - description: The pending or in-progress change of the admin user password for the cluster. NodeType: allOf: - $ref: '#/components/schemas/String' - description: The pending or in-progress change of the cluster's node type. NumberOfNodes: allOf: - $ref: '#/components/schemas/IntegerOptional' - description: The pending or in-progress change of the number of nodes in the cluster. ClusterType: allOf: - $ref: '#/components/schemas/String' - description: The pending or in-progress change of the cluster type. ClusterVersion: allOf: - $ref: '#/components/schemas/String' - description: The pending or in-progress change of the service version. AutomatedSnapshotRetentionPeriod: allOf: - $ref: '#/components/schemas/IntegerOptional' - description: The pending or in-progress change of the automated snapshot retention period. ClusterIdentifier: allOf: - $ref: '#/components/schemas/String' - description: The pending or in-progress change of the new identifier for the cluster. PubliclyAccessible: allOf: - $ref: '#/components/schemas/BooleanOptional' - description: The pending or in-progress change of the ability to connect to the cluster from the public network. EnhancedVpcRouting: allOf: - $ref: '#/components/schemas/BooleanOptional' - description: '

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 Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

If this option is true, enhanced VPC routing is enabled.

Default: false

' MaintenanceTrackName: allOf: - $ref: '#/components/schemas/String' - description: The name of the maintenance track that the cluster will change to during the next maintenance window. EncryptionType: allOf: - $ref: '#/components/schemas/String' - description: 'The encryption type for a cluster. Possible values are: KMS and None. ' description: Describes cluster attributes that are in a pending state. A change to one or more the attributes was requested and is in progress or will be applied. ElasticIpStatus: type: object properties: ElasticIp: allOf: - $ref: '#/components/schemas/String' - description: The elastic IP (EIP) address for the cluster. Status: allOf: - $ref: '#/components/schemas/String' - description: The status of the elastic IP (EIP) address. description: Describes the status of the elastic IP (EIP) address. VpcSecurityGroupMembershipList: type: array items: allOf: - $ref: '#/components/schemas/VpcSecurityGroupMembership' - xml: name: VpcSecurityGroup Long: type: integer LimitExceededFault: {} CreateClusterResult: type: object properties: Cluster: $ref: '#/components/schemas/Cluster' BooleanOptional: type: boolean InvalidElasticIpFault: {} Integer: type: integer ClusterSecurityGroupMembershipList: type: array items: allOf: - $ref: '#/components/schemas/ClusterSecurityGroupMembership' - xml: name: ClusterSecurityGroup InsufficientClusterCapacityFault: {} String: type: string maxLength: 2147483647 ClusterSecurityGroupMembership: type: object properties: ClusterSecurityGroupName: allOf: - $ref: '#/components/schemas/String' - description: The name of the cluster security group. Status: allOf: - $ref: '#/components/schemas/String' - description: The status of the cluster security group. description: Describes a cluster security group. HsmConfigurationNotFoundFault: {} VpcSecurityGroupIdList: type: array items: allOf: - $ref: '#/components/schemas/String' - xml: name: VpcSecurityGroupId Endpoint: type: object properties: Address: allOf: - $ref: '#/components/schemas/String' - description: The DNS address of the Cluster. Port: allOf: - $ref: '#/components/schemas/Integer' - description: The port that the database engine is listening on. VpcEndpoints: allOf: - $ref: '#/components/schemas/VpcEndpointsList' - description: Describes a connection endpoint. description: Describes a connection endpoint. AquaStatus: type: string enum: - enabled - disabled - applying NumberOfNodesQuotaExceededFault: {} ClusterIamRole: type: object properties: IamRoleArn: allOf: - $ref: '#/components/schemas/String' - description: 'The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload. ' ApplyStatus: allOf: - $ref: '#/components/schemas/String' - description: '

A value that describes the status of the IAM role''s association with an Amazon Redshift cluster.

The following are possible statuses and descriptions.

' description: An Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other Amazon Web Services services. ClusterSnapshotCopyStatus: type: object properties: DestinationRegion: allOf: - $ref: '#/components/schemas/String' - description: The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled. RetentionPeriod: allOf: - $ref: '#/components/schemas/Long' - description: The number of days that automated snapshots are retained in the destination region after they are copied from a source region. ManualSnapshotRetentionPeriod: allOf: - $ref: '#/components/schemas/Integer' - description:

The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.

The value must be either -1 or an integer between 1 and 3,653.

SnapshotCopyGrantName: allOf: - $ref: '#/components/schemas/String' - description: The name of the snapshot copy grant. description: Returns the destination region and retention period that are configured for cross-region snapshot copy. ClusterNodesList: type: array items: $ref: '#/components/schemas/ClusterNode' DependentServiceRequestThrottlingFault: {} ClusterQuotaExceededFault: {} VpcSecurityGroupMembership: type: object properties: VpcSecurityGroupId: allOf: - $ref: '#/components/schemas/String' - description: The identifier of the VPC security group. Status: allOf: - $ref: '#/components/schemas/String' - description: The status of the VPC security group. description: Describes the members of a VPC security group. ClusterParameterStatusList: type: array items: $ref: '#/components/schemas/ClusterParameterStatus' CreateClusterMessage: type: object required: - ClusterIdentifier - NodeType - MasterUsername - MasterUserPassword title: CreateClusterMessage properties: DBName: allOf: - $ref: '#/components/schemas/String' - description: '

The name of the first database to be created when the cluster is created.

To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.

Default: dev

Constraints:

' ClusterIdentifier: allOf: - $ref: '#/components/schemas/String' - description: '

A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.

Constraints:

Example: myexamplecluster

' ClusterType: allOf: - $ref: '#/components/schemas/String' - description: '

The type of the cluster. When cluster type is specified as

Valid Values: multi-node | single-node

Default: multi-node

' NodeType: allOf: - $ref: '#/components/schemas/String' - description: '

The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.

Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.xlplus | ra3.4xlarge | ra3.16xlarge

' MasterUsername: allOf: - $ref: '#/components/schemas/String' - description:

The user name associated with the admin user for the cluster that is being created.

Constraints:

MasterUserPassword: allOf: - $ref: '#/components/schemas/String' - description:

The password associated with the admin user for the cluster that is being created.

Constraints:

ClusterSecurityGroups: allOf: - $ref: '#/components/schemas/ClusterSecurityGroupNameList' - description: '

A list of security groups to be associated with this cluster.

Default: The default cluster security group for Amazon Redshift.

' VpcSecurityGroupIds: allOf: - $ref: '#/components/schemas/VpcSecurityGroupIdList' - description: '

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

Default: The default VPC security group is associated with the cluster.

' ClusterSubnetGroupName: allOf: - $ref: '#/components/schemas/String' - description:

The name of a cluster subnet group to be associated with this cluster.

If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).

AvailabilityZone: allOf: - $ref: '#/components/schemas/String' - description: '

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.

Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.

Example: us-east-2d

Constraint: The specified Availability Zone must be in the same region as the current endpoint.

' PreferredMaintenanceWindow: allOf: - $ref: '#/components/schemas/String' - description: '

The weekly time range (in UTC) during which automated cluster maintenance can occur.

Format: ddd:hh24:mi-ddd:hh24:mi

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Minimum 30-minute window.

' ClusterParameterGroupName: allOf: - $ref: '#/components/schemas/String' - description: '

The name of the parameter group to be associated with this cluster.

Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups

Constraints:

' AutomatedSnapshotRetentionPeriod: allOf: - $ref: '#/components/schemas/IntegerOptional' - description: '

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 CreateClusterSnapshot.

You can''t disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.

Default: 1

Constraints: Must be a value from 0 to 35.

' ManualSnapshotRetentionPeriod: allOf: - $ref: '#/components/schemas/IntegerOptional' - description:

The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

The value must be either -1 or an integer between 1 and 3,653.

Port: allOf: - $ref: '#/components/schemas/IntegerOptional' - description: '

The port number on which the cluster accepts incoming connections.

The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections.

Default: 5439

Valid Values: 1150-65535

' ClusterVersion: allOf: - $ref: '#/components/schemas/String' - description: '

The version of the Amazon Redshift engine software that you want to deploy on the cluster.

The version selected runs on all the nodes in the cluster.

Constraints: Only version 1.0 is currently available.

Example: 1.0

' AllowVersionUpgrade: allOf: - $ref: '#/components/schemas/BooleanOptional' - description: '

If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.

Default: true

' NumberOfNodes: allOf: - $ref: '#/components/schemas/IntegerOptional' - description: '

The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.

For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.

If you don''t specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.

Default: 1

Constraints: Value must be at least 1 and no more than 100.

' PubliclyAccessible: allOf: - $ref: '#/components/schemas/BooleanOptional' - description: 'If true, the cluster can be accessed from a public network. ' Encrypted: allOf: - $ref: '#/components/schemas/BooleanOptional' - description: '

If true, the data in the cluster is encrypted at rest.

Default: false

' HsmClientCertificateIdentifier: allOf: - $ref: '#/components/schemas/String' - description: Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM. HsmConfigurationIdentifier: allOf: - $ref: '#/components/schemas/String' - 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. ElasticIp: allOf: - $ref: '#/components/schemas/String' - description: '

The Elastic IP (EIP) address for the cluster.

Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. Don''t specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.

' Tags: allOf: - $ref: '#/components/schemas/TagList' - description: A list of tag instances. KmsKeyId: allOf: - $ref: '#/components/schemas/String' - description: The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. EnhancedVpcRouting: allOf: - $ref: '#/components/schemas/BooleanOptional' - description: '

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 Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

If this option is true, enhanced VPC routing is enabled.

Default: false

' AdditionalInfo: allOf: - $ref: '#/components/schemas/String' - description: Reserved. IamRoles: allOf: - $ref: '#/components/schemas/IamRoleArnList' - description:

A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format.

The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.

MaintenanceTrackName: allOf: - $ref: '#/components/schemas/String' - description: An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the current track. SnapshotScheduleIdentifier: allOf: - $ref: '#/components/schemas/String' - description: A unique identifier for the snapshot schedule. AvailabilityZoneRelocation: allOf: - $ref: '#/components/schemas/BooleanOptional' - description: The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created. AquaConfigurationStatus: allOf: - $ref: '#/components/schemas/AquaConfigurationStatus' - description: This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator). DefaultIamRoleArn: allOf: - $ref: '#/components/schemas/String' - description: 'The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created. ' LoadSampleData: allOf: - $ref: '#/components/schemas/String' - description: A flag that specifies whether to load sample data once the cluster is created. description:

ScheduleState: type: string enum: - MODIFYING - ACTIVE - FAILED 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. ReservedNodeExchangeStatusType: type: string enum: - REQUESTED - PENDING - IN_PROGRESS - RETRYING - SUCCEEDED - FAILED InvalidTagFault: {} NumberOfNodesPerClusterLimitExceededFault: {} 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 determines whether to use AQUA (Advanced Query Accelerator). TagList: type: array items: allOf: - $ref: '#/components/schemas/Tag' - xml: name: Tag AquaConfigurationStatus: type: string enum: - enabled - disabled - auto DoubleOptional: type: number format: double ClusterAlreadyExistsFault: {} ResizeInfo: type: object properties: ResizeType: allOf: - $ref: '#/components/schemas/String' - description: Returns the value ClassicResize. AllowCancelResize: allOf: - $ref: '#/components/schemas/Boolean' - description: A boolean value indicating if the resize operation can be cancelled. description: Describes a resize operation. InvalidVPCNetworkStateFault: {} Cluster: type: object properties: ClusterIdentifier: allOf: - $ref: '#/components/schemas/String' - description: The unique identifier of the cluster. NodeType: allOf: - $ref: '#/components/schemas/String' - description: The node type for the nodes in the cluster. ClusterStatus: allOf: - $ref: '#/components/schemas/String' - description:

The current state of the cluster. Possible values are the following:

ClusterAvailabilityStatus: allOf: - $ref: '#/components/schemas/String' - description:

The availability status of the cluster for queries. Possible values are the following:

ModifyStatus: allOf: - $ref: '#/components/schemas/String' - description: The status of a modify operation, if any, initiated for the cluster. MasterUsername: allOf: - $ref: '#/components/schemas/String' - description: 'The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter. ' DBName: allOf: - $ref: '#/components/schemas/String' - description: 'The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default. ' Endpoint: allOf: - $ref: '#/components/schemas/Endpoint' - description: The connection endpoint. ClusterCreateTime: allOf: - $ref: '#/components/schemas/TStamp' - description: The date and time that the cluster was created. AutomatedSnapshotRetentionPeriod: allOf: - $ref: '#/components/schemas/Integer' - description: The number of days that automatic cluster snapshots are retained. ManualSnapshotRetentionPeriod: allOf: - $ref: '#/components/schemas/Integer' - description:

The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

The value must be either -1 or an integer between 1 and 3,653.

ClusterSecurityGroups: allOf: - $ref: '#/components/schemas/ClusterSecurityGroupMembershipList' - description:

A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.

Cluster security groups are used when the cluster is not created in an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.

VpcSecurityGroups: allOf: - $ref: '#/components/schemas/VpcSecurityGroupMembershipList' - description: A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC. ClusterParameterGroups: allOf: - $ref: '#/components/schemas/ClusterParameterGroupStatusList' - description: The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status. ClusterSubnetGroupName: allOf: - $ref: '#/components/schemas/String' - description: The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC. VpcId: allOf: - $ref: '#/components/schemas/String' - description: The identifier of the VPC the cluster is in, if the cluster is in a VPC. AvailabilityZone: allOf: - $ref: '#/components/schemas/String' - description: The name of the Availability Zone in which the cluster is located. PreferredMaintenanceWindow: allOf: - $ref: '#/components/schemas/String' - description: The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur. PendingModifiedValues: allOf: - $ref: '#/components/schemas/PendingModifiedValues' - description: A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements. ClusterVersion: allOf: - $ref: '#/components/schemas/String' - description: The version ID of the Amazon Redshift engine that is running on the cluster. AllowVersionUpgrade: allOf: - $ref: '#/components/schemas/Boolean' - description: 'A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window. ' NumberOfNodes: allOf: - $ref: '#/components/schemas/Integer' - description: The number of compute nodes in the cluster. PubliclyAccessible: allOf: - $ref: '#/components/schemas/Boolean' - description: A boolean value that, if true, indicates that the cluster can be accessed from a public network. Encrypted: allOf: - $ref: '#/components/schemas/Boolean' - description: A boolean value that, if true, indicates that data in the cluster is encrypted at rest. RestoreStatus: allOf: - $ref: '#/components/schemas/RestoreStatus' - description: A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot. DataTransferProgress: allOf: - $ref: '#/components/schemas/DataTransferProgress' - description:

HsmStatus: allOf: - $ref: '#/components/schemas/HsmStatus' - description: '

A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (HSM) settings changes specified in a modify cluster command.

Values: active, applying

' ClusterSnapshotCopyStatus: allOf: - $ref: '#/components/schemas/ClusterSnapshotCopyStatus' - description: A value that returns the destination region and retention period that are configured for cross-region snapshot copy. ClusterPublicKey: allOf: - $ref: '#/components/schemas/String' - description: The public key for the cluster. ClusterNodes: allOf: - $ref: '#/components/schemas/ClusterNodesList' - description: The nodes in the cluster. ElasticIpStatus: allOf: - $ref: '#/components/schemas/ElasticIpStatus' - description: The status of the elastic IP (EIP) address. ClusterRevisionNumber: allOf: - $ref: '#/components/schemas/String' - description: The specific revision number of the database in the cluster. Tags: allOf: - $ref: '#/components/schemas/TagList' - description: The list of tags for the cluster. KmsKeyId: allOf: - $ref: '#/components/schemas/String' - description: The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster. EnhancedVpcRouting: allOf: - $ref: '#/components/schemas/Boolean' - description: '

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 Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

If this option is true, enhanced VPC routing is enabled.

Default: false

' IamRoles: allOf: - $ref: '#/components/schemas/ClusterIamRoleList' - description: A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. PendingActions: allOf: - $ref: '#/components/schemas/PendingActionsList' - description: Cluster operations that are waiting to be started. MaintenanceTrackName: allOf: - $ref: '#/components/schemas/String' - description: The name of the maintenance track for the cluster. ElasticResizeNumberOfNodeOptions: allOf: - $ref: '#/components/schemas/String' - description: 'The number of nodes that you can resize the cluster to with the elastic resize method. ' DeferredMaintenanceWindows: allOf: - $ref: '#/components/schemas/DeferredMaintenanceWindowsList' - description: Describes a group of DeferredMaintenanceWindow objects. SnapshotScheduleIdentifier: allOf: - $ref: '#/components/schemas/String' - description: A unique identifier for the cluster snapshot schedule. SnapshotScheduleState: allOf: - $ref: '#/components/schemas/ScheduleState' - description: The current state of the cluster snapshot schedule. ExpectedNextSnapshotScheduleTime: allOf: - $ref: '#/components/schemas/TStamp' - description: 'The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled. ' ExpectedNextSnapshotScheduleTimeStatus: allOf: - $ref: '#/components/schemas/String' - description:

The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:

NextMaintenanceWindowStartTime: allOf: - $ref: '#/components/schemas/TStamp' - description: The date and time in UTC when system maintenance can begin. ResizeInfo: allOf: - $ref: '#/components/schemas/ResizeInfo' - description: '

Returns the following:

' AvailabilityZoneRelocationStatus: allOf: - $ref: '#/components/schemas/String' - description: Describes the status of the Availability Zone relocation operation. ClusterNamespaceArn: allOf: - $ref: '#/components/schemas/String' - description: The namespace Amazon Resource Name (ARN) of the cluster. TotalStorageCapacityInMegaBytes: allOf: - $ref: '#/components/schemas/LongOptional' - description: 'The total storage capacity of the cluster in megabytes. ' AquaConfiguration: allOf: - $ref: '#/components/schemas/AquaConfiguration' - description: This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator). DefaultIamRoleArn: allOf: - $ref: '#/components/schemas/String' - description: The Amazon Resource Name (ARN) for the IAM role set as default for the cluster. ReservedNodeExchangeStatus: allOf: - $ref: '#/components/schemas/ReservedNodeExchangeStatus' - description: The status of the reserved-node exchange request. Statuses include in-progress and requested. description: Describes a cluster. ClusterIamRoleList: type: array items: allOf: - $ref: '#/components/schemas/ClusterIamRole' - xml: name: ClusterIamRole IntegerOptional: type: integer InvalidRetentionPeriodFault: {} DataTransferProgress: type: object properties: Status: allOf: - $ref: '#/components/schemas/String' - description: Describes the status of the cluster. While the transfer is in progress the status is transferringdata. CurrentRateInMegaBytesPerSecond: allOf: - $ref: '#/components/schemas/DoubleOptional' - description: Describes the data transfer rate in MB's per second. TotalDataInMegaBytes: allOf: - $ref: '#/components/schemas/Long' - description: Describes the total amount of data to be transfered in megabytes. DataTransferredInMegaBytes: allOf: - $ref: '#/components/schemas/Long' - description: Describes the total amount of data that has been transfered in MB's. EstimatedTimeToCompletionInSeconds: allOf: - $ref: '#/components/schemas/LongOptional' - description: Describes the estimated number of seconds remaining to complete the transfer. ElapsedTimeInSeconds: allOf: - $ref: '#/components/schemas/LongOptional' - description: Describes the number of seconds that have elapsed during the data transfer. description: Describes the status of a cluster while it is in the process of resizing with an incremental resize. TStamp: type: string format: date-time VpcEndpointsList: type: array items: allOf: - $ref: '#/components/schemas/VpcEndpoint' - xml: name: VpcEndpoint UnauthorizedOperation: {} HsmStatus: type: object properties: HsmClientCertificateIdentifier: allOf: - $ref: '#/components/schemas/String' - description: Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM. HsmConfigurationIdentifier: allOf: - $ref: '#/components/schemas/String' - 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. Status: allOf: - $ref: '#/components/schemas/String' - description: '

Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.

Values: active, applying

' description: Describes the status of changes to HSM settings. ReservedNodeExchangeStatus: type: object properties: ReservedNodeExchangeRequestId: allOf: - $ref: '#/components/schemas/String' - description: The identifier of the reserved-node exchange request. Status: allOf: - $ref: '#/components/schemas/ReservedNodeExchangeStatusType' - description: The status of the reserved-node exchange request. Statuses include in-progress and requested. RequestTime: allOf: - $ref: '#/components/schemas/TStamp' - description: A date and time that indicate when the reserved-node exchange was requested. SourceReservedNodeId: allOf: - $ref: '#/components/schemas/String' - description: The identifier of the source reserved node. SourceReservedNodeType: allOf: - $ref: '#/components/schemas/String' - description: The source reserved-node type, for example ds2.xlarge. SourceReservedNodeCount: allOf: - $ref: '#/components/schemas/Integer' - description: The source reserved-node count in the cluster. TargetReservedNodeOfferingId: allOf: - $ref: '#/components/schemas/String' - description: The identifier of the target reserved node offering. TargetReservedNodeType: allOf: - $ref: '#/components/schemas/String' - description: The node type of the target reserved node, for example ra3.4xlarge. TargetReservedNodeCount: allOf: - $ref: '#/components/schemas/Integer' - description: The count of target reserved nodes in the cluster. description: 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. InvalidClusterSubnetGroupStateFault: {} ClusterSecurityGroupNameList: type: array items: allOf: - $ref: '#/components/schemas/String' - xml: name: ClusterSecurityGroupName ClusterParameterGroupStatusList: type: array items: allOf: - $ref: '#/components/schemas/ClusterParameterGroupStatus' - xml: name: ClusterParameterGroup ClusterSubnetGroupNotFoundFault: {} ClusterSecurityGroupNotFoundFault: {} NetworkInterfaceList: type: array items: allOf: - $ref: '#/components/schemas/NetworkInterface' - xml: name: NetworkInterface InvalidSubnet: {} IamRoleArnList: type: array items: allOf: - $ref: '#/components/schemas/String' - xml: name: IamRoleArn InvalidClusterTrackFault: {} Boolean: type: boolean TagLimitExceededFault: {} LongOptional: type: integer DeferredMaintenanceWindow: type: object properties: DeferMaintenanceIdentifier: allOf: - $ref: '#/components/schemas/String' - description: A unique identifier for the maintenance window. DeferMaintenanceStartTime: allOf: - $ref: '#/components/schemas/TStamp' - description: ' A timestamp for the beginning of the time period when we defer maintenance.' DeferMaintenanceEndTime: allOf: - $ref: '#/components/schemas/TStamp' - description: ' A timestamp for the end of the time period when we defer maintenance.' description: Describes a deferred maintenance window ClusterParameterGroupStatus: type: object properties: ParameterGroupName: allOf: - $ref: '#/components/schemas/String' - description: The name of the cluster parameter group. ParameterApplyStatus: allOf: - $ref: '#/components/schemas/String' - description: The status of parameter updates. ClusterParameterStatusList: allOf: - $ref: '#/components/schemas/ClusterParameterStatusList' - description:

The list of parameter statuses.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

description: Describes the status of a parameter group. parameters: X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/redshift-data/ x-hasEquivalentPaths: true