String clusterSecurityGroupName
The name of the security group to which the ingress rule is added.
String cIDRIP
The IP range to be added the Amazon Redshift security group.
String eC2SecurityGroupName
The EC2 security group to be added the Amazon Redshift security group.
String eC2SecurityGroupOwnerId
The AWS account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value.
Example: 111122223333
String snapshotIdentifier
The identifier of the snapshot the account is authorized to restore.
String snapshotClusterIdentifier
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.
String accountWithRestoreAccess
The identifier of the AWS customer account authorized to restore the specified snapshot.
To share a snapshot with AWS support, specify amazon-redshift-support.
String name
The name of the availability zone.
SdkInternalList<T> supportedPlatforms
String clusterIdentifier
The unique identifier of the cluster.
String nodeType
The node type for the nodes in the cluster.
String clusterStatus
The current state of the cluster. Possible values are the following:
available
creating
deleting
final-snapshot
hardware-failure
incompatible-hsm
incompatible-network
incompatible-parameters
incompatible-restore
modifying
rebooting
renaming
resizing
rotating-keys
storage-full
updating-hsm
String modifyStatus
The status of a modify operation, if any, initiated for the cluster.
String masterUsername
The master user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
String dBName
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 endpoint
The connection endpoint.
Date clusterCreateTime
The date and time that the cluster was created.
Integer automatedSnapshotRetentionPeriod
The number of days that automatic cluster snapshots are retained.
SdkInternalList<T> clusterSecurityGroups
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.
SdkInternalList<T> vpcSecurityGroups
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.
SdkInternalList<T> clusterParameterGroups
The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
String clusterSubnetGroupName
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
String vpcId
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
String availabilityZone
The name of the Availability Zone in which the cluster is located.
String preferredMaintenanceWindow
The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
PendingModifiedValues pendingModifiedValues
A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
String clusterVersion
The version ID of the Amazon Redshift engine that is running on the cluster.
Boolean allowVersionUpgrade
A Boolean value that, if true, indicates that major version upgrades will be applied automatically
to the cluster during the maintenance window.
Integer numberOfNodes
The number of compute nodes in the cluster.
Boolean publiclyAccessible
A Boolean value that, if true, indicates that the cluster can be accessed from a public network.
Boolean encrypted
A Boolean value that, if true, indicates that data in the cluster is encrypted at rest.
RestoreStatus restoreStatus
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.
HsmStatus hsmStatus
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 clusterSnapshotCopyStatus
A value that returns the destination region and retention period that are configured for cross-region snapshot copy.
String clusterPublicKey
The public key for the cluster.
SdkInternalList<T> clusterNodes
The nodes in the cluster.
ElasticIpStatus elasticIpStatus
The status of the elastic IP (EIP) address.
String clusterRevisionNumber
The specific revision number of the database in the cluster.
SdkInternalList<T> tags
The list of tags for the cluster.
String kmsKeyId
The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster.
Boolean enhancedVpcRouting
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
SdkInternalList<T> iamRoles
A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
SdkInternalList<T> pendingActions
Cluster operations that are waiting to be started.
String clusterIdentifier
The unique identifier of the cluster.
String currentDatabaseRevision
A string representing the current cluster version.
Date databaseRevisionReleaseDate
The date on which the database revision was released.
SdkInternalList<T> revisionTargets
A list of RevisionTarget objects, where each object describes the database revision that a cluster
can be updated to.
String iamRoleArn
The Amazon Resource Name (ARN) of the IAM role, for example,
arn:aws:iam::123456789012:role/RedshiftCopyUnload.
String applyStatus
A value that describes the status of the IAM role's association with an Amazon Redshift cluster.
The following are possible statuses and descriptions.
in-sync: The role is available for use by the cluster.
adding: The role is in the process of being associated with the cluster.
removing: The role is in the process of being disassociated with the cluster.
String parameterGroupName
The name of the cluster parameter group.
String parameterGroupFamily
The name of the cluster parameter group family that this cluster parameter group is compatible with.
String description
The description of the parameter group.
SdkInternalList<T> tags
The list of tags for the cluster parameter group.
String parameterGroupName
The name of the cluster parameter group.
String parameterApplyStatus
The status of parameter updates.
SdkInternalList<T> clusterParameterStatusList
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.
String parameterName
The name of the parameter.
String parameterApplyStatus
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.
in-sync: The parameter value is in sync with the database.
pending-reboot: The parameter value will be applied after the cluster reboots.
applying: The parameter value is being applied to the database.
invalid-parameter: Cannot apply the parameter value because it has an invalid value or syntax.
apply-deferred: The parameter contains static property changes. The changes are deferred until the
cluster reboots.
apply-error: Cannot connect to the cluster. The parameter change will be applied after the cluster
reboots.
unknown-error: Cannot apply the parameter change right now. The change will be applied after the
cluster reboots.
String parameterApplyErrorDescription
The error that prevented the parameter from being applied to the database.
String clusterSecurityGroupName
The name of the cluster security group to which the operation was applied.
String description
A description of the security group.
SdkInternalList<T> eC2SecurityGroups
A list of EC2 security groups that are permitted to access clusters associated with this cluster security group.
SdkInternalList<T> iPRanges
A list of IP ranges (CIDR blocks) that are permitted to access clusters associated with this cluster security group.
SdkInternalList<T> tags
The list of tags for the cluster security group.
String destinationRegion
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
Long retentionPeriod
The number of days that automated snapshots are retained in the destination region after they are copied from a source region.
String snapshotCopyGrantName
The name of the snapshot copy grant.
String clusterSubnetGroupName
The name of the cluster subnet group.
String description
The description of the cluster subnet group.
String vpcId
The VPC ID of the cluster subnet group.
String subnetGroupStatus
The status of the cluster subnet group. Possible values are Complete, Incomplete and
Invalid.
SdkInternalList<T> subnets
A list of the VPC Subnet elements.
SdkInternalList<T> tags
The list of tags for the cluster subnet group.
String sourceSnapshotIdentifier
The identifier for the source snapshot.
Constraints:
Must be the identifier for a valid automated snapshot whose state is available.
String sourceSnapshotClusterIdentifier
The identifier of the cluster the source 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.
Constraints:
Must be the identifier for a valid cluster.
String targetSnapshotIdentifier
The identifier given to the new manual snapshot.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for the AWS account that is making the request.
String parameterGroupName
The name of the cluster parameter group.
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique withing your AWS account.
This value is stored as a lower-case string.
String parameterGroupFamily
The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.
To get a list of valid parameter group family names, you can call DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including the default parameter groups for each Amazon Redshift engine version. The parameter group family names associated with the default parameter groups provide you the valid values. For example, a valid family name is "redshift-1.0".
String description
A description of the parameter group.
SdkInternalList<T> tags
A list of tag instances.
String dBName
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:
Must contain 1 to 64 alphanumeric characters.
Must contain only lowercase letters.
Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
String clusterIdentifier
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:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account.
Example: myexamplecluster
String clusterType
The type of the cluster. When cluster type is specified as
single-node, the NumberOfNodes parameter is not required.
multi-node, the NumberOfNodes parameter is required.
Valid Values: multi-node | single-node
Default: multi-node
String nodeType
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 | ds2.xlarge |
ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large |
dc2.8xlarge
String masterUsername
The user name associated with the master user account for the cluster that is being created.
Constraints:
Must be 1 - 128 alphanumeric characters. The user name can't be PUBLIC.
First character must be a letter.
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
String masterUserPassword
The password associated with the master user account for the cluster that is being created.
Constraints:
Must be between 8 and 64 characters in length.
Must contain at least one uppercase letter.
Must contain at least one lowercase letter.
Must contain one number.
Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), \, /, @, or space.
SdkInternalList<T> clusterSecurityGroups
A list of security groups to be associated with this cluster.
Default: The default cluster security group for Amazon Redshift.
SdkInternalList<T> vpcSecurityGroupIds
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.
String clusterSubnetGroupName
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).
String availabilityZone
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-1d
Constraint: The specified Availability Zone must be in the same region as the current endpoint.
String preferredMaintenanceWindow
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.
String clusterParameterGroupName
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:
Must be 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Integer automatedSnapshotRetentionPeriod
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.
Default: 1
Constraints: Must be a value from 0 to 35.
Integer port
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
String clusterVersion
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
Boolean allowVersionUpgrade
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
Integer numberOfNodes
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.
Boolean publiclyAccessible
If true, the cluster can be accessed from a public network.
Boolean encrypted
If true, the data in the cluster is encrypted at rest.
Default: false
String hsmClientCertificateIdentifier
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
String hsmConfigurationIdentifier
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.
String elasticIp
The Elastic IP (EIP) address for the cluster.
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 Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
SdkInternalList<T> tags
A list of tag instances.
String kmsKeyId
The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
Boolean enhancedVpcRouting
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
String additionalInfo
Reserved.
SdkInternalList<T> iamRoles
A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.
A cluster can have up to 10 IAM roles associated with it at any time.
String clusterSecurityGroupName
The name for the security group. Amazon Redshift stores the value as a lowercase string.
Constraints:
Must contain no more than 255 alphanumeric characters or hyphens.
Must not be "Default".
Must be unique for all security groups that are created by your AWS account.
Example: examplesecuritygroup
String description
A description for the security group.
SdkInternalList<T> tags
A list of tag instances.
String snapshotIdentifier
A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the AWS account.
Constraints:
Cannot be null, empty, or blank
Must contain from 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
String clusterIdentifier
The cluster identifier for which you want a snapshot.
SdkInternalList<T> tags
A list of tag instances.
String clusterSubnetGroupName
The name for the subnet group. Amazon Redshift stores the value as a lowercase string.
Constraints:
Must contain no more than 255 alphanumeric characters or hyphens.
Must not be "Default".
Must be unique for all subnet groups that are created by your AWS account.
Example: examplesubnetgroup
String description
A description for the subnet group.
SdkInternalList<T> subnetIds
An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.
SdkInternalList<T> tags
A list of tag instances.
String subscriptionName
The name of the event subscription to be created.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
String snsTopicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
String sourceType
The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs.
Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.
SdkInternalList<T> sourceIds
A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.
Example: my-cluster-1, my-cluster-2
Example: my-snapshot-20131010
SdkInternalList<T> eventCategories
Specifies the Amazon Redshift event categories to be published by the event notification subscription.
Values: Configuration, Management, Monitoring, Security
String severity
Specifies the Amazon Redshift event severity to be published by the event notification subscription.
Values: ERROR, INFO
Boolean enabled
A Boolean value; set to true to activate the subscription, set to false to create the
subscription but not active it.
SdkInternalList<T> tags
A list of tag instances.
String hsmClientCertificateIdentifier
The identifier to be assigned to the new HSM client certificate that the cluster will use to connect to the HSM to use the database encryption keys.
SdkInternalList<T> tags
A list of tag instances.
String hsmConfigurationIdentifier
The identifier to be assigned to the new Amazon Redshift HSM configuration.
String description
A text description of the HSM configuration to be created.
String hsmIpAddress
The IP address that the Amazon Redshift cluster must use to access the HSM.
String hsmPartitionName
The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.
String hsmPartitionPassword
The password required to access the HSM partition.
String hsmServerPublicCertificate
The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.
SdkInternalList<T> tags
A list of tag instances.
String snapshotCopyGrantName
The name of the snapshot copy grant. This name must be unique in the region for the AWS account.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account.
String kmsKeyId
The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission. If no key is specified, the default key is used.
SdkInternalList<T> tags
A list of tag instances.
String resourceName
The Amazon Resource Name (ARN) to which you want to add the tag or tags. For example,
arn:aws:redshift:us-east-1:123456789:cluster:t1.
SdkInternalList<T> tags
One or more name/value pairs to add as tags to the specified resource. Each tag name is passed in with the
parameter Key and the corresponding value is passed in with the parameter Value. The
Key and Value parameters are separated by a comma (,). Separate multiple tags with a
space. For example,
--tags "Key"="owner","Value"="admin" "Key"="environment","Value"="test" "Key"="version","Value"="1.0"
.
String parameterGroupFamily
The name of the cluster parameter group family to which the engine default parameters apply.
String marker
A value that indicates the starting point for the next set of response records in a subsequent request. If a
value is returned in a response, you can retrieve the next set of records by providing this returned marker value
in the Marker parameter and retrying the command. If the Marker field is empty, all
response records have been retrieved for the request.
SdkInternalList<T> parameters
The list of cluster default parameters.
String parameterGroupName
The name of the parameter group to be deleted.
Constraints:
Must be the name of an existing cluster parameter group.
Cannot delete a default cluster parameter group.
String clusterIdentifier
The identifier of the cluster to be deleted.
Constraints:
Must contain lowercase characters.
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Boolean skipFinalClusterSnapshot
Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If
true, a final cluster snapshot is not created. If false, a final cluster snapshot is
created before the cluster is deleted.
The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is
false.
Default: false
String finalClusterSnapshotIdentifier
The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this
parameter is provided, SkipFinalClusterSnapshot must be false.
Constraints:
Must be 1 to 255 alphanumeric characters.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
String clusterSecurityGroupName
The name of the cluster security group to be deleted.
String snapshotIdentifier
The unique identifier of the manual snapshot to be deleted.
Constraints: Must be the name of an existing snapshot that is in the available state.
String snapshotClusterIdentifier
The unique 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.
Constraints: Must be the name of valid cluster.
String clusterSubnetGroupName
The name of the cluster subnet group name to be deleted.
String subscriptionName
The name of the Amazon Redshift event notification subscription to be deleted.
String hsmClientCertificateIdentifier
The identifier of the HSM client certificate to be deleted.
String hsmConfigurationIdentifier
The identifier of the Amazon Redshift HSM configuration to be deleted.
String snapshotCopyGrantName
The name of the snapshot copy grant to delete.
String resourceName
The Amazon Resource Name (ARN) from which you want to remove the tag or tags. For example,
arn:aws:redshift:us-east-1:123456789:cluster:t1.
SdkInternalList<T> tagKeys
The tag key that you want to delete.
String clusterIdentifier
A unique identifier for a cluster whose ClusterDbRevisions you are requesting. This parameter is
case sensitive. All clusters defined for an account are returned by default.
Integer maxRecords
The maximum number of response records to return in each call. If the number of remaining response records
exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You
can retrieve the next set of response records by providing the returned marker value in the
marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
An optional parameter that specifies the starting point for returning a set of response records. When the results
of a DescribeClusterDbRevisions request exceed the value specified in MaxRecords,
Amazon Redshift returns a value in the marker field of the response. You can retrieve the next set
of response records by providing the returned marker value in the marker parameter and
retrying the request.
Constraints: You can specify either the ClusterIdentifier parameter, or the marker
parameter, but not both.
String marker
A string representing the starting point for the next set of revisions. If a value is returned in a response, you
can retrieve the next set of revisions by providing the value in the marker parameter and retrying
the command. If the marker field is empty, all revisions have already been returned.
SdkInternalList<T> clusterDbRevisions
A list of revisions.
String parameterGroupName
The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.
Integer maxRecords
The maximum number of response records to return in each call. If the number of remaining response records
exceeds the specified MaxRecords value, a value is returned in a marker field of the
response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
An optional parameter that specifies the starting point to return a set of response records. When the results of
a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS
returns a value in the Marker field of the response. You can retrieve the next set of response
records by providing the returned marker value in the Marker parameter and retrying the request.
SdkInternalList<T> tagKeys
A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the
specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called
owner and environment. If you specify both of these tag keys in the request, Amazon
Redshift returns a response with the parameter groups that have either or both of these tag keys associated with
them.
SdkInternalList<T> tagValues
A tag value or values for which you want to return all matching cluster parameter groups that are associated with
the specified tag value or values. For example, suppose that you have parameter groups that are tagged with
values called admin and test. If you specify both of these tag values in the request,
Amazon Redshift returns a response with the parameter groups that have either or both of these tag values
associated with them.
String marker
A value that indicates the starting point for the next set of response records in a subsequent request. If a
value is returned in a response, you can retrieve the next set of records by providing this returned marker value
in the Marker parameter and retrying the command. If the Marker field is empty, all
response records have been retrieved for the request.
SdkInternalList<T> parameterGroups
A list of ClusterParameterGroup instances. Each instance describes one cluster parameter group.
String parameterGroupName
The name of a cluster parameter group for which to return details.
String source
The parameter types to return. Specify user to show parameters that are different form the default.
Similarly, specify engine-default to show parameters that are the same as the default parameter
group.
Default: All parameter types returned.
Valid Values: user | engine-default
Integer maxRecords
The maximum number of response records to return in each call. If the number of remaining response records
exceeds the specified MaxRecords value, a value is returned in a marker field of the
response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
An optional parameter that specifies the starting point to return a set of response records. When the results of
a DescribeClusterParameters request exceed the value specified in MaxRecords, AWS returns a
value in the Marker field of the response. You can retrieve the next set of response records by
providing the returned marker value in the Marker parameter and retrying the request.
SdkInternalList<T> parameters
A list of Parameter instances. Each instance lists the parameters of one cluster parameter group.
String marker
A value that indicates the starting point for the next set of response records in a subsequent request. If a
value is returned in a response, you can retrieve the next set of records by providing this returned marker value
in the Marker parameter and retrying the command. If the Marker field is empty, all
response records have been retrieved for the request.
String clusterSecurityGroupName
The name of a cluster security group for which you are requesting details. You can specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both.
Example: securitygroup1
Integer maxRecords
The maximum number of response records to return in each call. If the number of remaining response records
exceeds the specified MaxRecords value, a value is returned in a marker field of the
response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
An optional parameter that specifies the starting point to return a set of response records. When the results of
a DescribeClusterSecurityGroups request exceed the value specified in MaxRecords, AWS returns
a value in the Marker field of the response. You can retrieve the next set of response records by
providing the returned marker value in the Marker parameter and retrying the request.
Constraints: You can specify either the ClusterSecurityGroupName parameter or the Marker parameter, but not both.
SdkInternalList<T> tagKeys
A tag key or keys for which you want to return all matching cluster security groups that are associated with the
specified key or keys. For example, suppose that you have security groups that are tagged with keys called
owner and environment. If you specify both of these tag keys in the request, Amazon
Redshift returns a response with the security groups that have either or both of these tag keys associated with
them.
SdkInternalList<T> tagValues
A tag value or values for which you want to return all matching cluster security groups that are associated with
the specified tag value or values. For example, suppose that you have security groups that are tagged with values
called admin and test. If you specify both of these tag values in the request, Amazon
Redshift returns a response with the security groups that have either or both of these tag values associated with
them.
String marker
A value that indicates the starting point for the next set of response records in a subsequent request. If a
value is returned in a response, you can retrieve the next set of records by providing this returned marker value
in the Marker parameter and retrying the command. If the Marker field is empty, all
response records have been retrieved for the request.
SdkInternalList<T> clusterSecurityGroups
A list of ClusterSecurityGroup instances.
String clusterIdentifier
The identifier of the cluster for which information about snapshots is requested.
String snapshotIdentifier
The snapshot identifier of the snapshot about which to return information.
String snapshotType
The type of snapshots for which you are requesting information. By default, snapshots of all types are returned.
Valid Values: automated | manual
Date startTime
A value that requests only snapshots created at or after the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2012-07-16T18:00:00Z
Date endTime
A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2012-07-16T18:00:00Z
Integer maxRecords
The maximum number of response records to return in each call. If the number of remaining response records
exceeds the specified MaxRecords value, a value is returned in a marker field of the
response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
An optional parameter that specifies the starting point to return a set of response records. When the results of
a DescribeClusterSnapshots request exceed the value specified in MaxRecords, AWS returns a
value in the Marker field of the response. You can retrieve the next set of response records by
providing the returned marker value in the Marker parameter and retrying the request.
String ownerAccount
The AWS customer account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your AWS customer account, or do not specify the parameter.
SdkInternalList<T> tagKeys
A tag key or keys for which you want to return all matching cluster snapshots that are associated with the
specified key or keys. For example, suppose that you have snapshots that are tagged with keys called
owner and environment. If you specify both of these tag keys in the request, Amazon
Redshift returns a response with the snapshots that have either or both of these tag keys associated with them.
SdkInternalList<T> tagValues
A tag value or values for which you want to return all matching cluster snapshots that are associated with the
specified tag value or values. For example, suppose that you have snapshots that are tagged with values called
admin and test. If you specify both of these tag values in the request, Amazon Redshift
returns a response with the snapshots that have either or both of these tag values associated with them.
Boolean clusterExists
A value that indicates whether to return snapshots only for an existing cluster. Table-level restore can be
performed only using a snapshot of an existing cluster, that is, a cluster that has not been deleted. If
ClusterExists is set to true, ClusterIdentifier is required.
String marker
A value that indicates the starting point for the next set of response records in a subsequent request. If a
value is returned in a response, you can retrieve the next set of records by providing this returned marker value
in the Marker parameter and retrying the command. If the Marker field is empty, all
response records have been retrieved for the request.
SdkInternalList<T> snapshots
A list of Snapshot instances.
String clusterIdentifier
The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.
The default is that all clusters defined for an account are returned.
Integer maxRecords
The maximum number of response records to return in each call. If the number of remaining response records
exceeds the specified MaxRecords value, a value is returned in a marker field of the
response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
An optional parameter that specifies the starting point to return a set of response records. When the results of
a DescribeClusters request exceed the value specified in MaxRecords, AWS returns a value in
the Marker field of the response. You can retrieve the next set of response records by providing the
returned marker value in the Marker parameter and retrying the request.
Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.
SdkInternalList<T> tagKeys
A tag key or keys for which you want to return all matching clusters that are associated with the specified key
or keys. For example, suppose that you have clusters that are tagged with keys called owner and
environment. If you specify both of these tag keys in the request, Amazon Redshift returns a
response with the clusters that have either or both of these tag keys associated with them.
SdkInternalList<T> tagValues
A tag value or values for which you want to return all matching clusters that are associated with the specified
tag value or values. For example, suppose that you have clusters that are tagged with values called
admin and test. If you specify both of these tag values in the request, Amazon Redshift
returns a response with the clusters that have either or both of these tag values associated with them.
String marker
A value that indicates the starting point for the next set of response records in a subsequent request. If a
value is returned in a response, you can retrieve the next set of records by providing this returned marker value
in the Marker parameter and retrying the command. If the Marker field is empty, all
response records have been retrieved for the request.
SdkInternalList<T> clusters
A list of Cluster objects, where each object describes one cluster.
String clusterSubnetGroupName
The name of the cluster subnet group for which information is requested.
Integer maxRecords
The maximum number of response records to return in each call. If the number of remaining response records
exceeds the specified MaxRecords value, a value is returned in a marker field of the
response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
An optional parameter that specifies the starting point to return a set of response records. When the results of
a DescribeClusterSubnetGroups request exceed the value specified in MaxRecords, AWS returns a
value in the Marker field of the response. You can retrieve the next set of response records by
providing the returned marker value in the Marker parameter and retrying the request.
SdkInternalList<T> tagKeys
A tag key or keys for which you want to return all matching cluster subnet groups that are associated with the
specified key or keys. For example, suppose that you have subnet groups that are tagged with keys called
owner and environment. If you specify both of these tag keys in the request, Amazon
Redshift returns a response with the subnet groups that have either or both of these tag keys associated with
them.
SdkInternalList<T> tagValues
A tag value or values for which you want to return all matching cluster subnet groups that are associated with
the specified tag value or values. For example, suppose that you have subnet groups that are tagged with values
called admin and test. If you specify both of these tag values in the request, Amazon
Redshift returns a response with the subnet groups that have either or both of these tag values associated with
them.
String marker
A value that indicates the starting point for the next set of response records in a subsequent request. If a
value is returned in a response, you can retrieve the next set of records by providing this returned marker value
in the Marker parameter and retrying the command. If the Marker field is empty, all
response records have been retrieved for the request.
SdkInternalList<T> clusterSubnetGroups
A list of ClusterSubnetGroup instances.
String clusterVersion
The specific cluster version to return.
Example: 1.0
String clusterParameterGroupFamily
The name of a specific cluster parameter group family to return details for.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Integer maxRecords
The maximum number of response records to return in each call. If the number of remaining response records
exceeds the specified MaxRecords value, a value is returned in a marker field of the
response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
An optional parameter that specifies the starting point to return a set of response records. When the results of
a DescribeClusterVersions request exceed the value specified in MaxRecords, AWS returns a
value in the Marker field of the response. You can retrieve the next set of response records by
providing the returned marker value in the Marker parameter and retrying the request.
String marker
A value that indicates the starting point for the next set of response records in a subsequent request. If a
value is returned in a response, you can retrieve the next set of records by providing this returned marker value
in the Marker parameter and retrying the command. If the Marker field is empty, all
response records have been retrieved for the request.
SdkInternalList<T> clusterVersions
A list of Version elements.
String parameterGroupFamily
The name of the cluster parameter group family.
Integer maxRecords
The maximum number of response records to return in each call. If the number of remaining response records
exceeds the specified MaxRecords value, a value is returned in a marker field of the
response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
An optional parameter that specifies the starting point to return a set of response records. When the results of
a DescribeDefaultClusterParameters request exceed the value specified in MaxRecords, AWS
returns a value in the Marker field of the response. You can retrieve the next set of response
records by providing the returned marker value in the Marker parameter and retrying the request.
String sourceType
The source type, such as cluster or parameter group, to which the described event categories apply.
Valid values: cluster, cluster-snapshot, cluster-parameter-group, and cluster-security-group.
SdkInternalList<T> eventCategoriesMapList
A list of event categories descriptions.
String sourceIdentifier
The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.
Constraints:
If SourceIdentifier is supplied, SourceType must also be provided.
Specify a cluster identifier when SourceType is cluster.
Specify a cluster security group name when SourceType is cluster-security-group.
Specify a cluster parameter group name when SourceType is cluster-parameter-group.
Specify a cluster snapshot identifier when SourceType is cluster-snapshot.
String sourceType
The event source to retrieve events for. If no value is specified, all events are returned.
Constraints:
If SourceType is supplied, SourceIdentifier must also be provided.
Specify cluster when SourceIdentifier is a cluster identifier.
Specify cluster-security-group when SourceIdentifier is a cluster security group name.
Specify cluster-parameter-group when SourceIdentifier is a cluster parameter group name.
Specify cluster-snapshot when SourceIdentifier is a cluster snapshot identifier.
Date startTime
The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
Date endTime
The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
Integer duration
The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.
Default: 60
Integer maxRecords
The maximum number of response records to return in each call. If the number of remaining response records
exceeds the specified MaxRecords value, a value is returned in a marker field of the
response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
An optional parameter that specifies the starting point to return a set of response records. When the results of
a DescribeEvents request exceed the value specified in MaxRecords, AWS returns a value in the
Marker field of the response. You can retrieve the next set of response records by providing the
returned marker value in the Marker parameter and retrying the request.
String marker
A value that indicates the starting point for the next set of response records in a subsequent request. If a
value is returned in a response, you can retrieve the next set of records by providing this returned marker value
in the Marker parameter and retrying the command. If the Marker field is empty, all
response records have been retrieved for the request.
SdkInternalList<T> events
A list of Event instances.
String subscriptionName
The name of the Amazon Redshift event notification subscription to be described.
Integer maxRecords
The maximum number of response records to return in each call. If the number of remaining response records
exceeds the specified MaxRecords value, a value is returned in a marker field of the
response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
An optional parameter that specifies the starting point to return a set of response records. When the results of
a DescribeEventSubscriptions request exceed the value specified in MaxRecords, AWS returns a value
in the Marker field of the response. You can retrieve the next set of response records by providing
the returned marker value in the Marker parameter and retrying the request.
SdkInternalList<T> tagKeys
A tag key or keys for which you want to return all matching event notification subscriptions that are associated
with the specified key or keys. For example, suppose that you have subscriptions that are tagged with keys called
owner and environment. If you specify both of these tag keys in the request, Amazon
Redshift returns a response with the subscriptions that have either or both of these tag keys associated with
them.
SdkInternalList<T> tagValues
A tag value or values for which you want to return all matching event notification subscriptions that are
associated with the specified tag value or values. For example, suppose that you have subscriptions that are
tagged with values called admin and test. If you specify both of these tag values in
the request, Amazon Redshift returns a response with the subscriptions that have either or both of these tag
values associated with them.
String marker
A value that indicates the starting point for the next set of response records in a subsequent request. If a
value is returned in a response, you can retrieve the next set of records by providing this returned marker value
in the Marker parameter and retrying the command. If the Marker field is empty, all
response records have been retrieved for the request.
SdkInternalList<T> eventSubscriptionsList
A list of event subscriptions.
String hsmClientCertificateIdentifier
The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your AWS customer account.
Integer maxRecords
The maximum number of response records to return in each call. If the number of remaining response records
exceeds the specified MaxRecords value, a value is returned in a marker field of the
response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
An optional parameter that specifies the starting point to return a set of response records. When the results of
a DescribeHsmClientCertificates request exceed the value specified in MaxRecords, AWS returns
a value in the Marker field of the response. You can retrieve the next set of response records by
providing the returned marker value in the Marker parameter and retrying the request.
SdkInternalList<T> tagKeys
A tag key or keys for which you want to return all matching HSM client certificates that are associated with the
specified key or keys. For example, suppose that you have HSM client certificates that are tagged with keys
called owner and environment. If you specify both of these tag keys in the request,
Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag keys
associated with them.
SdkInternalList<T> tagValues
A tag value or values for which you want to return all matching HSM client certificates that are associated with
the specified tag value or values. For example, suppose that you have HSM client certificates that are tagged
with values called admin and test. If you specify both of these tag values in the
request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these
tag values associated with them.
String marker
A value that indicates the starting point for the next set of response records in a subsequent request. If a
value is returned in a response, you can retrieve the next set of records by providing this returned marker value
in the Marker parameter and retrying the command. If the Marker field is empty, all
response records have been retrieved for the request.
SdkInternalList<T> hsmClientCertificates
A list of the identifiers for one or more HSM client certificates used by Amazon Redshift clusters to store and retrieve database encryption keys in an HSM.
String hsmConfigurationIdentifier
The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your AWS customer account.
Integer maxRecords
The maximum number of response records to return in each call. If the number of remaining response records
exceeds the specified MaxRecords value, a value is returned in a marker field of the
response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
An optional parameter that specifies the starting point to return a set of response records. When the results of
a DescribeHsmConfigurations request exceed the value specified in MaxRecords, AWS returns a
value in the Marker field of the response. You can retrieve the next set of response records by
providing the returned marker value in the Marker parameter and retrying the request.
SdkInternalList<T> tagKeys
A tag key or keys for which you want to return all matching HSM configurations that are associated with the
specified key or keys. For example, suppose that you have HSM configurations that are tagged with keys called
owner and environment. If you specify both of these tag keys in the request, Amazon
Redshift returns a response with the HSM configurations that have either or both of these tag keys associated
with them.
SdkInternalList<T> tagValues
A tag value or values for which you want to return all matching HSM configurations that are associated with the
specified tag value or values. For example, suppose that you have HSM configurations that are tagged with values
called admin and test. If you specify both of these tag values in the request, Amazon
Redshift returns a response with the HSM configurations that have either or both of these tag values associated
with them.
String marker
A value that indicates the starting point for the next set of response records in a subsequent request. If a
value is returned in a response, you can retrieve the next set of records by providing this returned marker value
in the Marker parameter and retrying the command. If the Marker field is empty, all
response records have been retrieved for the request.
SdkInternalList<T> hsmConfigurations
A list of HsmConfiguration objects.
String clusterIdentifier
The identifier of the cluster from which to get the logging status.
Example: examplecluster
Boolean loggingEnabled
true if logging is on, false if logging is off.
String bucketName
The name of the S3 bucket where the log files are stored.
String s3KeyPrefix
The prefix applied to the log file names.
Date lastSuccessfulDeliveryTime
The last time that logs were delivered.
Date lastFailureTime
The last time when logs failed to be delivered.
String lastFailureMessage
The message indicating that logs failed to be delivered.
String clusterVersion
The version filter value. Specify this parameter to show only the available offerings matching the specified version.
Default: All versions.
Constraints: Must be one of the version returned from DescribeClusterVersions.
String nodeType
The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.
Integer maxRecords
The maximum number of response records to return in each call. If the number of remaining response records
exceeds the specified MaxRecords value, a value is returned in a marker field of the
response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
An optional parameter that specifies the starting point to return a set of response records. When the results of
a DescribeOrderableClusterOptions request exceed the value specified in MaxRecords, AWS
returns a value in the Marker field of the response. You can retrieve the next set of response
records by providing the returned marker value in the Marker parameter and retrying the request.
SdkInternalList<T> orderableClusterOptions
An OrderableClusterOption structure containing information about orderable options for the cluster.
String marker
A value that indicates the starting point for the next set of response records in a subsequent request. If a
value is returned in a response, you can retrieve the next set of records by providing this returned marker value
in the Marker parameter and retrying the command. If the Marker field is empty, all
response records have been retrieved for the request.
String reservedNodeOfferingId
The unique identifier for the offering.
Integer maxRecords
The maximum number of response records to return in each call. If the number of remaining response records
exceeds the specified MaxRecords value, a value is returned in a marker field of the
response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
An optional parameter that specifies the starting point to return a set of response records. When the results of
a DescribeReservedNodeOfferings request exceed the value specified in MaxRecords, AWS returns
a value in the Marker field of the response. You can retrieve the next set of response records by
providing the returned marker value in the Marker parameter and retrying the request.
String marker
A value that indicates the starting point for the next set of response records in a subsequent request. If a
value is returned in a response, you can retrieve the next set of records by providing this returned marker value
in the Marker parameter and retrying the command. If the Marker field is empty, all
response records have been retrieved for the request.
SdkInternalList<T> reservedNodeOfferings
A list of ReservedNodeOffering objects.
String reservedNodeId
Identifier for the node reservation.
Integer maxRecords
The maximum number of response records to return in each call. If the number of remaining response records
exceeds the specified MaxRecords value, a value is returned in a marker field of the
response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
An optional parameter that specifies the starting point to return a set of response records. When the results of
a DescribeReservedNodes request exceed the value specified in MaxRecords, AWS returns a value
in the Marker field of the response. You can retrieve the next set of response records by providing
the returned marker value in the Marker parameter and retrying the request.
String marker
A value that indicates the starting point for the next set of response records in a subsequent request. If a
value is returned in a response, you can retrieve the next set of records by providing this returned marker value
in the Marker parameter and retrying the command. If the Marker field is empty, all
response records have been retrieved for the request.
SdkInternalList<T> reservedNodes
The list of ReservedNode objects.
String clusterIdentifier
The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive.
By default, resize operations for all clusters defined for an AWS account are returned.
String targetNodeType
The node type that the cluster will have after the resize operation is complete.
Integer targetNumberOfNodes
The number of nodes that the cluster will have after the resize operation is complete.
String targetClusterType
The cluster type after the resize operation is complete.
Valid Values: multi-node | single-node
String status
The status of the resize operation.
Valid Values: NONE | IN_PROGRESS | FAILED | SUCCEEDED
SdkInternalList<T> importTablesCompleted
The names of tables that have been completely imported .
Valid Values: List of table names.
SdkInternalList<T> importTablesInProgress
The names of tables that are being currently imported.
Valid Values: List of table names.
SdkInternalList<T> importTablesNotStarted
The names of tables that have not been yet imported.
Valid Values: List of table names
Double avgResizeRateInMegaBytesPerSecond
The average rate of the resize operation over the last few minutes, measured in megabytes per second. After the resize operation completes, this value shows the average rate of the entire resize operation.
Long totalResizeDataInMegaBytes
The estimated total amount of data, in megabytes, on the cluster before the resize operation began.
Long progressInMegaBytes
While the resize operation is in progress, this value shows the current amount of data, in megabytes, that has been processed so far. When the resize operation is complete, this value shows the total amount of data, in megabytes, on the cluster, which may be more or less than TotalResizeDataInMegaBytes (the estimated total amount of data before resize).
Long elapsedTimeInSeconds
The amount of seconds that have elapsed since the resize operation began. After the resize operation completes, this value shows the total actual time, in seconds, for the resize operation.
Long estimatedTimeToCompletionInSeconds
The estimated time remaining, in seconds, until the resize operation is complete. This value is calculated based on the average resize rate and the estimated amount of data remaining to be processed. Once the resize operation is complete, this value will be 0.
String snapshotCopyGrantName
The name of the snapshot copy grant.
Integer maxRecords
The maximum number of response records to return in each call. If the number of remaining response records
exceeds the specified MaxRecords value, a value is returned in a marker field of the
response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
String marker
An optional parameter that specifies the starting point to return a set of response records. When the results of
a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, AWS
returns a value in the Marker field of the response. You can retrieve the next set of response
records by providing the returned marker value in the Marker parameter and retrying the request.
Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.
SdkInternalList<T> tagKeys
A tag key or keys for which you want to return all matching resources that are associated with the specified key
or keys. For example, suppose that you have resources tagged with keys called owner and
environment. If you specify both of these tag keys in the request, Amazon Redshift returns a
response with all resources that have either or both of these tag keys associated with them.
SdkInternalList<T> tagValues
A tag value or values for which you want to return all matching resources that are associated with the specified
value or values. For example, suppose that you have resources tagged with values called admin and
test. If you specify both of these tag values in the request, Amazon Redshift returns a response
with all resources that have either or both of these tag values associated with them.
String marker
An optional parameter that specifies the starting point to return a set of response records. When the results of
a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, AWS
returns a value in the Marker field of the response. You can retrieve the next set of response
records by providing the returned marker value in the Marker parameter and retrying the request.
Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.
SdkInternalList<T> snapshotCopyGrants
The list of SnapshotCopyGrant objects.
String clusterIdentifier
The Amazon Redshift cluster that the table is being restored to.
String tableRestoreRequestId
The identifier of the table restore request to return status for. If you don't specify a
TableRestoreRequestId value, then DescribeTableRestoreStatus returns the status of all
in-progress table restore requests.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords value, a pagination token called a marker is included in the response so that the
remaining results can be retrieved.
String marker
An optional pagination token provided by a previous DescribeTableRestoreStatus request. If this
parameter is specified, the response includes only records beyond the marker, up to the value specified by the
MaxRecords parameter.
SdkInternalList<T> tableRestoreStatusDetails
A list of status details for one or more table restore requests.
String marker
A pagination token that can be used in a subsequent DescribeTableRestoreStatus request.
String resourceName
The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example,
arn:aws:redshift:us-east-1:123456789:cluster:t1.
String resourceType
The type of resource with which you want to view tags. Valid resource types are:
Cluster
CIDR/IP
EC2 security group
Snapshot
Cluster security group
Subnet group
HSM connection
HSM certificate
Parameter group
Snapshot copy grant
For more information about Amazon Redshift resource types and constructing ARNs, go to Specifying Policy Elements: Actions, Effects, Resources, and Principals in the Amazon Redshift Cluster Management Guide.
Integer maxRecords
The maximum number or response records to return in each call. If the number of remaining response records
exceeds the specified MaxRecords value, a value is returned in a marker field of the
response. You can retrieve the next set of records by retrying the command with the returned marker
value.
String marker
A value that indicates the starting point for the next set of response records in a subsequent request. If a
value is returned in a response, you can retrieve the next set of records by providing this returned marker value
in the marker parameter and retrying the command. If the marker field is empty, all
response records have been retrieved for the request.
SdkInternalList<T> tagKeys
A tag key or keys for which you want to return all matching resources that are associated with the specified key
or keys. For example, suppose that you have resources tagged with keys called owner and
environment. If you specify both of these tag keys in the request, Amazon Redshift returns a
response with all resources that have either or both of these tag keys associated with them.
SdkInternalList<T> tagValues
A tag value or values for which you want to return all matching resources that are associated with the specified
value or values. For example, suppose that you have resources tagged with values called admin and
test. If you specify both of these tag values in the request, Amazon Redshift returns a response
with all resources that have either or both of these tag values associated with them.
SdkInternalList<T> taggedResources
A list of tags with their associated resources.
String marker
A value that indicates the starting point for the next set of response records in a subsequent request. If a
value is returned in a response, you can retrieve the next set of records by providing this returned marker value
in the Marker parameter and retrying the command. If the Marker field is empty, all
response records have been retrieved for the request.
String clusterIdentifier
The identifier of the cluster on which logging is to be stopped.
Example: examplecluster
Boolean loggingEnabled
true if logging is on, false if logging is off.
String bucketName
The name of the S3 bucket where the log files are stored.
String s3KeyPrefix
The prefix applied to the log file names.
Date lastSuccessfulDeliveryTime
The last time that logs were delivered.
Date lastFailureTime
The last time when logs failed to be delivered.
String lastFailureMessage
The message indicating that logs failed to be delivered.
String clusterIdentifier
The unique identifier of the source cluster that you want to disable copying of snapshots to a destination region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.
String status
The status of the EC2 security group.
String eC2SecurityGroupName
The name of the EC2 Security Group.
String eC2SecurityGroupOwnerId
The AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
SdkInternalList<T> tags
The list of tags for the EC2 security group.
String clusterIdentifier
The identifier of the cluster on which logging is to be started.
Example: examplecluster
String bucketName
The name of an existing S3 bucket where the log files are to be stored.
Constraints:
Must be in the same region as the cluster
The cluster must have read bucket and put object permissions
String s3KeyPrefix
The prefix applied to the log file names.
Constraints:
Cannot exceed 512 characters
Cannot contain spaces( ), double quotes ("), single quotes ('), a backslash (\), or control characters. The hexadecimal codes for invalid characters are:
x00 to x20
x22
x27
x5c
x7f or larger
Boolean loggingEnabled
true if logging is on, false if logging is off.
String bucketName
The name of the S3 bucket where the log files are stored.
String s3KeyPrefix
The prefix applied to the log file names.
Date lastSuccessfulDeliveryTime
The last time that logs were delivered.
Date lastFailureTime
The last time when logs failed to be delivered.
String lastFailureMessage
The message indicating that logs failed to be delivered.
String clusterIdentifier
The unique identifier of the source cluster to copy snapshots from.
Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.
String destinationRegion
The destination region that you want to copy snapshots to.
Constraints: Must be the name of a valid region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.
Integer retentionPeriod
The number of days to retain automated snapshots in the destination region after they are copied from the source region.
Default: 7.
Constraints: Must be at least 1 and no more than 35.
String snapshotCopyGrantName
The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
String sourceIdentifier
The identifier for the source of the event.
String sourceType
The source type for this event.
String message
The text of this event.
SdkInternalList<T> eventCategories
A list of the event categories.
Values: Configuration, Management, Monitoring, Security
String severity
The severity of the event.
Values: ERROR, INFO
Date date
The date and time of the event.
String eventId
The identifier of the event.
String sourceType
The source type, such as cluster or cluster-snapshot, that the returned categories belong to.
SdkInternalList<T> events
The events in the event category.
String eventId
The identifier of an Amazon Redshift event.
SdkInternalList<T> eventCategories
The category of an Amazon Redshift event.
String eventDescription
The description of an Amazon Redshift event.
String severity
The severity of the event.
Values: ERROR, INFO
String customerAwsId
The AWS customer account associated with the Amazon Redshift event notification subscription.
String custSubscriptionId
The name of the Amazon Redshift event notification subscription.
String snsTopicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event notification subscription.
String status
The status of the Amazon Redshift event notification subscription.
Constraints:
Can be one of the following: active | no-permission | topic-not-exist
The status "no-permission" indicates that Amazon Redshift no longer has permission to post to the Amazon SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
Date subscriptionCreationTime
The date and time the Amazon Redshift event notification subscription was created.
String sourceType
The source type of the events returned the Amazon Redshift event notification, such as cluster, or cluster-snapshot.
SdkInternalList<T> sourceIdsList
A list of the sources that publish events to the Amazon Redshift event notification subscription.
SdkInternalList<T> eventCategoriesList
The list of Amazon Redshift event categories specified in the event notification subscription.
Values: Configuration, Management, Monitoring, Security
String severity
The event severity specified in the Amazon Redshift event notification subscription.
Values: ERROR, INFO
Boolean enabled
A Boolean value indicating whether the subscription is enabled. true indicates the subscription is
enabled.
SdkInternalList<T> tags
The list of tags for the event subscription.
String dbUser
The name of a database user. If a user name matching DbUser exists in the database, the temporary
user credentials have the same permissions as the existing user. If DbUser doesn't exist in the
database and Autocreate is True, a new user is created using the value for
DbUser with PUBLIC permissions. If a database user matching the value for DbUser
doesn't exist and Autocreate is False, then the command succeeds but the connection
attempt will fail because the user doesn't exist in the database.
For more information, see CREATE USER in the Amazon Redshift Database Developer Guide.
Constraints:
Must be 1 to 64 alphanumeric characters or hyphens. The user name can't be PUBLIC.
Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
String dbName
The name of a database that DbUser is authorized to log on to. If DbName is not
specified, DbUser can log on to any existing database.
Constraints:
Must be 1 to 64 alphanumeric characters or hyphens
Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
String clusterIdentifier
The unique identifier of the cluster that contains the database for which your are requesting credentials. This parameter is case sensitive.
Integer durationSeconds
The number of seconds until the returned temporary password expires.
Constraint: minimum 900, maximum 3600.
Default: 900
Boolean autoCreate
Create a database user with the name specified for the user named in DbUser if one does not exist.
SdkInternalList<T> dbGroups
A list of the names of existing database groups that the user named in DbUser will join for the
current session, in addition to any group memberships for an existing user. If not specified, a new user is added
only to PUBLIC.
Database group name constraints
Must be 1 to 64 alphanumeric characters or hyphens
Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
String dbUser
A database user name that is authorized to log on to the database DbName using the password
DbPassword. If the specified DbUser exists in the database, the new user name has the same database
privileges as the the user named in DbUser. By default, the user is added to PUBLIC. If the DbGroups
parameter is specifed, DbUser is added to the listed groups for any sessions created using these
credentials.
String dbPassword
A temporary password that authorizes the user name returned by DbUser to log on to the database
DbName.
Date expiration
The date and time the password in DbPassword expires.
String reservedNodeId
A string representing the node identifier for the Reserved Node to be exchanged.
Integer maxRecords
An integer setting the maximum number of ReservedNodeOfferings to retrieve.
String marker
A value that indicates the starting point for the next set of ReservedNodeOfferings.
String marker
An optional parameter that specifies the starting point for returning a set of response records. When the results
of a GetReservedNodeExchangeOfferings request exceed the value specified in MaxRecords, Amazon
Redshift returns a value in the marker field of the response. You can retrieve the next set of response records
by providing the returned marker value in the marker parameter and retrying the request.
SdkInternalList<T> reservedNodeOfferings
Returns an array of ReservedNodeOffering objects.
String hsmClientCertificateIdentifier
The identifier of the HSM client certificate.
String hsmClientCertificatePublicKey
The public key that the Amazon Redshift cluster will use to connect to the HSM. You must register the public key in the HSM.
SdkInternalList<T> tags
The list of tags for the HSM client certificate.
String hsmConfigurationIdentifier
The name of the Amazon Redshift HSM configuration.
String description
A text description of the HSM configuration.
String hsmIpAddress
The IP address that the Amazon Redshift cluster must use to access the HSM.
String hsmPartitionName
The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.
SdkInternalList<T> tags
The list of tags for the HSM configuration.
String hsmClientCertificateIdentifier
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
String hsmConfigurationIdentifier
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.
String status
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
String status
The status of the IP range, for example, "authorized".
String cIDRIP
The IP range in Classless Inter-Domain Routing (CIDR) notation.
SdkInternalList<T> tags
The list of tags for the IP range.
String clusterIdentifier
The unique identifier of a cluster whose database revision you want to modify.
Example: examplecluster
String revisionTarget
The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.
String clusterIdentifier
The unique identifier of the cluster for which you want to associate or disassociate IAM roles.
SdkInternalList<T> addIamRoles
Zero or more IAM roles to associate with the cluster. The roles must be in their Amazon Resource Name (ARN) format. You can associate up to 10 IAM roles with a single cluster in a single request.
SdkInternalList<T> removeIamRoles
Zero or more IAM roles in ARN format to disassociate from the cluster. You can disassociate up to 10 IAM roles from a single cluster in a single request.
String parameterGroupName
The name of the parameter group to be modified.
SdkInternalList<T> parameters
An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.
For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.
String parameterGroupName
The name of the cluster parameter group.
String parameterGroupStatus
The status of the parameter group. For example, if you made a change to a parameter group name-value pair, then the change could be pending a reboot of an associated cluster.
String clusterIdentifier
The unique identifier of the cluster to be modified.
Example: examplecluster
String clusterType
The new cluster type.
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 DescribeResize to track the progress of the resize request.
Valid Values: multi-node | single-node
String nodeType
The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter.
When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request.
Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large |
dc1.8xlarge | dc2.large | dc2.8xlarge
Integer numberOfNodes
The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter.
When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request.
Valid Values: Integer greater than 0.
SdkInternalList<T> clusterSecurityGroups
A list of cluster security groups to be authorized on this cluster. This change is asynchronously applied as soon as possible.
Security groups currently associated with the cluster, and not in the list of groups to apply, will be revoked from the cluster.
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
SdkInternalList<T> vpcSecurityGroupIds
A list of virtual private cloud (VPC) security groups to be associated with the cluster. This change is asynchronously applied as soon as possible.
String masterUserPassword
The new password for the cluster master user. This change is asynchronously applied as soon as possible. Between
the time of the request and the completion of the request, the MasterUserPassword element exists in
the PendingModifiedValues element of the operation response.
Operations never return the password, so this operation provides a way to regain access to the master user account for a cluster if the password is lost.
Default: Uses existing setting.
Constraints:
Must be between 8 and 64 characters in length.
Must contain at least one uppercase letter.
Must contain at least one lowercase letter.
Must contain one number.
Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), \, /, @, or space.
String clusterParameterGroupName
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 RebootCluster.
Default: Uses existing setting.
Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.
Integer automatedSnapshotRetentionPeriod
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.
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.
Default: Uses existing setting.
Constraints: Must be a value from 0 to 35.
String preferredMaintenanceWindow
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.
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.
Default: Uses existing setting.
Format: ddd:hh24:mi-ddd:hh24:mi, for example wed:07:30-wed:08:00.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes.
String clusterVersion
The new version number of the Amazon Redshift engine to upgrade to.
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 Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
Example: 1.0
Boolean allowVersionUpgrade
If true, major version upgrades will be applied automatically to the cluster during the maintenance
window.
Default: false
String hsmClientCertificateIdentifier
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
String hsmConfigurationIdentifier
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.
String newClusterIdentifier
The new identifier for the cluster.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account.
Example: examplecluster
Boolean publiclyAccessible
If true, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be
publicly available.
String elasticIp
The Elastic IP (EIP) address for the cluster.
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 Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
Boolean enhancedVpcRouting
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
String clusterSubnetGroupName
The name of the subnet group to be modified.
String description
A text description of the subnet group to be modified.
SdkInternalList<T> subnetIds
An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.
String subscriptionName
The name of the modified Amazon Redshift event notification subscription.
String snsTopicArn
The Amazon Resource Name (ARN) of the SNS topic to be used by the event notification subscription.
String sourceType
The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs.
Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.
SdkInternalList<T> sourceIds
A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.
Example: my-cluster-1, my-cluster-2
Example: my-snapshot-20131010
SdkInternalList<T> eventCategories
Specifies the Amazon Redshift event categories to be published by the event notification subscription.
Values: Configuration, Management, Monitoring, Security
String severity
Specifies the Amazon Redshift event severity to be published by the event notification subscription.
Values: ERROR, INFO
Boolean enabled
A Boolean value indicating if the subscription is enabled. true indicates the subscription is
enabled
String clusterIdentifier
The unique identifier of the cluster for which you want to change the retention period for automated snapshots that are copied to a destination region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.
Integer retentionPeriod
The number of days to retain automated snapshots in the destination region after they are copied from the source region.
If you decrease the retention period for automated snapshots that are copied to a destination region, Amazon Redshift will delete any existing automated snapshots that were copied to the destination region and that fall outside of the new retention period.
Constraints: Must be at least 1 and no more than 35.
String clusterVersion
The version of the orderable cluster.
String clusterType
The cluster type, for example multi-node.
String nodeType
The node type for the orderable cluster.
SdkInternalList<T> availabilityZones
A list of availability zones for the orderable cluster.
String parameterName
The name of the parameter.
String parameterValue
The value of the parameter.
String description
A description of the parameter.
String source
The source of the parameter value, such as "engine-default" or "user".
String dataType
The data type of the parameter.
String allowedValues
The valid range of values for the parameter.
String applyType
Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
Boolean isModifiable
If true, the parameter can be modified. Some parameters have security or operational implications
that prevent them from being changed.
String minimumEngineVersion
The earliest engine version to which the parameter can apply.
String masterUserPassword
The pending or in-progress change of the master user password for the cluster.
String nodeType
The pending or in-progress change of the cluster's node type.
Integer numberOfNodes
The pending or in-progress change of the number of nodes in the cluster.
String clusterType
The pending or in-progress change of the cluster type.
String clusterVersion
The pending or in-progress change of the service version.
Integer automatedSnapshotRetentionPeriod
The pending or in-progress change of the automated snapshot retention period.
String clusterIdentifier
The pending or in-progress change of the new identifier for the cluster.
Boolean publiclyAccessible
The pending or in-progress change of the ability to connect to the cluster from the public network.
Boolean enhancedVpcRouting
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
String clusterIdentifier
The cluster identifier.
String reservedNodeId
The unique identifier for the reservation.
String reservedNodeOfferingId
The identifier for the reserved node offering.
String nodeType
The node type of the reserved node.
Date startTime
The time the reservation started. You purchase a reserved node offering for a duration. This is the start time of that duration.
Integer duration
The duration of the node reservation in seconds.
Double fixedPrice
The fixed cost Amazon Redshift charges you for this reserved node.
Double usagePrice
The hourly rate Amazon Redshift charges you for this reserved node.
String currencyCode
The currency code for the reserved cluster.
Integer nodeCount
The number of reserved compute nodes.
String state
The state of the reserved compute node.
Possible Values:
pending-payment-This reserved node has recently been purchased, and the sale has been approved, but payment has not yet been confirmed.
active-This reserved node is owned by the caller and is available for use.
payment-failed-Payment failed for the purchase attempt.
retired-The reserved node is no longer available.
exchanging-The owner is exchanging the reserved node for another reserved node.
String offeringType
The anticipated utilization of the reserved node, as defined in the reserved node offering.
SdkInternalList<T> recurringCharges
The recurring charges for the reserved node.
String reservedNodeOfferingType
String reservedNodeOfferingId
The offering identifier.
String nodeType
The node type offered by the reserved node offering.
Integer duration
The duration, in seconds, for which the offering will reserve the node.
Double fixedPrice
The upfront fixed charge you will pay to purchase the specific reserved node offering.
Double usagePrice
The rate you are charged for each hour the cluster that is using the offering is running.
String currencyCode
The currency code for the compute nodes offering.
String offeringType
The anticipated utilization of the reserved node, as defined in the reserved node offering.
SdkInternalList<T> recurringCharges
The charge to your account regardless of whether you are creating any clusters using the node offering. Recurring charges are only in effect for heavy-utilization reserved nodes.
String reservedNodeOfferingType
String parameterGroupName
The name of the cluster parameter group to be reset.
Boolean resetAllParameters
If true, all parameters in the specified parameter group will be reset to their default values.
Default: true
SdkInternalList<T> parameters
An array of names of parameters to be reset. If ResetAllParameters option is not used, then at least one parameter name must be supplied.
Constraints: A maximum of 20 parameters can be reset in a single request.
String parameterGroupName
The name of the cluster parameter group.
String parameterGroupStatus
The status of the parameter group. For example, if you made a change to a parameter group name-value pair, then the change could be pending a reboot of an associated cluster.
String clusterIdentifier
The identifier of the cluster that will be created from restoring the snapshot.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account.
String snapshotIdentifier
The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.
Example: my-snapshot-id
String snapshotClusterIdentifier
The name of the cluster the source 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.
Integer port
The port number on which the cluster accepts connections.
Default: The same port as the original cluster.
Constraints: Must be between 1115 and 65535.
String availabilityZone
The Amazon EC2 Availability Zone in which to restore the cluster.
Default: A random, system-chosen Availability Zone.
Example: us-east-1a
Boolean allowVersionUpgrade
If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift
engine that is running on the cluster.
Default: true
String clusterSubnetGroupName
The name of the subnet group where you want to cluster restored.
A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must provide subnet group name where you want the cluster restored.
Boolean publiclyAccessible
If true, the cluster can be accessed from a public network.
String ownerAccount
The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
String hsmClientCertificateIdentifier
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
String hsmConfigurationIdentifier
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.
String elasticIp
The elastic IP (EIP) address for the cluster.
String clusterParameterGroupName
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:
Must be 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
SdkInternalList<T> clusterSecurityGroups
A list of security groups to be associated with this cluster.
Default: The default cluster security group for Amazon Redshift.
Cluster security groups only apply to clusters outside of VPCs.
SdkInternalList<T> vpcSecurityGroupIds
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.
VPC security groups only apply to clusters in VPCs.
String preferredMaintenanceWindow
The weekly time range (in UTC) during which automated cluster maintenance can occur.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: The value selected for the cluster from which the snapshot was taken. 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.
Integer automatedSnapshotRetentionPeriod
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.
Default: The value selected for the cluster from which the snapshot was taken.
Constraints: Must be a value from 0 to 35.
String kmsKeyId
The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster that you restore from a shared snapshot.
String nodeType
The node type that the restored cluster will be provisioned with.
Default: The node type of the cluster from which the snapshot was taken. You can modify this if you are using any DS node type. In that case, you can choose to restore into another DS node type of the same size. For example, you can restore ds1.8xlarge into ds2.8xlarge, or ds1.xlarge into ds2.xlarge. If you have a DC instance type, you must restore into that same instance type and size. In other words, you can only restore a dc1.large instance type into another dc1.large instance type or dc2.large instance type. You can't restore dc1.8xlarge to dc2.8xlarge. First restore to a dc1.8xlareg cluster, then resize to a dc2.8large cluster. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide.
Boolean enhancedVpcRouting
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
String additionalInfo
Reserved.
SdkInternalList<T> iamRoles
A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.
A cluster can have up to 10 IAM roles associated at any time.
String status
The status of the restore action. Returns starting, restoring, completed, or failed.
Double currentRestoreRateInMegaBytesPerSecond
The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
Long snapshotSizeInMegaBytes
The size of the set of snapshot data used to restore the cluster.
Long progressInMegaBytes
The number of megabytes that have been transferred from snapshot storage.
Long elapsedTimeInSeconds
The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
Long estimatedTimeToCompletionInSeconds
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
String clusterIdentifier
The identifier of the Amazon Redshift cluster to restore the table to.
String snapshotIdentifier
The identifier of the snapshot to restore the table from. This snapshot must have been created from the Amazon
Redshift cluster specified by the ClusterIdentifier parameter.
String sourceDatabaseName
The name of the source database that contains the table to restore from.
String sourceSchemaName
The name of the source schema that contains the table to restore from. If you do not specify a
SourceSchemaName value, the default is public.
String sourceTableName
The name of the source table to restore from.
String targetDatabaseName
The name of the database to restore the table to.
String targetSchemaName
The name of the schema to restore the table to.
String newTableName
The name of the table to create as a result of the current request.
String databaseRevision
A unique string that identifies the version to update the cluster to. You can use this value in ModifyClusterDbRevision.
String description
A string that describes the changes and features that will be applied to the cluster when it is updated to the corresponding ClusterDbRevision.
Date databaseRevisionReleaseDate
The date on which the database revision was released.
String clusterSecurityGroupName
The name of the security Group from which to revoke the ingress rule.
String cIDRIP
The IP range for which to revoke access. This range must be a valid Classless Inter-Domain Routing (CIDR) block
of IP addresses. If CIDRIP is specified, EC2SecurityGroupName and
EC2SecurityGroupOwnerId cannot be provided.
String eC2SecurityGroupName
The name of the EC2 Security Group whose access is to be revoked. If EC2SecurityGroupName is
specified, EC2SecurityGroupOwnerId must also be provided and CIDRIP cannot be provided.
String eC2SecurityGroupOwnerId
The AWS account number of the owner of the security group specified in the EC2SecurityGroupName
parameter. The AWS access key ID is not an acceptable value. If EC2SecurityGroupOwnerId is
specified, EC2SecurityGroupName must also be provided. and CIDRIP cannot be provided.
Example: 111122223333
String snapshotIdentifier
The identifier of the snapshot that the account can no longer access.
String snapshotClusterIdentifier
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.
String accountWithRestoreAccess
The identifier of the AWS customer account that can no longer restore the specified snapshot.
String clusterIdentifier
The unique identifier of the cluster that you want to rotate the encryption keys for.
Constraints: Must be the name of valid cluster that has encryption enabled.
String snapshotIdentifier
The snapshot identifier that is provided in the request.
String clusterIdentifier
The identifier of the cluster for which the snapshot was taken.
Date snapshotCreateTime
The time (UTC) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.
String status
The snapshot status. The value of the status depends on the API operation used.
CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".
DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".
DeleteClusterSnapshot returns status as "deleted".
Integer port
The port that the cluster is listening on.
String availabilityZone
The Availability Zone in which the cluster was created.
Date clusterCreateTime
The time (UTC) when the cluster was originally created.
String masterUsername
The master user name for the cluster.
String clusterVersion
The version ID of the Amazon Redshift engine that is running on the cluster.
String snapshotType
The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type "manual".
String nodeType
The node type of the nodes in the cluster.
Integer numberOfNodes
The number of nodes in the cluster.
String dBName
The name of the database that was created when the cluster was created.
String vpcId
The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.
Boolean encrypted
If true, the data in the snapshot is encrypted at rest.
String kmsKeyId
The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.
Boolean encryptedWithHSM
A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster.
true indicates that the data is encrypted using HSM keys.
SdkInternalList<T> accountsWithRestoreAccess
A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts
are authorized. Visible only to the snapshot owner.
String ownerAccount
For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.
Double totalBackupSizeInMegaBytes
The size of the complete set of backup data that would be used to restore the cluster.
Double actualIncrementalBackupSizeInMegaBytes
The size of the incremental backup.
Double backupProgressInMegaBytes
The number of megabytes that have been transferred to the snapshot backup.
Double currentBackupRateInMegaBytesPerSecond
The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a
completed backup.
Long estimatedSecondsToCompletion
The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a
completed backup.
Long elapsedTimeInSeconds
The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.
String sourceRegion
The source region from which the snapshot was copied.
SdkInternalList<T> tags
The list of tags for the cluster snapshot.
SdkInternalList<T> restorableNodeTypes
The list of node types that this cluster snapshot is able to restore into.
Boolean enhancedVpcRouting
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
String snapshotCopyGrantName
The name of the snapshot copy grant.
String kmsKeyId
The unique identifier of the customer master key (CMK) in AWS KMS to which Amazon Redshift is granted permission.
SdkInternalList<T> tags
A list of tag instances.
String subnetIdentifier
The identifier of the subnet.
AvailabilityZone subnetAvailabilityZone
String subnetStatus
The status of the subnet.
String name
String tableRestoreRequestId
The unique identifier for the table restore request.
String status
A value that describes the current state of the table restore request.
Valid Values: SUCCEEDED, FAILED, CANCELED, PENDING,
IN_PROGRESS
String message
A description of the status of the table restore request. Status values include SUCCEEDED,
FAILED, CANCELED, PENDING, IN_PROGRESS.
Date requestTime
The time that the table restore request was made, in Universal Coordinated Time (UTC).
Long progressInMegaBytes
The amount of data restored to the new table so far, in megabytes (MB).
Long totalDataInMegaBytes
The total amount of data to restore to the new table, in megabytes (MB).
String clusterIdentifier
The identifier of the Amazon Redshift cluster that the table is being restored to.
String snapshotIdentifier
The identifier of the snapshot that the table is being restored from.
String sourceDatabaseName
The name of the source database that contains the table being restored.
String sourceSchemaName
The name of the source schema that contains the table being restored.
String sourceTableName
The name of the source table being restored.
String targetDatabaseName
The name of the database to restore the table to.
String targetSchemaName
The name of the schema to restore the table to.
String newTableName
The name of the table to create as a result of the table restore request.
Tag tag
The tag for the resource.
String resourceName
The Amazon Resource Name (ARN) with which the tag is associated. For example,
arn:aws:redshift:us-east-1:123456789:cluster:t1.
String resourceType
The type of resource with which the tag is associated. Valid resource types are:
Cluster
CIDR/IP
EC2 security group
Snapshot
Cluster security group
Subnet group
HSM connection
HSM certificate
Parameter group
For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.
Copyright © 2018. All rights reserved.