amazonka-redshift-serverless-2.0: Amazon Redshift Serverless SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.RedshiftServerLess.Lens

Description

 
Synopsis

Operations

ConvertRecoveryPointToSnapshot

convertRecoveryPointToSnapshot_tags :: Lens' ConvertRecoveryPointToSnapshot (Maybe [Tag]) Source #

An array of Tag objects to associate with the created snapshot.

CreateEndpointAccess

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

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

createEndpointAccess_endpointName :: Lens' CreateEndpointAccess Text Source #

The name of the VPC endpoint. 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_subnetIds :: Lens' CreateEndpointAccess [Text] Source #

The unique identifers of subnets from which Amazon Redshift Serverless chooses one to deploy a VPC endpoint.

createEndpointAccess_workgroupName :: Lens' CreateEndpointAccess Text Source #

The name of the workgroup to associate with the VPC endpoint.

CreateNamespace

createNamespace_adminUserPassword :: Lens' CreateNamespace (Maybe Text) Source #

The password of the administrator for the first database created in the namespace.

createNamespace_adminUsername :: Lens' CreateNamespace (Maybe Text) Source #

The username of the administrator for the first database created in the namespace.

createNamespace_dbName :: Lens' CreateNamespace (Maybe Text) Source #

The name of the first database created in the namespace.

createNamespace_defaultIamRoleArn :: Lens' CreateNamespace (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.

createNamespace_iamRoles :: Lens' CreateNamespace (Maybe [Text]) Source #

A list of IAM roles to associate with the namespace.

createNamespace_kmsKeyId :: Lens' CreateNamespace (Maybe Text) Source #

The ID of the Amazon Web Services Key Management Service key used to encrypt your data.

createNamespace_logExports :: Lens' CreateNamespace (Maybe [LogExport]) Source #

The types of logs the namespace can export. Available export types are userlog, connectionlog, and useractivitylog.

createNamespace_tags :: Lens' CreateNamespace (Maybe [Tag]) Source #

A list of tag instances.

CreateSnapshot

createSnapshot_retentionPeriod :: Lens' CreateSnapshot (Maybe Int) Source #

How long to retain the created snapshot.

createSnapshot_tags :: Lens' CreateSnapshot (Maybe [Tag]) Source #

An array of Tag objects to associate with the snapshot.

createSnapshot_namespaceName :: Lens' CreateSnapshot Text Source #

The namespace to create a snapshot for.

CreateUsageLimit

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

The action that Amazon Redshift Serverless takes when the limit is reached. The default is log.

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_amount :: Lens' CreateUsageLimit Integer Source #

The limit amount. If time-based, this amount is in Redshift Processing Units (RPU) consumed per hour. If data-based, this amount is in terabytes (TB) of data transferred between Regions in cross-account sharing. The value must be a positive number.

createUsageLimit_resourceArn :: Lens' CreateUsageLimit Text Source #

The Amazon Resource Name (ARN) of the Amazon Redshift Serverless resource to create the usage limit for.

createUsageLimit_usageType :: Lens' CreateUsageLimit UsageLimitUsageType Source #

The type of Amazon Redshift Serverless usage to create a usage limit for.

CreateWorkgroup

createWorkgroup_baseCapacity :: Lens' CreateWorkgroup (Maybe Int) Source #

The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).

createWorkgroup_configParameters :: Lens' CreateWorkgroup (Maybe [ConfigParameter]) Source #

An array of parameters to set for more control over a serverless database. The options are datestyle, enable_user_activity_logging, query_group, search_path, and max_query_execution_time.

createWorkgroup_enhancedVpcRouting :: Lens' CreateWorkgroup (Maybe Bool) Source #

The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC instead of over the internet.

createWorkgroup_port :: Lens' CreateWorkgroup (Maybe Int) Source #

The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.

createWorkgroup_publiclyAccessible :: Lens' CreateWorkgroup (Maybe Bool) Source #

A value that specifies whether the workgroup can be accessed from a public network.

createWorkgroup_securityGroupIds :: Lens' CreateWorkgroup (Maybe [Text]) Source #

An array of security group IDs to associate with the workgroup.

createWorkgroup_subnetIds :: Lens' CreateWorkgroup (Maybe [Text]) Source #

An array of VPC subnet IDs to associate with the workgroup.

