libZSservicesZSamazonka-redshiftZSamazonka-redshift
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Redshift.Lens

Contents

Description

 
Synopsis

Operations

CancelResize

cancelResize_clusterIdentifier :: Lens' CancelResize Text Source #

The unique identifier for the cluster that you want to cancel a resize operation for.

resizeProgressMessage_importTablesNotStarted :: Lens' ResizeProgressMessage (Maybe [Text]) Source #

The names of tables that have not been yet imported.

Valid Values: List of table names

resizeProgressMessage_status :: Lens' ResizeProgressMessage (Maybe Text) Source #

The status of the resize operation.

Valid Values: NONE | IN_PROGRESS | FAILED | SUCCEEDED | CANCELLING

resizeProgressMessage_estimatedTimeToCompletionInSeconds :: Lens' ResizeProgressMessage (Maybe Integer) Source #

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.

resizeProgressMessage_avgResizeRateInMegaBytesPerSecond :: Lens' ResizeProgressMessage (Maybe Double) Source #

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.

resizeProgressMessage_targetNumberOfNodes :: Lens' ResizeProgressMessage (Maybe Int) Source #

The number of nodes that the cluster will have after the resize operation is complete.

resizeProgressMessage_targetEncryptionType :: Lens' ResizeProgressMessage (Maybe Text) Source #

The type of encryption for the cluster after the resize is complete.

Possible values are KMS and None.

resizeProgressMessage_targetNodeType :: Lens' ResizeProgressMessage (Maybe Text) Source #

The node type that the cluster will have after the resize operation is complete.

resizeProgressMessage_importTablesInProgress :: Lens' ResizeProgressMessage (Maybe [Text]) Source #

The names of tables that are being currently imported.

Valid Values: List of table names.

resizeProgressMessage_resizeType :: Lens' ResizeProgressMessage (Maybe Text) Source #

An enum with possible values of ClassicResize and ElasticResize. These values describe the type of resize operation being performed.

resizeProgressMessage_importTablesCompleted :: Lens' ResizeProgressMessage (Maybe [Text]) Source #

The names of tables that have been completely imported .

Valid Values: List of table names.

resizeProgressMessage_progressInMegaBytes :: Lens' ResizeProgressMessage (Maybe Integer) Source #

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

resizeProgressMessage_dataTransferProgressPercent :: Lens' ResizeProgressMessage (Maybe Double) Source #

The percent of data transferred from source cluster to target cluster.

resizeProgressMessage_totalResizeDataInMegaBytes :: Lens' ResizeProgressMessage (Maybe Integer) Source #

The estimated total amount of data, in megabytes, on the cluster before the resize operation began.

resizeProgressMessage_targetClusterType :: Lens' ResizeProgressMessage (Maybe Text) Source #

The cluster type after the resize operation is complete.

Valid Values: multi-node | single-node

resizeProgressMessage_message :: Lens' ResizeProgressMessage (Maybe Text) Source #

An optional string to provide additional details about the resize action.

resizeProgressMessage_elapsedTimeInSeconds :: Lens' ResizeProgressMessage (Maybe Integer) Source #

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.

DescribeStorage

describeStorageResponse_totalProvisionedStorageInMegaBytes :: Lens' DescribeStorageResponse (Maybe Double) Source #

The total amount of storage currently provisioned.

describeStorageResponse_totalBackupSizeInMegaBytes :: Lens' DescribeStorageResponse (Maybe Double) Source #

The total amount of storage currently used for snapshots.

describeStorageResponse_httpStatus :: Lens' DescribeStorageResponse Int Source #

The response's http status code.

DescribeClusters

describeClusters_tagValues :: Lens' DescribeClusters (Maybe [Text]) Source #

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.

describeClusters_tagKeys :: Lens' DescribeClusters (Maybe [Text]) Source #

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.

describeClusters_clusterIdentifier :: Lens' DescribeClusters (Maybe Text) Source #

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.

describeClusters_marker :: Lens' DescribeClusters (Maybe Text) Source #

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.

describeClusters_maxRecords :: Lens' DescribeClusters (Maybe Int) Source #

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.

describeClustersResponse_marker :: Lens' DescribeClustersResponse (Maybe Text) Source #

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.

describeClustersResponse_clusters :: Lens' DescribeClustersResponse (Maybe [Cluster]) Source #

A list of Cluster objects, where each object describes one cluster.

describeClustersResponse_httpStatus :: Lens' DescribeClustersResponse Int Source #

The response's http status code.

DescribeTags

describeTags_tagValues :: Lens' DescribeTags (Maybe [Text]) Source #

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.

describeTags_resourceType :: Lens' DescribeTags (Maybe Text) Source #

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.

describeTags_resourceName :: Lens' DescribeTags (Maybe Text) Source #

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.

describeTags_tagKeys :: Lens' DescribeTags (Maybe [Text]) Source #

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.

describeTags_marker :: Lens' DescribeTags (Maybe Text) Source #

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.

describeTags_maxRecords :: Lens' DescribeTags (Maybe Int) Source #

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.

describeTagsResponse_marker :: Lens' DescribeTagsResponse (Maybe Text) Source #

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.

describeTagsResponse_taggedResources :: Lens' DescribeTagsResponse (Maybe [TaggedResource]) Source #

A list of tags with their associated resources.

describeTagsResponse_httpStatus :: Lens' DescribeTagsResponse Int Source #

The response's http status code.

CreateUsageLimit

createUsageLimit_period :: Lens' CreateUsageLimit (Maybe UsageLimitPeriod) Source #

The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

createUsageLimit_breachAction :: Lens' CreateUsageLimit (Maybe UsageLimitBreachAction) Source #

The action that Amazon Redshift takes when the limit is reached. The default is log. For more information about this parameter, see UsageLimit.

createUsageLimit_tags :: Lens' CreateUsageLimit (Maybe [Tag]) Source #

A list of tag instances.

createUsageLimit_clusterIdentifier :: Lens' CreateUsageLimit Text Source #

The identifier of the cluster that you want to limit usage.

createUsageLimit_featureType :: Lens' CreateUsageLimit UsageLimitFeatureType Source #

The Amazon Redshift feature that you want to limit.

createUsageLimit_limitType :: Lens' CreateUsageLimit UsageLimitLimitType Source #

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.

createUsageLimit_amount :: Lens' CreateUsageLimit Integer Source #

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.

usageLimit_amount :: Lens' UsageLimit (Maybe Integer) Source #

The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).

usageLimit_limitType :: Lens' UsageLimit (Maybe UsageLimitLimitType) Source #

The type of limit. Depending on the feature type, this can be based on a time duration or data size.

usageLimit_usageLimitId :: Lens' UsageLimit (Maybe Text) Source #

The identifier of the usage limit.

usageLimit_period :: Lens' UsageLimit (Maybe UsageLimitPeriod) Source #

The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

usageLimit_clusterIdentifier :: Lens' UsageLimit (Maybe Text) Source #

The identifier of the cluster with a usage limit.

usageLimit_breachAction :: Lens' UsageLimit (Maybe UsageLimitBreachAction) Source #

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.

usageLimit_featureType :: Lens' UsageLimit (Maybe UsageLimitFeatureType) Source #

The Amazon Redshift feature to which the limit applies.

usageLimit_tags :: Lens' UsageLimit (Maybe [Tag]) Source #

A list of tag instances.

ModifyEndpointAccess

modifyEndpointAccess_vpcSecurityGroupIds :: Lens' ModifyEndpointAccess (Maybe [Text]) Source #

The complete list of VPC security groups associated with the endpoint after the endpoint is modified.

modifyEndpointAccess_endpointName :: Lens' ModifyEndpointAccess Text Source #

The endpoint to be modified.

endpointAccess_endpointName :: Lens' EndpointAccess (Maybe Text) Source #

The name of the endpoint.

endpointAccess_endpointCreateTime :: Lens' EndpointAccess (Maybe UTCTime) Source #

The time (UTC) that the endpoint was created.

endpointAccess_subnetGroupName :: Lens' EndpointAccess (Maybe Text) Source #

The subnet group name where Amazon Redshift chooses to deploy the endpoint.

endpointAccess_address :: Lens' EndpointAccess (Maybe Text) Source #

The DNS address of the endpoint.

endpointAccess_clusterIdentifier :: Lens' EndpointAccess (Maybe Text) Source #

The cluster identifier of the cluster associated with the endpoint.

endpointAccess_endpointStatus :: Lens' EndpointAccess (Maybe Text) Source #

The status of the endpoint.

endpointAccess_vpcSecurityGroups :: Lens' EndpointAccess (Maybe [VpcSecurityGroupMembership]) Source #

The security groups associated with the endpoint.

endpointAccess_resourceOwner :: Lens' EndpointAccess (Maybe Text) Source #

The Amazon Web Services account ID of the owner of the cluster.

endpointAccess_vpcEndpoint :: Lens' EndpointAccess (Maybe VpcEndpoint) Source #

Undocumented member.

endpointAccess_port :: Lens' EndpointAccess (Maybe Int) Source #

The port number on which the cluster accepts incoming connections.

AssociateDataShareConsumer

associateDataShareConsumer_associateEntireAccount :: Lens' AssociateDataShareConsumer (Maybe Bool) Source #

A value that specifies whether the datashare is associated with the entire account.

associateDataShareConsumer_consumerArn :: Lens' AssociateDataShareConsumer (Maybe Text) Source #

The Amazon Resource Name (ARN) of the consumer that is associated with the datashare.

associateDataShareConsumer_dataShareArn :: Lens' AssociateDataShareConsumer Text Source #

The Amazon Resource Name (ARN) of the datashare that the consumer is to use with the account or the namespace.

dataShare_producerArn :: Lens' DataShare (Maybe Text) Source #

The Amazon Resource Name (ARN) of the producer.

dataShare_dataShareAssociations :: Lens' DataShare (Maybe [DataShareAssociation]) Source #

A value that specifies when the datashare has an association between a producer and data consumers.

dataShare_dataShareArn :: Lens' DataShare (Maybe Text) Source #

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.

dataShare_allowPubliclyAccessibleConsumers :: Lens' DataShare (Maybe Bool) Source #

A value that specifies whether the datashare can be shared to a publicly accessible cluster.

DeleteClusterSubnetGroup

deleteClusterSubnetGroup_clusterSubnetGroupName :: Lens' DeleteClusterSubnetGroup Text Source #

The name of the cluster subnet group name to be deleted.

ModifyScheduledAction

modifyScheduledAction_targetAction :: Lens' ModifyScheduledAction (Maybe ScheduledActionType) Source #

A modified JSON format of the scheduled action. For more information about this parameter, see ScheduledAction.

modifyScheduledAction_startTime :: Lens' ModifyScheduledAction (Maybe UTCTime) Source #

A modified start time of the scheduled action. For more information about this parameter, see ScheduledAction.

modifyScheduledAction_schedule :: Lens' ModifyScheduledAction (Maybe Text) Source #

A modified schedule in either at( ) or cron( ) format. For more information about this parameter, see ScheduledAction.

modifyScheduledAction_scheduledActionDescription :: Lens' ModifyScheduledAction (Maybe Text) Source #

A modified description of the scheduled action.

modifyScheduledAction_enable :: Lens' ModifyScheduledAction (Maybe Bool) Source #

A modified enable flag of the scheduled action. If true, the scheduled action is active. If false, the scheduled action is disabled.

modifyScheduledAction_endTime :: Lens' ModifyScheduledAction (Maybe UTCTime) Source #

A modified end time of the scheduled action. For more information about this parameter, see ScheduledAction.

modifyScheduledAction_iamRole :: Lens' ModifyScheduledAction (Maybe Text) Source #

A different IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.

modifyScheduledAction_scheduledActionName :: Lens' ModifyScheduledAction Text Source #

The name of the scheduled action to modify.

scheduledAction_state :: Lens' ScheduledAction (Maybe ScheduledActionState) Source #

The state of the scheduled action. For example, DISABLED.

scheduledAction_targetAction :: Lens' ScheduledAction (Maybe ScheduledActionType) Source #

A JSON format string of the Amazon Redshift API operation with input parameters.

"{\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}".

scheduledAction_startTime :: Lens' ScheduledAction (Maybe UTCTime) Source #

The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

scheduledAction_schedule :: Lens' ScheduledAction (Maybe Text) Source #

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.

scheduledAction_scheduledActionName :: Lens' ScheduledAction (Maybe Text) Source #

The name of the scheduled action.

scheduledAction_scheduledActionDescription :: Lens' ScheduledAction (Maybe Text) Source #

The description of the scheduled action.

scheduledAction_nextInvocations :: Lens' ScheduledAction (Maybe [UTCTime]) Source #

List of times when the scheduled action will run.

scheduledAction_endTime :: Lens' ScheduledAction (Maybe UTCTime) Source #

The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

scheduledAction_iamRole :: Lens' ScheduledAction (Maybe Text) Source #

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.

DisableLogging

disableLogging_clusterIdentifier :: Lens' DisableLogging Text Source #

The identifier of the cluster on which logging is to be stopped.

Example: examplecluster

loggingStatus_lastFailureTime :: Lens' LoggingStatus (Maybe UTCTime) Source #

The last time when logs failed to be delivered.

loggingStatus_lastSuccessfulDeliveryTime :: Lens' LoggingStatus (Maybe UTCTime) Source #

The last time that logs were delivered.

loggingStatus_s3KeyPrefix :: Lens' LoggingStatus (Maybe Text) Source #

The prefix applied to the log file names.

loggingStatus_bucketName :: Lens' LoggingStatus (Maybe Text) Source #

The name of the S3 bucket where the log files are stored.

loggingStatus_loggingEnabled :: Lens' LoggingStatus (Maybe Bool) Source #

true if logging is on, false if logging is off.

loggingStatus_lastFailureMessage :: Lens' LoggingStatus (Maybe Text) Source #

The message indicating that logs failed to be delivered.

DescribeSnapshotSchedules

describeSnapshotSchedules_tagValues :: Lens' DescribeSnapshotSchedules (Maybe [Text]) Source #

The value corresponding to the key of the snapshot schedule tag.

describeSnapshotSchedules_tagKeys :: Lens' DescribeSnapshotSchedules (Maybe [Text]) Source #

The key value for a snapshot schedule tag.

describeSnapshotSchedules_clusterIdentifier :: Lens' DescribeSnapshotSchedules (Maybe Text) Source #

The unique identifier for the cluster whose snapshot schedules you want to view.

describeSnapshotSchedules_marker :: Lens' DescribeSnapshotSchedules (Maybe Text) Source #

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.

describeSnapshotSchedules_maxRecords :: Lens' DescribeSnapshotSchedules (Maybe Int) Source #

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.

describeSnapshotSchedules_scheduleIdentifier :: Lens' DescribeSnapshotSchedules (Maybe Text) Source #

A unique identifier for a snapshot schedule.

describeSnapshotSchedulesResponse_snapshotSchedules :: Lens' DescribeSnapshotSchedulesResponse (Maybe [SnapshotSchedule]) Source #

A list of SnapshotSchedules.

describeSnapshotSchedulesResponse_marker :: Lens' DescribeSnapshotSchedulesResponse (Maybe Text) Source #

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.

describeSnapshotSchedulesResponse_httpStatus :: Lens' DescribeSnapshotSchedulesResponse Int Source #

The response's http status code.

RevokeEndpointAccess

revokeEndpointAccess_force :: Lens' RevokeEndpointAccess (Maybe Bool) Source #

Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.

revokeEndpointAccess_clusterIdentifier :: Lens' RevokeEndpointAccess (Maybe Text) Source #

The cluster to revoke access from.

revokeEndpointAccess_account :: Lens' RevokeEndpointAccess (Maybe Text) Source #

The Amazon Web Services account ID whose access is to be revoked.

revokeEndpointAccess_vpcIds :: Lens' RevokeEndpointAccess (Maybe [Text]) Source #

The virtual private cloud (VPC) identifiers for which access is to be revoked.

endpointAuthorization_status :: Lens' EndpointAuthorization (Maybe AuthorizationStatus) Source #

The status of the authorization action.

endpointAuthorization_allowedAllVPCs :: Lens' EndpointAuthorization (Maybe Bool) Source #

Indicates whether all VPCs in the grantee account are allowed access to the cluster.

endpointAuthorization_endpointCount :: Lens' EndpointAuthorization (Maybe Int) Source #

The number of Redshift-managed VPC endpoints created for the authorization.

endpointAuthorization_grantor :: Lens' EndpointAuthorization (Maybe Text) Source #

The Amazon Web Services account ID of the cluster owner.

endpointAuthorization_clusterIdentifier :: Lens' EndpointAuthorization (Maybe Text) Source #

The cluster identifier.

endpointAuthorization_grantee :: Lens' EndpointAuthorization (Maybe Text) Source #

The Amazon Web Services account ID of the grantee of the cluster.

endpointAuthorization_allowedVPCs :: Lens' EndpointAuthorization (Maybe [Text]) Source #

The VPCs allowed access to the cluster.

endpointAuthorization_clusterStatus :: Lens' EndpointAuthorization (Maybe Text) Source #

The status of the cluster.

endpointAuthorization_authorizeTime :: Lens' EndpointAuthorization (Maybe UTCTime) Source #

The time (UTC) when the authorization was created.

ModifyEventSubscription

modifyEventSubscription_snsTopicArn :: Lens' ModifyEventSubscription (Maybe Text) Source #

The Amazon Resource Name (ARN) of the SNS topic to be used by the event notification subscription.

modifyEventSubscription_enabled :: Lens' ModifyEventSubscription (Maybe Bool) Source #

A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled

modifyEventSubscription_sourceType :: Lens' ModifyEventSubscription (Maybe Text) Source #

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.

modifyEventSubscription_severity :: Lens' ModifyEventSubscription (Maybe Text) Source #

Specifies the Amazon Redshift event severity to be published by the event notification subscription.

Values: ERROR, INFO

modifyEventSubscription_eventCategories :: Lens' ModifyEventSubscription (Maybe [Text]) Source #

Specifies the Amazon Redshift event categories to be published by the event notification subscription.

Values: configuration, management, monitoring, security, pending

modifyEventSubscription_sourceIds :: Lens' ModifyEventSubscription (Maybe [Text]) Source #

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

modifyEventSubscription_subscriptionName :: Lens' ModifyEventSubscription Text Source #

The name of the modified Amazon Redshift event notification subscription.

modifyEventSubscriptionResponse_eventSubscription :: Lens' ModifyEventSubscriptionResponse (Maybe EventSubscription) Source #

Undocumented member.

modifyEventSubscriptionResponse_httpStatus :: Lens' ModifyEventSubscriptionResponse Int Source #

The response's http status code.

ModifyClusterDbRevision

modifyClusterDbRevision_clusterIdentifier :: Lens' ModifyClusterDbRevision Text Source #

The unique identifier of a cluster whose database revision you want to modify.

Example: examplecluster

modifyClusterDbRevision_revisionTarget :: Lens' ModifyClusterDbRevision Text Source #

The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.

modifyClusterDbRevisionResponse_cluster :: Lens' ModifyClusterDbRevisionResponse (Maybe Cluster) Source #

Undocumented member.

modifyClusterDbRevisionResponse_httpStatus :: Lens' ModifyClusterDbRevisionResponse Int Source #

The response's http status code.

DeleteClusterSnapshot

deleteClusterSnapshot_snapshotClusterIdentifier :: Lens' DeleteClusterSnapshot (Maybe Text) Source #

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.

deleteClusterSnapshot_snapshotIdentifier :: Lens' DeleteClusterSnapshot Text Source #

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.

deleteClusterSnapshotResponse_snapshot :: Lens' DeleteClusterSnapshotResponse (Maybe Snapshot) Source #

Undocumented member.

deleteClusterSnapshotResponse_httpStatus :: Lens' DeleteClusterSnapshotResponse Int Source #

The response's http status code.

AddPartner

addPartner_accountId :: Lens' AddPartner Text Source #

The Amazon Web Services account ID that owns the cluster.

addPartner_clusterIdentifier :: Lens' AddPartner Text Source #

The cluster identifier of the cluster that receives data from the partner.

addPartner_databaseName :: Lens' AddPartner Text Source #

The name of the database that receives data from the partner.

addPartner_partnerName :: Lens' AddPartner Text Source #

The name of the partner that is authorized to send data.

partnerIntegrationOutputMessage_partnerName :: Lens' PartnerIntegrationOutputMessage (Maybe Text) Source #

The name of the partner that is authorized to send data.

partnerIntegrationOutputMessage_databaseName :: Lens' PartnerIntegrationOutputMessage (Maybe Text) Source #

The name of the database that receives data from the partner.

PurchaseReservedNodeOffering

purchaseReservedNodeOffering_nodeCount :: Lens' PurchaseReservedNodeOffering (Maybe Int) Source #

The number of reserved nodes that you want to purchase.

Default: 1

purchaseReservedNodeOffering_reservedNodeOfferingId :: Lens' PurchaseReservedNodeOffering Text Source #

The unique identifier of the reserved node offering you want to purchase.

purchaseReservedNodeOfferingResponse_reservedNode :: Lens' PurchaseReservedNodeOfferingResponse (Maybe ReservedNode) Source #

Undocumented member.

purchaseReservedNodeOfferingResponse_httpStatus :: Lens' PurchaseReservedNodeOfferingResponse Int Source #

The response's http status code.

DescribeReservedNodeOfferings

describeReservedNodeOfferings_reservedNodeOfferingId :: Lens' DescribeReservedNodeOfferings (Maybe Text) Source #

The unique identifier for the offering.

describeReservedNodeOfferings_marker :: Lens' DescribeReservedNodeOfferings (Maybe Text) Source #

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.

describeReservedNodeOfferings_maxRecords :: Lens' DescribeReservedNodeOfferings (Maybe Int) Source #

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.

describeReservedNodeOfferingsResponse_reservedNodeOfferings :: Lens' DescribeReservedNodeOfferingsResponse (Maybe [ReservedNodeOffering]) Source #

A list of ReservedNodeOffering objects.

describeReservedNodeOfferingsResponse_marker :: Lens' DescribeReservedNodeOfferingsResponse (Maybe Text) Source #

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.

describeReservedNodeOfferingsResponse_httpStatus :: Lens' DescribeReservedNodeOfferingsResponse Int Source #

The response's http status code.

DescribeEndpointAccess

describeEndpointAccess_endpointName :: Lens' DescribeEndpointAccess (Maybe Text) Source #

The name of the endpoint to be described.

describeEndpointAccess_vpcId :: Lens' DescribeEndpointAccess (Maybe Text) Source #

The virtual private cloud (VPC) identifier with access to the cluster.

describeEndpointAccess_clusterIdentifier :: Lens' DescribeEndpointAccess (Maybe Text) Source #

The cluster identifier associated with the described endpoint.

describeEndpointAccess_marker :: Lens' DescribeEndpointAccess (Maybe Text) Source #

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.

describeEndpointAccess_maxRecords :: Lens' DescribeEndpointAccess (Maybe Int) Source #

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.

describeEndpointAccess_resourceOwner :: Lens' DescribeEndpointAccess (Maybe Text) Source #

The Amazon Web Services account ID of the owner of the cluster.

