aws_sdk_odb/client/
create_odb_network.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`CreateOdbNetwork`](crate::operation::create_odb_network::builders::CreateOdbNetworkFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`display_name(impl Into<String>)`](crate::operation::create_odb_network::builders::CreateOdbNetworkFluentBuilder::display_name) / [`set_display_name(Option<String>)`](crate::operation::create_odb_network::builders::CreateOdbNetworkFluentBuilder::set_display_name):<br>required: **true**<br><p>A user-friendly name for the ODB network.</p><br>
7    ///   - [`availability_zone(impl Into<String>)`](crate::operation::create_odb_network::builders::CreateOdbNetworkFluentBuilder::availability_zone) / [`set_availability_zone(Option<String>)`](crate::operation::create_odb_network::builders::CreateOdbNetworkFluentBuilder::set_availability_zone):<br>required: **false**<br><p>The Amazon Web Services Availability Zone (AZ) where the ODB network is located.</p> <p>This operation requires that you specify a value for either <code>availabilityZone</code> or <code>availabilityZoneId</code>.</p><br>
8    ///   - [`availability_zone_id(impl Into<String>)`](crate::operation::create_odb_network::builders::CreateOdbNetworkFluentBuilder::availability_zone_id) / [`set_availability_zone_id(Option<String>)`](crate::operation::create_odb_network::builders::CreateOdbNetworkFluentBuilder::set_availability_zone_id):<br>required: **false**<br><p>The AZ ID of the AZ where the ODB network is located.</p> <p>This operation requires that you specify a value for either <code>availabilityZone</code> or <code>availabilityZoneId</code>.</p><br>
9    ///   - [`client_subnet_cidr(impl Into<String>)`](crate::operation::create_odb_network::builders::CreateOdbNetworkFluentBuilder::client_subnet_cidr) / [`set_client_subnet_cidr(Option<String>)`](crate::operation::create_odb_network::builders::CreateOdbNetworkFluentBuilder::set_client_subnet_cidr):<br>required: **true**<br><p>The CIDR range of the client subnet for the ODB network.</p> <p>Constraints:</p> <ul>  <li>   <p>Must not overlap with the CIDR range of the backup subnet.</p></li>  <li>   <p>Must not overlap with the CIDR ranges of the VPCs that are connected to the ODB network.</p></li>  <li>   <p>Must not use the following CIDR ranges that are reserved by OCI:</p>   <ul>    <li>     <p><code>100.106.0.0/16</code> and <code>100.107.0.0/16</code></p></li>    <li>     <p><code>169.254.0.0/16</code></p></li>    <li>     <p><code>224.0.0.0 - 239.255.255.255</code></p></li>    <li>     <p><code>240.0.0.0 - 255.255.255.255</code></p></li>   </ul></li> </ul><br>
10    ///   - [`backup_subnet_cidr(impl Into<String>)`](crate::operation::create_odb_network::builders::CreateOdbNetworkFluentBuilder::backup_subnet_cidr) / [`set_backup_subnet_cidr(Option<String>)`](crate::operation::create_odb_network::builders::CreateOdbNetworkFluentBuilder::set_backup_subnet_cidr):<br>required: **false**<br><p>The CIDR range of the backup subnet for the ODB network.</p> <p>Constraints:</p> <ul>  <li>   <p>Must not overlap with the CIDR range of the client subnet.</p></li>  <li>   <p>Must not overlap with the CIDR ranges of the VPCs that are connected to the ODB network.</p></li>  <li>   <p>Must not use the following CIDR ranges that are reserved by OCI:</p>   <ul>    <li>     <p><code>100.106.0.0/16</code> and <code>100.107.0.0/16</code></p></li>    <li>     <p><code>169.254.0.0/16</code></p></li>    <li>     <p><code>224.0.0.0 - 239.255.255.255</code></p></li>    <li>     <p><code>240.0.0.0 - 255.255.255.255</code></p></li>   </ul></li> </ul><br>
11    ///   - [`custom_domain_name(impl Into<String>)`](crate::operation::create_odb_network::builders::CreateOdbNetworkFluentBuilder::custom_domain_name) / [`set_custom_domain_name(Option<String>)`](crate::operation::create_odb_network::builders::CreateOdbNetworkFluentBuilder::set_custom_domain_name):<br>required: **false**<br><p>The domain name to use for the resources in the ODB network.</p><br>
12    ///   - [`default_dns_prefix(impl Into<String>)`](crate::operation::create_odb_network::builders::CreateOdbNetworkFluentBuilder::default_dns_prefix) / [`set_default_dns_prefix(Option<String>)`](crate::operation::create_odb_network::builders::CreateOdbNetworkFluentBuilder::set_default_dns_prefix):<br>required: **false**<br><p>The DNS prefix to the default DNS domain name. The default DNS domain name is oraclevcn.com.</p><br>
13    ///   - [`client_token(impl Into<String>)`](crate::operation::create_odb_network::builders::CreateOdbNetworkFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_odb_network::builders::CreateOdbNetworkFluentBuilder::set_client_token):<br>required: **false**<br><p>A 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.</p><br>
14    ///   - [`s3_access(Access)`](crate::operation::create_odb_network::builders::CreateOdbNetworkFluentBuilder::s3_access) / [`set_s3_access(Option<Access>)`](crate::operation::create_odb_network::builders::CreateOdbNetworkFluentBuilder::set_s3_access):<br>required: **false**<br><p>Specifies the configuration for Amazon S3 access from the ODB network.</p><br>
15    ///   - [`zero_etl_access(Access)`](crate::operation::create_odb_network::builders::CreateOdbNetworkFluentBuilder::zero_etl_access) / [`set_zero_etl_access(Option<Access>)`](crate::operation::create_odb_network::builders::CreateOdbNetworkFluentBuilder::set_zero_etl_access):<br>required: **false**<br><p>Specifies the configuration for Zero-ETL access from the ODB network.</p><br>
16    ///   - [`s3_policy_document(impl Into<String>)`](crate::operation::create_odb_network::builders::CreateOdbNetworkFluentBuilder::s3_policy_document) / [`set_s3_policy_document(Option<String>)`](crate::operation::create_odb_network::builders::CreateOdbNetworkFluentBuilder::set_s3_policy_document):<br>required: **false**<br><p>Specifies the endpoint policy for Amazon S3 access from the ODB network.</p><br>
17    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_odb_network::builders::CreateOdbNetworkFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_odb_network::builders::CreateOdbNetworkFluentBuilder::set_tags):<br>required: **false**<br><p>The list of resource tags to apply to the ODB network.</p><br>
18    /// - On success, responds with [`CreateOdbNetworkOutput`](crate::operation::create_odb_network::CreateOdbNetworkOutput) with field(s):
19    ///   - [`display_name(Option<String>)`](crate::operation::create_odb_network::CreateOdbNetworkOutput::display_name): <p>The user-friendly name of the ODB network.</p>
20    ///   - [`status(Option<ResourceStatus>)`](crate::operation::create_odb_network::CreateOdbNetworkOutput::status): <p>The current status of the ODB network.</p>
21    ///   - [`status_reason(Option<String>)`](crate::operation::create_odb_network::CreateOdbNetworkOutput::status_reason): <p>Additional information about the status of the ODB network.</p>
22    ///   - [`odb_network_id(String)`](crate::operation::create_odb_network::CreateOdbNetworkOutput::odb_network_id): <p>The unique identifier of the ODB network.</p>
23    /// - On failure, responds with [`SdkError<CreateOdbNetworkError>`](crate::operation::create_odb_network::CreateOdbNetworkError)
24    pub fn create_odb_network(&self) -> crate::operation::create_odb_network::builders::CreateOdbNetworkFluentBuilder {
25        crate::operation::create_odb_network::builders::CreateOdbNetworkFluentBuilder::new(self.handle.clone())
26    }
27}