createWorkgroup_tags :: Lens' CreateWorkgroup (Maybe [Tag]) Source #

A array of tag instances.

createWorkgroup_namespaceName :: Lens' CreateWorkgroup Text Source #

The name of the namespace to associate with the workgroup.

createWorkgroup_workgroupName :: Lens' CreateWorkgroup Text Source #

The name of the created workgroup.

DeleteEndpointAccess

deleteEndpointAccess_endpointName :: Lens' DeleteEndpointAccess Text Source #

The name of the VPC endpoint to delete.

DeleteNamespace

deleteNamespace_finalSnapshotName :: Lens' DeleteNamespace (Maybe Text) Source #

The name of the snapshot to be created before the namespace is deleted.

deleteNamespace_namespaceName :: Lens' DeleteNamespace Text Source #

The name of the namespace to delete.

DeleteResourcePolicy

deleteResourcePolicy_resourceArn :: Lens' DeleteResourcePolicy Text Source #

The Amazon Resource Name (ARN) of the policy to delete.

DeleteSnapshot

deleteSnapshot_snapshotName :: Lens' DeleteSnapshot Text Source #

The name of the snapshot to be deleted.

DeleteUsageLimit

deleteUsageLimit_usageLimitId :: Lens' DeleteUsageLimit Text Source #

The unique identifier of the usage limit to delete.

DeleteWorkgroup

deleteWorkgroup_workgroupName :: Lens' DeleteWorkgroup Text Source #

The name of the workgroup to be deleted.

GetCredentials

getCredentials_dbName :: Lens' GetCredentials (Maybe Text) Source #

The name of the database to get temporary authorization to log on to.

Constraints:

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

getCredentials_durationSeconds :: Lens' GetCredentials (Maybe Int) Source #

The number of seconds until the returned temporary password expires. The minimum is 900 seconds, and the maximum is 3600 seconds.

getCredentials_workgroupName :: Lens' GetCredentials Text Source #

The name of the workgroup associated with the database.

getCredentialsResponse_dbPassword :: Lens' GetCredentialsResponse (Maybe Text) Source #

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

getCredentialsResponse_dbUser :: Lens' GetCredentialsResponse (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.

getCredentialsResponse_expiration :: Lens' GetCredentialsResponse (Maybe UTCTime) Source #

The date and time the password in DbPassword expires.

getCredentialsResponse_nextRefreshTime :: Lens' GetCredentialsResponse (Maybe UTCTime) Source #

The date and time of when the DbUser and DbPassword authorization refreshes.

GetEndpointAccess

getEndpointAccess_endpointName :: Lens' GetEndpointAccess Text Source #

The name of the VPC endpoint to return information for.

GetNamespace

getNamespace_namespaceName :: Lens' GetNamespace Text Source #

The name of the namespace to retrieve information for.

GetRecoveryPoint

getRecoveryPoint_recoveryPointId :: Lens' GetRecoveryPoint Text Source #

The unique identifier of the recovery point to return information for.

GetResourcePolicy

getResourcePolicy_resourceArn :: Lens' GetResourcePolicy Text Source #

The Amazon Resource Name (ARN) of the resource to return.

GetSnapshot

getSnapshot_ownerAccount :: Lens' GetSnapshot (Maybe Text) Source #

The owner Amazon Web Services account of a snapshot shared with another user.

getSnapshot_snapshotArn :: Lens' GetSnapshot (Maybe Text) Source #

The Amazon Resource Name (ARN) of the snapshot to return.

getSnapshot_snapshotName :: Lens' GetSnapshot (Maybe Text) Source #

The name of the snapshot to return.

GetTableRestoreStatus

getTableRestoreStatus_tableRestoreRequestId :: Lens' GetTableRestoreStatus Text Source #

The ID of the RestoreTableFromSnapshot request to return status for.

getTableRestoreStatusResponse_tableRestoreStatus :: Lens' GetTableRestoreStatusResponse (Maybe TableRestoreStatus) Source #

The returned TableRestoreStatus object that contains information about the status of your RestoreTableFromSnapshot request.

GetUsageLimit

getUsageLimit_usageLimitId :: Lens' GetUsageLimit Text Source #

The unique identifier of the usage limit to return information for.

GetWorkgroup

getWorkgroup_workgroupName :: Lens' GetWorkgroup Text Source #

The name of the workgroup to return information for.