describeEndpointAccessResponse_marker :: Lens' DescribeEndpointAccessResponse (Maybe Text) Source #

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.

describeEndpointAccessResponse_endpointAccessList :: Lens' DescribeEndpointAccessResponse (Maybe [EndpointAccess]) Source #

The list of endpoints with access to the cluster.

describeEndpointAccessResponse_httpStatus :: Lens' DescribeEndpointAccessResponse Int Source #

The response's http status code.

DescribeEvents

describeEvents_startTime :: Lens' DescribeEvents (Maybe UTCTime) Source #

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

describeEvents_sourceType :: Lens' DescribeEvents (Maybe SourceType) Source #

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.

describeEvents_sourceIdentifier :: Lens' DescribeEvents (Maybe Text) Source #

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.

describeEvents_marker :: Lens' DescribeEvents (Maybe Text) Source #

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.

describeEvents_maxRecords :: Lens' DescribeEvents (Maybe Int) Source #

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.

describeEvents_endTime :: Lens' DescribeEvents (Maybe UTCTime) Source #

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

describeEvents_duration :: Lens' DescribeEvents (Maybe Int) Source #

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

describeEventsResponse_events :: Lens' DescribeEventsResponse (Maybe [Event]) Source #

A list of Event instances.

describeEventsResponse_marker :: Lens' DescribeEventsResponse (Maybe Text) Source #

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.

describeEventsResponse_httpStatus :: Lens' DescribeEventsResponse Int Source #

The response's http status code.

DescribeReservedNodes

describeReservedNodes_reservedNodeId :: Lens' DescribeReservedNodes (Maybe Text) Source #

Identifier for the node reservation.

describeReservedNodes_marker :: Lens' DescribeReservedNodes (Maybe Text) Source #

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.

describeReservedNodes_maxRecords :: Lens' DescribeReservedNodes (Maybe Int) Source #

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.

describeReservedNodesResponse_reservedNodes :: Lens' DescribeReservedNodesResponse (Maybe [ReservedNode]) Source #

The list of ReservedNode objects.

describeReservedNodesResponse_marker :: Lens' DescribeReservedNodesResponse (Maybe Text) Source #

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.

describeReservedNodesResponse_httpStatus :: Lens' DescribeReservedNodesResponse Int Source #

The response's http status code.

GetReservedNodeExchangeOfferings

getReservedNodeExchangeOfferings_marker :: Lens' GetReservedNodeExchangeOfferings (Maybe Text) Source #

A value that indicates the starting point for the next set of ReservedNodeOfferings.

getReservedNodeExchangeOfferings_maxRecords :: Lens' GetReservedNodeExchangeOfferings (Maybe Int) Source #

An integer setting the maximum number of ReservedNodeOfferings to retrieve.

getReservedNodeExchangeOfferings_reservedNodeId :: Lens' GetReservedNodeExchangeOfferings Text Source #

A string representing the node identifier for the DC1 Reserved Node to be exchanged.

getReservedNodeExchangeOfferingsResponse_reservedNodeOfferings :: Lens' GetReservedNodeExchangeOfferingsResponse (Maybe [ReservedNodeOffering]) Source #

Returns an array of ReservedNodeOffering objects.

getReservedNodeExchangeOfferingsResponse_marker :: Lens' GetReservedNodeExchangeOfferingsResponse (Maybe Text) Source #

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.

getReservedNodeExchangeOfferingsResponse_httpStatus :: Lens' GetReservedNodeExchangeOfferingsResponse Int Source #

The response's http status code.

DeleteAuthenticationProfile

deleteAuthenticationProfile_authenticationProfileName :: Lens' DeleteAuthenticationProfile Text Source #

The name of the authentication profile to delete.

deleteAuthenticationProfileResponse_authenticationProfileName :: Lens' DeleteAuthenticationProfileResponse (Maybe Text) Source #

The name of the authentication profile that was deleted.

deleteAuthenticationProfileResponse_httpStatus :: Lens' DeleteAuthenticationProfileResponse Int Source #

The response's http status code.

DescribeClusterParameterGroups

describeClusterParameterGroups_tagValues :: Lens' DescribeClusterParameterGroups (Maybe [Text]) Source #

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.

describeClusterParameterGroups_tagKeys :: Lens' DescribeClusterParameterGroups (Maybe [Text]) Source #

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.

describeClusterParameterGroups_marker :: Lens' DescribeClusterParameterGroups (Maybe Text) Source #

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.

describeClusterParameterGroups_maxRecords :: Lens' DescribeClusterParameterGroups (Maybe Int) Source #

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.

describeClusterParameterGroups_parameterGroupName :: Lens' DescribeClusterParameterGroups (Maybe Text) Source #

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.

describeClusterParameterGroupsResponse_marker :: Lens' DescribeClusterParameterGroupsResponse (Maybe Text) Source #

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.

describeClusterParameterGroupsResponse_parameterGroups :: Lens' DescribeClusterParameterGroupsResponse (Maybe [ClusterParameterGroup]) Source #

A list of ClusterParameterGroup instances. Each instance describes one cluster parameter group.

describeClusterParameterGroupsResponse_httpStatus :: Lens' DescribeClusterParameterGroupsResponse Int Source #

The response's http status code.

EnableLogging

enableLogging_s3KeyPrefix :: Lens' EnableLogging (Maybe Text) Source #

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

enableLogging_clusterIdentifier :: Lens' EnableLogging Text Source #

The identifier of the cluster on which logging is to be started.

Example: examplecluster

enableLogging_bucketName :: Lens' EnableLogging Text Source #

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

loggingStatus_lastFailureTime :: Lens' LoggingStatus (Maybe UTCTime) Source #

The last time when logs failed to be delivered.

loggingStatus_lastSuccessfulDeliveryTime :: Lens' LoggingStatus (Maybe UTCTime) Source #

The last time that logs were delivered.

loggingStatus_s3KeyPrefix :: Lens' LoggingStatus (Maybe Text) Source #

The prefix applied to the log file names.

loggingStatus_bucketName :: Lens' LoggingStatus (Maybe Text) Source #

The name of the S3 bucket where the log files are stored.

loggingStatus_loggingEnabled :: Lens' LoggingStatus (Maybe Bool) Source #

true if logging is on, false if logging is off.

loggingStatus_lastFailureMessage :: Lens' LoggingStatus (Maybe Text) Source #

The message indicating that logs failed to be delivered.

CreateClusterSubnetGroup

createClusterSubnetGroup_tags :: Lens' CreateClusterSubnetGroup (Maybe [Tag]) Source #

A list of tag instances.

createClusterSubnetGroup_clusterSubnetGroupName :: Lens' CreateClusterSubnetGroup Text Source #

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

createClusterSubnetGroup_description :: Lens' CreateClusterSubnetGroup Text Source #

A description for the subnet group.

createClusterSubnetGroup_subnetIds :: Lens' CreateClusterSubnetGroup [Text] Source #

An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.

createClusterSubnetGroupResponse_clusterSubnetGroup :: Lens' CreateClusterSubnetGroupResponse (Maybe ClusterSubnetGroup) Source #

Undocumented member.

createClusterSubnetGroupResponse_httpStatus :: Lens' CreateClusterSubnetGroupResponse Int Source #

The response's http status code.

DeleteClusterParameterGroup

deleteClusterParameterGroup_parameterGroupName :: Lens' DeleteClusterParameterGroup Text Source #

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.

DescribeClusterSecurityGroups

describeClusterSecurityGroups_tagValues :: Lens' DescribeClusterSecurityGroups (Maybe [Text]) Source #

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.

describeClusterSecurityGroups_tagKeys :: Lens' DescribeClusterSecurityGroups (Maybe [Text]) Source #

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.

describeClusterSecurityGroups_clusterSecurityGroupName :: Lens' DescribeClusterSecurityGroups (Maybe Text) Source #

The name of a cluster security group for which you are requesting details. You can specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both.

Example: securitygroup1

describeClusterSecurityGroups_marker :: Lens' DescribeClusterSecurityGroups (Maybe Text) Source #

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 can specify either the ClusterSecurityGroupName parameter or the Marker parameter, but not both.

describeClusterSecurityGroups_maxRecords :: Lens' DescribeClusterSecurityGroups (Maybe Int) Source #

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.

describeClusterSecurityGroupsResponse_clusterSecurityGroups :: Lens' DescribeClusterSecurityGroupsResponse (Maybe [ClusterSecurityGroup]) Source #

A list of ClusterSecurityGroup instances.

describeClusterSecurityGroupsResponse_marker :: Lens' DescribeClusterSecurityGroupsResponse (Maybe Text) Source #

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.

describeClusterSecurityGroupsResponse_httpStatus :: Lens' DescribeClusterSecurityGroupsResponse Int Source #

The response's http status code.

CreateTags

createTags_resourceName :: Lens' CreateTags Text Source #

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.

createTags_tags :: Lens' CreateTags [Tag] Source #

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

DescribeEndpointAuthorization

describeEndpointAuthorization_clusterIdentifier :: Lens' DescribeEndpointAuthorization (Maybe Text) Source #

The cluster identifier of the cluster to access.

describeEndpointAuthorization_account :: Lens' DescribeEndpointAuthorization (Maybe Text) Source #

The AAmazon 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.

describeEndpointAuthorization_marker :: Lens' DescribeEndpointAuthorization (Maybe Text) Source #

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.

describeEndpointAuthorization_maxRecords :: Lens' DescribeEndpointAuthorization (Maybe Int) Source #

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.

describeEndpointAuthorization_grantee :: Lens' DescribeEndpointAuthorization (Maybe Bool) Source #

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.

describeEndpointAuthorizationResponse_endpointAuthorizationList :: Lens' DescribeEndpointAuthorizationResponse (Maybe [EndpointAuthorization]) Source #

The authorizations to an endpoint.

describeEndpointAuthorizationResponse_marker :: Lens' DescribeEndpointAuthorizationResponse (Maybe Text) Source #

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.

describeEndpointAuthorizationResponse_httpStatus :: Lens' DescribeEndpointAuthorizationResponse Int Source #

The response's http status code.

EnableSnapshotCopy

enableSnapshotCopy_manualSnapshotRetentionPeriod :: Lens' EnableSnapshotCopy (Maybe Int) Source #

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.

enableSnapshotCopy_retentionPeriod :: Lens' EnableSnapshotCopy (Maybe Int) Source #

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.

enableSnapshotCopy_snapshotCopyGrantName :: Lens' EnableSnapshotCopy (Maybe Text) Source #

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.

enableSnapshotCopy_clusterIdentifier :: Lens' EnableSnapshotCopy Text Source #

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.

enableSnapshotCopy_destinationRegion :: Lens' EnableSnapshotCopy Text Source #

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.

enableSnapshotCopyResponse_cluster :: Lens' EnableSnapshotCopyResponse (Maybe Cluster) Source #

Undocumented member.

enableSnapshotCopyResponse_httpStatus :: Lens' EnableSnapshotCopyResponse Int Source #

The response's http status code.

DescribeClusterSnapshots

describeClusterSnapshots_snapshotIdentifier :: Lens' DescribeClusterSnapshots (Maybe Text) Source #

The snapshot identifier of the snapshot about which to return information.

describeClusterSnapshots_tagValues :: Lens' DescribeClusterSnapshots (Maybe [Text]) Source #

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.

describeClusterSnapshots_clusterExists :: Lens' DescribeClusterSnapshots (Maybe Bool) Source #

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.

describeClusterSnapshots_startTime :: Lens' DescribeClusterSnapshots (Maybe UTCTime) Source #

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

describeClusterSnapshots_tagKeys :: Lens' DescribeClusterSnapshots (Maybe [Text]) Source #

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.

describeClusterSnapshots_clusterIdentifier :: Lens' DescribeClusterSnapshots (Maybe Text) Source #

The identifier of the cluster which generated the requested snapshots.

describeClusterSnapshots_snapshotType :: Lens' DescribeClusterSnapshots (Maybe Text) Source #

The type of snapshots for which you are requesting information. By default, snapshots of all types are returned.

Valid Values: automated | manual

describeClusterSnapshots_sortingEntities :: Lens' DescribeClusterSnapshots (Maybe [SnapshotSortingEntity]) Source #

 

describeClusterSnapshots_marker :: Lens' DescribeClusterSnapshots (Maybe Text) Source #

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.

describeClusterSnapshots_maxRecords :: Lens' DescribeClusterSnapshots (Maybe Int) Source #

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.

describeClusterSnapshots_endTime :: Lens' DescribeClusterSnapshots (Maybe UTCTime) Source #

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

describeClusterSnapshots_ownerAccount :: Lens' DescribeClusterSnapshots (Maybe Text) Source #

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.

describeClusterSnapshotsResponse_snapshots :: Lens' DescribeClusterSnapshotsResponse (Maybe [Snapshot]) Source #

A list of Snapshot instances.

describeClusterSnapshotsResponse_marker :: Lens' DescribeClusterSnapshotsResponse (Maybe Text) Source #

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.

describeClusterSnapshotsResponse_httpStatus :: Lens' DescribeClusterSnapshotsResponse Int Source #

The response's http status code.

BatchDeleteClusterSnapshots

batchDeleteClusterSnapshots_identifiers :: Lens' BatchDeleteClusterSnapshots [DeleteClusterSnapshotMessage] Source #

A list of identifiers for the snapshots that you want to delete.

batchDeleteClusterSnapshotsResponse_resources :: Lens' BatchDeleteClusterSnapshotsResponse (Maybe [Text]) Source #

A list of the snapshot identifiers that were deleted.

batchDeleteClusterSnapshotsResponse_errors :: Lens' BatchDeleteClusterSnapshotsResponse (Maybe [SnapshotErrorMessage]) Source #

A list of any errors returned.

batchDeleteClusterSnapshotsResponse_httpStatus :: Lens' BatchDeleteClusterSnapshotsResponse Int Source #

The response's http status code.

DeleteTags

deleteTags_resourceName :: Lens' DeleteTags Text Source #

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.

deleteTags_tagKeys :: Lens' DeleteTags [Text] Source #

The tag key that you want to delete.

ModifyUsageLimit

modifyUsageLimit_amount :: Lens' ModifyUsageLimit (Maybe Integer) Source #

The new limit amount. For more information about this parameter, see UsageLimit.

modifyUsageLimit_breachAction :: Lens' ModifyUsageLimit (Maybe UsageLimitBreachAction) Source #

The new action that Amazon Redshift takes when the limit is reached. For more information about this parameter, see UsageLimit.

modifyUsageLimit_usageLimitId :: Lens' ModifyUsageLimit Text Source #

The identifier of the usage limit to modify.

usageLimit_amount :: Lens' UsageLimit (Maybe Integer) Source #

The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).

usageLimit_limitType :: Lens' UsageLimit (Maybe UsageLimitLimitType) Source #

The type of limit. Depending on the feature type, this can be based on a time duration or data size.

usageLimit_usageLimitId :: Lens' UsageLimit (Maybe Text) Source #

The identifier of the usage limit.

usageLimit_period :: Lens' UsageLimit (Maybe UsageLimitPeriod) Source #

The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

usageLimit_clusterIdentifier :: Lens' UsageLimit (Maybe Text) Source #

The identifier of the cluster with a usage limit.

usageLimit_breachAction :: Lens' UsageLimit (Maybe UsageLimitBreachAction) Source #

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.

usageLimit_featureType :: Lens' UsageLimit (Maybe UsageLimitFeatureType) Source #

The Amazon Redshift feature to which the limit applies.

usageLimit_tags :: Lens' UsageLimit (Maybe [Tag]) Source #

A list of tag instances.

DescribeClusterSubnetGroups

describeClusterSubnetGroups_tagValues :: Lens' DescribeClusterSubnetGroups (Maybe [Text]) Source #

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.

describeClusterSubnetGroups_tagKeys :: Lens' DescribeClusterSubnetGroups (Maybe [Text]) Source #

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.

describeClusterSubnetGroups_clusterSubnetGroupName :: Lens' DescribeClusterSubnetGroups (Maybe Text) Source #

The name of the cluster subnet group for which information is requested.

describeClusterSubnetGroups_marker :: Lens' DescribeClusterSubnetGroups (Maybe Text) Source #

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.

describeClusterSubnetGroups_maxRecords :: Lens' DescribeClusterSubnetGroups (Maybe Int) Source #

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.

describeClusterSubnetGroupsResponse_clusterSubnetGroups :: Lens' DescribeClusterSubnetGroupsResponse (Maybe [ClusterSubnetGroup]) Source #

A list of ClusterSubnetGroup instances.

describeClusterSubnetGroupsResponse_marker :: Lens' DescribeClusterSubnetGroupsResponse (Maybe Text) Source #

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.

describeClusterSubnetGroupsResponse_httpStatus :: Lens' DescribeClusterSubnetGroupsResponse Int Source #

The response's http status code.

ResizeCluster

resizeCluster_numberOfNodes :: Lens' ResizeCluster (Maybe Int) Source #

The new number of nodes for the cluster. If not specified, the cluster's current number of nodes is used.

resizeCluster_classic :: Lens' ResizeCluster (Maybe Bool) Source #

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.

resizeCluster_clusterType :: Lens' ResizeCluster (Maybe Text) Source #

The new cluster type for the specified cluster.

resizeCluster_nodeType :: Lens' ResizeCluster (Maybe Text) Source #

The new node type for the nodes you are adding. If not specified, the cluster's current node type is used.

resizeCluster_clusterIdentifier :: Lens' ResizeCluster Text Source #

The unique identifier for the cluster to resize.

resizeClusterResponse_cluster :: Lens' ResizeClusterResponse (Maybe Cluster) Source #

Undocumented member.

resizeClusterResponse_httpStatus :: Lens' ResizeClusterResponse Int Source #

The response's http status code.

ModifySnapshotCopyRetentionPeriod

modifySnapshotCopyRetentionPeriod_manual :: Lens' ModifySnapshotCopyRetentionPeriod (Maybe Bool) Source #

Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

modifySnapshotCopyRetentionPeriod_clusterIdentifier :: Lens' ModifySnapshotCopyRetentionPeriod Text Source #

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.

modifySnapshotCopyRetentionPeriod_retentionPeriod :: Lens' ModifySnapshotCopyRetentionPeriod Int Source #

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.

modifySnapshotCopyRetentionPeriodResponse_cluster :: Lens' ModifySnapshotCopyRetentionPeriodResponse (Maybe Cluster) Source #

Undocumented member.

modifySnapshotCopyRetentionPeriodResponse_httpStatus :: Lens' ModifySnapshotCopyRetentionPeriodResponse Int Source #

The response's http status code.

ModifyClusterIamRoles

modifyClusterIamRoles_removeIamRoles :: Lens' ModifyClusterIamRoles (Maybe [Text]) Source #

Zero or more IAM roles in ARN format to disassociate from the cluster. You can disassociate up to 10 IAM roles from a single cluster in a single request.

modifyClusterIamRoles_addIamRoles :: Lens' ModifyClusterIamRoles (Maybe [Text]) Source #

Zero or more IAM roles to associate with the cluster. The roles must be in their Amazon Resource Name (ARN) format. You can associate up to 10 IAM roles with a single cluster in a single request.

modifyClusterIamRoles_clusterIdentifier :: Lens' ModifyClusterIamRoles Text Source #

The unique identifier of the cluster for which you want to associate or disassociate IAM roles.

modifyClusterIamRolesResponse_cluster :: Lens' ModifyClusterIamRolesResponse (Maybe Cluster) Source #

Undocumented member.

modifyClusterIamRolesResponse_httpStatus :: Lens' ModifyClusterIamRolesResponse Int Source #

The response's http status code.

AuthorizeSnapshotAccess

authorizeSnapshotAccess_snapshotClusterIdentifier :: Lens' AuthorizeSnapshotAccess (Maybe Text) Source #

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.

authorizeSnapshotAccess_snapshotIdentifier :: Lens' AuthorizeSnapshotAccess Text Source #

The identifier of the snapshot the account is authorized to restore.

authorizeSnapshotAccess_accountWithRestoreAccess :: Lens' AuthorizeSnapshotAccess Text Source #

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.

authorizeSnapshotAccessResponse_snapshot :: Lens' AuthorizeSnapshotAccessResponse (Maybe Snapshot) Source #

Undocumented member.

authorizeSnapshotAccessResponse_httpStatus :: Lens' AuthorizeSnapshotAccessResponse Int Source #

The response's http status code.

RebootCluster

rebootCluster_clusterIdentifier :: Lens' RebootCluster Text Source #

The cluster identifier.

rebootClusterResponse_cluster :: Lens' RebootClusterResponse (Maybe Cluster) Source #

Undocumented member.

rebootClusterResponse_httpStatus :: Lens' RebootClusterResponse Int Source #

The response's http status code.

ResumeCluster

resumeCluster_clusterIdentifier :: Lens' ResumeCluster Text Source #

The identifier of the cluster to be resumed.

resumeClusterResponse_cluster :: Lens' ResumeClusterResponse (Maybe Cluster) Source #

Undocumented member.

resumeClusterResponse_httpStatus :: Lens' ResumeClusterResponse Int Source #

The response's http status code.

DeleteCluster

deleteCluster_skipFinalClusterSnapshot :: Lens' DeleteCluster (Maybe Bool) Source #

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

deleteCluster_finalClusterSnapshotRetentionPeriod :: Lens' DeleteCluster (Maybe Int) Source #

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.

deleteCluster_finalClusterSnapshotIdentifier :: Lens' DeleteCluster (Maybe Text) Source #

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.

deleteCluster_clusterIdentifier :: Lens' DeleteCluster Text Source #

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.

deleteClusterResponse_cluster :: Lens' DeleteClusterResponse (Maybe Cluster) Source #

Undocumented member.

deleteClusterResponse_httpStatus :: Lens' DeleteClusterResponse Int Source #

The response's http status code.

CreateEventSubscription

createEventSubscription_enabled :: Lens' CreateEventSubscription (Maybe Bool) Source #

A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.

createEventSubscription_sourceType :: Lens' CreateEventSubscription (Maybe Text) Source #

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.

createEventSubscription_severity :: Lens' CreateEventSubscription (Maybe Text) Source #

Specifies the Amazon Redshift event severity to be published by the event notification subscription.

Values: ERROR, INFO

createEventSubscription_eventCategories :: Lens' CreateEventSubscription (Maybe [Text]) Source #

Specifies the Amazon Redshift event categories to be published by the event notification subscription.

Values: configuration, management, monitoring, security, pending

createEventSubscription_sourceIds :: Lens' CreateEventSubscription (Maybe [Text]) Source #

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

createEventSubscription_tags :: Lens' CreateEventSubscription (Maybe [Tag]) Source #

A list of tag instances.

createEventSubscription_subscriptionName :: Lens' CreateEventSubscription Text Source #

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.

createEventSubscription_snsTopicArn :: Lens' CreateEventSubscription Text Source #

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.

createEventSubscriptionResponse_eventSubscription :: Lens' CreateEventSubscriptionResponse (Maybe EventSubscription) Source #

Undocumented member.

createEventSubscriptionResponse_httpStatus :: Lens' CreateEventSubscriptionResponse Int Source #

