Struct Client

pub struct Client { /* private fields */ }

Client for Amazon Redshift

Client for invoking operations on Amazon Redshift. Each operation on Amazon Redshift is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_redshift::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_redshift::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AcceptReservedNodeExchange operation has a Client::accept_reserved_node_exchange, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.accept_reserved_node_exchange()
    .reserved_node_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Waiters

This client provides wait_until methods behind the Waiters trait. To use them, simply import the trait, and then call one of the wait_until methods. This will return a waiter fluent builder that takes various parameters, which are documented on the builder type. Once parameters have been provided, the wait method can be called to initiate waiting.

For example, if there was a wait_until_thing method, it could look like:

let result = client.wait_until_thing()
    .thing_id("someId")
    .wait(Duration::from_secs(120))
    .await;

Implementations

impl Client

pub fn accept_reserved_node_exchange( &self, ) -> AcceptReservedNodeExchangeFluentBuilder

Constructs a fluent builder for the AcceptReservedNodeExchange operation.

• The fluent builder is configurable:
  • reserved_node_id(impl Into<String>) / set_reserved_node_id(Option<String>):
    required: true
    

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

    
    
  • target_reserved_node_offering_id(impl Into<String>) / set_target_reserved_node_offering_id(Option<String>):
    required: true
    

    The unique identifier of the DC2 Reserved Node offering to be used for the exchange. You can obtain the value for the parameter by calling GetReservedNodeExchangeOfferings

    
    
• On success, responds with AcceptReservedNodeExchangeOutput with field(s):
  • exchanged_reserved_node(Option<ReservedNode>):

• On failure, responds with SdkError<AcceptReservedNodeExchangeError>

impl Client

pub fn add_partner(&self) -> AddPartnerFluentBuilder

Constructs a fluent builder for the AddPartner operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID that owns the cluster.

    
    
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

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

    
    
  • database_name(impl Into<String>) / set_database_name(Option<String>):
    required: true
    

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

    
    
  • partner_name(impl Into<String>) / set_partner_name(Option<String>):
    required: true
    

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

    
    
• On success, responds with AddPartnerOutput with field(s):
  • database_name(Option<String>):

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

  • partner_name(Option<String>):

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

• On failure, responds with SdkError<AddPartnerError>

impl Client

pub fn associate_data_share_consumer( &self, ) -> AssociateDataShareConsumerFluentBuilder

Constructs a fluent builder for the AssociateDataShareConsumer operation.

• The fluent builder is configurable:
  • data_share_arn(impl Into<String>) / set_data_share_arn(Option<String>):
    required: true
    

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

    
    
  • associate_entire_account(bool) / set_associate_entire_account(Option<bool>):
    required: false
    

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

    
    
  • consumer_arn(impl Into<String>) / set_consumer_arn(Option<String>):
    required: false
    

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

    
    
  • consumer_region(impl Into<String>) / set_consumer_region(Option<String>):
    required: false
    

    From a datashare consumer account, associates a datashare with all existing and future namespaces in the specified Amazon Web Services Region.

    
    
  • allow_writes(bool) / set_allow_writes(Option<bool>):
    required: false
    

    If set to true, allows write operations for a datashare.

    
    
• On success, responds with AssociateDataShareConsumerOutput with field(s):
  • data_share_arn(Option<String>):

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

  • producer_arn(Option<String>):

    The Amazon Resource Name (ARN) of the producer namespace.

  • allow_publicly_accessible_consumers(Option<bool>):

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

  • data_share_associations(Option<Vec::<DataShareAssociation>>):

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

  • managed_by(Option<String>):

    The identifier of a datashare to show its managing entity.

  • data_share_type(Option<DataShareType>):

    The type of the datashare created by RegisterNamespace.

• On failure, responds with SdkError<AssociateDataShareConsumerError>

impl Client

pub fn authorize_cluster_security_group_ingress( &self, ) -> AuthorizeClusterSecurityGroupIngressFluentBuilder

Constructs a fluent builder for the AuthorizeClusterSecurityGroupIngress operation.

• The fluent builder is configurable:
  • cluster_security_group_name(impl Into<String>) / set_cluster_security_group_name(Option<String>):
    required: true
    

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

    
    
  • cidrip(impl Into<String>) / set_cidrip(Option<String>):
    required: false
    

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

    
    
  • ec2_security_group_name(impl Into<String>) / set_ec2_security_group_name(Option<String>):
    required: false
    

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

    
    
  • ec2_security_group_owner_id(impl Into<String>) / set_ec2_security_group_owner_id(Option<String>):
    required: false
    

    The Amazon Web Services account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The Amazon Web Services Access Key ID is not an acceptable value.

    Example: 111122223333

    
    
• On success, responds with AuthorizeClusterSecurityGroupIngressOutput with field(s):
  • cluster_security_group(Option<ClusterSecurityGroup>):

    Describes a security group.

• On failure, responds with SdkError<AuthorizeClusterSecurityGroupIngressError>

impl Client

pub fn authorize_data_share(&self) -> AuthorizeDataShareFluentBuilder

Constructs a fluent builder for the AuthorizeDataShare operation.

• The fluent builder is configurable:
  • data_share_arn(impl Into<String>) / set_data_share_arn(Option<String>):
    required: true
    

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

    
    
  • consumer_identifier(impl Into<String>) / set_consumer_identifier(Option<String>):
    required: true
    

    The identifier of the data consumer that is authorized to access the datashare. This identifier is an Amazon Web Services account ID or a keyword, such as ADX.

    
    
  • allow_writes(bool) / set_allow_writes(Option<bool>):
    required: false
    

    If set to true, allows write operations for a datashare.

    
    
• On success, responds with AuthorizeDataShareOutput with field(s):
  • data_share_arn(Option<String>):

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

  • producer_arn(Option<String>):

    The Amazon Resource Name (ARN) of the producer namespace.

  • allow_publicly_accessible_consumers(Option<bool>):

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

  • data_share_associations(Option<Vec::<DataShareAssociation>>):

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

  • managed_by(Option<String>):

    The identifier of a datashare to show its managing entity.

  • data_share_type(Option<DataShareType>):

    The type of the datashare created by RegisterNamespace.

• On failure, responds with SdkError<AuthorizeDataShareError>

impl Client

pub fn authorize_endpoint_access(&self) -> AuthorizeEndpointAccessFluentBuilder

Constructs a fluent builder for the AuthorizeEndpointAccess operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: false
    

    The cluster identifier of the cluster to grant access to.

    
    
  • account(impl Into<String>) / set_account(Option<String>):
    required: true
    

    The Amazon Web Services account ID to grant access to.

    
    
  • vpc_ids(impl Into<String>) / set_vpc_ids(Option<Vec::<String>>):
    required: false
    

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

    
    
• On success, responds with AuthorizeEndpointAccessOutput with field(s):
  • grantor(Option<String>):

    The Amazon Web Services account ID of the cluster owner.

  • grantee(Option<String>):

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

  • cluster_identifier(Option<String>):

    The cluster identifier.

  • authorize_time(Option<DateTime>):

    The time (UTC) when the authorization was created.

  • cluster_status(Option<String>):

    The status of the cluster.

  • status(Option<AuthorizationStatus>):

    The status of the authorization action.

  • allowed_all_vpcs(Option<bool>):

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

  • allowed_vpcs(Option<Vec::<String>>):

    The VPCs allowed access to the cluster.

  • endpoint_count(Option<i32>):

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

• On failure, responds with SdkError<AuthorizeEndpointAccessError>

impl Client

pub fn authorize_snapshot_access(&self) -> AuthorizeSnapshotAccessFluentBuilder

Constructs a fluent builder for the AuthorizeSnapshotAccess operation.

• The fluent builder is configurable:
  • snapshot_identifier(impl Into<String>) / set_snapshot_identifier(Option<String>):
    required: false
    

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

    
    
  • snapshot_arn(impl Into<String>) / set_snapshot_arn(Option<String>):
    required: false
    

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

    
    
  • snapshot_cluster_identifier(impl Into<String>) / set_snapshot_cluster_identifier(Option<String>):
    required: false
    

    The identifier of the cluster the snapshot was created from.

    • If the snapshot to access doesn’t exist and the associated IAM policy doesn’t allow access to all (*) snapshots - This parameter is required. Otherwise, permissions aren’t available to check if the snapshot exists.

    • If the snapshot to access exists - This parameter isn’t required. Redshift can retrieve the cluster identifier and use it to validate snapshot authorization.

    
    
  • account_with_restore_access(impl Into<String>) / set_account_with_restore_access(Option<String>):
    required: true
    

    The identifier of the Amazon Web Services account authorized to restore the specified snapshot.

    To share a snapshot with Amazon Web Services Support, specify amazon-redshift-support.

    
    
• On success, responds with AuthorizeSnapshotAccessOutput with field(s):
  • snapshot(Option<Snapshot>):

    Describes a snapshot.

• On failure, responds with SdkError<AuthorizeSnapshotAccessError>

impl Client

pub fn batch_delete_cluster_snapshots( &self, ) -> BatchDeleteClusterSnapshotsFluentBuilder

Constructs a fluent builder for the BatchDeleteClusterSnapshots operation.

• The fluent builder is configurable:
  • identifiers(DeleteClusterSnapshotMessage) / set_identifiers(Option<Vec::<DeleteClusterSnapshotMessage>>):
    required: true
    

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

    
    
• On success, responds with BatchDeleteClusterSnapshotsOutput with field(s):
  • resources(Option<Vec::<String>>):

    A list of the snapshot identifiers that were deleted.

  • errors(Option<Vec::<SnapshotErrorMessage>>):

    A list of any errors returned.

• On failure, responds with SdkError<BatchDeleteClusterSnapshotsError>

impl Client

pub fn batch_modify_cluster_snapshots( &self, ) -> BatchModifyClusterSnapshotsFluentBuilder

Constructs a fluent builder for the BatchModifyClusterSnapshots operation.

• The fluent builder is configurable:
  • snapshot_identifier_list(impl Into<String>) / set_snapshot_identifier_list(Option<Vec::<String>>):
    required: true
    

    A list of snapshot identifiers you want to modify.

    
    
  • manual_snapshot_retention_period(i32) / set_manual_snapshot_retention_period(Option<i32>):
    required: false
    

    The number of days that a manual snapshot is retained. If you specify the value -1, the manual snapshot is retained indefinitely.

    The number must be either -1 or an integer between 1 and 3,653.

    If you decrease the manual snapshot retention period from its current value, existing manual snapshots that fall outside of the new retention period will return an error. If you want to suppress the errors and delete the snapshots, use the force option.

    
    
  • force(bool) / set_force(Option<bool>):
    required: false
    

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

    
    
• On success, responds with BatchModifyClusterSnapshotsOutput with field(s):
  • resources(Option<Vec::<String>>):

    A list of the snapshots that were modified.

  • errors(Option<Vec::<SnapshotErrorMessage>>):

    A list of any errors returned.

• On failure, responds with SdkError<BatchModifyClusterSnapshotsError>

impl Client

pub fn cancel_resize(&self) -> CancelResizeFluentBuilder

Constructs a fluent builder for the CancelResize operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

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

    
    
• On success, responds with CancelResizeOutput with field(s):
  • target_node_type(Option<String>):

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

  • target_number_of_nodes(Option<i32>):

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

  • target_cluster_type(Option<String>):

    The cluster type after the resize operation is complete.

    Valid Values: multi-node | single-node

  • status(Option<String>):

    The status of the resize operation.

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

  • import_tables_completed(Option<Vec::<String>>):

    The names of tables that have been completely imported .

    Valid Values: List of table names.

  • import_tables_in_progress(Option<Vec::<String>>):

    The names of tables that are being currently imported.

    Valid Values: List of table names.

  • import_tables_not_started(Option<Vec::<String>>):

    The names of tables that have not been yet imported.

    Valid Values: List of table names

  • avg_resize_rate_in_mega_bytes_per_second(Option<f64>):

    The average rate of the resize operation over the last few minutes, measured in megabytes per second. After the resize operation completes, this value shows the average rate of the entire resize operation.

  • total_resize_data_in_mega_bytes(Option<i64>):

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

  • progress_in_mega_bytes(Option<i64>):

    While the resize operation is in progress, this value shows the current amount of data, in megabytes, that has been processed so far. When the resize operation is complete, this value shows the total amount of data, in megabytes, on the cluster, which may be more or less than TotalResizeDataInMegaBytes (the estimated total amount of data before resize).

  • elapsed_time_in_seconds(Option<i64>):

    The amount of seconds that have elapsed since the resize operation began. After the resize operation completes, this value shows the total actual time, in seconds, for the resize operation.

  • estimated_time_to_completion_in_seconds(Option<i64>):

    The estimated time remaining, in seconds, until the resize operation is complete. This value is calculated based on the average resize rate and the estimated amount of data remaining to be processed. Once the resize operation is complete, this value will be 0.

  • resize_type(Option<String>):

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

  • message(Option<String>):

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

  • target_encryption_type(Option<String>):

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

    Possible values are KMS and None.

  • data_transfer_progress_percent(Option<f64>):

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

• On failure, responds with SdkError<CancelResizeError>

impl Client

pub fn copy_cluster_snapshot(&self) -> CopyClusterSnapshotFluentBuilder

Constructs a fluent builder for the CopyClusterSnapshot operation.

• The fluent builder is configurable:
  • source_snapshot_identifier(impl Into<String>) / set_source_snapshot_identifier(Option<String>):
    required: true
    

    The identifier for the source snapshot.

    Constraints:

    • Must be the identifier for a valid automated snapshot whose state is available.

    
    
  • source_snapshot_cluster_identifier(impl Into<String>) / set_source_snapshot_cluster_identifier(Option<String>):
    required: false
    

    The identifier of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

    Constraints:

    • Must be the identifier for a valid cluster.

    
    
  • target_snapshot_identifier(impl Into<String>) / set_target_snapshot_identifier(Option<String>):
    required: true
    

    The identifier given to the new manual snapshot.

    Constraints:

    • Cannot be null, empty, or blank.

    • Must contain from 1 to 255 alphanumeric characters or hyphens.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    • Must be unique for the Amazon Web Services account that is making the request.

    
    
  • manual_snapshot_retention_period(i32) / set_manual_snapshot_retention_period(Option<i32>):
    required: false
    

    The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

    The value must be either -1 or an integer between 1 and 3,653.

    The default value is -1.

    
    
• On success, responds with CopyClusterSnapshotOutput with field(s):
  • snapshot(Option<Snapshot>):

    Describes a snapshot.

• On failure, responds with SdkError<CopyClusterSnapshotError>

impl Client

pub fn create_authentication_profile( &self, ) -> CreateAuthenticationProfileFluentBuilder

Constructs a fluent builder for the CreateAuthenticationProfile operation.

• The fluent builder is configurable:
  • authentication_profile_name(impl Into<String>) / set_authentication_profile_name(Option<String>):
    required: true
    

    The name of the authentication profile to be created.

    
    
  • authentication_profile_content(impl Into<String>) / set_authentication_profile_content(Option<String>):
    required: true
    

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

    
    
• On success, responds with CreateAuthenticationProfileOutput with field(s):
  • authentication_profile_name(Option<String>):

    The name of the authentication profile that was created.

  • authentication_profile_content(Option<String>):

    The content of the authentication profile in JSON format.

• On failure, responds with SdkError<CreateAuthenticationProfileError>

impl Client

pub fn create_cluster(&self) -> CreateClusterFluentBuilder

Constructs a fluent builder for the CreateCluster operation.

• The fluent builder is configurable:
  • db_name(impl Into<String>) / set_db_name(Option<String>):
    required: false
    

    The name of the first database to be created when the cluster is created.

    To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.

    Default: dev

    Constraints:

    • Must contain 1 to 64 alphanumeric characters.

    • Must contain only lowercase letters.

    • Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

    
    
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.

    Constraints:

    • Must contain from 1 to 63 alphanumeric characters or hyphens.

    • Alphabetic characters must be lowercase.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    • Must be unique for all clusters within an Amazon Web Services account.

    Example: myexamplecluster

    
    
  • cluster_type(impl Into<String>) / set_cluster_type(Option<String>):
    required: false
    

    The type of the cluster. When cluster type is specified as

    • single-node, the NumberOfNodes parameter is not required.

    • multi-node, the NumberOfNodes parameter is required.

    Valid Values: multi-node | single-node

    Default: multi-node

    
    
  • node_type(impl Into<String>) / set_node_type(Option<String>):
    required: true
    

    The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.

    Valid Values: dc2.large | dc2.8xlarge | ra3.large | ra3.xlplus | ra3.4xlarge | ra3.16xlarge

    
    
  • master_username(impl Into<String>) / set_master_username(Option<String>):
    required: true
    

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

    Constraints:

    • Must be 1 - 128 alphanumeric characters or hyphens. The user name can’t be PUBLIC.

    • Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

    • The first character must be a letter.

    • Must not contain a colon (:) or a slash (/).

    • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

    
    
  • master_user_password(impl Into<String>) / set_master_user_password(Option<String>):
    required: false
    

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

    You can’t use MasterUserPassword if ManageMasterPassword is true.

    Constraints:

    • Must be between 8 and 64 characters in length.

    • Must contain at least one uppercase letter.

    • Must contain at least one lowercase letter.

    • Must contain one number.

    • Can be any printable ASCII character (ASCII code 33-126) except ’ (single quote), “ (double quote), </code>, /, or @.

    

  • cluster_security_groups(impl Into<String>) / set_cluster_security_groups(Option<Vec::<String>>):
    required: false
    

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

    Default: The default cluster security group for Amazon Redshift.

    
    
  • vpc_security_group_ids(impl Into<String>) / set_vpc_security_group_ids(Option<Vec::<String>>):
    required: false
    

    A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

    Default: The default VPC security group is associated with the cluster.

    
    
  • cluster_subnet_group_name(impl Into<String>) / set_cluster_subnet_group_name(Option<String>):
    required: false
    

    The name of a cluster subnet group to be associated with this cluster.

    If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).

    
    
  • availability_zone(impl Into<String>) / set_availability_zone(Option<String>):
    required: false
    

    The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.

    Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.

    Example: us-east-2d

    Constraint: The specified Availability Zone must be in the same region as the current endpoint.

    
    
  • preferred_maintenance_window(impl Into<String>) / set_preferred_maintenance_window(Option<String>):
    required: false
    

    The weekly time range (in UTC) during which automated cluster maintenance can occur.

    Format: ddd:hh24:mi-ddd:hh24:mi

    Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.

    Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

    Constraints: Minimum 30-minute window.

    
    
  • cluster_parameter_group_name(impl Into<String>) / set_cluster_parameter_group_name(Option<String>):
    required: false
    

    The name of the parameter group to be associated with this cluster.

    Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups

    Constraints:

    • Must be 1 to 255 alphanumeric characters or hyphens.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    
    
  • automated_snapshot_retention_period(i32) / set_automated_snapshot_retention_period(Option<i32>):
    required: false
    

    The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.

    You can’t disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.

    Default: 1

    Constraints: Must be a value from 0 to 35.

    
    
  • manual_snapshot_retention_period(i32) / set_manual_snapshot_retention_period(Option<i32>):
    required: false
    

    The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn’t change the retention period of existing snapshots.

    The value must be either -1 or an integer between 1 and 3,653.

    
    
  • port(i32) / set_port(Option<i32>):
    required: false
    

    The port number on which the cluster accepts incoming connections.

    The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections.

    Default: 5439

    Valid Values:

    • For clusters with ra3 nodes - Select a port within the ranges 5431-5455 or 8191-8215. (If you have an existing cluster with ra3 nodes, it isn’t required that you change the port to these ranges.)

    • For clusters with dc2 nodes - Select a port within the range 1150-65535.

    
    
  • cluster_version(impl Into<String>) / set_cluster_version(Option<String>):
    required: false
    

    The version of the Amazon Redshift engine software that you want to deploy on the cluster.

    The version selected runs on all the nodes in the cluster.

    Constraints: Only version 1.0 is currently available.

    Example: 1.0

    
    
  • allow_version_upgrade(bool) / set_allow_version_upgrade(Option<bool>):
    required: false
    

    If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

    When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.

    Default: true

    
    
  • number_of_nodes(i32) / set_number_of_nodes(Option<i32>):
    required: false
    

    The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.

    For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.

    If you don’t specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.

    Default: 1

    Constraints: Value must be at least 1 and no more than 100.

    
    
  • publicly_accessible(bool) / set_publicly_accessible(Option<bool>):
    required: false
    

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

    Default: false

    
    
  • encrypted(bool) / set_encrypted(Option<bool>):
    required: false
    

    If true, the data in the cluster is encrypted at rest. If you set the value on this parameter to false, the request will fail.

    Default: true

    
    
  • hsm_client_certificate_identifier(impl Into<String>) / set_hsm_client_certificate_identifier(Option<String>):
    required: false
    

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

    
    
  • hsm_configuration_identifier(impl Into<String>) / set_hsm_configuration_identifier(Option<String>):
    required: false
    

    Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.

    
    
  • elastic_ip(impl Into<String>) / set_elastic_ip(Option<String>):
    required: false
    

    The Elastic IP (EIP) address for the cluster.

    Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. Don’t specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of tag instances.

    
    
  • kms_key_id(impl Into<String>) / set_kms_key_id(Option<String>):
    required: false
    

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

    
    
  • enhanced_vpc_routing(bool) / set_enhanced_vpc_routing(Option<bool>):
    required: false
    

    An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

    If this option is true, enhanced VPC routing is enabled.

    Default: false

    
    
  • additional_info(impl Into<String>) / set_additional_info(Option<String>):
    required: false
    

    Reserved.

    
    
  • iam_roles(impl Into<String>) / set_iam_roles(Option<Vec::<String>>):
    required: false
    

    A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format.

    The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.

    
    
  • maintenance_track_name(impl Into<String>) / set_maintenance_track_name(Option<String>):
    required: false
    

    An optional parameter for the name of the maintenance track for the cluster. If you don’t provide a maintenance track name, the cluster is assigned to the current track.

    
    
  • snapshot_schedule_identifier(impl Into<String>) / set_snapshot_schedule_identifier(Option<String>):
    required: false
    

    A unique identifier for the snapshot schedule.

    
    
  • availability_zone_relocation(bool) / set_availability_zone_relocation(Option<bool>):
    required: false
    

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

    
    
  • aqua_configuration_status(AquaConfigurationStatus) / set_aqua_configuration_status(Option<AquaConfigurationStatus>):
    required: false
    

    This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).

    
    
  • default_iam_role_arn(impl Into<String>) / set_default_iam_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.

    
    
  • load_sample_data(impl Into<String>) / set_load_sample_data(Option<String>):
    required: false
    

    A flag that specifies whether to load sample data once the cluster is created.

    
    
  • manage_master_password(bool) / set_manage_master_password(Option<bool>):
    required: false
    

    If true, Amazon Redshift uses Secrets Manager to manage this cluster’s admin credentials. You can’t use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account’s password.

    
    
  • master_password_secret_kms_key_id(impl Into<String>) / set_master_password_secret_kms_key_id(Option<String>):
    required: false
    

    The ID of the Key Management Service (KMS) key used to encrypt and store the cluster’s admin credentials secret. You can only use this parameter if ManageMasterPassword is true.

    
    
  • ip_address_type(impl Into<String>) / set_ip_address_type(Option<String>):
    required: false
    

    The IP address types that the cluster supports. Possible values are ipv4 and dualstack.

    
    
  • multi_az(bool) / set_multi_az(Option<bool>):
    required: false
    

    If true, Amazon Redshift will deploy the cluster in two Availability Zones (AZ).

    
    
  • redshift_idc_application_arn(impl Into<String>) / set_redshift_idc_application_arn(Option<String>):
    required: false
    

    The Amazon resource name (ARN) of the Amazon Redshift IAM Identity Center application.

    
    