ListEndpointAccess

listEndpointAccess_maxResults :: Lens' ListEndpointAccess (Maybe Natural) Source #

An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

listEndpointAccess_nextToken :: Lens' ListEndpointAccess (Maybe Text) Source #

If your initial ListEndpointAccess operation returns a nextToken, you can include the returned nextToken in following ListEndpointAccess operations, which returns results in the next page.

listEndpointAccess_vpcId :: Lens' ListEndpointAccess (Maybe Text) Source #

The unique identifier of the virtual private cloud with access to Amazon Redshift Serverless.

listEndpointAccess_workgroupName :: Lens' ListEndpointAccess (Maybe Text) Source #

The name of the workgroup associated with the VPC endpoint to return.

listEndpointAccessResponse_nextToken :: Lens' ListEndpointAccessResponse (Maybe Text) Source #

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

ListNamespaces

listNamespaces_maxResults :: Lens' ListNamespaces (Maybe Natural) Source #

An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

listNamespaces_nextToken :: Lens' ListNamespaces (Maybe Text) Source #

If your initial ListNamespaces operation returns a nextToken, you can include the returned nextToken in following ListNamespaces operations, which returns results in the next page.

listNamespacesResponse_nextToken :: Lens' ListNamespacesResponse (Maybe Text) Source #

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

ListRecoveryPoints

listRecoveryPoints_endTime :: Lens' ListRecoveryPoints (Maybe UTCTime) Source #

The time when creation of the recovery point finished.

listRecoveryPoints_maxResults :: Lens' ListRecoveryPoints (Maybe Natural) Source #

An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

listRecoveryPoints_namespaceArn :: Lens' ListRecoveryPoints (Maybe Text) Source #

The Amazon Resource Name (ARN) of the namespace from which to list recovery points.

listRecoveryPoints_namespaceName :: Lens' ListRecoveryPoints (Maybe Text) Source #

The name of the namespace to list recovery points for.

listRecoveryPoints_nextToken :: Lens' ListRecoveryPoints (Maybe Text) Source #

If your initial ListRecoveryPoints operation returns a nextToken, you can include the returned nextToken in following ListRecoveryPoints operations, which returns results in the next page.

listRecoveryPoints_startTime :: Lens' ListRecoveryPoints (Maybe UTCTime) Source #

The time when the recovery point's creation was initiated.

listRecoveryPointsResponse_nextToken :: Lens' ListRecoveryPointsResponse (Maybe Text) Source #

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

ListSnapshots

listSnapshots_endTime :: Lens' ListSnapshots (Maybe UTCTime) Source #

The timestamp showing when the snapshot creation finished.

listSnapshots_maxResults :: Lens' ListSnapshots (Maybe Natural) Source #

An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

listSnapshots_namespaceArn :: Lens' ListSnapshots (Maybe Text) Source #

The Amazon Resource Name (ARN) of the namespace from which to list all snapshots.

listSnapshots_namespaceName :: Lens' ListSnapshots (Maybe Text) Source #

The namespace from which to list all snapshots.

listSnapshots_nextToken :: Lens' ListSnapshots (Maybe Text) Source #

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

listSnapshots_ownerAccount :: Lens' ListSnapshots (Maybe Text) Source #

The owner Amazon Web Services account of the snapshot.

listSnapshots_startTime :: Lens' ListSnapshots (Maybe UTCTime) Source #

The time when the creation of the snapshot was initiated.

listSnapshotsResponse_nextToken :: Lens' ListSnapshotsResponse (Maybe Text) Source #

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

ListTableRestoreStatus

listTableRestoreStatus_maxResults :: Lens' ListTableRestoreStatus (Maybe Natural) Source #

An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

listTableRestoreStatus_namespaceName :: Lens' ListTableRestoreStatus (Maybe Text) Source #

The namespace from which to list all of the statuses of RestoreTableFromSnapshot operations .

listTableRestoreStatus_nextToken :: Lens' ListTableRestoreStatus (Maybe Text) Source #

If your initial ListTableRestoreStatus operation returns a nextToken, you can include the returned nextToken in following ListTableRestoreStatus operations. This will return results on the next page.

listTableRestoreStatus_workgroupName :: Lens' ListTableRestoreStatus (Maybe Text) Source #

The workgroup from which to list all of the statuses of RestoreTableFromSnapshot operations.

