Struct Client

pub struct Client { /* private fields */ }

Client for Amazon Neptune

Client for invoking operations on Amazon Neptune. Each operation on Amazon Neptune 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_neptune::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_neptune::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 AddRoleToDBCluster operation has a Client::add_role_to_db_cluster, 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.add_role_to_db_cluster()
    .db_cluster_identifier("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 add_role_to_db_cluster(&self) -> AddRoleToDBClusterFluentBuilder

Constructs a fluent builder for the AddRoleToDBCluster operation.

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

    The name of the DB cluster to associate the IAM role with.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the IAM role to associate with the Neptune DB cluster, for example arn:aws:iam::123456789012:role/NeptuneAccessRole.

    
    
  • feature_name(impl Into<String>) / set_feature_name(Option<String>):
    required: false
    

    The name of the feature for the Neptune DB cluster that the IAM role is to be associated with. For the list of supported feature names, see DBEngineVersion.

    
    
• On success, responds with AddRoleToDbClusterOutput
• On failure, responds with SdkError<AddRoleToDBClusterError>

impl Client

pub fn add_source_identifier_to_subscription( &self, ) -> AddSourceIdentifierToSubscriptionFluentBuilder

Constructs a fluent builder for the AddSourceIdentifierToSubscription operation.

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

    The name of the event notification subscription you want to add a source identifier to.

    
    
  • source_identifier(impl Into<String>) / set_source_identifier(Option<String>):
    required: true
    

    The identifier of the event source to be added.

    Constraints:

    • If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.

    • If the source type is a DB security group, a DBSecurityGroupName must be supplied.

    • If the source type is a DB parameter group, a DBParameterGroupName must be supplied.

    • If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.

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

    Contains the results of a successful invocation of the DescribeEventSubscriptions action.

• On failure, responds with SdkError<AddSourceIdentifierToSubscriptionError>

impl Client

pub fn add_tags_to_resource(&self) -> AddTagsToResourceFluentBuilder

Constructs a fluent builder for the AddTagsToResource operation.

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

    The Amazon Neptune resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).

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

    The tags to be assigned to the Amazon Neptune resource.

    
    
• On success, responds with AddTagsToResourceOutput
• On failure, responds with SdkError<AddTagsToResourceError>

impl Client

pub fn apply_pending_maintenance_action( &self, ) -> ApplyPendingMaintenanceActionFluentBuilder

Constructs a fluent builder for the ApplyPendingMaintenanceAction operation.

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

    The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).

    
    
  • apply_action(impl Into<String>) / set_apply_action(Option<String>):
    required: true
    

    The pending maintenance action to apply to this resource.

    Valid values: system-update, db-upgrade

    
    
  • opt_in_type(impl Into<String>) / set_opt_in_type(Option<String>):
    required: true
    

    A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type immediate can’t be undone.

    Valid values:

    • immediate - Apply the maintenance action immediately.

    • next-maintenance - Apply the maintenance action during the next maintenance window for the resource.

    • undo-opt-in - Cancel any existing next-maintenance opt-in requests.

    
    
• On success, responds with ApplyPendingMaintenanceActionOutput with field(s):
  • resource_pending_maintenance_actions(Option<ResourcePendingMaintenanceActions>):

    Describes the pending maintenance actions for a resource.

• On failure, responds with SdkError<ApplyPendingMaintenanceActionError>

impl Client

pub fn copy_db_cluster_parameter_group( &self, ) -> CopyDBClusterParameterGroupFluentBuilder

Constructs a fluent builder for the CopyDBClusterParameterGroup operation.

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

    The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).

    Constraints:

    • Must specify a valid DB cluster parameter group.

    • If the source DB cluster parameter group is in the same Amazon Region as the copy, specify a valid DB parameter group identifier, for example my-db-cluster-param-group, or a valid ARN.

    • If the source DB parameter group is in a different Amazon Region than the copy, specify a valid DB cluster parameter group ARN, for example arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1.

    
    
  • target_db_cluster_parameter_group_identifier(impl Into<String>) / set_target_db_cluster_parameter_group_identifier(Option<String>):
    required: true
    

    The identifier for the copied DB cluster parameter group.

    Constraints:

    • Cannot be null, empty, or blank

    • Must contain from 1 to 255 letters, numbers, or hyphens

    • First character must be a letter

    • Cannot end with a hyphen or contain two consecutive hyphens

    Example: my-cluster-param-group1

    
    
  • target_db_cluster_parameter_group_description(impl Into<String>) / set_target_db_cluster_parameter_group_description(Option<String>):
    required: true
    

    A description for the copied DB cluster parameter group.

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

    The tags to be assigned to the copied DB cluster parameter group.

    
    
• On success, responds with CopyDbClusterParameterGroupOutput with field(s):
  • db_cluster_parameter_group(Option<DbClusterParameterGroup>):

    Contains the details of an Amazon Neptune DB cluster parameter group.

    This data type is used as a response element in the DescribeDBClusterParameterGroups action.

• On failure, responds with SdkError<CopyDBClusterParameterGroupError>

impl Client

pub fn copy_db_cluster_snapshot(&self) -> CopyDBClusterSnapshotFluentBuilder

Constructs a fluent builder for the CopyDBClusterSnapshot operation.

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

    The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive.

    Constraints:

    • Must specify a valid system snapshot in the “available” state.

    • Specify a valid DB snapshot identifier.

    Example: my-cluster-snapshot1

    
    
  • target_db_cluster_snapshot_identifier(impl Into<String>) / set_target_db_cluster_snapshot_identifier(Option<String>):
    required: true
    

    The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.

    • First character must be a letter.

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

    Example: my-cluster-snapshot2

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

    The Amazon Amazon KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

    If you copy an encrypted DB cluster snapshot from your Amazon account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don’t specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.

    If you copy an encrypted DB cluster snapshot that is shared from another Amazon account, then you must specify a value for KmsKeyId.

    KMS encryption keys are specific to the Amazon Region that they are created in, and you can’t use encryption keys from one Amazon Region in another Amazon Region.

    You cannot encrypt an unencrypted DB cluster snapshot when you copy it. If you try to copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

    
    
  • pre_signed_url(impl Into<String>) / set_pre_signed_url(Option<String>):
    required: false
    

    Not currently supported.

    
    
  • copy_tags(bool) / set_copy_tags(Option<bool>):
    required: false
    

    True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false. The default is false.

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

    The tags to assign to the new DB cluster snapshot copy.

    
    
• On success, responds with CopyDbClusterSnapshotOutput with field(s):
  • db_cluster_snapshot(Option<DbClusterSnapshot>):

    Contains the details for an Amazon Neptune DB cluster snapshot

    This data type is used as a response element in the DescribeDBClusterSnapshots action.

• On failure, responds with SdkError<CopyDBClusterSnapshotError>

impl Client

pub fn copy_db_parameter_group(&self) -> CopyDBParameterGroupFluentBuilder

Constructs a fluent builder for the CopyDBParameterGroup operation.

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

    The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).

    Constraints:

    • Must specify a valid DB parameter group.

    • Must specify a valid DB parameter group identifier, for example my-db-param-group, or a valid ARN.

    
    
  • target_db_parameter_group_identifier(impl Into<String>) / set_target_db_parameter_group_identifier(Option<String>):
    required: true
    

    The identifier for the copied DB parameter group.

    Constraints:

    • Cannot be null, empty, or blank.

    • Must contain from 1 to 255 letters, numbers, or hyphens.

    • First character must be a letter.

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

    Example: my-db-parameter-group

    
    
  • target_db_parameter_group_description(impl Into<String>) / set_target_db_parameter_group_description(Option<String>):
    required: true
    

    A description for the copied DB parameter group.

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

    The tags to be assigned to the copied DB parameter group.

    
    
• On success, responds with CopyDbParameterGroupOutput with field(s):
  • db_parameter_group(Option<DbParameterGroup>):

    Contains the details of an Amazon Neptune DB parameter group.

    This data type is used as a response element in the DescribeDBParameterGroups action.

• On failure, responds with SdkError<CopyDBParameterGroupError>

impl Client

pub fn create_db_cluster(&self) -> CreateDBClusterFluentBuilder