The response's http status code.

CreateScheduledAction

createScheduledAction_startTime :: Lens' CreateScheduledAction (Maybe UTCTime) Source #

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.

createScheduledAction_scheduledActionDescription :: Lens' CreateScheduledAction (Maybe Text) Source #

The description of the scheduled action.

createScheduledAction_enable :: Lens' CreateScheduledAction (Maybe Bool) Source #

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.

createScheduledAction_endTime :: Lens' CreateScheduledAction (Maybe UTCTime) Source #

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.

createScheduledAction_scheduledActionName :: Lens' CreateScheduledAction Text Source #

The name of the scheduled action. The name must be unique within an account. For more information about this parameter, see ScheduledAction.

createScheduledAction_targetAction :: Lens' CreateScheduledAction ScheduledActionType Source #

A JSON format string of the Amazon Redshift API operation with input parameters. For more information about this parameter, see ScheduledAction.

createScheduledAction_schedule :: Lens' CreateScheduledAction Text Source #

The schedule in at( ) or cron( ) format. For more information about this parameter, see ScheduledAction.

createScheduledAction_iamRole :: Lens' CreateScheduledAction Text Source #

The IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.

scheduledAction_state :: Lens' ScheduledAction (Maybe ScheduledActionState) Source #

The state of the scheduled action. For example, DISABLED.

scheduledAction_targetAction :: Lens' ScheduledAction (Maybe ScheduledActionType) Source #

A JSON format string of the Amazon Redshift API operation with input parameters.

"{\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}".

scheduledAction_startTime :: Lens' ScheduledAction (Maybe UTCTime) Source #

The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

scheduledAction_schedule :: Lens' ScheduledAction (Maybe Text) Source #

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.

scheduledAction_scheduledActionName :: Lens' ScheduledAction (Maybe Text) Source #

The name of the scheduled action.

scheduledAction_scheduledActionDescription :: Lens' ScheduledAction (Maybe Text) Source #

The description of the scheduled action.

scheduledAction_nextInvocations :: Lens' ScheduledAction (Maybe [UTCTime]) Source #

List of times when the scheduled action will run.

scheduledAction_endTime :: Lens' ScheduledAction (Maybe UTCTime) Source #

The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

scheduledAction_iamRole :: Lens' ScheduledAction (Maybe Text) Source #

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.

DescribeOrderableClusterOptions

describeOrderableClusterOptions_marker :: Lens' DescribeOrderableClusterOptions (Maybe Text) Source #

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.

describeOrderableClusterOptions_maxRecords :: Lens' DescribeOrderableClusterOptions (Maybe Int) Source #

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.

describeOrderableClusterOptions_clusterVersion :: Lens' DescribeOrderableClusterOptions (Maybe Text) Source #

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.

describeOrderableClusterOptions_nodeType :: Lens' DescribeOrderableClusterOptions (Maybe Text) Source #

The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.

describeOrderableClusterOptionsResponse_marker :: Lens' DescribeOrderableClusterOptionsResponse (Maybe Text) Source #

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.

describeOrderableClusterOptionsResponse_orderableClusterOptions :: Lens' DescribeOrderableClusterOptionsResponse (Maybe [OrderableClusterOption]) Source #

An OrderableClusterOption structure containing information about orderable options for the cluster.

describeOrderableClusterOptionsResponse_httpStatus :: Lens' DescribeOrderableClusterOptionsResponse Int Source #

The response's http status code.

CreateEndpointAccess

createEndpointAccess_clusterIdentifier :: Lens' CreateEndpointAccess (Maybe Text) Source #

The cluster identifier of the cluster to access.

createEndpointAccess_vpcSecurityGroupIds :: Lens' CreateEndpointAccess (Maybe [Text]) Source #

The security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

createEndpointAccess_resourceOwner :: Lens' CreateEndpointAccess (Maybe Text) Source #

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.

createEndpointAccess_endpointName :: Lens' CreateEndpointAccess Text Source #

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.

createEndpointAccess_subnetGroupName :: Lens' CreateEndpointAccess Text Source #

The subnet group from which Amazon Redshift chooses the subnet to deploy the endpoint.

endpointAccess_endpointName :: Lens' EndpointAccess (Maybe Text) Source #

The name of the endpoint.

endpointAccess_endpointCreateTime :: Lens' EndpointAccess (Maybe UTCTime) Source #

The time (UTC) that the endpoint was created.

endpointAccess_subnetGroupName :: Lens' EndpointAccess (Maybe Text) Source #

The subnet group name where Amazon Redshift chooses to deploy the endpoint.

endpointAccess_address :: Lens' EndpointAccess (Maybe Text) Source #

The DNS address of the endpoint.

endpointAccess_clusterIdentifier :: Lens' EndpointAccess (Maybe Text) Source #

The cluster identifier of the cluster associated with the endpoint.

endpointAccess_endpointStatus :: Lens' EndpointAccess (Maybe Text) Source #

The status of the endpoint.

endpointAccess_vpcSecurityGroups :: Lens' EndpointAccess (Maybe [VpcSecurityGroupMembership]) Source #

The security groups associated with the endpoint.

endpointAccess_resourceOwner :: Lens' EndpointAccess (Maybe Text) Source #

The Amazon Web Services account ID of the owner of the cluster.

endpointAccess_vpcEndpoint :: Lens' EndpointAccess (Maybe VpcEndpoint) Source #

Undocumented member.

endpointAccess_port :: Lens' EndpointAccess (Maybe Int) Source #

The port number on which the cluster accepts incoming connections.

DescribeClusterTracks

describeClusterTracks_maintenanceTrackName :: Lens' DescribeClusterTracks (Maybe Text) Source #

The name of the maintenance track.

describeClusterTracks_marker :: Lens' DescribeClusterTracks (Maybe Text) Source #

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.

describeClusterTracks_maxRecords :: Lens' DescribeClusterTracks (Maybe Int) Source #

An integer value for the maximum number of maintenance tracks to return.

describeClusterTracksResponse_maintenanceTracks :: Lens' DescribeClusterTracksResponse (Maybe [MaintenanceTrack]) Source #

A list of maintenance tracks output by the DescribeClusterTracks operation.

describeClusterTracksResponse_marker :: Lens' DescribeClusterTracksResponse (Maybe Text) Source #

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.

describeClusterTracksResponse_httpStatus :: Lens' DescribeClusterTracksResponse Int Source #

The response's http status code.

CreateCluster

createCluster_manualSnapshotRetentionPeriod :: Lens' CreateCluster (Maybe Int) Source #

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.

createCluster_enhancedVpcRouting :: Lens' CreateCluster (Maybe Bool) Source #

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

createCluster_additionalInfo :: Lens' CreateCluster (Maybe Text) Source #

Reserved.

createCluster_snapshotScheduleIdentifier :: Lens' CreateCluster (Maybe Text) Source #

A unique identifier for the snapshot schedule.

createCluster_publiclyAccessible :: Lens' CreateCluster (Maybe Bool) Source #

If true, the cluster can be accessed from a public network.

createCluster_maintenanceTrackName :: Lens' CreateCluster (Maybe Text) Source #

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.

createCluster_hsmConfigurationIdentifier :: Lens' CreateCluster (Maybe Text) Source #

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.

createCluster_aquaConfigurationStatus :: Lens' CreateCluster (Maybe AquaConfigurationStatus) Source #

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) when it is created. Possible values include the following.

  • enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.
  • disabled - Don't use AQUA.
  • auto - Amazon Redshift determines whether to use AQUA.

createCluster_clusterSecurityGroups :: Lens' CreateCluster (Maybe [Text]) Source #

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

Default: The default cluster security group for Amazon Redshift.

createCluster_automatedSnapshotRetentionPeriod :: Lens' CreateCluster (Maybe Int) Source #

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.

createCluster_encrypted :: Lens' CreateCluster (Maybe Bool) Source #

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

Default: false

createCluster_clusterSubnetGroupName :: Lens' CreateCluster (Maybe Text) Source #

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

createCluster_hsmClientCertificateIdentifier :: Lens' CreateCluster (Maybe Text) Source #

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

createCluster_numberOfNodes :: Lens' CreateCluster (Maybe Int) Source #

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.

createCluster_elasticIp :: Lens' CreateCluster (Maybe Text) Source #

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.

createCluster_preferredMaintenanceWindow :: Lens' CreateCluster (Maybe Text) Source #

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.

createCluster_kmsKeyId :: Lens' CreateCluster (Maybe Text) Source #

The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.

createCluster_availabilityZone :: Lens' CreateCluster (Maybe Text) Source #

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.

createCluster_vpcSecurityGroupIds :: Lens' CreateCluster (Maybe [Text]) Source #

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.

createCluster_iamRoles :: Lens' CreateCluster (Maybe [Text]) Source #

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. You can supply up to 10 IAM roles in a single request.

A cluster can have up to 10 IAM roles associated with it at any time.

createCluster_clusterType :: Lens' CreateCluster (Maybe Text) Source #

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

createCluster_availabilityZoneRelocation :: Lens' CreateCluster (Maybe Bool) Source #

The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.

createCluster_clusterVersion :: Lens' CreateCluster (Maybe Text) Source #

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

createCluster_allowVersionUpgrade :: Lens' CreateCluster (Maybe Bool) Source #

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

createCluster_clusterParameterGroupName :: Lens' CreateCluster (Maybe Text) Source #

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.

createCluster_tags :: Lens' CreateCluster (Maybe [Tag]) Source #

A list of tag instances.

createCluster_port :: Lens' CreateCluster (Maybe Int) Source #

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

createCluster_dbName :: Lens' CreateCluster (Maybe Text) Source #

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.

createCluster_clusterIdentifier :: Lens' CreateCluster Text Source #

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

createCluster_nodeType :: Lens' CreateCluster Text Source #

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

createCluster_masterUsername :: Lens' CreateCluster Text Source #

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

Constraints:

  • Must be 1 - 128 alphanumeric characters. The user name can't be PUBLIC.
  • First character must be a letter.
  • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

createCluster_masterUserPassword :: Lens' CreateCluster Text Source #

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

Constraints:

  • Must be between 8 and 64 characters in length.
  • Must contain at least one uppercase letter.
  • Must contain at least one lowercase letter.
  • Must contain one number.
  • Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), \, /, @, or space.

createClusterResponse_cluster :: Lens' CreateClusterResponse (Maybe Cluster) Source #

Undocumented member.

createClusterResponse_httpStatus :: Lens' CreateClusterResponse Int Source #

The response's http status code.

CreateHsmClientCertificate

createHsmClientCertificate_tags :: Lens' CreateHsmClientCertificate (Maybe [Tag]) Source #

A list of tag instances.

createHsmClientCertificate_hsmClientCertificateIdentifier :: Lens' CreateHsmClientCertificate Text Source #

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.

createHsmClientCertificateResponse_hsmClientCertificate :: Lens' CreateHsmClientCertificateResponse (Maybe HsmClientCertificate) Source #

Undocumented member.

createHsmClientCertificateResponse_httpStatus :: Lens' CreateHsmClientCertificateResponse Int Source #

The response's http status code.

RestoreTableFromClusterSnapshot

restoreTableFromClusterSnapshot_targetSchemaName :: Lens' RestoreTableFromClusterSnapshot (Maybe Text) Source #

The name of the schema to restore the table to.

restoreTableFromClusterSnapshot_enableCaseSensitiveIdentifier :: Lens' RestoreTableFromClusterSnapshot (Maybe Bool) Source #

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.

restoreTableFromClusterSnapshot_targetDatabaseName :: Lens' RestoreTableFromClusterSnapshot (Maybe Text) Source #

The name of the database to restore the table to.

restoreTableFromClusterSnapshot_sourceSchemaName :: Lens' RestoreTableFromClusterSnapshot (Maybe Text) Source #

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.

restoreTableFromClusterSnapshot_clusterIdentifier :: Lens' RestoreTableFromClusterSnapshot Text Source #

The identifier of the Amazon Redshift cluster to restore the table to.

restoreTableFromClusterSnapshot_snapshotIdentifier :: Lens' RestoreTableFromClusterSnapshot Text Source #

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.

restoreTableFromClusterSnapshot_sourceDatabaseName :: Lens' RestoreTableFromClusterSnapshot Text Source #

The name of the source database that contains the table to restore from.

restoreTableFromClusterSnapshot_sourceTableName :: Lens' RestoreTableFromClusterSnapshot Text Source #

The name of the source table to restore from.

restoreTableFromClusterSnapshot_newTableName :: Lens' RestoreTableFromClusterSnapshot Text Source #

The name of the table to create as a result of the current request.

restoreTableFromClusterSnapshotResponse_tableRestoreStatus :: Lens' RestoreTableFromClusterSnapshotResponse (Maybe TableRestoreStatus) Source #

Undocumented member.

restoreTableFromClusterSnapshotResponse_httpStatus :: Lens' RestoreTableFromClusterSnapshotResponse Int Source #

The response's http status code.

DeleteScheduledAction

deleteScheduledAction_scheduledActionName :: Lens' DeleteScheduledAction Text Source #

The name of the scheduled action to delete.

DescribeDefaultClusterParameters

describeDefaultClusterParameters_marker :: Lens' DescribeDefaultClusterParameters (Maybe Text) Source #

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.

describeDefaultClusterParameters_maxRecords :: Lens' DescribeDefaultClusterParameters (Maybe Int) Source #

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.

describeDefaultClusterParameters_parameterGroupFamily :: Lens' DescribeDefaultClusterParameters Text Source #

The name of the cluster parameter group family.

describeDefaultClusterParametersResponse_httpStatus :: Lens' DescribeDefaultClusterParametersResponse Int Source #

The response's http status code.

describeDefaultClusterParametersResponse_defaultClusterParameters :: Lens' DescribeDefaultClusterParametersResponse DefaultClusterParameters Source #

Undocumented member.

DeleteEventSubscription

deleteEventSubscription_subscriptionName :: Lens' DeleteEventSubscription Text Source #

The name of the Amazon Redshift event notification subscription to be deleted.

ModifyClusterSnapshot

modifyClusterSnapshot_manualSnapshotRetentionPeriod :: Lens' ModifyClusterSnapshot (Maybe Int) Source #

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.

modifyClusterSnapshot_force :: Lens' ModifyClusterSnapshot (Maybe Bool) Source #

A Boolean option to override an exception if the retention period has already passed.

modifyClusterSnapshot_snapshotIdentifier :: Lens' ModifyClusterSnapshot Text Source #

The identifier of the snapshot whose setting you want to modify.

modifyClusterSnapshotResponse_snapshot :: Lens' ModifyClusterSnapshotResponse (Maybe Snapshot) Source #

Undocumented member.

modifyClusterSnapshotResponse_httpStatus :: Lens' ModifyClusterSnapshotResponse Int Source #

The response's http status code.

DescribeDataSharesForConsumer

describeDataSharesForConsumer_status :: Lens' DescribeDataSharesForConsumer (Maybe DataShareStatusForConsumer) Source #

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.

describeDataSharesForConsumer_consumerArn :: Lens' DescribeDataSharesForConsumer (Maybe Text) Source #

The Amazon Resource Name (ARN) of the consumer that returns in the list of datashares.

describeDataSharesForConsumer_marker :: Lens' DescribeDataSharesForConsumer (Maybe Text) Source #

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, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

describeDataSharesForConsumer_maxRecords :: Lens' DescribeDataSharesForConsumer (Maybe Int) Source #

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.

describeDataSharesForConsumerResponse_marker :: Lens' DescribeDataSharesForConsumerResponse (Maybe Text) Source #

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, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

describeDataSharesForConsumerResponse_dataShares :: Lens' DescribeDataSharesForConsumerResponse (Maybe [DataShare]) Source #

Shows the results of datashares available for consumers.

describeDataSharesForConsumerResponse_httpStatus :: Lens' DescribeDataSharesForConsumerResponse Int Source #

The response's http status code.

AuthorizeDataShare

authorizeDataShare_dataShareArn :: Lens' AuthorizeDataShare Text Source #

The Amazon Resource Name (ARN) of the datashare that producers are to authorize sharing for.

authorizeDataShare_consumerIdentifier :: Lens' AuthorizeDataShare Text Source #

The identifier of the data consumer that is authorized to access the datashare. This identifier is an AWS account ID.

dataShare_producerArn :: Lens' DataShare (Maybe Text) Source #

The Amazon Resource Name (ARN) of the producer.

dataShare_dataShareAssociations :: Lens' DataShare (Maybe [DataShareAssociation]) Source #

A value that specifies when the datashare has an association between a producer and data consumers.

dataShare_dataShareArn :: Lens' DataShare (Maybe Text) Source #

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.

dataShare_allowPubliclyAccessibleConsumers :: Lens' DataShare (Maybe Bool) Source #

A value that specifies whether the datashare can be shared to a publicly accessible cluster.

ResetClusterParameterGroup

resetClusterParameterGroup_resetAllParameters :: Lens' ResetClusterParameterGroup (Maybe Bool) Source #

If true, all parameters in the specified parameter group will be reset to their default values.

Default: true

resetClusterParameterGroup_parameters :: Lens' ResetClusterParameterGroup (Maybe [Parameter]) Source #

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.

resetClusterParameterGroup_parameterGroupName :: Lens' ResetClusterParameterGroup Text Source #

The name of the cluster parameter group to be reset.

clusterParameterGroupNameMessage_parameterGroupStatus :: Lens' ClusterParameterGroupNameMessage (Maybe Text) Source #

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.

clusterParameterGroupNameMessage_parameterGroupName :: Lens' ClusterParameterGroupNameMessage (Maybe Text) Source #

The name of the cluster parameter group.

DescribeScheduledActions

describeScheduledActions_startTime :: Lens' DescribeScheduledActions (Maybe UTCTime) Source #

The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations after this time are retrieved.

describeScheduledActions_scheduledActionName :: Lens' DescribeScheduledActions (Maybe Text) Source #

The name of the scheduled action to retrieve.

describeScheduledActions_filters :: Lens' DescribeScheduledActions (Maybe [ScheduledActionFilter]) Source #

List of scheduled action filters.

describeScheduledActions_active :: Lens' DescribeScheduledActions (Maybe Bool) Source #

If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.

describeScheduledActions_targetActionType :: Lens' DescribeScheduledActions (Maybe ScheduledActionTypeValues) Source #

The type of the scheduled actions to retrieve.

describeScheduledActions_marker :: Lens' DescribeScheduledActions (Maybe Text) Source #

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.

describeScheduledActions_maxRecords :: Lens' DescribeScheduledActions (Maybe Int) Source #

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.

describeScheduledActions_endTime :: Lens' DescribeScheduledActions (Maybe UTCTime) Source #

The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.

describeScheduledActionsResponse_scheduledActions :: Lens' DescribeScheduledActionsResponse (Maybe [ScheduledAction]) Source #

List of retrieved scheduled actions.

describeScheduledActionsResponse_marker :: Lens' DescribeScheduledActionsResponse (Maybe Text) Source #

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.

describeScheduledActionsResponse_httpStatus :: Lens' DescribeScheduledActionsResponse Int Source #

The response's http status code.

DisassociateDataShareConsumer

disassociateDataShareConsumer_disassociateEntireAccount :: Lens' DisassociateDataShareConsumer (Maybe Bool) Source #

A value that specifies whether association for the datashare is removed from the entire account.

disassociateDataShareConsumer_consumerArn :: Lens' DisassociateDataShareConsumer (Maybe Text) Source #

The Amazon Resource Name (ARN) of the consumer that association for the datashare is removed from.

disassociateDataShareConsumer_dataShareArn :: Lens' DisassociateDataShareConsumer Text Source #

The Amazon Resource Name (ARN) of the datashare to remove association for.

dataShare_producerArn :: Lens' DataShare (Maybe Text) Source #

The Amazon Resource Name (ARN) of the producer.

dataShare_dataShareAssociations :: Lens' DataShare (Maybe [DataShareAssociation]) Source #

A value that specifies when the datashare has an association between a producer and data consumers.

dataShare_dataShareArn :: Lens' DataShare (Maybe Text) Source #

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.

dataShare_allowPubliclyAccessibleConsumers :: Lens' DataShare (Maybe Bool) Source #

A value that specifies whether the datashare can be shared to a publicly accessible cluster.

DescribeEventSubscriptions

describeEventSubscriptions_subscriptionName :: Lens' DescribeEventSubscriptions (Maybe Text) Source #

The name of the Amazon Redshift event notification subscription to be described.

describeEventSubscriptions_tagValues :: Lens' DescribeEventSubscriptions (Maybe [Text]) Source #

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.

describeEventSubscriptions_tagKeys :: Lens' DescribeEventSubscriptions (Maybe [Text]) Source #

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.

describeEventSubscriptions_marker :: Lens' DescribeEventSubscriptions (Maybe Text) Source #

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.

describeEventSubscriptions_maxRecords :: Lens' DescribeEventSubscriptions (Maybe Int) Source #

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.

describeEventSubscriptionsResponse_eventSubscriptionsList :: Lens' DescribeEventSubscriptionsResponse (Maybe [EventSubscription]) Source #

A list of event subscriptions.

describeEventSubscriptionsResponse_marker :: Lens' DescribeEventSubscriptionsResponse (Maybe Text) Source #

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.

describeEventSubscriptionsResponse_httpStatus :: Lens' DescribeEventSubscriptionsResponse Int Source #

The response's http status code.

DescribeClusterDbRevisions

describeClusterDbRevisions_clusterIdentifier :: Lens' DescribeClusterDbRevisions (Maybe Text) Source #

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.

describeClusterDbRevisions_marker :: Lens' DescribeClusterDbRevisions (Maybe Text) Source #

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.

describeClusterDbRevisions_maxRecords :: Lens' DescribeClusterDbRevisions (Maybe Int) Source #

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.

describeClusterDbRevisionsResponse_clusterDbRevisions :: Lens' DescribeClusterDbRevisionsResponse (Maybe [ClusterDbRevision]) Source #

A list of revisions.

describeClusterDbRevisionsResponse_marker :: Lens' DescribeClusterDbRevisionsResponse (Maybe Text) Source #

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.

describeClusterDbRevisionsResponse_httpStatus :: Lens' DescribeClusterDbRevisionsResponse Int Source #

The response's http status code.

BatchModifyClusterSnapshots

batchModifyClusterSnapshots_manualSnapshotRetentionPeriod :: Lens' BatchModifyClusterSnapshots (Maybe Int) Source #

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.

batchModifyClusterSnapshots_force :: Lens' BatchModifyClusterSnapshots (Maybe Bool) Source #

A boolean value indicating whether to override an exception if the retention period has passed.

batchModifyClusterSnapshots_snapshotIdentifierList :: Lens' BatchModifyClusterSnapshots [Text] Source #

A list of snapshot identifiers you want to modify.

batchModifyClusterSnapshotsResponse_resources :: Lens' BatchModifyClusterSnapshotsResponse (Maybe [Text]) Source #

A list of the snapshots that were modified.

batchModifyClusterSnapshotsResponse_errors :: Lens' BatchModifyClusterSnapshotsResponse (Maybe [SnapshotErrorMessage]) Source #

A list of any errors returned.