listTableRestoreStatusResponse_nextToken :: Lens' ListTableRestoreStatusResponse (Maybe Text) Source #

If your initial ListTableRestoreStatus operation returns a nextToken, you can include the returned nextToken in following ListTableRestoreStatus operations. This will returns results on the next page.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the resource to list tags for.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag]) Source #

A map of the key-value pairs assigned to the resource.

ListUsageLimits

listUsageLimits_maxResults :: Lens' ListUsageLimits (Maybe Natural) Source #

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 100.

listUsageLimits_nextToken :: Lens' ListUsageLimits (Maybe Text) Source #

If your initial ListUsageLimits operation returns a nextToken, you can include the returned nextToken in following ListUsageLimits operations, which returns results in the next page.

listUsageLimits_resourceArn :: Lens' ListUsageLimits (Maybe Text) Source #

The Amazon Resource Name (ARN) associated with the resource whose usage limits you want to list.

listUsageLimits_usageType :: Lens' ListUsageLimits (Maybe UsageLimitUsageType) Source #

The Amazon Redshift Serverless feature whose limits you want to see.

listUsageLimitsResponse_nextToken :: Lens' ListUsageLimitsResponse (Maybe Text) Source #

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

ListWorkgroups

listWorkgroups_maxResults :: Lens' ListWorkgroups (Maybe Natural) Source #

An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

listWorkgroups_nextToken :: Lens' ListWorkgroups (Maybe Text) Source #

If your initial ListWorkgroups operation returns a nextToken, you can include the returned nextToken in following ListNamespaces operations, which returns results in the next page.

listWorkgroupsResponse_nextToken :: Lens' ListWorkgroupsResponse (Maybe Text) Source #

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token.

PutResourcePolicy

putResourcePolicy_policy :: Lens' PutResourcePolicy Text Source #

The policy to create or update. For example, the following policy grants a user authorization to restore a snapshot.

"{\"Version\": \"2012-10-17\", \"Statement\" : [{ \"Sid\": \"AllowUserRestoreFromSnapshot\", \"Principal\":{\"AWS\": [\"739247239426\"]}, \"Action\": [\"redshift-serverless:RestoreFromSnapshot\"] , \"Effect\": \"Allow\" }]}"

putResourcePolicy_resourceArn :: Lens' PutResourcePolicy Text Source #

The Amazon Resource Name (ARN) of the account to create or update a resource policy for.

RestoreFromRecoveryPoint

restoreFromRecoveryPoint_namespaceName :: Lens' RestoreFromRecoveryPoint Text Source #

The name of the namespace to restore data into.

restoreFromRecoveryPoint_recoveryPointId :: Lens' RestoreFromRecoveryPoint Text Source #

The unique identifier of the recovery point to restore from.

restoreFromRecoveryPoint_workgroupName :: Lens' RestoreFromRecoveryPoint Text Source #

The name of the workgroup used to restore data.

restoreFromRecoveryPointResponse_recoveryPointId :: Lens' RestoreFromRecoveryPointResponse (Maybe Text) Source #

The unique identifier of the recovery point used for the restore.

RestoreFromSnapshot

restoreFromSnapshot_ownerAccount :: Lens' RestoreFromSnapshot (Maybe Text) Source #

The Amazon Web Services account that owns the snapshot.

restoreFromSnapshot_snapshotArn :: Lens' RestoreFromSnapshot (Maybe Text) Source #

The Amazon Resource Name (ARN) of the snapshot to restore from. Required if restoring from Amazon Redshift Serverless to a provisioned cluster. Must not be specified at the same time as snapshotName.

The format of the ARN is arn:aws:redshift:<region>:<account_id>:snapshot:<cluster_identifier>/<snapshot_identifier>.

restoreFromSnapshot_snapshotName :: Lens' RestoreFromSnapshot (Maybe Text) Source #

The name of the snapshot to restore from. Must not be specified at the same time as snapshotArn.

restoreFromSnapshot_namespaceName :: Lens' RestoreFromSnapshot Text Source #

The name of the namespace to restore the snapshot to.

restoreFromSnapshot_workgroupName :: Lens' RestoreFromSnapshot Text Source #

The name of the workgroup used to restore the snapshot.

restoreFromSnapshotResponse_ownerAccount :: Lens' RestoreFromSnapshotResponse (Maybe Text) Source #