Constructs a fluent builder for the CreateDBCluster operation.

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

    A list of EC2 Availability Zones that instances in the DB cluster can be created in.

    
    
  • backup_retention_period(i32) / set_backup_retention_period(Option<i32>):
    required: false
    

    The number of days for which automated backups are retained. You must specify a minimum value of 1.

    Default: 1

    Constraints:

    • Must be a value from 1 to 35

    
    
  • character_set_name(impl Into<String>) / set_character_set_name(Option<String>):
    required: false
    

    (Not supported by Neptune)

    
    
  • copy_tags_to_snapshot(bool) / set_copy_tags_to_snapshot(Option<bool>):
    required: false
    

    If set to true, tags are copied to any snapshot of the DB cluster that is created.

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

    The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Neptune will not create a database in the DB cluster you are creating.

    
    
  • db_cluster_identifier(impl Into<String>) / set_db_cluster_identifier(Option<String>):
    required: true
    

    The DB cluster identifier. This parameter is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.

    • First character must be a letter.

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

    Example: my-cluster1

    
    
  • db_cluster_parameter_group_name(impl Into<String>) / set_db_cluster_parameter_group_name(Option<String>):
    required: false
    

    The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default is used.

    Constraints:

    • If supplied, must match the name of an existing DBClusterParameterGroup.

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

    A list of EC2 VPC security groups to associate with this DB cluster.

    
    
  • db_subnet_group_name(impl Into<String>) / set_db_subnet_group_name(Option<String>):
    required: false
    

    A DB subnet group to associate with this DB cluster.

    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

    Example: mySubnetgroup

    
    
  • engine(impl Into<String>) / set_engine(Option<String>):
    required: true
    

    The name of the database engine to be used for this DB cluster.

    Valid Values: neptune

    
    
  • engine_version(impl Into<String>) / set_engine_version(Option<String>):
    required: false
    

    The version number of the database engine to use for the new DB cluster.

    Example: 1.2.1.0

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

    The port number on which the instances in the DB cluster accept connections.

    Default: 8182

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

    Not supported by Neptune.

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

    Not supported by Neptune.

    
    
  • option_group_name(impl Into<String>) / set_option_group_name(Option<String>):
    required: false
    

    (Not supported by Neptune)

    
    
  • preferred_backup_window(impl Into<String>) / set_preferred_backup_window(Option<String>):
    required: false
    

    The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

    The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region. To see the time blocks available, see Neptune Maintenance Window in the Amazon Neptune User Guide.

    Constraints:

    • Must be in the format hh24:mi-hh24:mi.

    • Must be in Universal Coordinated Time (UTC).

    • Must not conflict with the preferred maintenance window.

    • Must be at least 30 minutes.

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

    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

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

    The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region, occurring on a random day of the week. To see the time blocks available, see Neptune Maintenance Window in the Amazon Neptune User Guide.

    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

    Constraints: Minimum 30-minute window.

    
    
  • replication_source_identifier(impl Into<String>) / set_replication_source_identifier(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

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

    The tags to assign to the new DB cluster.

    
    
  • storage_encrypted(bool) / set_storage_encrypted(Option<bool>):
    required: false
    

    Specifies whether the DB cluster is encrypted.

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

    The Amazon KMS key identifier for an encrypted DB cluster.

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same Amazon account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

    If an encryption key is not specified in KmsKeyId:

    • If ReplicationSourceIdentifier identifies an encrypted source, then Amazon Neptune will use the encryption key used to encrypt the source. Otherwise, Amazon Neptune will use your default encryption key.

    • If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, then Amazon Neptune will use your default encryption key.

    Amazon KMS creates the default encryption key for your Amazon account. Your Amazon account has a different default encryption key for each Amazon Region.

    If you create a Read Replica of an encrypted DB cluster in another Amazon Region, you must set KmsKeyId to a KMS key ID that is valid in the destination Amazon Region. This key is used to encrypt the Read Replica in that Amazon Region.

    
    
  • pre_signed_url(impl Into<String>) / set_pre_signed_url(Option<String>):
    required: false
    

    This parameter is not currently supported.

    
    
  • enable_iam_database_authentication(bool) / set_enable_iam_database_authentication(Option<bool>):
    required: false
    

    If set to true, enables Amazon Identity and Access Management (IAM) authentication for the entire DB cluster (this cannot be set at an instance level).

    Default: false.

    
    
  • enable_cloudwatch_logs_exports(impl Into<String>) / set_enable_cloudwatch_logs_exports(Option<Vec::<String>>):
    required: false
    

    A list of the log types that this DB cluster should export to CloudWatch Logs. Valid log types are: audit (to publish audit logs) and slowquery (to publish slow-query logs). See Publishing Neptune logs to Amazon CloudWatch logs.

    
    
  • deletion_protection(bool) / set_deletion_protection(Option<bool>):
    required: false
    

    A value that indicates whether the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. By default, deletion protection is enabled.

    
    
  • serverless_v2_scaling_configuration(ServerlessV2ScalingConfiguration) / set_serverless_v2_scaling_configuration(Option<ServerlessV2ScalingConfiguration>):
    required: false
    

    Contains the scaling configuration of a Neptune Serverless DB cluster.

    For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

    
    
  • global_cluster_identifier(impl Into<String>) / set_global_cluster_identifier(Option<String>):
    required: false
    

    The ID of the Neptune global database to which this new DB cluster should be added.

    
    
  • storage_type(impl Into<String>) / set_storage_type(Option<String>):
    required: false
    

    The storage type for the new DB cluster.

    Valid Values:

    • standard   –   ( the default ) Configures cost-effective database storage for applications with moderate to small I/O usage. When set to standard, the storage type is not returned in the response.

    • iopt1   –   Enables I/O-Optimized storage that’s designed to meet the needs of I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O throughput.

      Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0.

    
    
• On success, responds with CreateDbClusterOutput with field(s):
  • db_cluster(Option<DbCluster>):

    Contains the details of an Amazon Neptune DB cluster.

    This data type is used as a response element in the DescribeDBClusters.

• On failure, responds with SdkError<CreateDBClusterError>

impl Client

pub fn create_db_cluster_endpoint(&self) -> CreateDBClusterEndpointFluentBuilder

Constructs a fluent builder for the CreateDBClusterEndpoint operation.

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

    The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

    
    
  • db_cluster_endpoint_identifier(impl Into<String>) / set_db_cluster_endpoint_identifier(Option<String>):
    required: true
    

    The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

    
    
  • endpoint_type(impl Into<String>) / set_endpoint_type(Option<String>):
    required: true
    

    The type of the endpoint. One of: READER, WRITER, ANY.

    
    
  • static_members(impl Into<String>) / set_static_members(Option<Vec::<String>>):
    required: false
    

    List of DB instance identifiers that are part of the custom endpoint group.

    
    
  • excluded_members(impl Into<String>) / set_excluded_members(Option<Vec::<String>>):
    required: false
    

    List of DB instance identifiers that aren’t part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

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

    The tags to be assigned to the Amazon Neptune resource.

    
    
• On success, responds with CreateDbClusterEndpointOutput with field(s):
  • db_cluster_endpoint_identifier(Option<String>):

    The identifier associated with the endpoint. This parameter is stored as a lowercase string.

  • db_cluster_identifier(Option<String>):

    The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

  • db_cluster_endpoint_resource_identifier(Option<String>):

    A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

  • endpoint(Option<String>):

    The DNS address of the endpoint.

  • status(Option<String>):

    The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that cannot be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.

  • endpoint_type(Option<String>):

    The type of the endpoint. One of: READER, WRITER, CUSTOM.

  • custom_endpoint_type(Option<String>):

    The type associated with a custom endpoint. One of: READER, WRITER, ANY.

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

    List of DB instance identifiers that are part of the custom endpoint group.

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

    List of DB instance identifiers that aren’t part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

  • db_cluster_endpoint_arn(Option<String>):

    The Amazon Resource Name (ARN) for the endpoint.

• On failure, responds with SdkError<CreateDBClusterEndpointError>

impl Client

pub fn create_db_cluster_parameter_group( &self, ) -> CreateDBClusterParameterGroupFluentBuilder

Constructs a fluent builder for the CreateDBClusterParameterGroup operation.

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

    The name of the DB cluster parameter group.

    Constraints:

    • Must match the name of an existing DBClusterParameterGroup.

    This value is stored as a lowercase string.

    
    
  • db_parameter_group_family(impl Into<String>) / set_db_parameter_group_family(Option<String>):
    required: true
    

    The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.

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

    The description for the DB cluster parameter group.

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

    The tags to be assigned to the new DB cluster parameter group.

    
    
• On success, responds with CreateDbClusterParameterGroupOutput with field(s):
  • db_cluster_parameter_group(Option<DbClusterParameterGroup>):

    Contains the details of an Amazon Neptune DB cluster parameter group.

    This data type is used as a response element in the DescribeDBClusterParameterGroups action.

• On failure, responds with SdkError<CreateDBClusterParameterGroupError>

impl Client

pub fn create_db_cluster_snapshot(&self) -> CreateDBClusterSnapshotFluentBuilder

Constructs a fluent builder for the CreateDBClusterSnapshot operation.

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

    The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.

    • First character must be a letter.

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

    Example: my-cluster1-snapshot1

    
    
  • db_cluster_identifier(impl Into<String>) / set_db_cluster_identifier(Option<String>):
    required: true
    

    The identifier of the DB cluster to create a snapshot for. This parameter is not case-sensitive.

    Constraints:

    • Must match the identifier of an existing DBCluster.

    Example: my-cluster1

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

    The tags to be assigned to the DB cluster snapshot.

    
    
• On success, responds with CreateDbClusterSnapshotOutput with field(s):
  • db_cluster_snapshot(Option<DbClusterSnapshot>):

    Contains the details for an Amazon Neptune DB cluster snapshot

    This data type is used as a response element in the DescribeDBClusterSnapshots action.

• On failure, responds with SdkError<CreateDBClusterSnapshotError>

impl Client

pub fn create_db_instance(&self) -> CreateDBInstanceFluentBuilder

Constructs a fluent builder for the CreateDBInstance operation.

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

    Not supported.

    
    
  • db_instance_identifier(impl Into<String>) / set_db_instance_identifier(Option<String>):
    required: true
    

    The DB instance identifier. This parameter is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.

    • First character must be a letter.

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

    Example: mydbinstance

    
    
  • allocated_storage(i32) / set_allocated_storage(Option<i32>):
    required: false
    

    Not supported by Neptune.

    
    
  • db_instance_class(impl Into<String>) / set_db_instance_class(Option<String>):
    required: true
    

    The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all Amazon Regions.

    
    
  • engine(impl Into<String>) / set_engine(Option<String>):
    required: true
    

    The name of the database engine to be used for this instance.

    Valid Values: neptune

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

    Not supported by Neptune.

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

    Not supported by Neptune.

    
    
  • db_security_groups(impl Into<String>) / set_db_security_groups(Option<Vec::<String>>):
    required: false
    

    A list of DB security groups to associate with this DB instance.

    Default: The default DB security group for the database engine.

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

    A list of EC2 VPC security groups to associate with this DB instance.

    Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see CreateDBCluster.

    Default: The default EC2 VPC security group for the DB subnet group’s VPC.

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

    The EC2 Availability Zone that the DB instance is created in

    Default: A random, system-chosen Availability Zone in the endpoint’s Amazon Region.

    Example: us-east-1d

    Constraint: The AvailabilityZone parameter can’t be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same Amazon Region as the current endpoint.

    
    
  • db_subnet_group_name(impl Into<String>) / set_db_subnet_group_name(Option<String>):
    required: false
    

    A DB subnet group to associate with this DB instance.

    If there is no DB subnet group, then it is a non-VPC DB instance.

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

    The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

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

    The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region, occurring on a random day of the week.

    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

    Constraints: Minimum 30-minute window.

    
    
  • db_parameter_group_name(impl Into<String>) / set_db_parameter_group_name(Option<String>):
    required: false
    

    The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine is used.

    Constraints:

    • Must be 1 to 255 letters, numbers, or hyphens.

    • First character must be a letter

    • Cannot end with a hyphen or contain two consecutive hyphens

    
    
  • backup_retention_period(i32) / set_backup_retention_period(Option<i32>):
    required: false
    

    The number of days for which automated backups are retained.

    Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see CreateDBCluster.

    Default: 1

    Constraints:

    • Must be a value from 0 to 35

    • Cannot be set to 0 if the DB instance is a source to Read Replicas

    
    
  • preferred_backup_window(impl Into<String>) / set_preferred_backup_window(Option<String>):
    required: false
    

    The daily time range during which automated backups are created.

    Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see CreateDBCluster.

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

    The port number on which the database accepts connections.

    Not applicable. The port is managed by the DB cluster. For more information, see CreateDBCluster.

    Default: 8182

    Type: Integer

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

    Specifies if the DB instance is a Multi-AZ deployment. You can’t set the AvailabilityZone parameter if the MultiAZ parameter is set to true.

    
    
  • engine_version(impl Into<String>) / set_engine_version(Option<String>):
    required: false
    

    The version number of the database engine to use. Currently, setting this parameter has no effect.

    
    
  • auto_minor_version_upgrade(bool) / set_auto_minor_version_upgrade(Option<bool>):
    required: false
    

    Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.

    Default: true

    
    
  • license_model(impl Into<String>) / set_license_model(Option<String>):
    required: false
    

    License model information for this DB instance.

    Valid values: license-included | bring-your-own-license | general-public-license

    
    
  • iops(i32) / set_iops(Option<i32>):
    required: false
    

    The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

    
    
  • option_group_name(impl Into<String>) / set_option_group_name(Option<String>):
    required: false
    

    (Not supported by Neptune)

    
    
  • character_set_name(impl Into<String>) / set_character_set_name(Option<String>):
    required: false
    

    (Not supported by Neptune)

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

    This flag should no longer be used.

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

    The tags to assign to the new instance.

    
    
  • db_cluster_identifier(impl Into<String>) / set_db_cluster_identifier(Option<String>):
    required: true
    

    The identifier of the DB cluster that the instance will belong to.

    For information on creating a DB cluster, see CreateDBCluster.

    Type: String

    
    
  • storage_type(impl Into<String>) / set_storage_type(Option<String>):
    required: false
    

    Not applicable. In Neptune the storage type is managed at the DB Cluster level.

    
    
  • tde_credential_arn(impl Into<String>) / set_tde_credential_arn(Option<String>):
    required: false
    

    The ARN from the key store with which to associate the instance for TDE encryption.

    
    
  • tde_credential_password(impl Into<String>) / set_tde_credential_password(Option<String>):
    required: false
    

    The password for the given ARN from the key store in order to access the device.

    
    
  • storage_encrypted(bool) / set_storage_encrypted(Option<bool>):
    required: false
    

    Specifies whether the DB instance is encrypted.

    Not applicable. The encryption for DB instances is managed by the DB cluster. For more information, see CreateDBCluster.

    Default: false

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

    The Amazon KMS key identifier for an encrypted DB instance.

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same Amazon account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

    Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.

    If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon Neptune will use your default encryption key. Amazon KMS creates the default encryption key for your Amazon account. Your Amazon account has a different default encryption key for each Amazon Region.

    
    
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: false
    

    Specify the Active Directory Domain to create the instance in.

    
    
  • copy_tags_to_snapshot(bool) / set_copy_tags_to_snapshot(Option<bool>):
    required: false
    

    True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.

    
    
  • monitoring_interval(i32) / set_monitoring_interval(Option<i32>):
    required: false
    

    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

    If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

    Valid Values: 0, 1, 5, 10, 15, 30, 60

    
    
  • monitoring_role_arn(impl Into<String>) / set_monitoring_role_arn(Option<String>):
    required: false
    

    The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess.

    If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

    
    
  • domain_iam_role_name(impl Into<String>) / set_domain_iam_role_name(Option<String>):
    required: false
    

    Specify the name of the IAM role to be used when making API calls to the Directory Service.

    
    
  • promotion_tier(i32) / set_promotion_tier(Option<i32>):
    required: false
    

    A value that specifies the order in which an Read Replica is promoted to the primary instance after a failure of the existing primary instance.

    Default: 1

    Valid Values: 0 - 15

    
    
  • timezone(impl Into<String>) / set_timezone(Option<String>):
    required: false
    

    The time zone of the DB instance.

    
    
  • enable_iam_database_authentication(bool) / set_enable_iam_database_authentication(Option<bool>):
    required: false
    

    Not supported by Neptune (ignored).

    
    
  • enable_performance_insights(bool) / set_enable_performance_insights(Option<bool>):
    required: false
    

    (Not supported by Neptune)

    
    
  • performance_insights_kms_key_id(impl Into<String>) / set_performance_insights_kms_key_id(Option<String>):
    required: false
    

    (Not supported by Neptune)

    
    
  • enable_cloudwatch_logs_exports(impl Into<String>) / set_enable_cloudwatch_logs_exports(Option<Vec::<String>>):
    required: false
    

    The list of log types that need to be enabled for exporting to CloudWatch Logs.

    
    
  • deletion_protection(bool) / set_deletion_protection(Option<bool>):
    required: false
    

    A value that indicates whether the DB instance has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. By default, deletion protection is disabled. See Deleting a DB Instance.

    DB instances in a DB cluster can be deleted even when deletion protection is enabled in their parent DB cluster.

    
    
• On success, responds with CreateDbInstanceOutput with field(s):
  • db_instance(Option<DbInstance>):

    Contains the details of an Amazon Neptune DB instance.

    This data type is used as a response element in the DescribeDBInstances action.

• On failure, responds with SdkError<CreateDBInstanceError>

impl Client

pub fn create_db_parameter_group(&self) -> CreateDBParameterGroupFluentBuilder

Constructs a fluent builder for the CreateDBParameterGroup operation.

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

    The name of the DB parameter group.

    Constraints:

    • Must be 1 to 255 letters, numbers, or hyphens.

    • First character must be a letter

    • Cannot end with a hyphen or contain two consecutive hyphens

    This value is stored as a lowercase string.

    
    
  • db_parameter_group_family(impl Into<String>) / set_db_parameter_group_family(Option<String>):
    required: true
    

    The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

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

    The description for the DB parameter group.

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

    The tags to be assigned to the new DB parameter group.

    
    
• On success, responds with CreateDbParameterGroupOutput with field(s):
  • db_parameter_group(Option<DbParameterGroup>):

    Contains the details of an Amazon Neptune DB parameter group.

    This data type is used as a response element in the DescribeDBParameterGroups action.

• On failure, responds with SdkError<CreateDBParameterGroupError>

impl Client

pub fn create_db_subnet_group(&self) -> CreateDBSubnetGroupFluentBuilder

Constructs a fluent builder for the CreateDBSubnetGroup operation.

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

    The name for the DB subnet group. This value is stored as a lowercase string.

    Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.

    Example: mySubnetgroup

    
    
  • db_subnet_group_description(impl Into<String>) / set_db_subnet_group_description(Option<String>):
    required: true
    

    The description for the DB subnet group.

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

    The EC2 Subnet IDs for the DB subnet group.

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

    The tags to be assigned to the new DB subnet group.

    
    
• On success, responds with CreateDbSubnetGroupOutput with field(s):
  • db_subnet_group(Option<DbSubnetGroup>):

    Contains the details of an Amazon Neptune DB subnet group.

    This data type is used as a response element in the DescribeDBSubnetGroups action.

• On failure, responds with SdkError<CreateDBSubnetGroupError>

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

    Constraints: The name must be less than 255 characters.

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

    The Amazon Resource Name (ARN) of the SNS topic created for event notification. 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 is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.

    Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot

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

    A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType by using the DescribeEventCategories action.

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

    The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can’t end with a hyphen or contain two consecutive hyphens.

    Constraints:

    • If SourceIds are supplied, SourceType must also be provided.

    • If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.

    • If the source type is a DB security group, a DBSecurityGroupName must be supplied.

    • If the source type is a DB parameter group, a DBParameterGroupName must be supplied.

    • If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.

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

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

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

    The tags to be applied to the new event subscription.

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

    Contains the results of a successful invocation of the DescribeEventSubscriptions action.

• On failure, responds with SdkError<CreateEventSubscriptionError>

impl Client

pub fn create_global_cluster(&self) -> CreateGlobalClusterFluentBuilder

Constructs a fluent builder for the CreateGlobalCluster operation.

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

    The cluster identifier of the new global database cluster.

    
    
  • source_db_cluster_identifier(impl Into<String>) / set_source_db_cluster_identifier(Option<String>):
    required: false
    

    (Optional) The Amazon Resource Name (ARN) of an existing Neptune DB cluster to use as the primary cluster of the new global database.

    
    
  • engine(impl Into<String>) / set_engine(Option<String>):
    required: false
    

    The name of the database engine to be used in the global database.

    Valid values: neptune

    
    
  • engine_version(impl Into<String>) / set_engine_version(Option<String>):
    required: false
    

    The Neptune engine version to be used by the global database.

    Valid values: 1.2.0.0 or above.

    
    
  • deletion_protection(bool) / set_deletion_protection(Option<bool>):
    required: false
    

    The deletion protection setting for the new global database. The global database can’t be deleted when deletion protection is enabled.

    
    
  • storage_encrypted(bool) / set_storage_encrypted(Option<bool>):
    required: false
    

    The storage encryption setting for the new global database cluster.

    
    
• On success, responds with CreateGlobalClusterOutput with field(s):
  • global_cluster(Option<GlobalCluster>):

    Contains the details of an Amazon Neptune global database.

    This data type is used as a response element for the CreateGlobalCluster, DescribeGlobalClusters, ModifyGlobalCluster, DeleteGlobalCluster, FailoverGlobalCluster, and RemoveFromGlobalCluster actions.

• On failure, responds with SdkError<CreateGlobalClusterError>

impl Client

pub fn delete_db_cluster(&self) -> DeleteDBClusterFluentBuilder

Constructs a fluent builder for the DeleteDBCluster operation.

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

    The DB cluster identifier for the DB cluster to be deleted. This parameter isn’t case-sensitive.

    Constraints:

    • Must match an existing DBClusterIdentifier.

    
    
  • skip_final_snapshot(bool) / set_skip_final_snapshot(Option<bool>):
    required: false
    

    Determines whether a final DB cluster snapshot is created before the DB cluster is deleted. If true is specified, no DB cluster snapshot is created. If false is specified, a DB cluster snapshot is created before the DB cluster is deleted.

    You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is false.

    Default: false

    
    
  • final_db_snapshot_identifier(impl Into<String>) / set_final_db_snapshot_identifier(Option<String>):
    required: false
    

    The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is set to false.

    Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

    Constraints:

    • Must be 1 to 255 letters, numbers, or hyphens.

    • First character must be a letter

    • Cannot end with a hyphen or contain two consecutive hyphens

    
    
• On success, responds with DeleteDbClusterOutput with field(s):
  • db_cluster(Option<DbCluster>):

    Contains the details of an Amazon Neptune DB cluster.

    This data type is used as a response element in the DescribeDBClusters.

• On failure, responds with SdkError<DeleteDBClusterError>

impl Client

pub fn delete_db_cluster_endpoint(&self) -> DeleteDBClusterEndpointFluentBuilder

Constructs a fluent builder for the DeleteDBClusterEndpoint operation.

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

    The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.

    
    
• On success, responds with DeleteDbClusterEndpointOutput with field(s):
  • db_cluster_endpoint_identifier(Option<String>):

    The identifier associated with the endpoint. This parameter is stored as a lowercase string.

  • db_cluster_identifier(Option<String>):

    The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

  • db_cluster_endpoint_resource_identifier(Option<String>):

    A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

  • endpoint(Option<String>):

    The DNS address of the endpoint.

  • status(Option<String>):

    The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that cannot be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.

  • endpoint_type(Option<String>):

    The type of the endpoint. One of: READER, WRITER, CUSTOM.

  • custom_endpoint_type(Option<String>):

    The type associated with a custom endpoint. One of: READER, WRITER, ANY.

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

    List of DB instance identifiers that are part of the custom endpoint group.

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

    List of DB instance identifiers that aren’t part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

  • db_cluster_endpoint_arn(Option<String>):

    The Amazon Resource Name (ARN) for the endpoint.

• On failure, responds with SdkError<DeleteDBClusterEndpointError>

impl Client

pub fn delete_db_cluster_parameter_group( &self, ) -> DeleteDBClusterParameterGroupFluentBuilder

Constructs a fluent builder for the DeleteDBClusterParameterGroup operation.

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

    The name of the DB cluster parameter group.

    Constraints:

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

    • You can’t delete a default DB cluster parameter group.

    • Cannot be associated with any DB clusters.

    
    
• On success, responds with DeleteDbClusterParameterGroupOutput
• On failure, responds with SdkError<DeleteDBClusterParameterGroupError>

impl Client

pub fn delete_db_cluster_snapshot(&self) -> DeleteDBClusterSnapshotFluentBuilder

Constructs a fluent builder for the DeleteDBClusterSnapshot operation.

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

    The identifier of the DB cluster snapshot to delete.

    Constraints: Must be the name of an existing DB cluster snapshot in the available state.

    
    
• On success, responds with DeleteDbClusterSnapshotOutput with field(s):
  • db_cluster_snapshot(Option<DbClusterSnapshot>):

    Contains the details for an Amazon Neptune DB cluster snapshot

    This data type is used as a response element in the DescribeDBClusterSnapshots action.

• On failure, responds with SdkError<DeleteDBClusterSnapshotError>

impl Client

pub fn delete_db_instance(&self) -> DeleteDBInstanceFluentBuilder

Constructs a fluent builder for the DeleteDBInstance operation.

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

    The DB instance identifier for the DB instance to be deleted. This parameter isn’t case-sensitive.

    Constraints:

    • Must match the name of an existing DB instance.

    
    
  • skip_final_snapshot(bool) / set_skip_final_snapshot(Option<bool>):
    required: false
    

    Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted.

    Note that when a DB instance is in a failure state and has a status of ‘failed’, ‘incompatible-restore’, or ‘incompatible-network’, it can only be deleted when the SkipFinalSnapshot parameter is set to “true”.

    Specify true when deleting a Read Replica.

    The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.

    Default: false

    
    
  • final_db_snapshot_identifier(impl Into<String>) / set_final_db_snapshot_identifier(Option<String>):
    required: false
    

    The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.

    Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

    Constraints:

    • Must be 1 to 255 letters or numbers.

    • First character must be a letter

    • Cannot end with a hyphen or contain two consecutive hyphens

    • Cannot be specified when deleting a Read Replica.

    
    
• On success, responds with DeleteDbInstanceOutput with field(s):
  • db_instance(Option<DbInstance>):

    Contains the details of an Amazon Neptune DB instance.

    This data type is used as a response element in the DescribeDBInstances action.

• On failure, responds with SdkError<DeleteDBInstanceError>

impl Client

pub fn delete_db_parameter_group(&self) -> DeleteDBParameterGroupFluentBuilder

Constructs a fluent builder for the DeleteDBParameterGroup operation.

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

    The name of the DB parameter group.

    Constraints:

    • Must be the name of an existing DB parameter group

    • You can’t delete a default DB parameter group

    • Cannot be associated with any DB instances

    
    
• On success, responds with DeleteDbParameterGroupOutput
• On failure, responds with SdkError<DeleteDBParameterGroupError>

impl Client

pub fn delete_db_subnet_group(&self) -> DeleteDBSubnetGroupFluentBuilder

Constructs a fluent builder for the DeleteDBSubnetGroup operation.

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

    The name of the database subnet group to delete.

    You can’t delete the default subnet group.

    Constraints:

    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

    Example: mySubnetgroup

    
    
• On success, responds with DeleteDbSubnetGroupOutput
• On failure, responds with SdkError<DeleteDBSubnetGroupError>

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 event notification subscription you want to delete.

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

    Contains the results of a successful invocation of the DescribeEventSubscriptions action.

• On failure, responds with SdkError<DeleteEventSubscriptionError>

impl Client

pub fn delete_global_cluster(&self) -> DeleteGlobalClusterFluentBuilder

Constructs a fluent builder for the DeleteGlobalCluster operation.

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

    The cluster identifier of the global database cluster being deleted.

    
    
• On success, responds with DeleteGlobalClusterOutput with field(s):
  • global_cluster(Option<GlobalCluster>):

    Contains the details of an Amazon Neptune global database.

    This data type is used as a response element for the CreateGlobalCluster, DescribeGlobalClusters, ModifyGlobalCluster, DeleteGlobalCluster, FailoverGlobalCluster, and RemoveFromGlobalCluster actions.

• On failure, responds with SdkError<DeleteGlobalClusterError>

impl Client

pub fn describe_db_cluster_endpoints( &self, ) -> DescribeDBClusterEndpointsFluentBuilder

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

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

    The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

    
    
  • db_cluster_endpoint_identifier(impl Into<String>) / set_db_cluster_endpoint_identifier(Option<String>):
    required: false
    

    The identifier of the endpoint to describe. This parameter is stored as a lowercase string.

    
    
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format Name=endpoint_type,Values=endpoint_type1,endpoint_type2,…. Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any. Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, inactive, modifying.

    
    
  • 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 you can retrieve the remaining results.

    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 DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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

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

  • db_cluster_endpoints(Option<Vec::<DbClusterEndpoint>>):

    Contains the details of the endpoints associated with the cluster and matching any filter conditions.

• On failure, responds with SdkError<DescribeDBClusterEndpointsError>

impl Client

pub fn describe_db_cluster_parameter_groups( &self, ) -> DescribeDBClusterParameterGroupsFluentBuilder

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

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

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

    Constraints:

    • If supplied, must match the name of an existing DBClusterParameterGroup.

    
    
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    This parameter is not currently supported.

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

    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 DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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

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

  • db_cluster_parameter_groups(Option<Vec::<DbClusterParameterGroup>>):

    A list of DB cluster parameter groups.

• On failure, responds with SdkError<DescribeDBClusterParameterGroupsError>

impl Client

pub fn describe_db_cluster_parameters( &self, ) -> DescribeDBClusterParametersFluentBuilder

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

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

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

    Constraints:

    • If supplied, must match the name of an existing DBClusterParameterGroup.

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

    A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

    
    
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    This parameter is not currently supported.

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

    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 DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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

    Provides a list of parameters for the DB cluster parameter group.

  • marker(Option<String>):

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

• On failure, responds with SdkError<DescribeDBClusterParametersError>

impl Client

pub fn describe_db_cluster_snapshot_attributes( &self, ) -> DescribeDBClusterSnapshotAttributesFluentBuilder

Constructs a fluent builder for the DescribeDBClusterSnapshotAttributes operation.

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

    The identifier for the DB cluster snapshot to describe the attributes for.

    
    
• On success, responds with DescribeDbClusterSnapshotAttributesOutput with field(s):
  • db_cluster_snapshot_attributes_result(Option<DbClusterSnapshotAttributesResult>):

    Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action.

    Manual DB cluster snapshot attributes are used to authorize other Amazon accounts to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

• On failure, responds with SdkError<DescribeDBClusterSnapshotAttributesError>

impl Client

pub fn describe_db_cluster_snapshots( &self, ) -> DescribeDBClusterSnapshotsFluentBuilder

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

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

    The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can’t be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter is not case-sensitive.

    Constraints:

    • If supplied, must match the identifier of an existing DBCluster.

    
    
  • db_cluster_snapshot_identifier(impl Into<String>) / set_db_cluster_snapshot_identifier(Option<String>):
    required: false
    

    A specific DB cluster snapshot identifier to describe. This parameter can’t be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

    Constraints:

    • If supplied, must match the identifier of an existing DBClusterSnapshot.

    • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

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

    The type of DB cluster snapshots to be returned. You can specify one of the following values:

    • automated - Return all DB cluster snapshots that have been automatically taken by Amazon Neptune for my Amazon account.

    • manual - Return all DB cluster snapshots that have been taken by my Amazon account.

    • shared - Return all manual DB cluster snapshots that have been shared to my Amazon account.

    • public - Return all DB cluster snapshots that have been marked as public.

    If you don’t specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public DB cluster snapshots with these results by setting the IncludePublic parameter to true.

    The IncludeShared and IncludePublic parameters don’t apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn’t apply when SnapshotType is set to shared. The IncludeShared parameter doesn’t apply when SnapshotType is set to public.

    
    
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    This parameter is not currently supported.

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

    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 DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    
    
  • include_shared(bool) / set_include_shared(Option<bool>):
    required: false
    

    True to include shared manual DB cluster snapshots from other Amazon accounts that this Amazon account has been given permission to copy or restore, and otherwise false. The default is false.

    You can give an Amazon account permission to restore a manual DB cluster snapshot from another Amazon account by the ModifyDBClusterSnapshotAttribute API action.

    
    
  • include_public(bool) / set_include_public(Option<bool>):
    required: false
    

    True to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon account, and otherwise false. The default is false. The default is false.

    You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

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

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

  • db_cluster_snapshots(Option<Vec::<DbClusterSnapshot>>):

    Provides a list of DB cluster snapshots for the user.

• On failure, responds with SdkError<DescribeDBClusterSnapshotsError>

impl Client

pub fn describe_db_clusters(&self) -> DescribeDBClustersFluentBuilder

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

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

    The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn’t case-sensitive.

    Constraints:

    • If supplied, must match an existing DBClusterIdentifier.

    
    
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    A filter that specifies one or more DB clusters to describe.

    Supported filters:

    • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.

    • engine - Accepts an engine name (such as neptune), and restricts the results list to DB clusters created by that engine.

    For example, to invoke this API from the Amazon CLI and filter so that only Neptune DB clusters are returned, you could use the following command:

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

    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 DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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

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

  • db_clusters(Option<Vec::<DbCluster>>):

    Contains a list of DB clusters for the user.

• On failure, responds with SdkError<DescribeDBClustersError>

impl Client

pub fn describe_db_engine_versions( &self, ) -> DescribeDBEngineVersionsFluentBuilder

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

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

    The database engine to return.

    
    
  • engine_version(impl Into<String>) / set_engine_version(Option<String>):
    required: false
    

    The database engine version to return.

    Example: 5.1.49

    
    
  • db_parameter_group_family(impl Into<String>) / set_db_parameter_group_family(Option<String>):
    required: false
    

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

    Constraints:

    • If supplied, must match an existing DBParameterGroupFamily.

    
    
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    Not currently supported.

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

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

    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 request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    
    
  • default_only(bool) / set_default_only(Option<bool>):
    required: false
    

    Indicates that only the default version of the specified engine or engine and major version combination is returned.

    
    
  • list_supported_character_sets(bool) / set_list_supported_character_sets(Option<bool>):
    required: false
    

    If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

    
    
  • list_supported_timezones(bool) / set_list_supported_timezones(Option<bool>):
    required: false
    

    If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

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

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

  • db_engine_versions(Option<Vec::<DbEngineVersion>>):

    A list of DBEngineVersion elements.

• On failure, responds with SdkError<DescribeDBEngineVersionsError>

impl Client

pub fn describe_db_instances(&self) -> DescribeDBInstancesFluentBuilder

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

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

    The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn’t case-sensitive.

    Constraints:

    • If supplied, must match the identifier of an existing DBInstance.

    
    
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    A filter that specifies one or more DB instances to describe.

    Supported filters:

    • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB clusters identified by these ARNs.

    • engine - Accepts an engine name (such as neptune), and restricts the results list to DB instances created by that engine.

    For example, to invoke this API from the Amazon CLI and filter so that only Neptune DB instances are returned, you could use the following command:

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

    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 DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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

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

  • db_instances(Option<Vec::<DbInstance>>):

    A list of DBInstance instances.

• On failure, responds with SdkError<DescribeDBInstancesError>

impl Client

pub fn describe_db_parameter_groups( &self, ) -> DescribeDBParameterGroupsFluentBuilder

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

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

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

    Constraints:

    • If supplied, must match the name of an existing DBClusterParameterGroup.

    
    
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    This parameter is not currently supported.

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

    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 DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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

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

  • db_parameter_groups(Option<Vec::<DbParameterGroup>>):

    A list of DBParameterGroup instances.

• On failure, responds with SdkError<DescribeDBParameterGroupsError>

impl Client

pub fn describe_db_parameters(&self) -> DescribeDBParametersFluentBuilder

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

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

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

    Constraints:

    • If supplied, must match the name of an existing DBParameterGroup.

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

    The parameter types to return.

    Default: All parameter types returned

    Valid Values: user | system | engine-default

    
    
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    This parameter is not currently supported.

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

    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 DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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

    A list of Parameter values.

  • marker(Option<String>):

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

• On failure, responds with SdkError<DescribeDBParametersError>

impl Client

pub fn describe_db_subnet_groups(&self) -> DescribeDBSubnetGroupsFluentBuilder

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

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

    The name of the DB subnet group to return details for.

    
    
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    This parameter is not currently supported.

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

    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 DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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

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

  • db_subnet_groups(Option<Vec::<DbSubnetGroup>>):

    A list of DBSubnetGroup instances.

• On failure, responds with SdkError<DescribeDBSubnetGroupsError>

impl Client

pub fn describe_engine_default_cluster_parameters( &self, ) -> DescribeEngineDefaultClusterParametersFluentBuilder

Constructs a fluent builder for the DescribeEngineDefaultClusterParameters operation.

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

    The name of the DB cluster parameter group family to return engine parameter information for.

    
    
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    This parameter is not currently supported.

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

    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 DescribeEngineDefaultClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    
    
• On success, responds with DescribeEngineDefaultClusterParametersOutput with field(s):
  • engine_defaults(Option<EngineDefaults>):

    Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

• On failure, responds with SdkError<DescribeEngineDefaultClusterParametersError>

impl Client

pub fn describe_engine_default_parameters( &self, ) -> DescribeEngineDefaultParametersFluentBuilder

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

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

    The name of the DB parameter group family.

    
    
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    Not currently supported.

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

    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 DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    
    
• On success, responds with DescribeEngineDefaultParametersOutput with field(s):
  • engine_defaults(Option<EngineDefaults>):

    Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

• On failure, responds with SdkError<DescribeEngineDefaultParametersError>

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 type of source that is generating the events.

    Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

    
    
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    This parameter is not currently supported.

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

    A list of EventCategoriesMap data types.

• 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 event notification subscription you want to describe.

    
    
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    This parameter is not currently supported.

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

    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 DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

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

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

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

    A list of EventSubscriptions data types.

• 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 are returned. If not specified, then all sources are included in the response.

    Constraints:

    • If SourceIdentifier is supplied, SourceType must also be provided.

    • If the source type is DBInstance, then a DBInstanceIdentifier must be supplied.

    • If the source type is DBSecurityGroup, a DBSecurityGroupName must be supplied.

    • If the source type is DBParameterGroup, a DBParameterGroupName must be supplied.

    • If the source type is DBSnapshot, a DBSnapshotIdentifier must be supplied.

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

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

    
    
  • 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 to retrieve events for.

    Default: 60

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

    A list of event categories that trigger notifications for a event notification subscription.

    
    
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    This parameter is not currently supported.

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

    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 DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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

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

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

    A list of Event instances.

• On failure, responds with SdkError<DescribeEventsError>

impl Client

pub fn describe_global_clusters(&self) -> DescribeGlobalClustersFluentBuilder

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

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

    The user-supplied DB cluster identifier. If this parameter is specified, only information about the specified DB cluster is returned. This parameter is not case-sensitive.

    Constraints: If supplied, must match an existing DB cluster identifier.

    
    
  • 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 marker token is included in the response that you can use to retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

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

    (Optional) A pagination token returned by a previous call to DescribeGlobalClusters. If this parameter is specified, the response will only include records beyond the marker, up to the number specified by MaxRecords.

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

    A pagination token. If this parameter is returned in the response, more records are available, which can be retrieved by one or more additional calls to DescribeGlobalClusters.

  • global_clusters(Option<Vec::<GlobalCluster>>):

    The list of global clusters and instances returned by this request.

• On failure, responds with SdkError<DescribeGlobalClustersError>

impl Client

pub fn describe_orderable_db_instance_options( &self, ) -> DescribeOrderableDBInstanceOptionsFluentBuilder

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

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

    The name of the engine to retrieve DB instance options for.

    
    
  • engine_version(impl Into<String>) / set_engine_version(Option<String>):
    required: false
    

    The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.

    
    
  • db_instance_class(impl Into<String>) / set_db_instance_class(Option<String>):
    required: false
    

    The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

    
    
  • license_model(impl Into<String>) / set_license_model(Option<String>):
    required: false
    

    The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.

    
    
  • vpc(bool) / set_vpc(Option<bool>):
    required: false
    

    The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

    
    
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    This parameter is not currently supported.

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

    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 DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

    
    
• On success, responds with DescribeOrderableDbInstanceOptionsOutput with field(s):
  • orderable_db_instance_options(Option<Vec::<OrderableDbInstanceOption>>):

    An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.

  • marker(Option<String>):

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

• On failure, responds with SdkError<DescribeOrderableDBInstanceOptionsError>

impl Client

pub fn describe_pending_maintenance_actions( &self, ) -> DescribePendingMaintenanceActionsFluentBuilder

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

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

    The ARN of a resource to return pending maintenance actions for.

    
    
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    A filter that specifies one or more resources to return pending maintenance actions for.

    Supported filters:

    • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include pending maintenance actions for the DB clusters identified by these ARNs.

    • db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list will only include pending maintenance actions for the DB instances identified by these ARNs.

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

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

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

    Default: 100

    Constraints: Minimum 20, maximum 100.

    
    
• On success, responds with DescribePendingMaintenanceActionsOutput with field(s):
  • pending_maintenance_actions(Option<Vec::<ResourcePendingMaintenanceActions>>):

    A list of the pending maintenance actions for the resource.

  • marker(Option<String>):

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

• On failure, responds with SdkError<DescribePendingMaintenanceActionsError>

impl Client

pub fn describe_valid_db_instance_modifications( &self, ) -> DescribeValidDBInstanceModificationsFluentBuilder

Constructs a fluent builder for the DescribeValidDBInstanceModifications operation.

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

    The customer identifier or the ARN of your DB instance.

    
    
• On success, responds with DescribeValidDbInstanceModificationsOutput with field(s):
  • valid_db_instance_modifications_message(Option<ValidDbInstanceModificationsMessage>):

    Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action. You can use this information when you call ModifyDBInstance.

• On failure, responds with SdkError<DescribeValidDBInstanceModificationsError>

impl Client

pub fn failover_db_cluster(&self) -> FailoverDBClusterFluentBuilder

Constructs a fluent builder for the FailoverDBCluster operation.

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

    A DB cluster identifier to force a failover for. This parameter is not case-sensitive.

    Constraints:

    • Must match the identifier of an existing DBCluster.

    
    
  • target_db_instance_identifier(impl Into<String>) / set_target_db_instance_identifier(Option<String>):
    required: false
    

    The name of the instance to promote to the primary instance.

    You must specify the instance identifier for an Read Replica in the DB cluster. For example, mydbcluster-replica1.

    
    
• On success, responds with FailoverDbClusterOutput with field(s):
  • db_cluster(Option<DbCluster>):

    Contains the details of an Amazon Neptune DB cluster.

    This data type is used as a response element in the DescribeDBClusters.

• On failure, responds with SdkError<FailoverDBClusterError>

impl Client

pub fn failover_global_cluster(&self) -> FailoverGlobalClusterFluentBuilder

Constructs a fluent builder for the FailoverGlobalCluster operation.

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

    Identifier of the Neptune global database that should be failed over. The identifier is the unique key assigned by the user when the Neptune global database was created. In other words, it’s the name of the global database that you want to fail over.

    Constraints: Must match the identifier of an existing Neptune global database.

    
    
  • target_db_cluster_identifier(impl Into<String>) / set_target_db_cluster_identifier(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the secondary Neptune DB cluster that you want to promote to primary for the global database.

    
    
  • allow_data_loss(bool) / set_allow_data_loss(Option<bool>):
    required: false
    

    Specifies whether to allow data loss for this global database cluster operation. Allowing data loss triggers a global failover operation.

    If you don’t specify AllowDataLoss, the global database cluster operation defaults to a switchover.

    Constraints:Can’t be specified together with the Switchover parameter.

    
    
  • switchover(bool) / set_switchover(Option<bool>):
    required: false
    

    Specifies whether to switch over this global database cluster.

    Constraints:Can’t be specified together with the AllowDataLoss parameter.

    
    
• On success, responds with FailoverGlobalClusterOutput with field(s):
  • global_cluster(Option<GlobalCluster>):

    Contains the details of an Amazon Neptune global database.

    This data type is used as a response element for the CreateGlobalCluster, DescribeGlobalClusters, ModifyGlobalCluster, DeleteGlobalCluster, FailoverGlobalCluster, and RemoveFromGlobalCluster actions.

• On failure, responds with SdkError<FailoverGlobalClusterError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

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

    The Amazon Neptune resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).

    
    
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    This parameter is not currently supported.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tag_list(Option<Vec::<Tag>>):

    List of tags returned by the ListTagsForResource operation.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn modify_db_cluster(&self) -> ModifyDBClusterFluentBuilder

Constructs a fluent builder for the ModifyDBCluster operation.

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

    The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.

    Constraints:

    • Must match the identifier of an existing DBCluster.

    
    
  • new_db_cluster_identifier(impl Into<String>) / set_new_db_cluster_identifier(Option<String>):
    required: false
    

    The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens

    • The first character must be a letter

    • Cannot end with a hyphen or contain two consecutive hyphens

    Example: my-cluster2

    
    
  • apply_immediately(bool) / set_apply_immediately(Option<bool>):
    required: false
    

    A value that specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is set to false, changes to the DB cluster are applied during the next maintenance window.

    The ApplyImmediately parameter only affects NewDBClusterIdentifier values. If you set the ApplyImmediately parameter value to false, then changes to NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

    Default: false

    
    
  • backup_retention_period(i32) / set_backup_retention_period(Option<i32>):
    required: false
    

    The number of days for which automated backups are retained. You must specify a minimum value of 1.

    Default: 1

    Constraints:

    • Must be a value from 1 to 35

    
    
  • db_cluster_parameter_group_name(impl Into<String>) / set_db_cluster_parameter_group_name(Option<String>):
    required: false
    

    The name of the DB cluster parameter group to use for the DB cluster.

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

    A list of VPC security groups that the DB cluster will belong to.

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

    The port number on which the DB cluster accepts connections.

    Constraints: Value must be 1150-65535

    Default: The same port as the original DB cluster.

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

    Not supported by Neptune.

    
    
  • option_group_name(impl Into<String>) / set_option_group_name(Option<String>):
    required: false
    

    Not supported by Neptune.

    
    
  • preferred_backup_window(impl Into<String>) / set_preferred_backup_window(Option<String>):
    required: false
    

    The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

    The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region.

    Constraints:

    • Must be in the format hh24:mi-hh24:mi.

    • Must be in Universal Coordinated Time (UTC).

    • Must not conflict with the preferred maintenance window.

    • Must be at least 30 minutes.

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

    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

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

    The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region, occurring on a random day of the week.

    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

    Constraints: Minimum 30-minute window.

    
    
  • enable_iam_database_authentication(bool) / set_enable_iam_database_authentication(Option<bool>):
    required: false
    

    True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

    Default: false

    
    
  • cloudwatch_logs_export_configuration(CloudwatchLogsExportConfiguration) / set_cloudwatch_logs_export_configuration(Option<CloudwatchLogsExportConfiguration>):
    required: false
    

    The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster. See Using the CLI to publish Neptune audit logs to CloudWatch Logs.

    
    
  • engine_version(impl Into<String>) / set_engine_version(Option<String>):
    required: false
    

    The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true.

    For a list of valid engine versions, see Engine Releases for Amazon Neptune, or call DescribeDBEngineVersions.

    
    
  • allow_major_version_upgrade(bool) / set_allow_major_version_upgrade(Option<bool>):
    required: false
    

    A value that indicates whether upgrades between different major versions are allowed.

    Constraints: You must set the allow-major-version-upgrade flag when providing an EngineVersion parameter that uses a different major version than the DB cluster’s current version.

    
    
  • db_instance_parameter_group_name(impl Into<String>) / set_db_instance_parameter_group_name(Option<String>):
    required: false
    

    The name of the DB parameter group to apply to all instances of the DB cluster.

    When you apply a parameter group using DBInstanceParameterGroupName, parameter changes aren’t applied during the next maintenance window but instead are applied immediately.

    Default: The existing name setting

    Constraints:

    • The DB parameter group must be in the same DB parameter group family as the target DB cluster version.

    • The DBInstanceParameterGroupName parameter is only valid in combination with the AllowMajorVersionUpgrade parameter.

    
    
  • deletion_protection(bool) / set_deletion_protection(Option<bool>):
    required: false
    

    A value that indicates whether the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. By default, deletion protection is disabled.

    
    
  • copy_tags_to_snapshot(bool) / set_copy_tags_to_snapshot(Option<bool>):
    required: false
    

    If set to true, tags are copied to any snapshot of the DB cluster that is created.

    
    
  • serverless_v2_scaling_configuration(ServerlessV2ScalingConfiguration) / set_serverless_v2_scaling_configuration(Option<ServerlessV2ScalingConfiguration>):
    required: false
    

    Contains the scaling configuration of a Neptune Serverless DB cluster.

    For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

    
    
  • storage_type(impl Into<String>) / set_storage_type(Option<String>):
    required: false
    

    The storage type to associate with the DB cluster.

    Valid Values:

    • standard   –   ( the default ) Configures cost-effective database storage for applications with moderate to small I/O usage.

    • iopt1   –   Enables I/O-Optimized storage that’s designed to meet the needs of I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O throughput.

      Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0.

    
    
• On success, responds with ModifyDbClusterOutput with field(s):
  • db_cluster(Option<DbCluster>):

    Contains the details of an Amazon Neptune DB cluster.

    This data type is used as a response element in the DescribeDBClusters.

• On failure, responds with SdkError<ModifyDBClusterError>

impl Client

pub fn modify_db_cluster_endpoint(&self) -> ModifyDBClusterEndpointFluentBuilder

Constructs a fluent builder for the ModifyDBClusterEndpoint operation.

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

    The identifier of the endpoint to modify. This parameter is stored as a lowercase string.

    
    
  • endpoint_type(impl Into<String>) / set_endpoint_type(Option<String>):
    required: false
    

    The type of the endpoint. One of: READER, WRITER, ANY.

    
    
  • static_members(impl Into<String>) / set_static_members(Option<Vec::<String>>):
    required: false
    

    List of DB instance identifiers that are part of the custom endpoint group.

    
    
  • excluded_members(impl Into<String>) / set_excluded_members(Option<Vec::<String>>):
    required: false
    

    List of DB instance identifiers that aren’t part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

    
    
• On success, responds with ModifyDbClusterEndpointOutput with field(s):
  • db_cluster_endpoint_identifier(Option<String>):

    The identifier associated with the endpoint. This parameter is stored as a lowercase string.

  • db_cluster_identifier(Option<String>):

    The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

  • db_cluster_endpoint_resource_identifier(Option<String>):

    A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

  • endpoint(Option<String>):

    The DNS address of the endpoint.

  • status(Option<String>):

    The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that cannot be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.

  • endpoint_type(Option<String>):

    The type of the endpoint. One of: READER, WRITER, CUSTOM.

  • custom_endpoint_type(Option<String>):

    The type associated with a custom endpoint. One of: READER, WRITER, ANY.

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

    List of DB instance identifiers that are part of the custom endpoint group.

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

    List of DB instance identifiers that aren’t part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

  • db_cluster_endpoint_arn(Option<String>):

    The Amazon Resource Name (ARN) for the endpoint.

• On failure, responds with SdkError<ModifyDBClusterEndpointError>

impl Client

pub fn modify_db_cluster_parameter_group( &self, ) -> ModifyDBClusterParameterGroupFluentBuilder

Constructs a fluent builder for the ModifyDBClusterParameterGroup operation.

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

    The name of the DB cluster parameter group to modify.

    
    
  • parameters(Parameter) / set_parameters(Option<Vec::<Parameter>>):
    required: true
    

    A list of parameters in the DB cluster parameter group to modify.

    
    
• On success, responds with ModifyDbClusterParameterGroupOutput with field(s):
  • db_cluster_parameter_group_name(Option<String>):

    The name of the DB cluster parameter group.

    Constraints:

    • Must be 1 to 255 letters or numbers.

    • First character must be a letter

    • Cannot end with a hyphen or contain two consecutive hyphens

    This value is stored as a lowercase string.

• On failure, responds with SdkError<ModifyDBClusterParameterGroupError>

impl Client

pub fn modify_db_cluster_snapshot_attribute( &self, ) -> ModifyDBClusterSnapshotAttributeFluentBuilder

Constructs a fluent builder for the ModifyDBClusterSnapshotAttribute operation.

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

    The identifier for the DB cluster snapshot to modify the attributes for.

    
    
  • attribute_name(impl Into<String>) / set_attribute_name(Option<String>):
    required: true
    

    The name of the DB cluster snapshot attribute to modify.

    To manage authorization for other Amazon accounts to copy or restore a manual DB cluster snapshot, set this value to restore.

    
    
  • values_to_add(impl Into<String>) / set_values_to_add(Option<Vec::<String>>):
    required: false
    

    A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.

    To authorize other Amazon accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon account IDs, or all to make the manual DB cluster snapshot restorable by any Amazon account. Do not add the all value for any manual DB cluster snapshots that contain private information that you don’t want available to all Amazon accounts.

    
    
  • values_to_remove(impl Into<String>) / set_values_to_remove(Option<Vec::<String>>):
    required: false
    

    A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.

    To remove authorization for other Amazon accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon account identifiers, or all to remove authorization for any Amazon account to copy or restore the DB cluster snapshot. If you specify all, an Amazon account whose account ID is explicitly added to the restore attribute can still copy or restore a manual DB cluster snapshot.

    
    
• On success, responds with ModifyDbClusterSnapshotAttributeOutput with field(s):
  • db_cluster_snapshot_attributes_result(Option<DbClusterSnapshotAttributesResult>):

    Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action.

    Manual DB cluster snapshot attributes are used to authorize other Amazon accounts to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

• On failure, responds with SdkError<ModifyDBClusterSnapshotAttributeError>

impl Client

pub fn modify_db_instance(&self) -> ModifyDBInstanceFluentBuilder

Constructs a fluent builder for the ModifyDBInstance operation.

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

    The DB instance identifier. This value is stored as a lowercase string.

    Constraints:

    • Must match the identifier of an existing DBInstance.

    
    
  • allocated_storage(i32) / set_allocated_storage(Option<i32>):
    required: false
    

    Not supported by Neptune.

    
    
  • db_instance_class(impl Into<String>) / set_db_instance_class(Option<String>):
    required: false
    

    The new compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all Amazon Regions.

    If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

    Default: Uses existing setting

    
    
  • db_subnet_group_name(impl Into<String>) / set_db_subnet_group_name(Option<String>):
    required: false
    

    The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC.

    Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you specify true for the ApplyImmediately parameter.

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    Example: mySubnetGroup

    
    
  • db_security_groups(impl Into<String>) / set_db_security_groups(Option<Vec::<String>>):
    required: false
    

    A list of DB security groups to authorize on this DB instance. Changing this setting doesn’t result in an outage and the change is asynchronously applied as soon as possible.

    Constraints:

    • If supplied, must match existing DBSecurityGroups.

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

    A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

    Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.

    Constraints:

    • If supplied, must match existing VpcSecurityGroupIds.

    
    
  • apply_immediately(bool) / set_apply_immediately(Option<bool>):
    required: false
    

    Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.

    If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance, or the next failure reboot.

    Default: false

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

    Not supported by Neptune.

    
    
  • db_parameter_group_name(impl Into<String>) / set_db_parameter_group_name(Option<String>):
    required: false
    

    The name of the DB parameter group to apply to the DB instance. Changing this setting doesn’t result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.

    Default: Uses existing setting

    Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

    
    
  • backup_retention_period(i32) / set_backup_retention_period(Option<i32>):
    required: false
    

    Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

    Default: Uses existing setting

    
    
  • preferred_backup_window(impl Into<String>) / set_preferred_backup_window(Option<String>):
    required: false
    

    The daily time range during which automated backups are created if automated backups are enabled.

    Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

    Constraints:

    • Must be in the format hh24:mi-hh24:mi

    • Must be in Universal Time Coordinated (UTC)

    • Must not conflict with the preferred maintenance window

    • Must be at least 30 minutes

    
    
  • 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, which might result in an outage. Changing this parameter doesn’t result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

    Default: Uses existing setting

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

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

    Constraints: Must be at least 30 minutes

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

    Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter doesn’t result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

    
    
  • engine_version(impl Into<String>) / set_engine_version(Option<String>):
    required: false
    

    The version number of the database engine to upgrade to. Currently, setting this parameter has no effect. To upgrade your database engine to the most recent release, use the ApplyPendingMaintenanceAction API.

    
    
  • allow_major_version_upgrade(bool) / set_allow_major_version_upgrade(Option<bool>):
    required: false
    

    Indicates that major version upgrades are allowed. Changing this parameter doesn’t result in an outage and the change is asynchronously applied as soon as possible.

    
    
  • auto_minor_version_upgrade(bool) / set_auto_minor_version_upgrade(Option<bool>):
    required: false
    

    Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window. Changing this parameter doesn’t result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and Neptune has enabled auto patching for that engine version.

    
    
  • license_model(impl Into<String>) / set_license_model(Option<String>):
    required: false
    

    Not supported by Neptune.

    
    
  • iops(i32) / set_iops(Option<i32>):
    required: false
    

    The new Provisioned IOPS (I/O operations per second) value for the instance.

    Changing this setting doesn’t result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

    Default: Uses existing setting

    
    
  • option_group_name(impl Into<String>) / set_option_group_name(Option<String>):
    required: false
    

    (Not supported by Neptune)

    
    
  • new_db_instance_identifier(impl Into<String>) / set_new_db_instance_identifier(Option<String>):
    required: false
    

    The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set Apply Immediately to true, or will occur during the next maintenance window if Apply Immediately to false. This value is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.

    • The first character must be a letter.

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

    Example: mydbinstance

    
    
  • storage_type(impl Into<String>) / set_storage_type(Option<String>):
    required: false
    

    Not applicable. In Neptune the storage type is managed at the DB Cluster level.

    
    
  • tde_credential_arn(impl Into<String>) / set_tde_credential_arn(Option<String>):
    required: false
    

    The ARN from the key store with which to associate the instance for TDE encryption.

    
    
  • tde_credential_password(impl Into<String>) / set_tde_credential_password(Option<String>):
    required: false
    

    The password for the given ARN from the key store in order to access the device.

    
    
  • ca_certificate_identifier(impl Into<String>) / set_ca_certificate_identifier(Option<String>):
    required: false
    

    Indicates the certificate that needs to be associated with the instance.

    
    
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: false
    

    Not supported.

    
    
  • copy_tags_to_snapshot(bool) / set_copy_tags_to_snapshot(Option<bool>):
    required: false
    

    True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.

    
    
  • monitoring_interval(i32) / set_monitoring_interval(Option<i32>):
    required: false
    

    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

    If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

    Valid Values: 0, 1, 5, 10, 15, 30, 60

    
    
  • db_port_number(i32) / set_db_port_number(Option<i32>):
    required: false
    

    The port number on which the database accepts connections.

    The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.

    Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter.

    Default: 8182

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

    This flag should no longer be used.

    
    
  • monitoring_role_arn(impl Into<String>) / set_monitoring_role_arn(Option<String>):
    required: false
    

    The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess.

    If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

    
    
  • domain_iam_role_name(impl Into<String>) / set_domain_iam_role_name(Option<String>):
    required: false
    

    Not supported

    
    
  • promotion_tier(i32) / set_promotion_tier(Option<i32>):
    required: false
    

    A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

    Default: 1

    Valid Values: 0 - 15

    
    
  • enable_iam_database_authentication(bool) / set_enable_iam_database_authentication(Option<bool>):
    required: false
    

    True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

    You can enable IAM database authentication for the following database engines

    Not applicable. Mapping Amazon IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster.

    Default: false

    
    
  • enable_performance_insights(bool) / set_enable_performance_insights(Option<bool>):
    required: false
    

    (Not supported by Neptune)

    
    
  • performance_insights_kms_key_id(impl Into<String>) / set_performance_insights_kms_key_id(Option<String>):
    required: false
    

    (Not supported by Neptune)

    
    
  • cloudwatch_logs_export_configuration(CloudwatchLogsExportConfiguration) / set_cloudwatch_logs_export_configuration(Option<CloudwatchLogsExportConfiguration>):
    required: false
    

    The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.

    
    
  • deletion_protection(bool) / set_deletion_protection(Option<bool>):
    required: false
    

    A value that indicates whether the DB instance has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. By default, deletion protection is disabled. See Deleting a DB Instance.

    
    
• On success, responds with ModifyDbInstanceOutput with field(s):
  • db_instance(Option<DbInstance>):

    Contains the details of an Amazon Neptune DB instance.

    This data type is used as a response element in the DescribeDBInstances action.

• On failure, responds with SdkError<ModifyDBInstanceError>

impl Client

pub fn modify_db_parameter_group(&self) -> ModifyDBParameterGroupFluentBuilder

Constructs a fluent builder for the ModifyDBParameterGroup operation.

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

    The name of the DB parameter group.

    Constraints:

    • If supplied, must match the name of an existing DBParameterGroup.

    
    
  • parameters(Parameter) / set_parameters(Option<Vec::<Parameter>>):
    required: true
    

    An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be modified in a single request.

    Valid Values (for the application method): immediate | pending-reboot

    You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover.

    
    
• On success, responds with ModifyDbParameterGroupOutput with field(s):
  • db_parameter_group_name(Option<String>):

    Provides the name of the DB parameter group.

• On failure, responds with SdkError<ModifyDBParameterGroupError>

impl Client

pub fn modify_db_subnet_group(&self) -> ModifyDBSubnetGroupFluentBuilder

Constructs a fluent builder for the ModifyDBSubnetGroup operation.

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

    The name for the DB subnet group. This value is stored as a lowercase string. You can’t modify the default subnet group.

    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

    Example: mySubnetgroup

    
    
  • db_subnet_group_description(impl Into<String>) / set_db_subnet_group_description(Option<String>):
    required: false
    

    The description for the DB subnet group.

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

    The EC2 subnet IDs for the DB subnet group.

    
    
• On success, responds with ModifyDbSubnetGroupOutput with field(s):
  • db_subnet_group(Option<DbSubnetGroup>):

    Contains the details of an Amazon Neptune DB subnet group.

    This data type is used as a response element in the DescribeDBSubnetGroups action.

• On failure, responds with SdkError<ModifyDBSubnetGroupError>

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 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 created for event notification. 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 is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.

    Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

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

    A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType by using the DescribeEventCategories action.

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

    A Boolean value; set to true to activate the subscription.

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

    Contains the results of a successful invocation of the DescribeEventSubscriptions action.

• On failure, responds with SdkError<ModifyEventSubscriptionError>

impl Client

pub fn modify_global_cluster(&self) -> ModifyGlobalClusterFluentBuilder

Constructs a fluent builder for the ModifyGlobalCluster operation.

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

    The DB cluster identifier for the global cluster being modified. This parameter is not case-sensitive.

    Constraints: Must match the identifier of an existing global database cluster.

    
    
  • new_global_cluster_identifier(impl Into<String>) / set_new_global_cluster_identifier(Option<String>):
    required: false
    

    A new cluster identifier to assign to the global database. This value is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.

    • The first character must be a letter.

    • Can’t end with a hyphen or contain two consecutive hyphens

    Example: my-cluster2

    
    
  • deletion_protection(bool) / set_deletion_protection(Option<bool>):
    required: false
    

    Indicates whether the global database has deletion protection enabled. The global database cannot be deleted when deletion protection is enabled.

    
    
  • engine_version(impl Into<String>) / set_engine_version(Option<String>):
    required: false
    

    The version number of the database engine to which you want to upgrade. Changing this parameter will result in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.

    To list all of the available Neptune engine versions, use the following command:

    
    
  • allow_major_version_upgrade(bool) / set_allow_major_version_upgrade(Option<bool>):
    required: false
    

    A value that indicates whether major version upgrades are allowed.

    Constraints: You must allow major version upgrades if you specify a value for the EngineVersion parameter that is a different major version than the DB cluster’s current version.

    If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version, so you will need to apply any custom parameter groups after completing the upgrade.

    
    
• On success, responds with ModifyGlobalClusterOutput with field(s):
  • global_cluster(Option<GlobalCluster>):

    Contains the details of an Amazon Neptune global database.

    This data type is used as a response element for the CreateGlobalCluster, DescribeGlobalClusters, ModifyGlobalCluster, DeleteGlobalCluster, FailoverGlobalCluster, and RemoveFromGlobalCluster actions.

• On failure, responds with SdkError<ModifyGlobalClusterError>

impl Client

pub fn promote_read_replica_db_cluster( &self, ) -> PromoteReadReplicaDBClusterFluentBuilder

Constructs a fluent builder for the PromoteReadReplicaDBCluster operation.

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

    Not supported.

    
    
• On success, responds with PromoteReadReplicaDbClusterOutput with field(s):
  • db_cluster(Option<DbCluster>):

    Contains the details of an Amazon Neptune DB cluster.

    This data type is used as a response element in the DescribeDBClusters.

• On failure, responds with SdkError<PromoteReadReplicaDBClusterError>

impl Client

pub fn reboot_db_instance(&self) -> RebootDBInstanceFluentBuilder

Constructs a fluent builder for the RebootDBInstance operation.

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

    The DB instance identifier. This parameter is stored as a lowercase string.

    Constraints:

    • Must match the identifier of an existing DBInstance.

    
    
  • force_failover(bool) / set_force_failover(Option<bool>):
    required: false
    

    When true, the reboot is conducted through a MultiAZ failover.

    Constraint: You can’t specify true if the instance is not configured for MultiAZ.

    
    
• On success, responds with RebootDbInstanceOutput with field(s):
  • db_instance(Option<DbInstance>):

    Contains the details of an Amazon Neptune DB instance.

    This data type is used as a response element in the DescribeDBInstances action.

• On failure, responds with SdkError<RebootDBInstanceError>

impl Client

pub fn remove_from_global_cluster(&self) -> RemoveFromGlobalClusterFluentBuilder

Constructs a fluent builder for the RemoveFromGlobalCluster operation.

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

    The identifier of the Neptune global database from which to detach the specified Neptune DB cluster.

    
    
  • db_cluster_identifier(impl Into<String>) / set_db_cluster_identifier(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) identifying the cluster to be detached from the Neptune global database cluster.

    
    
• On success, responds with RemoveFromGlobalClusterOutput with field(s):
  • global_cluster(Option<GlobalCluster>):

    Contains the details of an Amazon Neptune global database.

    This data type is used as a response element for the CreateGlobalCluster, DescribeGlobalClusters, ModifyGlobalCluster, DeleteGlobalCluster, FailoverGlobalCluster, and RemoveFromGlobalCluster actions.

• On failure, responds with SdkError<RemoveFromGlobalClusterError>

impl Client

pub fn remove_role_from_db_cluster( &self, ) -> RemoveRoleFromDBClusterFluentBuilder

Constructs a fluent builder for the RemoveRoleFromDBCluster operation.

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

    The name of the DB cluster to disassociate the IAM role from.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB cluster, for example arn:aws:iam::123456789012:role/NeptuneAccessRole.

    
    
  • feature_name(impl Into<String>) / set_feature_name(Option<String>):
    required: false
    

    The name of the feature for the DB cluster that the IAM role is to be disassociated from. For the list of supported feature names, see DescribeDBEngineVersions.

    
    
• On success, responds with RemoveRoleFromDbClusterOutput
• On failure, responds with SdkError<RemoveRoleFromDBClusterError>

impl Client

pub fn remove_source_identifier_from_subscription( &self, ) -> RemoveSourceIdentifierFromSubscriptionFluentBuilder

Constructs a fluent builder for the RemoveSourceIdentifierFromSubscription operation.

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

    The name of the event notification subscription you want to remove a source identifier from.

    
    
  • source_identifier(impl Into<String>) / set_source_identifier(Option<String>):
    required: true
    

    The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.

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

    Contains the results of a successful invocation of the DescribeEventSubscriptions action.

• On failure, responds with SdkError<RemoveSourceIdentifierFromSubscriptionError>

impl Client

pub fn remove_tags_from_resource(&self) -> RemoveTagsFromResourceFluentBuilder

Constructs a fluent builder for the RemoveTagsFromResource operation.

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

    The Amazon Neptune resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).

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

    The tag key (name) of the tag to be removed.

    
    