batchModifyClusterSnapshotsResponse_httpStatus :: Lens' BatchModifyClusterSnapshotsResponse Int Source #

The response's http status code.

DeleteUsageLimit

deleteUsageLimit_usageLimitId :: Lens' DeleteUsageLimit Text Source #

The identifier of the usage limit to delete.

RevokeClusterSecurityGroupIngress

revokeClusterSecurityGroupIngress_eC2SecurityGroupOwnerId :: Lens' RevokeClusterSecurityGroupIngress (Maybe Text) Source #

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

revokeClusterSecurityGroupIngress_eC2SecurityGroupName :: Lens' RevokeClusterSecurityGroupIngress (Maybe Text) Source #

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.

revokeClusterSecurityGroupIngress_cidrip :: Lens' RevokeClusterSecurityGroupIngress (Maybe Text) Source #

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.

revokeClusterSecurityGroupIngress_clusterSecurityGroupName :: Lens' RevokeClusterSecurityGroupIngress Text Source #

The name of the security Group from which to revoke the ingress rule.

revokeClusterSecurityGroupIngressResponse_clusterSecurityGroup :: Lens' RevokeClusterSecurityGroupIngressResponse (Maybe ClusterSecurityGroup) Source #

Undocumented member.

revokeClusterSecurityGroupIngressResponse_httpStatus :: Lens' RevokeClusterSecurityGroupIngressResponse Int Source #

The response's http status code.

DescribeHsmClientCertificates

describeHsmClientCertificates_tagValues :: Lens' DescribeHsmClientCertificates (Maybe [Text]) Source #

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.

describeHsmClientCertificates_tagKeys :: Lens' DescribeHsmClientCertificates (Maybe [Text]) Source #

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.

describeHsmClientCertificates_hsmClientCertificateIdentifier :: Lens' DescribeHsmClientCertificates (Maybe Text) Source #

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.

describeHsmClientCertificates_marker :: Lens' DescribeHsmClientCertificates (Maybe Text) Source #

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.

describeHsmClientCertificates_maxRecords :: Lens' DescribeHsmClientCertificates (Maybe Int) Source #

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.

describeHsmClientCertificatesResponse_marker :: Lens' DescribeHsmClientCertificatesResponse (Maybe Text) Source #

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.

describeHsmClientCertificatesResponse_hsmClientCertificates :: Lens' DescribeHsmClientCertificatesResponse (Maybe [HsmClientCertificate]) Source #

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.

describeHsmClientCertificatesResponse_httpStatus :: Lens' DescribeHsmClientCertificatesResponse Int Source #

The response's http status code.

ModifyClusterParameterGroup

modifyClusterParameterGroup_parameterGroupName :: Lens' ModifyClusterParameterGroup Text Source #

The name of the parameter group to be modified.

modifyClusterParameterGroup_parameters :: Lens' ModifyClusterParameterGroup [Parameter] Source #

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.

clusterParameterGroupNameMessage_parameterGroupStatus :: Lens' ClusterParameterGroupNameMessage (Maybe Text) Source #

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.

clusterParameterGroupNameMessage_parameterGroupName :: Lens' ClusterParameterGroupNameMessage (Maybe Text) Source #

The name of the cluster parameter group.

AuthorizeEndpointAccess

authorizeEndpointAccess_clusterIdentifier :: Lens' AuthorizeEndpointAccess (Maybe Text) Source #

The cluster identifier of the cluster to grant access to.

authorizeEndpointAccess_vpcIds :: Lens' AuthorizeEndpointAccess (Maybe [Text]) Source #

The virtual private cloud (VPC) identifiers to grant access to.

authorizeEndpointAccess_account :: Lens' AuthorizeEndpointAccess Text Source #

The Amazon Web Services account ID to grant access to.

endpointAuthorization_status :: Lens' EndpointAuthorization (Maybe AuthorizationStatus) Source #

The status of the authorization action.

endpointAuthorization_allowedAllVPCs :: Lens' EndpointAuthorization (Maybe Bool) Source #

Indicates whether all VPCs in the grantee account are allowed access to the cluster.

endpointAuthorization_endpointCount :: Lens' EndpointAuthorization (Maybe Int) Source #

The number of Redshift-managed VPC endpoints created for the authorization.

endpointAuthorization_grantor :: Lens' EndpointAuthorization (Maybe Text) Source #

The Amazon Web Services account ID of the cluster owner.

endpointAuthorization_clusterIdentifier :: Lens' EndpointAuthorization (Maybe Text) Source #

The cluster identifier.

endpointAuthorization_grantee :: Lens' EndpointAuthorization (Maybe Text) Source #

The Amazon Web Services account ID of the grantee of the cluster.

endpointAuthorization_allowedVPCs :: Lens' EndpointAuthorization (Maybe [Text]) Source #

The VPCs allowed access to the cluster.

endpointAuthorization_clusterStatus :: Lens' EndpointAuthorization (Maybe Text) Source #

The status of the cluster.

endpointAuthorization_authorizeTime :: Lens' EndpointAuthorization (Maybe UTCTime) Source #

The time (UTC) when the authorization was created.

ModifyAquaConfiguration

modifyAquaConfiguration_aquaConfigurationStatus :: Lens' ModifyAquaConfiguration (Maybe AquaConfigurationStatus) Source #

The new value of AQUA configuration status. Possible values include the following.

  • enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.
  • disabled - Don't use AQUA.
  • auto - Amazon Redshift determines whether to use AQUA.

modifyAquaConfiguration_clusterIdentifier :: Lens' ModifyAquaConfiguration Text Source #

The identifier of the cluster to be modified.

modifyAquaConfigurationResponse_aquaConfiguration :: Lens' ModifyAquaConfigurationResponse (Maybe AquaConfiguration) Source #

The updated AQUA configuration of the cluster.

modifyAquaConfigurationResponse_httpStatus :: Lens' ModifyAquaConfigurationResponse Int Source #

The response's http status code.

GetClusterCredentials

getClusterCredentials_dbGroups :: Lens' GetClusterCredentials (Maybe [Text]) Source #

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.

getClusterCredentials_durationSeconds :: Lens' GetClusterCredentials (Maybe Int) Source #

The number of seconds until the returned temporary password expires.

Constraint: minimum 900, maximum 3600.

Default: 900

getClusterCredentials_autoCreate :: Lens' GetClusterCredentials (Maybe Bool) Source #

Create a database user with the name specified for the user named in DbUser if one does not exist.

getClusterCredentials_dbName :: Lens' GetClusterCredentials (Maybe Text) Source #

The name of a database that DbUser is authorized to log on to. If DbName is not specified, DbUser can log on to any existing database.

Constraints:

  • Must be 1 to 64 alphanumeric characters or hyphens
  • Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
  • First character must be a letter.
  • Must not contain a colon ( : ) or slash ( / ).
  • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

getClusterCredentials_dbUser :: Lens' GetClusterCredentials Text Source #

The name of a database user. If a user name matching DbUser exists in the database, the temporary user credentials have the same permissions as the existing user. If DbUser doesn't exist in the database and Autocreate is True, a new user is created using the value for DbUser with PUBLIC permissions. If a database user matching the value for DbUser doesn't exist and Autocreate is False, then the command succeeds but the connection attempt will fail because the user doesn't exist in the database.

For more information, see CREATE USER in the Amazon Redshift Database Developer Guide.

Constraints:

  • Must be 1 to 64 alphanumeric characters or hyphens. The user name can't be PUBLIC.
  • Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
  • First character must be a letter.
  • Must not contain a colon ( : ) or slash ( / ).
  • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

getClusterCredentials_clusterIdentifier :: Lens' GetClusterCredentials Text Source #

The unique identifier of the cluster that contains the database for which your are requesting credentials. This parameter is case sensitive.

getClusterCredentialsResponse_dbUser :: Lens' GetClusterCredentialsResponse (Maybe Text) Source #

A database user name that is authorized to log on to the database DbName using the password DbPassword. If the specified DbUser exists in the database, the new user name has the same database privileges as the the user named in DbUser. By default, the user is added to PUBLIC. If the DbGroups parameter is specifed, DbUser is added to the listed groups for any sessions created using these credentials.

getClusterCredentialsResponse_expiration :: Lens' GetClusterCredentialsResponse (Maybe UTCTime) Source #

The date and time the password in DbPassword expires.

getClusterCredentialsResponse_dbPassword :: Lens' GetClusterCredentialsResponse (Maybe Text) Source #

A temporary password that authorizes the user name returned by DbUser to log on to the database DbName.

getClusterCredentialsResponse_httpStatus :: Lens' GetClusterCredentialsResponse Int Source #

The response's http status code.

ModifyClusterMaintenance

modifyClusterMaintenance_deferMaintenanceEndTime :: Lens' ModifyClusterMaintenance (Maybe UTCTime) Source #

A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.

modifyClusterMaintenance_deferMaintenance :: Lens' ModifyClusterMaintenance (Maybe Bool) Source #

A boolean indicating whether to enable the deferred maintenance window.

modifyClusterMaintenance_deferMaintenanceDuration :: Lens' ModifyClusterMaintenance (Maybe Int) Source #

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.

modifyClusterMaintenance_deferMaintenanceStartTime :: Lens' ModifyClusterMaintenance (Maybe UTCTime) Source #

A timestamp indicating the start time for the deferred maintenance window.

modifyClusterMaintenance_deferMaintenanceIdentifier :: Lens' ModifyClusterMaintenance (Maybe Text) Source #

A unique identifier for the deferred maintenance window.

modifyClusterMaintenance_clusterIdentifier :: Lens' ModifyClusterMaintenance Text Source #

A unique identifier for the cluster.

modifyClusterMaintenanceResponse_cluster :: Lens' ModifyClusterMaintenanceResponse (Maybe Cluster) Source #

Undocumented member.

modifyClusterMaintenanceResponse_httpStatus :: Lens' ModifyClusterMaintenanceResponse Int Source #

The response's http status code.

CreateClusterSecurityGroup

createClusterSecurityGroup_tags :: Lens' CreateClusterSecurityGroup (Maybe [Tag]) Source #

A list of tag instances.

createClusterSecurityGroup_clusterSecurityGroupName :: Lens' CreateClusterSecurityGroup Text Source #

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

createClusterSecurityGroup_description :: Lens' CreateClusterSecurityGroup Text Source #

A description for the security group.

createClusterSecurityGroupResponse_clusterSecurityGroup :: Lens' CreateClusterSecurityGroupResponse (Maybe ClusterSecurityGroup) Source #

Undocumented member.

createClusterSecurityGroupResponse_httpStatus :: Lens' CreateClusterSecurityGroupResponse Int Source #

The response's http status code.

DescribeEventCategories

describeEventCategories_sourceType :: Lens' DescribeEventCategories (Maybe Text) Source #

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.

describeEventCategoriesResponse_eventCategoriesMapList :: Lens' DescribeEventCategoriesResponse (Maybe [EventCategoriesMap]) Source #

A list of event categories descriptions.

describeEventCategoriesResponse_httpStatus :: Lens' DescribeEventCategoriesResponse Int Source #

The response's http status code.

DescribeResize

describeResize_clusterIdentifier :: Lens' DescribeResize Text Source #

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.

resizeProgressMessage_importTablesNotStarted :: Lens' ResizeProgressMessage (Maybe [Text]) Source #

The names of tables that have not been yet imported.

Valid Values: List of table names

resizeProgressMessage_status :: Lens' ResizeProgressMessage (Maybe Text) Source #

The status of the resize operation.

Valid Values: NONE | IN_PROGRESS | FAILED | SUCCEEDED | CANCELLING

resizeProgressMessage_estimatedTimeToCompletionInSeconds :: Lens' ResizeProgressMessage (Maybe Integer) Source #

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.

resizeProgressMessage_avgResizeRateInMegaBytesPerSecond :: Lens' ResizeProgressMessage (Maybe Double) Source #

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.

resizeProgressMessage_targetNumberOfNodes :: Lens' ResizeProgressMessage (Maybe Int) Source #

The number of nodes that the cluster will have after the resize operation is complete.

resizeProgressMessage_targetEncryptionType :: Lens' ResizeProgressMessage (Maybe Text) Source #

The type of encryption for the cluster after the resize is complete.

Possible values are KMS and None.

resizeProgressMessage_targetNodeType :: Lens' ResizeProgressMessage (Maybe Text) Source #

The node type that the cluster will have after the resize operation is complete.

resizeProgressMessage_importTablesInProgress :: Lens' ResizeProgressMessage (Maybe [Text]) Source #

The names of tables that are being currently imported.

Valid Values: List of table names.

resizeProgressMessage_resizeType :: Lens' ResizeProgressMessage (Maybe Text) Source #

An enum with possible values of ClassicResize and ElasticResize. These values describe the type of resize operation being performed.

resizeProgressMessage_importTablesCompleted :: Lens' ResizeProgressMessage (Maybe [Text]) Source #

The names of tables that have been completely imported .

Valid Values: List of table names.

resizeProgressMessage_progressInMegaBytes :: Lens' ResizeProgressMessage (Maybe Integer) Source #

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

resizeProgressMessage_dataTransferProgressPercent :: Lens' ResizeProgressMessage (Maybe Double) Source #

The percent of data transferred from source cluster to target cluster.

resizeProgressMessage_totalResizeDataInMegaBytes :: Lens' ResizeProgressMessage (Maybe Integer) Source #

The estimated total amount of data, in megabytes, on the cluster before the resize operation began.

resizeProgressMessage_targetClusterType :: Lens' ResizeProgressMessage (Maybe Text) Source #

The cluster type after the resize operation is complete.

Valid Values: multi-node | single-node

resizeProgressMessage_message :: Lens' ResizeProgressMessage (Maybe Text) Source #

An optional string to provide additional details about the resize action.

resizeProgressMessage_elapsedTimeInSeconds :: Lens' ResizeProgressMessage (Maybe Integer) Source #

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.

DeleteHsmConfiguration

deleteHsmConfiguration_hsmConfigurationIdentifier :: Lens' DeleteHsmConfiguration Text Source #

The identifier of the Amazon Redshift HSM configuration to be deleted.

CreateAuthenticationProfile

createAuthenticationProfile_authenticationProfileName :: Lens' CreateAuthenticationProfile Text Source #

The name of the authentication profile to be created.

createAuthenticationProfile_authenticationProfileContent :: Lens' CreateAuthenticationProfile Text Source #

The content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.

createAuthenticationProfileResponse_authenticationProfileName :: Lens' CreateAuthenticationProfileResponse (Maybe Text) Source #

The name of the authentication profile that was created.

createAuthenticationProfileResponse_authenticationProfileContent :: Lens' CreateAuthenticationProfileResponse (Maybe Text) Source #

The content of the authentication profile in JSON format.

createAuthenticationProfileResponse_httpStatus :: Lens' CreateAuthenticationProfileResponse Int Source #

The response's http status code.

DeauthorizeDataShare

deauthorizeDataShare_dataShareArn :: Lens' DeauthorizeDataShare Text Source #

The Amazon Resource Name (ARN) of the datashare to remove authorization from.

deauthorizeDataShare_consumerIdentifier :: Lens' DeauthorizeDataShare Text Source #

The identifier of the data consumer that is to have authorization removed from the datashare. This identifier is an AWS account ID.

dataShare_producerArn :: Lens' DataShare (Maybe Text) Source #

The Amazon Resource Name (ARN) of the producer.

dataShare_dataShareAssociations :: Lens' DataShare (Maybe [DataShareAssociation]) Source #

A value that specifies when the datashare has an association between a producer and data consumers.

dataShare_dataShareArn :: Lens' DataShare (Maybe Text) Source #

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.

dataShare_allowPubliclyAccessibleConsumers :: Lens' DataShare (Maybe Bool) Source #

A value that specifies whether the datashare can be shared to a publicly accessible cluster.

AcceptReservedNodeExchange

acceptReservedNodeExchange_reservedNodeId :: Lens' AcceptReservedNodeExchange Text Source #

A string representing the node identifier of the DC1 Reserved Node to be exchanged.

acceptReservedNodeExchange_targetReservedNodeOfferingId :: Lens' AcceptReservedNodeExchange Text Source #

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

acceptReservedNodeExchangeResponse_exchangedReservedNode :: Lens' AcceptReservedNodeExchangeResponse (Maybe ReservedNode) Source #

 

acceptReservedNodeExchangeResponse_httpStatus :: Lens' AcceptReservedNodeExchangeResponse Int Source #

The response's http status code.

AuthorizeClusterSecurityGroupIngress

authorizeClusterSecurityGroupIngress_eC2SecurityGroupOwnerId :: Lens' AuthorizeClusterSecurityGroupIngress (Maybe Text) Source #

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

authorizeClusterSecurityGroupIngress_eC2SecurityGroupName :: Lens' AuthorizeClusterSecurityGroupIngress (Maybe Text) Source #

The EC2 security group to be added the Amazon Redshift security group.

authorizeClusterSecurityGroupIngress_cidrip :: Lens' AuthorizeClusterSecurityGroupIngress (Maybe Text) Source #

The IP range to be added the Amazon Redshift security group.

authorizeClusterSecurityGroupIngress_clusterSecurityGroupName :: Lens' AuthorizeClusterSecurityGroupIngress Text Source #

The name of the security group to which the ingress rule is added.

authorizeClusterSecurityGroupIngressResponse_clusterSecurityGroup :: Lens' AuthorizeClusterSecurityGroupIngressResponse (Maybe ClusterSecurityGroup) Source #

Undocumented member.

authorizeClusterSecurityGroupIngressResponse_httpStatus :: Lens' AuthorizeClusterSecurityGroupIngressResponse Int Source #

The response's http status code.

DeletePartner

deletePartner_accountId :: Lens' DeletePartner Text Source #

The Amazon Web Services account ID that owns the cluster.

deletePartner_clusterIdentifier :: Lens' DeletePartner Text Source #

The cluster identifier of the cluster that receives data from the partner.

deletePartner_databaseName :: Lens' DeletePartner Text Source #

The name of the database that receives data from the partner.

deletePartner_partnerName :: Lens' DeletePartner Text Source #

The name of the partner that is authorized to send data.

partnerIntegrationOutputMessage_partnerName :: Lens' PartnerIntegrationOutputMessage (Maybe Text) Source #

The name of the partner that is authorized to send data.

partnerIntegrationOutputMessage_databaseName :: Lens' PartnerIntegrationOutputMessage (Maybe Text) Source #

The name of the database that receives data from the partner.

DescribeTableRestoreStatus

describeTableRestoreStatus_tableRestoreRequestId :: Lens' DescribeTableRestoreStatus (Maybe Text) Source #

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.

describeTableRestoreStatus_clusterIdentifier :: Lens' DescribeTableRestoreStatus (Maybe Text) Source #

The Amazon Redshift cluster that the table is being restored to.

describeTableRestoreStatus_marker :: Lens' DescribeTableRestoreStatus (Maybe Text) Source #

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.

describeTableRestoreStatus_maxRecords :: Lens' DescribeTableRestoreStatus (Maybe Int) Source #

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.

describeTableRestoreStatusResponse_marker :: Lens' DescribeTableRestoreStatusResponse (Maybe Text) Source #

A pagination token that can be used in a subsequent DescribeTableRestoreStatus request.

describeTableRestoreStatusResponse_tableRestoreStatusDetails :: Lens' DescribeTableRestoreStatusResponse (Maybe [TableRestoreStatus]) Source #

A list of status details for one or more table restore requests.

describeTableRestoreStatusResponse_httpStatus :: Lens' DescribeTableRestoreStatusResponse Int Source #

The response's http status code.

CreateClusterSnapshot

createClusterSnapshot_manualSnapshotRetentionPeriod :: Lens' CreateClusterSnapshot (Maybe Int) Source #

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.

createClusterSnapshot_tags :: Lens' CreateClusterSnapshot (Maybe [Tag]) Source #

A list of tag instances.

createClusterSnapshot_snapshotIdentifier :: Lens' CreateClusterSnapshot Text Source #

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

createClusterSnapshot_clusterIdentifier :: Lens' CreateClusterSnapshot Text Source #

The cluster identifier for which you want a snapshot.

createClusterSnapshotResponse_snapshot :: Lens' CreateClusterSnapshotResponse (Maybe Snapshot) Source #

Undocumented member.

createClusterSnapshotResponse_httpStatus :: Lens' CreateClusterSnapshotResponse Int Source #

The response's http status code.

RejectDataShare

rejectDataShare_dataShareArn :: Lens' RejectDataShare Text Source #

The Amazon Resource Name (ARN) of the datashare to reject.

dataShare_producerArn :: Lens' DataShare (Maybe Text) Source #

The Amazon Resource Name (ARN) of the producer.

dataShare_dataShareAssociations :: Lens' DataShare (Maybe [DataShareAssociation]) Source #

A value that specifies when the datashare has an association between a producer and data consumers.

dataShare_dataShareArn :: Lens' DataShare (Maybe Text) Source #

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.

dataShare_allowPubliclyAccessibleConsumers :: Lens' DataShare (Maybe Bool) Source #

A value that specifies whether the datashare can be shared to a publicly accessible cluster.

CreateHsmConfiguration

createHsmConfiguration_tags :: Lens' CreateHsmConfiguration (Maybe [Tag]) Source #

A list of tag instances.

createHsmConfiguration_hsmConfigurationIdentifier :: Lens' CreateHsmConfiguration Text Source #

The identifier to be assigned to the new Amazon Redshift HSM configuration.

createHsmConfiguration_description :: Lens' CreateHsmConfiguration Text Source #

A text description of the HSM configuration to be created.

createHsmConfiguration_hsmIpAddress :: Lens' CreateHsmConfiguration Text Source #

The IP address that the Amazon Redshift cluster must use to access the HSM.

createHsmConfiguration_hsmPartitionName :: Lens' CreateHsmConfiguration Text Source #

The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

createHsmConfiguration_hsmPartitionPassword :: Lens' CreateHsmConfiguration Text Source #

The password required to access the HSM partition.

createHsmConfiguration_hsmServerPublicCertificate :: Lens' CreateHsmConfiguration Text Source #

The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

createHsmConfigurationResponse_hsmConfiguration :: Lens' CreateHsmConfigurationResponse (Maybe HsmConfiguration) Source #

Undocumented member.

createHsmConfigurationResponse_httpStatus :: Lens' CreateHsmConfigurationResponse Int Source #

The response's http status code.

DescribeLoggingStatus

describeLoggingStatus_clusterIdentifier :: Lens' DescribeLoggingStatus Text Source #

The identifier of the cluster from which to get the logging status.

Example: examplecluster

loggingStatus_lastFailureTime :: Lens' LoggingStatus (Maybe UTCTime) Source #

The last time when logs failed to be delivered.

loggingStatus_lastSuccessfulDeliveryTime :: Lens' LoggingStatus (Maybe UTCTime) Source #

The last time that logs were delivered.

loggingStatus_s3KeyPrefix :: Lens' LoggingStatus (Maybe Text) Source #

The prefix applied to the log file names.

loggingStatus_bucketName :: Lens' LoggingStatus (Maybe Text) Source #

The name of the S3 bucket where the log files are stored.