• On success, responds with CreateClusterOutput with field(s):
  • cluster(Option<Cluster>):

    Describes a cluster.

• On failure, responds with SdkError<CreateClusterError>

impl Client

pub fn create_cluster_parameter_group( &self, ) -> CreateClusterParameterGroupFluentBuilder

Constructs a fluent builder for the CreateClusterParameterGroup operation.

• The fluent builder is configurable:
  • parameter_group_name(impl Into<String>) / set_parameter_group_name(Option<String>):
    required: true
    

    The name of the cluster parameter group.

    Constraints:

    • Must be 1 to 255 alphanumeric characters or hyphens

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    • Must be unique withing your Amazon Web Services account.

    This value is stored as a lower-case string.

    
    
  • parameter_group_family(impl Into<String>) / set_parameter_group_family(Option<String>):
    required: true
    

    The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.

    To get a list of valid parameter group family names, you can call DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your Amazon Web Services account, including the default parameter groups for each Amazon Redshift engine version. The parameter group family names associated with the default parameter groups provide you the valid values. For example, a valid family name is “redshift-1.0”.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: true
    

    A description of the parameter group.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of tag instances.

    
    
• On success, responds with CreateClusterParameterGroupOutput with field(s):
  • cluster_parameter_group(Option<ClusterParameterGroup>):

    Describes a parameter group.

• On failure, responds with SdkError<CreateClusterParameterGroupError>

impl Client

pub fn create_cluster_security_group( &self, ) -> CreateClusterSecurityGroupFluentBuilder

Constructs a fluent builder for the CreateClusterSecurityGroup operation.

• The fluent builder is configurable:
  • cluster_security_group_name(impl Into<String>) / set_cluster_security_group_name(Option<String>):
    required: true
    

    The name for the security group. Amazon Redshift stores the value as a lowercase string.

    Constraints:

    • Must contain no more than 255 alphanumeric characters or hyphens.

    • Must not be “Default”.

    • Must be unique for all security groups that are created by your Amazon Web Services account.

    Example: examplesecuritygroup

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: true
    

    A description for the security group.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of tag instances.

    
    
• On success, responds with CreateClusterSecurityGroupOutput with field(s):
  • cluster_security_group(Option<ClusterSecurityGroup>):

    Describes a security group.

• On failure, responds with SdkError<CreateClusterSecurityGroupError>

impl Client

pub fn create_cluster_snapshot(&self) -> CreateClusterSnapshotFluentBuilder

Constructs a fluent builder for the CreateClusterSnapshot operation.

• The fluent builder is configurable:
  • snapshot_identifier(impl Into<String>) / set_snapshot_identifier(Option<String>):
    required: true
    

    A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the Amazon Web Services account.

    Constraints:

    • Cannot be null, empty, or blank

    • Must contain from 1 to 255 alphanumeric characters or hyphens

    • First character must be a letter

    • Cannot end with a hyphen or contain two consecutive hyphens

    Example: my-snapshot-id

    
    
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    The cluster identifier for which you want a snapshot.

    
    
  • manual_snapshot_retention_period(i32) / set_manual_snapshot_retention_period(Option<i32>):
    required: false
    

    The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

    The value must be either -1 or an integer between 1 and 3,653.

    The default value is -1.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of tag instances.

    
    
• On success, responds with CreateClusterSnapshotOutput with field(s):
  • snapshot(Option<Snapshot>):

    Describes a snapshot.

• On failure, responds with SdkError<CreateClusterSnapshotError>

impl Client

pub fn create_cluster_subnet_group( &self, ) -> CreateClusterSubnetGroupFluentBuilder

Constructs a fluent builder for the CreateClusterSubnetGroup operation.

• The fluent builder is configurable:
  • cluster_subnet_group_name(impl Into<String>) / set_cluster_subnet_group_name(Option<String>):
    required: true
    

    The name for the subnet group. Amazon Redshift stores the value as a lowercase string.

    Constraints:

    • Must contain no more than 255 alphanumeric characters or hyphens.

    • Must not be “Default”.

    • Must be unique for all subnet groups that are created by your Amazon Web Services account.

    Example: examplesubnetgroup

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: true
    

    A description for the subnet group.

    
    
  • subnet_ids(impl Into<String>) / set_subnet_ids(Option<Vec::<String>>):
    required: true
    

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

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of tag instances.

    
    
• On success, responds with CreateClusterSubnetGroupOutput with field(s):
  • cluster_subnet_group(Option<ClusterSubnetGroup>):

    Describes a subnet group.

• On failure, responds with SdkError<CreateClusterSubnetGroupError>

impl Client

pub fn create_custom_domain_association( &self, ) -> CreateCustomDomainAssociationFluentBuilder

Constructs a fluent builder for the CreateCustomDomainAssociation operation.

• The fluent builder is configurable:
  • custom_domain_name(impl Into<String>) / set_custom_domain_name(Option<String>):
    required: true
    

    The custom domain name for a custom domain association.

    
    
  • custom_domain_certificate_arn(impl Into<String>) / set_custom_domain_certificate_arn(Option<String>):
    required: true
    

    The certificate Amazon Resource Name (ARN) for the custom domain name association.

    
    
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    The cluster identifier that the custom domain is associated with.

    
    
• On success, responds with CreateCustomDomainAssociationOutput with field(s):
  • custom_domain_name(Option<String>):

    The custom domain name for the association result.

  • custom_domain_certificate_arn(Option<String>):

    The Amazon Resource Name (ARN) for the certificate associated with the custom domain name.

  • cluster_identifier(Option<String>):

    The identifier of the cluster that the custom domain is associated with.

  • custom_domain_cert_expiry_time(Option<String>):

    The expiration time for the certificate for the custom domain.

• On failure, responds with SdkError<CreateCustomDomainAssociationError>

impl Client

pub fn create_endpoint_access(&self) -> CreateEndpointAccessFluentBuilder

Constructs a fluent builder for the CreateEndpointAccess operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: false
    

    The cluster identifier of the cluster to access.

    
    
  • resource_owner(impl Into<String>) / set_resource_owner(Option<String>):
    required: false
    

    The Amazon Web Services account ID of the owner of the cluster. This is only required if the cluster is in another Amazon Web Services account.

    
    
  • endpoint_name(impl Into<String>) / set_endpoint_name(Option<String>):
    required: true
    

    The Redshift-managed VPC endpoint name.

    An endpoint name must contain 1-30 characters. Valid characters are A-Z, a-z, 0-9, and hyphen(-). The first character must be a letter. The name can’t contain two consecutive hyphens or end with a hyphen.

    
    
  • subnet_group_name(impl Into<String>) / set_subnet_group_name(Option<String>):
    required: true
    

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

    
    
  • vpc_security_group_ids(impl Into<String>) / set_vpc_security_group_ids(Option<Vec::<String>>):
    required: false
    

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

    
    
• On success, responds with CreateEndpointAccessOutput with field(s):
  • cluster_identifier(Option<String>):

    The cluster identifier of the cluster associated with the endpoint.

  • resource_owner(Option<String>):

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

  • subnet_group_name(Option<String>):

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

  • endpoint_status(Option<String>):

    The status of the endpoint.

  • endpoint_name(Option<String>):

    The name of the endpoint.

  • endpoint_create_time(Option<DateTime>):

    The time (UTC) that the endpoint was created.

  • port(Option<i32>):

    The port number on which the cluster accepts incoming connections.

  • address(Option<String>):

    The DNS address of the endpoint.

  • vpc_security_groups(Option<Vec::<VpcSecurityGroupMembership>>):

    The security groups associated with the endpoint.

  • vpc_endpoint(Option<VpcEndpoint>):

    The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.

• On failure, responds with SdkError<CreateEndpointAccessError>

impl Client

pub fn create_event_subscription(&self) -> CreateEventSubscriptionFluentBuilder

Constructs a fluent builder for the CreateEventSubscription operation.

• The fluent builder is configurable:
  • subscription_name(impl Into<String>) / set_subscription_name(Option<String>):
    required: true
    

    The name of the event subscription to be created.

    Constraints:

    • Cannot be null, empty, or blank.

    • Must contain from 1 to 255 alphanumeric characters or hyphens.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    
    
  • sns_topic_arn(impl Into<String>) / set_sns_topic_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

    
    
  • source_type(impl Into<String>) / set_source_type(Option<String>):
    required: false
    

    The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your Amazon Web Services account. You must specify a source type in order to specify source IDs.

    Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.

    
    
  • source_ids(impl Into<String>) / set_source_ids(Option<Vec::<String>>):
    required: false
    

    A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.

    Example: my-cluster-1, my-cluster-2

    Example: my-snapshot-20131010

    
    
  • event_categories(impl Into<String>) / set_event_categories(Option<Vec::<String>>):
    required: false
    

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

    Values: configuration, management, monitoring, security, pending

    
    
  • severity(impl Into<String>) / set_severity(Option<String>):
    required: false
    

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

    Values: ERROR, INFO

    
    
  • enabled(bool) / set_enabled(Option<bool>):
    required: false
    

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

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of tag instances.

    
    
• On success, responds with CreateEventSubscriptionOutput with field(s):
  • event_subscription(Option<EventSubscription>):

    Describes event subscriptions.

• On failure, responds with SdkError<CreateEventSubscriptionError>

impl Client

pub fn create_hsm_client_certificate( &self, ) -> CreateHsmClientCertificateFluentBuilder

Constructs a fluent builder for the CreateHsmClientCertificate operation.

• The fluent builder is configurable:
  • hsm_client_certificate_identifier(impl Into<String>) / set_hsm_client_certificate_identifier(Option<String>):
    required: true
    

    The identifier to be assigned to the new HSM client certificate that the cluster will use to connect to the HSM to use the database encryption keys.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of tag instances.

    
    
• On success, responds with CreateHsmClientCertificateOutput with field(s):
  • hsm_client_certificate(Option<HsmClientCertificate>):

    Returns information about an HSM client certificate. The certificate is stored in a secure Hardware Storage Module (HSM), and used by the Amazon Redshift cluster to encrypt data files.

• On failure, responds with SdkError<CreateHsmClientCertificateError>

impl Client

pub fn create_hsm_configuration(&self) -> CreateHsmConfigurationFluentBuilder

Constructs a fluent builder for the CreateHsmConfiguration operation.

• The fluent builder is configurable:
  • hsm_configuration_identifier(impl Into<String>) / set_hsm_configuration_identifier(Option<String>):
    required: true
    

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

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: true
    

    A text description of the HSM configuration to be created.

    
    
  • hsm_ip_address(impl Into<String>) / set_hsm_ip_address(Option<String>):
    required: true
    

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

    
    
  • hsm_partition_name(impl Into<String>) / set_hsm_partition_name(Option<String>):
    required: true
    

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

    
    
  • hsm_partition_password(impl Into<String>) / set_hsm_partition_password(Option<String>):
    required: true
    

    The password required to access the HSM partition.

    
    
  • hsm_server_public_certificate(impl Into<String>) / set_hsm_server_public_certificate(Option<String>):
    required: true
    

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

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of tag instances.

    
    
• On success, responds with CreateHsmConfigurationOutput with field(s):
  • hsm_configuration(Option<HsmConfiguration>):

    Returns information about an HSM configuration, which is an object that describes to Amazon Redshift clusters the information they require to connect to an HSM where they can store database encryption keys.

• On failure, responds with SdkError<CreateHsmConfigurationError>

impl Client

pub fn create_integration(&self) -> CreateIntegrationFluentBuilder

Constructs a fluent builder for the CreateIntegration operation.

• The fluent builder is configurable:
  • source_arn(impl Into<String>) / set_source_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the database to use as the source for replication.

    
    
  • target_arn(impl Into<String>) / set_target_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the Amazon Redshift data warehouse to use as the target for replication.

    
    
  • integration_name(impl Into<String>) / set_integration_name(Option<String>):
    required: true
    

    The name of the integration.

    
    
  • kms_key_id(impl Into<String>) / set_kms_key_id(Option<String>):
    required: false
    

    An Key Management Service (KMS) key identifier for the key to use to encrypt the integration. If you don’t specify an encryption key, the default Amazon Web Services owned key is used.

    
    
  • tag_list(Tag) / set_tag_list(Option<Vec::<Tag>>):
    required: false
    

    A list of tags.

    
    
  • additional_encryption_context(impl Into<String>, impl Into<String>) / set_additional_encryption_context(Option<HashMap::<String, String>>):
    required: false
    

    An optional set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide.

    You can only include this parameter if you specify the KMSKeyId parameter.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the integration.

    
    
• On success, responds with CreateIntegrationOutput with field(s):
  • integration_arn(Option<String>):

    The Amazon Resource Name (ARN) of the integration.

  • integration_name(Option<String>):

    The name of the integration.

  • source_arn(Option<String>):

    The Amazon Resource Name (ARN) of the database used as the source for replication.

  • target_arn(Option<String>):

    The Amazon Resource Name (ARN) of the Amazon Redshift data warehouse to use as the target for replication.

  • status(Option<ZeroEtlIntegrationStatus>):

    The current status of the integration.

  • errors(Option<Vec::<IntegrationError>>):

    Any errors associated with the integration.

  • create_time(Option<DateTime>):

    The time (UTC) when the integration was created.

  • description(Option<String>):

    The description of the integration.

  • kms_key_id(Option<String>):

    The Key Management Service (KMS) key identifier for the key used to encrypt the integration.

  • additional_encryption_context(Option<HashMap::<String, String>>):

    The encryption context for the integration. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide.

  • tags(Option<Vec::<Tag>>):

    The list of tags associated with the integration.

• On failure, responds with SdkError<CreateIntegrationError>

impl Client

pub fn create_redshift_idc_application( &self, ) -> CreateRedshiftIdcApplicationFluentBuilder

Constructs a fluent builder for the CreateRedshiftIdcApplication operation.

• The fluent builder is configurable:
  • idc_instance_arn(impl Into<String>) / set_idc_instance_arn(Option<String>):
    required: true
    

    The Amazon resource name (ARN) of the IAM Identity Center instance where Amazon Redshift creates a new managed application.

    
    
  • redshift_idc_application_name(impl Into<String>) / set_redshift_idc_application_name(Option<String>):
    required: true
    

    The name of the Redshift application in IAM Identity Center.

    
    
  • identity_namespace(impl Into<String>) / set_identity_namespace(Option<String>):
    required: false
    

    The namespace for the Amazon Redshift IAM Identity Center application instance. It determines which managed application verifies the connection token.

    
    
  • idc_display_name(impl Into<String>) / set_idc_display_name(Option<String>):
    required: true
    

    The display name for the Amazon Redshift IAM Identity Center application instance. It appears in the console.

    
    
  • iam_role_arn(impl Into<String>) / set_iam_role_arn(Option<String>):
    required: true
    

    The IAM role ARN for the Amazon Redshift IAM Identity Center application instance. It has the required permissions to be assumed and invoke the IDC Identity Center API.

    
    
  • authorized_token_issuer_list(AuthorizedTokenIssuer) / set_authorized_token_issuer_list(Option<Vec::<AuthorizedTokenIssuer>>):
    required: false
    

    The token issuer list for the Amazon Redshift IAM Identity Center application instance.

    
    
  • service_integrations(ServiceIntegrationsUnion) / set_service_integrations(Option<Vec::<ServiceIntegrationsUnion>>):
    required: false
    

    A collection of service integrations for the Redshift IAM Identity Center application.

    
    
• On success, responds with CreateRedshiftIdcApplicationOutput with field(s):
  • redshift_idc_application(Option<RedshiftIdcApplication>):

    Contains properties for the Redshift IDC application.

• On failure, responds with SdkError<CreateRedshiftIdcApplicationError>

impl Client

pub fn create_scheduled_action(&self) -> CreateScheduledActionFluentBuilder

Constructs a fluent builder for the CreateScheduledAction operation.

• The fluent builder is configurable:
  • scheduled_action_name(impl Into<String>) / set_scheduled_action_name(Option<String>):
    required: true
    

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

    
    
  • target_action(ScheduledActionType) / set_target_action(Option<ScheduledActionType>):
    required: true
    

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

    
    
  • schedule(impl Into<String>) / set_schedule(Option<String>):
    required: true
    

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

    
    
  • iam_role(impl Into<String>) / set_iam_role(Option<String>):
    required: true
    

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

    
    
  • scheduled_action_description(impl Into<String>) / set_scheduled_action_description(Option<String>):
    required: false
    

    The description of the scheduled action.

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: false
    

    The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: false
    

    The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.

    
    
  • enable(bool) / set_enable(Option<bool>):
    required: false
    

    If true, the schedule is enabled. If false, the scheduled action does not trigger. For more information about state of the scheduled action, see ScheduledAction.

    
    
• On success, responds with CreateScheduledActionOutput with field(s):
  • scheduled_action_name(Option<String>):

    The name of the scheduled action.

  • target_action(Option<ScheduledActionType>):

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

    “{"ResizeCluster":{"NodeType":"ra3.4xlarge","ClusterIdentifier":"my-test-cluster","NumberOfNodes":3}}”.

  • schedule(Option<String>):

    The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.

    Format of at expressions is “at(yyyy-mm-ddThh:mm:ss)”. For example, “at(2016-03-04T17:27:00)”.

    Format of cron expressions is “cron(Minutes Hours Day-of-month Month Day-of-week Year)”. For example, “cron(0 10 ? * MON *)”. For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.

  • iam_role(Option<String>):

    The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide.

  • scheduled_action_description(Option<String>):

    The description of the scheduled action.

  • state(Option<ScheduledActionState>):

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

  • next_invocations(Option<Vec::<DateTime>>):

    List of times when the scheduled action will run.

  • start_time(Option<DateTime>):

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

  • end_time(Option<DateTime>):

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

• On failure, responds with SdkError<CreateScheduledActionError>

impl Client

pub fn create_snapshot_copy_grant(&self) -> CreateSnapshotCopyGrantFluentBuilder

Constructs a fluent builder for the CreateSnapshotCopyGrant operation.