• On success, responds with RemoveTagsFromResourceOutput
• On failure, responds with SdkError<RemoveTagsFromResourceError>

impl Client

pub fn reset_db_cluster_parameter_group( &self, ) -> ResetDBClusterParameterGroupFluentBuilder

Constructs a fluent builder for the ResetDBClusterParameterGroup operation.

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

    The name of the DB cluster parameter group to reset.

    
    
  • reset_all_parameters(bool) / set_reset_all_parameters(Option<bool>):
    required: false
    

    A value that is set to true to reset all parameters in the DB cluster parameter group to their default values, and false otherwise. You can’t use this parameter if there is a list of parameter names specified for the Parameters parameter.

    
    
  • parameters(Parameter) / set_parameters(Option<Vec::<Parameter>>):
    required: false
    

    A list of parameter names in the DB cluster parameter group to reset to the default values. You can’t use this parameter if the ResetAllParameters parameter is set to true.

    
    
• On success, responds with ResetDbClusterParameterGroupOutput with field(s):
  • db_cluster_parameter_group_name(Option<String>):

    The name of the DB cluster parameter group.

    Constraints:

    • Must be 1 to 255 letters or numbers.

    • First character must be a letter

    • Cannot end with a hyphen or contain two consecutive hyphens

    This value is stored as a lowercase string.

