String reservedNodeId
A string representing the node identifier of the DC1 Reserved Node to be exchanged.
String targetReservedNodeOfferingId
The unique identifier of the DC2 Reserved Node offering to be used for the exchange. You can obtain the value for the parameter by calling GetReservedNodeExchangeOfferings
String attributeName
The name of the attribute.
SdkInternalList<T> attributeValues
A list of attribute values.
String accountId
The identifier of an Amazon Web Services account authorized to restore a snapshot.
String accountAlias
The identifier of an Amazon Web Services support account authorized to restore a snapshot. For Amazon Web
Services Support, the identifier is amazon-redshift-support
.
String accountId
The Amazon Web Services account ID that owns the cluster.
String clusterIdentifier
The cluster identifier of the cluster that receives data from the partner.
String databaseName
The name of the database that receives data from the partner.
String partnerName
The name of the partner that is authorized to send data.
String aquaStatus
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
String aquaConfigurationStatus
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
String dataShareArn
The Amazon Resource Name (ARN) of the datashare that the consumer is to use with the account or the namespace.
Boolean associateEntireAccount
A value that specifies whether the datashare is associated with the entire account.
String consumerArn
The Amazon Resource Name (ARN) of the consumer that is associated with the datashare.
String consumerRegion
From a datashare consumer account, associates a datashare with all existing and future namespaces in the specified Amazon Web Services Region.
String dataShareArn
An Amazon Resource Name (ARN) that references the datashare that is owned by a specific namespace of the producer
cluster. A datashare ARN is in the
arn:aws:redshift:{region}:{account-id}:{datashare}:{namespace-guid}/{datashare-name}
format.
String producerArn
The Amazon Resource Name (ARN) of the producer.
Boolean allowPubliclyAccessibleConsumers
A value that specifies whether the datashare can be shared to a publicly accessible cluster.
SdkInternalList<T> dataShareAssociations
A value that specifies when the datashare has an association between producer and data consumers.
String managedBy
The identifier of a datashare to show its managing entity.
String customDomainCertificateArn
The Amazon Resource Name (ARN) for the certificate associated with the custom domain.
Date customDomainCertificateExpiryDate
The expiration date for the certificate.
SdkInternalList<T> certificateAssociations
A list of all associated clusters and domain names tied to a specific certificate.
String attributeValue
The value of the attribute.
String authenticationProfileName
The name of the authentication profile.
String authenticationProfileContent
The content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.
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 Amazon Web Services account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The Amazon Web Services Access Key ID is not an acceptable value.
Example: 111122223333
String dataShareArn
The Amazon Resource Name (ARN) of the datashare that producers are to authorize sharing for.
String consumerIdentifier
The identifier of the data consumer that is authorized to access the datashare. This identifier is an Amazon Web Services account ID or a keyword, such as ADX.
String dataShareArn
An Amazon Resource Name (ARN) that references the datashare that is owned by a specific namespace of the producer
cluster. A datashare ARN is in the
arn:aws:redshift:{region}:{account-id}:{datashare}:{namespace-guid}/{datashare-name}
format.
String producerArn
The Amazon Resource Name (ARN) of the producer.
Boolean allowPubliclyAccessibleConsumers
A value that specifies whether the datashare can be shared to a publicly accessible cluster.
SdkInternalList<T> dataShareAssociations
A value that specifies when the datashare has an association between producer and data consumers.
String managedBy
The identifier of a datashare to show its managing entity.
String clusterIdentifier
The cluster identifier of the cluster to grant access to.
String account
The Amazon Web Services account ID to grant access to.
SdkInternalList<T> vpcIds
The virtual private cloud (VPC) identifiers to grant access to.
String grantor
The Amazon Web Services account ID of the cluster owner.
String grantee
The Amazon Web Services account ID of the grantee of the cluster.
String clusterIdentifier
The cluster identifier.
Date authorizeTime
The time (UTC) when the authorization was created.
String clusterStatus
The status of the cluster.
String status
The status of the authorization action.
Boolean allowedAllVPCs
Indicates whether all VPCs in the grantee account are allowed access to the cluster.
SdkInternalList<T> allowedVPCs
The VPCs allowed access to the cluster.
Integer endpointCount
The number of Redshift-managed VPC endpoints created for the authorization.
String snapshotIdentifier
The identifier of the snapshot the account is authorized to restore.
String snapshotArn
The Amazon Resource Name (ARN) of the snapshot to authorize access to.
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 Amazon Web Services account authorized to restore the specified snapshot.
To share a snapshot with Amazon Web Services Support, specify amazon-redshift-support.
String name
The name of the availability zone.
SdkInternalList<T> supportedPlatforms
SdkInternalList<T> identifiers
A list of identifiers for the snapshots that you want to delete.
SdkInternalList<T> resources
A list of the snapshot identifiers that were deleted.
SdkInternalList<T> errors
A list of any errors returned.
SdkInternalList<T> snapshotIdentifierList
A list of snapshot identifiers you want to modify.
Integer manualSnapshotRetentionPeriod
The number of days that a manual snapshot is retained. If you specify the value -1, the manual snapshot is retained indefinitely.
The number must be either -1 or an integer between 1 and 3,653.
If you decrease the manual snapshot retention period from its current value, existing manual snapshots that fall outside of the new retention period will return an error. If you want to suppress the errors and delete the snapshots, use the force option.
Boolean force
A boolean value indicating whether to override an exception if the retention period has passed.
SdkInternalList<T> resources
A list of the snapshots that were modified.
SdkInternalList<T> errors
A list of any errors returned.
String clusterIdentifier
The unique identifier for the cluster that you want to cancel a resize operation for.
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
|
CANCELLING
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 resizeType
An enum with possible values of ClassicResize
and ElasticResize
. These values describe
the type of resize operation being performed.
String message
An optional string to provide additional details about the resize action.
String targetEncryptionType
The type of encryption for the cluster after the resize is complete.
Possible values are KMS
and None
.
Double dataTransferProgressPercent
The percent of data transferred from source cluster to target cluster.
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
available, prep-for-resize
available, resize-cleanup
cancelling-resize
creating
deleting
final-snapshot
hardware-failure
incompatible-hsm
incompatible-network
incompatible-parameters
incompatible-restore
modifying
paused
rebooting
renaming
resizing
rotating-keys
storage-full
updating-hsm
String clusterAvailabilityStatus
The availability status of the cluster for queries. Possible values are the following:
Available - The cluster is available for queries.
Unavailable - The cluster is not available for queries.
Maintenance - The cluster is intermittently available for queries due to maintenance activities.
Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.
Failed - The cluster failed and is not available for queries.
String modifyStatus
The status of a modify operation, if any, initiated for the cluster.
String masterUsername
The admin 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 dev
dev 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.
Integer manualSnapshotRetentionPeriod
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
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.
DataTransferProgress dataTransferProgress
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 Key Management Service (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 Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
SdkInternalList<T> pendingActions
Cluster operations that are waiting to be started.
String maintenanceTrackName
The name of the maintenance track for the cluster.
String elasticResizeNumberOfNodeOptions
The number of nodes that you can resize the cluster to with the elastic resize method.
SdkInternalList<T> deferredMaintenanceWindows
Describes a group of DeferredMaintenanceWindow
objects.
String snapshotScheduleIdentifier
A unique identifier for the cluster snapshot schedule.
String snapshotScheduleState
The current state of the cluster snapshot schedule.
Date expectedNextSnapshotScheduleTime
The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.
String expectedNextSnapshotScheduleTimeStatus
The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:
OnTrack - The next snapshot is expected to be taken on time.
Pending - The next snapshot is pending to be taken.
Date nextMaintenanceWindowStartTime
The date and time in UTC when system maintenance can begin.
ResizeInfo resizeInfo
Returns the following:
AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
ResizeType: Returns ClassicResize
String availabilityZoneRelocationStatus
Describes the status of the Availability Zone relocation operation.
String clusterNamespaceArn
The namespace Amazon Resource Name (ARN) of the cluster.
Long totalStorageCapacityInMegaBytes
The total storage capacity of the cluster in megabytes.
AquaConfiguration aquaConfiguration
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
String defaultIamRoleArn
The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
ReservedNodeExchangeStatus reservedNodeExchangeStatus
The status of the reserved-node exchange request. Statuses include in-progress and requested.
String customDomainName
The custom domain name associated with the cluster.
String customDomainCertificateArn
The certificate Amazon Resource Name (ARN) for the custom domain name.
Date customDomainCertificateExpiryDate
The expiration date for the certificate associated with the custom domain name.
String masterPasswordSecretArn
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
String masterPasswordSecretKmsKeyId
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
String ipAddressType
The IP address type for the cluster. Possible values are ipv4
and dualstack
.
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.
Integer manualSnapshotRetentionPeriod
The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
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.
SdkInternalList<T> supportedClusterIpAddressTypes
The IP address types supported by this cluster subnet group. Possible values are ipv4
and
dualstack
.
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 Amazon Web Services account that is making the request.
Integer manualSnapshotRetentionPeriod
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
String authenticationProfileName
The name of the authentication profile to be created.
String authenticationProfileContent
The content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.
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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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
| dc1.large
|
dc1.8xlarge
| dc2.large
| dc2.8xlarge
| ra3.xlplus
|
ra3.4xlarge
| ra3.16xlarge
String masterUsername
The user name associated with the admin user account for the cluster that is being created.
Constraints:
Must be 1 - 128 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.
The first character must be a letter.
Must not contain a colon (:) or a 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 masterUserPassword
The password associated with the admin user account for the cluster that is being created.
You can't use MasterUserPassword
if ManageMasterPassword
is true
.
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-126) except '
(single quote), "
(double quote), \
, /
, or @
.
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-2d
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.
You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.
Default: 1
Constraints: Must be a value from 0 to 35.
Integer manualSnapshotRetentionPeriod
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
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. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
SdkInternalList<T> tags
A list of tag instances.
String kmsKeyId
The 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 Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format.
The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.
String maintenanceTrackName
An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance
track name, the cluster is assigned to the current
track.
String snapshotScheduleIdentifier
A unique identifier for the snapshot schedule.
Boolean availabilityZoneRelocation
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.
String aquaConfigurationStatus
This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
String defaultIamRoleArn
The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.
String loadSampleData
A flag that specifies whether to load sample data once the cluster is created.
Boolean manageMasterPassword
If true
, Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials. You can't
use MasterUserPassword
if ManageMasterPassword
is true. If
ManageMasterPassword
is false or not set, Amazon Redshift uses MasterUserPassword
for
the admin user account's password.
String masterPasswordSecretKmsKeyId
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
You can only use this parameter if ManageMasterPassword
is true.
String ipAddressType
The IP address types that the cluster supports. Possible values are ipv4
and dualstack
.
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 Amazon Web Services 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 Amazon Web Services 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.
Integer manualSnapshotRetentionPeriod
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
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 Amazon Web Services 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 customDomainName
The custom domain name for a custom domain association.
String customDomainCertificateArn
The certificate Amazon Resource Name (ARN) for the custom domain name association.
String clusterIdentifier
The cluster identifier that the custom domain is associated with.
String customDomainName
The custom domain name for the association result.
String customDomainCertificateArn
The Amazon Resource Name (ARN) for the certificate associated with the custom domain name.
String clusterIdentifier
The identifier of the cluster that the custom domain is associated with.
String customDomainCertExpiryTime
The expiration time for the certificate for the custom domain.
String clusterIdentifier
The cluster identifier of the cluster to access.
String resourceOwner
The Amazon Web Services account ID of the owner of the cluster. This is only required if the cluster is in another Amazon Web Services account.
String endpointName
The Redshift-managed VPC endpoint name.
An endpoint name must contain 1-30 characters. Valid characters are A-Z, a-z, 0-9, and hyphen(-). The first character must be a letter. The name can't contain two consecutive hyphens or end with a hyphen.
String subnetGroupName
The subnet group from which Amazon Redshift chooses the subnet to deploy the endpoint.
SdkInternalList<T> vpcSecurityGroupIds
The security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
String clusterIdentifier
The cluster identifier of the cluster associated with the endpoint.
String resourceOwner
The Amazon Web Services account ID of the owner of the cluster.
String subnetGroupName
The subnet group name where Amazon Redshift chooses to deploy the endpoint.
String endpointStatus
The status of the endpoint.
String endpointName
The name of the endpoint.
Date endpointCreateTime
The time (UTC) that the endpoint was created.
Integer port
The port number on which the cluster accepts incoming connections.
String address
The DNS address of the endpoint.
SdkInternalList<T> vpcSecurityGroups
The security groups associated with the endpoint.
VpcEndpoint vpcEndpoint
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 Amazon Web Services account. You must specify a source type in order to specify source IDs.
Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.
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, pending
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, and set to false
to create
the subscription but not activate 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 scheduledActionName
The name of the scheduled action. The name must be unique within an account. For more information about this parameter, see ScheduledAction.
ScheduledActionType targetAction
A JSON format string of the Amazon Redshift API operation with input parameters. For more information about this parameter, see ScheduledAction.
String schedule
The schedule in at( )
or cron( )
format. For more information about this parameter, see
ScheduledAction.
String iamRole
The IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.
String scheduledActionDescription
The description of the scheduled action.
Date startTime
The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.
Date endTime
The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.
Boolean enable
If true, the schedule is enabled. If false, the scheduled action does not trigger. For more information about
state
of the scheduled action, see ScheduledAction.
String scheduledActionName
The name of the scheduled action.
ScheduledActionType targetAction
A JSON format string of the Amazon Redshift API operation with input parameters.
"
{\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}
".
String schedule
The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.
Format of at expressions is "at(yyyy-mm-ddThh:mm:ss)
". For example, "
at(2016-03-04T17:27:00)
".
Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year)
". For example, "cron(0 10 ? * MON *)
". For more information, see Cron Expressions in the Amazon
CloudWatch Events User Guide.
String iamRole
The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide.
String scheduledActionDescription
The description of the scheduled action.
String state
The state of the scheduled action. For example, DISABLED
.
SdkInternalList<T> nextInvocations
List of times when the scheduled action will run.
Date startTime
The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.
Date endTime
The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.
String snapshotCopyGrantName
The name of the snapshot copy grant. This name must be unique in the region for the Amazon Web Services 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 Amazon Web Services account.
String kmsKeyId
The unique identifier of the encrypted symmetric key 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.
SdkInternalList<T> scheduleDefinitions
The definition of the snapshot schedule. The definition is made up of schedule expressions, for example "cron(30 12 *)" or "rate(12 hours)".
String scheduleIdentifier
A unique identifier for a snapshot schedule. Only alphanumeric characters are allowed for the identifier.
String scheduleDescription
The description of the snapshot schedule.
SdkInternalList<T> tags
An optional set of tags you can use to search for the schedule.
Boolean dryRun
Integer nextInvocations
SdkInternalList<T> scheduleDefinitions
A list of ScheduleDefinitions.
String scheduleIdentifier
A unique identifier for the schedule.
String scheduleDescription
The description of the schedule.
SdkInternalList<T> tags
An optional set of tags describing the schedule.
SdkInternalList<T> nextInvocations
Integer associatedClusterCount
The number of clusters associated with the schedule.
SdkInternalList<T> associatedClusters
A list of clusters associated with the schedule. A maximum of 100 clusters is returned.
String resourceName
The Amazon Resource Name (ARN) to which you want to add the tag or tags. For example,
arn:aws:redshift:us-east-2: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 clusterIdentifier
The identifier of the cluster that you want to limit usage.
String featureType
The Amazon Redshift feature that you want to limit.
String limitType
The type of limit. Depending on the feature type, this can be based on a time duration or data size. If
FeatureType
is spectrum
, then LimitType
must be data-scanned
.
If FeatureType
is concurrency-scaling
, then LimitType
must be
time
. If FeatureType
is cross-region-datasharing
, then
LimitType
must be data-scanned
.
Long amount
The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB). The value must be a positive number.
String period
The time period that the amount applies to. A weekly
period begins on Sunday. The default is
monthly
.
String breachAction
The action that Amazon Redshift takes when the limit is reached. The default is log. For more information about this parameter, see UsageLimit.
SdkInternalList<T> tags
A list of tag instances.
String usageLimitId
The identifier of the usage limit.
String clusterIdentifier
The identifier of the cluster with a usage limit.
String featureType
The Amazon Redshift feature to which the limit applies.
String limitType
The type of limit. Depending on the feature type, this can be based on a time duration or data size.
Long amount
The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).
String period
The time period that the amount applies to. A weekly
period begins on Sunday. The default is
monthly
.
String breachAction
The action that Amazon Redshift takes when the limit is reached. Possible values are:
log - To log an event in a system table. The default is log.
emit-metric - To emit CloudWatch metrics.
disable - To disable the feature until the next usage period begins.
SdkInternalList<T> tags
A list of tag instances.
String dataShareArn
An Amazon Resource Name (ARN) that references the datashare that is owned by a specific namespace of the producer
cluster. A datashare ARN is in the
arn:aws:redshift:{region}:{account-id}:{datashare}:{namespace-guid}/{datashare-name}
format.
String producerArn
The Amazon Resource Name (ARN) of the producer.
Boolean allowPubliclyAccessibleConsumers
A value that specifies whether the datashare can be shared to a publicly accessible cluster.
SdkInternalList<T> dataShareAssociations
A value that specifies when the datashare has an association between producer and data consumers.
String managedBy
The identifier of a datashare to show its managing entity.
String consumerIdentifier
The name of the consumer accounts that have an association with a producer datashare.
String status
The status of the datashare that is associated.
String consumerRegion
The Amazon Web Services Region of the consumer accounts that have an association with a producer datashare.
Date createdDate
The creation date of the datashare that is associated.
Date statusChangeDate
The status change data of the datashare that is associated.
String status
Describes the status of the cluster. While the transfer is in progress the status is
transferringdata
.
Double currentRateInMegaBytesPerSecond
Describes the data transfer rate in MB's per second.
Long totalDataInMegaBytes
Describes the total amount of data to be transfered in megabytes.
Long dataTransferredInMegaBytes
Describes the total amount of data that has been transfered in MB's.
Long estimatedTimeToCompletionInSeconds
Describes the estimated number of seconds remaining to complete the transfer.
Long elapsedTimeInSeconds
Describes the number of seconds that have elapsed during the data transfer.
String dataShareArn
The Amazon Resource Name (ARN) of the datashare to remove authorization from.
String consumerIdentifier
The identifier of the data consumer that is to have authorization removed from the datashare. This identifier is an Amazon Web Services account ID or a keyword, such as ADX.
String dataShareArn
An Amazon Resource Name (ARN) that references the datashare that is owned by a specific namespace of the producer
cluster. A datashare ARN is in the
arn:aws:redshift:{region}:{account-id}:{datashare}:{namespace-guid}/{datashare-name}
format.
String producerArn
The Amazon Resource Name (ARN) of the producer.
Boolean allowPubliclyAccessibleConsumers
A value that specifies whether the datashare can be shared to a publicly accessible cluster.
SdkInternalList<T> dataShareAssociations
A value that specifies when the datashare has an association between producer and data consumers.
String managedBy
The identifier of a datashare to show its managing entity.
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 deferMaintenanceIdentifier
A unique identifier for the maintenance window.
Date deferMaintenanceStartTime
A timestamp for the beginning of the time period when we defer maintenance.
Date deferMaintenanceEndTime
A timestamp for the end of the time period when we defer maintenance.
String authenticationProfileName
The name of the authentication profile to delete.
String authenticationProfileName
The name of the authentication profile that was deleted.
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.
Integer finalClusterSnapshotRetentionPeriod
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
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
, failed
,
or cancelled
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 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
, failed
,
or cancelled
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 clusterIdentifier
The identifier of the cluster to delete a custom domain association for.
String endpointName
The Redshift-managed VPC endpoint to delete.
String clusterIdentifier
The cluster identifier of the cluster associated with the endpoint.
String resourceOwner
The Amazon Web Services account ID of the owner of the cluster.
String subnetGroupName
The subnet group name where Amazon Redshift chooses to deploy the endpoint.
String endpointStatus
The status of the endpoint.
String endpointName
The name of the endpoint.
Date endpointCreateTime
The time (UTC) that the endpoint was created.
Integer port
The port number on which the cluster accepts incoming connections.
String address
The DNS address of the endpoint.
SdkInternalList<T> vpcSecurityGroups
The security groups associated with the endpoint.
VpcEndpoint vpcEndpoint
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 accountId
The Amazon Web Services account ID that owns the cluster.
String clusterIdentifier
The cluster identifier of the cluster that receives data from the partner.
String databaseName
The name of the database that receives data from the partner.
String partnerName
The name of the partner that is authorized to send data.
String resourceArn
The Amazon Resource Name (ARN) of the resource of which its resource policy is deleted.
String scheduledActionName
The name of the scheduled action to delete.
String snapshotCopyGrantName
The name of the snapshot copy grant to delete.
String scheduleIdentifier
A unique identifier of the snapshot schedule 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-2:123456789:cluster:t1
.
SdkInternalList<T> tagKeys
The tag key that you want to delete.
String usageLimitId
The identifier of the usage limit to delete.
SdkInternalList<T> attributeNames
A list of attribute names.
SdkInternalList<T> accountAttributes
A list of attributes assigned to an account.
String authenticationProfileName
The name of the authentication profile to describe. If not specified then all authentication profiles owned by the account are listed.
SdkInternalList<T> authenticationProfiles
The list of authentication profiles.
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
, Amazon Web
Services 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
, Amazon Web
Services 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 must 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
, Amazon Web
Services 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 must 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 which generated the requested snapshots.
String snapshotIdentifier
The snapshot identifier of the snapshot about which to return information.
String snapshotArn
The Amazon Resource Name (ARN) of the snapshot associated with the message to describe cluster snapshots.
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
, Amazon Web
Services 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 Amazon Web Services 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 Amazon Web Services 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. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:
If ClusterExists
is set to true
, ClusterIdentifier
is required.
If ClusterExists
is set to false
and ClusterIdentifier
isn't specified,
all snapshots associated with deleted clusters (orphaned snapshots) are returned.
If ClusterExists
is set to false
and ClusterIdentifier
is specified for a
deleted cluster, snapshots associated with that cluster are returned.
If ClusterExists
is set to false
and ClusterIdentifier
is specified for an
existing cluster, no snapshots are returned.
SdkInternalList<T> sortingEntities
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
, Amazon Web Services
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
, Amazon Web
Services 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 maintenanceTrackName
The name of the maintenance track.
Integer maxRecords
An integer value for the maximum number of maintenance tracks to return.
String marker
An optional parameter that specifies the starting point to return a set of response records. When the results of
a DescribeClusterTracks
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> maintenanceTracks
A list of maintenance tracks output by the DescribeClusterTracks
operation.
String marker
The starting point to return a set of response tracklist records. You can retrieve the next set of response
records by providing the returned marker value in the Marker
parameter and retrying the request.
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
, Amazon Web
Services 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 customDomainName
The custom domain name for the custom domain association.
String customDomainCertificateArn
The certificate Amazon Resource Name (ARN) for the custom domain association.
Integer maxRecords
The maximum records setting for the associated custom domain.
String marker
The marker for the custom domain association.
String marker
The marker for the custom domain association.
SdkInternalList<T> associations
The associations for the custom domain.
String consumerArn
The Amazon Resource Name (ARN) of the consumer that returns in the list of datashares.
String status
An identifier giving the status of a datashare in the consumer cluster. If this field is specified, Amazon Redshift returns the list of datashares that have the specified status.
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.
String marker
An optional parameter that specifies the starting point to return a set of response records. When the results of
a DescribeDataSharesForConsumer request exceed the value specified in MaxRecords
, Amazon Web
Services 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> dataShares
Shows the results of datashares available for consumers.
String marker
An optional parameter that specifies the starting point to return a set of response records. When the results of
a DescribeDataSharesForConsumer request exceed the value specified in MaxRecords
, Amazon Web
Services 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 producerArn
The Amazon Resource Name (ARN) of the producer that returns in the list of datashares.
String status
An identifier giving the status of a datashare in the producer. If this field is specified, Amazon Redshift returns the list of datashares that have the specified status.
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.
String marker
An optional parameter that specifies the starting point to return a set of response records. When the results of
a DescribeDataSharesForProducer request exceed the value specified in MaxRecords
, Amazon Web
Services 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> dataShares
Shows the results of datashares available for producers.
String marker
An optional parameter that specifies the starting point to return a set of response records. When the results of
a DescribeDataSharesForProducer request exceed the value specified in MaxRecords
, Amazon Web
Services 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 dataShareArn
The identifier of the datashare to describe details of.
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.
String marker
An optional parameter that specifies the starting point to return a set of response records. When the results of
a DescribeDataShares request exceed the value specified in MaxRecords
, Amazon Web Services
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> dataShares
The results returned from describing datashares.
String marker
An optional parameter that specifies the starting point to return a set of response records. When the results of
a DescribeDataShares request exceed the value specified in MaxRecords
, Amazon Web Services
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 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
, Amazon
Web Services 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 clusterIdentifier
The cluster identifier associated with the described endpoint.
String resourceOwner
The Amazon Web Services account ID of the owner of the cluster.
String endpointName
The name of the endpoint to be described.
String vpcId
The virtual private cloud (VPC) identifier with access to the cluster.
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 DescribeEndpointAccess
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> endpointAccessList
The list of endpoints with access to the cluster.
String marker
An optional pagination token provided by a previous DescribeEndpointAccess
request. If this
parameter is specified, the response includes only records beyond the marker, up to the value specified by the
MaxRecords
parameter.
String clusterIdentifier
The cluster identifier of the cluster to access.
String account
The Amazon Web Services account ID of either the cluster owner (grantor) or grantee. If Grantee
parameter is true, then the Account
value is of the grantor.
Boolean grantee
Indicates whether to check authorization from a grantor or grantee point of view. If true, Amazon Redshift returns endpoint authorizations that you've been granted. If false (default), checks authorization from a grantor point of view.
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 DescribeEndpointAuthorization
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> endpointAuthorizationList
The authorizations to an endpoint.
String marker
An optional pagination token provided by a previous DescribeEndpointAuthorization
request. If this
parameter is specified, the response includes only records beyond the marker, up to the value specified by the
MaxRecords
parameter.
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, cluster-security-group, and scheduled-action.
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
, Amazon Web Services
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
, Amazon Web Services
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 Amazon Web Services 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
, Amazon Web
Services 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 Amazon Web Services 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
, Amazon Web
Services 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 integrationArn
The Amazon Resource Name (ARN) of the inbound integration.
String targetArn
The Amazon Resource Name (ARN) of the target of an inbound integration.
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 DescribeInboundIntegrations request exceed the value specified in MaxRecords
, Amazon Web
Services 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> inboundIntegrations
A list of InboundIntegration instances.
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 logDestinationType
The log destination type. An enum with possible values of s3
and cloudwatch
.
SdkInternalList<T> logExports
The collection of exported log types. Possible values are connectionlog
,
useractivitylog
, and userlog
.
String actionType
The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration combinations for elastic resize based on an existing cluster.
String clusterIdentifier
The identifier of the cluster to evaluate for possible node configurations.
String snapshotIdentifier
The identifier of the snapshot to evaluate for possible node configurations.
String snapshotArn
The Amazon Resource Name (ARN) of the snapshot associated with the message to describe node configuration.
String ownerAccount
The Amazon Web Services 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.
SdkInternalList<T> filters
A set of name, operator, and value items to filter the results.
String marker
An optional parameter that specifies the starting point to return a set of response records. When the results of
a DescribeNodeConfigurationOptions request exceed the value specified in MaxRecords
, Amazon
Web Services 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.
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: 500
Constraints: minimum 100, maximum 500.
SdkInternalList<T> nodeConfigurationOptionList
A list of valid node configurations.
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 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
, Amazon
Web Services 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 accountId
The Amazon Web Services account ID that owns the cluster.
String clusterIdentifier
The cluster identifier of the cluster whose partner integration is being described.
String databaseName
The name of the database whose partner integration is being described. If database name is not specified, then all databases in the cluster are described.
String partnerName
The name of the partner that is being described. If partner name is not specified, then all partner integrations are described.
SdkInternalList<T> partnerIntegrationInfoList
A list of partner integrations.
String reservedNodeId
The identifier of the source reserved node in a reserved-node exchange request.
String reservedNodeExchangeRequestId
The identifier of the reserved-node exchange request.
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.
String marker
An optional pagination token provided by a previous DescribeReservedNodeExchangeStatus
request. If
this parameter is specified, the response includes only records beyond the marker, up to the value specified by
the MaxRecords
parameter. 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> reservedNodeExchangeStatusDetails
The details of the reserved-node exchange request, including the status, request time, source reserved-node identifier, and additional details.
String marker
A pagination token provided by a previous DescribeReservedNodeExchangeStatus
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
, Amazon Web
Services 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
, Amazon Web Services
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 Amazon Web Services 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
|
CANCELLING
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 resizeType
An enum with possible values of ClassicResize
and ElasticResize
. These values describe
the type of resize operation being performed.
String message
An optional string to provide additional details about the resize action.
String targetEncryptionType
The type of encryption for the cluster after the resize is complete.
Possible values are KMS
and None
.
Double dataTransferProgressPercent
The percent of data transferred from source cluster to target cluster.
String scheduledActionName
The name of the scheduled action to retrieve.
String targetActionType
The type of the scheduled actions to retrieve.
Date startTime
The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations after this time are retrieved.
Date endTime
The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.
Boolean active
If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
SdkInternalList<T> filters
List of scheduled action filters.
String marker
An optional parameter that specifies the starting point to return a set of response records. When the results of
a DescribeScheduledActions request exceed the value specified in MaxRecords
, Amazon Web
Services 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.
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 DescribeScheduledActions request exceed the value specified in MaxRecords
, Amazon Web
Services 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> scheduledActions
List of retrieved scheduled actions.
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
, Amazon
Web Services 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
, Amazon
Web Services 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 unique identifier for the cluster whose snapshot schedules you want to view.
String scheduleIdentifier
A unique identifier for a snapshot schedule.
SdkInternalList<T> tagKeys
The key value for a snapshot schedule tag.
SdkInternalList<T> tagValues
The value corresponding to the key of the snapshot schedule tag.
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.
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.
SdkInternalList<T> snapshotSchedules
A list of SnapshotSchedules.
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 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-2: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 usageLimitId
The identifier of the usage limit to describe.
String clusterIdentifier
The identifier of the cluster for which you want to describe usage limits.
String featureType
The feature type for which you want to describe usage limits.
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 DescribeUsageLimits request exceed the value specified in MaxRecords
, Amazon Web Services
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 usage limit objects 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 usage limit objects 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 usage limit objects 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 usage limit objects that have either or both of these tag values associated
with them.
SdkInternalList<T> usageLimits
Contains the output from the DescribeUsageLimits action.
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 logDestinationType
The log destination type. An enum with possible values of s3
and cloudwatch
.
SdkInternalList<T> logExports
The collection of exported log types. Possible values are connectionlog
,
useractivitylog
, and userlog
.
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 dataShareArn
The Amazon Resource Name (ARN) of the datashare to remove association for.
Boolean disassociateEntireAccount
A value that specifies whether association for the datashare is removed from the entire account.
String consumerArn
The Amazon Resource Name (ARN) of the consumer that association for the datashare is removed from.
String consumerRegion
From a datashare consumer account, removes association of a datashare from all the existing and future namespaces in the specified Amazon Web Services Region.
String dataShareArn
An Amazon Resource Name (ARN) that references the datashare that is owned by a specific namespace of the producer
cluster. A datashare ARN is in the
arn:aws:redshift:{region}:{account-id}:{datashare}:{namespace-guid}/{datashare-name}
format.
String producerArn
The Amazon Resource Name (ARN) of the producer.
Boolean allowPubliclyAccessibleConsumers
A value that specifies whether the datashare can be shared to a publicly accessible cluster.
SdkInternalList<T> dataShareAssociations
A value that specifies when the datashare has an association between producer and data consumers.
String managedBy
The identifier of a datashare to show its managing entity.
String status
The status of the EC2 security group.
String eC2SecurityGroupName
The name of the EC2 Security Group.
String eC2SecurityGroupOwnerId
The Amazon Web Services account 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
String logDestinationType
The log destination type. An enum with possible values of s3
and cloudwatch
.
SdkInternalList<T> logExports
The collection of exported log types. Possible values are connectionlog
,
useractivitylog
, and userlog
.
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 logDestinationType
The log destination type. An enum with possible values of s3
and cloudwatch
.
SdkInternalList<T> logExports
The collection of exported log types. Possible values are connectionlog
,
useractivitylog
, and userlog
.
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 Amazon Web Services Region that you want to copy snapshots to.
Constraints: Must be the name of a valid Amazon Web Services 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 Amazon Web Services KMS-encrypted cluster are copied to the destination region.
Integer manualSnapshotRetentionPeriod
The number of days to retain newly copied snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
String address
The DNS address of the Cluster.
Integer port
The port that the database engine is listening on.
SdkInternalList<T> vpcEndpoints
Describes a connection endpoint.
String clusterIdentifier
The cluster identifier of the cluster associated with the endpoint.
String resourceOwner
The Amazon Web Services account ID of the owner of the cluster.
String subnetGroupName
The subnet group name where Amazon Redshift chooses to deploy the endpoint.
String endpointStatus
The status of the endpoint.
String endpointName
The name of the endpoint.
Date endpointCreateTime
The time (UTC) that the endpoint was created.
Integer port
The port number on which the cluster accepts incoming connections.
String address
The DNS address of the endpoint.
SdkInternalList<T> vpcSecurityGroups
The security groups associated with the endpoint.
VpcEndpoint vpcEndpoint
String grantor
The Amazon Web Services account ID of the cluster owner.
String grantee
The Amazon Web Services account ID of the grantee of the cluster.
String clusterIdentifier
The cluster identifier.
Date authorizeTime
The time (UTC) when the authorization was created.
String clusterStatus
The status of the cluster.
String status
The status of the authorization action.
Boolean allowedAllVPCs
Indicates whether all VPCs in the grantee account are allowed access to the cluster.
SdkInternalList<T> allowedVPCs
The VPCs allowed access to the cluster.
Integer endpointCount
The number of Redshift-managed VPC endpoints created for the authorization.
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, Pending
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 Amazon Web Services 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 by the Amazon Redshift event notification, such as cluster, cluster-snapshot, cluster-parameter-group, cluster-security-group, or scheduled-action.
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, Pending
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 that 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 uppercase or 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 uppercase or 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 you 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 customDomainName
The custom domain name for the cluster credentials.
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
permissions 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 dbName
The name of the database for which you are requesting credentials. If the database name is specified, the IAM
policy must allow access to the resource dbname
for the specified database name. If the database
name is not specified, access to all databases is allowed.
String clusterIdentifier
The unique identifier of the cluster that contains the database for which you are requesting credentials.
Integer durationSeconds
The number of seconds until the returned temporary password expires.
Range: 900-3600. Default: 900.
String customDomainName
The custom domain name for the IAM message cluster credentials.
String dbUser
A database user name that you provide when you connect to a database. The database user is mapped 1:1 to the source IAM identity.
String dbPassword
A temporary password that you provide when you connect to a database.
Date expiration
The time (UTC) when the temporary password expires. After this timestamp, a log in with the temporary password fails.
Date nextRefreshTime
Reserved for future use.
String actionType
The action type of the reserved-node configuration. The action type can be an exchange initiated from either a snapshot or a resize.
String clusterIdentifier
The identifier for the cluster that is the source for a reserved-node exchange.
String snapshotIdentifier
The identifier for the snapshot that is the source for the reserved-node exchange.
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.
String marker
An optional pagination token provided by a previous GetReservedNodeExchangeConfigurationOptions
request. If this parameter is specified, the response includes only records beyond the marker, up to the value
specified by the MaxRecords
parameter. 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 pagination token provided by a previous GetReservedNodeExchangeConfigurationOptions
request.
SdkInternalList<T> reservedNodeConfigurationOptionList
the configuration options for the reserved-node exchange. These options include information about the source reserved node and target reserved node. Details include the node type, the price, the node count, and the offering type.
String reservedNodeId
A string representing the node identifier for the DC1 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 resourceArn
The Amazon Resource Name (ARN) of the resource of which its resource policy is fetched.
ResourcePolicy resourcePolicy
The content of the resource policy.
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 integrationArn
The Amazon Resource Name (ARN) of an inbound integration.
String sourceArn
The Amazon Resource Name (ARN) of the source of an inbound integration.
String targetArn
The Amazon Resource Name (ARN) of the target of an inbound integration.
String status
The status of an inbound integration.
SdkInternalList<T> errors
The outstanding errors of an inbound integration. Each item is an "IntegrationError". This is null if there is no error.
Date createTime
The creation time of an inbound integration.
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 maintenanceTrackName
The name of the maintenance track. Possible values are current
and trailing
.
String databaseVersion
The version number for the cluster release.
SdkInternalList<T> updateTargets
An array of UpdateTarget objects to update with the maintenance track.
AquaConfiguration aquaConfiguration
This parameter is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
String authenticationProfileName
The name of the authentication profile to replace.
String authenticationProfileContent
The new content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.
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.
SdkInternalList<T> removeIamRoles
Zero or more IAM roles in ARN format to disassociate from the cluster.
String defaultIamRoleArn
The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was last modified.
String clusterIdentifier
A unique identifier for the cluster.
Boolean deferMaintenance
A boolean indicating whether to enable the deferred maintenance window.
String deferMaintenanceIdentifier
A unique identifier for the deferred maintenance window.
Date deferMaintenanceStartTime
A timestamp indicating the start time for the deferred maintenance window.
Date deferMaintenanceEndTime
A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.
Integer deferMaintenanceDuration
An integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less.
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.
For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
Valid Values: ds2.xlarge
| ds2.8xlarge
| dc1.large
|
dc1.8xlarge
| dc2.large
| dc2.8xlarge
| ra3.xlplus
|
ra3.4xlarge
| ra3.16xlarge
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.
For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
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 admin 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.
You can't use MasterUserPassword
if ManageMasterPassword
is true
.
Operations never return the password, so this operation provides a way to regain access to the admin 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-126) except '
(single quote), "
(double quote), \
, /
, or @
.
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.
You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.
Default: Uses existing setting.
Constraints: Must be a value from 0 to 35.
Integer manualSnapshotRetentionPeriod
The default for number of days that a newly created manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. This value doesn't retroactively change the retention periods of existing manual snapshots.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
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 Amazon Web Services 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 maintenanceTrackName
The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The
new track name stays in the PendingModifiedValues
for the cluster until the next maintenance window.
When the maintenance track changes, the cluster is switched to the latest cluster release available for the
maintenance track. At this point, the maintenance track name is applied.
Boolean encrypted
Indicates whether the cluster is encrypted. If the value is encrypted (true) and you provide a value for the
KmsKeyId
parameter, we encrypt the cluster with the provided KmsKeyId
. If you don't
provide a KmsKeyId
, we encrypt with the default key.
If the value is not encrypted (false), then the cluster is decrypted.
String kmsKeyId
The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
Boolean availabilityZoneRelocation
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.
String availabilityZone
The option to initiate relocation for an Amazon Redshift cluster to the target Availability Zone.
Integer port
The option to change the port of an Amazon Redshift cluster.
Boolean manageMasterPassword
If true
, Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials. You can't
use MasterUserPassword
if ManageMasterPassword
is true. If
ManageMasterPassword
is false or not set, Amazon Redshift uses MasterUserPassword
for
the admin user account's password.
String masterPasswordSecretKmsKeyId
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
You can only use this parameter if ManageMasterPassword
is true.
String ipAddressType
The IP address types that the cluster supports. Possible values are ipv4
and dualstack
.
String snapshotIdentifier
The identifier of the snapshot whose setting you want to modify.
Integer manualSnapshotRetentionPeriod
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
If the manual snapshot falls outside of the new retention period, you can specify the force option to immediately delete the snapshot.
The value must be either -1 or an integer between 1 and 3,653.
Boolean force
A Boolean option to override an exception if the retention period has already passed.
String clusterIdentifier
A unique identifier for the cluster whose snapshot schedule you want to modify.
String scheduleIdentifier
A unique alphanumeric identifier for the schedule that you want to associate with the cluster.
Boolean disassociateSchedule
A boolean to indicate whether to remove the assoiciation between the cluster and the schedule.
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 customDomainName
The custom domain name for a changed custom domain association.
String customDomainCertificateArn
The certificate Amazon Resource Name (ARN) for the changed custom domain association.
String clusterIdentifier
The identifier of the cluster to change a custom domain association for.
String customDomainName
The custom domain name associated with the result for the changed custom domain association.
String customDomainCertificateArn
The certificate Amazon Resource Name (ARN) associated with the result for the changed custom domain association.
String clusterIdentifier
The identifier of the cluster associated with the result for the changed custom domain association.
String customDomainCertExpiryTime
The certificate expiration time associated with the result for the changed custom domain association.
String endpointName
The endpoint to be modified.
SdkInternalList<T> vpcSecurityGroupIds
The complete list of VPC security groups associated with the endpoint after the endpoint is modified.
String clusterIdentifier
The cluster identifier of the cluster associated with the endpoint.
String resourceOwner
The Amazon Web Services account ID of the owner of the cluster.
String subnetGroupName
The subnet group name where Amazon Redshift chooses to deploy the endpoint.
String endpointStatus
The status of the endpoint.
String endpointName
The name of the endpoint.
Date endpointCreateTime
The time (UTC) that the endpoint was created.
Integer port
The port number on which the cluster accepts incoming connections.
String address
The DNS address of the endpoint.
SdkInternalList<T> vpcSecurityGroups
The security groups associated with the endpoint.
VpcEndpoint vpcEndpoint
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 Amazon Web Services account. You must specify a source type in order to specify source IDs.
Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.
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, pending
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 scheduledActionName
The name of the scheduled action to modify.
ScheduledActionType targetAction
A modified JSON format of the scheduled action. For more information about this parameter, see ScheduledAction.
String schedule
A modified schedule in either at( )
or cron( )
format. For more information about this
parameter, see ScheduledAction.
String iamRole
A different IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.
String scheduledActionDescription
A modified description of the scheduled action.
Date startTime
A modified start time of the scheduled action. For more information about this parameter, see ScheduledAction.
Date endTime
A modified end time of the scheduled action. For more information about this parameter, see ScheduledAction.
Boolean enable
A modified enable flag of the scheduled action. If true, the scheduled action is active. If false, the scheduled action is disabled.
String scheduledActionName
The name of the scheduled action.
ScheduledActionType targetAction
A JSON format string of the Amazon Redshift API operation with input parameters.
"
{\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}
".
String schedule
The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.
Format of at expressions is "at(yyyy-mm-ddThh:mm:ss)
". For example, "
at(2016-03-04T17:27:00)
".
Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year)
". For example, "cron(0 10 ? * MON *)
". For more information, see Cron Expressions in the Amazon
CloudWatch Events User Guide.
String iamRole
The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide.
String scheduledActionDescription
The description of the scheduled action.
String state
The state of the scheduled action. For example, DISABLED
.
SdkInternalList<T> nextInvocations
List of times when the scheduled action will run.
Date startTime
The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.
Date endTime
The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.
String clusterIdentifier
The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination Amazon Web Services 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 Amazon Web Services Region after they are copied from the source Amazon Web Services Region.
By default, this only changes the retention period of copied automated snapshots.
If you decrease the retention period for automated snapshots that are copied to a destination Amazon Web Services Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination Amazon Web Services Region and that fall outside of the new retention period.
Constraints: Must be at least 1 and no more than 35 for automated snapshots.
If you specify the manual
option, only newly copied manual snapshots will have the new retention
period.
If you specify the value of -1 newly copied manual snapshots are retained indefinitely.
Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.
Boolean manual
Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
String scheduleIdentifier
A unique alphanumeric identifier of the schedule to modify.
SdkInternalList<T> scheduleDefinitions
An updated list of schedule definitions. A schedule definition is made up of schedule expressions, for example, "cron(30 12 *)" or "rate(12 hours)".
SdkInternalList<T> scheduleDefinitions
A list of ScheduleDefinitions.
String scheduleIdentifier
A unique identifier for the schedule.
String scheduleDescription
The description of the schedule.
SdkInternalList<T> tags
An optional set of tags describing the schedule.
SdkInternalList<T> nextInvocations
Integer associatedClusterCount
The number of clusters associated with the schedule.
SdkInternalList<T> associatedClusters
A list of clusters associated with the schedule. A maximum of 100 clusters is returned.
String usageLimitId
The identifier of the usage limit to modify.
Long amount
The new limit amount. For more information about this parameter, see UsageLimit.
String breachAction
The new action that Amazon Redshift takes when the limit is reached. For more information about this parameter, see UsageLimit.
String usageLimitId
The identifier of the usage limit.
String clusterIdentifier
The identifier of the cluster with a usage limit.
String featureType
The Amazon Redshift feature to which the limit applies.
String limitType
The type of limit. Depending on the feature type, this can be based on a time duration or data size.
Long amount
The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).
String period
The time period that the amount applies to. A weekly
period begins on Sunday. The default is
monthly
.
String breachAction
The action that Amazon Redshift takes when the limit is reached. Possible values are:
log - To log an event in a system table. The default is log.
emit-metric - To emit CloudWatch metrics.
disable - To disable the feature until the next usage period begins.
SdkInternalList<T> tags
A list of tag instances.
String networkInterfaceId
The network interface identifier.
String subnetId
The subnet identifier.
String privateIpAddress
The IPv4 address of the network interface within the subnet.
String availabilityZone
The Availability Zone.
String ipv6Address
The IPv6 address of the network interface within the subnet.
String nodeType
The node type, such as, "ds2.8xlarge".
Integer numberOfNodes
The number of nodes.
Double estimatedDiskUtilizationPercent
The estimated disk utilizaton percentage.
String mode
The category of the node configuration recommendation.
String name
The name of the element to filter.
String operator
The filter operator. If filter Name is NodeType only the 'in' operator is supported. Provide one value to evaluate for 'eq', 'lt', 'le', 'gt', and 'ge'. Provide two values to evaluate for 'between'. Provide a list of values for 'in'.
SdkInternalList<T> values
List of values. Compare Name using Operator to Values. If filter Name is NumberOfNodes, then values can range from 0 to 200. If filter Name is EstimatedDiskUtilizationPercent, then values can range from 0 to 100. For example, filter NumberOfNodes (name) GT (operator) 3 (values).
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. If ParameterName
is wlm_json_configuration
, then the
maximum size of ParameterValue
is 8000 characters.
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 databaseName
The name of the database that receives data from a partner.
String partnerName
The name of the partner.
String status
The partner integration status.
String statusMessage
The status message provided by the partner.
Date createdAt
The date (UTC) that the partner integration was created.
Date updatedAt
The date (UTC) that the partner integration status was last updated by the partner.
String clusterIdentifier
The identifier of the cluster to be paused.
String clusterIdentifier
The identifier of the cluster to be paused.
String masterUserPassword
The pending or in-progress change of the admin 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 maintenanceTrackName
The name of the maintenance track that the cluster will change to during the next maintenance window.
String encryptionType
The encryption type for a cluster. Possible values are: KMS and None.
ResourcePolicy resourcePolicy
The content of the updated resource policy.
String clusterIdentifier
The cluster identifier.
String dataShareArn
The Amazon Resource Name (ARN) of the datashare to reject.
String dataShareArn
An Amazon Resource Name (ARN) that references the datashare that is owned by a specific namespace of the producer
cluster. A datashare ARN is in the
arn:aws:redshift:{region}:{account-id}:{datashare}:{namespace-guid}/{datashare-name}
format.
String producerArn
The Amazon Resource Name (ARN) of the producer.
Boolean allowPubliclyAccessibleConsumers
A value that specifies whether the datashare can be shared to a publicly accessible cluster.
SdkInternalList<T> dataShareAssociations
A value that specifies when the datashare has an association between producer and data consumers.
String managedBy
The identifier of a datashare to show its managing entity.
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
ReservedNode sourceReservedNode
Integer targetReservedNodeCount
The target reserved-node count.
ReservedNodeOffering targetReservedNodeOffering
String reservedNodeExchangeRequestId
The identifier of the reserved-node exchange request.
String status
The status of the reserved-node exchange request. Statuses include in-progress and requested.
Date requestTime
A date and time that indicate when the reserved-node exchange was requested.
String sourceReservedNodeId
The identifier of the source reserved node.
String sourceReservedNodeType
The source reserved-node type, for example ds2.xlarge.
Integer sourceReservedNodeCount
The source reserved-node count in the cluster.
String targetReservedNodeOfferingId
The identifier of the target reserved node offering.
String targetReservedNodeType
The node type of the target reserved node, for example ra3.4xlarge.
Integer targetReservedNodeCount
The count of target reserved nodes in the cluster.
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 unique identifier for the cluster to resize.
String clusterType
The new cluster type for the specified cluster.
String nodeType
The new node type for the nodes you are adding. If not specified, the cluster's current node type is used.
Integer numberOfNodes
The new number of nodes for the cluster. If not specified, the cluster's current number of nodes is used.
Boolean classic
A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide
this parameter or set the value to false
, the resize type is elastic.
String reservedNodeId
The identifier of the reserved node.
String targetReservedNodeOfferingId
The identifier of the target reserved node offering.
String clusterIdentifier
The unique identifier for the cluster to resize.
String clusterType
The new cluster type for the specified cluster.
String nodeType
The new node type for the nodes you are adding. If not specified, the cluster's current node type is used.
Integer numberOfNodes
The new number of nodes for the cluster. If not specified, the cluster's current number of nodes is used.
Boolean classic
A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide
this parameter or set the value to false
, the resize type is elastic.
String reservedNodeId
The identifier of the reserved node.
String targetReservedNodeOfferingId
The identifier of the target reserved node offering.
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 Amazon Web Services account.
String snapshotIdentifier
The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. You must
specify this parameter or snapshotArn
, but not both.
Example: my-snapshot-id
String snapshotArn
The Amazon Resource Name (ARN) of the snapshot associated with the message to restore from a cluster. You must
specify this parameter or snapshotIdentifier
, but not both.
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-2a
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 Amazon Web Services 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. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on.
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.
You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.
Default: The value selected for the cluster from which the snapshot was taken.
Constraints: Must be a value from 0 to 35.
Integer manualSnapshotRetentionPeriod
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
String kmsKeyId
The Key Management Service (KMS) key ID of the encryption key that encrypts data in the cluster restored from a shared snapshot. You can also provide the key ID when you restore from an unencrypted snapshot to an encrypted cluster in the same account. Additionally, you can specify a new KMS key ID when you restore from an encrypted snapshot in the same account in order to change it. In that case, the restored cluster is encrypted with the new KMS key ID.
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.8xlarge 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 Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format.
The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.
String maintenanceTrackName
The name of the maintenance track for the restored cluster. When you take a snapshot, the snapshot inherits the
MaintenanceTrack
value from the cluster. The snapshot might be on a different track than the cluster
that was the source for the snapshot. For example, suppose that you take a snapshot of a cluster that is on the
current track and then change the cluster to be on the trailing track. In this case, the snapshot and the source
cluster are on different tracks.
String snapshotScheduleIdentifier
A unique identifier for the snapshot schedule.
Integer numberOfNodes
The number of nodes specified when provisioning the restored cluster.
Boolean availabilityZoneRelocation
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is restored.
String aquaConfigurationStatus
This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
String defaultIamRoleArn
The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was last modified while it was restored from a snapshot.
String reservedNodeId
The identifier of the target reserved node offering.
String targetReservedNodeOfferingId
The identifier of the target reserved node offering.
Boolean encrypted
Enables support for restoring an unencrypted snapshot to a cluster encrypted with Key Management Service (KMS) and a customer managed key.
Boolean manageMasterPassword
If true
, Amazon Redshift uses Secrets Manager to manage the restored cluster's admin credentials. If
ManageMasterPassword
is false or not set, Amazon Redshift uses the admin credentials the cluster had
at the time the snapshot was taken.
String masterPasswordSecretKmsKeyId
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
You can only use this parameter if ManageMasterPassword
is true.
String ipAddressType
The IP address type for the cluster. Possible values are ipv4
and dualstack
.
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. This field is only updated when you restore to DC2 and DS2 node types.
Long snapshotSizeInMegaBytes
The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.
Long progressInMegaBytes
The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.
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. This field is only updated when you restore to DC2 and DS2 node types.
Long estimatedTimeToCompletionInSeconds
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.
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.
Boolean enableCaseSensitiveIdentifier
Indicates whether name identifiers for database, schema, and table are case sensitive. If true
, the
names are case sensitive. If false
(default), the names are not case sensitive.
String clusterIdentifier
The identifier of the cluster to be resumed.
String clusterIdentifier
The identifier of the cluster to be resumed.
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 Amazon Web Services account number of the owner of the security group specified in the
EC2SecurityGroupName
parameter. The Amazon Web Services 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 clusterIdentifier
The cluster to revoke access from.
String account
The Amazon Web Services account ID whose access is to be revoked.
SdkInternalList<T> vpcIds
The virtual private cloud (VPC) identifiers for which access is to be revoked.
Boolean force
Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.
String grantor
The Amazon Web Services account ID of the cluster owner.
String grantee
The Amazon Web Services account ID of the grantee of the cluster.
String clusterIdentifier
The cluster identifier.
Date authorizeTime
The time (UTC) when the authorization was created.
String clusterStatus
The status of the cluster.
String status
The status of the authorization action.
Boolean allowedAllVPCs
Indicates whether all VPCs in the grantee account are allowed access to the cluster.
SdkInternalList<T> allowedVPCs
The VPCs allowed access to the cluster.
Integer endpointCount
The number of Redshift-managed VPC endpoints created for the authorization.
String snapshotIdentifier
The identifier of the snapshot that the account can no longer access.
String snapshotArn
The Amazon Resource Name (ARN) of the snapshot associated with the message to revoke 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 Amazon Web Services 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 scheduledActionName
The name of the scheduled action.
ScheduledActionType targetAction
A JSON format string of the Amazon Redshift API operation with input parameters.
"
{\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}
".
String schedule
The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.
Format of at expressions is "at(yyyy-mm-ddThh:mm:ss)
". For example, "
at(2016-03-04T17:27:00)
".
Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year)
". For example, "cron(0 10 ? * MON *)
". For more information, see Cron Expressions in the Amazon
CloudWatch Events User Guide.
String iamRole
The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide.
String scheduledActionDescription
The description of the scheduled action.
String state
The state of the scheduled action. For example, DISABLED
.
SdkInternalList<T> nextInvocations
List of times when the scheduled action will run.
Date startTime
The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.
Date endTime
The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.
String name
The type of element to filter.
SdkInternalList<T> values
List of values. Compare if the value (of type defined by Name
) equals an item in the list of
scheduled actions.
ResizeClusterMessage resizeCluster
An action that runs a ResizeCluster
API operation.
PauseClusterMessage pauseCluster
An action that runs a PauseCluster
API operation.
ResumeClusterMessage resumeCluster
An action that runs a ResumeCluster
API operation.
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 (in UTC format) 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 admin user name for the cluster.
String clusterVersion
The version ID of the Amazon Redshift engine that is running on the cluster.
String engineFullVersion
The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.
String snapshotType
The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are 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 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 Amazon Web Services 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 Amazon Web Services 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 maintenanceTrackName
The name of the maintenance track for the snapshot.
Integer manualSnapshotRetentionPeriod
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
Integer manualSnapshotRemainingDays
The number of days until a manual snapshot will pass its retention period.
Date snapshotRetentionStartTime
A timestamp representing the start of the retention period for the snapshot.
String masterPasswordSecretArn
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
String masterPasswordSecretKmsKeyId
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
String snapshotCopyGrantName
The name of the snapshot copy grant.
String kmsKeyId
The unique identifier of the encrypted symmetric key in Amazon Web Services KMS to which Amazon Redshift is granted permission.
SdkInternalList<T> tags
A list of tag instances.
String snapshotIdentifier
A unique identifier for the snapshot returning the error.
String snapshotClusterIdentifier
A unique identifier for the cluster.
String failureCode
The failure code for the error.
String failureReason
The text message describing the error.
SdkInternalList<T> scheduleDefinitions
A list of ScheduleDefinitions.
String scheduleIdentifier
A unique identifier for the schedule.
String scheduleDescription
The description of the schedule.
SdkInternalList<T> tags
An optional set of tags describing the schedule.
SdkInternalList<T> nextInvocations
Integer associatedClusterCount
The number of clusters associated with the schedule.
SdkInternalList<T> associatedClusters
A list of clusters associated with the schedule. A maximum of 100 clusters is returned.
String subnetIdentifier
The identifier of the subnet.
AvailabilityZone subnetAvailabilityZone
String subnetStatus
The status of the subnet.
String operationName
A list of the supported operations.
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-2: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.
String accountId
The Amazon Web Services account ID that owns the cluster.
String clusterIdentifier
The cluster identifier of the cluster whose partner integration status is being updated.
String databaseName
The name of the database whose partner integration status is being updated.
String partnerName
The name of the partner whose integration status is being updated.
String status
The value of the updated status.
String statusMessage
The status message provided by the partner.
String maintenanceTrackName
The name of the new maintenance track.
String databaseVersion
The cluster version for the new maintenance track.
SdkInternalList<T> supportedOperations
A list of operations supported by the maintenance track.
String usageLimitId
The identifier of the usage limit.
String clusterIdentifier
The identifier of the cluster with a usage limit.
String featureType
The Amazon Redshift feature to which the limit applies.
String limitType
The type of limit. Depending on the feature type, this can be based on a time duration or data size.
Long amount
The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).
String period
The time period that the amount applies to. A weekly
period begins on Sunday. The default is
monthly
.
String breachAction
The action that Amazon Redshift takes when the limit is reached. Possible values are:
log - To log an event in a system table. The default is log.
emit-metric - To emit CloudWatch metrics.
disable - To disable the feature until the next usage period begins.
SdkInternalList<T> tags
A list of tag instances.
String vpcEndpointId
The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.
String vpcId
The VPC identifier that the endpoint is associated.
SdkInternalList<T> networkInterfaces
One or more network interfaces of the endpoint. Also known as an interface endpoint.
Copyright © 2023. All rights reserved.