• The fluent builder is configurable:
  • snapshot_copy_grant_name(impl Into<String>) / set_snapshot_copy_grant_name(Option<String>):
    required: true
    

    The name of the snapshot copy grant. This name must be unique in the region for the Amazon Web Services account.

    Constraints:

    • Must contain from 1 to 63 alphanumeric characters or hyphens.

    • Alphabetic characters must be lowercase.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    • Must be unique for all clusters within an Amazon Web Services account.

    
    
  • kms_key_id(impl Into<String>) / set_kms_key_id(Option<String>):
    required: false
    

    The unique identifier of the encrypted symmetric key to which to grant Amazon Redshift permission. If no key is specified, the default key is used.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of tag instances.

    
    
• On success, responds with CreateSnapshotCopyGrantOutput with field(s):
  • snapshot_copy_grant(Option<SnapshotCopyGrant>):

    The snapshot copy grant that grants Amazon Redshift permission to encrypt copied snapshots with the specified encrypted symmetric key from Amazon Web Services KMS 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.

• On failure, responds with SdkError<CreateSnapshotCopyGrantError>

impl Client

pub fn create_snapshot_schedule(&self) -> CreateSnapshotScheduleFluentBuilder

Constructs a fluent builder for the CreateSnapshotSchedule operation.

• The fluent builder is configurable:
  • schedule_definitions(impl Into<String>) / set_schedule_definitions(Option<Vec::<String>>):
    required: false
    

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

    
    
  • schedule_identifier(impl Into<String>) / set_schedule_identifier(Option<String>):
    required: false
    

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

    
    
  • schedule_description(impl Into<String>) / set_schedule_description(Option<String>):
    required: false
    

    The description of the snapshot schedule.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

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

    
    
  • dry_run(bool) / set_dry_run(Option<bool>):
    required: false
    
    
    
  • next_invocations(i32) / set_next_invocations(Option<i32>):
    required: false
    
    
    
• On success, responds with CreateSnapshotScheduleOutput with field(s):
  • schedule_definitions(Option<Vec::<String>>):

    A list of ScheduleDefinitions.

  • schedule_identifier(Option<String>):

    A unique identifier for the schedule.

  • schedule_description(Option<String>):

    The description of the schedule.

  • tags(Option<Vec::<Tag>>):

    An optional set of tags describing the schedule.

  • next_invocations(Option<Vec::<DateTime>>):

  • associated_cluster_count(Option<i32>):

    The number of clusters associated with the schedule.

  • associated_clusters(Option<Vec::<ClusterAssociatedToSchedule>>):

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

• On failure, responds with SdkError<CreateSnapshotScheduleError>

impl Client

pub fn create_tags(&self) -> CreateTagsFluentBuilder

Constructs a fluent builder for the CreateTags operation.

• The fluent builder is configurable:
  • resource_name(impl Into<String>) / set_resource_name(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) to which you want to add the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    One or more name/value pairs to add as tags to the specified resource. Each tag name is passed in with the parameter Key and the corresponding value is passed in with the parameter Value. The Key and Value parameters are separated by a comma (,). Separate multiple tags with a space. For example, –tags “Key”=“owner”,“Value”=“admin” “Key”=“environment”,“Value”=“test” “Key”=“version”,“Value”=“1.0”.

    
    
• On success, responds with CreateTagsOutput
• On failure, responds with SdkError<CreateTagsError>

impl Client

pub fn create_usage_limit(&self) -> CreateUsageLimitFluentBuilder

Constructs a fluent builder for the CreateUsageLimit operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

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

    
    
  • feature_type(UsageLimitFeatureType) / set_feature_type(Option<UsageLimitFeatureType>):
    required: true
    

    The Amazon Redshift feature that you want to limit.

    
    
  • limit_type(UsageLimitLimitType) / set_limit_type(Option<UsageLimitLimitType>):
    required: true
    

    The type of limit. Depending on the feature type, this can be based on a time duration or data size. If FeatureType is spectrum, then LimitType must be data-scanned. If FeatureType is concurrency-scaling, then LimitType must be time. If FeatureType is cross-region-datasharing, then LimitType must be data-scanned.

    
    
  • amount(i64) / set_amount(Option<i64>):
    required: true
    

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

    
    
  • period(UsageLimitPeriod) / set_period(Option<UsageLimitPeriod>):
    required: false
    

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

    
    
  • breach_action(UsageLimitBreachAction) / set_breach_action(Option<UsageLimitBreachAction>):
    required: false
    

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

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of tag instances.

    
    
• On success, responds with CreateUsageLimitOutput with field(s):
  • usage_limit_id(Option<String>):

    The identifier of the usage limit.

  • cluster_identifier(Option<String>):

    The identifier of the cluster with a usage limit.

  • feature_type(Option<UsageLimitFeatureType>):

    The Amazon Redshift feature to which the limit applies.

  • limit_type(Option<UsageLimitLimitType>):

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

  • amount(Option<i64>):

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

  • period(Option<UsageLimitPeriod>):

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

  • breach_action(Option<UsageLimitBreachAction>):

    The action that Amazon Redshift takes when the limit is reached. Possible values are:

    • log - To log an event in a system table. The default is log.

    • emit-metric - To emit CloudWatch metrics.

    • disable - To disable the feature until the next usage period begins.

  • tags(Option<Vec::<Tag>>):

    A list of tag instances.

• On failure, responds with SdkError<CreateUsageLimitError>

impl Client

pub fn deauthorize_data_share(&self) -> DeauthorizeDataShareFluentBuilder

Constructs a fluent builder for the DeauthorizeDataShare operation.

• The fluent builder is configurable:
  • data_share_arn(impl Into<String>) / set_data_share_arn(Option<String>):
    required: true
    

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

    
    
  • consumer_identifier(impl Into<String>) / set_consumer_identifier(Option<String>):
    required: true
    

    The identifier of the data consumer that is to have authorization removed from the datashare. This identifier is an Amazon Web Services account ID or a keyword, such as ADX.

    
    
• On success, responds with DeauthorizeDataShareOutput with field(s):
  • data_share_arn(Option<String>):

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

  • producer_arn(Option<String>):

    The Amazon Resource Name (ARN) of the producer namespace.

  • allow_publicly_accessible_consumers(Option<bool>):

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

  • data_share_associations(Option<Vec::<DataShareAssociation>>):

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

  • managed_by(Option<String>):

    The identifier of a datashare to show its managing entity.

  • data_share_type(Option<DataShareType>):

    The type of the datashare created by RegisterNamespace.

• On failure, responds with SdkError<DeauthorizeDataShareError>

impl Client

pub fn delete_authentication_profile( &self, ) -> DeleteAuthenticationProfileFluentBuilder

Constructs a fluent builder for the DeleteAuthenticationProfile operation.

• The fluent builder is configurable:
  • authentication_profile_name(impl Into<String>) / set_authentication_profile_name(Option<String>):
    required: true
    

    The name of the authentication profile to delete.

    
    
• On success, responds with DeleteAuthenticationProfileOutput with field(s):
  • authentication_profile_name(Option<String>):

    The name of the authentication profile that was deleted.

• On failure, responds with SdkError<DeleteAuthenticationProfileError>

impl Client

pub fn delete_cluster(&self) -> DeleteClusterFluentBuilder

Constructs a fluent builder for the DeleteCluster operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    The identifier of the cluster to be deleted.

    Constraints:

    • Must contain lowercase characters.

    • Must contain from 1 to 63 alphanumeric characters or hyphens.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    
    
  • skip_final_cluster_snapshot(bool) / set_skip_final_cluster_snapshot(Option<bool>):
    required: false
    

    Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted.

    The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false.

    Default: false

    
    
  • final_cluster_snapshot_identifier(impl Into<String>) / set_final_cluster_snapshot_identifier(Option<String>):
    required: false
    

    The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.

    Constraints:

    • Must be 1 to 255 alphanumeric characters.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    
    
  • final_cluster_snapshot_retention_period(i32) / set_final_cluster_snapshot_retention_period(Option<i32>):
    required: false
    

    The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

    The value must be either -1 or an integer between 1 and 3,653.

    The default value is -1.

    
    
• On success, responds with DeleteClusterOutput with field(s):
  • cluster(Option<Cluster>):

    Describes a cluster.

• On failure, responds with SdkError<DeleteClusterError>

impl Client

pub fn delete_cluster_parameter_group( &self, ) -> DeleteClusterParameterGroupFluentBuilder

Constructs a fluent builder for the DeleteClusterParameterGroup operation.

• The fluent builder is configurable:
  • parameter_group_name(impl Into<String>) / set_parameter_group_name(Option<String>):
    required: true
    

    The name of the parameter group to be deleted.

    Constraints:

    • Must be the name of an existing cluster parameter group.

    • Cannot delete a default cluster parameter group.

    
    
• On success, responds with DeleteClusterParameterGroupOutput
• On failure, responds with SdkError<DeleteClusterParameterGroupError>

impl Client

pub fn delete_cluster_security_group( &self, ) -> DeleteClusterSecurityGroupFluentBuilder

Constructs a fluent builder for the DeleteClusterSecurityGroup operation.

• The fluent builder is configurable:
  • cluster_security_group_name(impl Into<String>) / set_cluster_security_group_name(Option<String>):
    required: true
    

    The name of the cluster security group to be deleted.

    
    
• On success, responds with DeleteClusterSecurityGroupOutput
• On failure, responds with SdkError<DeleteClusterSecurityGroupError>

impl Client

pub fn delete_cluster_snapshot(&self) -> DeleteClusterSnapshotFluentBuilder

Constructs a fluent builder for the DeleteClusterSnapshot operation.

• The fluent builder is configurable:
  • snapshot_identifier(impl Into<String>) / set_snapshot_identifier(Option<String>):
    required: true
    

    The unique identifier of the manual snapshot to be deleted.

    Constraints: Must be the name of an existing snapshot that is in the available, failed, or cancelled state.

    
    
  • snapshot_cluster_identifier(impl Into<String>) / set_snapshot_cluster_identifier(Option<String>):
    required: false
    

    The unique identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

    Constraints: Must be the name of valid cluster.

    
    
• On success, responds with DeleteClusterSnapshotOutput with field(s):
  • snapshot(Option<Snapshot>):

    Describes a snapshot.

• On failure, responds with SdkError<DeleteClusterSnapshotError>

impl Client

pub fn delete_cluster_subnet_group( &self, ) -> DeleteClusterSubnetGroupFluentBuilder

Constructs a fluent builder for the DeleteClusterSubnetGroup operation.

• The fluent builder is configurable:
  • cluster_subnet_group_name(impl Into<String>) / set_cluster_subnet_group_name(Option<String>):
    required: true
    

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

    
    
• On success, responds with DeleteClusterSubnetGroupOutput
• On failure, responds with SdkError<DeleteClusterSubnetGroupError>

impl Client

pub fn delete_custom_domain_association( &self, ) -> DeleteCustomDomainAssociationFluentBuilder

Constructs a fluent builder for the DeleteCustomDomainAssociation operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    The identifier of the cluster to delete a custom domain association for.

    
    
  • custom_domain_name(impl Into<String>) / set_custom_domain_name(Option<String>):
    required: true
    

    The custom domain name for the custom domain association.

    
    
• On success, responds with DeleteCustomDomainAssociationOutput
• On failure, responds with SdkError<DeleteCustomDomainAssociationError>

impl Client

pub fn delete_endpoint_access(&self) -> DeleteEndpointAccessFluentBuilder

Constructs a fluent builder for the DeleteEndpointAccess operation.

• The fluent builder is configurable:
  • endpoint_name(impl Into<String>) / set_endpoint_name(Option<String>):
    required: true
    

    The Redshift-managed VPC endpoint to delete.

    
    
• On success, responds with DeleteEndpointAccessOutput with field(s):
  • cluster_identifier(Option<String>):

    The cluster identifier of the cluster associated with the endpoint.

  • resource_owner(Option<String>):

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

  • subnet_group_name(Option<String>):

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

  • endpoint_status(Option<String>):

    The status of the endpoint.

  • endpoint_name(Option<String>):

    The name of the endpoint.

  • endpoint_create_time(Option<DateTime>):

    The time (UTC) that the endpoint was created.

  • port(Option<i32>):

    The port number on which the cluster accepts incoming connections.

  • address(Option<String>):

    The DNS address of the endpoint.

  • vpc_security_groups(Option<Vec::<VpcSecurityGroupMembership>>):

    The security groups associated with the endpoint.

  • vpc_endpoint(Option<VpcEndpoint>):

    The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.

• On failure, responds with SdkError<DeleteEndpointAccessError>

impl Client

pub fn delete_event_subscription(&self) -> DeleteEventSubscriptionFluentBuilder

Constructs a fluent builder for the DeleteEventSubscription operation.

• The fluent builder is configurable:
  • subscription_name(impl Into<String>) / set_subscription_name(Option<String>):
    required: true
    

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

    
    
• On success, responds with DeleteEventSubscriptionOutput
• On failure, responds with SdkError<DeleteEventSubscriptionError>

impl Client

pub fn delete_hsm_client_certificate( &self, ) -> DeleteHsmClientCertificateFluentBuilder

Constructs a fluent builder for the DeleteHsmClientCertificate operation.

• The fluent builder is configurable:
  • hsm_client_certificate_identifier(impl Into<String>) / set_hsm_client_certificate_identifier(Option<String>):
    required: true
    

    The identifier of the HSM client certificate to be deleted.

    
    
• On success, responds with DeleteHsmClientCertificateOutput
• On failure, responds with SdkError<DeleteHsmClientCertificateError>

impl Client

pub fn delete_hsm_configuration(&self) -> DeleteHsmConfigurationFluentBuilder

Constructs a fluent builder for the DeleteHsmConfiguration operation.

• The fluent builder is configurable:
  • hsm_configuration_identifier(impl Into<String>) / set_hsm_configuration_identifier(Option<String>):
    required: true
    

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

    
    
• On success, responds with DeleteHsmConfigurationOutput
• On failure, responds with SdkError<DeleteHsmConfigurationError>

impl Client

pub fn delete_integration(&self) -> DeleteIntegrationFluentBuilder

Constructs a fluent builder for the DeleteIntegration operation.

• The fluent builder is configurable:
  • integration_arn(impl Into<String>) / set_integration_arn(Option<String>):
    required: true
    

    The unique identifier of the integration to delete.

    
    
• On success, responds with DeleteIntegrationOutput with field(s):
  • integration_arn(Option<String>):

    The Amazon Resource Name (ARN) of the integration.

  • integration_name(Option<String>):

    The name of the integration.

  • source_arn(Option<String>):

    The Amazon Resource Name (ARN) of the database used as the source for replication.

  • target_arn(Option<String>):

    The Amazon Resource Name (ARN) of the Amazon Redshift data warehouse to use as the target for replication.

  • status(Option<ZeroEtlIntegrationStatus>):

    The current status of the integration.

  • errors(Option<Vec::<IntegrationError>>):

    Any errors associated with the integration.

  • create_time(Option<DateTime>):

    The time (UTC) when the integration was created.

  • description(Option<String>):

    The description of the integration.

  • kms_key_id(Option<String>):

    The Key Management Service (KMS) key identifier for the key used to encrypt the integration.

  • additional_encryption_context(Option<HashMap::<String, String>>):

    The encryption context for the integration. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide.

  • tags(Option<Vec::<Tag>>):

    The list of tags associated with the integration.

• On failure, responds with SdkError<DeleteIntegrationError>

impl Client

pub fn delete_partner(&self) -> DeletePartnerFluentBuilder

Constructs a fluent builder for the DeletePartner operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID that owns the cluster.

    
    
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

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

    
    
  • database_name(impl Into<String>) / set_database_name(Option<String>):
    required: true
    

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

    
    
  • partner_name(impl Into<String>) / set_partner_name(Option<String>):
    required: true
    

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

    
    
• On success, responds with DeletePartnerOutput with field(s):
  • database_name(Option<String>):

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

  • partner_name(Option<String>):

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

• On failure, responds with SdkError<DeletePartnerError>

impl Client

pub fn delete_redshift_idc_application( &self, ) -> DeleteRedshiftIdcApplicationFluentBuilder

Constructs a fluent builder for the DeleteRedshiftIdcApplication operation.

• The fluent builder is configurable:
  • redshift_idc_application_arn(impl Into<String>) / set_redshift_idc_application_arn(Option<String>):
    required: true
    

    The ARN for a deleted Amazon Redshift IAM Identity Center application.

    
    
• On success, responds with DeleteRedshiftIdcApplicationOutput
• On failure, responds with SdkError<DeleteRedshiftIdcApplicationError>

impl Client

pub fn delete_resource_policy(&self) -> DeleteResourcePolicyFluentBuilder

Constructs a fluent builder for the DeleteResourcePolicy operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource of which its resource policy is deleted.

    
    
• On success, responds with DeleteResourcePolicyOutput
• On failure, responds with SdkError<DeleteResourcePolicyError>

impl Client

pub fn delete_scheduled_action(&self) -> DeleteScheduledActionFluentBuilder

Constructs a fluent builder for the DeleteScheduledAction operation.

• The fluent builder is configurable:
  • scheduled_action_name(impl Into<String>) / set_scheduled_action_name(Option<String>):
    required: true
    

    The name of the scheduled action to delete.

    
    
• On success, responds with DeleteScheduledActionOutput
• On failure, responds with SdkError<DeleteScheduledActionError>

impl Client

pub fn delete_snapshot_copy_grant(&self) -> DeleteSnapshotCopyGrantFluentBuilder

Constructs a fluent builder for the DeleteSnapshotCopyGrant operation.

• The fluent builder is configurable:
  • snapshot_copy_grant_name(impl Into<String>) / set_snapshot_copy_grant_name(Option<String>):
    required: true
    

    The name of the snapshot copy grant to delete.

    
    
• On success, responds with DeleteSnapshotCopyGrantOutput
• On failure, responds with SdkError<DeleteSnapshotCopyGrantError>

impl Client

pub fn delete_snapshot_schedule(&self) -> DeleteSnapshotScheduleFluentBuilder

Constructs a fluent builder for the DeleteSnapshotSchedule operation.

• The fluent builder is configurable:
  • schedule_identifier(impl Into<String>) / set_schedule_identifier(Option<String>):
    required: true
    

    A unique identifier of the snapshot schedule to delete.

    
    
• On success, responds with DeleteSnapshotScheduleOutput
• On failure, responds with SdkError<DeleteSnapshotScheduleError>

impl Client

pub fn delete_tags(&self) -> DeleteTagsFluentBuilder

Constructs a fluent builder for the DeleteTags operation.

• The fluent builder is configurable:
  • resource_name(impl Into<String>) / set_resource_name(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) from which you want to remove the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The tag key that you want to delete.

    
    
• On success, responds with DeleteTagsOutput
• On failure, responds with SdkError<DeleteTagsError>

impl Client

pub fn delete_usage_limit(&self) -> DeleteUsageLimitFluentBuilder

Constructs a fluent builder for the DeleteUsageLimit operation.

• The fluent builder is configurable:
  • usage_limit_id(impl Into<String>) / set_usage_limit_id(Option<String>):
    required: true
    

    The identifier of the usage limit to delete.

    
    
• On success, responds with DeleteUsageLimitOutput
• On failure, responds with SdkError<DeleteUsageLimitError>

impl Client

pub fn deregister_namespace(&self) -> DeregisterNamespaceFluentBuilder

Constructs a fluent builder for the DeregisterNamespace operation.

• The fluent builder is configurable:
  • namespace_identifier(NamespaceIdentifierUnion) / set_namespace_identifier(Option<NamespaceIdentifierUnion>):
    required: true
    

    The unique identifier of the cluster or serverless namespace that you want to deregister.

    
    
  • consumer_identifiers(impl Into<String>) / set_consumer_identifiers(Option<Vec::<String>>):
    required: true
    

    An array containing the ID of the consumer account that you want to deregister the cluster or serverless namespace from.

    
    
• On success, responds with DeregisterNamespaceOutput with field(s):
  • status(Option<NamespaceRegistrationStatus>):

    The registration status of the cluster or serverless namespace.

• On failure, responds with SdkError<DeregisterNamespaceError>

impl Client

pub fn describe_account_attributes( &self, ) -> DescribeAccountAttributesFluentBuilder

Constructs a fluent builder for the DescribeAccountAttributes operation.

• The fluent builder is configurable:
  • attribute_names(impl Into<String>) / set_attribute_names(Option<Vec::<String>>):
    required: false
    

    A list of attribute names.

    
    
• On success, responds with DescribeAccountAttributesOutput with field(s):
  • account_attributes(Option<Vec::<AccountAttribute>>):

    A list of attributes assigned to an account.

• On failure, responds with SdkError<DescribeAccountAttributesError>

impl Client

pub fn describe_authentication_profiles( &self, ) -> DescribeAuthenticationProfilesFluentBuilder

Constructs a fluent builder for the DescribeAuthenticationProfiles operation.

