aws_sdk_ec2/client/
provision_ipam_pool_cidr.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 [`ProvisionIpamPoolCidr`](crate::operation::provision_ipam_pool_cidr::builders::ProvisionIpamPoolCidrFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`dry_run(bool)`](crate::operation::provision_ipam_pool_cidr::builders::ProvisionIpamPoolCidrFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::provision_ipam_pool_cidr::builders::ProvisionIpamPoolCidrFluentBuilder::set_dry_run):<br>required: **false**<br><p>A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p><br>
7    ///   - [`ipam_pool_id(impl Into<String>)`](crate::operation::provision_ipam_pool_cidr::builders::ProvisionIpamPoolCidrFluentBuilder::ipam_pool_id) / [`set_ipam_pool_id(Option<String>)`](crate::operation::provision_ipam_pool_cidr::builders::ProvisionIpamPoolCidrFluentBuilder::set_ipam_pool_id):<br>required: **true**<br><p>The ID of the IPAM pool to which you want to assign a CIDR.</p><br>
8    ///   - [`cidr(impl Into<String>)`](crate::operation::provision_ipam_pool_cidr::builders::ProvisionIpamPoolCidrFluentBuilder::cidr) / [`set_cidr(Option<String>)`](crate::operation::provision_ipam_pool_cidr::builders::ProvisionIpamPoolCidrFluentBuilder::set_cidr):<br>required: **false**<br><p>The CIDR you want to assign to the IPAM pool. Either "NetmaskLength" or "Cidr" is required. This value will be null if you specify "NetmaskLength" and will be filled in during the provisioning process.</p><br>
9    ///   - [`cidr_authorization_context(IpamCidrAuthorizationContext)`](crate::operation::provision_ipam_pool_cidr::builders::ProvisionIpamPoolCidrFluentBuilder::cidr_authorization_context) / [`set_cidr_authorization_context(Option<IpamCidrAuthorizationContext>)`](crate::operation::provision_ipam_pool_cidr::builders::ProvisionIpamPoolCidrFluentBuilder::set_cidr_authorization_context):<br>required: **false**<br><p>A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option only applies to IPv4 and IPv6 pools in the public scope.</p><br>
10    ///   - [`netmask_length(i32)`](crate::operation::provision_ipam_pool_cidr::builders::ProvisionIpamPoolCidrFluentBuilder::netmask_length) / [`set_netmask_length(Option<i32>)`](crate::operation::provision_ipam_pool_cidr::builders::ProvisionIpamPoolCidrFluentBuilder::set_netmask_length):<br>required: **false**<br><p>The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. Either "NetmaskLength" or "Cidr" is required.</p><br>
11    ///   - [`client_token(impl Into<String>)`](crate::operation::provision_ipam_pool_cidr::builders::ProvisionIpamPoolCidrFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::provision_ipam_pool_cidr::builders::ProvisionIpamPoolCidrFluentBuilder::set_client_token):<br>required: **false**<br><p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html">Ensuring idempotency</a>.</p><br>
12    ///   - [`verification_method(VerificationMethod)`](crate::operation::provision_ipam_pool_cidr::builders::ProvisionIpamPoolCidrFluentBuilder::verification_method) / [`set_verification_method(Option<VerificationMethod>)`](crate::operation::provision_ipam_pool_cidr::builders::ProvisionIpamPoolCidrFluentBuilder::set_verification_method):<br>required: **false**<br><p>The method for verifying control of a public IP address range. Defaults to <code>remarks-x509</code> if not specified. This option only applies to IPv4 and IPv6 pools in the public scope.</p><br>
13    ///   - [`ipam_external_resource_verification_token_id(impl Into<String>)`](crate::operation::provision_ipam_pool_cidr::builders::ProvisionIpamPoolCidrFluentBuilder::ipam_external_resource_verification_token_id) / [`set_ipam_external_resource_verification_token_id(Option<String>)`](crate::operation::provision_ipam_pool_cidr::builders::ProvisionIpamPoolCidrFluentBuilder::set_ipam_external_resource_verification_token_id):<br>required: **false**<br><p>Verification token ID. This option only applies to IPv4 and IPv6 pools in the public scope.</p><br>
14    /// - On success, responds with [`ProvisionIpamPoolCidrOutput`](crate::operation::provision_ipam_pool_cidr::ProvisionIpamPoolCidrOutput) with field(s):
15    ///   - [`ipam_pool_cidr(Option<IpamPoolCidr>)`](crate::operation::provision_ipam_pool_cidr::ProvisionIpamPoolCidrOutput::ipam_pool_cidr): <p>Information about the provisioned CIDR.</p>
16    /// - On failure, responds with [`SdkError<ProvisionIpamPoolCidrError>`](crate::operation::provision_ipam_pool_cidr::ProvisionIpamPoolCidrError)
17    pub fn provision_ipam_pool_cidr(&self) -> crate::operation::provision_ipam_pool_cidr::builders::ProvisionIpamPoolCidrFluentBuilder {
18        crate::operation::provision_ipam_pool_cidr::builders::ProvisionIpamPoolCidrFluentBuilder::new(self.handle.clone())
19    }
20}