Struct AllocateIpamPoolCidrInput

#[non_exhaustive]
pub struct AllocateIpamPoolCidrInput {
    pub dry_run: Option<bool>,
    pub ipam_pool_id: Option<String>,
    pub cidr: Option<String>,
    pub netmask_length: Option<i32>,
    pub client_token: Option<String>,
    pub description: Option<String>,
    pub preview_next_cidr: Option<bool>,
    pub allowed_cidrs: Option<Vec<String>>,
    pub disallowed_cidrs: Option<Vec<String>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

dry_run: Option<bool>

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 DryRunOperation. Otherwise, it is UnauthorizedOperation.

ipam_pool_id: Option<String>

The ID of the IPAM pool from which you would like to allocate a CIDR.

cidr: Option<String>

The CIDR you would like to allocate from the IPAM pool. Note the following:

• If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.

• If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.

Possible values: Any available IPv4 or IPv6 CIDR.

netmask_length: Option<i32>

The netmask length of the CIDR you would like to allocate from the IPAM pool. Note the following:

• If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.

• If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.

Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

client_token: Option<String>

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

description: Option<String>

A description for the allocation.

preview_next_cidr: Option<bool>

A preview of the next available CIDR in a pool.

allowed_cidrs: Option<Vec<String>>

Include a particular CIDR range that can be returned by the pool. Allowed CIDRs are only allowed if using netmask length for allocation.

disallowed_cidrs: Option<Vec<String>>

Exclude a particular CIDR range from being returned by the pool. Disallowed CIDRs are only allowed if using netmask length for allocation.

Implementations

impl AllocateIpamPoolCidrInput

pub fn dry_run(&self) -> Option<bool>

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 DryRunOperation. Otherwise, it is UnauthorizedOperation.

pub fn ipam_pool_id(&self) -> Option<&str>

The ID of the IPAM pool from which you would like to allocate a CIDR.

pub fn cidr(&self) -> Option<&str>

The CIDR you would like to allocate from the IPAM pool. Note the following:

• If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.

• If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.

Possible values: Any available IPv4 or IPv6 CIDR.

pub fn netmask_length(&self) -> Option<i32>

The netmask length of the CIDR you would like to allocate from the IPAM pool. Note the following:

• If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.

• If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.

Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

pub fn client_token(&self) -> Option<&str>

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

pub fn description(&self) -> Option<&str>

A description for the allocation.

pub fn preview_next_cidr(&self) -> Option<bool>

A preview of the next available CIDR in a pool.

pub fn allowed_cidrs(&self) -> &[String]

Include a particular CIDR range that can be returned by the pool. Allowed CIDRs are only allowed if using netmask length for allocation.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .allowed_cidrs.is_none().

pub fn disallowed_cidrs(&self) -> &[String]

Exclude a particular CIDR range from being returned by the pool. Disallowed CIDRs are only allowed if using netmask length for allocation.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .disallowed_cidrs.is_none().

impl AllocateIpamPoolCidrInput

pub fn builder() -> AllocateIpamPoolCidrInputBuilder

Creates a new builder-style object to manufacture AllocateIpamPoolCidrInput.

Trait Implementations

impl Clone for AllocateIpamPoolCidrInput

fn clone(&self) -> AllocateIpamPoolCidrInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AllocateIpamPoolCidrInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for AllocateIpamPoolCidrInput

fn eq(&self, other: &AllocateIpamPoolCidrInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AllocateIpamPoolCidrInput