• The fluent builder is configurable:
  • authentication_profile_name(impl Into<String>) / set_authentication_profile_name(Option<String>):
    required: false
    

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

    
    
• On success, responds with DescribeAuthenticationProfilesOutput with field(s):
  • authentication_profiles(Option<Vec::<AuthenticationProfile>>):

    The list of authentication profiles.

• On failure, responds with SdkError<DescribeAuthenticationProfilesError>

impl Client

pub fn describe_cluster_db_revisions( &self, ) -> DescribeClusterDbRevisionsFluentBuilder

Constructs a fluent builder for the DescribeClusterDbRevisions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: false
    

    A unique identifier for a cluster whose ClusterDbRevisions you are requesting. This parameter is case sensitive. All clusters defined for an account are returned by default.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.

    Default: 100

    Constraints: minimum 20, maximum 100.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional parameter that specifies the starting point for returning a set of response records. When the results of a DescribeClusterDbRevisions request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.

    Constraints: You can specify either the ClusterIdentifier parameter, or the marker parameter, but not both.

    
    
• On success, responds with DescribeClusterDbRevisionsOutput with field(s):
  • marker(Option<String>):

    A string representing the starting point for the next set of revisions. If a value is returned in a response, you can retrieve the next set of revisions by providing the value in the marker parameter and retrying the command. If the marker field is empty, all revisions have already been returned.

  • cluster_db_revisions(Option<Vec::<ClusterDbRevision>>):

    A list of revisions.

• On failure, responds with SdkError<DescribeClusterDbRevisionsError>

impl Client

pub fn describe_cluster_parameter_groups( &self, ) -> DescribeClusterParameterGroupsFluentBuilder

Constructs a fluent builder for the DescribeClusterParameterGroups operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • parameter_group_name(impl Into<String>) / set_parameter_group_name(Option<String>):
    required: false
    

    The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: false
    

    A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.

    
    
  • tag_values(impl Into<String>) / set_tag_values(Option<Vec::<String>>):
    required: false
    

    A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.

    
    
• On success, responds with DescribeClusterParameterGroupsOutput with field(s):
  • marker(Option<String>):

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

  • parameter_groups(Option<Vec::<ClusterParameterGroup>>):

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

• On failure, responds with SdkError<DescribeClusterParameterGroupsError>

impl Client

pub fn describe_cluster_parameters( &self, ) -> DescribeClusterParametersFluentBuilder

Constructs a fluent builder for the DescribeClusterParameters operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • parameter_group_name(impl Into<String>) / set_parameter_group_name(Option<String>):
    required: true
    

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

    
    
  • source(impl Into<String>) / set_source(Option<String>):
    required: false
    

    The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.

    Default: All parameter types returned.

    Valid Values: user | engine-default

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    
    
• On success, responds with DescribeClusterParametersOutput with field(s):
  • parameters(Option<Vec::<Parameter>>):

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

  • marker(Option<String>):

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

• On failure, responds with SdkError<DescribeClusterParametersError>

impl Client

pub fn describe_cluster_security_groups( &self, ) -> DescribeClusterSecurityGroupsFluentBuilder

Constructs a fluent builder for the DescribeClusterSecurityGroups operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • cluster_security_group_name(impl Into<String>) / set_cluster_security_group_name(Option<String>):
    required: false
    

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

    Example: securitygroup1

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSecurityGroups request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    Constraints: You must specify either the ClusterSecurityGroupName parameter or the Marker parameter, but not both.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: false
    

    A tag key or keys for which you want to return all matching cluster security groups that are associated with the specified key or keys. For example, suppose that you have security groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag keys associated with them.

    
    
  • tag_values(impl Into<String>) / set_tag_values(Option<Vec::<String>>):
    required: false
    

    A tag value or values for which you want to return all matching cluster security groups that are associated with the specified tag value or values. For example, suppose that you have security groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag values associated with them.

    
    
• On success, responds with DescribeClusterSecurityGroupsOutput with field(s):
  • marker(Option<String>):

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

  • cluster_security_groups(Option<Vec::<ClusterSecurityGroup>>):

    A list of ClusterSecurityGroup instances.

• On failure, responds with SdkError<DescribeClusterSecurityGroupsError>

impl Client

pub fn describe_cluster_snapshots( &self, ) -> DescribeClusterSnapshotsFluentBuilder

Constructs a fluent builder for the DescribeClusterSnapshots operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: false
    

    The identifier of the cluster which generated the requested snapshots.

    
    
  • snapshot_identifier(impl Into<String>) / set_snapshot_identifier(Option<String>):
    required: false
    

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

    
    
  • snapshot_arn(impl Into<String>) / set_snapshot_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the snapshot associated with the message to describe cluster snapshots.

    
    
  • snapshot_type(impl Into<String>) / set_snapshot_type(Option<String>):
    required: false
    

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

    Valid Values: automated | manual

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: false
    

    A value that requests only snapshots created at or after the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

    Example: 2012-07-16T18:00:00Z

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: false
    

    A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

    Example: 2012-07-16T18:00:00Z

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSnapshots request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    
    
  • owner_account(impl Into<String>) / set_owner_account(Option<String>):
    required: false
    

    The Amazon Web Services account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your Amazon Web Services account, or do not specify the parameter.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: false
    

    A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys. For example, suppose that you have snapshots that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag keys associated with them.

    
    
  • tag_values(impl Into<String>) / set_tag_values(Option<Vec::<String>>):
    required: false
    

    A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values. For example, suppose that you have snapshots that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag values associated with them.

    
    
  • cluster_exists(bool) / set_cluster_exists(Option<bool>):
    required: false
    

    A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:

    • If ClusterExists is set to true, ClusterIdentifier is required.

    • If ClusterExists is set to false and ClusterIdentifier isn’t specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.

    • If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.

    • If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.

    
    
  • sorting_entities(SnapshotSortingEntity) / set_sorting_entities(Option<Vec::<SnapshotSortingEntity>>):
    required: false
    
    
    
• On success, responds with DescribeClusterSnapshotsOutput with field(s):
  • marker(Option<String>):

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

  • snapshots(Option<Vec::<Snapshot>>):

    A list of Snapshot instances.

• On failure, responds with SdkError<DescribeClusterSnapshotsError>

impl Client

pub fn describe_cluster_subnet_groups( &self, ) -> DescribeClusterSubnetGroupsFluentBuilder

Constructs a fluent builder for the DescribeClusterSubnetGroups operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • cluster_subnet_group_name(impl Into<String>) / set_cluster_subnet_group_name(Option<String>):
    required: false
    

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

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSubnetGroups request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: false
    

    A tag key or keys for which you want to return all matching cluster subnet groups that are associated with the specified key or keys. For example, suppose that you have subnet groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag keys associated with them.

    
    
  • tag_values(impl Into<String>) / set_tag_values(Option<Vec::<String>>):
    required: false
    

    A tag value or values for which you want to return all matching cluster subnet groups that are associated with the specified tag value or values. For example, suppose that you have subnet groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag values associated with them.

    
    
• On success, responds with DescribeClusterSubnetGroupsOutput with field(s):
  • marker(Option<String>):

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

  • cluster_subnet_groups(Option<Vec::<ClusterSubnetGroup>>):

    A list of ClusterSubnetGroup instances.

• On failure, responds with SdkError<DescribeClusterSubnetGroupsError>

impl Client

pub fn describe_cluster_tracks(&self) -> DescribeClusterTracksFluentBuilder

Constructs a fluent builder for the DescribeClusterTracks operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • maintenance_track_name(impl Into<String>) / set_maintenance_track_name(Option<String>):
    required: false
    

    The name of the maintenance track.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

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

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterTracks request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    
    
• On success, responds with DescribeClusterTracksOutput with field(s):
  • maintenance_tracks(Option<Vec::<MaintenanceTrack>>):

    A list of maintenance tracks output by the DescribeClusterTracks operation.

  • marker(Option<String>):

    The starting point to return a set of response tracklist records. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

• On failure, responds with SdkError<DescribeClusterTracksError>

impl Client

pub fn describe_cluster_versions(&self) -> DescribeClusterVersionsFluentBuilder

Constructs a fluent builder for the DescribeClusterVersions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • cluster_version(impl Into<String>) / set_cluster_version(Option<String>):
    required: false
    

    The specific cluster version to return.

    Example: 1.0

    
    
  • cluster_parameter_group_family(impl Into<String>) / set_cluster_parameter_group_family(Option<String>):
    required: false
    

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

    Constraints:

    • Must be 1 to 255 alphanumeric characters

    • First character must be a letter

    • Cannot end with a hyphen or contain two consecutive hyphens

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterVersions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    
    
• On success, responds with DescribeClusterVersionsOutput with field(s):
  • marker(Option<String>):

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

  • cluster_versions(Option<Vec::<ClusterVersion>>):

    A list of Version elements.

• On failure, responds with SdkError<DescribeClusterVersionsError>

impl Client

pub fn describe_clusters(&self) -> DescribeClustersFluentBuilder

Constructs a fluent builder for the DescribeClusters operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: false
    

    The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.

    The default is that all clusters defined for an account are returned.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: false
    

    A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.

    
    
  • tag_values(impl Into<String>) / set_tag_values(Option<Vec::<String>>):
    required: false
    

    A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

    
    
• On success, responds with DescribeClustersOutput with field(s):
  • marker(Option<String>):

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

  • clusters(Option<Vec::<Cluster>>):

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

• On failure, responds with SdkError<DescribeClustersError>

impl Client

pub fn describe_custom_domain_associations( &self, ) -> DescribeCustomDomainAssociationsFluentBuilder

Constructs a fluent builder for the DescribeCustomDomainAssociations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • custom_domain_name(impl Into<String>) / set_custom_domain_name(Option<String>):
    required: false
    

    The custom domain name for the custom domain association.

    
    
  • custom_domain_certificate_arn(impl Into<String>) / set_custom_domain_certificate_arn(Option<String>):
    required: false
    

    The certificate Amazon Resource Name (ARN) for the custom domain association.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum records setting for the associated custom domain.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    The marker for the custom domain association.

    
    
• On success, responds with DescribeCustomDomainAssociationsOutput with field(s):
  • marker(Option<String>):

    The marker for the custom domain association.

  • associations(Option<Vec::<Association>>):

    The associations for the custom domain.

• On failure, responds with SdkError<DescribeCustomDomainAssociationsError>

impl Client

pub fn describe_data_shares(&self) -> DescribeDataSharesFluentBuilder

Constructs a fluent builder for the DescribeDataShares operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • data_share_arn(impl Into<String>) / set_data_share_arn(Option<String>):
    required: false
    

    The Amazon resource name (ARN) of the datashare to describe details of.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataShares request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    
    
• On success, responds with DescribeDataSharesOutput with field(s):
  • data_shares(Option<Vec::<DataShare>>):

    The results returned from describing datashares.

  • marker(Option<String>):

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataShares request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

• On failure, responds with SdkError<DescribeDataSharesError>

impl Client

pub fn describe_data_shares_for_consumer( &self, ) -> DescribeDataSharesForConsumerFluentBuilder

Constructs a fluent builder for the DescribeDataSharesForConsumer operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • consumer_arn(impl Into<String>) / set_consumer_arn(Option<String>):
    required: false
    

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

    
    
  • status(DataShareStatusForConsumer) / set_status(Option<DataShareStatusForConsumer>):
    required: false
    

    An identifier giving the status of a datashare in the consumer cluster. If this field is specified, Amazon Redshift returns the list of datashares that have the specified status.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForConsumer request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    
    
• On success, responds with DescribeDataSharesForConsumerOutput with field(s):
  • data_shares(Option<Vec::<DataShare>>):

    Shows the results of datashares available for consumers.

  • marker(Option<String>):

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForConsumer request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

• On failure, responds with SdkError<DescribeDataSharesForConsumerError>

impl Client

pub fn describe_data_shares_for_producer( &self, ) -> DescribeDataSharesForProducerFluentBuilder

Constructs a fluent builder for the DescribeDataSharesForProducer operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • producer_arn(impl Into<String>) / set_producer_arn(Option<String>):
    required: false
    

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

    
    
  • status(DataShareStatusForProducer) / set_status(Option<DataShareStatusForProducer>):
    required: false
    

    An identifier giving the status of a datashare in the producer. If this field is specified, Amazon Redshift returns the list of datashares that have the specified status.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForProducer request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    
    
• On success, responds with DescribeDataSharesForProducerOutput with field(s):
  • data_shares(Option<Vec::<DataShare>>):

    Shows the results of datashares available for producers.

  • marker(Option<String>):

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForProducer request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

• On failure, responds with SdkError<DescribeDataSharesForProducerError>

impl Client

pub fn describe_default_cluster_parameters( &self, ) -> DescribeDefaultClusterParametersFluentBuilder

Constructs a fluent builder for the DescribeDefaultClusterParameters operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • parameter_group_family(impl Into<String>) / set_parameter_group_family(Option<String>):
    required: true
    

    The name of the cluster parameter group family.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDefaultClusterParameters request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    
    
• On success, responds with DescribeDefaultClusterParametersOutput with field(s):
  • default_cluster_parameters(Option<DefaultClusterParameters>):

    Describes the default cluster parameters for a parameter group family.

• On failure, responds with SdkError<DescribeDefaultClusterParametersError>

impl Client

pub fn describe_endpoint_access(&self) -> DescribeEndpointAccessFluentBuilder

Constructs a fluent builder for the DescribeEndpointAccess operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: false
    

    The cluster identifier associated with the described endpoint.

    
    
  • resource_owner(impl Into<String>) / set_resource_owner(Option<String>):
    required: false
    

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

    
    
  • endpoint_name(impl Into<String>) / set_endpoint_name(Option<String>):
    required: false
    

    The name of the endpoint to be described.

    
    
  • vpc_id(impl Into<String>) / set_vpc_id(Option<String>):
    required: false
    

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

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a Marker is included in the response so that the remaining results can be retrieved.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional pagination token provided by a previous DescribeEndpointAccess request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

    
    
• On success, responds with DescribeEndpointAccessOutput with field(s):
  • endpoint_access_list(Option<Vec::<EndpointAccess>>):

    The list of endpoints with access to the cluster.

  • marker(Option<String>):

    An optional pagination token provided by a previous DescribeEndpointAccess request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

• On failure, responds with SdkError<DescribeEndpointAccessError>

impl Client

pub fn describe_endpoint_authorization( &self, ) -> DescribeEndpointAuthorizationFluentBuilder

Constructs a fluent builder for the DescribeEndpointAuthorization operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: false
    

    The cluster identifier of the cluster to access.

    
    
  • account(impl Into<String>) / set_account(Option<String>):
    required: false
    

    The Amazon Web Services account ID of either the cluster owner (grantor) or grantee. If Grantee parameter is true, then the Account value is of the grantor.

    
    
  • grantee(bool) / set_grantee(Option<bool>):
    required: false
    

    Indicates whether to check authorization from a grantor or grantee point of view. If true, Amazon Redshift returns endpoint authorizations that you’ve been granted. If false (default), checks authorization from a grantor point of view.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a Marker is included in the response so that the remaining results can be retrieved.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional pagination token provided by a previous DescribeEndpointAuthorization request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

    
    
• On success, responds with DescribeEndpointAuthorizationOutput with field(s):
  • endpoint_authorization_list(Option<Vec::<EndpointAuthorization>>):

    The authorizations to an endpoint.

  • marker(Option<String>):

    An optional pagination token provided by a previous DescribeEndpointAuthorization request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

• On failure, responds with SdkError<DescribeEndpointAuthorizationError>

impl Client

pub fn describe_event_categories(&self) -> DescribeEventCategoriesFluentBuilder

Constructs a fluent builder for the DescribeEventCategories operation.

• The fluent builder is configurable:
  • source_type(impl Into<String>) / set_source_type(Option<String>):
    required: false
    

    The source type, such as cluster or parameter group, to which the described event categories apply.

    Valid values: cluster, cluster-snapshot, cluster-parameter-group, cluster-security-group, and scheduled-action.

    
    
• On success, responds with DescribeEventCategoriesOutput with field(s):
  • event_categories_map_list(Option<Vec::<EventCategoriesMap>>):

    A list of event categories descriptions.

• On failure, responds with SdkError<DescribeEventCategoriesError>

impl Client

pub fn describe_event_subscriptions( &self, ) -> DescribeEventSubscriptionsFluentBuilder

Constructs a fluent builder for the DescribeEventSubscriptions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • subscription_name(impl Into<String>) / set_subscription_name(Option<String>):
    required: false
    

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

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEventSubscriptions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: false
    

    A tag key or keys for which you want to return all matching event notification subscriptions that are associated with the specified key or keys. For example, suppose that you have subscriptions that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subscriptions that have either or both of these tag keys associated with them.

    
    
  • tag_values(impl Into<String>) / set_tag_values(Option<Vec::<String>>):
    required: false
    

    A tag value or values for which you want to return all matching event notification subscriptions that are associated with the specified tag value or values. For example, suppose that you have subscriptions that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the subscriptions that have either or both of these tag values associated with them.

    
    
• On success, responds with DescribeEventSubscriptionsOutput with field(s):
  • marker(Option<String>):

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

  • event_subscriptions_list(Option<Vec::<EventSubscription>>):

    A list of event subscriptions.

• On failure, responds with SdkError<DescribeEventSubscriptionsError>

impl Client

pub fn describe_events(&self) -> DescribeEventsFluentBuilder

Constructs a fluent builder for the DescribeEvents operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • source_identifier(impl Into<String>) / set_source_identifier(Option<String>):
    required: false
    

    The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.

    Constraints:

    If SourceIdentifier is supplied, SourceType must also be provided.

    • Specify a cluster identifier when SourceType is cluster.

    • Specify a cluster security group name when SourceType is cluster-security-group.

    • Specify a cluster parameter group name when SourceType is cluster-parameter-group.

    • Specify a cluster snapshot identifier when SourceType is cluster-snapshot.

    
    
  • source_type(SourceType) / set_source_type(Option<SourceType>):
    required: false
    

    The event source to retrieve events for. If no value is specified, all events are returned.

    Constraints:

    If SourceType is supplied, SourceIdentifier must also be provided.

    • Specify cluster when SourceIdentifier is a cluster identifier.

    • Specify cluster-security-group when SourceIdentifier is a cluster security group name.

    • Specify cluster-parameter-group when SourceIdentifier is a cluster parameter group name.

    • Specify cluster-snapshot when SourceIdentifier is a cluster snapshot identifier.

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: false
    

    The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

    Example: 2009-07-08T18:00Z

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: false
    

    The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

    Example: 2009-07-08T18:00Z

    
    
  • duration(i32) / set_duration(Option<i32>):
    required: false
    

    The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.

    Default: 60

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEvents request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    
    
• On success, responds with DescribeEventsOutput with field(s):
  • marker(Option<String>):

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

  • events(Option<Vec::<Event>>):

    A list of Event instances.

• On failure, responds with SdkError<DescribeEventsError>

impl Client

pub fn describe_hsm_client_certificates( &self, ) -> DescribeHsmClientCertificatesFluentBuilder

Constructs a fluent builder for the DescribeHsmClientCertificates operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • hsm_client_certificate_identifier(impl Into<String>) / set_hsm_client_certificate_identifier(Option<String>):
    required: false
    

    The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your Amazon Web Services account.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmClientCertificates request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: false
    

    A tag key or keys for which you want to return all matching HSM client certificates that are associated with the specified key or keys. For example, suppose that you have HSM client certificates that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag keys associated with them.

    
    
  • tag_values(impl Into<String>) / set_tag_values(Option<Vec::<String>>):
    required: false
    

    A tag value or values for which you want to return all matching HSM client certificates that are associated with the specified tag value or values. For example, suppose that you have HSM client certificates that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag values associated with them.

    
    
• On success, responds with DescribeHsmClientCertificatesOutput with field(s):
  • marker(Option<String>):

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

  • hsm_client_certificates(Option<Vec::<HsmClientCertificate>>):

    A list of the identifiers for one or more HSM client certificates used by Amazon Redshift clusters to store and retrieve database encryption keys in an HSM.

• On failure, responds with SdkError<DescribeHsmClientCertificatesError>

impl Client

pub fn describe_hsm_configurations( &self, ) -> DescribeHsmConfigurationsFluentBuilder

Constructs a fluent builder for the DescribeHsmConfigurations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • hsm_configuration_identifier(impl Into<String>) / set_hsm_configuration_identifier(Option<String>):
    required: false
    

    The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your Amazon Web Services account.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmConfigurations request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: false
    

    A tag key or keys for which you want to return all matching HSM configurations that are associated with the specified key or keys. For example, suppose that you have HSM configurations that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag keys associated with them.

    
    
  • tag_values(impl Into<String>) / set_tag_values(Option<Vec::<String>>):
    required: false
    

    A tag value or values for which you want to return all matching HSM configurations that are associated with the specified tag value or values. For example, suppose that you have HSM configurations that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag values associated with them.

    
    
