pub struct Client { /* private fields */ }Expand description
Client for odb
Client for invoking operations on odb. Each operation on odb 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_odb::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_odb::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 AcceptMarketplaceRegistration operation has
a Client::accept_marketplace_registration, function which returns a builder for that operation.
The fluent builder ultimately has a send() function that returns an async future that
returns a result, as illustrated below:
let result = client.accept_marketplace_registration()
.marketplace_registration_token("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.
Implementations§
Source§impl Client
impl Client
Sourcepub fn accept_marketplace_registration(
&self,
) -> AcceptMarketplaceRegistrationFluentBuilder
pub fn accept_marketplace_registration( &self, ) -> AcceptMarketplaceRegistrationFluentBuilder
Constructs a fluent builder for the AcceptMarketplaceRegistration operation.
- The fluent builder is configurable:
marketplace_registration_token(impl Into<String>)/set_marketplace_registration_token(Option<String>):
required: trueThe registration token that’s generated by Amazon Web Services Marketplace and sent to Oracle Database@Amazon Web Services.
- On success, responds with
AcceptMarketplaceRegistrationOutput - On failure, responds with
SdkError<AcceptMarketplaceRegistrationError>
Source§impl Client
impl Client
Sourcepub fn associate_iam_role_to_resource(
&self,
) -> AssociateIamRoleToResourceFluentBuilder
pub fn associate_iam_role_to_resource( &self, ) -> AssociateIamRoleToResourceFluentBuilder
Constructs a fluent builder for the AssociateIamRoleToResource operation.
- The fluent builder is configurable:
iam_role_arn(impl Into<String>)/set_iam_role_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the IAM service role to associate with the resource.
aws_integration(SupportedAwsIntegration)/set_aws_integration(Option<SupportedAwsIntegration>):
required: trueThe Amazon Web Services integration configuration settings for the IAM service role association.
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the target resource to associate with the IAM service role.
- On success, responds with
AssociateIamRoleToResourceOutput - On failure, responds with
SdkError<AssociateIamRoleToResourceError>
Source§impl Client
impl Client
Sourcepub fn create_cloud_autonomous_vm_cluster(
&self,
) -> CreateCloudAutonomousVmClusterFluentBuilder
pub fn create_cloud_autonomous_vm_cluster( &self, ) -> CreateCloudAutonomousVmClusterFluentBuilder
Constructs a fluent builder for the CreateCloudAutonomousVmCluster operation.
- The fluent builder is configurable:
cloud_exadata_infrastructure_id(impl Into<String>)/set_cloud_exadata_infrastructure_id(Option<String>):
required: trueThe unique identifier of the Exadata infrastructure where the VM cluster will be created.
odb_network_id(impl Into<String>)/set_odb_network_id(Option<String>):
required: trueThe unique identifier of the ODB network to be used for the VM cluster.
display_name(impl Into<String>)/set_display_name(Option<String>):
required: trueThe display name for the Autonomous VM cluster. The name does not need to be unique.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA client-provided token to ensure idempotency of the request.
autonomous_data_storage_size_in_tbs(f64)/set_autonomous_data_storage_size_in_tbs(Option<f64>):
required: trueThe data disk group size to be allocated for Autonomous Databases, in terabytes (TB).
cpu_core_count_per_node(i32)/set_cpu_core_count_per_node(Option<i32>):
required: trueThe number of CPU cores to be enabled per VM cluster node.
db_servers(impl Into<String>)/set_db_servers(Option<Vec::<String>>):
required: falseThe list of database servers to be used for the Autonomous VM cluster.
description(impl Into<String>)/set_description(Option<String>):
required: falseA user-provided description of the Autonomous VM cluster.
is_mtls_enabled_vm_cluster(bool)/set_is_mtls_enabled_vm_cluster(Option<bool>):
required: falseSpecifies whether to enable mutual TLS (mTLS) authentication for the Autonomous VM cluster.
license_model(LicenseModel)/set_license_model(Option<LicenseModel>):
required: falseThe Oracle license model to apply to the Autonomous VM cluster.
maintenance_window(MaintenanceWindow)/set_maintenance_window(Option<MaintenanceWindow>):
required: falseThe scheduling details for the maintenance window. Patching and system updates take place during the maintenance window.
memory_per_oracle_compute_unit_in_gbs(i32)/set_memory_per_oracle_compute_unit_in_gbs(Option<i32>):
required: trueThe amount of memory to be allocated per OCPU, in GB.
scan_listener_port_non_tls(i32)/set_scan_listener_port_non_tls(Option<i32>):
required: falseThe SCAN listener port for non-TLS (TCP) protocol.
scan_listener_port_tls(i32)/set_scan_listener_port_tls(Option<i32>):
required: falseThe SCAN listener port for TLS (TCP) protocol.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseFree-form tags for this resource. Each tag is a key-value pair with no predefined name, type, or namespace.
time_zone(impl Into<String>)/set_time_zone(Option<String>):
required: falseThe time zone to use for the Autonomous VM cluster.
total_container_databases(i32)/set_total_container_databases(Option<i32>):
required: trueThe total number of Autonomous CDBs that you can create in the Autonomous VM cluster.
- On success, responds with
CreateCloudAutonomousVmClusterOutputwith field(s):display_name(Option<String>):The display name of the created Autonomous VM cluster.
status(Option<ResourceStatus>):The current status of the Autonomous VM cluster creation process.
status_reason(Option<String>):Additional information about the current status of the Autonomous VM cluster creation process, if applicable.
cloud_autonomous_vm_cluster_id(String):The unique identifier of the created Autonomous VM cluster.
- On failure, responds with
SdkError<CreateCloudAutonomousVmClusterError>
Source§impl Client
impl Client
Sourcepub fn create_cloud_exadata_infrastructure(
&self,
) -> CreateCloudExadataInfrastructureFluentBuilder
pub fn create_cloud_exadata_infrastructure( &self, ) -> CreateCloudExadataInfrastructureFluentBuilder
Constructs a fluent builder for the CreateCloudExadataInfrastructure operation.
- The fluent builder is configurable:
display_name(impl Into<String>)/set_display_name(Option<String>):
required: trueA user-friendly name for the Exadata infrastructure.
shape(impl Into<String>)/set_shape(Option<String>):
required: trueThe model name of the Exadata infrastructure. For the list of valid model names, use the
ListDbSystemShapesoperation.availability_zone(impl Into<String>)/set_availability_zone(Option<String>):
required: falseThe name of the Availability Zone (AZ) where the Exadata infrastructure is located.
This operation requires that you specify a value for either
availabilityZoneoravailabilityZoneId.Example:
us-east-1aavailability_zone_id(impl Into<String>)/set_availability_zone_id(Option<String>):
required: falseThe AZ ID of the AZ where the Exadata infrastructure is located.
This operation requires that you specify a value for either
availabilityZoneoravailabilityZoneId.Example:
use1-az1tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseThe list of resource tags to apply to the Exadata infrastructure.
compute_count(i32)/set_compute_count(Option<i32>):
required: trueThe number of database servers for the Exadata infrastructure. Valid values for this parameter depend on the shape. To get information about the minimum and maximum values, use the
ListDbSystemShapesoperation.customer_contacts_to_send_to_oci(CustomerContact)/set_customer_contacts_to_send_to_oci(Option<Vec::<CustomerContact>>):
required: falseThe email addresses of contacts to receive notification from Oracle about maintenance updates for the Exadata infrastructure.
maintenance_window(MaintenanceWindow)/set_maintenance_window(Option<MaintenanceWindow>):
required: falseThe maintenance window configuration for the Exadata Cloud infrastructure.
This allows you to define when maintenance operations such as patching and updates can be performed on the infrastructure.
storage_count(i32)/set_storage_count(Option<i32>):
required: trueThe number of storage servers to activate for this Exadata infrastructure. Valid values for this parameter depend on the shape. To get information about the minimum and maximum values, use the
ListDbSystemShapesoperation.client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency. The client token is valid for up to 24 hours after it’s first used.
database_server_type(impl Into<String>)/set_database_server_type(Option<String>):
required: falseThe database server model type of the Exadata infrastructure. For the list of valid model names, use the
ListDbSystemShapesoperation.storage_server_type(impl Into<String>)/set_storage_server_type(Option<String>):
required: falseThe storage server model type of the Exadata infrastructure. For the list of valid model names, use the
ListDbSystemShapesoperation.
- On success, responds with
CreateCloudExadataInfrastructureOutputwith field(s):display_name(Option<String>):The user-friendly name for the Exadata infrastructure.
status(Option<ResourceStatus>):The current status of the Exadata infrastructure.
status_reason(Option<String>):Additional information about the status of the Exadata infrastructure.
cloud_exadata_infrastructure_id(String):The unique identifier of the Exadata infrastructure.
- On failure, responds with
SdkError<CreateCloudExadataInfrastructureError>
Source§impl Client
impl Client
Sourcepub fn create_cloud_vm_cluster(&self) -> CreateCloudVmClusterFluentBuilder
pub fn create_cloud_vm_cluster(&self) -> CreateCloudVmClusterFluentBuilder
Constructs a fluent builder for the CreateCloudVmCluster operation.
- The fluent builder is configurable:
cloud_exadata_infrastructure_id(impl Into<String>)/set_cloud_exadata_infrastructure_id(Option<String>):
required: trueThe unique identifier of the Exadata infrastructure for this VM cluster.
cpu_core_count(i32)/set_cpu_core_count(Option<i32>):
required: trueThe number of CPU cores to enable on the VM cluster.
display_name(impl Into<String>)/set_display_name(Option<String>):
required: trueA user-friendly name for the VM cluster.
gi_version(impl Into<String>)/set_gi_version(Option<String>):
required: trueA valid software version of Oracle Grid Infrastructure (GI). To get the list of valid values, use the
ListGiVersionsoperation and specify the shape of the Exadata infrastructure.Example:
19.0.0.0hostname(impl Into<String>)/set_hostname(Option<String>):
required: trueThe host name for the VM cluster.
Constraints:
-
Can’t be “localhost” or “hostname”.
-
Can’t contain “-version”.
-
The maximum length of the combined hostname and domain is 63 characters.
-
The hostname must be unique within the subnet.
-
ssh_public_keys(impl Into<String>)/set_ssh_public_keys(Option<Vec::<String>>):
required: trueThe public key portion of one or more key pairs used for SSH access to the VM cluster.
odb_network_id(impl Into<String>)/set_odb_network_id(Option<String>):
required: trueThe unique identifier of the ODB network for the VM cluster.
cluster_name(impl Into<String>)/set_cluster_name(Option<String>):
required: falseA name for the Grid Infrastructure cluster. The name isn’t case sensitive.
data_collection_options(DataCollectionOptions)/set_data_collection_options(Option<DataCollectionOptions>):
required: falseThe set of preferences for the various diagnostic collection options for the VM cluster.
data_storage_size_in_tbs(f64)/set_data_storage_size_in_tbs(Option<f64>):
required: falseThe size of the data disk group, in terabytes (TBs), to allocate for the VM cluster.
db_node_storage_size_in_gbs(i32)/set_db_node_storage_size_in_gbs(Option<i32>):
required: falseThe amount of local node storage, in gigabytes (GBs), to allocate for the VM cluster.
db_servers(impl Into<String>)/set_db_servers(Option<Vec::<String>>):
required: falseThe list of database servers for the VM cluster.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseThe list of resource tags to apply to the VM cluster.
is_local_backup_enabled(bool)/set_is_local_backup_enabled(Option<bool>):
required: falseSpecifies whether to enable database backups to local Exadata storage for the VM cluster.
is_sparse_diskgroup_enabled(bool)/set_is_sparse_diskgroup_enabled(Option<bool>):
required: falseSpecifies whether to create a sparse disk group for the VM cluster.
license_model(LicenseModel)/set_license_model(Option<LicenseModel>):
required: falseThe Oracle license model to apply to the VM cluster.
Default:
LICENSE_INCLUDEDmemory_size_in_gbs(i32)/set_memory_size_in_gbs(Option<i32>):
required: falseThe amount of memory, in gigabytes (GBs), to allocate for the VM cluster.
system_version(impl Into<String>)/set_system_version(Option<String>):
required: falseThe version of the operating system of the image for the VM cluster.
time_zone(impl Into<String>)/set_time_zone(Option<String>):
required: falseThe time zone for the VM cluster. For a list of valid values for time zone, you can check the options in the console.
Default: UTC
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency. The client token is valid for up to 24 hours after it’s first used.
scan_listener_port_tcp(i32)/set_scan_listener_port_tcp(Option<i32>):
required: falseThe port number for TCP connections to the single client access name (SCAN) listener.
Valid values:
1024–8999with the following exceptions:2484,6100,6200,7060,7070,7085, and7879Default:
1521
- On success, responds with
CreateCloudVmClusterOutputwith field(s):display_name(Option<String>):The user-friendly name for the VM cluster.
status(Option<ResourceStatus>):The current status of the VM cluster.
status_reason(Option<String>):Additional information about the status of the VM cluster.
cloud_vm_cluster_id(String):The unique identifier for the VM cluster.
- On failure, responds with
SdkError<CreateCloudVmClusterError>
Source§impl Client
impl Client
Sourcepub fn create_odb_network(&self) -> CreateOdbNetworkFluentBuilder
pub fn create_odb_network(&self) -> CreateOdbNetworkFluentBuilder
Constructs a fluent builder for the CreateOdbNetwork operation.
- The fluent builder is configurable:
display_name(impl Into<String>)/set_display_name(Option<String>):
required: trueA user-friendly name for the ODB network.
availability_zone(impl Into<String>)/set_availability_zone(Option<String>):
required: falseThe Amazon Web Services Availability Zone (AZ) where the ODB network is located.
This operation requires that you specify a value for either
availabilityZoneoravailabilityZoneId.availability_zone_id(impl Into<String>)/set_availability_zone_id(Option<String>):
required: falseThe AZ ID of the AZ where the ODB network is located.
This operation requires that you specify a value for either
availabilityZoneoravailabilityZoneId.client_subnet_cidr(impl Into<String>)/set_client_subnet_cidr(Option<String>):
required: trueThe CIDR range of the client subnet for the ODB network.
Constraints:
-
Must not overlap with the CIDR range of the backup subnet.
-
Must not overlap with the CIDR ranges of the VPCs that are connected to the ODB network.
-
Must not use the following CIDR ranges that are reserved by OCI:
-
100.106.0.0/16and100.107.0.0/16 -
169.254.0.0/16 -
224.0.0.0 - 239.255.255.255 -
240.0.0.0 - 255.255.255.255
-
-
backup_subnet_cidr(impl Into<String>)/set_backup_subnet_cidr(Option<String>):
required: falseThe CIDR range of the backup subnet for the ODB network.
Constraints:
-
Must not overlap with the CIDR range of the client subnet.
-
Must not overlap with the CIDR ranges of the VPCs that are connected to the ODB network.
-
Must not use the following CIDR ranges that are reserved by OCI:
-
100.106.0.0/16and100.107.0.0/16 -
169.254.0.0/16 -
224.0.0.0 - 239.255.255.255 -
240.0.0.0 - 255.255.255.255
-
-
custom_domain_name(impl Into<String>)/set_custom_domain_name(Option<String>):
required: falseThe domain name to use for the resources in the ODB network.
default_dns_prefix(impl Into<String>)/set_default_dns_prefix(Option<String>):
required: falseThe DNS prefix to the default DNS domain name. The default DNS domain name is oraclevcn.com.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseA unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency. The client token is valid for up to 24 hours after it’s first used.
s3_access(Access)/set_s3_access(Option<Access>):
required: falseSpecifies the configuration for Amazon S3 access from the ODB network.
zero_etl_access(Access)/set_zero_etl_access(Option<Access>):
required: falseSpecifies the configuration for Zero-ETL access from the ODB network.
sts_access(Access)/set_sts_access(Option<Access>):
required: falseThe Amazon Web Services Security Token Service (STS) access configuration for the ODB network.
kms_access(Access)/set_kms_access(Option<Access>):
required: falseThe Amazon Web Services Key Management Service (KMS) access configuration for the ODB network.
s3_policy_document(impl Into<String>)/set_s3_policy_document(Option<String>):
required: falseSpecifies the endpoint policy for Amazon S3 access from the ODB network.
sts_policy_document(impl Into<String>)/set_sts_policy_document(Option<String>):
required: falseThe STS policy document that defines permissions for token service usage within the ODB network.
kms_policy_document(impl Into<String>)/set_kms_policy_document(Option<String>):
required: falseThe KMS policy document that defines permissions for key usage within the ODB network.
cross_region_s3_restore_sources_to_enable(impl Into<String>)/set_cross_region_s3_restore_sources_to_enable(Option<Vec::<String>>):
required: falseThe cross-Region Amazon S3 restore sources to enable for the ODB network.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseThe list of resource tags to apply to the ODB network.
- On success, responds with
CreateOdbNetworkOutputwith field(s):display_name(Option<String>):The user-friendly name of the ODB network.
status(Option<ResourceStatus>):The current status of the ODB network.
status_reason(Option<String>):Additional information about the status of the ODB network.
odb_network_id(String):The unique identifier of the ODB network.
- On failure, responds with
SdkError<CreateOdbNetworkError>
Source§impl Client
impl Client
Sourcepub fn create_odb_peering_connection(
&self,
) -> CreateOdbPeeringConnectionFluentBuilder
pub fn create_odb_peering_connection( &self, ) -> CreateOdbPeeringConnectionFluentBuilder
Constructs a fluent builder for the CreateOdbPeeringConnection operation.
- The fluent builder is configurable:
odb_network_id(impl Into<String>)/set_odb_network_id(Option<String>):
required: trueThe unique identifier of the ODB network that initiates the peering connection.
peer_network_id(impl Into<String>)/set_peer_network_id(Option<String>):
required: trueThe unique identifier of the peer network. This can be either a VPC ID or another ODB network ID.
display_name(impl Into<String>)/set_display_name(Option<String>):
required: falseThe display name for the ODB peering connection.
peer_network_cidrs_to_be_added(impl Into<String>)/set_peer_network_cidrs_to_be_added(Option<Vec::<String>>):
required: falseA list of CIDR blocks to add to the peering connection. These CIDR blocks define the IP address ranges that can communicate through the peering connection.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseThe client token for the ODB peering connection request.
Constraints:
-
Must be unique for each request.
-
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseThe tags to assign to the ODB peering connection.
- On success, responds with
CreateOdbPeeringConnectionOutputwith field(s):display_name(Option<String>):The display name of the ODB peering connection.
status(Option<ResourceStatus>):The status of the ODB peering connection.
status_reason(Option<String>):The reason for the current status of the ODB peering connection.
odb_peering_connection_id(String):The unique identifier of the ODB peering connection.
- On failure, responds with
SdkError<CreateOdbPeeringConnectionError>
Source§impl Client
impl Client
Sourcepub fn delete_cloud_autonomous_vm_cluster(
&self,
) -> DeleteCloudAutonomousVmClusterFluentBuilder
pub fn delete_cloud_autonomous_vm_cluster( &self, ) -> DeleteCloudAutonomousVmClusterFluentBuilder
Constructs a fluent builder for the DeleteCloudAutonomousVmCluster operation.
- The fluent builder is configurable:
cloud_autonomous_vm_cluster_id(impl Into<String>)/set_cloud_autonomous_vm_cluster_id(Option<String>):
required: trueThe unique identifier of the Autonomous VM cluster to delete.
- On success, responds with
DeleteCloudAutonomousVmClusterOutput - On failure, responds with
SdkError<DeleteCloudAutonomousVmClusterError>
Source§impl Client
impl Client
Sourcepub fn delete_cloud_exadata_infrastructure(
&self,
) -> DeleteCloudExadataInfrastructureFluentBuilder
pub fn delete_cloud_exadata_infrastructure( &self, ) -> DeleteCloudExadataInfrastructureFluentBuilder
Constructs a fluent builder for the DeleteCloudExadataInfrastructure operation.
- The fluent builder is configurable:
cloud_exadata_infrastructure_id(impl Into<String>)/set_cloud_exadata_infrastructure_id(Option<String>):
required: trueThe unique identifier of the Exadata infrastructure to delete.
- On success, responds with
DeleteCloudExadataInfrastructureOutput - On failure, responds with
SdkError<DeleteCloudExadataInfrastructureError>
Source§impl Client
impl Client
Sourcepub fn delete_cloud_vm_cluster(&self) -> DeleteCloudVmClusterFluentBuilder
pub fn delete_cloud_vm_cluster(&self) -> DeleteCloudVmClusterFluentBuilder
Constructs a fluent builder for the DeleteCloudVmCluster operation.
- The fluent builder is configurable:
cloud_vm_cluster_id(impl Into<String>)/set_cloud_vm_cluster_id(Option<String>):
required: trueThe unique identifier of the VM cluster to delete.
- On success, responds with
DeleteCloudVmClusterOutput - On failure, responds with
SdkError<DeleteCloudVmClusterError>
Source§impl Client
impl Client
Sourcepub fn delete_odb_network(&self) -> DeleteOdbNetworkFluentBuilder
pub fn delete_odb_network(&self) -> DeleteOdbNetworkFluentBuilder
Constructs a fluent builder for the DeleteOdbNetwork operation.
- The fluent builder is configurable:
odb_network_id(impl Into<String>)/set_odb_network_id(Option<String>):
required: trueThe unique identifier of the ODB network to delete.
delete_associated_resources(bool)/set_delete_associated_resources(Option<bool>):
required: trueSpecifies whether to delete associated OCI networking resources along with the ODB network.
- On success, responds with
DeleteOdbNetworkOutput - On failure, responds with
SdkError<DeleteOdbNetworkError>
Source§impl Client
impl Client
Sourcepub fn delete_odb_peering_connection(
&self,
) -> DeleteOdbPeeringConnectionFluentBuilder
pub fn delete_odb_peering_connection( &self, ) -> DeleteOdbPeeringConnectionFluentBuilder
Constructs a fluent builder for the DeleteOdbPeeringConnection operation.
- The fluent builder is configurable:
odb_peering_connection_id(impl Into<String>)/set_odb_peering_connection_id(Option<String>):
required: trueThe unique identifier of the ODB peering connection to delete.
- On success, responds with
DeleteOdbPeeringConnectionOutput - On failure, responds with
SdkError<DeleteOdbPeeringConnectionError>
Source§impl Client
impl Client
Sourcepub fn disassociate_iam_role_from_resource(
&self,
) -> DisassociateIamRoleFromResourceFluentBuilder
pub fn disassociate_iam_role_from_resource( &self, ) -> DisassociateIamRoleFromResourceFluentBuilder
Constructs a fluent builder for the DisassociateIamRoleFromResource operation.
- The fluent builder is configurable:
iam_role_arn(impl Into<String>)/set_iam_role_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the IAM service role to disassociate from the resource.
aws_integration(SupportedAwsIntegration)/set_aws_integration(Option<SupportedAwsIntegration>):
required: trueThe Amazon Web Services integration configuration settings for the IAM service role disassociation.
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the target resource to disassociate from the IAM service role.
- On success, responds with
DisassociateIamRoleFromResourceOutput - On failure, responds with
SdkError<DisassociateIamRoleFromResourceError>
Source§impl Client
impl Client
Sourcepub fn get_cloud_autonomous_vm_cluster(
&self,
) -> GetCloudAutonomousVmClusterFluentBuilder
pub fn get_cloud_autonomous_vm_cluster( &self, ) -> GetCloudAutonomousVmClusterFluentBuilder
Constructs a fluent builder for the GetCloudAutonomousVmCluster operation.
- The fluent builder is configurable:
cloud_autonomous_vm_cluster_id(impl Into<String>)/set_cloud_autonomous_vm_cluster_id(Option<String>):
required: trueThe unique identifier of the Autonomous VM cluster to retrieve information about.
- On success, responds with
GetCloudAutonomousVmClusterOutputwith field(s):cloud_autonomous_vm_cluster(Option<CloudAutonomousVmCluster>):The details of the requested Autonomous VM cluster.
- On failure, responds with
SdkError<GetCloudAutonomousVmClusterError>
Source§impl Client
impl Client
Sourcepub fn get_cloud_exadata_infrastructure(
&self,
) -> GetCloudExadataInfrastructureFluentBuilder
pub fn get_cloud_exadata_infrastructure( &self, ) -> GetCloudExadataInfrastructureFluentBuilder
Constructs a fluent builder for the GetCloudExadataInfrastructure operation.
- The fluent builder is configurable:
cloud_exadata_infrastructure_id(impl Into<String>)/set_cloud_exadata_infrastructure_id(Option<String>):
required: trueThe unique identifier of the Exadata infrastructure.
- On success, responds with
GetCloudExadataInfrastructureOutputwith field(s):cloud_exadata_infrastructure(Option<CloudExadataInfrastructure>):The Exadata infrastructure.
- On failure, responds with
SdkError<GetCloudExadataInfrastructureError>
Source§impl Client
impl Client
Sourcepub fn get_cloud_exadata_infrastructure_unallocated_resources(
&self,
) -> GetCloudExadataInfrastructureUnallocatedResourcesFluentBuilder
pub fn get_cloud_exadata_infrastructure_unallocated_resources( &self, ) -> GetCloudExadataInfrastructureUnallocatedResourcesFluentBuilder
Constructs a fluent builder for the GetCloudExadataInfrastructureUnallocatedResources operation.
- The fluent builder is configurable:
cloud_exadata_infrastructure_id(impl Into<String>)/set_cloud_exadata_infrastructure_id(Option<String>):
required: trueThe unique identifier of the Cloud Exadata infrastructure for which to retrieve unallocated resources.
db_servers(impl Into<String>)/set_db_servers(Option<Vec::<String>>):
required: falseThe database servers to include in the unallocated resources query.
- On success, responds with
GetCloudExadataInfrastructureUnallocatedResourcesOutputwith field(s):cloud_exadata_infrastructure_unallocated_resources(Option<CloudExadataInfrastructureUnallocatedResources>):Details about the unallocated resources in the specified Cloud Exadata infrastructure.
- On failure, responds with
SdkError<GetCloudExadataInfrastructureUnallocatedResourcesError>
Source§impl Client
impl Client
Sourcepub fn get_cloud_vm_cluster(&self) -> GetCloudVmClusterFluentBuilder
pub fn get_cloud_vm_cluster(&self) -> GetCloudVmClusterFluentBuilder
Constructs a fluent builder for the GetCloudVmCluster operation.
- The fluent builder is configurable:
cloud_vm_cluster_id(impl Into<String>)/set_cloud_vm_cluster_id(Option<String>):
required: trueThe unique identifier of the VM cluster.
- On success, responds with
GetCloudVmClusterOutputwith field(s):cloud_vm_cluster(Option<CloudVmCluster>):The VM cluster.
- On failure, responds with
SdkError<GetCloudVmClusterError>
Source§impl Client
impl Client
Sourcepub fn get_db_node(&self) -> GetDbNodeFluentBuilder
pub fn get_db_node(&self) -> GetDbNodeFluentBuilder
Constructs a fluent builder for the GetDbNode operation.
- The fluent builder is configurable:
cloud_vm_cluster_id(impl Into<String>)/set_cloud_vm_cluster_id(Option<String>):
required: trueThe unique identifier of the VM cluster that contains the DB node.
db_node_id(impl Into<String>)/set_db_node_id(Option<String>):
required: trueThe unique identifier of the DB node to retrieve information about.
- On success, responds with
GetDbNodeOutputwith field(s):db_node(Option<DbNode>):Information about a DB node.
- On failure, responds with
SdkError<GetDbNodeError>
Source§impl Client
impl Client
Sourcepub fn get_db_server(&self) -> GetDbServerFluentBuilder
pub fn get_db_server(&self) -> GetDbServerFluentBuilder
Constructs a fluent builder for the GetDbServer operation.
- The fluent builder is configurable:
cloud_exadata_infrastructure_id(impl Into<String>)/set_cloud_exadata_infrastructure_id(Option<String>):
required: trueThe unique identifier of the Oracle Exadata infrastructure that contains the database server.
db_server_id(impl Into<String>)/set_db_server_id(Option<String>):
required: trueThe unique identifier of the database server to retrieve information about.
- On success, responds with
GetDbServerOutputwith field(s):db_server(Option<DbServer>):The details of the requested database server.
- On failure, responds with
SdkError<GetDbServerError>
Source§impl Client
impl Client
Sourcepub fn get_oci_onboarding_status(&self) -> GetOciOnboardingStatusFluentBuilder
pub fn get_oci_onboarding_status(&self) -> GetOciOnboardingStatusFluentBuilder
Constructs a fluent builder for the GetOciOnboardingStatus operation.
- The fluent builder takes no input, just
sendit. - On success, responds with
GetOciOnboardingStatusOutputwith field(s):status(Option<OciOnboardingStatus>):existing_tenancy_activation_link(Option<String>):The existing OCI tenancy activation link for your Amazon Web Services account.
new_tenancy_activation_link(Option<String>):A new OCI tenancy activation link for your Amazon Web Services account.
oci_identity_domain(Option<OciIdentityDomain>):The Oracle Cloud Infrastructure (OCI) identity domain information in the onboarding status response.
- On failure, responds with
SdkError<GetOciOnboardingStatusError>
Source§impl Client
impl Client
Sourcepub fn get_odb_network(&self) -> GetOdbNetworkFluentBuilder
pub fn get_odb_network(&self) -> GetOdbNetworkFluentBuilder
Constructs a fluent builder for the GetOdbNetwork operation.
- The fluent builder is configurable:
odb_network_id(impl Into<String>)/set_odb_network_id(Option<String>):
required: trueThe unique identifier of the ODB network.
- On success, responds with
GetOdbNetworkOutputwith field(s):odb_network(Option<OdbNetwork>):The ODB network.
- On failure, responds with
SdkError<GetOdbNetworkError>
Source§impl Client
impl Client
Sourcepub fn get_odb_peering_connection(&self) -> GetOdbPeeringConnectionFluentBuilder
pub fn get_odb_peering_connection(&self) -> GetOdbPeeringConnectionFluentBuilder
Constructs a fluent builder for the GetOdbPeeringConnection operation.
- The fluent builder is configurable:
odb_peering_connection_id(impl Into<String>)/set_odb_peering_connection_id(Option<String>):
required: trueThe unique identifier of the ODB peering connection to retrieve information about.
- On success, responds with
GetOdbPeeringConnectionOutputwith field(s):odb_peering_connection(Option<OdbPeeringConnection>):A peering connection between an ODB network and either another ODB network or a customer-owned VPC.
- On failure, responds with
SdkError<GetOdbPeeringConnectionError>
Source§impl Client
impl Client
Sourcepub fn initialize_service(&self) -> InitializeServiceFluentBuilder
pub fn initialize_service(&self) -> InitializeServiceFluentBuilder
Constructs a fluent builder for the InitializeService operation.
- The fluent builder is configurable:
oci_identity_domain(bool)/set_oci_identity_domain(Option<bool>):
required: falseThe Oracle Cloud Infrastructure (OCI) identity domain configuration for service initialization.
- On success, responds with
InitializeServiceOutput - On failure, responds with
SdkError<InitializeServiceError>
Source§impl Client
impl Client
Sourcepub fn list_autonomous_virtual_machines(
&self,
) -> ListAutonomousVirtualMachinesFluentBuilder
pub fn list_autonomous_virtual_machines( &self, ) -> ListAutonomousVirtualMachinesFluentBuilder
Constructs a fluent builder for the ListAutonomousVirtualMachines operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of items to return per page.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe pagination token to continue listing from.
cloud_autonomous_vm_cluster_id(impl Into<String>)/set_cloud_autonomous_vm_cluster_id(Option<String>):
required: trueThe unique identifier of the Autonomous VM cluster whose virtual machines you’re listing.
- On success, responds with
ListAutonomousVirtualMachinesOutputwith field(s):next_token(Option<String>):The pagination token from which to continue listing.
autonomous_virtual_machines(Vec::<AutonomousVirtualMachineSummary>):The list of Autonomous VMs in the specified Autonomous VM cluster.
- On failure, responds with
SdkError<ListAutonomousVirtualMachinesError>
Source§impl Client
impl Client
Sourcepub fn list_cloud_autonomous_vm_clusters(
&self,
) -> ListCloudAutonomousVmClustersFluentBuilder
pub fn list_cloud_autonomous_vm_clusters( &self, ) -> ListCloudAutonomousVmClustersFluentBuilder
Constructs a fluent builder for the ListCloudAutonomousVmClusters operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of items to return per page.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe pagination token to continue listing from.
cloud_exadata_infrastructure_id(impl Into<String>)/set_cloud_exadata_infrastructure_id(Option<String>):
required: falseThe unique identifier of the Cloud Exadata Infrastructure that hosts the Autonomous VM clusters to be listed.
- On success, responds with
ListCloudAutonomousVmClustersOutputwith field(s):next_token(Option<String>):The pagination token to continue listing from.
cloud_autonomous_vm_clusters(Vec::<CloudAutonomousVmClusterSummary>):The list of Autonomous VM clusters in the specified Cloud Exadata Infrastructure.
- On failure, responds with
SdkError<ListCloudAutonomousVmClustersError>
Source§impl Client
impl Client
Sourcepub fn list_cloud_exadata_infrastructures(
&self,
) -> ListCloudExadataInfrastructuresFluentBuilder
pub fn list_cloud_exadata_infrastructures( &self, ) -> ListCloudExadataInfrastructuresFluentBuilder
Constructs a fluent builder for the ListCloudExadataInfrastructures operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
Default:
10next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
- On success, responds with
ListCloudExadataInfrastructuresOutputwith field(s):next_token(Option<String>):The token to include in another request to get the next page of items. This value is
nullwhen there are no more items to return.cloud_exadata_infrastructures(Vec::<CloudExadataInfrastructureSummary>):The list of Exadata infrastructures along with their properties.
- On failure, responds with
SdkError<ListCloudExadataInfrastructuresError>
Source§impl Client
impl Client
Sourcepub fn list_cloud_vm_clusters(&self) -> ListCloudVmClustersFluentBuilder
pub fn list_cloud_vm_clusters(&self) -> ListCloudVmClustersFluentBuilder
Constructs a fluent builder for the ListCloudVmClusters operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
Default:
10next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
cloud_exadata_infrastructure_id(impl Into<String>)/set_cloud_exadata_infrastructure_id(Option<String>):
required: falseThe unique identifier of the Oracle Exadata infrastructure.
- On success, responds with
ListCloudVmClustersOutputwith field(s):next_token(Option<String>):The token to include in another request to get the next page of items. This value is
nullwhen there are no more items to return.cloud_vm_clusters(Vec::<CloudVmClusterSummary>):The list of VM clusters along with their properties.
- On failure, responds with
SdkError<ListCloudVmClustersError>
Source§impl Client
impl Client
Sourcepub fn list_db_nodes(&self) -> ListDbNodesFluentBuilder
pub fn list_db_nodes(&self) -> ListDbNodesFluentBuilder
Constructs a fluent builder for the ListDbNodes operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
Default:
10next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
cloud_vm_cluster_id(impl Into<String>)/set_cloud_vm_cluster_id(Option<String>):
required: trueThe unique identifier of the VM cluster.
- On success, responds with
ListDbNodesOutputwith field(s):next_token(Option<String>):The token to include in another request to get the next page of items. This value is
nullwhen there are no more items to return.db_nodes(Vec::<DbNodeSummary>):The list of DB nodes along with their properties.
- On failure, responds with
SdkError<ListDbNodesError>
Source§impl Client
impl Client
Sourcepub fn list_db_servers(&self) -> ListDbServersFluentBuilder
pub fn list_db_servers(&self) -> ListDbServersFluentBuilder
Constructs a fluent builder for the ListDbServers operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
cloud_exadata_infrastructure_id(impl Into<String>)/set_cloud_exadata_infrastructure_id(Option<String>):
required: trueThe unique identifier of the Oracle Exadata infrastructure.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
Default:
10next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
- On success, responds with
ListDbServersOutputwith field(s):next_token(Option<String>):The token to include in another request to get the next page of items. This value is
nullwhen there are no more items to return.db_servers(Vec::<DbServerSummary>):The list of database servers along with their properties.
- On failure, responds with
SdkError<ListDbServersError>
Source§impl Client
impl Client
Sourcepub fn list_db_system_shapes(&self) -> ListDbSystemShapesFluentBuilder
pub fn list_db_system_shapes(&self) -> ListDbSystemShapesFluentBuilder
Constructs a fluent builder for the ListDbSystemShapes operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
Default:
10next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
availability_zone(impl Into<String>)/set_availability_zone(Option<String>):
required: falseThe logical name of the AZ, for example, us-east-1a. This name varies depending on the account.
availability_zone_id(impl Into<String>)/set_availability_zone_id(Option<String>):
required: falseThe physical ID of the AZ, for example, use1-az4. This ID persists across accounts.
- On success, responds with
ListDbSystemShapesOutputwith field(s):next_token(Option<String>):The token to include in another request to get the next page of items. This value is
nullwhen there are no more items to return.db_system_shapes(Vec::<DbSystemShapeSummary>):The list of shapes and their properties.
- On failure, responds with
SdkError<ListDbSystemShapesError>
Source§impl Client
impl Client
Sourcepub fn list_gi_versions(&self) -> ListGiVersionsFluentBuilder
pub fn list_gi_versions(&self) -> ListGiVersionsFluentBuilder
Constructs a fluent builder for the ListGiVersions operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
Default:
10next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
shape(impl Into<String>)/set_shape(Option<String>):
required: falseThe shape to return GI versions for. For a list of valid shapes, use the
ListDbSystemShapesoperation..
- On success, responds with
ListGiVersionsOutputwith field(s):next_token(Option<String>):The token to include in another request to get the next page of items. This value is
nullwhen there are no more items to return.gi_versions(Vec::<GiVersionSummary>):The list of GI versions and their properties.
- On failure, responds with
SdkError<ListGiVersionsError>
Source§impl Client
impl Client
Sourcepub fn list_odb_networks(&self) -> ListOdbNetworksFluentBuilder
pub fn list_odb_networks(&self) -> ListOdbNetworksFluentBuilder
Constructs a fluent builder for the ListOdbNetworks operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
Default:
10next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
- On success, responds with
ListOdbNetworksOutputwith field(s):next_token(Option<String>):The token to include in another request to get the next page of items. This value is
nullwhen there are no more items to return.odb_networks(Vec::<OdbNetworkSummary>):The list of ODB networks.
- On failure, responds with
SdkError<ListOdbNetworksError>
Source§impl Client
impl Client
Sourcepub fn list_odb_peering_connections(
&self,
) -> ListOdbPeeringConnectionsFluentBuilder
pub fn list_odb_peering_connections( &self, ) -> ListOdbPeeringConnectionsFluentBuilder
Constructs a fluent builder for the ListOdbPeeringConnections operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of ODB peering connections to return in the response.
Default:
20Constraints:
-
Must be between 1 and 100.
-
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe pagination token for the next page of ODB peering connections.
odb_network_id(impl Into<String>)/set_odb_network_id(Option<String>):
required: falseThe identifier of the ODB network to list peering connections for.
If not specified, lists all ODB peering connections in the account.
- On success, responds with
ListOdbPeeringConnectionsOutputwith field(s):next_token(Option<String>):The pagination token for the next page of ODB peering connections.
odb_peering_connections(Vec::<OdbPeeringConnectionSummary>):The list of ODB peering connections.
- On failure, responds with
SdkError<ListOdbPeeringConnectionsError>
Source§impl Client
impl Client
Sourcepub fn list_system_versions(&self) -> ListSystemVersionsFluentBuilder
pub fn list_system_versions(&self) -> ListSystemVersionsFluentBuilder
Constructs a fluent builder for the ListSystemVersions operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
Default:
10next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseThe token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
gi_version(impl Into<String>)/set_gi_version(Option<String>):
required: trueThe software version of the Exadata Grid Infrastructure (GI).
shape(impl Into<String>)/set_shape(Option<String>):
required: trueThe Exadata hardware system model.
- On success, responds with
ListSystemVersionsOutputwith field(s):next_token(Option<String>):The token to include in another request to get the next page of items. This value is
nullwhen there are no more items to return.system_versions(Vec::<SystemVersionSummary>):The list of system versions.
- On failure, responds with
SdkError<ListSystemVersionsError>
Source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the resource to list tags for.
- On success, responds with
ListTagsForResourceOutputwith field(s):tags(Option<HashMap::<String, String>>):The list of tags applied to the resource.
- On failure, responds with
SdkError<ListTagsForResourceError>
Source§impl Client
impl Client
Sourcepub fn reboot_db_node(&self) -> RebootDbNodeFluentBuilder
pub fn reboot_db_node(&self) -> RebootDbNodeFluentBuilder
Constructs a fluent builder for the RebootDbNode operation.
- The fluent builder is configurable:
cloud_vm_cluster_id(impl Into<String>)/set_cloud_vm_cluster_id(Option<String>):
required: trueThe unique identifier of the VM cluster that contains the DB node to reboot.
db_node_id(impl Into<String>)/set_db_node_id(Option<String>):
required: trueThe unique identifier of the DB node to reboot.
- On success, responds with
RebootDbNodeOutputwith field(s):db_node_id(String):The unique identifier of the DB node that was rebooted.
status(Option<DbNodeResourceStatus>):The current status of the DB node after the reboot operation.
status_reason(Option<String>):Additional information about the status of the DB node after the reboot operation.
- On failure, responds with
SdkError<RebootDbNodeError>
Source§impl Client
impl Client
Sourcepub fn start_db_node(&self) -> StartDbNodeFluentBuilder
pub fn start_db_node(&self) -> StartDbNodeFluentBuilder
Constructs a fluent builder for the StartDbNode operation.
- The fluent builder is configurable:
cloud_vm_cluster_id(impl Into<String>)/set_cloud_vm_cluster_id(Option<String>):
required: trueThe unique identifier of the VM cluster that contains the DB node to start.
db_node_id(impl Into<String>)/set_db_node_id(Option<String>):
required: trueThe unique identifier of the DB node to start.
- On success, responds with
StartDbNodeOutputwith field(s):db_node_id(String):The unique identifier of the DB node that was started.
status(Option<DbNodeResourceStatus>):The current status of the DB node after the start operation.
status_reason(Option<String>):Additional information about the status of the DB node after the start operation.
- On failure, responds with
SdkError<StartDbNodeError>
Source§impl Client
impl Client
Sourcepub fn stop_db_node(&self) -> StopDbNodeFluentBuilder
pub fn stop_db_node(&self) -> StopDbNodeFluentBuilder
Constructs a fluent builder for the StopDbNode operation.
- The fluent builder is configurable:
cloud_vm_cluster_id(impl Into<String>)/set_cloud_vm_cluster_id(Option<String>):
required: trueThe unique identifier of the VM cluster that contains the DB node to stop.
db_node_id(impl Into<String>)/set_db_node_id(Option<String>):
required: trueThe unique identifier of the DB node to stop.
- On success, responds with
StopDbNodeOutputwith field(s):db_node_id(String):The unique identifier of the DB node that was stopped.
status(Option<DbNodeResourceStatus>):The current status of the DB node after the stop operation.
status_reason(Option<String>):Additional information about the status of the DB node after the stop operation.
- On failure, responds with
SdkError<StopDbNodeError>
Source§impl Client
impl Client
Sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the resource to apply tags to.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: trueThe list of tags to apply to the resource.
- On success, responds with
TagResourceOutput - On failure, responds with
SdkError<TagResourceError>
Source§impl Client
impl Client
Sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueThe Amazon Resource Name (ARN) of the resource to remove tags from.
tag_keys(impl Into<String>)/set_tag_keys(Option<Vec::<String>>):
required: trueThe names (keys) of the tags to remove from the resource.
- On success, responds with
UntagResourceOutput - On failure, responds with
SdkError<UntagResourceError>
Source§impl Client
impl Client
Sourcepub fn update_cloud_exadata_infrastructure(
&self,
) -> UpdateCloudExadataInfrastructureFluentBuilder
pub fn update_cloud_exadata_infrastructure( &self, ) -> UpdateCloudExadataInfrastructureFluentBuilder
Constructs a fluent builder for the UpdateCloudExadataInfrastructure operation.
- The fluent builder is configurable:
cloud_exadata_infrastructure_id(impl Into<String>)/set_cloud_exadata_infrastructure_id(Option<String>):
required: trueThe unique identifier of the Exadata infrastructure to update.
maintenance_window(MaintenanceWindow)/set_maintenance_window(Option<MaintenanceWindow>):
required: falseThe scheduling details for the maintenance window. Patching and system updates take place during the maintenance window.
- On success, responds with
UpdateCloudExadataInfrastructureOutputwith field(s):display_name(Option<String>):The user-friendly name of the updated Exadata infrastructure.
status(Option<ResourceStatus>):The current status of the Exadata infrastructure after the update operation.
status_reason(Option<String>):Additional information about the status of the Exadata infrastructure after the update operation.
cloud_exadata_infrastructure_id(String):The unique identifier of the updated Exadata infrastructure.
- On failure, responds with
SdkError<UpdateCloudExadataInfrastructureError>
Source§impl Client
impl Client
Sourcepub fn update_odb_network(&self) -> UpdateOdbNetworkFluentBuilder
pub fn update_odb_network(&self) -> UpdateOdbNetworkFluentBuilder
Constructs a fluent builder for the UpdateOdbNetwork operation.
- The fluent builder is configurable:
odb_network_id(impl Into<String>)/set_odb_network_id(Option<String>):
required: trueThe unique identifier of the ODB network to update.
display_name(impl Into<String>)/set_display_name(Option<String>):
required: falseThe new user-friendly name of the ODB network.
peered_cidrs_to_be_added(impl Into<String>)/set_peered_cidrs_to_be_added(Option<Vec::<String>>):
required: falseThe list of CIDR ranges from the peered VPC that allow access to the ODB network.
peered_cidrs_to_be_removed(impl Into<String>)/set_peered_cidrs_to_be_removed(Option<Vec::<String>>):
required: falseThe list of CIDR ranges from the peered VPC to remove from the ODB network.
s3_access(Access)/set_s3_access(Option<Access>):
required: falseSpecifies the updated configuration for Amazon S3 access from the ODB network.
zero_etl_access(Access)/set_zero_etl_access(Option<Access>):
required: falseSpecifies the updated configuration for Zero-ETL access from the ODB network.
sts_access(Access)/set_sts_access(Option<Access>):
required: falseThe Amazon Web Services Security Token Service (STS) access configuration for the ODB network.
kms_access(Access)/set_kms_access(Option<Access>):
required: falseThe Amazon Web Services Key Management Service (KMS) access configuration for the ODB network.
s3_policy_document(impl Into<String>)/set_s3_policy_document(Option<String>):
required: falseSpecifies the updated endpoint policy for Amazon S3 access from the ODB network.
sts_policy_document(impl Into<String>)/set_sts_policy_document(Option<String>):
required: falseThe STS policy document that defines permissions for token service usage within the ODB network.
kms_policy_document(impl Into<String>)/set_kms_policy_document(Option<String>):
required: falseThe KMS policy document that defines permissions for key usage within the ODB network.
cross_region_s3_restore_sources_to_enable(impl Into<String>)/set_cross_region_s3_restore_sources_to_enable(Option<Vec::<String>>):
required: falseThe cross-Region Amazon S3 restore sources to enable for the ODB network.
cross_region_s3_restore_sources_to_disable(impl Into<String>)/set_cross_region_s3_restore_sources_to_disable(Option<Vec::<String>>):
required: falseThe cross-Region Amazon S3 restore sources to disable for the ODB network.
- On success, responds with
UpdateOdbNetworkOutputwith field(s):display_name(Option<String>):The user-friendly name of the ODB network.
status(Option<ResourceStatus>):The current status of the ODB network.
status_reason(Option<String>):Additional information about the status of the ODB network.
odb_network_id(String):The unique identifier of the ODB network.
- On failure, responds with
SdkError<UpdateOdbNetworkError>
Source§impl Client
impl Client
Sourcepub fn update_odb_peering_connection(
&self,
) -> UpdateOdbPeeringConnectionFluentBuilder
pub fn update_odb_peering_connection( &self, ) -> UpdateOdbPeeringConnectionFluentBuilder
Constructs a fluent builder for the UpdateOdbPeeringConnection operation.
- The fluent builder is configurable:
odb_peering_connection_id(impl Into<String>)/set_odb_peering_connection_id(Option<String>):
required: trueThe identifier of the Oracle Database@Amazon Web Services peering connection to update.
display_name(impl Into<String>)/set_display_name(Option<String>):
required: falseA new display name for the peering connection.
peer_network_cidrs_to_be_added(impl Into<String>)/set_peer_network_cidrs_to_be_added(Option<Vec::<String>>):
required: falseA list of CIDR blocks to add to the peering connection. These CIDR blocks define the IP address ranges that can communicate through the peering connection. The CIDR blocks must not overlap with existing CIDR blocks in the Oracle Database@Amazon Web Services network.
peer_network_cidrs_to_be_removed(impl Into<String>)/set_peer_network_cidrs_to_be_removed(Option<Vec::<String>>):
required: falseA list of CIDR blocks to remove from the peering connection. The CIDR blocks must currently exist in the peering connection.
- On success, responds with
UpdateOdbPeeringConnectionOutputwith field(s):display_name(Option<String>):The display name of the peering connection.
status(Option<ResourceStatus>):The status of the peering connection update operation.
status_reason(Option<String>):Additional information about the status of the peering connection update operation.
odb_peering_connection_id(String):The identifier of the Oracle Database@Amazon Web Services peering connection that was updated.
- On failure, responds with
SdkError<UpdateOdbPeeringConnectionError>
Source§impl Client
impl Client
Sourcepub fn from_conf(conf: Config) -> Self
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_implconfigured. - Identity caching is enabled without a
sleep_implandtime_sourceconfigured. - No
behavior_versionis provided.
The panic message for each of these will have instructions on how to resolve them.
Source§impl Client
impl Client
Sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_configis missing an async sleep implementation. If you experience this panic, set thesleep_implon the Config passed into this function to fix it. - This method will panic if the
sdk_configis missing an HTTP connector. If you experience this panic, set thehttp_connectoron the Config passed into this function to fix it. - This method will panic if no
BehaviorVersionis provided. If you experience this panic, setbehavior_versionon the Config or enable thebehavior-version-latestCargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);