• On failure, responds with SdkError<ResetDBClusterParameterGroupError>

impl Client

pub fn reset_db_parameter_group(&self) -> ResetDBParameterGroupFluentBuilder

Constructs a fluent builder for the ResetDBParameterGroup operation.

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

    The name of the DB parameter group.

    Constraints:

    • Must match the name of an existing DBParameterGroup.

    
    
  • reset_all_parameters(bool) / set_reset_all_parameters(Option<bool>):
    required: false
    

    Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.

    Default: true

    
    
  • parameters(Parameter) / set_parameters(Option<Vec::<Parameter>>):
    required: false
    

    To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

    Valid Values (for Apply method): pending-reboot

    
    
• On success, responds with ResetDbParameterGroupOutput with field(s):
  • db_parameter_group_name(Option<String>):

    Provides the name of the DB parameter group.

• On failure, responds with SdkError<ResetDBParameterGroupError>

impl Client

pub fn restore_db_cluster_from_snapshot( &self, ) -> RestoreDBClusterFromSnapshotFluentBuilder

Constructs a fluent builder for the RestoreDBClusterFromSnapshot operation.

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

    Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.

    
    
  • db_cluster_identifier(impl Into<String>) / set_db_cluster_identifier(Option<String>):
    required: true
    

    The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn’t case-sensitive.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens

    • First character must be a letter

    • Cannot end with a hyphen or contain two consecutive hyphens

    Example: my-snapshot-id

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

    The identifier for the DB snapshot or DB cluster snapshot to restore from.

    You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

    Constraints:

    • Must match the identifier of an existing Snapshot.

    
    
  • engine(impl Into<String>) / set_engine(Option<String>):
    required: true
    

    The database engine to use for the new DB cluster.

    Default: The same as source

    Constraint: Must be compatible with the engine of the source

    
    
  • engine_version(impl Into<String>) / set_engine_version(Option<String>):
    required: false
    

    The version of the database engine to use for the new DB cluster.

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

    The port number on which the new DB cluster accepts connections.

    Constraints: Value must be 1150-65535

    Default: The same port as the original DB cluster.

    
    
  • db_subnet_group_name(impl Into<String>) / set_db_subnet_group_name(Option<String>):
    required: false
    

    The name of the DB subnet group to use for the new DB cluster.

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    Example: mySubnetgroup

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

    Not supported.

    
    
  • option_group_name(impl Into<String>) / set_option_group_name(Option<String>):
    required: false
    

    (Not supported by Neptune)

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

    A list of VPC security groups that the new DB cluster will belong to.

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

    The tags to be assigned to the restored DB cluster.

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

    The Amazon KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same Amazon account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

    If you do not specify a value for the KmsKeyId parameter, then the following will occur:

    • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.

    • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

    
    
  • enable_iam_database_authentication(bool) / set_enable_iam_database_authentication(Option<bool>):
    required: false
    

    True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

    Default: false

    
    
  • enable_cloudwatch_logs_exports(impl Into<String>) / set_enable_cloudwatch_logs_exports(Option<Vec::<String>>):
    required: false
    

    The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.

    
    
  • db_cluster_parameter_group_name(impl Into<String>) / set_db_cluster_parameter_group_name(Option<String>):
    required: false
    

    The name of the DB cluster parameter group to associate with the new DB cluster.

    Constraints:

    • If supplied, must match the name of an existing DBClusterParameterGroup.

    
    
  • deletion_protection(bool) / set_deletion_protection(Option<bool>):
    required: false
    

    A value that indicates whether the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. By default, deletion protection is disabled.

    
    
  • copy_tags_to_snapshot(bool) / set_copy_tags_to_snapshot(Option<bool>):
    required: false
    

    If set to true, tags are copied to any snapshot of the restored DB cluster that is created.

    
    
  • serverless_v2_scaling_configuration(ServerlessV2ScalingConfiguration) / set_serverless_v2_scaling_configuration(Option<ServerlessV2ScalingConfiguration>):
    required: false
    

    Contains the scaling configuration of a Neptune Serverless DB cluster.

    For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

    
    
  • storage_type(impl Into<String>) / set_storage_type(Option<String>):
    required: false
    

    Specifies the storage type to be associated with the DB cluster.

    Valid values: standard, iopt1

    Default: standard

    
    