• On success, responds with DescribeHsmConfigurationsOutput with field(s):
  • marker(Option<String>):

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

  • hsm_configurations(Option<Vec::<HsmConfiguration>>):

    A list of HsmConfiguration objects.

• On failure, responds with SdkError<DescribeHsmConfigurationsError>

impl Client

pub fn describe_inbound_integrations( &self, ) -> DescribeInboundIntegrationsFluentBuilder

Constructs a fluent builder for the DescribeInboundIntegrations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • integration_arn(impl Into<String>) / set_integration_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the inbound integration.

    
    
  • target_arn(impl Into<String>) / set_target_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the target of an inbound integration.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeInboundIntegrations request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    
    
• On success, responds with DescribeInboundIntegrationsOutput with field(s):
  • marker(Option<String>):

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

  • inbound_integrations(Option<Vec::<InboundIntegration>>):

    A list of InboundIntegration instances.

• On failure, responds with SdkError<DescribeInboundIntegrationsError>

impl Client

pub fn describe_integrations(&self) -> DescribeIntegrationsFluentBuilder

Constructs a fluent builder for the DescribeIntegrations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • integration_arn(impl Into<String>) / set_integration_arn(Option<String>):
    required: false
    

    The unique identifier of the integration.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional pagination token provided by a previous DescribeIntegrations request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    
    
  • filters(DescribeIntegrationsFilter) / set_filters(Option<Vec::<DescribeIntegrationsFilter>>):
    required: false
    

    A filter that specifies one or more resources to return.

    
    
• On success, responds with DescribeIntegrationsOutput with field(s):
  • marker(Option<String>):

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

  • integrations(Option<Vec::<Integration>>):

    List of integrations that are described.

• On failure, responds with SdkError<DescribeIntegrationsError>

impl Client

pub fn describe_logging_status(&self) -> DescribeLoggingStatusFluentBuilder

Constructs a fluent builder for the DescribeLoggingStatus operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

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

    Example: examplecluster

    
    
• On success, responds with DescribeLoggingStatusOutput with field(s):
  • logging_enabled(Option<bool>):

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

  • bucket_name(Option<String>):

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

  • s3_key_prefix(Option<String>):

    The prefix applied to the log file names.

  • last_successful_delivery_time(Option<DateTime>):

    The last time that logs were delivered.

  • last_failure_time(Option<DateTime>):

    The last time when logs failed to be delivered.

  • last_failure_message(Option<String>):

    The message indicating that logs failed to be delivered.

  • log_destination_type(Option<LogDestinationType>):

    The log destination type. An enum with possible values of s3 and cloudwatch.

  • log_exports(Option<Vec::<String>>):

    The collection of exported log types. Possible values are connectionlog, useractivitylog, and userlog.

• On failure, responds with SdkError<DescribeLoggingStatusError>

impl Client

pub fn describe_node_configuration_options( &self, ) -> DescribeNodeConfigurationOptionsFluentBuilder

Constructs a fluent builder for the DescribeNodeConfigurationOptions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • action_type(ActionType) / set_action_type(Option<ActionType>):
    required: true
    

    The action type to evaluate for possible node configurations. Specify “restore-cluster” to get configuration combinations based on an existing snapshot. Specify “recommend-node-config” to get configuration recommendations based on an existing cluster or snapshot. Specify “resize-cluster” to get configuration combinations for elastic resize based on an existing cluster.

    
    
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: false
    

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

    
    
  • snapshot_identifier(impl Into<String>) / set_snapshot_identifier(Option<String>):
    required: false
    

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

    
    
  • snapshot_arn(impl Into<String>) / set_snapshot_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the snapshot associated with the message to describe node configuration.

    
    
  • owner_account(impl Into<String>) / set_owner_account(Option<String>):
    required: false
    

    The Amazon Web Services account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.

    
    
  • filters(NodeConfigurationOptionsFilter) / set_filters(Option<Vec::<NodeConfigurationOptionsFilter>>):
    required: false
    

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

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeNodeConfigurationOptions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 500

    Constraints: minimum 100, maximum 500.

    
    
• On success, responds with DescribeNodeConfigurationOptionsOutput with field(s):
  • node_configuration_option_list(Option<Vec::<NodeConfigurationOption>>):

    A list of valid node configurations.

  • marker(Option<String>):

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

• On failure, responds with SdkError<DescribeNodeConfigurationOptionsError>

impl Client

pub fn describe_orderable_cluster_options( &self, ) -> DescribeOrderableClusterOptionsFluentBuilder

Constructs a fluent builder for the DescribeOrderableClusterOptions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • cluster_version(impl Into<String>) / set_cluster_version(Option<String>):
    required: false
    

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

    Default: All versions.

    Constraints: Must be one of the version returned from DescribeClusterVersions.

    
    
  • node_type(impl Into<String>) / set_node_type(Option<String>):
    required: false
    

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

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeOrderableClusterOptions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    
    
• On success, responds with DescribeOrderableClusterOptionsOutput with field(s):
  • orderable_cluster_options(Option<Vec::<OrderableClusterOption>>):

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

  • marker(Option<String>):

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

• On failure, responds with SdkError<DescribeOrderableClusterOptionsError>

impl Client

pub fn describe_partners(&self) -> DescribePartnersFluentBuilder

Constructs a fluent builder for the DescribePartners operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID that owns the cluster.

    
    
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

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

    
    
  • database_name(impl Into<String>) / set_database_name(Option<String>):
    required: false
    

    The name of the database whose partner integration is being described. If database name is not specified, then all databases in the cluster are described.

    
    
  • partner_name(impl Into<String>) / set_partner_name(Option<String>):
    required: false
    

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

    
    
• On success, responds with DescribePartnersOutput with field(s):
  • partner_integration_info_list(Option<Vec::<PartnerIntegrationInfo>>):

    A list of partner integrations.

• On failure, responds with SdkError<DescribePartnersError>

impl Client

pub fn describe_redshift_idc_applications( &self, ) -> DescribeRedshiftIdcApplicationsFluentBuilder

Constructs a fluent builder for the DescribeRedshiftIdcApplications operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • redshift_idc_application_arn(impl Into<String>) / set_redshift_idc_application_arn(Option<String>):
    required: false
    

    The ARN for the Redshift application that integrates with IAM Identity Center.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

    
    
• On success, responds with DescribeRedshiftIdcApplicationsOutput with field(s):
  • redshift_idc_applications(Option<Vec::<RedshiftIdcApplication>>):

    The list of Amazon Redshift IAM Identity Center applications.

  • marker(Option<String>):

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

• On failure, responds with SdkError<DescribeRedshiftIdcApplicationsError>

impl Client

pub fn describe_reserved_node_exchange_status( &self, ) -> DescribeReservedNodeExchangeStatusFluentBuilder

Constructs a fluent builder for the DescribeReservedNodeExchangeStatus operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • reserved_node_id(impl Into<String>) / set_reserved_node_id(Option<String>):
    required: false
    

    The identifier of the source reserved node in a reserved-node exchange request.

    
    
  • reserved_node_exchange_request_id(impl Into<String>) / set_reserved_node_exchange_request_id(Option<String>):
    required: false
    

    The identifier of the reserved-node exchange request.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a Marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional pagination token provided by a previous DescribeReservedNodeExchangeStatus request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    
    
• On success, responds with DescribeReservedNodeExchangeStatusOutput with field(s):
  • reserved_node_exchange_status_details(Option<Vec::<ReservedNodeExchangeStatus>>):

    The details of the reserved-node exchange request, including the status, request time, source reserved-node identifier, and additional details.

  • marker(Option<String>):

    A pagination token provided by a previous DescribeReservedNodeExchangeStatus request.

• On failure, responds with SdkError<DescribeReservedNodeExchangeStatusError>

impl Client

pub fn describe_reserved_node_offerings( &self, ) -> DescribeReservedNodeOfferingsFluentBuilder

Constructs a fluent builder for the DescribeReservedNodeOfferings operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • reserved_node_offering_id(impl Into<String>) / set_reserved_node_offering_id(Option<String>):
    required: false
    

    The unique identifier for the offering.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodeOfferings request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    
    
• On success, responds with DescribeReservedNodeOfferingsOutput with field(s):
  • marker(Option<String>):

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

  • reserved_node_offerings(Option<Vec::<ReservedNodeOffering>>):

    A list of ReservedNodeOffering objects.

• On failure, responds with SdkError<DescribeReservedNodeOfferingsError>

impl Client

pub fn describe_reserved_nodes(&self) -> DescribeReservedNodesFluentBuilder

Constructs a fluent builder for the DescribeReservedNodes operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • reserved_node_id(impl Into<String>) / set_reserved_node_id(Option<String>):
    required: false
    

    Identifier for the node reservation.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodes request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    
    
• On success, responds with DescribeReservedNodesOutput with field(s):
  • marker(Option<String>):

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

  • reserved_nodes(Option<Vec::<ReservedNode>>):

    The list of ReservedNode objects.

• On failure, responds with SdkError<DescribeReservedNodesError>

impl Client

pub fn describe_resize(&self) -> DescribeResizeFluentBuilder

Constructs a fluent builder for the DescribeResize operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive.

    By default, resize operations for all clusters defined for an Amazon Web Services account are returned.

    
    
• On success, responds with DescribeResizeOutput with field(s):
  • target_node_type(Option<String>):

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

  • target_number_of_nodes(Option<i32>):

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

  • target_cluster_type(Option<String>):

    The cluster type after the resize operation is complete.

    Valid Values: multi-node | single-node

  • status(Option<String>):

    The status of the resize operation.

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

  • import_tables_completed(Option<Vec::<String>>):

    The names of tables that have been completely imported .

    Valid Values: List of table names.

  • import_tables_in_progress(Option<Vec::<String>>):

    The names of tables that are being currently imported.

    Valid Values: List of table names.

  • import_tables_not_started(Option<Vec::<String>>):

    The names of tables that have not been yet imported.

    Valid Values: List of table names

  • avg_resize_rate_in_mega_bytes_per_second(Option<f64>):

    The average rate of the resize operation over the last few minutes, measured in megabytes per second. After the resize operation completes, this value shows the average rate of the entire resize operation.

  • total_resize_data_in_mega_bytes(Option<i64>):

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

  • progress_in_mega_bytes(Option<i64>):

    While the resize operation is in progress, this value shows the current amount of data, in megabytes, that has been processed so far. When the resize operation is complete, this value shows the total amount of data, in megabytes, on the cluster, which may be more or less than TotalResizeDataInMegaBytes (the estimated total amount of data before resize).

  • elapsed_time_in_seconds(Option<i64>):

    The amount of seconds that have elapsed since the resize operation began. After the resize operation completes, this value shows the total actual time, in seconds, for the resize operation.

  • estimated_time_to_completion_in_seconds(Option<i64>):

    The estimated time remaining, in seconds, until the resize operation is complete. This value is calculated based on the average resize rate and the estimated amount of data remaining to be processed. Once the resize operation is complete, this value will be 0.

  • resize_type(Option<String>):

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

  • message(Option<String>):

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

  • target_encryption_type(Option<String>):

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

    Possible values are KMS and None.

  • data_transfer_progress_percent(Option<f64>):

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

• On failure, responds with SdkError<DescribeResizeError>

impl Client

pub fn describe_scheduled_actions( &self, ) -> DescribeScheduledActionsFluentBuilder

Constructs a fluent builder for the DescribeScheduledActions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • scheduled_action_name(impl Into<String>) / set_scheduled_action_name(Option<String>):
    required: false
    

    The name of the scheduled action to retrieve.

    
    
  • target_action_type(ScheduledActionTypeValues) / set_target_action_type(Option<ScheduledActionTypeValues>):
    required: false
    

    The type of the scheduled actions to retrieve.

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: false
    

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

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: false
    

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

    
    
  • active(bool) / set_active(Option<bool>):
    required: false
    

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

    
    
  • filters(ScheduledActionFilter) / set_filters(Option<Vec::<ScheduledActionFilter>>):
    required: false
    

    List of scheduled action filters.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeScheduledActions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    
    
• On success, responds with DescribeScheduledActionsOutput with field(s):
  • marker(Option<String>):

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeScheduledActions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

  • scheduled_actions(Option<Vec::<ScheduledAction>>):

    List of retrieved scheduled actions.

• On failure, responds with SdkError<DescribeScheduledActionsError>

impl Client

pub fn describe_snapshot_copy_grants( &self, ) -> DescribeSnapshotCopyGrantsFluentBuilder

Constructs a fluent builder for the DescribeSnapshotCopyGrants operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • snapshot_copy_grant_name(impl Into<String>) / set_snapshot_copy_grant_name(Option<String>):
    required: false
    

    The name of the snapshot copy grant.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: false
    

    A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.

    
    
  • tag_values(impl Into<String>) / set_tag_values(Option<Vec::<String>>):
    required: false
    

    A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.

    
    
• On success, responds with DescribeSnapshotCopyGrantsOutput with field(s):
  • marker(Option<String>):

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.

  • snapshot_copy_grants(Option<Vec::<SnapshotCopyGrant>>):

    The list of SnapshotCopyGrant objects.

• On failure, responds with SdkError<DescribeSnapshotCopyGrantsError>

impl Client

pub fn describe_snapshot_schedules( &self, ) -> DescribeSnapshotSchedulesFluentBuilder

Constructs a fluent builder for the DescribeSnapshotSchedules operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: false
    

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

    
    
  • schedule_identifier(impl Into<String>) / set_schedule_identifier(Option<String>):
    required: false
    

    A unique identifier for a snapshot schedule.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: false
    

    The key value for a snapshot schedule tag.

    
    
  • tag_values(impl Into<String>) / set_tag_values(Option<Vec::<String>>):
    required: false
    

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

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number or response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    
    
• On success, responds with DescribeSnapshotSchedulesOutput with field(s):
  • snapshot_schedules(Option<Vec::<SnapshotSchedule>>):

    A list of SnapshotSchedules.

  • marker(Option<String>):

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.

• On failure, responds with SdkError<DescribeSnapshotSchedulesError>

impl Client

pub fn describe_storage(&self) -> DescribeStorageFluentBuilder

Constructs a fluent builder for the DescribeStorage operation.

• The fluent builder takes no input, just send it.
• On success, responds with DescribeStorageOutput with field(s):
  • total_backup_size_in_mega_bytes(Option<f64>):

    The total amount of storage currently used for snapshots.

  • total_provisioned_storage_in_mega_bytes(Option<f64>):

    The total amount of storage currently provisioned.

• On failure, responds with SdkError<DescribeStorageError>

impl Client

pub fn describe_table_restore_status( &self, ) -> DescribeTableRestoreStatusFluentBuilder

Constructs a fluent builder for the DescribeTableRestoreStatus operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: false
    

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

    
    
  • table_restore_request_id(impl Into<String>) / set_table_restore_request_id(Option<String>):
    required: false
    

    The identifier of the table restore request to return status for. If you don’t specify a TableRestoreRequestId value, then DescribeTableRestoreStatus returns the status of all in-progress table restore requests.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional pagination token provided by a previous DescribeTableRestoreStatus request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

    
    
• On success, responds with DescribeTableRestoreStatusOutput with field(s):
  • table_restore_status_details(Option<Vec::<TableRestoreStatus>>):

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

  • marker(Option<String>):

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

• On failure, responds with SdkError<DescribeTableRestoreStatusError>

impl Client

pub fn describe_tags(&self) -> DescribeTagsFluentBuilder