loggingStatus_loggingEnabled :: Lens' LoggingStatus (Maybe Bool) Source #

true if logging is on, false if logging is off.

loggingStatus_lastFailureMessage :: Lens' LoggingStatus (Maybe Text) Source #

The message indicating that logs failed to be delivered.

ModifyCluster

modifyCluster_manualSnapshotRetentionPeriod :: Lens' ModifyCluster (Maybe Int) Source #

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.

modifyCluster_enhancedVpcRouting :: Lens' ModifyCluster (Maybe Bool) Source #

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

modifyCluster_masterUserPassword :: Lens' ModifyCluster (Maybe Text) Source #

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.

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 to 126) except ' (single quote), " (double quote), \, /, @, or space.

modifyCluster_publiclyAccessible :: Lens' ModifyCluster (Maybe Bool) Source #

If true, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.

modifyCluster_maintenanceTrackName :: Lens' ModifyCluster (Maybe Text) Source #

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.

modifyCluster_hsmConfigurationIdentifier :: Lens' ModifyCluster (Maybe Text) Source #

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.

modifyCluster_clusterSecurityGroups :: Lens' ModifyCluster (Maybe [Text]) Source #

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

modifyCluster_automatedSnapshotRetentionPeriod :: Lens' ModifyCluster (Maybe Int) Source #

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.

modifyCluster_encrypted :: Lens' ModifyCluster (Maybe Bool) Source #

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.

modifyCluster_hsmClientCertificateIdentifier :: Lens' ModifyCluster (Maybe Text) Source #

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

modifyCluster_numberOfNodes :: Lens' ModifyCluster (Maybe Int) Source #

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.

modifyCluster_elasticIp :: Lens' ModifyCluster (Maybe Text) Source #

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.

modifyCluster_preferredMaintenanceWindow :: Lens' ModifyCluster (Maybe Text) Source #

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.

modifyCluster_kmsKeyId :: Lens' ModifyCluster (Maybe Text) Source #

The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.

modifyCluster_availabilityZone :: Lens' ModifyCluster (Maybe Text) Source #

The option to initiate relocation for an Amazon Redshift cluster to the target Availability Zone.

modifyCluster_vpcSecurityGroupIds :: Lens' ModifyCluster (Maybe [Text]) Source #

A list of virtual private cloud (VPC) security groups to be associated with the cluster. This change is asynchronously applied as soon as possible.

modifyCluster_clusterType :: Lens' ModifyCluster (Maybe Text) Source #

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

modifyCluster_newClusterIdentifier :: Lens' ModifyCluster (Maybe Text) Source #

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

modifyCluster_availabilityZoneRelocation :: Lens' ModifyCluster (Maybe Bool) Source #

The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.

modifyCluster_clusterVersion :: Lens' ModifyCluster (Maybe Text) Source #

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

modifyCluster_nodeType :: Lens' ModifyCluster (Maybe Text) Source #

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

modifyCluster_allowVersionUpgrade :: Lens' ModifyCluster (Maybe Bool) Source #

If true, major version upgrades will be applied automatically to the cluster during the maintenance window.

Default: false

modifyCluster_clusterParameterGroupName :: Lens' ModifyCluster (Maybe Text) Source #

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.

modifyCluster_port :: Lens' ModifyCluster (Maybe Int) Source #

The option to change the port of an Amazon Redshift cluster.

modifyCluster_clusterIdentifier :: Lens' ModifyCluster Text Source #

The unique identifier of the cluster to be modified.

Example: examplecluster

modifyClusterResponse_cluster :: Lens' ModifyClusterResponse (Maybe Cluster) Source #

Undocumented member.

modifyClusterResponse_httpStatus :: Lens' ModifyClusterResponse Int Source #

The response's http status code.

DeleteClusterSecurityGroup

deleteClusterSecurityGroup_clusterSecurityGroupName :: Lens' DeleteClusterSecurityGroup Text Source #

The name of the cluster security group to be deleted.

CreateSnapshotSchedule

createSnapshotSchedule_nextInvocations :: Lens' CreateSnapshotSchedule (Maybe Int) Source #

 

createSnapshotSchedule_scheduleDefinitions :: Lens' CreateSnapshotSchedule (Maybe [Text]) Source #

The definition of the snapshot schedule. The definition is made up of schedule expressions, for example "cron(30 12 *)" or "rate(12 hours)".

createSnapshotSchedule_scheduleDescription :: Lens' CreateSnapshotSchedule (Maybe Text) Source #

The description of the snapshot schedule.

createSnapshotSchedule_scheduleIdentifier :: Lens' CreateSnapshotSchedule (Maybe Text) Source #

A unique identifier for a snapshot schedule. Only alphanumeric characters are allowed for the identifier.

createSnapshotSchedule_dryRun :: Lens' CreateSnapshotSchedule (Maybe Bool) Source #

 

createSnapshotSchedule_tags :: Lens' CreateSnapshotSchedule (Maybe [Tag]) Source #

An optional set of tags you can use to search for the schedule.

snapshotSchedule_associatedClusters :: Lens' SnapshotSchedule (Maybe [ClusterAssociatedToSchedule]) Source #

A list of clusters associated with the schedule. A maximum of 100 clusters is returned.

snapshotSchedule_nextInvocations :: Lens' SnapshotSchedule (Maybe [UTCTime]) Source #

 

snapshotSchedule_scheduleDefinitions :: Lens' SnapshotSchedule (Maybe [Text]) Source #

A list of ScheduleDefinitions.

snapshotSchedule_scheduleDescription :: Lens' SnapshotSchedule (Maybe Text) Source #

The description of the schedule.

snapshotSchedule_scheduleIdentifier :: Lens' SnapshotSchedule (Maybe Text) Source #

A unique identifier for the schedule.

snapshotSchedule_associatedClusterCount :: Lens' SnapshotSchedule (Maybe Int) Source #

The number of clusters associated with the schedule.

snapshotSchedule_tags :: Lens' SnapshotSchedule (Maybe [Tag]) Source #

An optional set of tags describing the schedule.

DescribeAuthenticationProfiles

describeAuthenticationProfiles_authenticationProfileName :: Lens' DescribeAuthenticationProfiles (Maybe Text) Source #

The name of the authentication profile to describe. If not specified then all authentication profiles owned by the account are listed.

describeAuthenticationProfilesResponse_authenticationProfiles :: Lens' DescribeAuthenticationProfilesResponse (Maybe [AuthenticationProfile]) Source #

The list of authentication profiles.

describeAuthenticationProfilesResponse_httpStatus :: Lens' DescribeAuthenticationProfilesResponse Int Source #

The response's http status code.

DescribeNodeConfigurationOptions

describeNodeConfigurationOptions_snapshotIdentifier :: Lens' DescribeNodeConfigurationOptions (Maybe Text) Source #

The identifier of the snapshot to evaluate for possible node configurations.

describeNodeConfigurationOptions_filters :: Lens' DescribeNodeConfigurationOptions (Maybe [NodeConfigurationOptionsFilter]) Source #

A set of name, operator, and value items to filter the results.

describeNodeConfigurationOptions_clusterIdentifier :: Lens' DescribeNodeConfigurationOptions (Maybe Text) Source #

The identifier of the cluster to evaluate for possible node configurations.

describeNodeConfigurationOptions_marker :: Lens' DescribeNodeConfigurationOptions (Maybe Text) Source #

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.

describeNodeConfigurationOptions_maxRecords :: Lens' DescribeNodeConfigurationOptions (Maybe Int) Source #

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.

describeNodeConfigurationOptions_ownerAccount :: Lens' DescribeNodeConfigurationOptions (Maybe Text) Source #

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.

describeNodeConfigurationOptions_actionType :: Lens' DescribeNodeConfigurationOptions ActionType Source #

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.

describeNodeConfigurationOptionsResponse_nodeConfigurationOptionList :: Lens' DescribeNodeConfigurationOptionsResponse (Maybe [NodeConfigurationOption]) Source #

A list of valid node configurations.

describeNodeConfigurationOptionsResponse_marker :: Lens' DescribeNodeConfigurationOptionsResponse (Maybe Text) Source #

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.

describeNodeConfigurationOptionsResponse_httpStatus :: Lens' DescribeNodeConfigurationOptionsResponse Int Source #

The response's http status code.

DisableSnapshotCopy

disableSnapshotCopy_clusterIdentifier :: Lens' DisableSnapshotCopy Text Source #

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.

disableSnapshotCopyResponse_cluster :: Lens' DisableSnapshotCopyResponse (Maybe Cluster) Source #

Undocumented member.

disableSnapshotCopyResponse_httpStatus :: Lens' DisableSnapshotCopyResponse Int Source #

The response's http status code.

DescribeClusterParameters

describeClusterParameters_marker :: Lens' DescribeClusterParameters (Maybe Text) Source #

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.

describeClusterParameters_maxRecords :: Lens' DescribeClusterParameters (Maybe Int) Source #

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.

describeClusterParameters_source :: Lens' DescribeClusterParameters (Maybe Text) 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

describeClusterParameters_parameterGroupName :: Lens' DescribeClusterParameters Text Source #

The name of a cluster parameter group for which to return details.

describeClusterParametersResponse_marker :: Lens' DescribeClusterParametersResponse (Maybe Text) Source #

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.

describeClusterParametersResponse_parameters :: Lens' DescribeClusterParametersResponse (Maybe [Parameter]) Source #

A list of Parameter instances. Each instance lists the parameters of one cluster parameter group.

describeClusterParametersResponse_httpStatus :: Lens' DescribeClusterParametersResponse Int Source #

The response's http status code.

PauseCluster

pauseCluster_clusterIdentifier :: Lens' PauseCluster Text Source #

The identifier of the cluster to be paused.

pauseClusterResponse_cluster :: Lens' PauseClusterResponse (Maybe Cluster) Source #

Undocumented member.

pauseClusterResponse_httpStatus :: Lens' PauseClusterResponse Int Source #

The response's http status code.

DescribeDataSharesForProducer

describeDataSharesForProducer_status :: Lens' DescribeDataSharesForProducer (Maybe DataShareStatusForProducer) Source #

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.

describeDataSharesForProducer_producerArn :: Lens' DescribeDataSharesForProducer (Maybe Text) Source #

The Amazon Resource Name (ARN) of the producer that returns in the list of datashares.

describeDataSharesForProducer_marker :: Lens' DescribeDataSharesForProducer (Maybe Text) Source #

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, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

describeDataSharesForProducer_maxRecords :: Lens' DescribeDataSharesForProducer (Maybe Int) Source #

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.

describeDataSharesForProducerResponse_marker :: Lens' DescribeDataSharesForProducerResponse (Maybe Text) Source #

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, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

describeDataSharesForProducerResponse_dataShares :: Lens' DescribeDataSharesForProducerResponse (Maybe [DataShare]) Source #

Shows the results of datashares available for producers.

describeDataSharesForProducerResponse_httpStatus :: Lens' DescribeDataSharesForProducerResponse Int Source #

The response's http status code.

DeleteSnapshotSchedule

deleteSnapshotSchedule_scheduleIdentifier :: Lens' DeleteSnapshotSchedule Text Source #

A unique identifier of the snapshot schedule to delete.

RestoreFromClusterSnapshot

restoreFromClusterSnapshot_manualSnapshotRetentionPeriod :: Lens' RestoreFromClusterSnapshot (Maybe Int) Source #

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.

restoreFromClusterSnapshot_enhancedVpcRouting :: Lens' RestoreFromClusterSnapshot (Maybe Bool) Source #

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

restoreFromClusterSnapshot_additionalInfo :: Lens' RestoreFromClusterSnapshot (Maybe Text) Source #

Reserved.

restoreFromClusterSnapshot_snapshotScheduleIdentifier :: Lens' RestoreFromClusterSnapshot (Maybe Text) Source #

A unique identifier for the snapshot schedule.

restoreFromClusterSnapshot_publiclyAccessible :: Lens' RestoreFromClusterSnapshot (Maybe Bool) Source #

If true, the cluster can be accessed from a public network.

restoreFromClusterSnapshot_snapshotClusterIdentifier :: Lens' RestoreFromClusterSnapshot (Maybe Text) Source #

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.

restoreFromClusterSnapshot_maintenanceTrackName :: Lens' RestoreFromClusterSnapshot (Maybe Text) Source #

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.

restoreFromClusterSnapshot_hsmConfigurationIdentifier :: Lens' RestoreFromClusterSnapshot (Maybe Text) Source #

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.

restoreFromClusterSnapshot_aquaConfigurationStatus :: Lens' RestoreFromClusterSnapshot (Maybe AquaConfigurationStatus) Source #

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.

  • enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.
  • disabled - Don't use AQUA.
  • auto - Amazon Redshift determines whether to use AQUA.

restoreFromClusterSnapshot_clusterSecurityGroups :: Lens' RestoreFromClusterSnapshot (Maybe [Text]) Source #

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.

restoreFromClusterSnapshot_automatedSnapshotRetentionPeriod :: Lens' RestoreFromClusterSnapshot (Maybe Int) Source #

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.

restoreFromClusterSnapshot_clusterSubnetGroupName :: Lens' RestoreFromClusterSnapshot (Maybe Text) Source #

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.

restoreFromClusterSnapshot_hsmClientCertificateIdentifier :: Lens' RestoreFromClusterSnapshot (Maybe Text) Source #

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

restoreFromClusterSnapshot_numberOfNodes :: Lens' RestoreFromClusterSnapshot (Maybe Int) Source #

The number of nodes specified when provisioning the restored cluster.

restoreFromClusterSnapshot_elasticIp :: Lens' RestoreFromClusterSnapshot (Maybe Text) Source #

The elastic IP (EIP) address for the cluster.

restoreFromClusterSnapshot_preferredMaintenanceWindow :: Lens' RestoreFromClusterSnapshot (Maybe Text) Source #

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.

restoreFromClusterSnapshot_kmsKeyId :: Lens' RestoreFromClusterSnapshot (Maybe Text) Source #

The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster that you restore from a shared snapshot.

restoreFromClusterSnapshot_availabilityZone :: Lens' RestoreFromClusterSnapshot (Maybe Text) Source #

The Amazon EC2 Availability Zone in which to restore the cluster.

Default: A random, system-chosen Availability Zone.

Example: us-east-2a

restoreFromClusterSnapshot_vpcSecurityGroupIds :: Lens' RestoreFromClusterSnapshot (Maybe [Text]) Source #

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.

restoreFromClusterSnapshot_iamRoles :: Lens' RestoreFromClusterSnapshot (Maybe [Text]) Source #

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. You can supply up to 10 IAM roles in a single request.

A cluster can have up to 10 IAM roles associated at any time.

restoreFromClusterSnapshot_availabilityZoneRelocation :: Lens' RestoreFromClusterSnapshot (Maybe Bool) Source #

The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is restored.

restoreFromClusterSnapshot_ownerAccount :: Lens' RestoreFromClusterSnapshot (Maybe Text) Source #

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.

restoreFromClusterSnapshot_nodeType :: Lens' RestoreFromClusterSnapshot (Maybe Text) Source #

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.

restoreFromClusterSnapshot_allowVersionUpgrade :: Lens' RestoreFromClusterSnapshot (Maybe Bool) Source #

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

restoreFromClusterSnapshot_clusterParameterGroupName :: Lens' RestoreFromClusterSnapshot (Maybe Text) Source #

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.

restoreFromClusterSnapshot_port :: Lens' RestoreFromClusterSnapshot (Maybe Int) Source #

The port number on which the cluster accepts connections.

Default: The same port as the original cluster.

Constraints: Must be between 1115 and 65535.

restoreFromClusterSnapshot_clusterIdentifier :: Lens' RestoreFromClusterSnapshot Text Source #

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.

restoreFromClusterSnapshot_snapshotIdentifier :: Lens' RestoreFromClusterSnapshot Text Source #

The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.

Example: my-snapshot-id

restoreFromClusterSnapshotResponse_cluster :: Lens' RestoreFromClusterSnapshotResponse (Maybe Cluster) Source #

Undocumented member.

restoreFromClusterSnapshotResponse_httpStatus :: Lens' RestoreFromClusterSnapshotResponse Int Source #

The response's http status code.

CreateClusterParameterGroup

createClusterParameterGroup_tags :: Lens' CreateClusterParameterGroup (Maybe [Tag]) Source #

A list of tag instances.

createClusterParameterGroup_parameterGroupName :: Lens' CreateClusterParameterGroup Text Source #

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.

createClusterParameterGroup_parameterGroupFamily :: Lens' CreateClusterParameterGroup Text Source #

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

createClusterParameterGroup_description :: Lens' CreateClusterParameterGroup Text Source #

A description of the parameter group.

createClusterParameterGroupResponse_clusterParameterGroup :: Lens' CreateClusterParameterGroupResponse (Maybe ClusterParameterGroup) Source #

Undocumented member.

createClusterParameterGroupResponse_httpStatus :: Lens' CreateClusterParameterGroupResponse Int Source #

The response's http status code.

DescribePartners

describePartners_partnerName :: Lens' DescribePartners (Maybe Text) Source #

The name of the partner that is being described. If partner name is not specified, then all partner integrations are described.

describePartners_databaseName :: Lens' DescribePartners (Maybe Text) Source #

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.

describePartners_accountId :: Lens' DescribePartners Text Source #

The Amazon Web Services account ID that owns the cluster.

describePartners_clusterIdentifier :: Lens' DescribePartners Text Source #

The cluster identifier of the cluster whose partner integration is being described.

describePartnersResponse_partnerIntegrationInfoList :: Lens' DescribePartnersResponse (Maybe [PartnerIntegrationInfo]) Source #

A list of partner integrations.

describePartnersResponse_httpStatus :: Lens' DescribePartnersResponse Int Source #

The response's http status code.

RevokeSnapshotAccess

revokeSnapshotAccess_snapshotClusterIdentifier :: Lens' RevokeSnapshotAccess (Maybe Text) Source #

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.

revokeSnapshotAccess_snapshotIdentifier :: Lens' RevokeSnapshotAccess Text Source #

The identifier of the snapshot that the account can no longer access.

revokeSnapshotAccess_accountWithRestoreAccess :: Lens' RevokeSnapshotAccess Text Source #

The identifier of the Amazon Web Services account that can no longer restore the specified snapshot.

revokeSnapshotAccessResponse_snapshot :: Lens' RevokeSnapshotAccessResponse (Maybe Snapshot) Source #

Undocumented member.

revokeSnapshotAccessResponse_httpStatus :: Lens' RevokeSnapshotAccessResponse Int Source #

The response's http status code.

DescribeHsmConfigurations

describeHsmConfigurations_tagValues :: Lens' DescribeHsmConfigurations (Maybe [Text]) Source #

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.

describeHsmConfigurations_hsmConfigurationIdentifier :: Lens' DescribeHsmConfigurations (Maybe Text) Source #

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.

describeHsmConfigurations_tagKeys :: Lens' DescribeHsmConfigurations (Maybe [Text]) Source #

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.

describeHsmConfigurations_marker :: Lens' DescribeHsmConfigurations (Maybe Text) Source #

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.

describeHsmConfigurations_maxRecords :: Lens' DescribeHsmConfigurations (Maybe Int) Source #

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.

describeHsmConfigurationsResponse_marker :: Lens' DescribeHsmConfigurationsResponse (Maybe Text) Source #

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.

describeHsmConfigurationsResponse_hsmConfigurations :: Lens' DescribeHsmConfigurationsResponse (Maybe [HsmConfiguration]) Source #

A list of HsmConfiguration objects.

describeHsmConfigurationsResponse_httpStatus :: Lens' DescribeHsmConfigurationsResponse Int Source #

The response's http status code.

DescribeAccountAttributes

describeAccountAttributes_attributeNames :: Lens' DescribeAccountAttributes (Maybe [Text]) Source #

A list of attribute names.

describeAccountAttributesResponse_accountAttributes :: Lens' DescribeAccountAttributesResponse (Maybe [AccountAttribute]) Source #

A list of attributes assigned to an account.

describeAccountAttributesResponse_httpStatus :: Lens' DescribeAccountAttributesResponse Int Source #

The response's http status code.

CreateSnapshotCopyGrant

createSnapshotCopyGrant_kmsKeyId :: Lens' CreateSnapshotCopyGrant (Maybe Text) Source #

The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission. If no key is specified, the default key is used.

createSnapshotCopyGrant_tags :: Lens' CreateSnapshotCopyGrant (Maybe [Tag]) Source #

A list of tag instances.

createSnapshotCopyGrant_snapshotCopyGrantName :: Lens' CreateSnapshotCopyGrant Text Source #

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.

createSnapshotCopyGrantResponse_snapshotCopyGrant :: Lens' CreateSnapshotCopyGrantResponse (Maybe SnapshotCopyGrant) Source #

Undocumented member.

createSnapshotCopyGrantResponse_httpStatus :: Lens' CreateSnapshotCopyGrantResponse Int Source #

The response's http status code.

CopyClusterSnapshot

copyClusterSnapshot_manualSnapshotRetentionPeriod :: Lens' CopyClusterSnapshot (Maybe Int) Source #

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.

copyClusterSnapshot_sourceSnapshotClusterIdentifier :: Lens' CopyClusterSnapshot (Maybe Text) Source #

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.

copyClusterSnapshot_sourceSnapshotIdentifier :: Lens' CopyClusterSnapshot Text Source #

The identifier for the source snapshot.

Constraints:

  • Must be the identifier for a valid automated snapshot whose state is available.

copyClusterSnapshot_targetSnapshotIdentifier :: Lens' CopyClusterSnapshot Text Source #

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.

copyClusterSnapshotResponse_snapshot :: Lens' CopyClusterSnapshotResponse (Maybe Snapshot) Source #

Undocumented member.

copyClusterSnapshotResponse_httpStatus :: Lens' CopyClusterSnapshotResponse Int Source #

The response's http status code.

DescribeDataShares

describeDataShares_marker :: Lens' DescribeDataShares (Maybe Text) Source #

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, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

describeDataShares_maxRecords :: Lens' DescribeDataShares (Maybe Int) Source #

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.

describeDataShares_dataShareArn :: Lens' DescribeDataShares (Maybe Text) Source #

The identifier of the datashare to describe details of.

describeDataSharesResponse_marker :: Lens' DescribeDataSharesResponse (Maybe Text) Source #

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, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

describeDataSharesResponse_dataShares :: Lens' DescribeDataSharesResponse (Maybe [DataShare]) Source #

The results returned from describing datashares.

describeDataSharesResponse_httpStatus :: Lens' DescribeDataSharesResponse Int Source #

The response's http status code.

DeleteHsmClientCertificate

deleteHsmClientCertificate_hsmClientCertificateIdentifier :: Lens' DeleteHsmClientCertificate Text Source #

The identifier of the HSM client certificate to be deleted.

ModifyAuthenticationProfile

modifyAuthenticationProfile_authenticationProfileName :: Lens' ModifyAuthenticationProfile Text Source #

The name of the authentication profile to replace.

modifyAuthenticationProfile_authenticationProfileContent :: Lens' ModifyAuthenticationProfile Text Source #

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.

modifyAuthenticationProfileResponse_authenticationProfileName :: Lens' ModifyAuthenticationProfileResponse (Maybe Text) Source #