The owner Amazon Web Services; account of the snapshot that was restored.

restoreFromSnapshotResponse_snapshotName :: Lens' RestoreFromSnapshotResponse (Maybe Text) Source #

The name of the snapshot used to restore the namespace.

RestoreTableFromSnapshot

restoreTableFromSnapshot_activateCaseSensitiveIdentifier :: Lens' RestoreTableFromSnapshot (Maybe Bool) Source #

Indicates whether name identifiers for database, schema, and table are case sensitive. If true, the names are case sensitive. If false, the names are not case sensitive. The default is false.

restoreTableFromSnapshot_sourceSchemaName :: Lens' RestoreTableFromSnapshot (Maybe Text) Source #

The name of the source schema that contains the table being restored.

restoreTableFromSnapshot_targetDatabaseName :: Lens' RestoreTableFromSnapshot (Maybe Text) Source #

The name of the database to restore the table to.

restoreTableFromSnapshot_targetSchemaName :: Lens' RestoreTableFromSnapshot (Maybe Text) Source #

The name of the schema to restore the table to.

restoreTableFromSnapshot_namespaceName :: Lens' RestoreTableFromSnapshot Text Source #

The namespace of the snapshot to restore from.

restoreTableFromSnapshot_newTableName :: Lens' RestoreTableFromSnapshot Text Source #

The name of the table to create from the restore operation.

restoreTableFromSnapshot_snapshotName :: Lens' RestoreTableFromSnapshot Text Source #

The name of the snapshot to restore the table from.

restoreTableFromSnapshot_sourceDatabaseName :: Lens' RestoreTableFromSnapshot Text Source #

The name of the source database that contains the table being restored.

restoreTableFromSnapshotResponse_tableRestoreStatus :: Lens' RestoreTableFromSnapshotResponse (Maybe TableRestoreStatus) Source #

The TableRestoreStatus object that contains the status of the restore operation.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the resource to tag.

tagResource_tags :: Lens' TagResource [Tag] Source #

The map of the key-value pairs used to tag the resource.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the resource to remove tags from.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

The tag or set of tags to remove from the resource.

UpdateEndpointAccess

updateEndpointAccess_vpcSecurityGroupIds :: Lens' UpdateEndpointAccess (Maybe [Text]) Source #

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

updateEndpointAccess_endpointName :: Lens' UpdateEndpointAccess Text Source #

The name of the VPC endpoint to update.

UpdateNamespace

updateNamespace_adminUserPassword :: Lens' UpdateNamespace (Maybe Text) Source #

The password of the administrator for the first database created in the namespace.

updateNamespace_adminUsername :: Lens' UpdateNamespace (Maybe Text) Source #

The username of the administrator for the first database created in the namespace.

updateNamespace_defaultIamRoleArn :: Lens' UpdateNamespace (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.

updateNamespace_iamRoles :: Lens' UpdateNamespace (Maybe [Text]) Source #

A list of IAM roles to associate with the namespace.

updateNamespace_kmsKeyId :: Lens' UpdateNamespace (Maybe Text) Source #

The ID of the Amazon Web Services Key Management Service key used to encrypt your data.

updateNamespace_logExports :: Lens' UpdateNamespace (Maybe [LogExport]) Source #

The types of logs the namespace can export. The export types are userlog, connectionlog, and useractivitylog.

UpdateSnapshot

updateSnapshot_retentionPeriod :: Lens' UpdateSnapshot (Maybe Int) Source #

The new retention period of the snapshot.

UpdateUsageLimit

updateUsageLimit_amount :: Lens' UpdateUsageLimit (Maybe Integer) Source #

The new limit amount. If time-based, this amount is in Redshift Processing Units (RPU) consumed per hour. If data-based, this amount is in terabytes (TB) of data transferred between Regions in cross-account sharing. The value must be a positive number.

updateUsageLimit_breachAction :: Lens' UpdateUsageLimit (Maybe UsageLimitBreachAction) Source #

The new action that Amazon Redshift Serverless takes when the limit is reached.

updateUsageLimit_usageLimitId :: Lens' UpdateUsageLimit Text Source #

The identifier of the usage limit to update.

UpdateWorkgroup

updateWorkgroup_baseCapacity :: Lens' UpdateWorkgroup (Maybe Int) Source #