• On success, responds with RestoreDbClusterFromSnapshotOutput with field(s):
  • db_cluster(Option<DbCluster>):

    Contains the details of an Amazon Neptune DB cluster.

    This data type is used as a response element in the DescribeDBClusters.

• On failure, responds with SdkError<RestoreDBClusterFromSnapshotError>

impl Client

pub fn restore_db_cluster_to_point_in_time( &self, ) -> RestoreDBClusterToPointInTimeFluentBuilder

Constructs a fluent builder for the RestoreDBClusterToPointInTime operation.

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

    The name of the new DB cluster to be created.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens

    • First character must be a letter

    • Cannot end with a hyphen or contain two consecutive hyphens

    
    
  • restore_type(impl Into<String>) / set_restore_type(Option<String>):
    required: false
    

    The type of restore to be performed. You can specify one of the following values:

    • full-copy - The new DB cluster is restored as a full copy of the source DB cluster.

    • copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.

    If you don’t specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

    
    
  • source_db_cluster_identifier(impl Into<String>) / set_source_db_cluster_identifier(Option<String>):
    required: true
    

    The identifier of the source DB cluster from which to restore.

    Constraints:

    • Must match the identifier of an existing DBCluster.

    
    
  • restore_to_time(DateTime) / set_restore_to_time(Option<DateTime>):
    required: false
    

    The date and time to restore the DB cluster to.

    Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

    Constraints:

    • Must be before the latest restorable time for the DB instance

    • Must be specified if UseLatestRestorableTime parameter is not provided

    • Cannot be specified if UseLatestRestorableTime parameter is true

    • Cannot be specified if RestoreType parameter is copy-on-write

    Example: 2015-03-07T23:45:00Z

    
    
  • use_latest_restorable_time(bool) / set_use_latest_restorable_time(Option<bool>):
    required: false
    

    A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.

    Default: false

    Constraints: Cannot be specified if RestoreToTime parameter is provided.

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

    The port number on which the new DB cluster accepts connections.

    Constraints: Value must be 1150-65535

    Default: The same port as the original DB cluster.

    
    
  • db_subnet_group_name(impl Into<String>) / set_db_subnet_group_name(Option<String>):
    required: false
    

    The DB subnet group name to use for the new DB cluster.

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    Example: mySubnetgroup

    
    
  • option_group_name(impl Into<String>) / set_option_group_name(Option<String>):
    required: false
    

    (Not supported by Neptune)

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

    A list of VPC security groups that the new DB cluster belongs to.

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

    The tags to be applied to the restored DB cluster.

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

    The Amazon KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same Amazon account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

    You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.

    If you do not specify a value for the KmsKeyId parameter, then the following will occur:

    • If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.

    • If the DB cluster is not encrypted, then the restored DB cluster is not encrypted.

    If DBClusterIdentifier refers to a DB cluster that is not encrypted, then the restore request is rejected.

    
    
  • enable_iam_database_authentication(bool) / set_enable_iam_database_authentication(Option<bool>):
    required: false
    

    True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

    Default: false

    
    
  • enable_cloudwatch_logs_exports(impl Into<String>) / set_enable_cloudwatch_logs_exports(Option<Vec::<String>>):
    required: false
    

    The list of logs that the restored DB cluster is to export to CloudWatch Logs.

    
    
  • db_cluster_parameter_group_name(impl Into<String>) / set_db_cluster_parameter_group_name(Option<String>):
    required: false
    

    The name of the DB cluster parameter group to associate with the new DB cluster.

    Constraints:

    • If supplied, must match the name of an existing DBClusterParameterGroup.

    
    
  • deletion_protection(bool) / set_deletion_protection(Option<bool>):
    required: false
    

    A value that indicates whether the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. By default, deletion protection is disabled.

    
    
  • serverless_v2_scaling_configuration(ServerlessV2ScalingConfiguration) / set_serverless_v2_scaling_configuration(Option<ServerlessV2ScalingConfiguration>):
    required: false
    

    Contains the scaling configuration of a Neptune Serverless DB cluster.

    For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

    
    
  • storage_type(impl Into<String>) / set_storage_type(Option<String>):
    required: false
    

    Specifies the storage type to be associated with the DB cluster.

    Valid values: standard, iopt1

    Default: standard

    
    