Constructs a fluent builder for the DescribeTags operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • resource_name(impl Into<String>) / set_resource_name(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.

    
    
  • resource_type(impl Into<String>) / set_resource_type(Option<String>):
    required: false
    

    The type of resource with which you want to view tags. Valid resource types are:

    • Cluster

    • CIDR/IP

    • EC2 security group

    • Snapshot

    • Cluster security group

    • Subnet group

    • HSM connection

    • HSM certificate

    • Parameter group

    • Snapshot copy grant

    • Integration (zero-ETL integration or S3 event integration)

      To describe the tags associated with an integration, don’t specify ResourceType, instead specify the ResourceName of the integration.

    For more information about Amazon Redshift resource types and constructing ARNs, go to Specifying Policy Elements: Actions, Effects, Resources, and Principals in the Amazon Redshift Cluster Management Guide.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number or response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: false
    

    A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.

    
    
  • tag_values(impl Into<String>) / set_tag_values(Option<Vec::<String>>):
    required: false
    

    A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.

    
    
• On success, responds with DescribeTagsOutput with field(s):
  • tagged_resources(Option<Vec::<TaggedResource>>):

    A list of tags with their associated resources.

  • marker(Option<String>):

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

• On failure, responds with SdkError<DescribeTagsError>

impl Client

pub fn describe_usage_limits(&self) -> DescribeUsageLimitsFluentBuilder

Constructs a fluent builder for the DescribeUsageLimits operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • usage_limit_id(impl Into<String>) / set_usage_limit_id(Option<String>):
    required: false
    

    The identifier of the usage limit to describe.

    
    
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: false
    

    The identifier of the cluster for which you want to describe usage limits.

    
    
  • feature_type(UsageLimitFeatureType) / set_feature_type(Option<UsageLimitFeatureType>):
    required: false
    

    The feature type for which you want to describe usage limits.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeUsageLimits request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: false
    

    A tag key or keys for which you want to return all matching usage limit objects that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the usage limit objects have either or both of these tag keys associated with them.

    
    
  • tag_values(impl Into<String>) / set_tag_values(Option<Vec::<String>>):
    required: false
    

    A tag value or values for which you want to return all matching usage limit objects that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the usage limit objects that have either or both of these tag values associated with them.

    
    
• On success, responds with DescribeUsageLimitsOutput with field(s):
  • usage_limits(Option<Vec::<UsageLimit>>):

    Contains the output from the DescribeUsageLimits action.

  • marker(Option<String>):

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

• On failure, responds with SdkError<DescribeUsageLimitsError>

impl Client

pub fn disable_logging(&self) -> DisableLoggingFluentBuilder

Constructs a fluent builder for the DisableLogging operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

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

    Example: examplecluster

    
    
• On success, responds with DisableLoggingOutput with field(s):
  • logging_enabled(Option<bool>):

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

  • bucket_name(Option<String>):

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

  • s3_key_prefix(Option<String>):

    The prefix applied to the log file names.

  • last_successful_delivery_time(Option<DateTime>):

    The last time that logs were delivered.

  • last_failure_time(Option<DateTime>):

    The last time when logs failed to be delivered.

  • last_failure_message(Option<String>):

    The message indicating that logs failed to be delivered.

  • log_destination_type(Option<LogDestinationType>):

    The log destination type. An enum with possible values of s3 and cloudwatch.

  • log_exports(Option<Vec::<String>>):

    The collection of exported log types. Possible values are connectionlog, useractivitylog, and userlog.

• On failure, responds with SdkError<DisableLoggingError>

impl Client

pub fn disable_snapshot_copy(&self) -> DisableSnapshotCopyFluentBuilder

Constructs a fluent builder for the DisableSnapshotCopy operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    The unique identifier of the source cluster that you want to disable copying of snapshots to a destination region.

    Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.

    
    
• On success, responds with DisableSnapshotCopyOutput with field(s):
  • cluster(Option<Cluster>):

    Describes a cluster.

• On failure, responds with SdkError<DisableSnapshotCopyError>

impl Client

pub fn disassociate_data_share_consumer( &self, ) -> DisassociateDataShareConsumerFluentBuilder

Constructs a fluent builder for the DisassociateDataShareConsumer operation.

• The fluent builder is configurable:
  • data_share_arn(impl Into<String>) / set_data_share_arn(Option<String>):
    required: true
    

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

    
    
  • disassociate_entire_account(bool) / set_disassociate_entire_account(Option<bool>):
    required: false
    

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

    
    
  • consumer_arn(impl Into<String>) / set_consumer_arn(Option<String>):
    required: false
    

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

    
    
  • consumer_region(impl Into<String>) / set_consumer_region(Option<String>):
    required: false
    

    From a datashare consumer account, removes association of a datashare from all the existing and future namespaces in the specified Amazon Web Services Region.

    
    
• On success, responds with DisassociateDataShareConsumerOutput with field(s):
  • data_share_arn(Option<String>):

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

  • producer_arn(Option<String>):

    The Amazon Resource Name (ARN) of the producer namespace.

  • allow_publicly_accessible_consumers(Option<bool>):

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

  • data_share_associations(Option<Vec::<DataShareAssociation>>):

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

  • managed_by(Option<String>):

    The identifier of a datashare to show its managing entity.

  • data_share_type(Option<DataShareType>):

    The type of the datashare created by RegisterNamespace.

• On failure, responds with SdkError<DisassociateDataShareConsumerError>

impl Client

pub fn enable_logging(&self) -> EnableLoggingFluentBuilder

Constructs a fluent builder for the EnableLogging operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

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

    Example: examplecluster

    
    
  • bucket_name(impl Into<String>) / set_bucket_name(Option<String>):
    required: false
    

    The name of an existing S3 bucket where the log files are to be stored.

    Constraints:

    • Must be in the same region as the cluster

    • The cluster must have read bucket and put object permissions

    
    
  • s3_key_prefix(impl Into<String>) / set_s3_key_prefix(Option<String>):
    required: false
    

    The prefix applied to the log file names.

    Valid characters are any letter from any language, any whitespace character, any numeric character, and the following characters: underscore (_), period (.), colon (:), slash (/), equal (=), plus (+), backslash (</code>), hyphen (-), at symbol (@).

    

  • log_destination_type(LogDestinationType) / set_log_destination_type(Option<LogDestinationType>):
    required: false
    

    The log destination type. An enum with possible values of s3 and cloudwatch.

    
    
  • log_exports(impl Into<String>) / set_log_exports(Option<Vec::<String>>):
    required: false
    

    The collection of exported log types. Possible values are connectionlog, useractivitylog, and userlog.

    
    
• On success, responds with EnableLoggingOutput with field(s):
  • logging_enabled(Option<bool>):

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

  • bucket_name(Option<String>):

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

  • s3_key_prefix(Option<String>):

    The prefix applied to the log file names.

  • last_successful_delivery_time(Option<DateTime>):

    The last time that logs were delivered.

  • last_failure_time(Option<DateTime>):

    The last time when logs failed to be delivered.

  • last_failure_message(Option<String>):

    The message indicating that logs failed to be delivered.

  • log_destination_type(Option<LogDestinationType>):

    The log destination type. An enum with possible values of s3 and cloudwatch.

  • log_exports(Option<Vec::<String>>):

    The collection of exported log types. Possible values are connectionlog, useractivitylog, and userlog.

• On failure, responds with SdkError<EnableLoggingError>

impl Client

pub fn enable_snapshot_copy(&self) -> EnableSnapshotCopyFluentBuilder

Constructs a fluent builder for the EnableSnapshotCopy operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    The unique identifier of the source cluster to copy snapshots from.

    Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.

    
    
  • destination_region(impl Into<String>) / set_destination_region(Option<String>):
    required: true
    

    The destination Amazon Web Services Region that you want to copy snapshots to.

    Constraints: Must be the name of a valid Amazon Web Services Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.

    
    
  • retention_period(i32) / set_retention_period(Option<i32>):
    required: false
    

    The number of days to retain automated snapshots in the destination region after they are copied from the source region.

    Default: 7.

    Constraints: Must be at least 1 and no more than 35.

    
    
  • snapshot_copy_grant_name(impl Into<String>) / set_snapshot_copy_grant_name(Option<String>):
    required: false
    

    The name of the snapshot copy grant to use when snapshots of an Amazon Web Services KMS-encrypted cluster are copied to the destination region.

    
    
  • manual_snapshot_retention_period(i32) / set_manual_snapshot_retention_period(Option<i32>):
    required: false
    

    The number of days to retain newly copied snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region. If the value is -1, the manual snapshot is retained indefinitely.

    The value must be either -1 or an integer between 1 and 3,653.

    
    
• On success, responds with EnableSnapshotCopyOutput with field(s):
  • cluster(Option<Cluster>):

    Describes a cluster.

• On failure, responds with SdkError<EnableSnapshotCopyError>

impl Client

pub fn failover_primary_compute(&self) -> FailoverPrimaryComputeFluentBuilder

Constructs a fluent builder for the FailoverPrimaryCompute operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    The unique identifier of the cluster for which the primary compute unit will be failed over to another Availability Zone.

    
    
• On success, responds with FailoverPrimaryComputeOutput with field(s):
  • cluster(Option<Cluster>):

    Describes a cluster.

• On failure, responds with SdkError<FailoverPrimaryComputeError>

impl Client

pub fn get_cluster_credentials(&self) -> GetClusterCredentialsFluentBuilder

Constructs a fluent builder for the GetClusterCredentials operation.

• The fluent builder is configurable:
  • db_user(impl Into<String>) / set_db_user(Option<String>):
    required: true
    

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

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

    Constraints:

    • Must be 1 to 64 alphanumeric characters or hyphens. The user name can’t be PUBLIC.

    • Must contain uppercase or lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

    • First character must be a letter.

    • Must not contain a colon ( : ) or slash ( / ).

    • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

    
    
  • db_name(impl Into<String>) / set_db_name(Option<String>):
    required: false
    

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

    Constraints:

    • Must be 1 to 64 alphanumeric characters or hyphens

    • Must contain uppercase or lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

    • First character must be a letter.

    • Must not contain a colon ( : ) or slash ( / ).

    • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

    
    
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: false
    

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

    
    
  • duration_seconds(i32) / set_duration_seconds(Option<i32>):
    required: false
    

    The number of seconds until the returned temporary password expires.

    Constraint: minimum 900, maximum 3600.

    Default: 900

    
    
  • auto_create(bool) / set_auto_create(Option<bool>):
    required: false
    

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

    
    
  • db_groups(impl Into<String>) / set_db_groups(Option<Vec::<String>>):
    required: false
    

    A list of the names of existing database groups that the user named in DbUser will join for the current session, in addition to any group memberships for an existing user. If not specified, a new user is added only to PUBLIC.

    Database group name constraints

    • Must be 1 to 64 alphanumeric characters or hyphens

    • Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

    • First character must be a letter.

    • Must not contain a colon ( : ) or slash ( / ).

    • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

    
    
  • custom_domain_name(impl Into<String>) / set_custom_domain_name(Option<String>):
    required: false
    

    The custom domain name for the cluster credentials.

    
    
• On success, responds with GetClusterCredentialsOutput with field(s):
  • db_user(Option<String>):

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

  • db_password(Option<String>):

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

  • expiration(Option<DateTime>):

    The date and time the password in DbPassword expires.

• On failure, responds with SdkError<GetClusterCredentialsError>

impl Client

pub fn get_cluster_credentials_with_iam( &self, ) -> GetClusterCredentialsWithIAMFluentBuilder

Constructs a fluent builder for the GetClusterCredentialsWithIAM operation.

• The fluent builder is configurable:
  • db_name(impl Into<String>) / set_db_name(Option<String>):
    required: false
    

    The name of the database for which you are requesting credentials. If the database name is specified, the IAM policy must allow access to the resource dbname for the specified database name. If the database name is not specified, access to all databases is allowed.

    
    
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: false
    

    The unique identifier of the cluster that contains the database for which you are requesting credentials.

    
    
  • duration_seconds(i32) / set_duration_seconds(Option<i32>):
    required: false
    

    The number of seconds until the returned temporary password expires.

    Range: 900-3600. Default: 900.

    
    
  • custom_domain_name(impl Into<String>) / set_custom_domain_name(Option<String>):
    required: false
    

    The custom domain name for the IAM message cluster credentials.

    
    
• On success, responds with GetClusterCredentialsWithIamOutput with field(s):
  • db_user(Option<String>):

    A database user name that you provide when you connect to a database. The database user is mapped 1:1 to the source IAM identity.

  • db_password(Option<String>):

    A temporary password that you provide when you connect to a database.

  • expiration(Option<DateTime>):

    The time (UTC) when the temporary password expires. After this timestamp, a log in with the temporary password fails.

  • next_refresh_time(Option<DateTime>):

    Reserved for future use.

• On failure, responds with SdkError<GetClusterCredentialsWithIAMError>

impl Client

pub fn get_reserved_node_exchange_configuration_options( &self, ) -> GetReservedNodeExchangeConfigurationOptionsFluentBuilder

Constructs a fluent builder for the GetReservedNodeExchangeConfigurationOptions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • action_type(ReservedNodeExchangeActionType) / set_action_type(Option<ReservedNodeExchangeActionType>):
    required: true
    

    The action type of the reserved-node configuration. The action type can be an exchange initiated from either a snapshot or a resize.

    
    
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: false
    

    The identifier for the cluster that is the source for a reserved-node exchange.

    
    
  • snapshot_identifier(impl Into<String>) / set_snapshot_identifier(Option<String>):
    required: false
    

    The identifier for the snapshot that is the source for the reserved-node exchange.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a Marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional pagination token provided by a previous GetReservedNodeExchangeConfigurationOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    
    
• On success, responds with GetReservedNodeExchangeConfigurationOptionsOutput with field(s):
  • marker(Option<String>):

    A pagination token provided by a previous GetReservedNodeExchangeConfigurationOptions request.

  • reserved_node_configuration_option_list(Option<Vec::<ReservedNodeConfigurationOption>>):

    the configuration options for the reserved-node exchange. These options include information about the source reserved node and target reserved node. Details include the node type, the price, the node count, and the offering type.

• On failure, responds with SdkError<GetReservedNodeExchangeConfigurationOptionsError>

impl Client

pub fn get_reserved_node_exchange_offerings( &self, ) -> GetReservedNodeExchangeOfferingsFluentBuilder

Constructs a fluent builder for the GetReservedNodeExchangeOfferings operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • reserved_node_id(impl Into<String>) / set_reserved_node_id(Option<String>):
    required: true
    

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

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    An integer setting the maximum number of ReservedNodeOfferings to retrieve.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

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

    
    
• On success, responds with GetReservedNodeExchangeOfferingsOutput with field(s):
  • marker(Option<String>):

    An optional parameter that specifies the starting point for returning a set of response records. When the results of a GetReservedNodeExchangeOfferings request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.

  • reserved_node_offerings(Option<Vec::<ReservedNodeOffering>>):

    Returns an array of ReservedNodeOffering objects.

• On failure, responds with SdkError<GetReservedNodeExchangeOfferingsError>

impl Client

pub fn get_resource_policy(&self) -> GetResourcePolicyFluentBuilder

Constructs a fluent builder for the GetResourcePolicy operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource of which its resource policy is fetched.

    
    
• On success, responds with GetResourcePolicyOutput with field(s):
  • resource_policy(Option<ResourcePolicy>):

    The content of the resource policy.

• On failure, responds with SdkError<GetResourcePolicyError>

impl Client

pub fn list_recommendations(&self) -> ListRecommendationsFluentBuilder

Constructs a fluent builder for the ListRecommendations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: false
    

    The unique identifier of the Amazon Redshift cluster for which the list of Advisor recommendations is returned. If the neither the cluster identifier and the cluster namespace ARN parameters are specified, then recommendations for all clusters in the account are returned.

    
    
  • namespace_arn(impl Into<String>) / set_namespace_arn(Option<String>):
    required: false
    

    The Amazon Redshift cluster namespace Amazon Resource Name (ARN) for which the list of Advisor recommendations is returned. If the neither the cluster identifier and the cluster namespace ARN parameters are specified, then recommendations for all clusters in the account are returned.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

    
    
• On success, responds with ListRecommendationsOutput with field(s):
  • recommendations(Option<Vec::<Recommendation>>):

    The Advisor recommendations for action on the Amazon Redshift cluster.

  • marker(Option<String>):

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

• On failure, responds with SdkError<ListRecommendationsError>

impl Client

pub fn modify_aqua_configuration(&self) -> ModifyAquaConfigurationFluentBuilder

Constructs a fluent builder for the ModifyAquaConfiguration operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    The identifier of the cluster to be modified.

    
    
  • aqua_configuration_status(AquaConfigurationStatus) / set_aqua_configuration_status(Option<AquaConfigurationStatus>):
    required: false
    

    This parameter is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).

    
    
• On success, responds with ModifyAquaConfigurationOutput with field(s):
  • aqua_configuration(Option<AquaConfiguration>):

    This parameter is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).

• On failure, responds with SdkError<ModifyAquaConfigurationError>

impl Client

pub fn modify_authentication_profile( &self, ) -> ModifyAuthenticationProfileFluentBuilder

Constructs a fluent builder for the ModifyAuthenticationProfile operation.

• The fluent builder is configurable:
  • authentication_profile_name(impl Into<String>) / set_authentication_profile_name(Option<String>):
    required: true
    

    The name of the authentication profile to replace.

    
    
  • authentication_profile_content(impl Into<String>) / set_authentication_profile_content(Option<String>):
    required: true
    

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

    
    
• On success, responds with ModifyAuthenticationProfileOutput with field(s):
  • authentication_profile_name(Option<String>):

    The name of the authentication profile that was replaced.

  • authentication_profile_content(Option<String>):

    The updated content of the authentication profile in JSON format.

• On failure, responds with SdkError<ModifyAuthenticationProfileError>

impl Client

pub fn modify_cluster(&self) -> ModifyClusterFluentBuilder

Constructs a fluent builder for the ModifyCluster operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    The unique identifier of the cluster to be modified.

    Example: examplecluster

    
    
  • cluster_type(impl Into<String>) / set_cluster_type(Option<String>):
    required: false
    

    The new cluster type.

    When you submit your cluster resize request, your existing cluster goes into a read-only mode. After Amazon Redshift provisions a new cluster based on your resize requirements, there will be outage for a period while the old cluster is deleted and your connection is switched to the new cluster. You can use DescribeResize to track the progress of the resize request.

    Valid Values: multi-node | single-node

    
    
  • node_type(impl Into<String>) / set_node_type(Option<String>):
    required: false
    

    The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter.

    For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

    Valid Values: dc2.large | dc2.8xlarge | ra3.large | ra3.xlplus | ra3.4xlarge | ra3.16xlarge

    
    
  • number_of_nodes(i32) / set_number_of_nodes(Option<i32>):
    required: false
    

    The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter.

    For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

    Valid Values: Integer greater than 0.

    
    
  • cluster_security_groups(impl Into<String>) / set_cluster_security_groups(Option<Vec::<String>>):
    required: false
    

    A list of cluster security groups to be authorized on this cluster. This change is asynchronously applied as soon as possible.

    Security groups currently associated with the cluster, and not in the list of groups to apply, will be revoked from the cluster.

    Constraints:

    • Must be 1 to 255 alphanumeric characters or hyphens

    • First character must be a letter

    • Cannot end with a hyphen or contain two consecutive hyphens

    
    
  • vpc_security_group_ids(impl Into<String>) / set_vpc_security_group_ids(Option<Vec::<String>>):
    required: false
    

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

    
    
  • master_user_password(impl Into<String>) / set_master_user_password(Option<String>):
    required: false
    

    The new password for the cluster admin user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

    You can’t use MasterUserPassword if ManageMasterPassword is true.

    Operations never return the password, so this operation provides a way to regain access to the admin user account for a cluster if the password is lost.

    Default: Uses existing setting.

    Constraints:

    • Must be between 8 and 64 characters in length.

    • Must contain at least one uppercase letter.

    • Must contain at least one lowercase letter.

    • Must contain one number.

    • Can be any printable ASCII character (ASCII code 33-126) except ’ (single quote), “ (double quote), </code>, /, or @.

    

  • cluster_parameter_group_name(impl Into<String>) / set_cluster_parameter_group_name(Option<String>):
    required: false
    

    The name of the cluster parameter group to apply to this cluster. This change is applied only after the cluster is rebooted. To reboot a cluster use RebootCluster.

    Default: Uses existing setting.

    Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.

    
    
  • automated_snapshot_retention_period(i32) / set_automated_snapshot_retention_period(Option<i32>):
    required: false
    

    The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.

    If you decrease the automated snapshot retention period from its current value, existing automated snapshots that fall outside of the new retention period will be immediately deleted.

    You can’t disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.

    Default: Uses existing setting.

    Constraints: Must be a value from 0 to 35.

    
    
  • manual_snapshot_retention_period(i32) / set_manual_snapshot_retention_period(Option<i32>):
    required: false
    

    The default for number of days that a newly created manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. This value doesn’t retroactively change the retention periods of existing manual snapshots.

    The value must be either -1 or an integer between 1 and 3,653.

    The default value is -1.

    
    
  • preferred_maintenance_window(impl Into<String>) / set_preferred_maintenance_window(Option<String>):
    required: false
    

    The weekly time range (in UTC) during which system maintenance can occur, if necessary. If system maintenance is necessary during the window, it may result in an outage.

    This maintenance window change is made immediately. If the new maintenance window indicates the current time, there must be at least 120 minutes between the current time and end of the window in order to ensure that pending changes are applied.

    Default: Uses existing setting.

    Format: ddd:hh24:mi-ddd:hh24:mi, for example wed:07:30-wed:08:00.

    Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

    Constraints: Must be at least 30 minutes.

    
    
  • cluster_version(impl Into<String>) / set_cluster_version(Option<String>):
    required: false
    

    The new version number of the Amazon Redshift engine to upgrade to.

    For major version upgrades, if a non-default cluster parameter group is currently in use, a new cluster parameter group in the cluster parameter group family for the new version must be specified. The new cluster parameter group can be the default for that cluster parameter group family. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

    Example: 1.0

    
    
  • allow_version_upgrade(bool) / set_allow_version_upgrade(Option<bool>):
    required: false
    

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

    Default: false

    
    
  • hsm_client_certificate_identifier(impl Into<String>) / set_hsm_client_certificate_identifier(Option<String>):
    required: false
    

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

    
    
  • hsm_configuration_identifier(impl Into<String>) / set_hsm_configuration_identifier(Option<String>):
    required: false
    

    Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.

    
    
  • new_cluster_identifier(impl Into<String>) / set_new_cluster_identifier(Option<String>):
    required: false
    

    The new identifier for the cluster.

    Constraints:

    • Must contain from 1 to 63 alphanumeric characters or hyphens.

    • Alphabetic characters must be lowercase.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    • Must be unique for all clusters within an Amazon Web Services account.

    Example: examplecluster

    
    
  • publicly_accessible(bool) / set_publicly_accessible(Option<bool>):
    required: false
    

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

    Default: false

    
    
  • elastic_ip(impl Into<String>) / set_elastic_ip(Option<String>):
    required: false
    

    The Elastic IP (EIP) address for the cluster.

    Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.

    
    
  • enhanced_vpc_routing(bool) / set_enhanced_vpc_routing(Option<bool>):
    required: false
    

    An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

    If this option is true, enhanced VPC routing is enabled.

    Default: false

    
    
  • maintenance_track_name(impl Into<String>) / set_maintenance_track_name(Option<String>):
    required: false
    

    The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied.

    
    
  • encrypted(bool) / set_encrypted(Option<bool>):
    required: false
    

    Indicates whether the cluster is encrypted. If the value is encrypted (true) and you provide a value for the KmsKeyId parameter, we encrypt the cluster with the provided KmsKeyId. If you don’t provide a KmsKeyId, we encrypt with the default key.

    If the value is not encrypted (false), then the cluster is decrypted.

    
    
  • kms_key_id(impl Into<String>) / set_kms_key_id(Option<String>):
    required: false
    

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

    
    
  • availability_zone_relocation(bool) / set_availability_zone_relocation(Option<bool>):
    required: false
    

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

    
    
  • availability_zone(impl Into<String>) / set_availability_zone(Option<String>):
    required: false
    

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

    
    
  • port(i32) / set_port(Option<i32>):
    required: false
    

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

    Valid Values:

    • For clusters with ra3 nodes - Select a port within the ranges 5431-5455 or 8191-8215. (If you have an existing cluster with ra3 nodes, it isn’t required that you change the port to these ranges.)

    • For clusters with dc2 nodes - Select a port within the range 1150-65535.

    
    
  • manage_master_password(bool) / set_manage_master_password(Option<bool>):
    required: false
    

    If true, Amazon Redshift uses Secrets Manager to manage this cluster’s admin credentials. You can’t use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account’s password.

    
    
  • master_password_secret_kms_key_id(impl Into<String>) / set_master_password_secret_kms_key_id(Option<String>):
    required: false
    

    The ID of the Key Management Service (KMS) key used to encrypt and store the cluster’s admin credentials secret. You can only use this parameter if ManageMasterPassword is true.

    
    
  • ip_address_type(impl Into<String>) / set_ip_address_type(Option<String>):
    required: false
    

    The IP address types that the cluster supports. Possible values are ipv4 and dualstack.

    
    
  • multi_az(bool) / set_multi_az(Option<bool>):
    required: false
    

    If true and the cluster is currently only deployed in a single Availability Zone, the cluster will be modified to be deployed in two Availability Zones.

    
    
• On success, responds with ModifyClusterOutput with field(s):
  • cluster(Option<Cluster>):

    Describes a cluster.

• On failure, responds with SdkError<ModifyClusterError>

impl Client

pub fn modify_cluster_db_revision(&self) -> ModifyClusterDbRevisionFluentBuilder

Constructs a fluent builder for the ModifyClusterDbRevision operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

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

    Example: examplecluster

    
    
  • revision_target(impl Into<String>) / set_revision_target(Option<String>):
    required: true
    

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

    
    
• On success, responds with ModifyClusterDbRevisionOutput with field(s):
  • cluster(Option<Cluster>):

    Describes a cluster.

• On failure, responds with SdkError<ModifyClusterDbRevisionError>

impl Client