The new base data warehouse capacity in Redshift Processing Units (RPUs).

updateWorkgroup_configParameters :: Lens' UpdateWorkgroup (Maybe [ConfigParameter]) Source #

An array of parameters to set for advanced control over a database. The options are datestyle, enable_user_activity_logging, query_group, search_path, and max_query_execution_time.

updateWorkgroup_enhancedVpcRouting :: Lens' UpdateWorkgroup (Maybe Bool) Source #

The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.

updateWorkgroup_port :: Lens' UpdateWorkgroup (Maybe Int) Source #

The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.

updateWorkgroup_publiclyAccessible :: Lens' UpdateWorkgroup (Maybe Bool) Source #

A value that specifies whether the workgroup can be accessible from a public network.

updateWorkgroup_securityGroupIds :: Lens' UpdateWorkgroup (Maybe [Text]) Source #

An array of security group IDs to associate with the workgroup.

updateWorkgroup_subnetIds :: Lens' UpdateWorkgroup (Maybe [Text]) Source #

An array of VPC subnet IDs to associate with the workgroup.

updateWorkgroup_workgroupName :: Lens' UpdateWorkgroup Text Source #

The name of the workgroup to update.

Types

ConfigParameter

configParameter_parameterKey :: Lens' ConfigParameter (Maybe Text) Source #

The key of the parameter. The options are datestyle, enable_user_activity_logging, query_group, search_path, and max_query_execution_time.

configParameter_parameterValue :: Lens' ConfigParameter (Maybe Text) Source #

The value of the parameter to set.

Endpoint

endpoint_address :: Lens' Endpoint (Maybe Text) Source #

The DNS address of the VPC endpoint.

endpoint_port :: Lens' Endpoint (Maybe Int) Source #

The port that Amazon Redshift Serverless listens on.

endpoint_vpcEndpoints :: Lens' Endpoint (Maybe [VpcEndpoint]) Source #

An array of VpcEndpoint objects.

EndpointAccess

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

The DNS address of the endpoint.

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

The Amazon Resource Name (ARN) of the VPC endpoint.

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

The time that the endpoint was created.

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

The port number on which Amazon Redshift Serverless accepts incoming connections.

endpointAccess_subnetIds :: Lens' EndpointAccess (Maybe [Text]) Source #

The unique identifier of subnets where Amazon Redshift Serverless choose to deploy the VPC endpoint.

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

The connection endpoint for connecting to Amazon Redshift Serverless.

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

The security groups associated with the endpoint.

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

The name of the workgroup associated with the endpoint.

Namespace

namespace_adminUsername :: Lens' Namespace (Maybe Text) Source #

The username of the administrator for the first database created in the namespace.

namespace_creationDate :: Lens' Namespace (Maybe UTCTime) Source #

The date of when the namespace was created.

namespace_dbName :: Lens' Namespace (Maybe Text) Source #

The name of the first database created in the namespace.

namespace_defaultIamRoleArn :: Lens' Namespace (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.

namespace_iamRoles :: Lens' Namespace (Maybe [Text]) Source #

A list of IAM roles to associate with the namespace.

namespace_kmsKeyId :: Lens' Namespace (Maybe Text) Source #

The ID of the Amazon Web Services Key Management Service key used to encrypt your data.

namespace_logExports :: Lens' Namespace (Maybe [LogExport]) Source #

The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.

namespace_namespaceArn :: Lens' Namespace (Maybe Text) Source #

The Amazon Resource Name (ARN) associated with a namespace.

namespace_namespaceId :: Lens' Namespace (Maybe Text) Source #

The unique identifier of a namespace.

namespace_namespaceName :: Lens' Namespace (Maybe Text) Source #

The name of the namespace. Must be between 3-64 alphanumeric characters in lowercase, and it cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

namespace_status :: Lens' Namespace (Maybe NamespaceStatus) Source #

The status of the namespace.

NetworkInterface

networkInterface_networkInterfaceId :: Lens' NetworkInterface (Maybe Text) Source #

The unique identifier of the network interface.

networkInterface_privateIpAddress :: Lens' NetworkInterface (Maybe Text) Source #

The IPv4 address of the network interface within the subnet.

networkInterface_subnetId :: Lens' NetworkInterface (Maybe Text) Source #

The unique identifier of the subnet.

RecoveryPoint