The name of the authentication profile that was replaced.

modifyAuthenticationProfileResponse_authenticationProfileContent :: Lens' ModifyAuthenticationProfileResponse (Maybe Text) Source #

The updated content of the authentication profile in JSON format.

modifyAuthenticationProfileResponse_httpStatus :: Lens' ModifyAuthenticationProfileResponse Int Source #

The response's http status code.

UpdatePartnerStatus

updatePartnerStatus_statusMessage :: Lens' UpdatePartnerStatus (Maybe Text) Source #

The status message provided by the partner.

updatePartnerStatus_accountId :: Lens' UpdatePartnerStatus Text Source #

The Amazon Web Services account ID that owns the cluster.

updatePartnerStatus_clusterIdentifier :: Lens' UpdatePartnerStatus Text Source #

The cluster identifier of the cluster whose partner integration status is being updated.

updatePartnerStatus_databaseName :: Lens' UpdatePartnerStatus Text Source #

The name of the database whose partner integration status is being updated.

updatePartnerStatus_partnerName :: Lens' UpdatePartnerStatus Text Source #

The name of the partner whose integration status is being updated.

updatePartnerStatus_status :: Lens' UpdatePartnerStatus PartnerIntegrationStatus Source #

The value of the updated status.

partnerIntegrationOutputMessage_partnerName :: Lens' PartnerIntegrationOutputMessage (Maybe Text) Source #

The name of the partner that is authorized to send data.

partnerIntegrationOutputMessage_databaseName :: Lens' PartnerIntegrationOutputMessage (Maybe Text) Source #

The name of the database that receives data from the partner.

ModifyClusterSnapshotSchedule

modifyClusterSnapshotSchedule_disassociateSchedule :: Lens' ModifyClusterSnapshotSchedule (Maybe Bool) Source #

A boolean to indicate whether to remove the assoiciation between the cluster and the schedule.

modifyClusterSnapshotSchedule_scheduleIdentifier :: Lens' ModifyClusterSnapshotSchedule (Maybe Text) Source #

A unique alphanumeric identifier for the schedule that you want to associate with the cluster.

modifyClusterSnapshotSchedule_clusterIdentifier :: Lens' ModifyClusterSnapshotSchedule Text Source #

A unique identifier for the cluster whose snapshot schedule you want to modify.

DeleteEndpointAccess

deleteEndpointAccess_endpointName :: Lens' DeleteEndpointAccess Text Source #

The Redshift-managed VPC endpoint to delete.

endpointAccess_endpointName :: Lens' EndpointAccess (Maybe Text) Source #

The name of the endpoint.

endpointAccess_endpointCreateTime :: Lens' EndpointAccess (Maybe UTCTime) Source #

The time (UTC) that the endpoint was created.

endpointAccess_subnetGroupName :: Lens' EndpointAccess (Maybe Text) Source #

The subnet group name where Amazon Redshift chooses to deploy the endpoint.

endpointAccess_address :: Lens' EndpointAccess (Maybe Text) Source #

The DNS address of the endpoint.

endpointAccess_clusterIdentifier :: Lens' EndpointAccess (Maybe Text) Source #

The cluster identifier of the cluster associated with the endpoint.

endpointAccess_endpointStatus :: Lens' EndpointAccess (Maybe Text) Source #

The status of the endpoint.

endpointAccess_vpcSecurityGroups :: Lens' EndpointAccess (Maybe [VpcSecurityGroupMembership]) Source #

The security groups associated with the endpoint.

endpointAccess_resourceOwner :: Lens' EndpointAccess (Maybe Text) Source #

The Amazon Web Services account ID of the owner of the cluster.

endpointAccess_vpcEndpoint :: Lens' EndpointAccess (Maybe VpcEndpoint) Source #

Undocumented member.

endpointAccess_port :: Lens' EndpointAccess (Maybe Int) Source #

The port number on which the cluster accepts incoming connections.

DeleteSnapshotCopyGrant

deleteSnapshotCopyGrant_snapshotCopyGrantName :: Lens' DeleteSnapshotCopyGrant Text Source #

The name of the snapshot copy grant to delete.

DescribeClusterVersions

describeClusterVersions_clusterParameterGroupFamily :: Lens' DescribeClusterVersions (Maybe Text) Source #

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

describeClusterVersions_marker :: Lens' DescribeClusterVersions (Maybe Text) Source #

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.

describeClusterVersions_maxRecords :: Lens' DescribeClusterVersions (Maybe Int) Source #

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.

describeClusterVersions_clusterVersion :: Lens' DescribeClusterVersions (Maybe Text) Source #

The specific cluster version to return.

Example: 1.0

describeClusterVersionsResponse_clusterVersions :: Lens' DescribeClusterVersionsResponse (Maybe [ClusterVersion]) Source #

A list of Version elements.

describeClusterVersionsResponse_marker :: Lens' DescribeClusterVersionsResponse (Maybe Text) Source #

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.

describeClusterVersionsResponse_httpStatus :: Lens' DescribeClusterVersionsResponse Int Source #

The response's http status code.

ModifyClusterSubnetGroup

modifyClusterSubnetGroup_description :: Lens' ModifyClusterSubnetGroup (Maybe Text) Source #

A text description of the subnet group to be modified.

modifyClusterSubnetGroup_clusterSubnetGroupName :: Lens' ModifyClusterSubnetGroup Text Source #

The name of the subnet group to be modified.

modifyClusterSubnetGroup_subnetIds :: Lens' ModifyClusterSubnetGroup [Text] Source #

An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.

modifyClusterSubnetGroupResponse_clusterSubnetGroup :: Lens' ModifyClusterSubnetGroupResponse (Maybe ClusterSubnetGroup) Source #

Undocumented member.

modifyClusterSubnetGroupResponse_httpStatus :: Lens' ModifyClusterSubnetGroupResponse Int Source #

The response's http status code.

DescribeUsageLimits

describeUsageLimits_tagValues :: Lens' DescribeUsageLimits (Maybe [Text]) Source #

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.

describeUsageLimits_usageLimitId :: Lens' DescribeUsageLimits (Maybe Text) Source #

The identifier of the usage limit to describe.

describeUsageLimits_tagKeys :: Lens' DescribeUsageLimits (Maybe [Text]) Source #

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.

describeUsageLimits_clusterIdentifier :: Lens' DescribeUsageLimits (Maybe Text) Source #

The identifier of the cluster for which you want to describe usage limits.

describeUsageLimits_featureType :: Lens' DescribeUsageLimits (Maybe UsageLimitFeatureType) Source #

The feature type for which you want to describe usage limits.

describeUsageLimits_marker :: Lens' DescribeUsageLimits (Maybe Text) Source #

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.

describeUsageLimits_maxRecords :: Lens' DescribeUsageLimits (Maybe Int) Source #

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.

describeUsageLimitsResponse_usageLimits :: Lens' DescribeUsageLimitsResponse (Maybe [UsageLimit]) Source #

Contains the output from the DescribeUsageLimits action.

describeUsageLimitsResponse_marker :: Lens' DescribeUsageLimitsResponse (Maybe Text) Source #

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.

describeUsageLimitsResponse_httpStatus :: Lens' DescribeUsageLimitsResponse Int Source #

The response's http status code.

ModifySnapshotSchedule

modifySnapshotSchedule_scheduleIdentifier :: Lens' ModifySnapshotSchedule Text Source #

A unique alphanumeric identifier of the schedule to modify.

modifySnapshotSchedule_scheduleDefinitions :: Lens' ModifySnapshotSchedule [Text] Source #

An updated list of schedule definitions. A schedule definition is made up of schedule expressions, for example, "cron(30 12 *)" or "rate(12 hours)".

snapshotSchedule_associatedClusters :: Lens' SnapshotSchedule (Maybe [ClusterAssociatedToSchedule]) Source #

A list of clusters associated with the schedule. A maximum of 100 clusters is returned.

snapshotSchedule_nextInvocations :: Lens' SnapshotSchedule (Maybe [UTCTime]) Source #

 

snapshotSchedule_scheduleDefinitions :: Lens' SnapshotSchedule (Maybe [Text]) Source #

A list of ScheduleDefinitions.

snapshotSchedule_scheduleDescription :: Lens' SnapshotSchedule (Maybe Text) Source #

The description of the schedule.

snapshotSchedule_scheduleIdentifier :: Lens' SnapshotSchedule (Maybe Text) Source #

A unique identifier for the schedule.

snapshotSchedule_associatedClusterCount :: Lens' SnapshotSchedule (Maybe Int) Source #

The number of clusters associated with the schedule.

snapshotSchedule_tags :: Lens' SnapshotSchedule (Maybe [Tag]) Source #

An optional set of tags describing the schedule.

RotateEncryptionKey

rotateEncryptionKey_clusterIdentifier :: Lens' RotateEncryptionKey Text Source #

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.

rotateEncryptionKeyResponse_cluster :: Lens' RotateEncryptionKeyResponse (Maybe Cluster) Source #

Undocumented member.

rotateEncryptionKeyResponse_httpStatus :: Lens' RotateEncryptionKeyResponse Int Source #

The response's http status code.

DescribeSnapshotCopyGrants

describeSnapshotCopyGrants_tagValues :: Lens' DescribeSnapshotCopyGrants (Maybe [Text]) Source #

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.

describeSnapshotCopyGrants_tagKeys :: Lens' DescribeSnapshotCopyGrants (Maybe [Text]) Source #

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.

describeSnapshotCopyGrants_marker :: Lens' DescribeSnapshotCopyGrants (Maybe Text) Source #

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.

describeSnapshotCopyGrants_maxRecords :: Lens' DescribeSnapshotCopyGrants (Maybe Int) Source #

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.

describeSnapshotCopyGrants_snapshotCopyGrantName :: Lens' DescribeSnapshotCopyGrants (Maybe Text) Source #

The name of the snapshot copy grant.

describeSnapshotCopyGrantsResponse_snapshotCopyGrants :: Lens' DescribeSnapshotCopyGrantsResponse (Maybe [SnapshotCopyGrant]) Source #

The list of SnapshotCopyGrant objects.

describeSnapshotCopyGrantsResponse_marker :: Lens' DescribeSnapshotCopyGrantsResponse (Maybe Text) Source #

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.

describeSnapshotCopyGrantsResponse_httpStatus :: Lens' DescribeSnapshotCopyGrantsResponse Int Source #

The response's http status code.

Types

AccountAttribute

accountAttribute_attributeValues :: Lens' AccountAttribute (Maybe [AttributeValueTarget]) Source #

A list of attribute values.

accountAttribute_attributeName :: Lens' AccountAttribute (Maybe Text) Source #

The name of the attribute.

AccountWithRestoreAccess

accountWithRestoreAccess_accountAlias :: Lens' AccountWithRestoreAccess (Maybe Text) Source #

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.

accountWithRestoreAccess_accountId :: Lens' AccountWithRestoreAccess (Maybe Text) Source #

The identifier of an Amazon Web Services account authorized to restore a snapshot.

AquaConfiguration

aquaConfiguration_aquaConfigurationStatus :: Lens' AquaConfiguration (Maybe AquaConfigurationStatus) Source #

The value represents how the cluster is configured to use AQUA. Possible values include the following.

  • enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.
  • disabled - Don't use AQUA.
  • auto - Amazon Redshift determines whether to use AQUA.

aquaConfiguration_aquaStatus :: Lens' AquaConfiguration (Maybe AquaStatus) Source #

The value indicates the status of AQUA on the cluster. Possible values include the following.

  • enabled - AQUA is enabled.
  • disabled - AQUA is not enabled.
  • applying - AQUA status is being applied.

AttributeValueTarget

attributeValueTarget_attributeValue :: Lens' AttributeValueTarget (Maybe Text) Source #

The value of the attribute.

AuthenticationProfile

authenticationProfile_authenticationProfileName :: Lens' AuthenticationProfile (Maybe Text) Source #

The name of the authentication profile.

authenticationProfile_authenticationProfileContent :: Lens' AuthenticationProfile (Maybe Text) Source #

The content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.

AvailabilityZone

availabilityZone_name :: Lens' AvailabilityZone (Maybe Text) Source #

The name of the availability zone.

availabilityZone_supportedPlatforms :: Lens' AvailabilityZone (Maybe [SupportedPlatform]) Source #

 

Cluster

cluster_aquaConfiguration :: Lens' Cluster (Maybe AquaConfiguration) Source #

The AQUA (Advanced Query Accelerator) configuration of the cluster.

cluster_resizeInfo :: Lens' Cluster (Maybe ResizeInfo) Source #

Returns the following:

  • AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
  • ResizeType: Returns ClassicResize

cluster_restoreStatus :: Lens' Cluster (Maybe RestoreStatus) Source #

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.

cluster_manualSnapshotRetentionPeriod :: Lens' Cluster (Maybe Int) Source #

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.

cluster_enhancedVpcRouting :: Lens' Cluster (Maybe Bool) Source #

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

cluster_clusterSnapshotCopyStatus :: Lens' Cluster (Maybe ClusterSnapshotCopyStatus) Source #

A value that returns the destination region and retention period that are configured for cross-region snapshot copy.

cluster_clusterAvailabilityStatus :: Lens' Cluster (Maybe Text) Source #

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.

cluster_clusterRevisionNumber :: Lens' Cluster (Maybe Text) Source #

The specific revision number of the database in the cluster.

cluster_snapshotScheduleIdentifier :: Lens' Cluster (Maybe Text) Source #

A unique identifier for the cluster snapshot schedule.

cluster_publiclyAccessible :: Lens' Cluster (Maybe Bool) Source #

A boolean value that, if true, indicates that the cluster can be accessed from a public network.

cluster_masterUsername :: Lens' Cluster (Maybe Text) Source #

The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.

cluster_maintenanceTrackName :: Lens' Cluster (Maybe Text) Source #

The name of the maintenance track for the cluster.

cluster_expectedNextSnapshotScheduleTime :: Lens' Cluster (Maybe UTCTime) Source #

The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.

cluster_elasticResizeNumberOfNodeOptions :: Lens' Cluster (Maybe Text) Source #

The number of nodes that you can resize the cluster to with the elastic resize method.

cluster_vpcId :: Lens' Cluster (Maybe Text) Source #

The identifier of the VPC the cluster is in, if the cluster is in a VPC.

cluster_clusterSecurityGroups :: Lens' Cluster (Maybe [ClusterSecurityGroupMembership]) Source #

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.

cluster_automatedSnapshotRetentionPeriod :: Lens' Cluster (Maybe Int) Source #

The number of days that automatic cluster snapshots are retained.

cluster_snapshotScheduleState :: Lens' Cluster (Maybe ScheduleState) Source #

The current state of the cluster snapshot schedule.

cluster_dataTransferProgress :: Lens' Cluster (Maybe DataTransferProgress) Source #

 

cluster_encrypted :: Lens' Cluster (Maybe Bool) Source #

A boolean value that, if true, indicates that data in the cluster is encrypted at rest.

cluster_clusterSubnetGroupName :: Lens' Cluster (Maybe Text) Source #

The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.

cluster_expectedNextSnapshotScheduleTimeStatus :: Lens' Cluster (Maybe Text) Source #

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.

cluster_clusterIdentifier :: Lens' Cluster (Maybe Text) Source #

The unique identifier of the cluster.

cluster_deferredMaintenanceWindows :: Lens' Cluster (Maybe [DeferredMaintenanceWindow]) Source #

Describes a group of DeferredMaintenanceWindow objects.

cluster_numberOfNodes :: Lens' Cluster (Maybe Int) Source #

The number of compute nodes in the cluster.

cluster_clusterPublicKey :: Lens' Cluster (Maybe Text) Source #

The public key for the cluster.

cluster_preferredMaintenanceWindow :: Lens' Cluster (Maybe Text) Source #

The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.

cluster_modifyStatus :: Lens' Cluster (Maybe Text) Source #

The status of a modify operation, if any, initiated for the cluster.

cluster_clusterNamespaceArn :: Lens' Cluster (Maybe Text) Source #

The namespace Amazon Resource Name (ARN) of the cluster.

cluster_kmsKeyId :: Lens' Cluster (Maybe Text) Source #

The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.

cluster_clusterParameterGroups :: Lens' Cluster (Maybe [ClusterParameterGroupStatus]) Source #

The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

cluster_totalStorageCapacityInMegaBytes :: Lens' Cluster (Maybe Integer) Source #

The total storage capacity of the cluster in megabytes.

cluster_availabilityZone :: Lens' Cluster (Maybe Text) Source #

The name of the Availability Zone in which the cluster is located.

cluster_vpcSecurityGroups :: Lens' Cluster (Maybe [VpcSecurityGroupMembership]) Source #

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.

cluster_hsmStatus :: Lens' Cluster (Maybe HsmStatus) Source #

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

cluster_iamRoles :: Lens' Cluster (Maybe [ClusterIamRole]) Source #

A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.

cluster_pendingActions :: Lens' Cluster (Maybe [Text]) Source #

Cluster operations that are waiting to be started.

cluster_elasticIpStatus :: Lens' Cluster (Maybe ElasticIpStatus) Source #

The status of the elastic IP (EIP) address.

cluster_clusterVersion :: Lens' Cluster (Maybe Text) Source #

The version ID of the Amazon Redshift engine that is running on the cluster.

cluster_nodeType :: Lens' Cluster (Maybe Text) Source #

The node type for the nodes in the cluster.

cluster_nextMaintenanceWindowStartTime :: Lens' Cluster (Maybe UTCTime) Source #

The date and time in UTC when system maintenance can begin.

cluster_clusterCreateTime :: Lens' Cluster (Maybe UTCTime) Source #

The date and time that the cluster was created.

cluster_endpoint :: Lens' Cluster (Maybe Endpoint) Source #

The connection endpoint.

cluster_allowVersionUpgrade :: Lens' Cluster (Maybe Bool) Source #

A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.

cluster_clusterStatus :: Lens' Cluster (Maybe Text) Source #

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

cluster_pendingModifiedValues :: Lens' Cluster (Maybe PendingModifiedValues) Source #

A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.

cluster_tags :: Lens' Cluster (Maybe [Tag]) Source #

The list of tags for the cluster.

cluster_availabilityZoneRelocationStatus :: Lens' Cluster (Maybe Text) Source #

Describes the status of the Availability Zone relocation operation.

cluster_clusterNodes :: Lens' Cluster (Maybe [ClusterNode]) Source #

The nodes in the cluster.

cluster_dbName :: Lens' Cluster (Maybe Text) Source #

The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.

ClusterAssociatedToSchedule

clusterAssociatedToSchedule_scheduleAssociationState :: Lens' ClusterAssociatedToSchedule (Maybe ScheduleState) Source #

 

clusterAssociatedToSchedule_clusterIdentifier :: Lens' ClusterAssociatedToSchedule (Maybe Text) Source #

 

ClusterDbRevision

clusterDbRevision_databaseRevisionReleaseDate :: Lens' ClusterDbRevision (Maybe UTCTime) Source #

The date on which the database revision was released.

clusterDbRevision_clusterIdentifier :: Lens' ClusterDbRevision (Maybe Text) Source #

The unique identifier of the cluster.

clusterDbRevision_currentDatabaseRevision :: Lens' ClusterDbRevision (Maybe Text) Source #

A string representing the current cluster version.

clusterDbRevision_revisionTargets :: Lens' ClusterDbRevision (Maybe [RevisionTarget]) Source #

A list of RevisionTarget objects, where each object describes the database revision that a cluster can be updated to.

ClusterIamRole

clusterIamRole_iamRoleArn :: Lens' ClusterIamRole (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload.

clusterIamRole_applyStatus :: Lens' ClusterIamRole (Maybe Text) Source #

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.

ClusterNode

clusterNode_nodeRole :: Lens' ClusterNode (Maybe Text) Source #

Whether the node is a leader node or a compute node.

clusterNode_privateIPAddress :: Lens' ClusterNode (Maybe Text) Source #

The private IP address of a node within a cluster.

clusterNode_publicIPAddress :: Lens' ClusterNode (Maybe Text) Source #

The public IP address of a node within a cluster.

ClusterParameterGroup

clusterParameterGroup_parameterGroupFamily :: Lens' ClusterParameterGroup (Maybe Text) Source #

The name of the cluster parameter group family that this cluster parameter group is compatible with.

clusterParameterGroup_description :: Lens' ClusterParameterGroup (Maybe Text) Source #

The description of the parameter group.

clusterParameterGroup_tags :: Lens' ClusterParameterGroup (Maybe [Tag]) Source #

The list of tags for the cluster parameter group.

clusterParameterGroup_parameterGroupName :: Lens' ClusterParameterGroup (Maybe Text) Source #

The name of the cluster parameter group.

ClusterParameterGroupNameMessage

clusterParameterGroupNameMessage_parameterGroupStatus :: Lens' ClusterParameterGroupNameMessage (Maybe Text) Source #

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.

clusterParameterGroupNameMessage_parameterGroupName :: Lens' ClusterParameterGroupNameMessage (Maybe Text) Source #

The name of the cluster parameter group.

ClusterParameterGroupStatus

clusterParameterGroupStatus_clusterParameterStatusList :: Lens' ClusterParameterGroupStatus (Maybe [ClusterParameterStatus]) Source #

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.

clusterParameterGroupStatus_parameterApplyStatus :: Lens' ClusterParameterGroupStatus (Maybe Text) Source #

The status of parameter updates.

clusterParameterGroupStatus_parameterGroupName :: Lens' ClusterParameterGroupStatus (Maybe Text) Source #

The name of the cluster parameter group.

ClusterParameterStatus

clusterParameterStatus_parameterApplyErrorDescription :: Lens' ClusterParameterStatus (Maybe Text) Source #

The error that prevented the parameter from being applied to the database.

clusterParameterStatus_parameterName :: Lens' ClusterParameterStatus (Maybe Text) Source #

The name of the parameter.

clusterParameterStatus_parameterApplyStatus :: Lens' ClusterParameterStatus (Maybe Text) Source #

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.

ClusterSecurityGroup

clusterSecurityGroup_clusterSecurityGroupName :: Lens' ClusterSecurityGroup (Maybe Text) Source #

The name of the cluster security group to which the operation was applied.

clusterSecurityGroup_iPRanges :: Lens' ClusterSecurityGroup (Maybe [IPRange]) Source #

A list of IP ranges (CIDR blocks) that are permitted to access clusters associated with this cluster security group.

clusterSecurityGroup_eC2SecurityGroups :: Lens' ClusterSecurityGroup (Maybe [EC2SecurityGroup]) Source #

A list of EC2 security groups that are permitted to access clusters associated with this cluster security group.

clusterSecurityGroup_description :: Lens' ClusterSecurityGroup (Maybe Text) Source #

A description of the security group.

clusterSecurityGroup_tags :: Lens' ClusterSecurityGroup (Maybe [Tag]) Source #

The list of tags for the cluster security group.

ClusterSecurityGroupMembership

clusterSecurityGroupMembership_status :: Lens' ClusterSecurityGroupMembership (Maybe Text) Source #

The status of the cluster security group.