pub fn modify_cluster_iam_roles(&self) -> ModifyClusterIamRolesFluentBuilder

Constructs a fluent builder for the ModifyClusterIamRoles operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

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

    
    
  • add_iam_roles(impl Into<String>) / set_add_iam_roles(Option<Vec::<String>>):
    required: false
    

    Zero or more IAM roles to associate with the cluster. The roles must be in their Amazon Resource Name (ARN) format.

    
    
  • remove_iam_roles(impl Into<String>) / set_remove_iam_roles(Option<Vec::<String>>):
    required: false
    

    Zero or more IAM roles in ARN format to disassociate from the cluster.

    
    
  • default_iam_role_arn(impl Into<String>) / set_default_iam_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was last modified.

    
    
• On success, responds with ModifyClusterIamRolesOutput with field(s):
  • cluster(Option<Cluster>):

    Describes a cluster.

• On failure, responds with SdkError<ModifyClusterIamRolesError>

impl Client

pub fn modify_cluster_maintenance( &self, ) -> ModifyClusterMaintenanceFluentBuilder

Constructs a fluent builder for the ModifyClusterMaintenance operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    A unique identifier for the cluster.

    
    
  • defer_maintenance(bool) / set_defer_maintenance(Option<bool>):
    required: false
    

    A boolean indicating whether to enable the deferred maintenance window.

    
    
  • defer_maintenance_identifier(impl Into<String>) / set_defer_maintenance_identifier(Option<String>):
    required: false
    

    A unique identifier for the deferred maintenance window.

    
    
  • defer_maintenance_start_time(DateTime) / set_defer_maintenance_start_time(Option<DateTime>):
    required: false
    

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

    
    
  • defer_maintenance_end_time(DateTime) / set_defer_maintenance_end_time(Option<DateTime>):
    required: false
    

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

    
    
  • defer_maintenance_duration(i32) / set_defer_maintenance_duration(Option<i32>):
    required: false
    

    An integer indicating the duration of the maintenance window in days. If you specify a duration, you can’t specify an end time. The duration must be 45 days or less.

    
    
• On success, responds with ModifyClusterMaintenanceOutput with field(s):
  • cluster(Option<Cluster>):

    Describes a cluster.

• On failure, responds with SdkError<ModifyClusterMaintenanceError>

impl Client

pub fn modify_cluster_parameter_group( &self, ) -> ModifyClusterParameterGroupFluentBuilder

Constructs a fluent builder for the ModifyClusterParameterGroup operation.

• The fluent builder is configurable:
  • parameter_group_name(impl Into<String>) / set_parameter_group_name(Option<String>):
    required: true
    

    The name of the parameter group to be modified.

    
    
  • parameters(Parameter) / set_parameters(Option<Vec::<Parameter>>):
    required: true
    

    An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.

    For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.

    For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.

    
    
• On success, responds with ModifyClusterParameterGroupOutput with field(s):
  • parameter_group_name(Option<String>):

    The name of the cluster parameter group.

  • parameter_group_status(Option<String>):

    The status of the parameter group. For example, if you made a change to a parameter group name-value pair, then the change could be pending a reboot of an associated cluster.

• On failure, responds with SdkError<ModifyClusterParameterGroupError>

impl Client

pub fn modify_cluster_snapshot(&self) -> ModifyClusterSnapshotFluentBuilder

Constructs a fluent builder for the ModifyClusterSnapshot operation.

• The fluent builder is configurable:
  • snapshot_identifier(impl Into<String>) / set_snapshot_identifier(Option<String>):
    required: true
    

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

    
    
  • manual_snapshot_retention_period(i32) / set_manual_snapshot_retention_period(Option<i32>):
    required: false
    

    The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

    If the manual snapshot falls outside of the new retention period, you can specify the force option to immediately delete the snapshot.

    The value must be either -1 or an integer between 1 and 3,653.

    
    
  • force(bool) / set_force(Option<bool>):
    required: false
    

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

    
    
• On success, responds with ModifyClusterSnapshotOutput with field(s):
  • snapshot(Option<Snapshot>):

    Describes a snapshot.

• On failure, responds with SdkError<ModifyClusterSnapshotError>

impl Client

pub fn modify_cluster_snapshot_schedule( &self, ) -> ModifyClusterSnapshotScheduleFluentBuilder

Constructs a fluent builder for the ModifyClusterSnapshotSchedule operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    A unique identifier for the cluster whose snapshot schedule you want to modify.

    
    
  • schedule_identifier(impl Into<String>) / set_schedule_identifier(Option<String>):
    required: false
    

    A unique alphanumeric identifier for the schedule that you want to associate with the cluster.

    
    
  • disassociate_schedule(bool) / set_disassociate_schedule(Option<bool>):
    required: false
    

    A boolean to indicate whether to remove the assoiciation between the cluster and the schedule.

    
    
• On success, responds with ModifyClusterSnapshotScheduleOutput
• On failure, responds with SdkError<ModifyClusterSnapshotScheduleError>

impl Client

pub fn modify_cluster_subnet_group( &self, ) -> ModifyClusterSubnetGroupFluentBuilder

Constructs a fluent builder for the ModifyClusterSubnetGroup operation.

• The fluent builder is configurable:
  • cluster_subnet_group_name(impl Into<String>) / set_cluster_subnet_group_name(Option<String>):
    required: true
    

    The name of the subnet group to be modified.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A text description of the subnet group to be modified.

    
    
  • subnet_ids(impl Into<String>) / set_subnet_ids(Option<Vec::<String>>):
    required: true
    

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

    
    
• On success, responds with ModifyClusterSubnetGroupOutput with field(s):
  • cluster_subnet_group(Option<ClusterSubnetGroup>):

    Describes a subnet group.

• On failure, responds with SdkError<ModifyClusterSubnetGroupError>

impl Client

pub fn modify_custom_domain_association( &self, ) -> ModifyCustomDomainAssociationFluentBuilder

Constructs a fluent builder for the ModifyCustomDomainAssociation operation.

• The fluent builder is configurable:
  • custom_domain_name(impl Into<String>) / set_custom_domain_name(Option<String>):
    required: true
    

    The custom domain name for a changed custom domain association.

    
    
  • custom_domain_certificate_arn(impl Into<String>) / set_custom_domain_certificate_arn(Option<String>):
    required: true
    

    The certificate Amazon Resource Name (ARN) for the changed custom domain association.

    
    
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    The identifier of the cluster to change a custom domain association for.

    
    
• On success, responds with ModifyCustomDomainAssociationOutput with field(s):
  • custom_domain_name(Option<String>):

    The custom domain name associated with the result for the changed custom domain association.

  • custom_domain_certificate_arn(Option<String>):

    The certificate Amazon Resource Name (ARN) associated with the result for the changed custom domain association.

  • cluster_identifier(Option<String>):

    The identifier of the cluster associated with the result for the changed custom domain association.

  • custom_domain_cert_expiry_time(Option<String>):

    The certificate expiration time associated with the result for the changed custom domain association.

• On failure, responds with SdkError<ModifyCustomDomainAssociationError>

impl Client

pub fn modify_endpoint_access(&self) -> ModifyEndpointAccessFluentBuilder

Constructs a fluent builder for the ModifyEndpointAccess operation.

• The fluent builder is configurable:
  • endpoint_name(impl Into<String>) / set_endpoint_name(Option<String>):
    required: true
    

    The endpoint to be modified.

    
    
  • vpc_security_group_ids(impl Into<String>) / set_vpc_security_group_ids(Option<Vec::<String>>):
    required: false
    

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

    
    
• On success, responds with ModifyEndpointAccessOutput with field(s):
  • cluster_identifier(Option<String>):

    The cluster identifier of the cluster associated with the endpoint.

  • resource_owner(Option<String>):

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

  • subnet_group_name(Option<String>):

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

  • endpoint_status(Option<String>):

    The status of the endpoint.

  • endpoint_name(Option<String>):

    The name of the endpoint.

  • endpoint_create_time(Option<DateTime>):

    The time (UTC) that the endpoint was created.

  • port(Option<i32>):

    The port number on which the cluster accepts incoming connections.

  • address(Option<String>):

    The DNS address of the endpoint.

  • vpc_security_groups(Option<Vec::<VpcSecurityGroupMembership>>):

    The security groups associated with the endpoint.

  • vpc_endpoint(Option<VpcEndpoint>):

    The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.

• On failure, responds with SdkError<ModifyEndpointAccessError>

impl Client

pub fn modify_event_subscription(&self) -> ModifyEventSubscriptionFluentBuilder

Constructs a fluent builder for the ModifyEventSubscription operation.

• The fluent builder is configurable:
  • subscription_name(impl Into<String>) / set_subscription_name(Option<String>):
    required: true
    

    The name of the modified Amazon Redshift event notification subscription.

    
    
  • sns_topic_arn(impl Into<String>) / set_sns_topic_arn(Option<String>):
    required: false
    

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

    
    
  • source_type(impl Into<String>) / set_source_type(Option<String>):
    required: false
    

    The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your Amazon Web Services account. You must specify a source type in order to specify source IDs.

    Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.

    
    
  • source_ids(impl Into<String>) / set_source_ids(Option<Vec::<String>>):
    required: false
    

    A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.

    Example: my-cluster-1, my-cluster-2

    Example: my-snapshot-20131010

    
    
  • event_categories(impl Into<String>) / set_event_categories(Option<Vec::<String>>):
    required: false
    

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

    Values: configuration, management, monitoring, security, pending

    
    
  • severity(impl Into<String>) / set_severity(Option<String>):
    required: false
    

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

    Values: ERROR, INFO

    
    
  • enabled(bool) / set_enabled(Option<bool>):
    required: false
    

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

    
    
• On success, responds with ModifyEventSubscriptionOutput with field(s):
  • event_subscription(Option<EventSubscription>):

    Describes event subscriptions.

• On failure, responds with SdkError<ModifyEventSubscriptionError>

impl Client

pub fn modify_integration(&self) -> ModifyIntegrationFluentBuilder

Constructs a fluent builder for the ModifyIntegration operation.

• The fluent builder is configurable:
  • integration_arn(impl Into<String>) / set_integration_arn(Option<String>):
    required: true
    

    The unique identifier of the integration to modify.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A new description for the integration.

    
    
  • integration_name(impl Into<String>) / set_integration_name(Option<String>):
    required: false
    

    A new name for the integration.

    
    
• On success, responds with ModifyIntegrationOutput with field(s):
  • integration_arn(Option<String>):

    The Amazon Resource Name (ARN) of the integration.

  • integration_name(Option<String>):

    The name of the integration.

  • source_arn(Option<String>):

    The Amazon Resource Name (ARN) of the database used as the source for replication.

  • target_arn(Option<String>):

    The Amazon Resource Name (ARN) of the Amazon Redshift data warehouse to use as the target for replication.

  • status(Option<ZeroEtlIntegrationStatus>):

    The current status of the integration.

  • errors(Option<Vec::<IntegrationError>>):

    Any errors associated with the integration.

  • create_time(Option<DateTime>):

    The time (UTC) when the integration was created.

  • description(Option<String>):

    The description of the integration.

  • kms_key_id(Option<String>):

    The Key Management Service (KMS) key identifier for the key used to encrypt the integration.

  • additional_encryption_context(Option<HashMap::<String, String>>):

    The encryption context for the integration. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide.

  • tags(Option<Vec::<Tag>>):

    The list of tags associated with the integration.

• On failure, responds with SdkError<ModifyIntegrationError>

impl Client

pub fn modify_redshift_idc_application( &self, ) -> ModifyRedshiftIdcApplicationFluentBuilder

Constructs a fluent builder for the ModifyRedshiftIdcApplication operation.

• The fluent builder is configurable:
  • redshift_idc_application_arn(impl Into<String>) / set_redshift_idc_application_arn(Option<String>):
    required: true
    

    The ARN for the Redshift application that integrates with IAM Identity Center.

    
    
  • identity_namespace(impl Into<String>) / set_identity_namespace(Option<String>):
    required: false
    

    The namespace for the Amazon Redshift IAM Identity Center application to change. It determines which managed application verifies the connection token.

    
    
  • iam_role_arn(impl Into<String>) / set_iam_role_arn(Option<String>):
    required: false
    

    The IAM role ARN associated with the Amazon Redshift IAM Identity Center application to change. It has the required permissions to be assumed and invoke the IDC Identity Center API.

    
    
  • idc_display_name(impl Into<String>) / set_idc_display_name(Option<String>):
    required: false
    

    The display name for the Amazon Redshift IAM Identity Center application to change. It appears on the console.

    
    
  • authorized_token_issuer_list(AuthorizedTokenIssuer) / set_authorized_token_issuer_list(Option<Vec::<AuthorizedTokenIssuer>>):
    required: false
    

    The authorized token issuer list for the Amazon Redshift IAM Identity Center application to change.

    
    
  • service_integrations(ServiceIntegrationsUnion) / set_service_integrations(Option<Vec::<ServiceIntegrationsUnion>>):
    required: false
    

    A collection of service integrations associated with the application.

    
    
• On success, responds with ModifyRedshiftIdcApplicationOutput with field(s):
  • redshift_idc_application(Option<RedshiftIdcApplication>):

    Contains properties for the Redshift IDC application.

• On failure, responds with SdkError<ModifyRedshiftIdcApplicationError>

impl Client

pub fn modify_scheduled_action(&self) -> ModifyScheduledActionFluentBuilder

Constructs a fluent builder for the ModifyScheduledAction operation.

• The fluent builder is configurable:
  • scheduled_action_name(impl Into<String>) / set_scheduled_action_name(Option<String>):
    required: true
    

    The name of the scheduled action to modify.

    
    
  • target_action(ScheduledActionType) / set_target_action(Option<ScheduledActionType>):
    required: false
    

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

    
    
  • schedule(impl Into<String>) / set_schedule(Option<String>):
    required: false
    

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

    
    
  • iam_role(impl Into<String>) / set_iam_role(Option<String>):
    required: false
    

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

    
    
  • scheduled_action_description(impl Into<String>) / set_scheduled_action_description(Option<String>):
    required: false
    

    A modified description of the scheduled action.

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: false
    

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

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: false
    

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

    
    
  • enable(bool) / set_enable(Option<bool>):
    required: false
    

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

    
    
• On success, responds with ModifyScheduledActionOutput with field(s):
  • scheduled_action_name(Option<String>):

    The name of the scheduled action.

  • target_action(Option<ScheduledActionType>):

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

    “{"ResizeCluster":{"NodeType":"ra3.4xlarge","ClusterIdentifier":"my-test-cluster","NumberOfNodes":3}}”.

  • schedule(Option<String>):

    The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.

    Format of at expressions is “at(yyyy-mm-ddThh:mm:ss)”. For example, “at(2016-03-04T17:27:00)”.

    Format of cron expressions is “cron(Minutes Hours Day-of-month Month Day-of-week Year)”. For example, “cron(0 10 ? * MON *)”. For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.

  • iam_role(Option<String>):

    The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide.

  • scheduled_action_description(Option<String>):

    The description of the scheduled action.

  • state(Option<ScheduledActionState>):

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

  • next_invocations(Option<Vec::<DateTime>>):

    List of times when the scheduled action will run.

  • start_time(Option<DateTime>):

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

  • end_time(Option<DateTime>):

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

• On failure, responds with SdkError<ModifyScheduledActionError>

impl Client

pub fn modify_snapshot_copy_retention_period( &self, ) -> ModifySnapshotCopyRetentionPeriodFluentBuilder

Constructs a fluent builder for the ModifySnapshotCopyRetentionPeriod operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination Amazon Web Services Region.

    Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.

    
    
  • retention_period(i32) / set_retention_period(Option<i32>):
    required: true
    

    The number of days to retain automated snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region.

    By default, this only changes the retention period of copied automated snapshots.

    If you decrease the retention period for automated snapshots that are copied to a destination Amazon Web Services Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination Amazon Web Services Region and that fall outside of the new retention period.

    Constraints: Must be at least 1 and no more than 35 for automated snapshots.

    If you specify the manual option, only newly copied manual snapshots will have the new retention period.

    If you specify the value of -1 newly copied manual snapshots are retained indefinitely.

    Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.

    
    
  • manual(bool) / set_manual(Option<bool>):
    required: false
    

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

    
    
• On success, responds with ModifySnapshotCopyRetentionPeriodOutput with field(s):
  • cluster(Option<Cluster>):

    Describes a cluster.

• On failure, responds with SdkError<ModifySnapshotCopyRetentionPeriodError>

impl Client

pub fn modify_snapshot_schedule(&self) -> ModifySnapshotScheduleFluentBuilder

Constructs a fluent builder for the ModifySnapshotSchedule operation.

• The fluent builder is configurable:
  • schedule_identifier(impl Into<String>) / set_schedule_identifier(Option<String>):
    required: true
    

    A unique alphanumeric identifier of the schedule to modify.

    
    
  • schedule_definitions(impl Into<String>) / set_schedule_definitions(Option<Vec::<String>>):
    required: true
    

    An updated list of schedule definitions. A schedule definition is made up of schedule expressions, for example, “cron(30 12 *)” or “rate(12 hours)”.

    
    
• On success, responds with ModifySnapshotScheduleOutput with field(s):
  • schedule_definitions(Option<Vec::<String>>):

    A list of ScheduleDefinitions.

  • schedule_identifier(Option<String>):

    A unique identifier for the schedule.

  • schedule_description(Option<String>):

    The description of the schedule.

  • tags(Option<Vec::<Tag>>):

    An optional set of tags describing the schedule.

  • next_invocations(Option<Vec::<DateTime>>):

  • associated_cluster_count(Option<i32>):

    The number of clusters associated with the schedule.

  • associated_clusters(Option<Vec::<ClusterAssociatedToSchedule>>):

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

• On failure, responds with SdkError<ModifySnapshotScheduleError>

impl Client

pub fn modify_usage_limit(&self) -> ModifyUsageLimitFluentBuilder

Constructs a fluent builder for the ModifyUsageLimit operation.

• The fluent builder is configurable:
  • usage_limit_id(impl Into<String>) / set_usage_limit_id(Option<String>):
    required: true
    

    The identifier of the usage limit to modify.

    
    
  • amount(i64) / set_amount(Option<i64>):
    required: false
    

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

    
    
  • breach_action(UsageLimitBreachAction) / set_breach_action(Option<UsageLimitBreachAction>):
    required: false
    

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

    
    
• On success, responds with ModifyUsageLimitOutput with field(s):
  • usage_limit_id(Option<String>):

    The identifier of the usage limit.

  • cluster_identifier(Option<String>):

    The identifier of the cluster with a usage limit.

  • feature_type(Option<UsageLimitFeatureType>):

    The Amazon Redshift feature to which the limit applies.

  • limit_type(Option<UsageLimitLimitType>):

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

  • amount(Option<i64>):

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

  • period(Option<UsageLimitPeriod>):

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

  • breach_action(Option<UsageLimitBreachAction>):

    The action that Amazon Redshift takes when the limit is reached. Possible values are:

    • log - To log an event in a system table. The default is log.

    • emit-metric - To emit CloudWatch metrics.

    • disable - To disable the feature until the next usage period begins.

  • tags(Option<Vec::<Tag>>):

    A list of tag instances.

• On failure, responds with SdkError<ModifyUsageLimitError>

impl Client

pub fn pause_cluster(&self) -> PauseClusterFluentBuilder

Constructs a fluent builder for the PauseCluster operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    The identifier of the cluster to be paused.

    
    
• On success, responds with PauseClusterOutput with field(s):
  • cluster(Option<Cluster>):

    Describes a cluster.

• On failure, responds with SdkError<PauseClusterError>

impl Client

pub fn purchase_reserved_node_offering( &self, ) -> PurchaseReservedNodeOfferingFluentBuilder

Constructs a fluent builder for the PurchaseReservedNodeOffering operation.

• The fluent builder is configurable:
  • reserved_node_offering_id(impl Into<String>) / set_reserved_node_offering_id(Option<String>):
    required: true
    

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

    
    
  • node_count(i32) / set_node_count(Option<i32>):
    required: false
    

    The number of reserved nodes that you want to purchase.

    Default: 1

    
    
• On success, responds with PurchaseReservedNodeOfferingOutput with field(s):
  • reserved_node(Option<ReservedNode>):

    Describes a reserved node. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings.

• On failure, responds with SdkError<PurchaseReservedNodeOfferingError>

impl Client

pub fn put_resource_policy(&self) -> PutResourcePolicyFluentBuilder

Constructs a fluent builder for the PutResourcePolicy operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource of which its resource policy is updated.

    
    
  • policy(impl Into<String>) / set_policy(Option<String>):
    required: true
    

    The content of the resource policy being updated.

    
    
• On success, responds with PutResourcePolicyOutput with field(s):
  • resource_policy(Option<ResourcePolicy>):

    The content of the updated resource policy.

• On failure, responds with SdkError<PutResourcePolicyError>

impl Client

pub fn reboot_cluster(&self) -> RebootClusterFluentBuilder