recoveryPoint_namespaceArn :: Lens' RecoveryPoint (Maybe Text) Source #

The Amazon Resource Name (ARN) of the namespace the recovery point is associated with.

recoveryPoint_namespaceName :: Lens' RecoveryPoint (Maybe Text) Source #

The name of the namespace the recovery point is associated with.

recoveryPoint_recoveryPointCreateTime :: Lens' RecoveryPoint (Maybe UTCTime) Source #

The time the recovery point is created.

recoveryPoint_recoveryPointId :: Lens' RecoveryPoint (Maybe Text) Source #

The unique identifier of the recovery point.

recoveryPoint_totalSizeInMegaBytes :: Lens' RecoveryPoint (Maybe Double) Source #

The total size of the data in the recovery point in megabytes.

recoveryPoint_workgroupName :: Lens' RecoveryPoint (Maybe Text) Source #

The name of the workgroup the recovery point is associated with.

ResourcePolicy

resourcePolicy_resourceArn :: Lens' ResourcePolicy (Maybe Text) Source #

The Amazon Resource Name (ARN) of the policy.

Snapshot

snapshot_accountsWithProvisionedRestoreAccess :: Lens' Snapshot (Maybe [Text]) Source #

All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.

snapshot_accountsWithRestoreAccess :: Lens' Snapshot (Maybe [Text]) Source #

All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.

snapshot_actualIncrementalBackupSizeInMegaBytes :: Lens' Snapshot (Maybe Double) Source #

The size of the incremental backup in megabytes.

snapshot_adminUsername :: Lens' Snapshot (Maybe Text) Source #

The username of the database within a snapshot.

snapshot_backupProgressInMegaBytes :: Lens' Snapshot (Maybe Double) Source #

The size in megabytes of the data that has been backed up to a snapshot.

snapshot_currentBackupRateInMegaBytesPerSecond :: Lens' Snapshot (Maybe Double) Source #

The rate at which data is backed up into a snapshot in megabytes per second.

snapshot_elapsedTimeInSeconds :: Lens' Snapshot (Maybe Integer) Source #

The amount of time it took to back up data into a snapshot.

snapshot_estimatedSecondsToCompletion :: Lens' Snapshot (Maybe Integer) Source #

The estimated amount of seconds until the snapshot completes backup.

snapshot_kmsKeyId :: Lens' Snapshot (Maybe Text) Source #

The unique identifier of the KMS key used to encrypt the snapshot.

snapshot_namespaceArn :: Lens' Snapshot (Maybe Text) Source #

The Amazon Resource Name (ARN) of the namespace the snapshot was created from.

snapshot_namespaceName :: Lens' Snapshot (Maybe Text) Source #

The name of the namepsace.

snapshot_ownerAccount :: Lens' Snapshot (Maybe Text) Source #

The owner Amazon Web Services; account of the snapshot.

snapshot_snapshotArn :: Lens' Snapshot (Maybe Text) Source #

The Amazon Resource Name (ARN) of the snapshot.

snapshot_snapshotCreateTime :: Lens' Snapshot (Maybe UTCTime) Source #

The timestamp of when the snapshot was created.

snapshot_snapshotName :: Lens' Snapshot (Maybe Text) Source #

The name of the snapshot.

snapshot_snapshotRemainingDays :: Lens' Snapshot (Maybe Int) Source #

The amount of days until the snapshot is deleted.

snapshot_snapshotRetentionPeriod :: Lens' Snapshot (Maybe Int) Source #

The period of time, in days, of how long the snapshot is retained.

snapshot_snapshotRetentionStartTime :: Lens' Snapshot (Maybe UTCTime) Source #

The timestamp of when data within the snapshot started getting retained.

snapshot_status :: Lens' Snapshot (Maybe SnapshotStatus) Source #

The status of the snapshot.

snapshot_totalBackupSizeInMegaBytes :: Lens' Snapshot (Maybe Double) Source #

The total size, in megabytes, of how big the snapshot is.

TableRestoreStatus

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.

tableRestoreStatus_namespaceName :: Lens' TableRestoreStatus (Maybe Text) Source #

The namespace of the table being restored from.

tableRestoreStatus_newTableName :: Lens' TableRestoreStatus (Maybe Text) Source #

The name of the table to create from the restore operation.

tableRestoreStatus_progressInMegaBytes :: Lens' TableRestoreStatus (Maybe Integer) Source #