• On success, responds with RestoreDbClusterToPointInTimeOutput with field(s):
  • db_cluster(Option<DbCluster>):

    Contains the details of an Amazon Neptune DB cluster.

    This data type is used as a response element in the DescribeDBClusters.

• On failure, responds with SdkError<RestoreDBClusterToPointInTimeError>

impl Client

pub fn start_db_cluster(&self) -> StartDBClusterFluentBuilder

Constructs a fluent builder for the StartDBCluster operation.

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

    The DB cluster identifier of the Neptune DB cluster to be started. This parameter is stored as a lowercase string.

    
    
• On success, responds with StartDbClusterOutput with field(s):
  • db_cluster(Option<DbCluster>):

    Contains the details of an Amazon Neptune DB cluster.

    This data type is used as a response element in the DescribeDBClusters.

• On failure, responds with SdkError<StartDBClusterError>

impl Client

pub fn stop_db_cluster(&self) -> StopDBClusterFluentBuilder

Constructs a fluent builder for the StopDBCluster operation.

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

    The DB cluster identifier of the Neptune DB cluster to be stopped. This parameter is stored as a lowercase string.

    
    
• On success, responds with StopDbClusterOutput with field(s):
  • db_cluster(Option<DbCluster>):

    Contains the details of an Amazon Neptune DB cluster.

    This data type is used as a response element in the DescribeDBClusters.