clusterSecurityGroupMembership_clusterSecurityGroupName :: Lens' ClusterSecurityGroupMembership (Maybe Text) Source #

The name of the cluster security group.

ClusterSnapshotCopyStatus

clusterSnapshotCopyStatus_manualSnapshotRetentionPeriod :: Lens' ClusterSnapshotCopyStatus (Maybe Int) Source #

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.

clusterSnapshotCopyStatus_retentionPeriod :: Lens' ClusterSnapshotCopyStatus (Maybe Integer) Source #

The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

clusterSnapshotCopyStatus_destinationRegion :: Lens' ClusterSnapshotCopyStatus (Maybe Text) Source #

The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

clusterSnapshotCopyStatus_snapshotCopyGrantName :: Lens' ClusterSnapshotCopyStatus (Maybe Text) Source #

The name of the snapshot copy grant.

ClusterSubnetGroup

clusterSubnetGroup_vpcId :: Lens' ClusterSubnetGroup (Maybe Text) Source #

The VPC ID of the cluster subnet group.

clusterSubnetGroup_subnets :: Lens' ClusterSubnetGroup (Maybe [Subnet]) Source #

A list of the VPC Subnet elements.

clusterSubnetGroup_clusterSubnetGroupName :: Lens' ClusterSubnetGroup (Maybe Text) Source #

The name of the cluster subnet group.

clusterSubnetGroup_subnetGroupStatus :: Lens' ClusterSubnetGroup (Maybe Text) Source #

The status of the cluster subnet group. Possible values are Complete, Incomplete and Invalid.

clusterSubnetGroup_description :: Lens' ClusterSubnetGroup (Maybe Text) Source #

The description of the cluster subnet group.

clusterSubnetGroup_tags :: Lens' ClusterSubnetGroup (Maybe [Tag]) Source #

The list of tags for the cluster subnet group.

ClusterVersion

clusterVersion_clusterParameterGroupFamily :: Lens' ClusterVersion (Maybe Text) Source #

The name of the cluster parameter group family for the cluster.

clusterVersion_clusterVersion :: Lens' ClusterVersion (Maybe Text) Source #

The version number used by the cluster.

clusterVersion_description :: Lens' ClusterVersion (Maybe Text) Source #

The description of the cluster version.

DataShare

dataShare_producerArn :: Lens' DataShare (Maybe Text) Source #

The Amazon Resource Name (ARN) of the producer.

dataShare_dataShareAssociations :: Lens' DataShare (Maybe [DataShareAssociation]) Source #

A value that specifies when the datashare has an association between a producer and data consumers.

dataShare_dataShareArn :: Lens' DataShare (Maybe Text) Source #

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.

dataShare_allowPubliclyAccessibleConsumers :: Lens' DataShare (Maybe Bool) Source #

A value that specifies whether the datashare can be shared to a publicly accessible cluster.

DataShareAssociation

dataShareAssociation_status :: Lens' DataShareAssociation (Maybe DataShareStatus) Source #

The status of the datashare that is associated.

dataShareAssociation_consumerIdentifier :: Lens' DataShareAssociation (Maybe Text) Source #

The name of the consumer accounts that have an association with a producer datashare.

dataShareAssociation_createdDate :: Lens' DataShareAssociation (Maybe UTCTime) Source #

The creation date of the datashare that is associated.

dataShareAssociation_statusChangeDate :: Lens' DataShareAssociation (Maybe UTCTime) Source #

The status change data of the datashare that is associated.

DataTransferProgress

dataTransferProgress_currentRateInMegaBytesPerSecond :: Lens' DataTransferProgress (Maybe Double) Source #

Describes the data transfer rate in MB's per second.

dataTransferProgress_status :: Lens' DataTransferProgress (Maybe Text) Source #

Describes the status of the cluster. While the transfer is in progress the status is transferringdata.

dataTransferProgress_estimatedTimeToCompletionInSeconds :: Lens' DataTransferProgress (Maybe Integer) Source #

Describes the estimated number of seconds remaining to complete the transfer.

dataTransferProgress_dataTransferredInMegaBytes :: Lens' DataTransferProgress (Maybe Integer) Source #

Describes the total amount of data that has been transfered in MB's.

dataTransferProgress_totalDataInMegaBytes :: Lens' DataTransferProgress (Maybe Integer) Source #

Describes the total amount of data to be transfered in megabytes.

dataTransferProgress_elapsedTimeInSeconds :: Lens' DataTransferProgress (Maybe Integer) Source #

Describes the number of seconds that have elapsed during the data transfer.

DefaultClusterParameters

defaultClusterParameters_marker :: Lens' DefaultClusterParameters (Maybe Text) Source #

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.

defaultClusterParameters_parameters :: Lens' DefaultClusterParameters (Maybe [Parameter]) Source #

The list of cluster default parameters.

defaultClusterParameters_parameterGroupFamily :: Lens' DefaultClusterParameters (Maybe Text) Source #

The name of the cluster parameter group family to which the engine default parameters apply.

DeferredMaintenanceWindow

deferredMaintenanceWindow_deferMaintenanceEndTime :: Lens' DeferredMaintenanceWindow (Maybe UTCTime) Source #

A timestamp for the end of the time period when we defer maintenance.

deferredMaintenanceWindow_deferMaintenanceStartTime :: Lens' DeferredMaintenanceWindow (Maybe UTCTime) Source #

A timestamp for the beginning of the time period when we defer maintenance.

deferredMaintenanceWindow_deferMaintenanceIdentifier :: Lens' DeferredMaintenanceWindow (Maybe Text) Source #

A unique identifier for the maintenance window.

DeleteClusterSnapshotMessage

deleteClusterSnapshotMessage_snapshotClusterIdentifier :: Lens' DeleteClusterSnapshotMessage (Maybe Text) Source #

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.

deleteClusterSnapshotMessage_snapshotIdentifier :: Lens' DeleteClusterSnapshotMessage Text Source #

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.

EC2SecurityGroup

eC2SecurityGroup_status :: Lens' EC2SecurityGroup (Maybe Text) Source #

The status of the EC2 security group.

eC2SecurityGroup_eC2SecurityGroupOwnerId :: Lens' EC2SecurityGroup (Maybe Text) Source #

The Amazon Web Services account ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

eC2SecurityGroup_eC2SecurityGroupName :: Lens' EC2SecurityGroup (Maybe Text) Source #

The name of the EC2 Security Group.

eC2SecurityGroup_tags :: Lens' EC2SecurityGroup (Maybe [Tag]) Source #

The list of tags for the EC2 security group.

ElasticIpStatus

elasticIpStatus_status :: Lens' ElasticIpStatus (Maybe Text) Source #

The status of the elastic IP (EIP) address.

elasticIpStatus_elasticIp :: Lens' ElasticIpStatus (Maybe Text) Source #

The elastic IP (EIP) address for the cluster.

Endpoint

endpoint_address :: Lens' Endpoint (Maybe Text) Source #

The DNS address of the Cluster.

endpoint_vpcEndpoints :: Lens' Endpoint (Maybe [VpcEndpoint]) Source #

Describes a connection endpoint.

endpoint_port :: Lens' Endpoint (Maybe Int) Source #

The port that the database engine is listening on.

EndpointAccess

endpointAccess_endpointName :: Lens' EndpointAccess (Maybe Text) Source #

The name of the endpoint.

endpointAccess_endpointCreateTime :: Lens' EndpointAccess (Maybe UTCTime) Source #

The time (UTC) that the endpoint was created.

endpointAccess_subnetGroupName :: Lens' EndpointAccess (Maybe Text) Source #

The subnet group name where Amazon Redshift chooses to deploy the endpoint.

endpointAccess_address :: Lens' EndpointAccess (Maybe Text) Source #

The DNS address of the endpoint.

endpointAccess_clusterIdentifier :: Lens' EndpointAccess (Maybe Text) Source #

The cluster identifier of the cluster associated with the endpoint.

endpointAccess_endpointStatus :: Lens' EndpointAccess (Maybe Text) Source #

The status of the endpoint.

endpointAccess_vpcSecurityGroups :: Lens' EndpointAccess (Maybe [VpcSecurityGroupMembership]) Source #

The security groups associated with the endpoint.

endpointAccess_resourceOwner :: Lens' EndpointAccess (Maybe Text) Source #

The Amazon Web Services account ID of the owner of the cluster.

endpointAccess_vpcEndpoint :: Lens' EndpointAccess (Maybe VpcEndpoint) Source #

Undocumented member.

endpointAccess_port :: Lens' EndpointAccess (Maybe Int) Source #

The port number on which the cluster accepts incoming connections.

EndpointAuthorization

endpointAuthorization_status :: Lens' EndpointAuthorization (Maybe AuthorizationStatus) Source #

The status of the authorization action.

endpointAuthorization_allowedAllVPCs :: Lens' EndpointAuthorization (Maybe Bool) Source #

Indicates whether all VPCs in the grantee account are allowed access to the cluster.

endpointAuthorization_endpointCount :: Lens' EndpointAuthorization (Maybe Int) Source #

The number of Redshift-managed VPC endpoints created for the authorization.

endpointAuthorization_grantor :: Lens' EndpointAuthorization (Maybe Text) Source #

The Amazon Web Services account ID of the cluster owner.

endpointAuthorization_clusterIdentifier :: Lens' EndpointAuthorization (Maybe Text) Source #

The cluster identifier.

endpointAuthorization_grantee :: Lens' EndpointAuthorization (Maybe Text) Source #

The Amazon Web Services account ID of the grantee of the cluster.

endpointAuthorization_allowedVPCs :: Lens' EndpointAuthorization (Maybe [Text]) Source #

The VPCs allowed access to the cluster.

endpointAuthorization_clusterStatus :: Lens' EndpointAuthorization (Maybe Text) Source #

The status of the cluster.

endpointAuthorization_authorizeTime :: Lens' EndpointAuthorization (Maybe UTCTime) Source #

The time (UTC) when the authorization was created.

Event

event_sourceType :: Lens' Event (Maybe SourceType) Source #

The source type for this event.

event_severity :: Lens' Event (Maybe Text) Source #

The severity of the event.

Values: ERROR, INFO

event_sourceIdentifier :: Lens' Event (Maybe Text) Source #

The identifier for the source of the event.

event_date :: Lens' Event (Maybe UTCTime) Source #

The date and time of the event.

event_eventCategories :: Lens' Event (Maybe [Text]) Source #

A list of the event categories.

Values: Configuration, Management, Monitoring, Security, Pending

event_message :: Lens' Event (Maybe Text) Source #

The text of this event.

event_eventId :: Lens' Event (Maybe Text) Source #

The identifier of the event.

EventCategoriesMap

eventCategoriesMap_sourceType :: Lens' EventCategoriesMap (Maybe Text) Source #

The source type, such as cluster or cluster-snapshot, that the returned categories belong to.

eventCategoriesMap_events :: Lens' EventCategoriesMap (Maybe [EventInfoMap]) Source #

The events in the event category.

EventInfoMap

eventInfoMap_eventDescription :: Lens' EventInfoMap (Maybe Text) Source #

The description of an Amazon Redshift event.

eventInfoMap_severity :: Lens' EventInfoMap (Maybe Text) Source #

The severity of the event.

Values: ERROR, INFO

eventInfoMap_eventCategories :: Lens' EventInfoMap (Maybe [Text]) Source #

The category of an Amazon Redshift event.

eventInfoMap_eventId :: Lens' EventInfoMap (Maybe Text) Source #

The identifier of an Amazon Redshift event.

EventSubscription

eventSubscription_status :: Lens' EventSubscription (Maybe Text) Source #

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.

eventSubscription_customerAwsId :: Lens' EventSubscription (Maybe Text) Source #

The Amazon Web Services account associated with the Amazon Redshift event notification subscription.

eventSubscription_custSubscriptionId :: Lens' EventSubscription (Maybe Text) Source #

The name of the Amazon Redshift event notification subscription.

eventSubscription_snsTopicArn :: Lens' EventSubscription (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event notification subscription.

eventSubscription_enabled :: Lens' EventSubscription (Maybe Bool) Source #

A boolean value indicating whether the subscription is enabled; true indicates that the subscription is enabled.

eventSubscription_sourceType :: Lens' EventSubscription (Maybe Text) Source #

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.

eventSubscription_severity :: Lens' EventSubscription (Maybe Text) Source #

The event severity specified in the Amazon Redshift event notification subscription.

Values: ERROR, INFO

eventSubscription_subscriptionCreationTime :: Lens' EventSubscription (Maybe UTCTime) Source #

The date and time the Amazon Redshift event notification subscription was created.

eventSubscription_eventCategoriesList :: Lens' EventSubscription (Maybe [Text]) Source #

The list of Amazon Redshift event categories specified in the event notification subscription.

Values: Configuration, Management, Monitoring, Security, Pending

eventSubscription_tags :: Lens' EventSubscription (Maybe [Tag]) Source #

The list of tags for the event subscription.

eventSubscription_sourceIdsList :: Lens' EventSubscription (Maybe [Text]) Source #

A list of the sources that publish events to the Amazon Redshift event notification subscription.

HsmClientCertificate

hsmClientCertificate_hsmClientCertificateIdentifier :: Lens' HsmClientCertificate (Maybe Text) Source #

The identifier of the HSM client certificate.

hsmClientCertificate_hsmClientCertificatePublicKey :: Lens' HsmClientCertificate (Maybe Text) Source #

The public key that the Amazon Redshift cluster will use to connect to the HSM. You must register the public key in the HSM.

hsmClientCertificate_tags :: Lens' HsmClientCertificate (Maybe [Tag]) Source #

The list of tags for the HSM client certificate.

HsmConfiguration

hsmConfiguration_hsmConfigurationIdentifier :: Lens' HsmConfiguration (Maybe Text) Source #

The name of the Amazon Redshift HSM configuration.

hsmConfiguration_hsmPartitionName :: Lens' HsmConfiguration (Maybe Text) Source #

The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

hsmConfiguration_description :: Lens' HsmConfiguration (Maybe Text) Source #

A text description of the HSM configuration.

hsmConfiguration_tags :: Lens' HsmConfiguration (Maybe [Tag]) Source #

The list of tags for the HSM configuration.

hsmConfiguration_hsmIpAddress :: Lens' HsmConfiguration (Maybe Text) Source #

The IP address that the Amazon Redshift cluster must use to access the HSM.

HsmStatus

hsmStatus_status :: Lens' HsmStatus (Maybe Text) Source #

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

Values: active, applying

hsmStatus_hsmConfigurationIdentifier :: Lens' HsmStatus (Maybe Text) Source #

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.

hsmStatus_hsmClientCertificateIdentifier :: Lens' HsmStatus (Maybe Text) Source #

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

IPRange

iPRange_status :: Lens' IPRange (Maybe Text) Source #

The status of the IP range, for example, "authorized".

iPRange_cidrip :: Lens' IPRange (Maybe Text) Source #

The IP range in Classless Inter-Domain Routing (CIDR) notation.

iPRange_tags :: Lens' IPRange (Maybe [Tag]) Source #

The list of tags for the IP range.

LoggingStatus

loggingStatus_lastFailureTime :: Lens' LoggingStatus (Maybe UTCTime) Source #

The last time when logs failed to be delivered.

loggingStatus_lastSuccessfulDeliveryTime :: Lens' LoggingStatus (Maybe UTCTime) Source #

The last time that logs were delivered.

loggingStatus_s3KeyPrefix :: Lens' LoggingStatus (Maybe Text) Source #

The prefix applied to the log file names.

loggingStatus_bucketName :: Lens' LoggingStatus (Maybe Text) Source #

The name of the S3 bucket where the log files are stored.

loggingStatus_loggingEnabled :: Lens' LoggingStatus (Maybe Bool) Source #

true if logging is on, false if logging is off.

loggingStatus_lastFailureMessage :: Lens' LoggingStatus (Maybe Text) Source #

The message indicating that logs failed to be delivered.

MaintenanceTrack

maintenanceTrack_databaseVersion :: Lens' MaintenanceTrack (Maybe Text) Source #

The version number for the cluster release.

maintenanceTrack_maintenanceTrackName :: Lens' MaintenanceTrack (Maybe Text) Source #

The name of the maintenance track. Possible values are current and trailing.

maintenanceTrack_updateTargets :: Lens' MaintenanceTrack (Maybe [UpdateTarget]) Source #

An array of UpdateTarget objects to update with the maintenance track.

NetworkInterface

networkInterface_networkInterfaceId :: Lens' NetworkInterface (Maybe Text) Source #

The network interface identifier.

networkInterface_subnetId :: Lens' NetworkInterface (Maybe Text) Source #

The subnet identifier.

networkInterface_availabilityZone :: Lens' NetworkInterface (Maybe Text) Source #

The Availability Zone.

networkInterface_privateIpAddress :: Lens' NetworkInterface (Maybe Text) Source #

The IPv4 address of the network interface within the subnet.

NodeConfigurationOption

nodeConfigurationOption_mode :: Lens' NodeConfigurationOption (Maybe Mode) Source #

The category of the node configuration recommendation.

nodeConfigurationOption_numberOfNodes :: Lens' NodeConfigurationOption (Maybe Int) Source #

The number of nodes.

nodeConfigurationOption_nodeType :: Lens' NodeConfigurationOption (Maybe Text) Source #

The node type, such as, "ds2.8xlarge".

nodeConfigurationOption_estimatedDiskUtilizationPercent :: Lens' NodeConfigurationOption (Maybe Double) Source #

The estimated disk utilizaton percentage.

NodeConfigurationOptionsFilter

nodeConfigurationOptionsFilter_values :: Lens' NodeConfigurationOptionsFilter (Maybe [Text]) Source #

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

nodeConfigurationOptionsFilter_operator :: Lens' NodeConfigurationOptionsFilter (Maybe OperatorType) Source #

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

nodeConfigurationOptionsFilter_name :: Lens' NodeConfigurationOptionsFilter (Maybe NodeConfigurationOptionsFilterName) Source #

The name of the element to filter.

OrderableClusterOption

orderableClusterOption_availabilityZones :: Lens' OrderableClusterOption (Maybe [AvailabilityZone]) Source #

A list of availability zones for the orderable cluster.

orderableClusterOption_clusterType :: Lens' OrderableClusterOption (Maybe Text) Source #

The cluster type, for example multi-node.

orderableClusterOption_clusterVersion :: Lens' OrderableClusterOption (Maybe Text) Source #

The version of the orderable cluster.

orderableClusterOption_nodeType :: Lens' OrderableClusterOption (Maybe Text) Source #

The node type for the orderable cluster.

Parameter

parameter_applyType :: Lens' Parameter (Maybe ParameterApplyType) Source #

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.

parameter_parameterValue :: Lens' Parameter (Maybe Text) Source #

The value of the parameter. If ParameterName is wlm_json_configuration, then the maximum size of ParameterValue is 8000 characters.

parameter_minimumEngineVersion :: Lens' Parameter (Maybe Text) Source #

The earliest engine version to which the parameter can apply.

parameter_source :: Lens' Parameter (Maybe Text) Source #

The source of the parameter value, such as "engine-default" or "user".

parameter_isModifiable :: Lens' Parameter (Maybe Bool) Source #

If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

parameter_dataType :: Lens' Parameter (Maybe Text) Source #

The data type of the parameter.

parameter_allowedValues :: Lens' Parameter (Maybe Text) Source #

The valid range of values for the parameter.

parameter_parameterName :: Lens' Parameter (Maybe Text) Source #

The name of the parameter.

parameter_description :: Lens' Parameter (Maybe Text) Source #

A description of the parameter.

PartnerIntegrationInfo

partnerIntegrationInfo_status :: Lens' PartnerIntegrationInfo (Maybe PartnerIntegrationStatus) Source #

The partner integration status.

partnerIntegrationInfo_createdAt :: Lens' PartnerIntegrationInfo (Maybe UTCTime) Source #

The date (UTC) that the partner integration was created.

partnerIntegrationInfo_partnerName :: Lens' PartnerIntegrationInfo (Maybe Text) Source #

The name of the partner.

partnerIntegrationInfo_statusMessage :: Lens' PartnerIntegrationInfo (Maybe Text) Source #

The status message provided by the partner.

partnerIntegrationInfo_databaseName :: Lens' PartnerIntegrationInfo (Maybe Text) Source #

The name of the database that receives data from a partner.

partnerIntegrationInfo_updatedAt :: Lens' PartnerIntegrationInfo (Maybe UTCTime) Source #

The date (UTC) that the partner integration status was last updated by the partner.

PartnerIntegrationInputMessage

partnerIntegrationInputMessage_accountId :: Lens' PartnerIntegrationInputMessage Text Source #

The Amazon Web Services account ID that owns the cluster.

partnerIntegrationInputMessage_clusterIdentifier :: Lens' PartnerIntegrationInputMessage Text Source #

The cluster identifier of the cluster that receives data from the partner.

partnerIntegrationInputMessage_databaseName :: Lens' PartnerIntegrationInputMessage Text Source #

The name of the database that receives data from the partner.

partnerIntegrationInputMessage_partnerName :: Lens' PartnerIntegrationInputMessage Text Source #

The name of the partner that is authorized to send data.

PartnerIntegrationOutputMessage

partnerIntegrationOutputMessage_partnerName :: Lens' PartnerIntegrationOutputMessage (Maybe Text) Source #

The name of the partner that is authorized to send data.

partnerIntegrationOutputMessage_databaseName :: Lens' PartnerIntegrationOutputMessage (Maybe Text) Source #

The name of the database that receives data from the partner.

PauseClusterMessage

pauseClusterMessage_clusterIdentifier :: Lens' PauseClusterMessage Text Source #

The identifier of the cluster to be paused.

PendingModifiedValues

pendingModifiedValues_encryptionType :: Lens' PendingModifiedValues (Maybe Text) Source #

The encryption type for a cluster. Possible values are: KMS and None.

pendingModifiedValues_enhancedVpcRouting :: Lens' PendingModifiedValues (Maybe Bool) Source #

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

pendingModifiedValues_masterUserPassword :: Lens' PendingModifiedValues (Maybe Text) Source #

The pending or in-progress change of the admin user password for the cluster.

pendingModifiedValues_publiclyAccessible :: Lens' PendingModifiedValues (Maybe Bool) Source #

The pending or in-progress change of the ability to connect to the cluster from the public network.

pendingModifiedValues_maintenanceTrackName :: Lens' PendingModifiedValues (Maybe Text) Source #

The name of the maintenance track that the cluster will change to during the next maintenance window.

pendingModifiedValues_automatedSnapshotRetentionPeriod :: Lens' PendingModifiedValues (Maybe Int) Source #

The pending or in-progress change of the automated snapshot retention period.

pendingModifiedValues_clusterIdentifier :: Lens' PendingModifiedValues (Maybe Text) Source #

The pending or in-progress change of the new identifier for the cluster.

pendingModifiedValues_numberOfNodes :: Lens' PendingModifiedValues (Maybe Int) Source #

The pending or in-progress change of the number of nodes in the cluster.

pendingModifiedValues_clusterType :: Lens' PendingModifiedValues (Maybe Text) Source #

The pending or in-progress change of the cluster type.

