Struct aws_sdk_ec2::types::builders::IpamPoolBuilder

#[non_exhaustive]
pub struct IpamPoolBuilder { /* private fields */ }

A builder for IpamPool.

Implementations

impl IpamPoolBuilder

pub fn owner_id(self, input: impl Into<String>) -> Self

The Amazon Web Services account ID of the owner of the IPAM pool.

pub fn set_owner_id(self, input: Option<String>) -> Self

The Amazon Web Services account ID of the owner of the IPAM pool.

pub fn get_owner_id(&self) -> &Option<String>

The Amazon Web Services account ID of the owner of the IPAM pool.

pub fn ipam_pool_id(self, input: impl Into<String>) -> Self

The ID of the IPAM pool.

pub fn set_ipam_pool_id(self, input: Option<String>) -> Self

The ID of the IPAM pool.

pub fn get_ipam_pool_id(&self) -> &Option<String>

The ID of the IPAM pool.

pub fn source_ipam_pool_id(self, input: impl Into<String>) -> Self

The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.

pub fn set_source_ipam_pool_id(self, input: Option<String>) -> Self

The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.

pub fn get_source_ipam_pool_id(&self) -> &Option<String>

The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.

pub fn ipam_pool_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the IPAM pool.

pub fn set_ipam_pool_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the IPAM pool.

pub fn get_ipam_pool_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) of the IPAM pool.

pub fn ipam_scope_arn(self, input: impl Into<String>) -> Self

The ARN of the scope of the IPAM pool.

pub fn set_ipam_scope_arn(self, input: Option<String>) -> Self

The ARN of the scope of the IPAM pool.

pub fn get_ipam_scope_arn(&self) -> &Option<String>

The ARN of the scope of the IPAM pool.

pub fn ipam_scope_type(self, input: IpamScopeType) -> Self

In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

pub fn set_ipam_scope_type(self, input: Option<IpamScopeType>) -> Self

In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

pub fn get_ipam_scope_type(&self) -> &Option<IpamScopeType>

In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

pub fn ipam_arn(self, input: impl Into<String>) -> Self

The ARN of the IPAM.

pub fn set_ipam_arn(self, input: Option<String>) -> Self

The ARN of the IPAM.

pub fn get_ipam_arn(&self) -> &Option<String>

The ARN of the IPAM.

pub fn ipam_region(self, input: impl Into<String>) -> Self

The Amazon Web Services Region of the IPAM pool.

pub fn set_ipam_region(self, input: Option<String>) -> Self

The Amazon Web Services Region of the IPAM pool.

pub fn get_ipam_region(&self) -> &Option<String>

The Amazon Web Services Region of the IPAM pool.

pub fn locale(self, input: impl Into<String>) -> Self

The locale of the IPAM pool. In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.

pub fn set_locale(self, input: Option<String>) -> Self

The locale of the IPAM pool. In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.

pub fn get_locale(&self) -> &Option<String>

The locale of the IPAM pool. In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.

pub fn pool_depth(self, input: i32) -> Self

The depth of pools in your IPAM pool. The pool depth quota is 10. For more information, see Quotas in IPAM in the Amazon VPC IPAM User Guide.

pub fn set_pool_depth(self, input: Option<i32>) -> Self

The depth of pools in your IPAM pool. The pool depth quota is 10. For more information, see Quotas in IPAM in the Amazon VPC IPAM User Guide.

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

The depth of pools in your IPAM pool. The pool depth quota is 10. For more information, see Quotas in IPAM in the Amazon VPC IPAM User Guide.

pub fn state(self, input: IpamPoolState) -> Self

The state of the IPAM pool.

pub fn set_state(self, input: Option<IpamPoolState>) -> Self

The state of the IPAM pool.

pub fn get_state(&self) -> &Option<IpamPoolState>

The state of the IPAM pool.

pub fn state_message(self, input: impl Into<String>) -> Self

A message related to the failed creation of an IPAM pool.

pub fn set_state_message(self, input: Option<String>) -> Self

A message related to the failed creation of an IPAM pool.

pub fn get_state_message(&self) -> &Option<String>

A message related to the failed creation of an IPAM pool.

pub fn description(self, input: impl Into<String>) -> Self

The description of the IPAM pool.

pub fn set_description(self, input: Option<String>) -> Self

The description of the IPAM pool.

pub fn get_description(&self) -> &Option<String>

The description of the IPAM pool.

pub fn auto_import(self, input: bool) -> Self

If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

A locale must be set on the pool for this feature to work.

pub fn set_auto_import(self, input: Option<bool>) -> Self

If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

A locale must be set on the pool for this feature to work.

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

If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

A locale must be set on the pool for this feature to work.

pub fn publicly_advertisable(self, input: bool) -> Self

Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.

pub fn set_publicly_advertisable(self, input: Option<bool>) -> Self

Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.

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

Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.

pub fn address_family(self, input: AddressFamily) -> Self

The address family of the pool.

pub fn set_address_family(self, input: Option<AddressFamily>) -> Self

The address family of the pool.

pub fn get_address_family(&self) -> &Option<AddressFamily>

The address family of the pool.

pub fn allocation_min_netmask_length(self, input: i32) -> Self

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

pub fn set_allocation_min_netmask_length(self, input: Option<i32>) -> Self

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

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

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

pub fn allocation_max_netmask_length(self, input: i32) -> Self

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

pub fn set_allocation_max_netmask_length(self, input: Option<i32>) -> Self

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

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

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

pub fn allocation_default_netmask_length(self, input: i32) -> Self

The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.

pub fn set_allocation_default_netmask_length(self, input: Option<i32>) -> Self

The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.

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

The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.

pub fn allocation_resource_tags(self, input: IpamResourceTag) -> Self

Appends an item to allocation_resource_tags.

To override the contents of this collection use set_allocation_resource_tags.

Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.

pub fn set_allocation_resource_tags( self, input: Option<Vec<IpamResourceTag>> ) -> Self

Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.

pub fn get_allocation_resource_tags(&self) -> &Option<Vec<IpamResourceTag>>

Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.

pub fn tags(self, input: Tag) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

pub fn get_tags(&self) -> &Option<Vec<Tag>>

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

pub fn aws_service(self, input: IpamPoolAwsService) -> Self

Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.

pub fn set_aws_service(self, input: Option<IpamPoolAwsService>) -> Self

Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.

pub fn get_aws_service(&self) -> &Option<IpamPoolAwsService>

Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.

pub fn public_ip_source(self, input: IpamPoolPublicIpSource) -> Self

The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is BYOIP. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

pub fn set_public_ip_source(self, input: Option<IpamPoolPublicIpSource>) -> Self

The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is BYOIP. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

pub fn get_public_ip_source(&self) -> &Option<IpamPoolPublicIpSource>

The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is BYOIP. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

pub fn build(self) -> IpamPool

Consumes the builder and constructs a IpamPool.

Trait Implementations

impl Clone for IpamPoolBuilder

fn clone(&self) -> IpamPoolBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IpamPoolBuilder

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

Formats the value using the given formatter.

impl Default for IpamPoolBuilder

fn default() -> IpamPoolBuilder

Returns the “default value” for a type.

impl PartialEq<IpamPoolBuilder> for IpamPoolBuilder

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for IpamPoolBuilder