String code
String customDomainCertificateArn
The custom domain name’s certificate Amazon resource name (ARN).
Date customDomainCertificateExpiryTime
The expiration time for the certificate.
String customDomainName
The custom domain name associated with the workgroup.
String workgroupName
The name of the workgroup associated with the database.
String parameterKey
The key of the parameter. The options are auto_mv, datestyle,
enable_case_sensitive_identifier, enable_user_activity_logging,
query_group, search_path, require_ssl, use_fips_ssl, and
query monitoring metrics that let you define performance boundaries. For more information about query monitoring
rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.
String parameterValue
The value of the parameter to set.
Snapshot snapshot
The snapshot converted from the recovery point.
String customDomainCertificateArn
The custom domain name’s certificate Amazon resource name (ARN).
String customDomainName
The custom domain name to associate with the workgroup.
String workgroupName
The name of the workgroup associated with the database.
String customDomainCertificateArn
The custom domain name’s certificate Amazon resource name (ARN).
Date customDomainCertificateExpiryTime
The expiration time for the certificate.
String customDomainName
The custom domain name to associate with the workgroup.
String workgroupName
The name of the workgroup associated with the database.
String endpointName
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.
String ownerAccount
The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.
List<E> subnetIds
The unique identifers of subnets from which Amazon Redshift Serverless chooses one to deploy a VPC endpoint.
List<E> vpcSecurityGroupIds
The unique identifiers of the security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
String workgroupName
The name of the workgroup to associate with the VPC endpoint.
EndpointAccess endpoint
The created VPC endpoint.
String adminPasswordSecretKmsKeyId
The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials
secret. You can only use this parameter if manageAdminPassword is true.
String adminUserPassword
The password of the administrator for the first database created in the namespace.
You can't use adminUserPassword if manageAdminPassword is true.
String adminUsername
The username of the administrator for the first database created in the namespace.
String dbName
The name of the first database created in the namespace.
String defaultIamRoleArn
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
List<E> iamRoles
A list of IAM roles to associate with the namespace.
String kmsKeyId
The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
List<E> logExports
The types of logs the namespace can export. Available export types are userlog,
connectionlog, and useractivitylog.
Boolean manageAdminPassword
If true, Amazon Redshift uses Secrets Manager to manage the namespace's admin credentials. You can't
use adminUserPassword if manageAdminPassword is true. If
manageAdminPassword is false or not set, Amazon Redshift uses adminUserPassword for the
admin user account's password.
String namespaceName
The name of the namespace.
String redshiftIdcApplicationArn
The ARN for the Redshift application that integrates with IAM Identity Center.
List<E> tags
A list of tag instances.
Namespace namespace
The created namespace object.
Boolean enabled
Indicates whether the schedule is enabled. If false, the scheduled action does not trigger. For more information
about state of the scheduled action, see ScheduledAction.
Date endTime
The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.
String namespaceName
The name of the namespace for which to create a scheduled action.
String roleArn
The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (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 Management Guide
Schedule schedule
The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.
Format of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.
Format of cron expression is (Minutes Hours Day-of-month Month Day-of-week Year). For example,
"(0 10 ? * MON *)". For more information, see Cron
Expressions in the Amazon CloudWatch Events User Guide.
String scheduledActionDescription
The description of the scheduled action.
String scheduledActionName
The name of the scheduled action.
Date startTime
The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.
TargetAction targetAction
ScheduledActionResponse scheduledAction
The returned ScheduledAction object that describes the properties of a scheduled action.
String destinationKmsKeyId
The KMS key to use to encrypt your snapshots in the destination Amazon Web Services Region.
String destinationRegion
The destination Amazon Web Services Region that you want to copy snapshots to.
String namespaceName
The name of the namespace to copy snapshots from.
Integer snapshotRetentionPeriod
The retention period of the snapshots that you copy to the destination Amazon Web Services Region.
SnapshotCopyConfiguration snapshotCopyConfiguration
The snapshot copy configuration object that is returned.
Snapshot snapshot
The created snapshot object.
String namespaceName
The name of the namespace for which you want to configure a scheduled action to create a snapshot.
Integer retentionPeriod
The retention period of the snapshot created by the scheduled action.
String snapshotNamePrefix
A string prefix that is attached to the name of the snapshot created by the scheduled action. The final name of the snapshot is the string prefix appended by the date and time of when the snapshot was created.
List<E> tags
An array of Tag objects to associate with the snapshot.
Long amount
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.
String breachAction
The action that Amazon Redshift Serverless takes when the limit is reached. The default is log.
String period
The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
String resourceArn
The Amazon Resource Name (ARN) of the Amazon Redshift Serverless resource to create the usage limit for.
String usageType
The type of Amazon Redshift Serverless usage to create a usage limit for.
UsageLimit usageLimit
The returned usage limit object.
Integer baseCapacity
The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
List<E> configParameters
An array of parameters to set for advanced control over a database. The options are auto_mv,
datestyle, enable_case_sensitive_identifier, enable_user_activity_logging,
query_group, search_path, require_ssl, use_fips_ssl, and
query monitoring metrics that let you define performance boundaries. For more information about query monitoring
rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.
Boolean enhancedVpcRouting
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.
String ipAddressType
The IP address type that the workgroup supports. Possible values are ipv4 and dualstack
.
Integer maxCapacity
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.
String namespaceName
The name of the namespace to associate with the workgroup.
Integer port
The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
Boolean publiclyAccessible
A value that specifies whether the workgroup can be accessed from a public network.
List<E> securityGroupIds
An array of security group IDs to associate with the workgroup.
List<E> subnetIds
An array of VPC subnet IDs to associate with the workgroup.
List<E> tags
A array of tag instances.
String workgroupName
The name of the created workgroup.
Workgroup workgroup
The created workgroup object.
String endpointName
The name of the VPC endpoint to delete.
EndpointAccess endpoint
The deleted VPC endpoint.
Namespace namespace
The deleted namespace object.
String resourceArn
The Amazon Resource Name (ARN) of the policy to delete.
String scheduledActionName
The name of the scheduled action to delete.
ScheduledActionResponse scheduledAction
The deleted scheduled action object.
String snapshotCopyConfigurationId
The ID of the snapshot copy configuration to delete.
SnapshotCopyConfiguration snapshotCopyConfiguration
The deleted snapshot copy configuration object.
String snapshotName
The name of the snapshot to be deleted.
Snapshot snapshot
The deleted snapshot object.
String usageLimitId
The unique identifier of the usage limit to delete.
UsageLimit usageLimit
The deleted usage limit object.
String workgroupName
The name of the workgroup to be deleted.
Workgroup workgroup
The deleted workgroup object.
String address
The DNS address of the endpoint.
String endpointArn
The Amazon Resource Name (ARN) of the VPC endpoint.
Date endpointCreateTime
The time that the endpoint was created.
String endpointName
The name of the VPC endpoint.
String endpointStatus
The status of the VPC endpoint.
Integer port
The port number on which Amazon Redshift Serverless accepts incoming connections.
List<E> subnetIds
The unique identifier of subnets where Amazon Redshift Serverless choose to deploy the VPC endpoint.
VpcEndpoint vpcEndpoint
The connection endpoint for connecting to Amazon Redshift Serverless.
List<E> vpcSecurityGroups
The security groups associated with the endpoint.
String workgroupName
The name of the workgroup associated with the endpoint.
String customDomainName
The custom domain name associated with the workgroup. The custom domain name or the workgroup name must be included in the request.
String dbName
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
Integer durationSeconds
The number of seconds until the returned temporary password expires. The minimum is 900 seconds, and the maximum is 3600 seconds.
String workgroupName
The name of the workgroup associated with the database.
String dbPassword
A temporary password that authorizes the user name returned by DbUser to log on to the database
DbName.
String dbUser
A database user name that is authorized to log on to the database DbName using the password
DbPassword. If the specified DbUser exists in the database, the new user name has the
same database privileges as the the user named in DbUser. By default, the user is added to PUBLIC.
Date expiration
The date and time the password in DbPassword expires.
Date nextRefreshTime
The date and time of when the DbUser and DbPassword authorization refreshes.
String customDomainCertificateArn
The custom domain name’s certificate Amazon resource name (ARN).
Date customDomainCertificateExpiryTime
The expiration time for the certificate.
String customDomainName
The custom domain name associated with the workgroup.
String workgroupName
The name of the workgroup associated with the database.
String endpointName
The name of the VPC endpoint to return information for.
EndpointAccess endpoint
The returned VPC endpoint.
String namespaceName
The name of the namespace to retrieve information for.
Namespace namespace
The returned namespace object.
String recoveryPointId
The unique identifier of the recovery point to return information for.
RecoveryPoint recoveryPoint
The returned recovery point object.
String resourceArn
The Amazon Resource Name (ARN) of the resource to return.
ResourcePolicy resourcePolicy
The returned resource policy.
String scheduledActionName
The name of the scheduled action.
ScheduledActionResponse scheduledAction
The returned scheduled action object.
Snapshot snapshot
The returned snapshot object.
String tableRestoreRequestId
The ID of the RestoreTableFromSnapshot request to return status for.
TableRestoreStatus tableRestoreStatus
The returned TableRestoreStatus object that contains information about the status of your
RestoreTableFromSnapshot request.
String usageLimitId
The unique identifier of the usage limit to return information for.
UsageLimit usageLimit
The returned usage limit object.
String workgroupName
The name of the workgroup to return information for.
Workgroup workgroup
The returned workgroup object.
String customDomainCertificateArn
The custom domain name’s certificate Amazon resource name (ARN).
String customDomainName
The custom domain name associated with the workgroup.
Integer maxResults
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to display the next page of results.
String nextToken
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.
Integer maxResults
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to display the next page of results.
String nextToken
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.
String ownerAccount
The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.
String vpcId
The unique identifier of the virtual private cloud with access to Amazon Redshift Serverless.
String workgroupName
The name of the workgroup associated with the VPC endpoint to return.
Integer maxResults
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to display the next page of results.
String nextToken
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.
Date endTime
The time when creation of the recovery point finished.
Integer maxResults
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to display the next page of results.
String namespaceArn
The Amazon Resource Name (ARN) of the namespace from which to list recovery points.
String namespaceName
The name of the namespace to list recovery points for.
String nextToken
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.
Date startTime
The time when the recovery point's creation was initiated.
String nextToken
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.
List<E> recoveryPoints
The returned recovery point objects.
Integer maxResults
An optional parameter that specifies the maximum number of results to return. Use nextToken to
display the next page of results.
String namespaceName
The name of namespace associated with the scheduled action to retrieve.
String nextToken
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.
String nextToken
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.
List<E> scheduledActions
All of the returned scheduled action association objects.
Integer maxResults
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to display the next page of results.
String namespaceName
The namespace from which to list all snapshot copy configurations.
String nextToken
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.
String nextToken
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.
List<E> snapshotCopyConfigurations
All of the returned snapshot copy configurations.
Date endTime
The timestamp showing when the snapshot creation finished.
Integer maxResults
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to display the next page of results.
String namespaceArn
The Amazon Resource Name (ARN) of the namespace from which to list all snapshots.
String namespaceName
The namespace from which to list all snapshots.
String nextToken
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.
String ownerAccount
The owner Amazon Web Services account of the snapshot.
Date startTime
The time when the creation of the snapshot was initiated.
Integer maxResults
An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
String namespaceName
The namespace from which to list all of the statuses of RestoreTableFromSnapshot operations .
String nextToken
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.
String workgroupName
The workgroup from which to list all of the statuses of RestoreTableFromSnapshot operations.
String nextToken
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.
List<E> tableRestoreStatuses
The array of returned TableRestoreStatus objects.
String resourceArn
The Amazon Resource Name (ARN) of the resource to list tags for.
Integer maxResults
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.
String nextToken
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.
String resourceArn
The Amazon Resource Name (ARN) associated with the resource whose usage limits you want to list.
String usageType
The Amazon Redshift Serverless feature whose limits you want to see.
String nextToken
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.
List<E> usageLimits
An array of returned usage limit objects.
Integer maxResults
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to display the next page of results.
String nextToken
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.
String ownerAccount
The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.
String adminPasswordSecretArn
The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
String adminPasswordSecretKmsKeyId
The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
String adminUsername
The username of the administrator for the first database created in the namespace.
Date creationDate
The date of when the namespace was created.
String dbName
The name of the first database created in the namespace.
String defaultIamRoleArn
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
List<E> iamRoles
A list of IAM roles to associate with the namespace.
String kmsKeyId
The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
List<E> logExports
The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.
String namespaceArn
The Amazon Resource Name (ARN) associated with a namespace.
String namespaceId
The unique identifier of a namespace.
String namespaceName
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.
String status
The status of the namespace.
String availabilityZone
The availability Zone.
String ipv6Address
The IPv6 address of the network interface within the subnet.
String networkInterfaceId
The unique identifier of the network interface.
String privateIpAddress
The IPv4 address of the network interface within the subnet.
String subnetId
The unique identifier of the subnet.
String policy
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\" }]}"
String resourceArn
The Amazon Resource Name (ARN) of the account to create or update a resource policy for.
ResourcePolicy resourcePolicy
The policy that was created or updated.
String namespaceArn
The Amazon Resource Name (ARN) of the namespace the recovery point is associated with.
String namespaceName
The name of the namespace the recovery point is associated with.
Date recoveryPointCreateTime
The time the recovery point is created.
String recoveryPointId
The unique identifier of the recovery point.
Double totalSizeInMegaBytes
The total size of the data in the recovery point in megabytes.
String workgroupName
The name of the workgroup the recovery point is associated with.
String resourceName
The name of the resource that could not be found.
String adminPasswordSecretKmsKeyId
The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
Boolean manageAdminPassword
If true, Amazon Redshift uses Secrets Manager to manage the restored snapshot's admin credentials.
If MmanageAdminPassword is false or not set, Amazon Redshift uses the admin credentials that the
namespace or cluster had at the time the snapshot was taken.
String namespaceName
The name of the namespace to restore the snapshot to.
String ownerAccount
The Amazon Web Services account that owns the snapshot.
String snapshotArn
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>.
String snapshotName
The name of the snapshot to restore from. Must not be specified at the same time as snapshotArn.
String workgroupName
The name of the workgroup used to restore the snapshot.
Boolean activateCaseSensitiveIdentifier
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.
String namespaceName
Namespace of the recovery point to restore from.
String newTableName
The name of the table to create from the restore operation.
String recoveryPointId
The ID of the recovery point to restore the table from.
String sourceDatabaseName
The name of the source database that contains the table being restored.
String sourceSchemaName
The name of the source schema that contains the table being restored.
String sourceTableName
The name of the source table being restored.
String targetDatabaseName
The name of the database to restore the table to.
String targetSchemaName
The name of the schema to restore the table to.
String workgroupName
The workgroup to restore the table to.
TableRestoreStatus tableRestoreStatus
Boolean activateCaseSensitiveIdentifier
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.
String namespaceName
The namespace of the snapshot to restore from.
String newTableName
The name of the table to create from the restore operation.
String snapshotName
The name of the snapshot to restore the table from.
String sourceDatabaseName
The name of the source database that contains the table being restored.
String sourceSchemaName
The name of the source schema that contains the table being restored.
String sourceTableName
The name of the source table being restored.
String targetDatabaseName
The name of the database to restore the table to.
String targetSchemaName
The name of the schema to restore the table to.
String workgroupName
The workgroup to restore the table to.
TableRestoreStatus tableRestoreStatus
The TableRestoreStatus object that contains the status of the restore operation.
Date at
The timestamp of when Amazon Redshift Serverless should run the scheduled action. Timestamp is in UTC. Format of
at expression is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.
String cron
The cron expression to use to schedule a recurring scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.
Format of cron expressions is (Minutes Hours Day-of-month Month Day-of-week Year). For example,
"(0 10 ? * MON *)". For more information, see Cron
Expressions in the Amazon CloudWatch Events User Guide.
Date endTime
The end time of
String namespaceName
The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.
List<E> nextInvocations
An array of timestamps of when the next scheduled actions will trigger.
String roleArn
The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (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 Management Guide
Schedule schedule
The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.
Format of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.
Format of cron expression is (Minutes Hours Day-of-month Month Day-of-week Year). For example,
"(0 10 ? * MON *)". For more information, see Cron
Expressions in the Amazon CloudWatch Events User Guide.
String scheduledActionDescription
The description of the scheduled action.
String scheduledActionName
The name of the scheduled action.
String scheduledActionUuid
The uuid of the scheduled action.
Date startTime
The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.
String state
The state of the scheduled action.
TargetAction targetAction
List<E> accountsWithProvisionedRestoreAccess
All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.
List<E> accountsWithRestoreAccess
All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.
Double actualIncrementalBackupSizeInMegaBytes
The size of the incremental backup in megabytes.
String adminPasswordSecretArn
The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
String adminPasswordSecretKmsKeyId
The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
String adminUsername
The username of the database within a snapshot.
Double backupProgressInMegaBytes
The size in megabytes of the data that has been backed up to a snapshot.
Double currentBackupRateInMegaBytesPerSecond
The rate at which data is backed up into a snapshot in megabytes per second.
Long elapsedTimeInSeconds
The amount of time it took to back up data into a snapshot.
Long estimatedSecondsToCompletion
The estimated amount of seconds until the snapshot completes backup.
String kmsKeyId
The unique identifier of the KMS key used to encrypt the snapshot.
String namespaceArn
The Amazon Resource Name (ARN) of the namespace the snapshot was created from.
String namespaceName
The name of the namepsace.
String ownerAccount
The owner Amazon Web Services; account of the snapshot.
String snapshotArn
The Amazon Resource Name (ARN) of the snapshot.
Date snapshotCreateTime
The timestamp of when the snapshot was created.
String snapshotName
The name of the snapshot.
Integer snapshotRemainingDays
The amount of days until the snapshot is deleted.
Integer snapshotRetentionPeriod
The period of time, in days, of how long the snapshot is retained.
Date snapshotRetentionStartTime
The timestamp of when data within the snapshot started getting retained.
String status
The status of the snapshot.
Double totalBackupSizeInMegaBytes
The total size, in megabytes, of how big the snapshot is.
String destinationKmsKeyId
The ID of the KMS key to use to encrypt your snapshots in the destination Amazon Web Services Region.
String destinationRegion
The destination Amazon Web Services Region to copy snapshots to.
String namespaceName
The name of the namespace to copy snapshots from in the source Amazon Web Services Region.
String snapshotCopyConfigurationArn
The ARN of the snapshot copy configuration object.
String snapshotCopyConfigurationId
The ID of the snapshot copy configuration object.
Integer snapshotRetentionPeriod
The retention period of snapshots that are copied to the destination Amazon Web Services Region.
String message
A message that explains the returned status. For example, if the status of the operation is FAILED,
the message explains why the operation failed.
String namespaceName
The namespace of the table being restored from.
String newTableName
The name of the table to create from the restore operation.
Long progressInMegaBytes
The amount of data restored to the new table so far, in megabytes (MB).
String recoveryPointId
The ID of the recovery point being restored from.
Date requestTime
The time that the table restore request was made, in Universal Coordinated Time (UTC).
String snapshotName
The name of the snapshot being restored from.
String sourceDatabaseName
The name of the source database being restored from.
String sourceSchemaName
The name of the source schema being restored from.
String sourceTableName
The name of the source table being restored from.
String status
A value that describes the current state of the table restore request. Possible values are SUCCEEDED, FAILED, CANCELED, PENDING, and IN_PROGRESS.
String tableRestoreRequestId
The ID of the RestoreTableFromSnapshot request.
String targetDatabaseName
The name of the database to restore to.
String targetSchemaName
The name of the schema to restore to.
Long totalDataInMegaBytes
The total amount of data to restore to the new table, in megabytes (MB).
String workgroupName
The name of the workgroup being restored from.
CreateSnapshotScheduleActionParameters createSnapshot
String code
String resourceName
The name of the resource that exceeded the number of tags allowed for a resource.
String customDomainCertificateArn
The custom domain name’s certificate Amazon resource name (ARN). This is optional.
String customDomainName
The custom domain name associated with the workgroup.
String workgroupName
The name of the workgroup associated with the database.
String customDomainCertificateArn
The custom domain name’s certificate Amazon resource name (ARN).
Date customDomainCertificateExpiryTime
The expiration time for the certificate.
String customDomainName
The custom domain name associated with the workgroup.
String workgroupName
The name of the workgroup associated with the database.
EndpointAccess endpoint
The updated VPC endpoint.
String adminPasswordSecretKmsKeyId
The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials
secret. You can only use this parameter if manageAdminPassword is true.
String adminUserPassword
The password of the administrator for the first database created in the namespace. This parameter must be updated
together with adminUsername.
You can't use adminUserPassword if manageAdminPassword is true.
String adminUsername
The username of the administrator for the first database created in the namespace. This parameter must be updated
together with adminUserPassword.
String defaultIamRoleArn
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace. This parameter must be
updated together with iamRoles.
List<E> iamRoles
A list of IAM roles to associate with the namespace. This parameter must be updated together with
defaultIamRoleArn.
String kmsKeyId
The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
List<E> logExports
The types of logs the namespace can export. The export types are userlog, connectionlog
, and useractivitylog.
Boolean manageAdminPassword
If true, Amazon Redshift uses Secrets Manager to manage the namespace's admin credentials. You can't
use adminUserPassword if manageAdminPassword is true. If
manageAdminPassword is false or not set, Amazon Redshift uses adminUserPassword for the
admin user account's password.
String namespaceName
The name of the namespace to update. You can't update the name of a namespace once it is created.
Namespace namespace
A list of tag instances.
Boolean enabled
Specifies whether to enable the scheduled action.
Date endTime
The end time in UTC of the scheduled action to update.
String roleArn
The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots (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 Management Guide
Schedule schedule
The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.
Format of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.
Format of cron expression is (Minutes Hours Day-of-month Month Day-of-week Year). For example,
"(0 10 ? * MON *)". For more information, see Cron
Expressions in the Amazon CloudWatch Events User Guide.
String scheduledActionDescription
The descripion of the scheduled action to update to.
String scheduledActionName
The name of the scheduled action to update to.
Date startTime
The start time in UTC of the scheduled action to update to.
TargetAction targetAction
ScheduledActionResponse scheduledAction
The ScheduledAction object that was updated.
SnapshotCopyConfiguration snapshotCopyConfiguration
The updated snapshot copy configuration object.
Snapshot snapshot
The updated snapshot object.
Long amount
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.
String breachAction
The new action that Amazon Redshift Serverless takes when the limit is reached.
String usageLimitId
The identifier of the usage limit to update.
UsageLimit usageLimit
The updated usage limit object.
Integer baseCapacity
The new base data warehouse capacity in Redshift Processing Units (RPUs).
List<E> configParameters
An array of parameters to set for advanced control over a database. The options are auto_mv,
datestyle, enable_case_sensitive_identifier, enable_user_activity_logging,
query_group, search_path, require_ssl, use_fips_ssl, and
query monitoring metrics that let you define performance boundaries. For more information about query monitoring
rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.
Boolean enhancedVpcRouting
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.
String ipAddressType
The IP address type that the workgroup supports. Possible values are ipv4 and dualstack
.
Integer maxCapacity
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.
Integer port
The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
Boolean publiclyAccessible
A value that specifies whether the workgroup can be accessible from a public network.
List<E> securityGroupIds
An array of security group IDs to associate with the workgroup.
List<E> subnetIds
An array of VPC subnet IDs to associate with the workgroup.
String workgroupName
The name of the workgroup to update. You can't update the name of a workgroup once it is created.
Workgroup workgroup
The updated workgroup object.
Long amount
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.
String breachAction
The action that Amazon Redshift Serverless takes when the limit is reached.
String period
The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
String resourceArn
The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.
String usageLimitArn
The Amazon Resource Name (ARN) of the resource associated with the usage limit.
String usageLimitId
The identifier of the usage limit.
String usageType
The Amazon Redshift Serverless feature to limit.
List<E> networkInterfaces
One or more network interfaces of the endpoint. Also known as an interface endpoint.
String vpcEndpointId
The connection endpoint ID for connecting to Amazon Redshift Serverless.
String vpcId
The VPC identifier that the endpoint is associated with.
Integer baseCapacity
The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
List<E> configParameters
An array of parameters to set for advanced control over a database. The options are auto_mv,
datestyle, enable_case_sensitive_identifier, enable_user_activity_logging,
query_group, search_path, require_ssl, use_fips_ssl, and
query monitoring metrics that let you define performance boundaries. For more information about query monitoring
rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.
Date creationDate
The creation date of the workgroup.
List<E> crossAccountVpcs
A list of VPCs. Each entry is the unique identifier of a virtual private cloud with access to Amazon Redshift Serverless. If all of the VPCs for the grantee are allowed, it shows an asterisk.
String customDomainCertificateArn
The custom domain name’s certificate Amazon resource name (ARN).
Date customDomainCertificateExpiryTime
The expiration time for the certificate.
String customDomainName
The custom domain name associated with the workgroup.
Endpoint endpoint
The endpoint that is created from the workgroup.
Boolean enhancedVpcRouting
The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
String ipAddressType
The IP address type that the workgroup supports. Possible values are ipv4 and dualstack
.
Integer maxCapacity
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.
String namespaceName
The namespace the workgroup is associated with.
String patchVersion
The patch version of your Amazon Redshift Serverless workgroup. For more information about patch versions, see Cluster versions for Amazon Redshift.
Integer port
The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
Boolean publiclyAccessible
A value that specifies whether the workgroup can be accessible from a public network.
List<E> securityGroupIds
An array of security group IDs to associate with the workgroup.
String status
The status of the workgroup.
List<E> subnetIds
An array of subnet IDs the workgroup is associated with.
String workgroupArn
The Amazon Resource Name (ARN) that links to the workgroup.
String workgroupId
The unique identifier of the workgroup.
String workgroupName
The name of the workgroup.
String workgroupVersion
The Amazon Redshift Serverless version of your workgroup. For more information about Amazon Redshift Serverless versions, seeCluster versions for Amazon Redshift.
Copyright © 2024. All rights reserved.