Constructs a fluent builder for the RebootCluster operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    The cluster identifier.

    
    
• On success, responds with RebootClusterOutput with field(s):
  • cluster(Option<Cluster>):

    Describes a cluster.

• On failure, responds with SdkError<RebootClusterError>

impl Client

pub fn register_namespace(&self) -> RegisterNamespaceFluentBuilder

Constructs a fluent builder for the RegisterNamespace operation.

• The fluent builder is configurable:
  • namespace_identifier(NamespaceIdentifierUnion) / set_namespace_identifier(Option<NamespaceIdentifierUnion>):
    required: true
    

    The unique identifier of the cluster or serverless namespace that you want to register.

    
    
  • consumer_identifiers(impl Into<String>) / set_consumer_identifiers(Option<Vec::<String>>):
    required: true
    

    An array containing the ID of the consumer account that you want to register the namespace to.

    
    
• On success, responds with RegisterNamespaceOutput with field(s):
  • status(Option<NamespaceRegistrationStatus>):

    The registration status of the cluster or serverless namespace.

• On failure, responds with SdkError<RegisterNamespaceError>

impl Client

pub fn reject_data_share(&self) -> RejectDataShareFluentBuilder

Constructs a fluent builder for the RejectDataShare operation.

• The fluent builder is configurable:
  • data_share_arn(impl Into<String>) / set_data_share_arn(Option<String>):
    required: true
    

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

    
    
• On success, responds with RejectDataShareOutput with field(s):
  • data_share_arn(Option<String>):

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

  • producer_arn(Option<String>):

    The Amazon Resource Name (ARN) of the producer namespace.

  • allow_publicly_accessible_consumers(Option<bool>):

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

  • data_share_associations(Option<Vec::<DataShareAssociation>>):

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

  • managed_by(Option<String>):

    The identifier of a datashare to show its managing entity.

  • data_share_type(Option<DataShareType>):

    The type of the datashare created by RegisterNamespace.

• On failure, responds with SdkError<RejectDataShareError>

impl Client

pub fn reset_cluster_parameter_group( &self, ) -> ResetClusterParameterGroupFluentBuilder

Constructs a fluent builder for the ResetClusterParameterGroup operation.

• The fluent builder is configurable:
  • parameter_group_name(impl Into<String>) / set_parameter_group_name(Option<String>):
    required: true
    

    The name of the cluster parameter group to be reset.

    
    
  • reset_all_parameters(bool) / set_reset_all_parameters(Option<bool>):
    required: false
    

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

    Default: true

    
    
  • parameters(Parameter) / set_parameters(Option<Vec::<Parameter>>):
    required: false
    

    An array of names of parameters to be reset. If ResetAllParameters option is not used, then at least one parameter name must be supplied.

    Constraints: A maximum of 20 parameters can be reset in a single request.

    
    
• On success, responds with ResetClusterParameterGroupOutput with field(s):
  • parameter_group_name(Option<String>):

    The name of the cluster parameter group.

  • parameter_group_status(Option<String>):

    The status of the parameter group. For example, if you made a change to a parameter group name-value pair, then the change could be pending a reboot of an associated cluster.

• On failure, responds with SdkError<ResetClusterParameterGroupError>

impl Client

pub fn resize_cluster(&self) -> ResizeClusterFluentBuilder

Constructs a fluent builder for the ResizeCluster operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    The unique identifier for the cluster to resize.

    
    
  • cluster_type(impl Into<String>) / set_cluster_type(Option<String>):
    required: false
    

    The new cluster type for the specified cluster.

    
    
  • node_type(impl Into<String>) / set_node_type(Option<String>):
    required: false
    

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

    
    
  • number_of_nodes(i32) / set_number_of_nodes(Option<i32>):
    required: false
    

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

    
    
  • classic(bool) / set_classic(Option<bool>):
    required: false
    

    A boolean value indicating whether the resize operation is using the classic resize process. If you don’t provide this parameter or set the value to false, the resize type is elastic.

    
    
  • reserved_node_id(impl Into<String>) / set_reserved_node_id(Option<String>):
    required: false
    

    The identifier of the reserved node.

    
    
  • target_reserved_node_offering_id(impl Into<String>) / set_target_reserved_node_offering_id(Option<String>):
    required: false
    

    The identifier of the target reserved node offering.

    
    
• On success, responds with ResizeClusterOutput with field(s):
  • cluster(Option<Cluster>):

    Describes a cluster.

• On failure, responds with SdkError<ResizeClusterError>

impl Client

pub fn restore_from_cluster_snapshot( &self, ) -> RestoreFromClusterSnapshotFluentBuilder

Constructs a fluent builder for the RestoreFromClusterSnapshot operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    The identifier of the cluster that will be created from restoring the snapshot.

    Constraints:

    • Must contain from 1 to 63 alphanumeric characters or hyphens.

    • Alphabetic characters must be lowercase.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    • Must be unique for all clusters within an Amazon Web Services account.

    
    
  • snapshot_identifier(impl Into<String>) / set_snapshot_identifier(Option<String>):
    required: false
    

    The name of the snapshot from which to create the new cluster. This parameter isn’t case sensitive. You must specify this parameter or snapshotArn, but not both.

    Example: my-snapshot-id

    
    
  • snapshot_arn(impl Into<String>) / set_snapshot_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the snapshot associated with the message to restore from a cluster. You must specify this parameter or snapshotIdentifier, but not both.

    
    
  • snapshot_cluster_identifier(impl Into<String>) / set_snapshot_cluster_identifier(Option<String>):
    required: false
    

    The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

    
    
  • port(i32) / set_port(Option<i32>):
    required: false
    

    The port number on which the cluster accepts connections.

    Default: The same port as the original cluster.

    Valid values: For clusters with DC2 nodes, must be within the range 1150-65535. For clusters with ra3 nodes, must be within the ranges 5431-5455 or 8191-8215.

    
    
  • availability_zone(impl Into<String>) / set_availability_zone(Option<String>):
    required: false
    

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

    Default: A random, system-chosen Availability Zone.

    Example: us-east-2a

    
    
  • allow_version_upgrade(bool) / set_allow_version_upgrade(Option<bool>):
    required: false
    

    If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

    Default: true

    
    
  • cluster_subnet_group_name(impl Into<String>) / set_cluster_subnet_group_name(Option<String>):
    required: false
    

    The name of the subnet group where you want to cluster restored.

    A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must provide subnet group name where you want the cluster restored.

    
    
  • publicly_accessible(bool) / set_publicly_accessible(Option<bool>):
    required: false
    

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

    Default: false

    
    
  • owner_account(impl Into<String>) / set_owner_account(Option<String>):
    required: false
    

    The Amazon Web Services account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.

    
    
  • hsm_client_certificate_identifier(impl Into<String>) / set_hsm_client_certificate_identifier(Option<String>):
    required: false
    

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

    
    
  • hsm_configuration_identifier(impl Into<String>) / set_hsm_configuration_identifier(Option<String>):
    required: false
    

    Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.

    
    
  • elastic_ip(impl Into<String>) / set_elastic_ip(Option<String>):
    required: false
    

    The Elastic IP (EIP) address for the cluster. Don’t specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on.

    
    
  • cluster_parameter_group_name(impl Into<String>) / set_cluster_parameter_group_name(Option<String>):
    required: false
    

    The name of the parameter group to be associated with this cluster.

    Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups.

    Constraints:

    • Must be 1 to 255 alphanumeric characters or hyphens.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    
    
  • cluster_security_groups(impl Into<String>) / set_cluster_security_groups(Option<Vec::<String>>):
    required: false
    

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

    Default: The default cluster security group for Amazon Redshift.

    Cluster security groups only apply to clusters outside of VPCs.

    
    
  • vpc_security_group_ids(impl Into<String>) / set_vpc_security_group_ids(Option<Vec::<String>>):
    required: false
    

    A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

    Default: The default VPC security group is associated with the cluster.

    VPC security groups only apply to clusters in VPCs.

    
    
  • preferred_maintenance_window(impl Into<String>) / set_preferred_maintenance_window(Option<String>):
    required: false
    

    The weekly time range (in UTC) during which automated cluster maintenance can occur.

    Format: ddd:hh24:mi-ddd:hh24:mi

    Default: The value selected for the cluster from which the snapshot was taken. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.

    Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

    Constraints: Minimum 30-minute window.

    
    
  • automated_snapshot_retention_period(i32) / set_automated_snapshot_retention_period(Option<i32>):
    required: false
    

    The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.

    You can’t disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.

    Default: The value selected for the cluster from which the snapshot was taken.

    Constraints: Must be a value from 0 to 35.

    
    
  • manual_snapshot_retention_period(i32) / set_manual_snapshot_retention_period(Option<i32>):
    required: false
    

    The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn’t change the retention period of existing snapshots.

    The value must be either -1 or an integer between 1 and 3,653.

    
    
  • kms_key_id(impl Into<String>) / set_kms_key_id(Option<String>):
    required: false
    

    The Key Management Service (KMS) key ID of the encryption key that encrypts data in the cluster restored from a shared snapshot. You can also provide the key ID when you restore from an unencrypted snapshot to an encrypted cluster in the same account. Additionally, you can specify a new KMS key ID when you restore from an encrypted snapshot in the same account in order to change it. In that case, the restored cluster is encrypted with the new KMS key ID.

    
    
  • node_type(impl Into<String>) / set_node_type(Option<String>):
    required: false
    

    The node type that the restored cluster will be provisioned with.

    If you have a DC instance type, you must restore into that same instance type and size. In other words, you can only restore a dc2.large node type into another dc2 type. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide.

    
    
  • enhanced_vpc_routing(bool) / set_enhanced_vpc_routing(Option<bool>):
    required: false
    

    An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

    If this option is true, enhanced VPC routing is enabled.

    Default: false

    
    
  • additional_info(impl Into<String>) / set_additional_info(Option<String>):
    required: false
    

    Reserved.

    
    
  • iam_roles(impl Into<String>) / set_iam_roles(Option<Vec::<String>>):
    required: false
    

    A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format.

    The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.

    
    
  • maintenance_track_name(impl Into<String>) / set_maintenance_track_name(Option<String>):
    required: false
    

    The name of the maintenance track for the restored cluster. When you take a snapshot, the snapshot inherits the MaintenanceTrack value from the cluster. The snapshot might be on a different track than the cluster that was the source for the snapshot. For example, suppose that you take a snapshot of a cluster that is on the current track and then change the cluster to be on the trailing track. In this case, the snapshot and the source cluster are on different tracks.

    
    
  • snapshot_schedule_identifier(impl Into<String>) / set_snapshot_schedule_identifier(Option<String>):
    required: false
    

    A unique identifier for the snapshot schedule.

    
    
  • number_of_nodes(i32) / set_number_of_nodes(Option<i32>):
    required: false
    

    The number of nodes specified when provisioning the restored cluster.

    
    
  • availability_zone_relocation(bool) / set_availability_zone_relocation(Option<bool>):
    required: false
    

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

    
    
  • aqua_configuration_status(AquaConfigurationStatus) / set_aqua_configuration_status(Option<AquaConfigurationStatus>):
    required: false
    

    This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).

    
    
  • default_iam_role_arn(impl Into<String>) / set_default_iam_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was last modified while it was restored from a snapshot.

    
    
  • reserved_node_id(impl Into<String>) / set_reserved_node_id(Option<String>):
    required: false
    

    The identifier of the target reserved node offering.

    
    
  • target_reserved_node_offering_id(impl Into<String>) / set_target_reserved_node_offering_id(Option<String>):
    required: false
    

    The identifier of the target reserved node offering.

    
    
  • encrypted(bool) / set_encrypted(Option<bool>):
    required: false
    

    Enables support for restoring an unencrypted snapshot to a cluster encrypted with Key Management Service (KMS) and a customer managed key.

    
    
  • manage_master_password(bool) / set_manage_master_password(Option<bool>):
    required: false
    

    If true, Amazon Redshift uses Secrets Manager to manage the restored cluster’s admin credentials. If ManageMasterPassword is false or not set, Amazon Redshift uses the admin credentials the cluster had at the time the snapshot was taken.

    
    
  • master_password_secret_kms_key_id(impl Into<String>) / set_master_password_secret_kms_key_id(Option<String>):
    required: false
    

    The ID of the Key Management Service (KMS) key used to encrypt and store the cluster’s admin credentials secret. You can only use this parameter if ManageMasterPassword is true.

    
    
  • ip_address_type(impl Into<String>) / set_ip_address_type(Option<String>):
    required: false
    

    The IP address type for the cluster. Possible values are ipv4 and dualstack.

    
    
  • multi_az(bool) / set_multi_az(Option<bool>):
    required: false
    

    If true, the snapshot will be restored to a cluster deployed in two Availability Zones.

    
    
• On success, responds with RestoreFromClusterSnapshotOutput with field(s):
  • cluster(Option<Cluster>):

    Describes a cluster.

• On failure, responds with SdkError<RestoreFromClusterSnapshotError>

impl Client

pub fn restore_table_from_cluster_snapshot( &self, ) -> RestoreTableFromClusterSnapshotFluentBuilder

Constructs a fluent builder for the RestoreTableFromClusterSnapshot operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

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

    
    
  • snapshot_identifier(impl Into<String>) / set_snapshot_identifier(Option<String>):
    required: true
    

    The identifier of the snapshot to restore the table from. This snapshot must have been created from the Amazon Redshift cluster specified by the ClusterIdentifier parameter.

    
    
  • source_database_name(impl Into<String>) / set_source_database_name(Option<String>):
    required: true
    

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

    
    
  • source_schema_name(impl Into<String>) / set_source_schema_name(Option<String>):
    required: false
    

    The name of the source schema that contains the table to restore from. If you do not specify a SourceSchemaName value, the default is public.

    
    
  • source_table_name(impl Into<String>) / set_source_table_name(Option<String>):
    required: true
    

    The name of the source table to restore from.

    
    
  • target_database_name(impl Into<String>) / set_target_database_name(Option<String>):
    required: false
    

    The name of the database to restore the table to.

    
    
  • target_schema_name(impl Into<String>) / set_target_schema_name(Option<String>):
    required: false
    

    The name of the schema to restore the table to.

    
    
  • new_table_name(impl Into<String>) / set_new_table_name(Option<String>):
    required: true
    

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

    
    
  • enable_case_sensitive_identifier(bool) / set_enable_case_sensitive_identifier(Option<bool>):
    required: false
    

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

    
    
• On success, responds with RestoreTableFromClusterSnapshotOutput with field(s):
  • table_restore_status(Option<TableRestoreStatus>):

    Describes the status of a RestoreTableFromClusterSnapshot operation.

• On failure, responds with SdkError<RestoreTableFromClusterSnapshotError>

impl Client

pub fn resume_cluster(&self) -> ResumeClusterFluentBuilder

Constructs a fluent builder for the ResumeCluster operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    The identifier of the cluster to be resumed.

    
    
• On success, responds with ResumeClusterOutput with field(s):
  • cluster(Option<Cluster>):

    Describes a cluster.

• On failure, responds with SdkError<ResumeClusterError>

impl Client

pub fn revoke_cluster_security_group_ingress( &self, ) -> RevokeClusterSecurityGroupIngressFluentBuilder

Constructs a fluent builder for the RevokeClusterSecurityGroupIngress operation.

• The fluent builder is configurable:
  • cluster_security_group_name(impl Into<String>) / set_cluster_security_group_name(Option<String>):
    required: true
    

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

    
    
  • cidrip(impl Into<String>) / set_cidrip(Option<String>):
    required: false
    

    The IP range for which to revoke access. This range must be a valid Classless Inter-Domain Routing (CIDR) block of IP addresses. If CIDRIP is specified, EC2SecurityGroupName and EC2SecurityGroupOwnerId cannot be provided.

    
    
  • ec2_security_group_name(impl Into<String>) / set_ec2_security_group_name(Option<String>):
    required: false
    

    The name of the EC2 Security Group whose access is to be revoked. If EC2SecurityGroupName is specified, EC2SecurityGroupOwnerId must also be provided and CIDRIP cannot be provided.

    
    
  • ec2_security_group_owner_id(impl Into<String>) / set_ec2_security_group_owner_id(Option<String>):
    required: false
    

    The Amazon Web Services account number of the owner of the security group specified in the EC2SecurityGroupName parameter. The Amazon Web Services access key ID is not an acceptable value. If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName must also be provided. and CIDRIP cannot be provided.

    Example: 111122223333

    
    
• On success, responds with RevokeClusterSecurityGroupIngressOutput with field(s):
  • cluster_security_group(Option<ClusterSecurityGroup>):

    Describes a security group.

• On failure, responds with SdkError<RevokeClusterSecurityGroupIngressError>

impl Client

pub fn revoke_endpoint_access(&self) -> RevokeEndpointAccessFluentBuilder

Constructs a fluent builder for the RevokeEndpointAccess operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: false
    

    The cluster to revoke access from.

    
    
  • account(impl Into<String>) / set_account(Option<String>):
    required: false
    

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

    
    
  • vpc_ids(impl Into<String>) / set_vpc_ids(Option<Vec::<String>>):
    required: false
    

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

    
    
  • force(bool) / set_force(Option<bool>):
    required: false
    

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

    
    
• On success, responds with RevokeEndpointAccessOutput with field(s):
  • grantor(Option<String>):

    The Amazon Web Services account ID of the cluster owner.

  • grantee(Option<String>):

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

  • cluster_identifier(Option<String>):

    The cluster identifier.

  • authorize_time(Option<DateTime>):

    The time (UTC) when the authorization was created.

  • cluster_status(Option<String>):

    The status of the cluster.

  • status(Option<AuthorizationStatus>):

    The status of the authorization action.

  • allowed_all_vpcs(Option<bool>):

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

  • allowed_vpcs(Option<Vec::<String>>):

    The VPCs allowed access to the cluster.

  • endpoint_count(Option<i32>):

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

• On failure, responds with SdkError<RevokeEndpointAccessError>

impl Client

pub fn revoke_snapshot_access(&self) -> RevokeSnapshotAccessFluentBuilder

Constructs a fluent builder for the RevokeSnapshotAccess operation.

• The fluent builder is configurable:
  • snapshot_identifier(impl Into<String>) / set_snapshot_identifier(Option<String>):
    required: false
    

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

    
    
  • snapshot_arn(impl Into<String>) / set_snapshot_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the snapshot associated with the message to revoke access.

    
    
  • snapshot_cluster_identifier(impl Into<String>) / set_snapshot_cluster_identifier(Option<String>):
    required: false
    

    The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

    
    
  • account_with_restore_access(impl Into<String>) / set_account_with_restore_access(Option<String>):
    required: true
    

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

    
    
• On success, responds with RevokeSnapshotAccessOutput with field(s):
  • snapshot(Option<Snapshot>):

    Describes a snapshot.

• On failure, responds with SdkError<RevokeSnapshotAccessError>

impl Client

pub fn rotate_encryption_key(&self) -> RotateEncryptionKeyFluentBuilder

Constructs a fluent builder for the RotateEncryptionKey operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    The unique identifier of the cluster that you want to rotate the encryption keys for.

    Constraints: Must be the name of valid cluster that has encryption enabled.

    
    
• On success, responds with RotateEncryptionKeyOutput with field(s):
  • cluster(Option<Cluster>):

    Describes a cluster.

• On failure, responds with SdkError<RotateEncryptionKeyError>

impl Client

pub fn update_partner_status(&self) -> UpdatePartnerStatusFluentBuilder

Constructs a fluent builder for the UpdatePartnerStatus operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The Amazon Web Services account ID that owns the cluster.

    
    
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    The cluster identifier of the cluster whose partner integration status is being updated.

    
    
  • database_name(impl Into<String>) / set_database_name(Option<String>):
    required: true
    

    The name of the database whose partner integration status is being updated.

    
    
  • partner_name(impl Into<String>) / set_partner_name(Option<String>):
    required: true
    

    The name of the partner whose integration status is being updated.

    
    
  • status(PartnerIntegrationStatus) / set_status(Option<PartnerIntegrationStatus>):
    required: true
    

    The value of the updated status.

    
    
  • status_message(impl Into<String>) / set_status_message(Option<String>):
    required: false
    

    The status message provided by the partner.

    
    
• On success, responds with UpdatePartnerStatusOutput with field(s):
  • database_name(Option<String>):

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

  • partner_name(Option<String>):

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

• On failure, responds with SdkError<UpdatePartnerStatusError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Waiters for Client

fn wait_until_cluster_available(&self) -> ClusterAvailableFluentBuilder

Wait for cluster_available

fn wait_until_cluster_deleted(&self) -> ClusterDeletedFluentBuilder

Wait for cluster_deleted

fn wait_until_cluster_restored(&self) -> ClusterRestoredFluentBuilder

Wait for cluster_restored

fn wait_until_snapshot_available(&self) -> SnapshotAvailableFluentBuilder

Wait for snapshot_available