@Generated(value="software.amazon.awssdk:codegen") public interface RedshiftAsyncClient extends SdkClient, SdkAutoCloseable
builder()
method.
Overview
This is an interface reference for Amazon Redshift. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift clusters. Note that Amazon Redshift is asynchronous, which means that some interfaces may require techniques, such as polling or asynchronous callback handlers, to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a change is applied immediately, on the next instance reboot, or during the next maintenance window. For a summary of the Amazon Redshift cluster management interfaces, go to Using the Amazon Redshift Management Interfaces.
Amazon Redshift manages all the work of setting up, operating, and scaling a data warehouse: provisioning capacity, monitoring and backing up the cluster, and applying patches and upgrades to the Amazon Redshift engine. You can focus on using your data to acquire new insights for your business and customers.
If you are a first-time user of Amazon Redshift, we recommend that you begin by reading the Amazon Redshift Getting Started Guide.
If you are a database developer, the Amazon Redshift Database Developer Guide explains how to design, build, query, and maintain the databases that make up your data warehouse.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default CompletableFuture<AuthorizeClusterSecurityGroupIngressResponse> |
authorizeClusterSecurityGroupIngress(AuthorizeClusterSecurityGroupIngressRequest authorizeClusterSecurityGroupIngressRequest)
Adds an inbound (ingress) rule to an Amazon Redshift security group.
|
default CompletableFuture<AuthorizeClusterSecurityGroupIngressResponse> |
authorizeClusterSecurityGroupIngress(Consumer<AuthorizeClusterSecurityGroupIngressRequest.Builder> authorizeClusterSecurityGroupIngressRequest)
Adds an inbound (ingress) rule to an Amazon Redshift security group.
|
default CompletableFuture<AuthorizeSnapshotAccessResponse> |
authorizeSnapshotAccess(AuthorizeSnapshotAccessRequest authorizeSnapshotAccessRequest)
Authorizes the specified AWS customer account to restore the specified snapshot.
|
default CompletableFuture<AuthorizeSnapshotAccessResponse> |
authorizeSnapshotAccess(Consumer<AuthorizeSnapshotAccessRequest.Builder> authorizeSnapshotAccessRequest)
Authorizes the specified AWS customer account to restore the specified snapshot.
|
static RedshiftAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
RedshiftAsyncClient . |
default CompletableFuture<CopyClusterSnapshotResponse> |
copyClusterSnapshot(Consumer<CopyClusterSnapshotRequest.Builder> copyClusterSnapshotRequest)
Copies the specified automated cluster snapshot to a new manual cluster snapshot.
|
default CompletableFuture<CopyClusterSnapshotResponse> |
copyClusterSnapshot(CopyClusterSnapshotRequest copyClusterSnapshotRequest)
Copies the specified automated cluster snapshot to a new manual cluster snapshot.
|
static RedshiftAsyncClient |
create()
Create a
RedshiftAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from
the DefaultCredentialsProvider . |
default CompletableFuture<CreateClusterResponse> |
createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)
Creates a new cluster.
|
default CompletableFuture<CreateClusterResponse> |
createCluster(CreateClusterRequest createClusterRequest)
Creates a new cluster.
|
default CompletableFuture<CreateClusterParameterGroupResponse> |
createClusterParameterGroup(Consumer<CreateClusterParameterGroupRequest.Builder> createClusterParameterGroupRequest)
Creates an Amazon Redshift parameter group.
|
default CompletableFuture<CreateClusterParameterGroupResponse> |
createClusterParameterGroup(CreateClusterParameterGroupRequest createClusterParameterGroupRequest)
Creates an Amazon Redshift parameter group.
|
default CompletableFuture<CreateClusterSecurityGroupResponse> |
createClusterSecurityGroup(Consumer<CreateClusterSecurityGroupRequest.Builder> createClusterSecurityGroupRequest)
Creates a new Amazon Redshift security group.
|
default CompletableFuture<CreateClusterSecurityGroupResponse> |
createClusterSecurityGroup(CreateClusterSecurityGroupRequest createClusterSecurityGroupRequest)
Creates a new Amazon Redshift security group.
|
default CompletableFuture<CreateClusterSnapshotResponse> |
createClusterSnapshot(Consumer<CreateClusterSnapshotRequest.Builder> createClusterSnapshotRequest)
Creates a manual snapshot of the specified cluster.
|
default CompletableFuture<CreateClusterSnapshotResponse> |
createClusterSnapshot(CreateClusterSnapshotRequest createClusterSnapshotRequest)
Creates a manual snapshot of the specified cluster.
|
default CompletableFuture<CreateClusterSubnetGroupResponse> |
createClusterSubnetGroup(Consumer<CreateClusterSubnetGroupRequest.Builder> createClusterSubnetGroupRequest)
Creates a new Amazon Redshift subnet group.
|
default CompletableFuture<CreateClusterSubnetGroupResponse> |
createClusterSubnetGroup(CreateClusterSubnetGroupRequest createClusterSubnetGroupRequest)
Creates a new Amazon Redshift subnet group.
|
default CompletableFuture<CreateEventSubscriptionResponse> |
createEventSubscription(Consumer<CreateEventSubscriptionRequest.Builder> createEventSubscriptionRequest)
Creates an Amazon Redshift event notification subscription.
|
default CompletableFuture<CreateEventSubscriptionResponse> |
createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest)
Creates an Amazon Redshift event notification subscription.
|
default CompletableFuture<CreateHsmClientCertificateResponse> |
createHsmClientCertificate(Consumer<CreateHsmClientCertificateRequest.Builder> createHsmClientCertificateRequest)
Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in
order to store and retrieve the keys used to encrypt the cluster databases.
|
default CompletableFuture<CreateHsmClientCertificateResponse> |
createHsmClientCertificate(CreateHsmClientCertificateRequest createHsmClientCertificateRequest)
Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in
order to store and retrieve the keys used to encrypt the cluster databases.
|
default CompletableFuture<CreateHsmConfigurationResponse> |
createHsmConfiguration(Consumer<CreateHsmConfigurationRequest.Builder> createHsmConfigurationRequest)
Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and
use database encryption keys in a Hardware Security Module (HSM).
|
default CompletableFuture<CreateHsmConfigurationResponse> |
createHsmConfiguration(CreateHsmConfigurationRequest createHsmConfigurationRequest)
Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and
use database encryption keys in a Hardware Security Module (HSM).
|
default CompletableFuture<CreateSnapshotCopyGrantResponse> |
createSnapshotCopyGrant(Consumer<CreateSnapshotCopyGrantRequest.Builder> createSnapshotCopyGrantRequest)
Creates a snapshot copy grant that permits Amazon Redshift to use a customer master key (CMK) from AWS Key
Management Service (AWS KMS) to encrypt copied snapshots in a destination region.
|
default CompletableFuture<CreateSnapshotCopyGrantResponse> |
createSnapshotCopyGrant(CreateSnapshotCopyGrantRequest createSnapshotCopyGrantRequest)
Creates a snapshot copy grant that permits Amazon Redshift to use a customer master key (CMK) from AWS Key
Management Service (AWS KMS) to encrypt copied snapshots in a destination region.
|
default CompletableFuture<CreateTagsResponse> |
createTags(Consumer<CreateTagsRequest.Builder> createTagsRequest)
Adds one or more tags to a specified resource.
|
default CompletableFuture<CreateTagsResponse> |
createTags(CreateTagsRequest createTagsRequest)
Adds one or more tags to a specified resource.
|
default CompletableFuture<DeleteClusterResponse> |
deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)
Deletes a previously provisioned cluster.
|
default CompletableFuture<DeleteClusterResponse> |
deleteCluster(DeleteClusterRequest deleteClusterRequest)
Deletes a previously provisioned cluster.
|
default CompletableFuture<DeleteClusterParameterGroupResponse> |
deleteClusterParameterGroup(Consumer<DeleteClusterParameterGroupRequest.Builder> deleteClusterParameterGroupRequest)
Deletes a specified Amazon Redshift parameter group.
|
default CompletableFuture<DeleteClusterParameterGroupResponse> |
deleteClusterParameterGroup(DeleteClusterParameterGroupRequest deleteClusterParameterGroupRequest)
Deletes a specified Amazon Redshift parameter group.
|
default CompletableFuture<DeleteClusterSecurityGroupResponse> |
deleteClusterSecurityGroup(Consumer<DeleteClusterSecurityGroupRequest.Builder> deleteClusterSecurityGroupRequest)
Deletes an Amazon Redshift security group.
|
default CompletableFuture<DeleteClusterSecurityGroupResponse> |
deleteClusterSecurityGroup(DeleteClusterSecurityGroupRequest deleteClusterSecurityGroupRequest)
Deletes an Amazon Redshift security group.
|
default CompletableFuture<DeleteClusterSnapshotResponse> |
deleteClusterSnapshot(Consumer<DeleteClusterSnapshotRequest.Builder> deleteClusterSnapshotRequest)
Deletes the specified manual snapshot.
|
default CompletableFuture<DeleteClusterSnapshotResponse> |
deleteClusterSnapshot(DeleteClusterSnapshotRequest deleteClusterSnapshotRequest)
Deletes the specified manual snapshot.
|
default CompletableFuture<DeleteClusterSubnetGroupResponse> |
deleteClusterSubnetGroup(Consumer<DeleteClusterSubnetGroupRequest.Builder> deleteClusterSubnetGroupRequest)
Deletes the specified cluster subnet group.
|
default CompletableFuture<DeleteClusterSubnetGroupResponse> |
deleteClusterSubnetGroup(DeleteClusterSubnetGroupRequest deleteClusterSubnetGroupRequest)
Deletes the specified cluster subnet group.
|
default CompletableFuture<DeleteEventSubscriptionResponse> |
deleteEventSubscription(Consumer<DeleteEventSubscriptionRequest.Builder> deleteEventSubscriptionRequest)
Deletes an Amazon Redshift event notification subscription.
|
default CompletableFuture<DeleteEventSubscriptionResponse> |
deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest)
Deletes an Amazon Redshift event notification subscription.
|
default CompletableFuture<DeleteHsmClientCertificateResponse> |
deleteHsmClientCertificate(Consumer<DeleteHsmClientCertificateRequest.Builder> deleteHsmClientCertificateRequest)
Deletes the specified HSM client certificate.
|
default CompletableFuture<DeleteHsmClientCertificateResponse> |
deleteHsmClientCertificate(DeleteHsmClientCertificateRequest deleteHsmClientCertificateRequest)
Deletes the specified HSM client certificate.
|
default CompletableFuture<DeleteHsmConfigurationResponse> |
deleteHsmConfiguration(Consumer<DeleteHsmConfigurationRequest.Builder> deleteHsmConfigurationRequest)
Deletes the specified Amazon Redshift HSM configuration.
|
default CompletableFuture<DeleteHsmConfigurationResponse> |
deleteHsmConfiguration(DeleteHsmConfigurationRequest deleteHsmConfigurationRequest)
Deletes the specified Amazon Redshift HSM configuration.
|
default CompletableFuture<DeleteSnapshotCopyGrantResponse> |
deleteSnapshotCopyGrant(Consumer<DeleteSnapshotCopyGrantRequest.Builder> deleteSnapshotCopyGrantRequest)
Deletes the specified snapshot copy grant.
|
default CompletableFuture<DeleteSnapshotCopyGrantResponse> |
deleteSnapshotCopyGrant(DeleteSnapshotCopyGrantRequest deleteSnapshotCopyGrantRequest)
Deletes the specified snapshot copy grant.
|
default CompletableFuture<DeleteTagsResponse> |
deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest)
Deletes a tag or tags from a resource.
|
default CompletableFuture<DeleteTagsResponse> |
deleteTags(DeleteTagsRequest deleteTagsRequest)
Deletes a tag or tags from a resource.
|
default CompletableFuture<DescribeClusterParameterGroupsResponse> |
describeClusterParameterGroups()
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default
parameter group.
|
default CompletableFuture<DescribeClusterParameterGroupsResponse> |
describeClusterParameterGroups(Consumer<DescribeClusterParameterGroupsRequest.Builder> describeClusterParameterGroupsRequest)
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default
parameter group.
|
default CompletableFuture<DescribeClusterParameterGroupsResponse> |
describeClusterParameterGroups(DescribeClusterParameterGroupsRequest describeClusterParameterGroupsRequest)
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default
parameter group.
|
default DescribeClusterParameterGroupsPublisher |
describeClusterParameterGroupsPaginator()
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default
parameter group.
|
default DescribeClusterParameterGroupsPublisher |
describeClusterParameterGroupsPaginator(DescribeClusterParameterGroupsRequest describeClusterParameterGroupsRequest)
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default
parameter group.
|
default CompletableFuture<DescribeClusterParametersResponse> |
describeClusterParameters(Consumer<DescribeClusterParametersRequest.Builder> describeClusterParametersRequest)
Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group.
|
default CompletableFuture<DescribeClusterParametersResponse> |
describeClusterParameters(DescribeClusterParametersRequest describeClusterParametersRequest)
Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group.
|
default DescribeClusterParametersPublisher |
describeClusterParametersPaginator(DescribeClusterParametersRequest describeClusterParametersRequest)
Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group.
|
default CompletableFuture<DescribeClustersResponse> |
describeClusters()
Returns properties of provisioned clusters including general cluster properties, cluster database properties,
maintenance and backup properties, and security and access properties.
|
default CompletableFuture<DescribeClustersResponse> |
describeClusters(Consumer<DescribeClustersRequest.Builder> describeClustersRequest)
Returns properties of provisioned clusters including general cluster properties, cluster database properties,
maintenance and backup properties, and security and access properties.
|
default CompletableFuture<DescribeClustersResponse> |
describeClusters(DescribeClustersRequest describeClustersRequest)
Returns properties of provisioned clusters including general cluster properties, cluster database properties,
maintenance and backup properties, and security and access properties.
|
default CompletableFuture<DescribeClusterSecurityGroupsResponse> |
describeClusterSecurityGroups(Consumer<DescribeClusterSecurityGroupsRequest.Builder> describeClusterSecurityGroupsRequest)
Returns information about Amazon Redshift security groups.
|
default CompletableFuture<DescribeClusterSecurityGroupsResponse> |
describeClusterSecurityGroups(DescribeClusterSecurityGroupsRequest describeClusterSecurityGroupsRequest)
Returns information about Amazon Redshift security groups.
|
default DescribeClusterSecurityGroupsPublisher |
describeClusterSecurityGroupsPaginator(DescribeClusterSecurityGroupsRequest describeClusterSecurityGroupsRequest)
Returns information about Amazon Redshift security groups.
|
default CompletableFuture<DescribeClusterSnapshotsResponse> |
describeClusterSnapshots()
Returns one or more snapshot objects, which contain metadata about your cluster snapshots.
|
default CompletableFuture<DescribeClusterSnapshotsResponse> |
describeClusterSnapshots(Consumer<DescribeClusterSnapshotsRequest.Builder> describeClusterSnapshotsRequest)
Returns one or more snapshot objects, which contain metadata about your cluster snapshots.
|
default CompletableFuture<DescribeClusterSnapshotsResponse> |
describeClusterSnapshots(DescribeClusterSnapshotsRequest describeClusterSnapshotsRequest)
Returns one or more snapshot objects, which contain metadata about your cluster snapshots.
|
default DescribeClusterSnapshotsPublisher |
describeClusterSnapshotsPaginator()
Returns one or more snapshot objects, which contain metadata about your cluster snapshots.
|
default DescribeClusterSnapshotsPublisher |
describeClusterSnapshotsPaginator(DescribeClusterSnapshotsRequest describeClusterSnapshotsRequest)
Returns one or more snapshot objects, which contain metadata about your cluster snapshots.
|
default DescribeClustersPublisher |
describeClustersPaginator()
Returns properties of provisioned clusters including general cluster properties, cluster database properties,
maintenance and backup properties, and security and access properties.
|
default DescribeClustersPublisher |
describeClustersPaginator(DescribeClustersRequest describeClustersRequest)
Returns properties of provisioned clusters including general cluster properties, cluster database properties,
maintenance and backup properties, and security and access properties.
|
default CompletableFuture<DescribeClusterSubnetGroupsResponse> |
describeClusterSubnetGroups()
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups.
|
default CompletableFuture<DescribeClusterSubnetGroupsResponse> |
describeClusterSubnetGroups(Consumer<DescribeClusterSubnetGroupsRequest.Builder> describeClusterSubnetGroupsRequest)
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups.
|
default CompletableFuture<DescribeClusterSubnetGroupsResponse> |
describeClusterSubnetGroups(DescribeClusterSubnetGroupsRequest describeClusterSubnetGroupsRequest)
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups.
|
default DescribeClusterSubnetGroupsPublisher |
describeClusterSubnetGroupsPaginator()
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups.
|
default DescribeClusterSubnetGroupsPublisher |
describeClusterSubnetGroupsPaginator(DescribeClusterSubnetGroupsRequest describeClusterSubnetGroupsRequest)
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups.
|
default CompletableFuture<DescribeClusterVersionsResponse> |
describeClusterVersions()
Returns descriptions of the available Amazon Redshift cluster versions.
|
default CompletableFuture<DescribeClusterVersionsResponse> |
describeClusterVersions(Consumer<DescribeClusterVersionsRequest.Builder> describeClusterVersionsRequest)
Returns descriptions of the available Amazon Redshift cluster versions.
|
default CompletableFuture<DescribeClusterVersionsResponse> |
describeClusterVersions(DescribeClusterVersionsRequest describeClusterVersionsRequest)
Returns descriptions of the available Amazon Redshift cluster versions.
|
default DescribeClusterVersionsPublisher |
describeClusterVersionsPaginator()
Returns descriptions of the available Amazon Redshift cluster versions.
|
default DescribeClusterVersionsPublisher |
describeClusterVersionsPaginator(DescribeClusterVersionsRequest describeClusterVersionsRequest)
Returns descriptions of the available Amazon Redshift cluster versions.
|
default CompletableFuture<DescribeDefaultClusterParametersResponse> |
describeDefaultClusterParameters(Consumer<DescribeDefaultClusterParametersRequest.Builder> describeDefaultClusterParametersRequest)
Returns a list of parameter settings for the specified parameter group family.
|
default CompletableFuture<DescribeDefaultClusterParametersResponse> |
describeDefaultClusterParameters(DescribeDefaultClusterParametersRequest describeDefaultClusterParametersRequest)
Returns a list of parameter settings for the specified parameter group family.
|
default DescribeDefaultClusterParametersPublisher |
describeDefaultClusterParametersPaginator(DescribeDefaultClusterParametersRequest describeDefaultClusterParametersRequest)
Returns a list of parameter settings for the specified parameter group family.
|
default CompletableFuture<DescribeEventCategoriesResponse> |
describeEventCategories()
Displays a list of event categories for all event source types, or for a specified source type.
|
default CompletableFuture<DescribeEventCategoriesResponse> |
describeEventCategories(Consumer<DescribeEventCategoriesRequest.Builder> describeEventCategoriesRequest)
Displays a list of event categories for all event source types, or for a specified source type.
|
default CompletableFuture<DescribeEventCategoriesResponse> |
describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest)
Displays a list of event categories for all event source types, or for a specified source type.
|
default CompletableFuture<DescribeEventsResponse> |
describeEvents()
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days.
|
default CompletableFuture<DescribeEventsResponse> |
describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days.
|
default CompletableFuture<DescribeEventsResponse> |
describeEvents(DescribeEventsRequest describeEventsRequest)
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days.
|
default DescribeEventsPublisher |
describeEventsPaginator()
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days.
|
default DescribeEventsPublisher |
describeEventsPaginator(DescribeEventsRequest describeEventsRequest)
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days.
|
default CompletableFuture<DescribeEventSubscriptionsResponse> |
describeEventSubscriptions()
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account.
|
default CompletableFuture<DescribeEventSubscriptionsResponse> |
describeEventSubscriptions(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest)
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account.
|
default CompletableFuture<DescribeEventSubscriptionsResponse> |
describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account.
|
default DescribeEventSubscriptionsPublisher |
describeEventSubscriptionsPaginator()
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account.
|
default DescribeEventSubscriptionsPublisher |
describeEventSubscriptionsPaginator(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account.
|
default CompletableFuture<DescribeHsmClientCertificatesResponse> |
describeHsmClientCertificates()
Returns information about the specified HSM client certificate.
|
default CompletableFuture<DescribeHsmClientCertificatesResponse> |
describeHsmClientCertificates(Consumer<DescribeHsmClientCertificatesRequest.Builder> describeHsmClientCertificatesRequest)
Returns information about the specified HSM client certificate.
|
default CompletableFuture<DescribeHsmClientCertificatesResponse> |
describeHsmClientCertificates(DescribeHsmClientCertificatesRequest describeHsmClientCertificatesRequest)
Returns information about the specified HSM client certificate.
|
default DescribeHsmClientCertificatesPublisher |
describeHsmClientCertificatesPaginator()
Returns information about the specified HSM client certificate.
|
default DescribeHsmClientCertificatesPublisher |
describeHsmClientCertificatesPaginator(DescribeHsmClientCertificatesRequest describeHsmClientCertificatesRequest)
Returns information about the specified HSM client certificate.
|
default CompletableFuture<DescribeHsmConfigurationsResponse> |
describeHsmConfigurations()
Returns information about the specified Amazon Redshift HSM configuration.
|
default CompletableFuture<DescribeHsmConfigurationsResponse> |
describeHsmConfigurations(Consumer<DescribeHsmConfigurationsRequest.Builder> describeHsmConfigurationsRequest)
Returns information about the specified Amazon Redshift HSM configuration.
|
default CompletableFuture<DescribeHsmConfigurationsResponse> |
describeHsmConfigurations(DescribeHsmConfigurationsRequest describeHsmConfigurationsRequest)
Returns information about the specified Amazon Redshift HSM configuration.
|
default DescribeHsmConfigurationsPublisher |
describeHsmConfigurationsPaginator()
Returns information about the specified Amazon Redshift HSM configuration.
|
default DescribeHsmConfigurationsPublisher |
describeHsmConfigurationsPaginator(DescribeHsmConfigurationsRequest describeHsmConfigurationsRequest)
Returns information about the specified Amazon Redshift HSM configuration.
|
default CompletableFuture<DescribeLoggingStatusResponse> |
describeLoggingStatus(Consumer<DescribeLoggingStatusRequest.Builder> describeLoggingStatusRequest)
Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon
Redshift cluster.
|
default CompletableFuture<DescribeLoggingStatusResponse> |
describeLoggingStatus(DescribeLoggingStatusRequest describeLoggingStatusRequest)
Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon
Redshift cluster.
|
default CompletableFuture<DescribeOrderableClusterOptionsResponse> |
describeOrderableClusterOptions()
Returns a list of orderable cluster options.
|
default CompletableFuture<DescribeOrderableClusterOptionsResponse> |
describeOrderableClusterOptions(Consumer<DescribeOrderableClusterOptionsRequest.Builder> describeOrderableClusterOptionsRequest)
Returns a list of orderable cluster options.
|
default CompletableFuture<DescribeOrderableClusterOptionsResponse> |
describeOrderableClusterOptions(DescribeOrderableClusterOptionsRequest describeOrderableClusterOptionsRequest)
Returns a list of orderable cluster options.
|
default DescribeOrderableClusterOptionsPublisher |
describeOrderableClusterOptionsPaginator()
Returns a list of orderable cluster options.
|
default DescribeOrderableClusterOptionsPublisher |
describeOrderableClusterOptionsPaginator(DescribeOrderableClusterOptionsRequest describeOrderableClusterOptionsRequest)
Returns a list of orderable cluster options.
|
default CompletableFuture<DescribeReservedNodeOfferingsResponse> |
describeReservedNodeOfferings()
Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the
node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you.
|
default CompletableFuture<DescribeReservedNodeOfferingsResponse> |
describeReservedNodeOfferings(Consumer<DescribeReservedNodeOfferingsRequest.Builder> describeReservedNodeOfferingsRequest)
Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the
node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you.
|
default CompletableFuture<DescribeReservedNodeOfferingsResponse> |
describeReservedNodeOfferings(DescribeReservedNodeOfferingsRequest describeReservedNodeOfferingsRequest)
Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the
node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you.
|
default DescribeReservedNodeOfferingsPublisher |
describeReservedNodeOfferingsPaginator()
Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the
node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you.
|
default DescribeReservedNodeOfferingsPublisher |
describeReservedNodeOfferingsPaginator(DescribeReservedNodeOfferingsRequest describeReservedNodeOfferingsRequest)
Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the
node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you.
|
default CompletableFuture<DescribeReservedNodesResponse> |
describeReservedNodes()
Returns the descriptions of the reserved nodes.
|
default CompletableFuture<DescribeReservedNodesResponse> |
describeReservedNodes(Consumer<DescribeReservedNodesRequest.Builder> describeReservedNodesRequest)
Returns the descriptions of the reserved nodes.
|
default CompletableFuture<DescribeReservedNodesResponse> |
describeReservedNodes(DescribeReservedNodesRequest describeReservedNodesRequest)
Returns the descriptions of the reserved nodes.
|
default DescribeReservedNodesPublisher |
describeReservedNodesPaginator()
Returns the descriptions of the reserved nodes.
|
default DescribeReservedNodesPublisher |
describeReservedNodesPaginator(DescribeReservedNodesRequest describeReservedNodesRequest)
Returns the descriptions of the reserved nodes.
|
default CompletableFuture<DescribeResizeResponse> |
describeResize(Consumer<DescribeResizeRequest.Builder> describeResizeRequest)
Returns information about the last resize operation for the specified cluster.
|
default CompletableFuture<DescribeResizeResponse> |
describeResize(DescribeResizeRequest describeResizeRequest)
Returns information about the last resize operation for the specified cluster.
|
default CompletableFuture<DescribeSnapshotCopyGrantsResponse> |
describeSnapshotCopyGrants()
Returns a list of snapshot copy grants owned by the AWS account in the destination region.
|
default CompletableFuture<DescribeSnapshotCopyGrantsResponse> |
describeSnapshotCopyGrants(Consumer<DescribeSnapshotCopyGrantsRequest.Builder> describeSnapshotCopyGrantsRequest)
Returns a list of snapshot copy grants owned by the AWS account in the destination region.
|
default CompletableFuture<DescribeSnapshotCopyGrantsResponse> |
describeSnapshotCopyGrants(DescribeSnapshotCopyGrantsRequest describeSnapshotCopyGrantsRequest)
Returns a list of snapshot copy grants owned by the AWS account in the destination region.
|
default CompletableFuture<DescribeTableRestoreStatusResponse> |
describeTableRestoreStatus(Consumer<DescribeTableRestoreStatusRequest.Builder> describeTableRestoreStatusRequest)
Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API
action.
|
default CompletableFuture<DescribeTableRestoreStatusResponse> |
describeTableRestoreStatus(DescribeTableRestoreStatusRequest describeTableRestoreStatusRequest)
Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API
action.
|
default CompletableFuture<DescribeTagsResponse> |
describeTags()
Returns a list of tags.
|
default CompletableFuture<DescribeTagsResponse> |
describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest)
Returns a list of tags.
|
default CompletableFuture<DescribeTagsResponse> |
describeTags(DescribeTagsRequest describeTagsRequest)
Returns a list of tags.
|
default CompletableFuture<DisableLoggingResponse> |
disableLogging(Consumer<DisableLoggingRequest.Builder> disableLoggingRequest)
Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
|
default CompletableFuture<DisableLoggingResponse> |
disableLogging(DisableLoggingRequest disableLoggingRequest)
Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
|
default CompletableFuture<DisableSnapshotCopyResponse> |
disableSnapshotCopy(Consumer<DisableSnapshotCopyRequest.Builder> disableSnapshotCopyRequest)
Disables the automatic copying of snapshots from one region to another region for a specified cluster.
|
default CompletableFuture<DisableSnapshotCopyResponse> |
disableSnapshotCopy(DisableSnapshotCopyRequest disableSnapshotCopyRequest)
Disables the automatic copying of snapshots from one region to another region for a specified cluster.
|
default CompletableFuture<EnableLoggingResponse> |
enableLogging(Consumer<EnableLoggingRequest.Builder> enableLoggingRequest)
Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
|
default CompletableFuture<EnableLoggingResponse> |
enableLogging(EnableLoggingRequest enableLoggingRequest)
Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
|
default CompletableFuture<EnableSnapshotCopyResponse> |
enableSnapshotCopy(Consumer<EnableSnapshotCopyRequest.Builder> enableSnapshotCopyRequest)
Enables the automatic copy of snapshots from one region to another region for a specified cluster.
|
default CompletableFuture<EnableSnapshotCopyResponse> |
enableSnapshotCopy(EnableSnapshotCopyRequest enableSnapshotCopyRequest)
Enables the automatic copy of snapshots from one region to another region for a specified cluster.
|
default CompletableFuture<GetClusterCredentialsResponse> |
getClusterCredentials(Consumer<GetClusterCredentialsRequest.Builder> getClusterCredentialsRequest)
Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift
database.
|
default CompletableFuture<GetClusterCredentialsResponse> |
getClusterCredentials(GetClusterCredentialsRequest getClusterCredentialsRequest)
Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift
database.
|
default CompletableFuture<ModifyClusterResponse> |
modifyCluster(Consumer<ModifyClusterRequest.Builder> modifyClusterRequest)
Modifies the settings for a cluster.
|
default CompletableFuture<ModifyClusterResponse> |
modifyCluster(ModifyClusterRequest modifyClusterRequest)
Modifies the settings for a cluster.
|
default CompletableFuture<ModifyClusterIamRolesResponse> |
modifyClusterIamRoles(Consumer<ModifyClusterIamRolesRequest.Builder> modifyClusterIamRolesRequest)
Modifies the list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access
other AWS services.
|
default CompletableFuture<ModifyClusterIamRolesResponse> |
modifyClusterIamRoles(ModifyClusterIamRolesRequest modifyClusterIamRolesRequest)
Modifies the list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access
other AWS services.
|
default CompletableFuture<ModifyClusterParameterGroupResponse> |
modifyClusterParameterGroup(Consumer<ModifyClusterParameterGroupRequest.Builder> modifyClusterParameterGroupRequest)
Modifies the parameters of a parameter group.
|
default CompletableFuture<ModifyClusterParameterGroupResponse> |
modifyClusterParameterGroup(ModifyClusterParameterGroupRequest modifyClusterParameterGroupRequest)
Modifies the parameters of a parameter group.
|
default CompletableFuture<ModifyClusterSubnetGroupResponse> |
modifyClusterSubnetGroup(Consumer<ModifyClusterSubnetGroupRequest.Builder> modifyClusterSubnetGroupRequest)
Modifies a cluster subnet group to include the specified list of VPC subnets.
|
default CompletableFuture<ModifyClusterSubnetGroupResponse> |
modifyClusterSubnetGroup(ModifyClusterSubnetGroupRequest modifyClusterSubnetGroupRequest)
Modifies a cluster subnet group to include the specified list of VPC subnets.
|
default CompletableFuture<ModifyEventSubscriptionResponse> |
modifyEventSubscription(Consumer<ModifyEventSubscriptionRequest.Builder> modifyEventSubscriptionRequest)
Modifies an existing Amazon Redshift event notification subscription.
|
default CompletableFuture<ModifyEventSubscriptionResponse> |
modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest)
Modifies an existing Amazon Redshift event notification subscription.
|
default CompletableFuture<ModifySnapshotCopyRetentionPeriodResponse> |
modifySnapshotCopyRetentionPeriod(Consumer<ModifySnapshotCopyRetentionPeriodRequest.Builder> modifySnapshotCopyRetentionPeriodRequest)
Modifies the number of days to retain automated snapshots in the destination region after they are copied from
the source region.
|
default CompletableFuture<ModifySnapshotCopyRetentionPeriodResponse> |
modifySnapshotCopyRetentionPeriod(ModifySnapshotCopyRetentionPeriodRequest modifySnapshotCopyRetentionPeriodRequest)
Modifies the number of days to retain automated snapshots in the destination region after they are copied from
the source region.
|
default CompletableFuture<PurchaseReservedNodeOfferingResponse> |
purchaseReservedNodeOffering(Consumer<PurchaseReservedNodeOfferingRequest.Builder> purchaseReservedNodeOfferingRequest)
Allows you to purchase reserved nodes.
|
default CompletableFuture<PurchaseReservedNodeOfferingResponse> |
purchaseReservedNodeOffering(PurchaseReservedNodeOfferingRequest purchaseReservedNodeOfferingRequest)
Allows you to purchase reserved nodes.
|
default CompletableFuture<RebootClusterResponse> |
rebootCluster(Consumer<RebootClusterRequest.Builder> rebootClusterRequest)
Reboots a cluster.
|
default CompletableFuture<RebootClusterResponse> |
rebootCluster(RebootClusterRequest rebootClusterRequest)
Reboots a cluster.
|
default CompletableFuture<ResetClusterParameterGroupResponse> |
resetClusterParameterGroup(Consumer<ResetClusterParameterGroupRequest.Builder> resetClusterParameterGroupRequest)
Sets one or more parameters of the specified parameter group to their default values and sets the source values
of the parameters to "engine-default".
|
default CompletableFuture<ResetClusterParameterGroupResponse> |
resetClusterParameterGroup(ResetClusterParameterGroupRequest resetClusterParameterGroupRequest)
Sets one or more parameters of the specified parameter group to their default values and sets the source values
of the parameters to "engine-default".
|
default CompletableFuture<RestoreFromClusterSnapshotResponse> |
restoreFromClusterSnapshot(Consumer<RestoreFromClusterSnapshotRequest.Builder> restoreFromClusterSnapshotRequest)
Creates a new cluster from a snapshot.
|
default CompletableFuture<RestoreFromClusterSnapshotResponse> |
restoreFromClusterSnapshot(RestoreFromClusterSnapshotRequest restoreFromClusterSnapshotRequest)
Creates a new cluster from a snapshot.
|
default CompletableFuture<RestoreTableFromClusterSnapshotResponse> |
restoreTableFromClusterSnapshot(Consumer<RestoreTableFromClusterSnapshotRequest.Builder> restoreTableFromClusterSnapshotRequest)
Creates a new table from a table in an Amazon Redshift cluster snapshot.
|
default CompletableFuture<RestoreTableFromClusterSnapshotResponse> |
restoreTableFromClusterSnapshot(RestoreTableFromClusterSnapshotRequest restoreTableFromClusterSnapshotRequest)
Creates a new table from a table in an Amazon Redshift cluster snapshot.
|
default CompletableFuture<RevokeClusterSecurityGroupIngressResponse> |
revokeClusterSecurityGroupIngress(Consumer<RevokeClusterSecurityGroupIngressRequest.Builder> revokeClusterSecurityGroupIngressRequest)
Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2
security group.
|
default CompletableFuture<RevokeClusterSecurityGroupIngressResponse> |
revokeClusterSecurityGroupIngress(RevokeClusterSecurityGroupIngressRequest revokeClusterSecurityGroupIngressRequest)
Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2
security group.
|
default CompletableFuture<RevokeSnapshotAccessResponse> |
revokeSnapshotAccess(Consumer<RevokeSnapshotAccessRequest.Builder> revokeSnapshotAccessRequest)
Removes the ability of the specified AWS customer account to restore the specified snapshot.
|
default CompletableFuture<RevokeSnapshotAccessResponse> |
revokeSnapshotAccess(RevokeSnapshotAccessRequest revokeSnapshotAccessRequest)
Removes the ability of the specified AWS customer account to restore the specified snapshot.
|
default CompletableFuture<RotateEncryptionKeyResponse> |
rotateEncryptionKey(Consumer<RotateEncryptionKeyRequest.Builder> rotateEncryptionKeyRequest)
Rotates the encryption keys for a cluster.
|
default CompletableFuture<RotateEncryptionKeyResponse> |
rotateEncryptionKey(RotateEncryptionKeyRequest rotateEncryptionKeyRequest)
Rotates the encryption keys for a cluster.
|
serviceName
close
static final String SERVICE_NAME
static RedshiftAsyncClient create()
RedshiftAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from
the DefaultCredentialsProvider
.static RedshiftAsyncClientBuilder builder()
RedshiftAsyncClient
.default CompletableFuture<AuthorizeClusterSecurityGroupIngressResponse> authorizeClusterSecurityGroupIngress(AuthorizeClusterSecurityGroupIngressRequest authorizeClusterSecurityGroupIngressRequest)
Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an Amazon EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group.
If you authorize access to an Amazon EC2 security group, specify EC2SecurityGroupName and EC2SecurityGroupOwnerId. The Amazon EC2 security group and Amazon Redshift cluster must be in the same AWS region.
If you authorize access to a CIDR/IP address range, specify CIDRIP. For an overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing.
You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to Working with Security Groups in the Amazon Redshift Cluster Management Guide.
authorizeClusterSecurityGroupIngressRequest
- available
.default CompletableFuture<AuthorizeClusterSecurityGroupIngressResponse> authorizeClusterSecurityGroupIngress(Consumer<AuthorizeClusterSecurityGroupIngressRequest.Builder> authorizeClusterSecurityGroupIngressRequest)
Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an Amazon EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group.
If you authorize access to an Amazon EC2 security group, specify EC2SecurityGroupName and EC2SecurityGroupOwnerId. The Amazon EC2 security group and Amazon Redshift cluster must be in the same AWS region.
If you authorize access to a CIDR/IP address range, specify CIDRIP. For an overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing.
You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to Working with Security Groups in the Amazon Redshift Cluster Management Guide.
AuthorizeClusterSecurityGroupIngressRequest.Builder
avoiding the need to create one manually via
AuthorizeClusterSecurityGroupIngressRequest.builder()
authorizeClusterSecurityGroupIngressRequest
- a Consumer
that will call methods on AuthorizeClusterSecurityGroupIngressMessage.Builder
.available
.default CompletableFuture<AuthorizeSnapshotAccessResponse> authorizeSnapshotAccess(AuthorizeSnapshotAccessRequest authorizeSnapshotAccessRequest)
Authorizes the specified AWS customer account to restore the specified snapshot.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
authorizeSnapshotAccessRequest
- available
state, or other accounts are authorized to access the snapshot.default CompletableFuture<AuthorizeSnapshotAccessResponse> authorizeSnapshotAccess(Consumer<AuthorizeSnapshotAccessRequest.Builder> authorizeSnapshotAccessRequest)
Authorizes the specified AWS customer account to restore the specified snapshot.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
AuthorizeSnapshotAccessRequest.Builder
avoiding
the need to create one manually via AuthorizeSnapshotAccessRequest.builder()
authorizeSnapshotAccessRequest
- a Consumer
that will call methods on AuthorizeSnapshotAccessMessage.Builder
.available
state, or other accounts are authorized to access the snapshot.default CompletableFuture<CopyClusterSnapshotResponse> copyClusterSnapshot(CopyClusterSnapshotRequest copyClusterSnapshotRequest)
Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available state.
When you delete a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, when the retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you want to keep an automated snapshot for a longer period, you can make a manual copy of the snapshot. Manual snapshots are retained until you delete them.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
copyClusterSnapshotRequest
- available
state, or other accounts are authorized to access the snapshot.default CompletableFuture<CopyClusterSnapshotResponse> copyClusterSnapshot(Consumer<CopyClusterSnapshotRequest.Builder> copyClusterSnapshotRequest)
Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available state.
When you delete a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, when the retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you want to keep an automated snapshot for a longer period, you can make a manual copy of the snapshot. Manual snapshots are retained until you delete them.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
CopyClusterSnapshotRequest.Builder
avoiding the
need to create one manually via CopyClusterSnapshotRequest.builder()
copyClusterSnapshotRequest
- a Consumer
that will call methods on CopyClusterSnapshotMessage.Builder
.available
state, or other accounts are authorized to access the snapshot.default CompletableFuture<CreateClusterResponse> createCluster(CreateClusterRequest createClusterRequest)
Creates a new cluster.
To create the cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
createClusterRequest
- default CompletableFuture<CreateClusterResponse> createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)
Creates a new cluster.
To create the cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
CreateClusterRequest.Builder
avoiding the need to
create one manually via CreateClusterRequest.builder()
createClusterRequest
- a Consumer
that will call methods on CreateClusterMessage.Builder
.default CompletableFuture<CreateClusterParameterGroupResponse> createClusterParameterGroup(CreateClusterParameterGroupRequest createClusterParameterGroupRequest)
Creates an Amazon Redshift parameter group.
Creating parameter groups is independent of creating clusters. You can associate a cluster with a parameter group when you create the cluster. You can also associate an existing cluster with a parameter group after the cluster is created by using ModifyCluster.
Parameters in the parameter group define specific behavior that applies to the databases you create on the cluster. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
createClusterParameterGroupRequest
- default CompletableFuture<CreateClusterParameterGroupResponse> createClusterParameterGroup(Consumer<CreateClusterParameterGroupRequest.Builder> createClusterParameterGroupRequest)
Creates an Amazon Redshift parameter group.
Creating parameter groups is independent of creating clusters. You can associate a cluster with a parameter group when you create the cluster. You can also associate an existing cluster with a parameter group after the cluster is created by using ModifyCluster.
Parameters in the parameter group define specific behavior that applies to the databases you create on the cluster. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
CreateClusterParameterGroupRequest.Builder
avoiding the need to create one manually via CreateClusterParameterGroupRequest.builder()
createClusterParameterGroupRequest
- a Consumer
that will call methods on CreateClusterParameterGroupMessage.Builder
.default CompletableFuture<CreateClusterSecurityGroupResponse> createClusterSecurityGroup(CreateClusterSecurityGroupRequest createClusterSecurityGroupRequest)
Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
createClusterSecurityGroupRequest
- default CompletableFuture<CreateClusterSecurityGroupResponse> createClusterSecurityGroup(Consumer<CreateClusterSecurityGroupRequest.Builder> createClusterSecurityGroupRequest)
Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
CreateClusterSecurityGroupRequest.Builder
avoiding
the need to create one manually via CreateClusterSecurityGroupRequest.builder()
createClusterSecurityGroupRequest
- a Consumer
that will call methods on CreateClusterSecurityGroupMessage.Builder
.default CompletableFuture<CreateClusterSnapshotResponse> createClusterSnapshot(CreateClusterSnapshotRequest createClusterSnapshotRequest)
Creates a manual snapshot of the specified cluster. The cluster must be in the available
state.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
createClusterSnapshotRequest
- available
state.ClusterIdentifier
parameter does not refer to an existing
cluster.default CompletableFuture<CreateClusterSnapshotResponse> createClusterSnapshot(Consumer<CreateClusterSnapshotRequest.Builder> createClusterSnapshotRequest)
Creates a manual snapshot of the specified cluster. The cluster must be in the available
state.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
CreateClusterSnapshotRequest.Builder
avoiding the
need to create one manually via CreateClusterSnapshotRequest.builder()
createClusterSnapshotRequest
- a Consumer
that will call methods on CreateClusterSnapshotMessage.Builder
.available
state.ClusterIdentifier
parameter does not refer to an existing
cluster.default CompletableFuture<CreateClusterSubnetGroupResponse> createClusterSubnetGroup(CreateClusterSubnetGroupRequest createClusterSubnetGroupRequest)
Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group.
For information about subnet groups, go to Amazon Redshift Cluster Subnet Groups in the Amazon Redshift Cluster Management Guide.
createClusterSubnetGroupRequest
- default CompletableFuture<CreateClusterSubnetGroupResponse> createClusterSubnetGroup(Consumer<CreateClusterSubnetGroupRequest.Builder> createClusterSubnetGroupRequest)
Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group.
For information about subnet groups, go to Amazon Redshift Cluster Subnet Groups in the Amazon Redshift Cluster Management Guide.
CreateClusterSubnetGroupRequest.Builder
avoiding
the need to create one manually via CreateClusterSubnetGroupRequest.builder()
createClusterSubnetGroupRequest
- a Consumer
that will call methods on CreateClusterSubnetGroupMessage.Builder
.default CompletableFuture<CreateEventSubscriptionResponse> createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest)
Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the source type, and lists of Amazon Redshift source IDs, event categories, and event severities. Notifications will be sent for all events you want that match those criteria. For example, you can specify source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = ERROR. The subscription will only send notifications for those ERROR events in the Availability and Backup categories for the specified clusters.
If you specify both the source type and source IDs, such as source type = cluster and source identifier = my-cluster-1, notifications will be sent for all the cluster events for my-cluster-1. If you specify a source type but do not specify a source identifier, you will receive notice of the events for the objects of that type in your AWS account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon Redshift sources belonging to your AWS account. You must specify a source type if you specify a source ID.
createEventSubscriptionRequest
- default CompletableFuture<CreateEventSubscriptionResponse> createEventSubscription(Consumer<CreateEventSubscriptionRequest.Builder> createEventSubscriptionRequest)
Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the source type, and lists of Amazon Redshift source IDs, event categories, and event severities. Notifications will be sent for all events you want that match those criteria. For example, you can specify source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = ERROR. The subscription will only send notifications for those ERROR events in the Availability and Backup categories for the specified clusters.
If you specify both the source type and source IDs, such as source type = cluster and source identifier = my-cluster-1, notifications will be sent for all the cluster events for my-cluster-1. If you specify a source type but do not specify a source identifier, you will receive notice of the events for the objects of that type in your AWS account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon Redshift sources belonging to your AWS account. You must specify a source type if you specify a source ID.
CreateEventSubscriptionRequest.Builder
avoiding
the need to create one manually via CreateEventSubscriptionRequest.builder()
createEventSubscriptionRequest
- a Consumer
that will call methods on CreateEventSubscriptionMessage.Builder
.default CompletableFuture<CreateHsmClientCertificateResponse> createHsmClientCertificate(CreateHsmClientCertificateRequest createHsmClientCertificateRequest)
Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases.
The command returns a public key, which you must store in the HSM. In addition to creating the HSM certificate, you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to store and use encryption keys in the HSM. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.
createHsmClientCertificateRequest
- default CompletableFuture<CreateHsmClientCertificateResponse> createHsmClientCertificate(Consumer<CreateHsmClientCertificateRequest.Builder> createHsmClientCertificateRequest)
Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases.
The command returns a public key, which you must store in the HSM. In addition to creating the HSM certificate, you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to store and use encryption keys in the HSM. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.
CreateHsmClientCertificateRequest.Builder
avoiding
the need to create one manually via CreateHsmClientCertificateRequest.builder()
createHsmClientCertificateRequest
- a Consumer
that will call methods on CreateHsmClientCertificateMessage.Builder
.default CompletableFuture<CreateHsmConfigurationResponse> createHsmConfiguration(CreateHsmConfigurationRequest createHsmConfigurationRequest)
Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). After creating the HSM configuration, you can specify it as a parameter when creating a cluster. The cluster will then store its encryption keys in the HSM.
In addition to creating an HSM configuration, you must also create an HSM client certificate. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.
createHsmConfigurationRequest
- default CompletableFuture<CreateHsmConfigurationResponse> createHsmConfiguration(Consumer<CreateHsmConfigurationRequest.Builder> createHsmConfigurationRequest)
Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). After creating the HSM configuration, you can specify it as a parameter when creating a cluster. The cluster will then store its encryption keys in the HSM.
In addition to creating an HSM configuration, you must also create an HSM client certificate. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.
CreateHsmConfigurationRequest.Builder
avoiding the
need to create one manually via CreateHsmConfigurationRequest.builder()
createHsmConfigurationRequest
- a Consumer
that will call methods on CreateHsmConfigurationMessage.Builder
.default CompletableFuture<CreateSnapshotCopyGrantResponse> createSnapshotCopyGrant(CreateSnapshotCopyGrantRequest createSnapshotCopyGrantRequest)
Creates a snapshot copy grant that permits Amazon Redshift to use a customer master key (CMK) from AWS Key Management Service (AWS KMS) to encrypt copied snapshots in a destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
createSnapshotCopyGrantRequest
- The result of the CreateSnapshotCopyGrant
action.default CompletableFuture<CreateSnapshotCopyGrantResponse> createSnapshotCopyGrant(Consumer<CreateSnapshotCopyGrantRequest.Builder> createSnapshotCopyGrantRequest)
Creates a snapshot copy grant that permits Amazon Redshift to use a customer master key (CMK) from AWS Key Management Service (AWS KMS) to encrypt copied snapshots in a destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
CreateSnapshotCopyGrantRequest.Builder
avoiding
the need to create one manually via CreateSnapshotCopyGrantRequest.builder()
createSnapshotCopyGrantRequest
- a Consumer
that will call methods on CreateSnapshotCopyGrantMessage.Builder
.default CompletableFuture<CreateTagsResponse> createTags(CreateTagsRequest createTagsRequest)
Adds one or more tags to a specified resource.
A resource can have up to 10 tags. If you try to create more than 10 tags for a resource, you will receive an error and the attempt will fail.
If you specify a key that already exists for the resource, the value for that key will be updated with the new value.
createTagsRequest
- Contains the output from the CreateTags
action.default CompletableFuture<CreateTagsResponse> createTags(Consumer<CreateTagsRequest.Builder> createTagsRequest)
Adds one or more tags to a specified resource.
A resource can have up to 10 tags. If you try to create more than 10 tags for a resource, you will receive an error and the attempt will fail.
If you specify a key that already exists for the resource, the value for that key will be updated with the new value.
CreateTagsRequest.Builder
avoiding the need to
create one manually via CreateTagsRequest.builder()
createTagsRequest
- a Consumer
that will call methods on CreateTagsMessage.Builder
.default CompletableFuture<DeleteClusterResponse> deleteCluster(DeleteClusterRequest deleteClusterRequest)
Deletes a previously provisioned cluster. A successful response from the web service indicates that the request was received correctly. Use DescribeClusters to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
If you want to shut down the cluster and retain it for future use, set SkipFinalClusterSnapshot to
false
and specify a name for FinalClusterSnapshotIdentifier. You can later restore this
snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be
"final-snapshot" while the snapshot is being taken, then it's "deleting" once Amazon Redshift begins deleting the
cluster.
For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
deleteClusterRequest
- ClusterIdentifier
parameter does not refer to an existing
cluster.available
state.default CompletableFuture<DeleteClusterResponse> deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)
Deletes a previously provisioned cluster. A successful response from the web service indicates that the request was received correctly. Use DescribeClusters to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
If you want to shut down the cluster and retain it for future use, set SkipFinalClusterSnapshot to
false
and specify a name for FinalClusterSnapshotIdentifier. You can later restore this
snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be
"final-snapshot" while the snapshot is being taken, then it's "deleting" once Amazon Redshift begins deleting the
cluster.
For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
DeleteClusterRequest.Builder
avoiding the need to
create one manually via DeleteClusterRequest.builder()
deleteClusterRequest
- a Consumer
that will call methods on DeleteClusterMessage.Builder
.ClusterIdentifier
parameter does not refer to an existing
cluster.available
state.default CompletableFuture<DeleteClusterParameterGroupResponse> deleteClusterParameterGroup(DeleteClusterParameterGroupRequest deleteClusterParameterGroupRequest)
Deletes a specified Amazon Redshift parameter group.
You cannot delete a parameter group if it is associated with a cluster.
deleteClusterParameterGroupRequest
- default CompletableFuture<DeleteClusterParameterGroupResponse> deleteClusterParameterGroup(Consumer<DeleteClusterParameterGroupRequest.Builder> deleteClusterParameterGroupRequest)
Deletes a specified Amazon Redshift parameter group.
You cannot delete a parameter group if it is associated with a cluster.
DeleteClusterParameterGroupRequest.Builder
avoiding the need to create one manually via DeleteClusterParameterGroupRequest.builder()
deleteClusterParameterGroupRequest
- a Consumer
that will call methods on DeleteClusterParameterGroupMessage.Builder
.default CompletableFuture<DeleteClusterSecurityGroupResponse> deleteClusterSecurityGroup(DeleteClusterSecurityGroupRequest deleteClusterSecurityGroupRequest)
Deletes an Amazon Redshift security group.
You cannot delete a security group that is associated with any clusters. You cannot delete the default security group.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
deleteClusterSecurityGroupRequest
- available
.default CompletableFuture<DeleteClusterSecurityGroupResponse> deleteClusterSecurityGroup(Consumer<DeleteClusterSecurityGroupRequest.Builder> deleteClusterSecurityGroupRequest)
Deletes an Amazon Redshift security group.
You cannot delete a security group that is associated with any clusters. You cannot delete the default security group.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
DeleteClusterSecurityGroupRequest.Builder
avoiding
the need to create one manually via DeleteClusterSecurityGroupRequest.builder()
deleteClusterSecurityGroupRequest
- a Consumer
that will call methods on DeleteClusterSecurityGroupMessage.Builder
.available
.default CompletableFuture<DeleteClusterSnapshotResponse> deleteClusterSnapshot(DeleteClusterSnapshotRequest deleteClusterSnapshotRequest)
Deletes the specified manual snapshot. The snapshot must be in the available
state, with no other
users authorized to access the snapshot.
Unlike automated snapshots, manual snapshots are retained even after you delete your cluster. Amazon Redshift does not delete your manual snapshots. You must delete manual snapshot explicitly to avoid getting charged. If other accounts are authorized to access the snapshot, you must revoke all of the authorizations before you can delete the snapshot.
deleteClusterSnapshotRequest
- available
state, or other accounts are authorized to access the snapshot.default CompletableFuture<DeleteClusterSnapshotResponse> deleteClusterSnapshot(Consumer<DeleteClusterSnapshotRequest.Builder> deleteClusterSnapshotRequest)
Deletes the specified manual snapshot. The snapshot must be in the available
state, with no other
users authorized to access the snapshot.
Unlike automated snapshots, manual snapshots are retained even after you delete your cluster. Amazon Redshift does not delete your manual snapshots. You must delete manual snapshot explicitly to avoid getting charged. If other accounts are authorized to access the snapshot, you must revoke all of the authorizations before you can delete the snapshot.
DeleteClusterSnapshotRequest.Builder
avoiding the
need to create one manually via DeleteClusterSnapshotRequest.builder()
deleteClusterSnapshotRequest
- a Consumer
that will call methods on DeleteClusterSnapshotMessage.Builder
.available
state, or other accounts are authorized to access the snapshot.default CompletableFuture<DeleteClusterSubnetGroupResponse> deleteClusterSubnetGroup(DeleteClusterSubnetGroupRequest deleteClusterSubnetGroupRequest)
Deletes the specified cluster subnet group.
deleteClusterSubnetGroupRequest
- default CompletableFuture<DeleteClusterSubnetGroupResponse> deleteClusterSubnetGroup(Consumer<DeleteClusterSubnetGroupRequest.Builder> deleteClusterSubnetGroupRequest)
Deletes the specified cluster subnet group.
DeleteClusterSubnetGroupRequest.Builder
avoiding
the need to create one manually via DeleteClusterSubnetGroupRequest.builder()
deleteClusterSubnetGroupRequest
- a Consumer
that will call methods on DeleteClusterSubnetGroupMessage.Builder
.default CompletableFuture<DeleteEventSubscriptionResponse> deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest)
Deletes an Amazon Redshift event notification subscription.
deleteEventSubscriptionRequest
- default CompletableFuture<DeleteEventSubscriptionResponse> deleteEventSubscription(Consumer<DeleteEventSubscriptionRequest.Builder> deleteEventSubscriptionRequest)
Deletes an Amazon Redshift event notification subscription.
DeleteEventSubscriptionRequest.Builder
avoiding
the need to create one manually via DeleteEventSubscriptionRequest.builder()
deleteEventSubscriptionRequest
- a Consumer
that will call methods on DeleteEventSubscriptionMessage.Builder
.default CompletableFuture<DeleteHsmClientCertificateResponse> deleteHsmClientCertificate(DeleteHsmClientCertificateRequest deleteHsmClientCertificateRequest)
Deletes the specified HSM client certificate.
deleteHsmClientCertificateRequest
- available
state, or it is still in use by one or more Amazon Redshift clusters.default CompletableFuture<DeleteHsmClientCertificateResponse> deleteHsmClientCertificate(Consumer<DeleteHsmClientCertificateRequest.Builder> deleteHsmClientCertificateRequest)
Deletes the specified HSM client certificate.
DeleteHsmClientCertificateRequest.Builder
avoiding
the need to create one manually via DeleteHsmClientCertificateRequest.builder()
deleteHsmClientCertificateRequest
- a Consumer
that will call methods on DeleteHsmClientCertificateMessage.Builder
.available
state, or it is still in use by one or more Amazon Redshift clusters.default CompletableFuture<DeleteHsmConfigurationResponse> deleteHsmConfiguration(DeleteHsmConfigurationRequest deleteHsmConfigurationRequest)
Deletes the specified Amazon Redshift HSM configuration.
deleteHsmConfigurationRequest
- available
state, or it is still in use by one or more Amazon Redshift clusters.default CompletableFuture<DeleteHsmConfigurationResponse> deleteHsmConfiguration(Consumer<DeleteHsmConfigurationRequest.Builder> deleteHsmConfigurationRequest)
Deletes the specified Amazon Redshift HSM configuration.
DeleteHsmConfigurationRequest.Builder
avoiding the
need to create one manually via DeleteHsmConfigurationRequest.builder()
deleteHsmConfigurationRequest
- a Consumer
that will call methods on DeleteHsmConfigurationMessage.Builder
.available
state, or it is still in use by one or more Amazon Redshift clusters.default CompletableFuture<DeleteSnapshotCopyGrantResponse> deleteSnapshotCopyGrant(DeleteSnapshotCopyGrantRequest deleteSnapshotCopyGrantRequest)
Deletes the specified snapshot copy grant.
deleteSnapshotCopyGrantRequest
- The result of the DeleteSnapshotCopyGrant
action.default CompletableFuture<DeleteSnapshotCopyGrantResponse> deleteSnapshotCopyGrant(Consumer<DeleteSnapshotCopyGrantRequest.Builder> deleteSnapshotCopyGrantRequest)
Deletes the specified snapshot copy grant.
DeleteSnapshotCopyGrantRequest.Builder
avoiding
the need to create one manually via DeleteSnapshotCopyGrantRequest.builder()
deleteSnapshotCopyGrantRequest
- a Consumer
that will call methods on DeleteSnapshotCopyGrantMessage.Builder
.default CompletableFuture<DeleteTagsResponse> deleteTags(DeleteTagsRequest deleteTagsRequest)
Deletes a tag or tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags.
deleteTagsRequest
- Contains the output from the DeleteTags
action.default CompletableFuture<DeleteTagsResponse> deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest)
Deletes a tag or tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags.
DeleteTagsRequest.Builder
avoiding the need to
create one manually via DeleteTagsRequest.builder()
deleteTagsRequest
- a Consumer
that will call methods on DeleteTagsMessage.Builder
.default CompletableFuture<DescribeClusterParameterGroupsResponse> describeClusterParameterGroups(DescribeClusterParameterGroupsRequest describeClusterParameterGroupsRequest)
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups
that match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all parameter
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.
describeClusterParameterGroupsRequest
- default CompletableFuture<DescribeClusterParameterGroupsResponse> describeClusterParameterGroups()
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups
that match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all parameter
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.
default CompletableFuture<DescribeClusterParameterGroupsResponse> describeClusterParameterGroups(Consumer<DescribeClusterParameterGroupsRequest.Builder> describeClusterParameterGroupsRequest)
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups
that match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all parameter
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.
DescribeClusterParameterGroupsRequest.Builder
avoiding the need to create one manually via DescribeClusterParameterGroupsRequest.builder()
describeClusterParameterGroupsRequest
- a Consumer
that will call methods on DescribeClusterParameterGroupsMessage.Builder
.default DescribeClusterParameterGroupsPublisher describeClusterParameterGroupsPaginator(DescribeClusterParameterGroupsRequest describeClusterParameterGroupsRequest)
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups
that match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all parameter
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusterParameterGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParameterGroupsPublisher publisher = client.describeClusterParameterGroupsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParameterGroupsPublisher publisher = client.describeClusterParameterGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeClusterParameterGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsRequest)
operation.
describeClusterParameterGroupsRequest
- default DescribeClusterParameterGroupsPublisher describeClusterParameterGroupsPaginator()
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups
that match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all parameter
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusterParameterGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParameterGroupsPublisher publisher = client.describeClusterParameterGroupsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParameterGroupsPublisher publisher = client.describeClusterParameterGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeClusterParameterGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterParameterGroupsRequest)
operation.
default CompletableFuture<DescribeClusterParametersResponse> describeClusterParameters(DescribeClusterParametersRequest describeClusterParametersRequest)
Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on.
You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
describeClusterParametersRequest
- default CompletableFuture<DescribeClusterParametersResponse> describeClusterParameters(Consumer<DescribeClusterParametersRequest.Builder> describeClusterParametersRequest)
Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on.
You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
DescribeClusterParametersRequest.Builder
avoiding
the need to create one manually via DescribeClusterParametersRequest.builder()
describeClusterParametersRequest
- a Consumer
that will call methods on DescribeClusterParametersMessage.Builder
.default DescribeClusterParametersPublisher describeClusterParametersPaginator(DescribeClusterParametersRequest describeClusterParametersRequest)
Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on.
You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
This is a variant of
describeClusterParameters(software.amazon.awssdk.services.redshift.model.DescribeClusterParametersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParametersPublisher publisher = client.describeClusterParametersPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.redshift.paginators.DescribeClusterParametersPublisher publisher = client.describeClusterParametersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClusterParametersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClusterParametersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeClusterParameters(software.amazon.awssdk.services.redshift.model.DescribeClusterParametersRequest)
operation.
describeClusterParametersRequest
- default CompletableFuture<DescribeClusterSecurityGroupsResponse> describeClusterSecurityGroups(DescribeClusterSecurityGroupsRequest describeClusterSecurityGroupsRequest)
Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that
match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all security
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them.
describeClusterSecurityGroupsRequest
- default CompletableFuture<DescribeClusterSecurityGroupsResponse> describeClusterSecurityGroups(Consumer<DescribeClusterSecurityGroupsRequest.Builder> describeClusterSecurityGroupsRequest)
Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that
match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all security
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them.
DescribeClusterSecurityGroupsRequest.Builder
avoiding the need to create one manually via DescribeClusterSecurityGroupsRequest.builder()
describeClusterSecurityGroupsRequest
- a Consumer
that will call methods on DescribeClusterSecurityGroupsMessage.Builder
.default DescribeClusterSecurityGroupsPublisher describeClusterSecurityGroupsPaginator(DescribeClusterSecurityGroupsRequest describeClusterSecurityGroupsRequest)
Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that
match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all security
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusterSecurityGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSecurityGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSecurityGroupsPublisher publisher = client.describeClusterSecurityGroupsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSecurityGroupsPublisher publisher = client.describeClusterSecurityGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClusterSecurityGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClusterSecurityGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeClusterSecurityGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSecurityGroupsRequest)
operation.
describeClusterSecurityGroupsRequest
- default CompletableFuture<DescribeClusterSnapshotsResponse> describeClusterSnapshots(DescribeClusterSnapshotsRequest describeClusterSnapshotsRequest)
Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match
any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all snapshots
that have any combination of those values are returned. Only snapshots that you own are returned in the response;
shared snapshots are not returned with the tag key and tag value request parameters.
If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.
describeClusterSnapshotsRequest
- default CompletableFuture<DescribeClusterSnapshotsResponse> describeClusterSnapshots()
Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match
any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all snapshots
that have any combination of those values are returned. Only snapshots that you own are returned in the response;
shared snapshots are not returned with the tag key and tag value request parameters.
If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.
default CompletableFuture<DescribeClusterSnapshotsResponse> describeClusterSnapshots(Consumer<DescribeClusterSnapshotsRequest.Builder> describeClusterSnapshotsRequest)
Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match
any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all snapshots
that have any combination of those values are returned. Only snapshots that you own are returned in the response;
shared snapshots are not returned with the tag key and tag value request parameters.
If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.
DescribeClusterSnapshotsRequest.Builder
avoiding
the need to create one manually via DescribeClusterSnapshotsRequest.builder()
describeClusterSnapshotsRequest
- a Consumer
that will call methods on DescribeClusterSnapshotsMessage.Builder
.default DescribeClusterSnapshotsPublisher describeClusterSnapshotsPaginator(DescribeClusterSnapshotsRequest describeClusterSnapshotsRequest)
Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match
any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all snapshots
that have any combination of those values are returned. Only snapshots that you own are returned in the response;
shared snapshots are not returned with the tag key and tag value request parameters.
If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusterSnapshots(software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSnapshotsPublisher publisher = client.describeClusterSnapshotsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSnapshotsPublisher publisher = client.describeClusterSnapshotsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeClusterSnapshots(software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsRequest)
operation.
describeClusterSnapshotsRequest
- default DescribeClusterSnapshotsPublisher describeClusterSnapshotsPaginator()
Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match
any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all snapshots
that have any combination of those values are returned. Only snapshots that you own are returned in the response;
shared snapshots are not returned with the tag key and tag value request parameters.
If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusterSnapshots(software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSnapshotsPublisher publisher = client.describeClusterSnapshotsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSnapshotsPublisher publisher = client.describeClusterSnapshotsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeClusterSnapshots(software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsRequest)
operation.
default CompletableFuture<DescribeClusterSubnetGroupsResponse> describeClusterSubnetGroups(DescribeClusterSubnetGroupsRequest describeClusterSubnetGroupsRequest)
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that
match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all subnet
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.
describeClusterSubnetGroupsRequest
- default CompletableFuture<DescribeClusterSubnetGroupsResponse> describeClusterSubnetGroups()
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that
match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all subnet
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.
default CompletableFuture<DescribeClusterSubnetGroupsResponse> describeClusterSubnetGroups(Consumer<DescribeClusterSubnetGroupsRequest.Builder> describeClusterSubnetGroupsRequest)
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that
match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all subnet
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.
DescribeClusterSubnetGroupsRequest.Builder
avoiding the need to create one manually via DescribeClusterSubnetGroupsRequest.builder()
describeClusterSubnetGroupsRequest
- a Consumer
that will call methods on DescribeClusterSubnetGroupsMessage.Builder
.default DescribeClusterSubnetGroupsPublisher describeClusterSubnetGroupsPaginator(DescribeClusterSubnetGroupsRequest describeClusterSubnetGroupsRequest)
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that
match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all subnet
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusterSubnetGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSubnetGroupsPublisher publisher = client.describeClusterSubnetGroupsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSubnetGroupsPublisher publisher = client.describeClusterSubnetGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeClusterSubnetGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsRequest)
operation.
describeClusterSubnetGroupsRequest
- default DescribeClusterSubnetGroupsPublisher describeClusterSubnetGroupsPaginator()
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that
match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all subnet
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusterSubnetGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSubnetGroupsPublisher publisher = client.describeClusterSubnetGroupsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.redshift.paginators.DescribeClusterSubnetGroupsPublisher publisher = client.describeClusterSubnetGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeClusterSubnetGroups(software.amazon.awssdk.services.redshift.model.DescribeClusterSubnetGroupsRequest)
operation.
default CompletableFuture<DescribeClusterVersionsResponse> describeClusterVersions(DescribeClusterVersionsRequest describeClusterVersionsRequest)
Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
describeClusterVersionsRequest
- default CompletableFuture<DescribeClusterVersionsResponse> describeClusterVersions()
Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
default CompletableFuture<DescribeClusterVersionsResponse> describeClusterVersions(Consumer<DescribeClusterVersionsRequest.Builder> describeClusterVersionsRequest)
Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
DescribeClusterVersionsRequest.Builder
avoiding
the need to create one manually via DescribeClusterVersionsRequest.builder()
describeClusterVersionsRequest
- a Consumer
that will call methods on DescribeClusterVersionsMessage.Builder
.default DescribeClusterVersionsPublisher describeClusterVersionsPaginator(DescribeClusterVersionsRequest describeClusterVersionsRequest)
Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
This is a variant of
describeClusterVersions(software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.redshift.paginators.DescribeClusterVersionsPublisher publisher = client.describeClusterVersionsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.redshift.paginators.DescribeClusterVersionsPublisher publisher = client.describeClusterVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeClusterVersions(software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsRequest)
operation.
describeClusterVersionsRequest
- default DescribeClusterVersionsPublisher describeClusterVersionsPaginator()
Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
This is a variant of
describeClusterVersions(software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.redshift.paginators.DescribeClusterVersionsPublisher publisher = client.describeClusterVersionsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.redshift.paginators.DescribeClusterVersionsPublisher publisher = client.describeClusterVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeClusterVersions(software.amazon.awssdk.services.redshift.model.DescribeClusterVersionsRequest)
operation.
default CompletableFuture<DescribeClustersResponse> describeClusters(DescribeClustersRequest describeClustersRequest)
Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match
any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all clusters
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.
describeClustersRequest
- ClusterIdentifier
parameter does not refer to an existing
cluster.default CompletableFuture<DescribeClustersResponse> describeClusters()
Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match
any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all clusters
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.
ClusterIdentifier
parameter does not refer to an existing
cluster.default CompletableFuture<DescribeClustersResponse> describeClusters(Consumer<DescribeClustersRequest.Builder> describeClustersRequest)
Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match
any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all clusters
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.
DescribeClustersRequest.Builder
avoiding the need
to create one manually via DescribeClustersRequest.builder()
describeClustersRequest
- a Consumer
that will call methods on DescribeClustersMessage.Builder
.ClusterIdentifier
parameter does not refer to an existing
cluster.default DescribeClustersPublisher describeClustersPaginator(DescribeClustersRequest describeClustersRequest)
Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match
any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all clusters
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusters(software.amazon.awssdk.services.redshift.model.DescribeClustersRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.redshift.paginators.DescribeClustersPublisher publisher = client.describeClustersPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.redshift.paginators.DescribeClustersPublisher publisher = client.describeClustersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClustersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClustersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeClusters(software.amazon.awssdk.services.redshift.model.DescribeClustersRequest)
operation.
describeClustersRequest
- ClusterIdentifier
parameter does not refer to an existing
cluster.default DescribeClustersPublisher describeClustersPaginator()
Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match
any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all clusters
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeClusters(software.amazon.awssdk.services.redshift.model.DescribeClustersRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.redshift.paginators.DescribeClustersPublisher publisher = client.describeClustersPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.redshift.paginators.DescribeClustersPublisher publisher = client.describeClustersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeClustersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.redshift.model.DescribeClustersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeClusters(software.amazon.awssdk.services.redshift.model.DescribeClustersRequest)
operation.
ClusterIdentifier
parameter does not refer to an existing
cluster.default CompletableFuture<DescribeDefaultClusterParametersResponse> describeDefaultClusterParameters(DescribeDefaultClusterParametersRequest describeDefaultClusterParametersRequest)
Returns a list of parameter settings for the specified parameter group family.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
describeDefaultClusterParametersRequest
- default CompletableFuture<DescribeDefaultClusterParametersResponse> describeDefaultClusterParameters(Consumer<DescribeDefaultClusterParametersRequest.Builder> describeDefaultClusterParametersRequest)
Returns a list of parameter settings for the specified parameter group family.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
DescribeDefaultClusterParametersRequest.Builder
avoiding the need to create one manually via DescribeDefaultClusterParametersRequest.builder()
describeDefaultClusterParametersRequest
- a Consumer
that will call methods on DescribeDefaultClusterParametersMessage.Builder
.default DescribeDefaultClusterParametersPublisher describeDefaultClusterParametersPaginator(DescribeDefaultClusterParametersRequest describeDefaultClusterParametersRequest)
Returns a list of parameter settings for the specified parameter group family.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
This is a variant of
describeDefaultClusterParameters(software.amazon.awssdk.services.redshift.model.DescribeDefaultClusterParametersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.redshift.paginators.DescribeDefaultClusterParametersPublisher publisher = client.describeDefaultClusterParametersPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.redshift.paginators.DescribeDefaultClusterParametersPublisher publisher = client.describeDefaultClusterParametersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeDefaultClusterParametersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.redshift.model.DescribeDefaultClusterParametersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeDefaultClusterParameters(software.amazon.awssdk.services.redshift.model.DescribeDefaultClusterParametersRequest)
operation.
describeDefaultClusterParametersRequest
- default CompletableFuture<DescribeEventCategoriesResponse> describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest)
Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to Amazon Redshift Event Notifications.
describeEventCategoriesRequest
- default CompletableFuture<DescribeEventCategoriesResponse> describeEventCategories()
Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to Amazon Redshift Event Notifications.
default CompletableFuture<DescribeEventCategoriesResponse> describeEventCategories(Consumer<DescribeEventCategoriesRequest.Builder> describeEventCategoriesRequest)
Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to Amazon Redshift Event Notifications.
DescribeEventCategoriesRequest.Builder
avoiding
the need to create one manually via DescribeEventCategoriesRequest.builder()
describeEventCategoriesRequest
- a Consumer
that will call methods on DescribeEventCategoriesMessage.Builder
.default CompletableFuture<DescribeEventSubscriptionsResponse> describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification
subscriptions that match any combination of the specified keys and values. For example, if you have
owner
and environment
for tag keys, and admin
and test
for
tag values, all subscriptions that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.
describeEventSubscriptionsRequest
- default CompletableFuture<DescribeEventSubscriptionsResponse> describeEventSubscriptions()
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification
subscriptions that match any combination of the specified keys and values. For example, if you have
owner
and environment
for tag keys, and admin
and test
for
tag values, all subscriptions that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.
default CompletableFuture<DescribeEventSubscriptionsResponse> describeEventSubscriptions(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest)
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification
subscriptions that match any combination of the specified keys and values. For example, if you have
owner
and environment
for tag keys, and admin
and test
for
tag values, all subscriptions that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.
DescribeEventSubscriptionsRequest.Builder
avoiding
the need to create one manually via DescribeEventSubscriptionsRequest.builder()
describeEventSubscriptionsRequest
- a Consumer
that will call methods on DescribeEventSubscriptionsMessage.Builder
.default DescribeEventSubscriptionsPublisher describeEventSubscriptionsPaginator(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification
subscriptions that match any combination of the specified keys and values. For example, if you have
owner
and environment
for tag keys, and admin
and test
for
tag values, all subscriptions that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.redshift.paginators.DescribeEventSubscriptionsPublisher publisher = client.describeEventSubscriptionsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.redshift.paginators.DescribeEventSubscriptionsPublisher publisher = client.describeEventSubscriptionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeEventSubscriptions(software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsRequest)
operation.
describeEventSubscriptionsRequest
- default DescribeEventSubscriptionsPublisher describeEventSubscriptionsPaginator()
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification
subscriptions that match any combination of the specified keys and values. For example, if you have
owner
and environment
for tag keys, and admin
and test
for
tag values, all subscriptions that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.redshift.paginators.DescribeEventSubscriptionsPublisher publisher = client.describeEventSubscriptionsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.redshift.paginators.DescribeEventSubscriptionsPublisher publisher = client.describeEventSubscriptionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeEventSubscriptions(software.amazon.awssdk.services.redshift.model.DescribeEventSubscriptionsRequest)
operation.
default CompletableFuture<DescribeEventsResponse> describeEvents(DescribeEventsRequest describeEventsRequest)
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
describeEventsRequest
- default CompletableFuture<DescribeEventsResponse> describeEvents()
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
default CompletableFuture<DescribeEventsResponse> describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
DescribeEventsRequest.Builder
avoiding the need to
create one manually via DescribeEventsRequest.builder()
describeEventsRequest
- a Consumer
that will call methods on DescribeEventsMessage.Builder
.default DescribeEventsPublisher describeEventsPaginator(DescribeEventsRequest describeEventsRequest)
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
This is a variant of
describeEvents(software.amazon.awssdk.services.redshift.model.DescribeEventsRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.redshift.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.redshift.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeEventsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.redshift.model.DescribeEventsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.redshift.model.DescribeEventsRequest)
operation.
describeEventsRequest
- default DescribeEventsPublisher describeEventsPaginator()
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
This is a variant of
describeEvents(software.amazon.awssdk.services.redshift.model.DescribeEventsRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.redshift.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.redshift.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeEventsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.redshift.model.DescribeEventsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.redshift.model.DescribeEventsRequest)
operation.
default CompletableFuture<DescribeHsmClientCertificatesResponse> describeHsmClientCertificates(DescribeHsmClientCertificatesRequest describeHsmClientCertificatesRequest)
Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client
certificates that match any combination of the specified keys and values. For example, if you have
owner
and environment
for tag keys, and admin
and test
for
tag values, all HSM client certificates that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.
describeHsmClientCertificatesRequest
- default CompletableFuture<DescribeHsmClientCertificatesResponse> describeHsmClientCertificates()
Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client
certificates that match any combination of the specified keys and values. For example, if you have
owner
and environment
for tag keys, and admin
and test
for
tag values, all HSM client certificates that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.
default CompletableFuture<DescribeHsmClientCertificatesResponse> describeHsmClientCertificates(Consumer<DescribeHsmClientCertificatesRequest.Builder> describeHsmClientCertificatesRequest)
Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client
certificates that match any combination of the specified keys and values. For example, if you have
owner
and environment
for tag keys, and admin
and test
for
tag values, all HSM client certificates that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.
DescribeHsmClientCertificatesRequest.Builder
avoiding the need to create one manually via DescribeHsmClientCertificatesRequest.builder()
describeHsmClientCertificatesRequest
- a Consumer
that will call methods on DescribeHsmClientCertificatesMessage.Builder
.default DescribeHsmClientCertificatesPublisher describeHsmClientCertificatesPaginator(DescribeHsmClientCertificatesRequest describeHsmClientCertificatesRequest)
Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client
certificates that match any combination of the specified keys and values. For example, if you have
owner
and environment
for tag keys, and admin
and test
for
tag values, all HSM client certificates that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeHsmClientCertificates(software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.redshift.paginators.DescribeHsmClientCertificatesPublisher publisher = client.describeHsmClientCertificatesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.redshift.paginators.DescribeHsmClientCertificatesPublisher publisher = client.describeHsmClientCertificatesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeHsmClientCertificates(software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesRequest)
operation.
describeHsmClientCertificatesRequest
- default DescribeHsmClientCertificatesPublisher describeHsmClientCertificatesPaginator()
Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client
certificates that match any combination of the specified keys and values. For example, if you have
owner
and environment
for tag keys, and admin
and test
for
tag values, all HSM client certificates that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeHsmClientCertificates(software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.redshift.paginators.DescribeHsmClientCertificatesPublisher publisher = client.describeHsmClientCertificatesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.redshift.paginators.DescribeHsmClientCertificatesPublisher publisher = client.describeHsmClientCertificatesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeHsmClientCertificates(software.amazon.awssdk.services.redshift.model.DescribeHsmClientCertificatesRequest)
operation.
default CompletableFuture<DescribeHsmConfigurationsResponse> describeHsmConfigurations(DescribeHsmConfigurationsRequest describeHsmConfigurationsRequest)
Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that
match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all HSM
connections that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.
describeHsmConfigurationsRequest
- default CompletableFuture<DescribeHsmConfigurationsResponse> describeHsmConfigurations()
Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that
match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all HSM
connections that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.
default CompletableFuture<DescribeHsmConfigurationsResponse> describeHsmConfigurations(Consumer<DescribeHsmConfigurationsRequest.Builder> describeHsmConfigurationsRequest)
Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that
match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all HSM
connections that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.
DescribeHsmConfigurationsRequest.Builder
avoiding
the need to create one manually via DescribeHsmConfigurationsRequest.builder()
describeHsmConfigurationsRequest
- a Consumer
that will call methods on DescribeHsmConfigurationsMessage.Builder
.default DescribeHsmConfigurationsPublisher describeHsmConfigurationsPaginator(DescribeHsmConfigurationsRequest describeHsmConfigurationsRequest)
Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that
match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all HSM
connections that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeHsmConfigurations(software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.redshift.paginators.DescribeHsmConfigurationsPublisher publisher = client.describeHsmConfigurationsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.redshift.paginators.DescribeHsmConfigurationsPublisher publisher = client.describeHsmConfigurationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeHsmConfigurations(software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsRequest)
operation.
describeHsmConfigurationsRequest
- default DescribeHsmConfigurationsPublisher describeHsmConfigurationsPaginator()
Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that
match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all HSM
connections that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.
This is a variant of
describeHsmConfigurations(software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.redshift.paginators.DescribeHsmConfigurationsPublisher publisher = client.describeHsmConfigurationsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.redshift.paginators.DescribeHsmConfigurationsPublisher publisher = client.describeHsmConfigurationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeHsmConfigurations(software.amazon.awssdk.services.redshift.model.DescribeHsmConfigurationsRequest)
operation.
default CompletableFuture<DescribeLoggingStatusResponse> describeLoggingStatus(DescribeLoggingStatusRequest describeLoggingStatusRequest)
Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.
describeLoggingStatusRequest
- ClusterIdentifier
parameter does not refer to an existing
cluster.default CompletableFuture<DescribeLoggingStatusResponse> describeLoggingStatus(Consumer<DescribeLoggingStatusRequest.Builder> describeLoggingStatusRequest)
Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.
DescribeLoggingStatusRequest.Builder
avoiding the
need to create one manually via DescribeLoggingStatusRequest.builder()
describeLoggingStatusRequest
- a Consumer
that will call methods on DescribeLoggingStatusMessage.Builder
.ClusterIdentifier
parameter does not refer to an existing
cluster.default CompletableFuture<DescribeOrderableClusterOptionsResponse> describeOrderableClusterOptions(DescribeOrderableClusterOptionsRequest describeOrderableClusterOptionsRequest)
Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
describeOrderableClusterOptionsRequest
- default CompletableFuture<DescribeOrderableClusterOptionsResponse> describeOrderableClusterOptions()
Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
default CompletableFuture<DescribeOrderableClusterOptionsResponse> describeOrderableClusterOptions(Consumer<DescribeOrderableClusterOptionsRequest.Builder> describeOrderableClusterOptionsRequest)
Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
DescribeOrderableClusterOptionsRequest.Builder
avoiding the need to create one manually via DescribeOrderableClusterOptionsRequest.builder()
describeOrderableClusterOptionsRequest
- a Consumer
that will call methods on DescribeOrderableClusterOptionsMessage.Builder
.default DescribeOrderableClusterOptionsPublisher describeOrderableClusterOptionsPaginator(DescribeOrderableClusterOptionsRequest describeOrderableClusterOptionsRequest)
Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
This is a variant of
describeOrderableClusterOptions(software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.redshift.paginators.DescribeOrderableClusterOptionsPublisher publisher = client.describeOrderableClusterOptionsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.redshift.paginators.DescribeOrderableClusterOptionsPublisher publisher = client.describeOrderableClusterOptionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeOrderableClusterOptions(software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsRequest)
operation.
describeOrderableClusterOptionsRequest
- default DescribeOrderableClusterOptionsPublisher describeOrderableClusterOptionsPaginator()
Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
This is a variant of
describeOrderableClusterOptions(software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.redshift.paginators.DescribeOrderableClusterOptionsPublisher publisher = client.describeOrderableClusterOptionsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.redshift.paginators.DescribeOrderableClusterOptionsPublisher publisher = client.describeOrderableClusterOptionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeOrderableClusterOptions(software.amazon.awssdk.services.redshift.model.DescribeOrderableClusterOptionsRequest)
operation.
default CompletableFuture<DescribeReservedNodeOfferingsResponse> describeReservedNodeOfferings(DescribeReservedNodeOfferingsRequest describeReservedNodeOfferingsRequest)
Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster.
For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.
describeReservedNodeOfferingsRequest
- default CompletableFuture<DescribeReservedNodeOfferingsResponse> describeReservedNodeOfferings()
Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster.
For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.
default CompletableFuture<DescribeReservedNodeOfferingsResponse> describeReservedNodeOfferings(Consumer<DescribeReservedNodeOfferingsRequest.Builder> describeReservedNodeOfferingsRequest)
Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster.
For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.
DescribeReservedNodeOfferingsRequest.Builder
avoiding the need to create one manually via DescribeReservedNodeOfferingsRequest.builder()
describeReservedNodeOfferingsRequest
- a Consumer
that will call methods on DescribeReservedNodeOfferingsMessage.Builder
.default DescribeReservedNodeOfferingsPublisher describeReservedNodeOfferingsPaginator(DescribeReservedNodeOfferingsRequest describeReservedNodeOfferingsRequest)
Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster.
For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.
This is a variant of
describeReservedNodeOfferings(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeOfferingsPublisher publisher = client.describeReservedNodeOfferingsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeOfferingsPublisher publisher = client.describeReservedNodeOfferingsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeReservedNodeOfferings(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsRequest)
operation.
describeReservedNodeOfferingsRequest
- default DescribeReservedNodeOfferingsPublisher describeReservedNodeOfferingsPaginator()
Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster.
For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.
This is a variant of
describeReservedNodeOfferings(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeOfferingsPublisher publisher = client.describeReservedNodeOfferingsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodeOfferingsPublisher publisher = client.describeReservedNodeOfferingsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeReservedNodeOfferings(software.amazon.awssdk.services.redshift.model.DescribeReservedNodeOfferingsRequest)
operation.
default CompletableFuture<DescribeReservedNodesResponse> describeReservedNodes(DescribeReservedNodesRequest describeReservedNodesRequest)
Returns the descriptions of the reserved nodes.
describeReservedNodesRequest
- default CompletableFuture<DescribeReservedNodesResponse> describeReservedNodes()
Returns the descriptions of the reserved nodes.
default CompletableFuture<DescribeReservedNodesResponse> describeReservedNodes(Consumer<DescribeReservedNodesRequest.Builder> describeReservedNodesRequest)
Returns the descriptions of the reserved nodes.
DescribeReservedNodesRequest.Builder
avoiding the
need to create one manually via DescribeReservedNodesRequest.builder()
describeReservedNodesRequest
- a Consumer
that will call methods on DescribeReservedNodesMessage.Builder
.default DescribeReservedNodesPublisher describeReservedNodesPaginator(DescribeReservedNodesRequest describeReservedNodesRequest)
Returns the descriptions of the reserved nodes.
This is a variant of
describeReservedNodes(software.amazon.awssdk.services.redshift.model.DescribeReservedNodesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodesPublisher publisher = client.describeReservedNodesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodesPublisher publisher = client.describeReservedNodesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeReservedNodesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.redshift.model.DescribeReservedNodesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeReservedNodes(software.amazon.awssdk.services.redshift.model.DescribeReservedNodesRequest)
operation.
describeReservedNodesRequest
- default DescribeReservedNodesPublisher describeReservedNodesPaginator()
Returns the descriptions of the reserved nodes.
This is a variant of
describeReservedNodes(software.amazon.awssdk.services.redshift.model.DescribeReservedNodesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodesPublisher publisher = client.describeReservedNodesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.redshift.paginators.DescribeReservedNodesPublisher publisher = client.describeReservedNodesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.redshift.model.DescribeReservedNodesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.redshift.model.DescribeReservedNodesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeReservedNodes(software.amazon.awssdk.services.redshift.model.DescribeReservedNodesRequest)
operation.
default CompletableFuture<DescribeResizeResponse> describeResize(DescribeResizeRequest describeResizeRequest)
Returns information about the last resize operation for the specified cluster. If no resize operation has ever
been initiated for the specified cluster, a HTTP 404
error is returned. If a resize operation was
initiated and completed, the status of the resize remains as SUCCEEDED
until the next resize.
A resize operation can be requested using ModifyCluster and specifying a different number or type of nodes for the cluster.
describeResizeRequest
- ClusterIdentifier
parameter does not refer to an existing
cluster.default CompletableFuture<DescribeResizeResponse> describeResize(Consumer<DescribeResizeRequest.Builder> describeResizeRequest)
Returns information about the last resize operation for the specified cluster. If no resize operation has ever
been initiated for the specified cluster, a HTTP 404
error is returned. If a resize operation was
initiated and completed, the status of the resize remains as SUCCEEDED
until the next resize.
A resize operation can be requested using ModifyCluster and specifying a different number or type of nodes for the cluster.
DescribeResizeRequest.Builder
avoiding the need to
create one manually via DescribeResizeRequest.builder()
describeResizeRequest
- a Consumer
that will call methods on DescribeResizeMessage.Builder
.ClusterIdentifier
parameter does not refer to an existing
cluster.default CompletableFuture<DescribeSnapshotCopyGrantsResponse> describeSnapshotCopyGrants(DescribeSnapshotCopyGrantsRequest describeSnapshotCopyGrantsRequest)
Returns a list of snapshot copy grants owned by the AWS account in the destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
describeSnapshotCopyGrantsRequest
- The result of the DescribeSnapshotCopyGrants
action.default CompletableFuture<DescribeSnapshotCopyGrantsResponse> describeSnapshotCopyGrants()
Returns a list of snapshot copy grants owned by the AWS account in the destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
default CompletableFuture<DescribeSnapshotCopyGrantsResponse> describeSnapshotCopyGrants(Consumer<DescribeSnapshotCopyGrantsRequest.Builder> describeSnapshotCopyGrantsRequest)
Returns a list of snapshot copy grants owned by the AWS account in the destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
DescribeSnapshotCopyGrantsRequest.Builder
avoiding
the need to create one manually via DescribeSnapshotCopyGrantsRequest.builder()
describeSnapshotCopyGrantsRequest
- a Consumer
that will call methods on DescribeSnapshotCopyGrantsMessage.Builder
.default CompletableFuture<DescribeTableRestoreStatusResponse> describeTableRestoreStatus(DescribeTableRestoreStatusRequest describeTableRestoreStatusRequest)
Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API
action. If you don't specify a value for the TableRestoreRequestId
parameter, then
DescribeTableRestoreStatus
returns the status of all table restore requests ordered by the date and
time of the request in ascending order. Otherwise DescribeTableRestoreStatus
returns the status of
the table specified by TableRestoreRequestId
.
describeTableRestoreStatusRequest
- TableRestoreRequestId
value was not found.ClusterIdentifier
parameter does not refer to an existing
cluster.default CompletableFuture<DescribeTableRestoreStatusResponse> describeTableRestoreStatus(Consumer<DescribeTableRestoreStatusRequest.Builder> describeTableRestoreStatusRequest)
Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API
action. If you don't specify a value for the TableRestoreRequestId
parameter, then
DescribeTableRestoreStatus
returns the status of all table restore requests ordered by the date and
time of the request in ascending order. Otherwise DescribeTableRestoreStatus
returns the status of
the table specified by TableRestoreRequestId
.
DescribeTableRestoreStatusRequest.Builder
avoiding
the need to create one manually via DescribeTableRestoreStatusRequest.builder()
describeTableRestoreStatusRequest
- a Consumer
that will call methods on DescribeTableRestoreStatusMessage.Builder
.TableRestoreRequestId
value was not found.ClusterIdentifier
parameter does not refer to an existing
cluster.default CompletableFuture<DescribeTagsResponse> describeTags(DescribeTagsRequest describeTagsRequest)
Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on.
The following are limitations for DescribeTags
:
You cannot specify an ARN and a resource-type value together in the same request.
You cannot use the MaxRecords
and Marker
parameters together with the ARN parameter.
The MaxRecords
parameter can be a range from 10 to 50 results to return in a request.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match
any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all resources
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.
describeTagsRequest
- default CompletableFuture<DescribeTagsResponse> describeTags()
Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on.
The following are limitations for DescribeTags
:
You cannot specify an ARN and a resource-type value together in the same request.
You cannot use the MaxRecords
and Marker
parameters together with the ARN parameter.
The MaxRecords
parameter can be a range from 10 to 50 results to return in a request.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match
any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all resources
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.
default CompletableFuture<DescribeTagsResponse> describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest)
Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on.
The following are limitations for DescribeTags
:
You cannot specify an ARN and a resource-type value together in the same request.
You cannot use the MaxRecords
and Marker
parameters together with the ARN parameter.
The MaxRecords
parameter can be a range from 10 to 50 results to return in a request.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match
any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all resources
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.
DescribeTagsRequest.Builder
avoiding the need to
create one manually via DescribeTagsRequest.builder()
describeTagsRequest
- a Consumer
that will call methods on DescribeTagsMessage.Builder
.default CompletableFuture<DisableLoggingResponse> disableLogging(DisableLoggingRequest disableLoggingRequest)
Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
disableLoggingRequest
- ClusterIdentifier
parameter does not refer to an existing
cluster.default CompletableFuture<DisableLoggingResponse> disableLogging(Consumer<DisableLoggingRequest.Builder> disableLoggingRequest)
Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
DisableLoggingRequest.Builder
avoiding the need to
create one manually via DisableLoggingRequest.builder()
disableLoggingRequest
- a Consumer
that will call methods on DisableLoggingMessage.Builder
.ClusterIdentifier
parameter does not refer to an existing
cluster.default CompletableFuture<DisableSnapshotCopyResponse> disableSnapshotCopy(DisableSnapshotCopyRequest disableSnapshotCopyRequest)
Disables the automatic copying of snapshots from one region to another region for a specified cluster.
If your cluster and its snapshots are encrypted using a customer master key (CMK) from AWS KMS, use DeleteSnapshotCopyGrant to delete the grant that grants Amazon Redshift permission to the CMK in the destination region.
disableSnapshotCopyRequest
- ClusterIdentifier
parameter does not refer to an existing
cluster.available
state.default CompletableFuture<DisableSnapshotCopyResponse> disableSnapshotCopy(Consumer<DisableSnapshotCopyRequest.Builder> disableSnapshotCopyRequest)
Disables the automatic copying of snapshots from one region to another region for a specified cluster.
If your cluster and its snapshots are encrypted using a customer master key (CMK) from AWS KMS, use DeleteSnapshotCopyGrant to delete the grant that grants Amazon Redshift permission to the CMK in the destination region.
DisableSnapshotCopyRequest.Builder
avoiding the
need to create one manually via DisableSnapshotCopyRequest.builder()
disableSnapshotCopyRequest
- a Consumer
that will call methods on DisableSnapshotCopyMessage.Builder
.ClusterIdentifier
parameter does not refer to an existing
cluster.available
state.default CompletableFuture<EnableLoggingResponse> enableLogging(EnableLoggingRequest enableLoggingRequest)
Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
enableLoggingRequest
- ClusterIdentifier
parameter does not refer to an existing
cluster.default CompletableFuture<EnableLoggingResponse> enableLogging(Consumer<EnableLoggingRequest.Builder> enableLoggingRequest)
Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
EnableLoggingRequest.Builder
avoiding the need to
create one manually via EnableLoggingRequest.builder()
enableLoggingRequest
- a Consumer
that will call methods on EnableLoggingMessage.Builder
.ClusterIdentifier
parameter does not refer to an existing
cluster.default CompletableFuture<EnableSnapshotCopyResponse> enableSnapshotCopy(EnableSnapshotCopyRequest enableSnapshotCopyRequest)
Enables the automatic copy of snapshots from one region to another region for a specified cluster.
enableSnapshotCopyRequest
- available
state.ClusterIdentifier
parameter does not refer to an existing
cluster.default CompletableFuture<EnableSnapshotCopyResponse> enableSnapshotCopy(Consumer<EnableSnapshotCopyRequest.Builder> enableSnapshotCopyRequest)
Enables the automatic copy of snapshots from one region to another region for a specified cluster.
EnableSnapshotCopyRequest.Builder
avoiding the
need to create one manually via EnableSnapshotCopyRequest.builder()
enableSnapshotCopyRequest
- a Consumer
that will call methods on EnableSnapshotCopyMessage.Builder
.available
state.ClusterIdentifier
parameter does not refer to an existing
cluster.default CompletableFuture<GetClusterCredentialsResponse> getClusterCredentials(GetClusterCredentialsRequest getClusterCredentialsRequest)
Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift
database. The action returns the database user name prefixed with IAM:
if AutoCreate
is
False
or IAMA:
if AutoCreate
is True
. You can optionally
specify one or more database user groups that the user will join at log on. By default, the temporary credentials
expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds
(60 minutes). For more information, see Using IAM Authentication
to Generate Database User Credentials in the Amazon Redshift Cluster Management Guide.
The AWS Identity and Access Management (IAM)user or role that executes GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the Amazon Redshift Cluster Management Guide.
If the DbGroups
parameter is specified, the IAM policy must allow the
redshift:JoinGroup
action with access to the listed dbgroups
.
In addition, if the AutoCreate
parameter is set to True
, then the policy must include
the redshift:CreateClusterUser
privilege.
If the DbName
parameter is specified, the IAM policy must allow access to the resource
dbname
for the specified database name.
getClusterCredentialsRequest
- The request parameters to get cluster credentials.ClusterIdentifier
parameter does not refer to an existing
cluster.default CompletableFuture<GetClusterCredentialsResponse> getClusterCredentials(Consumer<GetClusterCredentialsRequest.Builder> getClusterCredentialsRequest)
Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift
database. The action returns the database user name prefixed with IAM:
if AutoCreate
is
False
or IAMA:
if AutoCreate
is True
. You can optionally
specify one or more database user groups that the user will join at log on. By default, the temporary credentials
expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds
(60 minutes). For more information, see Using IAM Authentication
to Generate Database User Credentials in the Amazon Redshift Cluster Management Guide.
The AWS Identity and Access Management (IAM)user or role that executes GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the Amazon Redshift Cluster Management Guide.
If the DbGroups
parameter is specified, the IAM policy must allow the
redshift:JoinGroup
action with access to the listed dbgroups
.
In addition, if the AutoCreate
parameter is set to True
, then the policy must include
the redshift:CreateClusterUser
privilege.
If the DbName
parameter is specified, the IAM policy must allow access to the resource
dbname
for the specified database name.
GetClusterCredentialsRequest.Builder
avoiding the
need to create one manually via GetClusterCredentialsRequest.builder()
getClusterCredentialsRequest
- a Consumer
that will call methods on GetClusterCredentialsMessage.Builder
.ClusterIdentifier
parameter does not refer to an existing
cluster.default CompletableFuture<ModifyClusterResponse> modifyCluster(ModifyClusterRequest modifyClusterRequest)
Modifies the settings for a cluster. For example, you can add another security or parameter group, update the preferred maintenance window, or change the master user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change.
modifyClusterRequest
- available
state.available
.ClusterIdentifier
parameter does not refer to an existing
cluster.default CompletableFuture<ModifyClusterResponse> modifyCluster(Consumer<ModifyClusterRequest.Builder> modifyClusterRequest)
Modifies the settings for a cluster. For example, you can add another security or parameter group, update the preferred maintenance window, or change the master user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change.
ModifyClusterRequest.Builder
avoiding the need to
create one manually via ModifyClusterRequest.builder()
modifyClusterRequest
- a Consumer
that will call methods on ModifyClusterMessage.Builder
.available
state.available
.ClusterIdentifier
parameter does not refer to an existing
cluster.default CompletableFuture<ModifyClusterIamRolesResponse> modifyClusterIamRoles(ModifyClusterIamRolesRequest modifyClusterIamRolesRequest)
Modifies the list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
A cluster can have up to 10 IAM roles associated at any time.
modifyClusterIamRolesRequest
- available
state.ClusterIdentifier
parameter does not refer to an existing
cluster.default CompletableFuture<ModifyClusterIamRolesResponse> modifyClusterIamRoles(Consumer<ModifyClusterIamRolesRequest.Builder> modifyClusterIamRolesRequest)
Modifies the list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
A cluster can have up to 10 IAM roles associated at any time.
ModifyClusterIamRolesRequest.Builder
avoiding the
need to create one manually via ModifyClusterIamRolesRequest.builder()
modifyClusterIamRolesRequest
- a Consumer
that will call methods on ModifyClusterIamRolesMessage.Builder
.available
state.ClusterIdentifier
parameter does not refer to an existing
cluster.default CompletableFuture<ModifyClusterParameterGroupResponse> modifyClusterParameterGroup(ModifyClusterParameterGroupRequest modifyClusterParameterGroupRequest)
Modifies the parameters of a parameter group.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
modifyClusterParameterGroupRequest
- default CompletableFuture<ModifyClusterParameterGroupResponse> modifyClusterParameterGroup(Consumer<ModifyClusterParameterGroupRequest.Builder> modifyClusterParameterGroupRequest)
Modifies the parameters of a parameter group.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
ModifyClusterParameterGroupRequest.Builder
avoiding the need to create one manually via ModifyClusterParameterGroupRequest.builder()
modifyClusterParameterGroupRequest
- a Consumer
that will call methods on ModifyClusterParameterGroupMessage.Builder
.default CompletableFuture<ModifyClusterSubnetGroupResponse> modifyClusterSubnetGroup(ModifyClusterSubnetGroupRequest modifyClusterSubnetGroupRequest)
Modifies a cluster subnet group to include the specified list of VPC subnets. The operation replaces the existing list of subnets with the new list of subnets.
modifyClusterSubnetGroupRequest
- default CompletableFuture<ModifyClusterSubnetGroupResponse> modifyClusterSubnetGroup(Consumer<ModifyClusterSubnetGroupRequest.Builder> modifyClusterSubnetGroupRequest)
Modifies a cluster subnet group to include the specified list of VPC subnets. The operation replaces the existing list of subnets with the new list of subnets.
ModifyClusterSubnetGroupRequest.Builder
avoiding
the need to create one manually via ModifyClusterSubnetGroupRequest.builder()
modifyClusterSubnetGroupRequest
- a Consumer
that will call methods on ModifyClusterSubnetGroupMessage.Builder
.default CompletableFuture<ModifyEventSubscriptionResponse> modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest)
Modifies an existing Amazon Redshift event notification subscription.
modifyEventSubscriptionRequest
- default CompletableFuture<ModifyEventSubscriptionResponse> modifyEventSubscription(Consumer<ModifyEventSubscriptionRequest.Builder> modifyEventSubscriptionRequest)
Modifies an existing Amazon Redshift event notification subscription.
ModifyEventSubscriptionRequest.Builder
avoiding
the need to create one manually via ModifyEventSubscriptionRequest.builder()
modifyEventSubscriptionRequest
- a Consumer
that will call methods on ModifyEventSubscriptionMessage.Builder
.default CompletableFuture<ModifySnapshotCopyRetentionPeriodResponse> modifySnapshotCopyRetentionPeriod(ModifySnapshotCopyRetentionPeriodRequest modifySnapshotCopyRetentionPeriodRequest)
Modifies the number of days to retain automated snapshots in the destination region after they are copied from the source region.
modifySnapshotCopyRetentionPeriodRequest
- ClusterIdentifier
parameter does not refer to an existing
cluster.available
state.default CompletableFuture<ModifySnapshotCopyRetentionPeriodResponse> modifySnapshotCopyRetentionPeriod(Consumer<ModifySnapshotCopyRetentionPeriodRequest.Builder> modifySnapshotCopyRetentionPeriodRequest)
Modifies the number of days to retain automated snapshots in the destination region after they are copied from the source region.
ModifySnapshotCopyRetentionPeriodRequest.Builder
avoiding the need to create one manually via ModifySnapshotCopyRetentionPeriodRequest.builder()
modifySnapshotCopyRetentionPeriodRequest
- a Consumer
that will call methods on ModifySnapshotCopyRetentionPeriodMessage.Builder
.ClusterIdentifier
parameter does not refer to an existing
cluster.available
state.default CompletableFuture<PurchaseReservedNodeOfferingResponse> purchaseReservedNodeOffering(PurchaseReservedNodeOfferingRequest purchaseReservedNodeOfferingRequest)
Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings. You can purchase one or more of the offerings. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings. You can call this API by providing a specific reserved node offering and the number of nodes you want to reserve.
For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.
purchaseReservedNodeOfferingRequest
- default CompletableFuture<PurchaseReservedNodeOfferingResponse> purchaseReservedNodeOffering(Consumer<PurchaseReservedNodeOfferingRequest.Builder> purchaseReservedNodeOfferingRequest)
Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings. You can purchase one or more of the offerings. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings. You can call this API by providing a specific reserved node offering and the number of nodes you want to reserve.
For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.
PurchaseReservedNodeOfferingRequest.Builder
avoiding the need to create one manually via PurchaseReservedNodeOfferingRequest.builder()
purchaseReservedNodeOfferingRequest
- a Consumer
that will call methods on PurchaseReservedNodeOfferingMessage.Builder
.default CompletableFuture<RebootClusterResponse> rebootCluster(RebootClusterRequest rebootClusterRequest)
Reboots a cluster. This action is taken as soon as possible. It results in a momentary outage to the cluster,
during which the cluster status is set to rebooting
. A cluster event is created when the reboot is
completed. Any pending cluster modifications (see ModifyCluster) are applied at this reboot. For more
information about managing clusters, go to Amazon Redshift Clusters in
the Amazon Redshift Cluster Management Guide.
rebootClusterRequest
- available
state.ClusterIdentifier
parameter does not refer to an existing
cluster.default CompletableFuture<RebootClusterResponse> rebootCluster(Consumer<RebootClusterRequest.Builder> rebootClusterRequest)
Reboots a cluster. This action is taken as soon as possible. It results in a momentary outage to the cluster,
during which the cluster status is set to rebooting
. A cluster event is created when the reboot is
completed. Any pending cluster modifications (see ModifyCluster) are applied at this reboot. For more
information about managing clusters, go to Amazon Redshift Clusters in
the Amazon Redshift Cluster Management Guide.
RebootClusterRequest.Builder
avoiding the need to
create one manually via RebootClusterRequest.builder()
rebootClusterRequest
- a Consumer
that will call methods on RebootClusterMessage.Builder
.available
state.ClusterIdentifier
parameter does not refer to an existing
cluster.default CompletableFuture<ResetClusterParameterGroupResponse> resetClusterParameterGroup(ResetClusterParameterGroupRequest resetClusterParameterGroupRequest)
Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to "engine-default". To reset the entire parameter group specify the ResetAllParameters parameter. For parameter changes to take effect you must reboot any associated clusters.
resetClusterParameterGroupRequest
- default CompletableFuture<ResetClusterParameterGroupResponse> resetClusterParameterGroup(Consumer<ResetClusterParameterGroupRequest.Builder> resetClusterParameterGroupRequest)
Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to "engine-default". To reset the entire parameter group specify the ResetAllParameters parameter. For parameter changes to take effect you must reboot any associated clusters.
ResetClusterParameterGroupRequest.Builder
avoiding
the need to create one manually via ResetClusterParameterGroupRequest.builder()
resetClusterParameterGroupRequest
- a Consumer
that will call methods on ResetClusterParameterGroupMessage.Builder
.default CompletableFuture<RestoreFromClusterSnapshotResponse> restoreFromClusterSnapshot(RestoreFromClusterSnapshotRequest restoreFromClusterSnapshotRequest)
Creates a new cluster from a snapshot. By default, Amazon Redshift creates the resulting cluster with the same configuration as the original cluster from which the snapshot was created, except that the new cluster is created with the default cluster security and parameter groups. After Amazon Redshift creates the cluster, you can use the ModifyCluster API to associate a different security group and different parameter group with the restored cluster. If you are using a DS node type, you can also choose to change to another DS node type of the same size during restore.
If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster restored.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
restoreFromClusterSnapshotRequest
- available
state, or other accounts are authorized to access the snapshot.default CompletableFuture<RestoreFromClusterSnapshotResponse> restoreFromClusterSnapshot(Consumer<RestoreFromClusterSnapshotRequest.Builder> restoreFromClusterSnapshotRequest)
Creates a new cluster from a snapshot. By default, Amazon Redshift creates the resulting cluster with the same configuration as the original cluster from which the snapshot was created, except that the new cluster is created with the default cluster security and parameter groups. After Amazon Redshift creates the cluster, you can use the ModifyCluster API to associate a different security group and different parameter group with the restored cluster. If you are using a DS node type, you can also choose to change to another DS node type of the same size during restore.
If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster restored.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
RestoreFromClusterSnapshotRequest.Builder
avoiding
the need to create one manually via RestoreFromClusterSnapshotRequest.builder()
restoreFromClusterSnapshotRequest
- a Consumer
that will call methods on RestoreFromClusterSnapshotMessage.Builder
.available
state, or other accounts are authorized to access the snapshot.default CompletableFuture<RestoreTableFromClusterSnapshotResponse> restoreTableFromClusterSnapshot(RestoreTableFromClusterSnapshotRequest restoreTableFromClusterSnapshotRequest)
Creates a new table from a table in an Amazon Redshift cluster snapshot. You must create the new table within the Amazon Redshift cluster that the snapshot was taken from.
You cannot use RestoreTableFromClusterSnapshot
to restore a table with the same name as an existing
table in an Amazon Redshift cluster. That is, you cannot overwrite an existing table in a cluster with a restored
table. If you want to replace your original table with a new, restored table, then rename or drop your original
table before you call RestoreTableFromClusterSnapshot
. When you have renamed your original table,
then you can pass the original name of the table as the NewTableName
parameter value in the call to
RestoreTableFromClusterSnapshot
. This way, you can replace the original table with the table created
from the snapshot.
restoreTableFromClusterSnapshotRequest
- available
state, or other accounts are authorized to access the snapshot.sourceDatabaseName
,
sourceSchemaName
, or sourceTableName
parameter, or a combination of these,
doesn't exist in the snapshot.ClusterIdentifier
parameter does not refer to an existing
cluster.available
state.default CompletableFuture<RestoreTableFromClusterSnapshotResponse> restoreTableFromClusterSnapshot(Consumer<RestoreTableFromClusterSnapshotRequest.Builder> restoreTableFromClusterSnapshotRequest)
Creates a new table from a table in an Amazon Redshift cluster snapshot. You must create the new table within the Amazon Redshift cluster that the snapshot was taken from.
You cannot use RestoreTableFromClusterSnapshot
to restore a table with the same name as an existing
table in an Amazon Redshift cluster. That is, you cannot overwrite an existing table in a cluster with a restored
table. If you want to replace your original table with a new, restored table, then rename or drop your original
table before you call RestoreTableFromClusterSnapshot
. When you have renamed your original table,
then you can pass the original name of the table as the NewTableName
parameter value in the call to
RestoreTableFromClusterSnapshot
. This way, you can replace the original table with the table created
from the snapshot.
RestoreTableFromClusterSnapshotRequest.Builder
avoiding the need to create one manually via RestoreTableFromClusterSnapshotRequest.builder()
restoreTableFromClusterSnapshotRequest
- a Consumer
that will call methods on RestoreTableFromClusterSnapshotMessage.Builder
.available
state, or other accounts are authorized to access the snapshot.sourceDatabaseName
,
sourceSchemaName
, or sourceTableName
parameter, or a combination of these,
doesn't exist in the snapshot.ClusterIdentifier
parameter does not refer to an existing
cluster.available
state.default CompletableFuture<RevokeClusterSecurityGroupIngressResponse> revokeClusterSecurityGroupIngress(RevokeClusterSecurityGroupIngressRequest revokeClusterSecurityGroupIngressRequest)
Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group. To add an ingress rule, see AuthorizeClusterSecurityGroupIngress. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
revokeClusterSecurityGroupIngressRequest
- available
.default CompletableFuture<RevokeClusterSecurityGroupIngressResponse> revokeClusterSecurityGroupIngress(Consumer<RevokeClusterSecurityGroupIngressRequest.Builder> revokeClusterSecurityGroupIngressRequest)
Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group. To add an ingress rule, see AuthorizeClusterSecurityGroupIngress. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
RevokeClusterSecurityGroupIngressRequest.Builder
avoiding the need to create one manually via RevokeClusterSecurityGroupIngressRequest.builder()
revokeClusterSecurityGroupIngressRequest
- a Consumer
that will call methods on RevokeClusterSecurityGroupIngressMessage.Builder
.available
.default CompletableFuture<RevokeSnapshotAccessResponse> revokeSnapshotAccess(RevokeSnapshotAccessRequest revokeSnapshotAccessRequest)
Removes the ability of the specified AWS customer account to restore the specified snapshot. If the account is currently restoring the snapshot, the restore will run to completion.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
revokeSnapshotAccessRequest
- default CompletableFuture<RevokeSnapshotAccessResponse> revokeSnapshotAccess(Consumer<RevokeSnapshotAccessRequest.Builder> revokeSnapshotAccessRequest)
Removes the ability of the specified AWS customer account to restore the specified snapshot. If the account is currently restoring the snapshot, the restore will run to completion.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
RevokeSnapshotAccessRequest.Builder
avoiding the
need to create one manually via RevokeSnapshotAccessRequest.builder()
revokeSnapshotAccessRequest
- a Consumer
that will call methods on RevokeSnapshotAccessMessage.Builder
.default CompletableFuture<RotateEncryptionKeyResponse> rotateEncryptionKey(RotateEncryptionKeyRequest rotateEncryptionKeyRequest)
Rotates the encryption keys for a cluster.
rotateEncryptionKeyRequest
- ClusterIdentifier
parameter does not refer to an existing
cluster.available
state.default CompletableFuture<RotateEncryptionKeyResponse> rotateEncryptionKey(Consumer<RotateEncryptionKeyRequest.Builder> rotateEncryptionKeyRequest)
Rotates the encryption keys for a cluster.
RotateEncryptionKeyRequest.Builder
avoiding the
need to create one manually via RotateEncryptionKeyRequest.builder()
rotateEncryptionKeyRequest
- a Consumer
that will call methods on RotateEncryptionKeyMessage.Builder
.ClusterIdentifier
parameter does not refer to an existing
cluster.available
state.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.