The amount of data restored to the new table so far, in megabytes (MB).

tableRestoreStatus_requestTime :: Lens' TableRestoreStatus (Maybe UTCTime) Source #

The time that the table restore request was made, in Universal Coordinated Time (UTC).

tableRestoreStatus_snapshotName :: Lens' TableRestoreStatus (Maybe Text) Source #

The name of the snapshot being restored from.

tableRestoreStatus_sourceDatabaseName :: Lens' TableRestoreStatus (Maybe Text) Source #

The name of the source database being restored from.

tableRestoreStatus_sourceSchemaName :: Lens' TableRestoreStatus (Maybe Text) Source #

The name of the source schema being restored from.

tableRestoreStatus_sourceTableName :: Lens' TableRestoreStatus (Maybe Text) Source #

The name of the source table being restored from.

tableRestoreStatus_status :: Lens' TableRestoreStatus (Maybe Text) Source #

A value that describes the current state of the table restore request. Possible values include SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS.

tableRestoreStatus_tableRestoreRequestId :: Lens' TableRestoreStatus (Maybe Text) Source #

The ID of the RestoreTableFromSnapshot request.

tableRestoreStatus_totalDataInMegaBytes :: Lens' TableRestoreStatus (Maybe Integer) Source #

The total amount of data to restore to the new table, in megabytes (MB).

tableRestoreStatus_workgroupName :: Lens' TableRestoreStatus (Maybe Text) Source #

The name of the workgroup being restored from.

Tag

tag_key :: Lens' Tag Text Source #

The key to use in the tag.

tag_value :: Lens' Tag Text Source #

The value of the tag.

UsageLimit

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

The limit amount. If time-based, this amount is in RPUs consumed per hour. If data-based, this amount is in terabytes (TB). The value must be a positive number.

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

The action that Amazon Redshift Serverless takes when the limit is reached.

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_resourceArn :: Lens' UsageLimit (Maybe Text) Source #

The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.

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

The Amazon Resource Name (ARN) of the resource associated with the usage limit.

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

The identifier of the usage limit.

usageLimit_usageType :: Lens' UsageLimit (Maybe UsageLimitUsageType) Source #

The Amazon Redshift Serverless feature to limit.

VpcEndpoint

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 to Amazon Redshift Serverless.

vpcEndpoint_vpcId :: Lens' VpcEndpoint (Maybe Text) Source #

The VPC identifier that the endpoint is associated with.

VpcSecurityGroupMembership

Workgroup

workgroup_baseCapacity :: Lens' Workgroup (Maybe Int) Source #

The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).

workgroup_configParameters :: Lens' Workgroup (Maybe [ConfigParameter]) Source #

An array of parameters to set for finer control over a database. The options are datestyle, enable_user_activity_logging, query_group, search_path, and max_query_execution_time.

workgroup_creationDate :: Lens' Workgroup (Maybe UTCTime) Source #

The creation date of the workgroup.

workgroup_endpoint :: Lens' Workgroup (Maybe Endpoint) Source #

The endpoint that is created from the workgroup.

workgroup_enhancedVpcRouting :: Lens' Workgroup (Maybe Bool) Source #

The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.

workgroup_namespaceName :: Lens' Workgroup (Maybe Text) Source #

The namespace the workgroup is associated with.

workgroup_port :: Lens' Workgroup (Maybe Int) Source #

The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.

workgroup_publiclyAccessible :: Lens' Workgroup (Maybe Bool) Source #

A value that specifies whether the workgroup can be accessible from a public network

workgroup_securityGroupIds :: Lens' Workgroup (Maybe [Text]) Source #

An array of security group IDs to associate with the workgroup.

workgroup_status :: Lens' Workgroup (Maybe WorkgroupStatus) Source #

The status of the workgroup.

workgroup_subnetIds :: Lens' Workgroup (Maybe [Text]) Source #

An array of subnet IDs the workgroup is associated with.

workgroup_workgroupArn :: Lens' Workgroup (Maybe Text) Source #

The Amazon Resource Name (ARN) that links to the workgroup.

workgroup_workgroupId :: Lens' Workgroup (Maybe Text) Source #

The unique identifier of the workgroup.

workgroup_workgroupName :: Lens' Workgroup (Maybe Text) Source #

The name of the workgroup.