pendingModifiedValues_clusterVersion :: Lens' PendingModifiedValues (Maybe Text) Source #

The pending or in-progress change of the service version.

pendingModifiedValues_nodeType :: Lens' PendingModifiedValues (Maybe Text) Source #

The pending or in-progress change of the cluster's node type.

RecurringCharge

recurringCharge_recurringChargeFrequency :: Lens' RecurringCharge (Maybe Text) Source #

The frequency at which the recurring charge amount is applied.

recurringCharge_recurringChargeAmount :: Lens' RecurringCharge (Maybe Double) Source #

The amount charged per the period of time specified by the recurring charge frequency.

ReservedNode

reservedNode_reservedNodeOfferingType :: Lens' ReservedNode (Maybe ReservedNodeOfferingType) Source #

 

reservedNode_state :: Lens' ReservedNode (Maybe Text) Source #

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.

reservedNode_currencyCode :: Lens' ReservedNode (Maybe Text) Source #

The currency code for the reserved cluster.

reservedNode_startTime :: Lens' ReservedNode (Maybe UTCTime) Source #

The time the reservation started. You purchase a reserved node offering for a duration. This is the start time of that duration.

reservedNode_nodeCount :: Lens' ReservedNode (Maybe Int) Source #

The number of reserved compute nodes.

reservedNode_reservedNodeId :: Lens' ReservedNode (Maybe Text) Source #

The unique identifier for the reservation.

reservedNode_reservedNodeOfferingId :: Lens' ReservedNode (Maybe Text) Source #

The identifier for the reserved node offering.

reservedNode_recurringCharges :: Lens' ReservedNode (Maybe [RecurringCharge]) Source #

The recurring charges for the reserved node.

reservedNode_offeringType :: Lens' ReservedNode (Maybe Text) Source #

The anticipated utilization of the reserved node, as defined in the reserved node offering.

reservedNode_usagePrice :: Lens' ReservedNode (Maybe Double) Source #

The hourly rate Amazon Redshift charges you for this reserved node.

reservedNode_nodeType :: Lens' ReservedNode (Maybe Text) Source #

The node type of the reserved node.

reservedNode_fixedPrice :: Lens' ReservedNode (Maybe Double) Source #

The fixed cost Amazon Redshift charges you for this reserved node.

reservedNode_duration :: Lens' ReservedNode (Maybe Int) Source #

The duration of the node reservation in seconds.

ReservedNodeOffering

reservedNodeOffering_reservedNodeOfferingType :: Lens' ReservedNodeOffering (Maybe ReservedNodeOfferingType) Source #

 

reservedNodeOffering_currencyCode :: Lens' ReservedNodeOffering (Maybe Text) Source #

The currency code for the compute nodes offering.

reservedNodeOffering_reservedNodeOfferingId :: Lens' ReservedNodeOffering (Maybe Text) Source #

The offering identifier.

reservedNodeOffering_recurringCharges :: Lens' ReservedNodeOffering (Maybe [RecurringCharge]) Source #

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.

reservedNodeOffering_offeringType :: Lens' ReservedNodeOffering (Maybe Text) Source #

The anticipated utilization of the reserved node, as defined in the reserved node offering.

reservedNodeOffering_usagePrice :: Lens' ReservedNodeOffering (Maybe Double) Source #

The rate you are charged for each hour the cluster that is using the offering is running.

reservedNodeOffering_nodeType :: Lens' ReservedNodeOffering (Maybe Text) Source #

The node type offered by the reserved node offering.

reservedNodeOffering_fixedPrice :: Lens' ReservedNodeOffering (Maybe Double) Source #

The upfront fixed charge you will pay to purchase the specific reserved node offering.

reservedNodeOffering_duration :: Lens' ReservedNodeOffering (Maybe Int) Source #

The duration, in seconds, for which the offering will reserve the node.

ResizeClusterMessage

resizeClusterMessage_numberOfNodes :: Lens' ResizeClusterMessage (Maybe Int) Source #

The new number of nodes for the cluster. If not specified, the cluster's current number of nodes is used.

resizeClusterMessage_classic :: Lens' ResizeClusterMessage (Maybe Bool) Source #

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.

resizeClusterMessage_clusterType :: Lens' ResizeClusterMessage (Maybe Text) Source #

The new cluster type for the specified cluster.

resizeClusterMessage_nodeType :: Lens' ResizeClusterMessage (Maybe Text) Source #

The new node type for the nodes you are adding. If not specified, the cluster's current node type is used.

resizeClusterMessage_clusterIdentifier :: Lens' ResizeClusterMessage Text Source #

The unique identifier for the cluster to resize.

ResizeInfo

resizeInfo_allowCancelResize :: Lens' ResizeInfo (Maybe Bool) Source #

A boolean value indicating if the resize operation can be cancelled.

resizeInfo_resizeType :: Lens' ResizeInfo (Maybe Text) Source #

Returns the value ClassicResize.

ResizeProgressMessage

resizeProgressMessage_importTablesNotStarted :: Lens' ResizeProgressMessage (Maybe [Text]) Source #

The names of tables that have not been yet imported.

Valid Values: List of table names

resizeProgressMessage_status :: Lens' ResizeProgressMessage (Maybe Text) Source #

The status of the resize operation.

Valid Values: NONE | IN_PROGRESS | FAILED | SUCCEEDED | CANCELLING

resizeProgressMessage_estimatedTimeToCompletionInSeconds :: Lens' ResizeProgressMessage (Maybe Integer) Source #

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.

resizeProgressMessage_avgResizeRateInMegaBytesPerSecond :: Lens' ResizeProgressMessage (Maybe Double) Source #

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.

resizeProgressMessage_targetNumberOfNodes :: Lens' ResizeProgressMessage (Maybe Int) Source #

The number of nodes that the cluster will have after the resize operation is complete.

resizeProgressMessage_targetEncryptionType :: Lens' ResizeProgressMessage (Maybe Text) Source #

The type of encryption for the cluster after the resize is complete.

Possible values are KMS and None.

resizeProgressMessage_targetNodeType :: Lens' ResizeProgressMessage (Maybe Text) Source #

The node type that the cluster will have after the resize operation is complete.

resizeProgressMessage_importTablesInProgress :: Lens' ResizeProgressMessage (Maybe [Text]) Source #

The names of tables that are being currently imported.

Valid Values: List of table names.

resizeProgressMessage_resizeType :: Lens' ResizeProgressMessage (Maybe Text) Source #

An enum with possible values of ClassicResize and ElasticResize. These values describe the type of resize operation being performed.

resizeProgressMessage_importTablesCompleted :: Lens' ResizeProgressMessage (Maybe [Text]) Source #

The names of tables that have been completely imported .

Valid Values: List of table names.

resizeProgressMessage_progressInMegaBytes :: Lens' ResizeProgressMessage (Maybe Integer) Source #

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

resizeProgressMessage_dataTransferProgressPercent :: Lens' ResizeProgressMessage (Maybe Double) Source #

The percent of data transferred from source cluster to target cluster.

resizeProgressMessage_totalResizeDataInMegaBytes :: Lens' ResizeProgressMessage (Maybe Integer) Source #

The estimated total amount of data, in megabytes, on the cluster before the resize operation began.

resizeProgressMessage_targetClusterType :: Lens' ResizeProgressMessage (Maybe Text) Source #

The cluster type after the resize operation is complete.

Valid Values: multi-node | single-node

resizeProgressMessage_message :: Lens' ResizeProgressMessage (Maybe Text) Source #

An optional string to provide additional details about the resize action.

resizeProgressMessage_elapsedTimeInSeconds :: Lens' ResizeProgressMessage (Maybe Integer) Source #

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.

RestoreStatus

restoreStatus_status :: Lens' RestoreStatus (Maybe Text) Source #

The status of the restore action. Returns starting, restoring, completed, or failed.

restoreStatus_estimatedTimeToCompletionInSeconds :: Lens' RestoreStatus (Maybe Integer) Source #

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.

restoreStatus_currentRestoreRateInMegaBytesPerSecond :: Lens' RestoreStatus (Maybe Double) Source #

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.

restoreStatus_progressInMegaBytes :: Lens' RestoreStatus (Maybe Integer) Source #

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.

restoreStatus_elapsedTimeInSeconds :: Lens' RestoreStatus (Maybe Integer) Source #

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.

restoreStatus_snapshotSizeInMegaBytes :: Lens' RestoreStatus (Maybe Integer) Source #

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.

ResumeClusterMessage

resumeClusterMessage_clusterIdentifier :: Lens' ResumeClusterMessage Text Source #

The identifier of the cluster to be resumed.

RevisionTarget

revisionTarget_databaseRevisionReleaseDate :: Lens' RevisionTarget (Maybe UTCTime) Source #

The date on which the database revision was released.

revisionTarget_databaseRevision :: Lens' RevisionTarget (Maybe Text) Source #

A unique string that identifies the version to update the cluster to. You can use this value in ModifyClusterDbRevision.

revisionTarget_description :: Lens' RevisionTarget (Maybe Text) Source #

A string that describes the changes and features that will be applied to the cluster when it is updated to the corresponding ClusterDbRevision.

ScheduledAction

scheduledAction_state :: Lens' ScheduledAction (Maybe ScheduledActionState) Source #

The state of the scheduled action. For example, DISABLED.

scheduledAction_targetAction :: Lens' ScheduledAction (Maybe ScheduledActionType) Source #

A JSON format string of the Amazon Redshift API operation with input parameters.

"{\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}".

scheduledAction_startTime :: Lens' ScheduledAction (Maybe UTCTime) Source #

The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

scheduledAction_schedule :: Lens' ScheduledAction (Maybe Text) Source #

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.

scheduledAction_scheduledActionName :: Lens' ScheduledAction (Maybe Text) Source #

The name of the scheduled action.

scheduledAction_scheduledActionDescription :: Lens' ScheduledAction (Maybe Text) Source #

The description of the scheduled action.

scheduledAction_nextInvocations :: Lens' ScheduledAction (Maybe [UTCTime]) Source #

List of times when the scheduled action will run.

scheduledAction_endTime :: Lens' ScheduledAction (Maybe UTCTime) Source #

The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

scheduledAction_iamRole :: Lens' ScheduledAction (Maybe Text) Source #

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.

ScheduledActionFilter

scheduledActionFilter_name :: Lens' ScheduledActionFilter ScheduledActionFilterName Source #

The type of element to filter.

scheduledActionFilter_values :: Lens' ScheduledActionFilter [Text] Source #

List of values. Compare if the value (of type defined by Name) equals an item in the list of scheduled actions.

ScheduledActionType

scheduledActionType_resizeCluster :: Lens' ScheduledActionType (Maybe ResizeClusterMessage) Source #

An action that runs a ResizeCluster API operation.

scheduledActionType_resumeCluster :: Lens' ScheduledActionType (Maybe ResumeClusterMessage) Source #

An action that runs a ResumeCluster API operation.

scheduledActionType_pauseCluster :: Lens' ScheduledActionType (Maybe PauseClusterMessage) Source #

An action that runs a PauseCluster API operation.

Snapshot

snapshot_status :: Lens' Snapshot (Maybe Text) Source #

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

snapshot_restorableNodeTypes :: Lens' Snapshot (Maybe [Text]) Source #

The list of node types that this cluster snapshot is able to restore into.

snapshot_accountsWithRestoreAccess :: Lens' Snapshot (Maybe [AccountWithRestoreAccess]) Source #

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.

snapshot_manualSnapshotRetentionPeriod :: Lens' Snapshot (Maybe Int) Source #

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.

snapshot_enhancedVpcRouting :: Lens' Snapshot (Maybe Bool) Source #

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

snapshot_snapshotIdentifier :: Lens' Snapshot (Maybe Text) Source #

The snapshot identifier that is provided in the request.

snapshot_engineFullVersion :: Lens' Snapshot (Maybe Text) Source #

The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.

snapshot_encryptedWithHSM :: Lens' Snapshot (Maybe Bool) Source #

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.

snapshot_masterUsername :: Lens' Snapshot (Maybe Text) Source #

The admin user name for the cluster.

snapshot_sourceRegion :: Lens' Snapshot (Maybe Text) Source #

The source region from which the snapshot was copied.

snapshot_maintenanceTrackName :: Lens' Snapshot (Maybe Text) Source #

The name of the maintenance track for the snapshot.

snapshot_snapshotRetentionStartTime :: Lens' Snapshot (Maybe UTCTime) Source #

A timestamp representing the start of the retention period for the snapshot.

snapshot_manualSnapshotRemainingDays :: Lens' Snapshot (Maybe Int) Source #

The number of days until a manual snapshot will pass its retention period.

snapshot_vpcId :: Lens' Snapshot (Maybe Text) Source #

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

snapshot_backupProgressInMegaBytes :: Lens' Snapshot (Maybe Double) Source #

The number of megabytes that have been transferred to the snapshot backup.

snapshot_encrypted :: Lens' Snapshot (Maybe Bool) Source #

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

snapshot_clusterIdentifier :: Lens' Snapshot (Maybe Text) Source #

The identifier of the cluster for which the snapshot was taken.

snapshot_numberOfNodes :: Lens' Snapshot (Maybe Int) Source #

The number of nodes in the cluster.

snapshot_snapshotType :: Lens' Snapshot (Maybe Text) Source #

The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".

snapshot_kmsKeyId :: Lens' Snapshot (Maybe Text) Source #

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.

snapshot_availabilityZone :: Lens' Snapshot (Maybe Text) Source #

The Availability Zone in which the cluster was created.

snapshot_currentBackupRateInMegaBytesPerSecond :: Lens' Snapshot (Maybe Double) Source #

The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

snapshot_snapshotCreateTime :: Lens' Snapshot (Maybe UTCTime) Source #

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.

snapshot_clusterVersion :: Lens' Snapshot (Maybe Text) Source #

The version ID of the Amazon Redshift engine that is running on the cluster.

snapshot_ownerAccount :: Lens' Snapshot (Maybe Text) Source #

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.

snapshot_nodeType :: Lens' Snapshot (Maybe Text) Source #

The node type of the nodes in the cluster.

snapshot_elapsedTimeInSeconds :: Lens' Snapshot (Maybe Integer) Source #

The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

snapshot_clusterCreateTime :: Lens' Snapshot (Maybe UTCTime) Source #

The time (UTC) when the cluster was originally created.

snapshot_estimatedSecondsToCompletion :: Lens' Snapshot (Maybe Integer) Source #

The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

snapshot_actualIncrementalBackupSizeInMegaBytes :: Lens' Snapshot (Maybe Double) Source #

The size of the incremental backup.

snapshot_tags :: Lens' Snapshot (Maybe [Tag]) Source #

The list of tags for the cluster snapshot.

snapshot_port :: Lens' Snapshot (Maybe Int) Source #

The port that the cluster is listening on.

snapshot_totalBackupSizeInMegaBytes :: Lens' Snapshot (Maybe Double) Source #

The size of the complete set of backup data that would be used to restore the cluster.

snapshot_dbName :: Lens' Snapshot (Maybe Text) Source #

The name of the database that was created when the cluster was created.

SnapshotCopyGrant

snapshotCopyGrant_kmsKeyId :: Lens' SnapshotCopyGrant (Maybe Text) Source #

The unique identifier of the customer master key (CMK) in Amazon Web Services KMS to which Amazon Redshift is granted permission.

snapshotCopyGrant_snapshotCopyGrantName :: Lens' SnapshotCopyGrant (Maybe Text) Source #

The name of the snapshot copy grant.

snapshotCopyGrant_tags :: Lens' SnapshotCopyGrant (Maybe [Tag]) Source #

A list of tag instances.

SnapshotErrorMessage

snapshotErrorMessage_failureReason :: Lens' SnapshotErrorMessage (Maybe Text) Source #

The text message describing the error.

snapshotErrorMessage_snapshotIdentifier :: Lens' SnapshotErrorMessage (Maybe Text) Source #

A unique identifier for the snapshot returning the error.

snapshotErrorMessage_snapshotClusterIdentifier :: Lens' SnapshotErrorMessage (Maybe Text) Source #

A unique identifier for the cluster.

snapshotErrorMessage_failureCode :: Lens' SnapshotErrorMessage (Maybe Text) Source #

The failure code for the error.

SnapshotSchedule

snapshotSchedule_associatedClusters :: Lens' SnapshotSchedule (Maybe [ClusterAssociatedToSchedule]) Source #

A list of clusters associated with the schedule. A maximum of 100 clusters is returned.

snapshotSchedule_nextInvocations :: Lens' SnapshotSchedule (Maybe [UTCTime]) Source #

 

snapshotSchedule_scheduleDefinitions :: Lens' SnapshotSchedule (Maybe [Text]) Source #

A list of ScheduleDefinitions.

snapshotSchedule_scheduleDescription :: Lens' SnapshotSchedule (Maybe Text) Source #

The description of the schedule.

snapshotSchedule_scheduleIdentifier :: Lens' SnapshotSchedule (Maybe Text) Source #

A unique identifier for the schedule.

snapshotSchedule_associatedClusterCount :: Lens' SnapshotSchedule (Maybe Int) Source #

The number of clusters associated with the schedule.

snapshotSchedule_tags :: Lens' SnapshotSchedule (Maybe [Tag]) Source #

An optional set of tags describing the schedule.

SnapshotSortingEntity

snapshotSortingEntity_sortOrder :: Lens' SnapshotSortingEntity (Maybe SortByOrder) Source #

The order for listing the attributes.

snapshotSortingEntity_attribute :: Lens' SnapshotSortingEntity SnapshotAttributeToSortBy Source #

The category for sorting the snapshots.

Subnet

subnet_subnetStatus :: Lens' Subnet (Maybe Text) Source #

The status of the subnet.

subnet_subnetIdentifier :: Lens' Subnet (Maybe Text) Source #

The identifier of the subnet.

subnet_subnetAvailabilityZone :: Lens' Subnet (Maybe AvailabilityZone) Source #

 

SupportedOperation

supportedOperation_operationName :: Lens' SupportedOperation (Maybe Text) Source #

A list of the supported operations.

SupportedPlatform

supportedPlatform_name :: Lens' SupportedPlatform (Maybe Text) Source #

 

TableRestoreStatus

tableRestoreStatus_status :: Lens' TableRestoreStatus (Maybe TableRestoreStatusType) Source #

A value that describes the current state of the table restore request.

Valid Values: SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS

tableRestoreStatus_targetSchemaName :: Lens' TableRestoreStatus (Maybe Text) Source #

The name of the schema to restore the table to.

tableRestoreStatus_snapshotIdentifier :: Lens' TableRestoreStatus (Maybe Text) Source #

The identifier of the snapshot that the table is being restored from.

tableRestoreStatus_sourceDatabaseName :: Lens' TableRestoreStatus (Maybe Text) Source #

The name of the source database that contains the table being restored.

tableRestoreStatus_tableRestoreRequestId :: Lens' TableRestoreStatus (Maybe Text) Source #

The unique identifier for the table restore request.

tableRestoreStatus_newTableName :: Lens' TableRestoreStatus (Maybe Text) Source #

The name of the table to create as a result of the table restore request.

tableRestoreStatus_targetDatabaseName :: Lens' TableRestoreStatus (Maybe Text) Source #

The name of the database to restore the table to.

tableRestoreStatus_sourceSchemaName :: Lens' TableRestoreStatus (Maybe Text) Source #

The name of the source schema that contains the table being restored.

tableRestoreStatus_clusterIdentifier :: Lens' TableRestoreStatus (Maybe Text) Source #

The identifier of the Amazon Redshift cluster that the table is being restored to.

tableRestoreStatus_requestTime :: Lens' TableRestoreStatus (Maybe UTCTime) Source #

The time that the table restore request was made, in Universal Coordinated Time (UTC).

tableRestoreStatus_sourceTableName :: Lens' TableRestoreStatus (Maybe Text) Source #

The name of the source table being restored.

tableRestoreStatus_totalDataInMegaBytes :: Lens' TableRestoreStatus (Maybe Integer) Source #

The total amount of data to restore to the new table, in megabytes (MB).

tableRestoreStatus_progressInMegaBytes :: Lens' TableRestoreStatus (Maybe Integer) Source #

The amount of data restored to the new table so far, in megabytes (MB).

tableRestoreStatus_message :: Lens' TableRestoreStatus (Maybe Text) Source #

A description of the status of the table restore request. Status values include SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS.

Tag

tag_value :: Lens' Tag (Maybe Text) Source #

The value for the resource tag.

tag_key :: Lens' Tag (Maybe Text) Source #

The key, or name, for the resource tag.

TaggedResource

taggedResource_tag :: Lens' TaggedResource (Maybe Tag) Source #

The tag for the resource.

taggedResource_resourceType :: Lens' TaggedResource (Maybe Text) Source #

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.

taggedResource_resourceName :: Lens' TaggedResource (Maybe Text) Source #

The Amazon Resource Name (ARN) with which the tag is associated, for example: arn:aws:redshift:us-east-2:123456789:cluster:t1.

UpdateTarget

updateTarget_databaseVersion :: Lens' UpdateTarget (Maybe Text) Source #

The cluster version for the new maintenance track.

updateTarget_maintenanceTrackName :: Lens' UpdateTarget (Maybe Text) Source #

The name of the new maintenance track.

updateTarget_supportedOperations :: Lens' UpdateTarget (Maybe [SupportedOperation]) Source #

A list of operations supported by the maintenance track.

UsageLimit

usageLimit_amount :: Lens' UsageLimit (Maybe Integer) Source #

The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).

usageLimit_limitType :: Lens' UsageLimit (Maybe UsageLimitLimitType) Source #

The type of limit. Depending on the feature type, this can be based on a time duration or data size.

usageLimit_usageLimitId :: Lens' UsageLimit (Maybe Text) Source #

The identifier of the usage limit.

usageLimit_period :: Lens' UsageLimit (Maybe UsageLimitPeriod) Source #

The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

usageLimit_clusterIdentifier :: Lens' UsageLimit (Maybe Text) Source #

The identifier of the cluster with a usage limit.

usageLimit_breachAction :: Lens' UsageLimit (Maybe UsageLimitBreachAction) Source #

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.

usageLimit_featureType :: Lens' UsageLimit (Maybe UsageLimitFeatureType) Source #

The Amazon Redshift feature to which the limit applies.

usageLimit_tags :: Lens' UsageLimit (Maybe [Tag]) Source #

A list of tag instances.

VpcEndpoint

vpcEndpoint_vpcId :: Lens' VpcEndpoint (Maybe Text) Source #

The VPC identifier that the endpoint is associated.

vpcEndpoint_networkInterfaces :: Lens' VpcEndpoint (Maybe [NetworkInterface]) Source #

One or more network interfaces of the endpoint. Also known as an interface endpoint.

vpcEndpoint_vpcEndpointId :: Lens' VpcEndpoint (Maybe Text) Source #

The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.

VpcSecurityGroupMembership

vpcSecurityGroupMembership_status :: Lens' VpcSecurityGroupMembership (Maybe Text) Source #

The status of the VPC security group.

vpcSecurityGroupMembership_vpcSecurityGroupId :: Lens' VpcSecurityGroupMembership (Maybe Text) Source #

The identifier of the VPC security group.