• On failure, responds with SdkError<StopDBClusterError>

impl Client

pub fn switchover_global_cluster(&self) -> SwitchoverGlobalClusterFluentBuilder

Constructs a fluent builder for the SwitchoverGlobalCluster operation.

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

    The identifier of the global database cluster to switch over. This parameter isn’t case-sensitive.

    Constraints: Must match the identifier of an existing global database cluster.

    
    
  • target_db_cluster_identifier(impl Into<String>) / set_target_db_cluster_identifier(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the secondary Neptune DB cluster that you want to promote to primary for the global database.

    
    
• On success, responds with SwitchoverGlobalClusterOutput with field(s):
  • global_cluster(Option<GlobalCluster>):

    Contains the details of an Amazon Neptune global database.

    This data type is used as a response element for the CreateGlobalCluster, DescribeGlobalClusters, ModifyGlobalCluster, DeleteGlobalCluster, FailoverGlobalCluster, and RemoveFromGlobalCluster actions.

• On failure, responds with SdkError<SwitchoverGlobalClusterError>

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_db_instance_available(&self) -> DbInstanceAvailableFluentBuilder

Wait for db_instance_available

fn wait_until_db_instance_deleted(&self) -> DbInstanceDeletedFluentBuilder

Wait for db_instance_deleted