pub struct Builder { /* private fields */ }
Expand description

A builder for ModifyIpamPoolInput.

Implementations§

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.

Examples found in repository?
src/client.rs (line 66003)
66002
66003
66004
66005
        pub fn dry_run(mut self, input: bool) -> Self {
            self.inner = self.inner.dry_run(input);
            self
        }

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.

Examples found in repository?
src/client.rs (line 66008)
66007
66008
66009
66010
        pub fn set_dry_run(mut self, input: std::option::Option<bool>) -> Self {
            self.inner = self.inner.set_dry_run(input);
            self
        }

The ID of the IPAM pool you want to modify.

Examples found in repository?
src/client.rs (line 66013)
66012
66013
66014
66015
        pub fn ipam_pool_id(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.ipam_pool_id(input.into());
            self
        }

The ID of the IPAM pool you want to modify.

Examples found in repository?
src/client.rs (line 66018)
66017
66018
66019
66020
        pub fn set_ipam_pool_id(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_ipam_pool_id(input);
            self
        }

The description of the IPAM pool you want to modify.

Examples found in repository?
src/client.rs (line 66023)
66022
66023
66024
66025
        pub fn description(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.description(input.into());
            self
        }

The description of the IPAM pool you want to modify.

Examples found in repository?
src/client.rs (line 66028)
66027
66028
66029
66030
        pub fn set_description(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_description(input);
            self
        }

If true, 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.

Examples found in repository?
src/client.rs (line 66034)
66033
66034
66035
66036
        pub fn auto_import(mut self, input: bool) -> Self {
            self.inner = self.inner.auto_import(input);
            self
        }

If true, 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.

Examples found in repository?
src/client.rs (line 66040)
66039
66040
66041
66042
        pub fn set_auto_import(mut self, input: std::option::Option<bool>) -> Self {
            self.inner = self.inner.set_auto_import(input);
            self
        }

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

Examples found in repository?
src/client.rs (line 66045)
66044
66045
66046
66047
        pub fn allocation_min_netmask_length(mut self, input: i32) -> Self {
            self.inner = self.inner.allocation_min_netmask_length(input);
            self
        }

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

Examples found in repository?
src/client.rs (line 66053)
66049
66050
66051
66052
66053
66054
66055
        pub fn set_allocation_min_netmask_length(
            mut self,
            input: std::option::Option<i32>,
        ) -> Self {
            self.inner = self.inner.set_allocation_min_netmask_length(input);
            self
        }

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

Examples found in repository?
src/client.rs (line 66058)
66057
66058
66059
66060
        pub fn allocation_max_netmask_length(mut self, input: i32) -> Self {
            self.inner = self.inner.allocation_max_netmask_length(input);
            self
        }

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

Examples found in repository?
src/client.rs (line 66066)
66062
66063
66064
66065
66066
66067
66068
        pub fn set_allocation_max_netmask_length(
            mut self,
            input: std::option::Option<i32>,
        ) -> Self {
            self.inner = self.inner.set_allocation_max_netmask_length(input);
            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.

Examples found in repository?
src/client.rs (line 66071)
66070
66071
66072
66073
        pub fn allocation_default_netmask_length(mut self, input: i32) -> Self {
            self.inner = self.inner.allocation_default_netmask_length(input);
            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.

Examples found in repository?
src/client.rs (line 66079)
66075
66076
66077
66078
66079
66080
66081
        pub fn set_allocation_default_netmask_length(
            mut self,
            input: std::option::Option<i32>,
        ) -> Self {
            self.inner = self.inner.set_allocation_default_netmask_length(input);
            self
        }

Clear the default netmask length allocation rule for this pool.

Examples found in repository?
src/client.rs (line 66084)
66083
66084
66085
66086
        pub fn clear_allocation_default_netmask_length(mut self, input: bool) -> Self {
            self.inner = self.inner.clear_allocation_default_netmask_length(input);
            self
        }

Clear the default netmask length allocation rule for this pool.

Examples found in repository?
src/client.rs (line 66094)
66088
66089
66090
66091
66092
66093
66094
66095
66096
        pub fn set_clear_allocation_default_netmask_length(
            mut self,
            input: std::option::Option<bool>,
        ) -> Self {
            self.inner = self
                .inner
                .set_clear_allocation_default_netmask_length(input);
            self
        }

Appends an item to add_allocation_resource_tags.

To override the contents of this collection use set_add_allocation_resource_tags.

Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.

Examples found in repository?
src/client.rs (line 66106)
66102
66103
66104
66105
66106
66107
66108
        pub fn add_allocation_resource_tags(
            mut self,
            input: crate::model::RequestIpamResourceTag,
        ) -> Self {
            self.inner = self.inner.add_allocation_resource_tags(input);
            self
        }

Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.

Examples found in repository?
src/client.rs (line 66114)
66110
66111
66112
66113
66114
66115
66116
        pub fn set_add_allocation_resource_tags(
            mut self,
            input: std::option::Option<std::vec::Vec<crate::model::RequestIpamResourceTag>>,
        ) -> Self {
            self.inner = self.inner.set_add_allocation_resource_tags(input);
            self
        }

Appends an item to remove_allocation_resource_tags.

To override the contents of this collection use set_remove_allocation_resource_tags.

Remove tag allocation rules from a pool.

Examples found in repository?
src/client.rs (line 66126)
66122
66123
66124
66125
66126
66127
66128
        pub fn remove_allocation_resource_tags(
            mut self,
            input: crate::model::RequestIpamResourceTag,
        ) -> Self {
            self.inner = self.inner.remove_allocation_resource_tags(input);
            self
        }

Remove tag allocation rules from a pool.

Examples found in repository?
src/client.rs (line 66134)
66130
66131
66132
66133
66134
66135
66136
        pub fn set_remove_allocation_resource_tags(
            mut self,
            input: std::option::Option<std::vec::Vec<crate::model::RequestIpamResourceTag>>,
        ) -> Self {
            self.inner = self.inner.set_remove_allocation_resource_tags(input);
            self
        }

Consumes the builder and constructs a ModifyIpamPoolInput.

Examples found in repository?
src/client.rs (line 65970)
65958
65959
65960
65961
65962
65963
65964
65965
65966
65967
65968
65969
65970
65971
65972
65973
65974
65975
65976
65977
65978
65979
65980
65981
65982
65983
65984
65985
65986
65987
65988
65989
65990
65991
65992
65993
65994
65995
65996
65997
65998
65999
66000
        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::ModifyIpamPool,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::ModifyIpamPoolError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// Sends the request and returns the response.
        ///
        /// If an error occurs, an `SdkError` will be returned with additional details that
        /// can be matched against.
        ///
        /// By default, any retryable failures will be retried twice. Retry behavior
        /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::ModifyIpamPoolOutput,
            aws_smithy_http::result::SdkError<crate::error::ModifyIpamPoolError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Returns the “default value” for a type. Read more
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more