aws_sdk_ec2/client/
create_ipam_scope.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 [`CreateIpamScope`](crate::operation::create_ipam_scope::builders::CreateIpamScopeFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`dry_run(bool)`](crate::operation::create_ipam_scope::builders::CreateIpamScopeFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::create_ipam_scope::builders::CreateIpamScopeFluentBuilder::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_id(impl Into<String>)`](crate::operation::create_ipam_scope::builders::CreateIpamScopeFluentBuilder::ipam_id) / [`set_ipam_id(Option<String>)`](crate::operation::create_ipam_scope::builders::CreateIpamScopeFluentBuilder::set_ipam_id):<br>required: **true**<br><p>The ID of the IPAM for which you're creating this scope.</p><br>
8    ///   - [`description(impl Into<String>)`](crate::operation::create_ipam_scope::builders::CreateIpamScopeFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_ipam_scope::builders::CreateIpamScopeFluentBuilder::set_description):<br>required: **false**<br><p>A description for the scope you're creating.</p><br>
9    ///   - [`tag_specifications(TagSpecification)`](crate::operation::create_ipam_scope::builders::CreateIpamScopeFluentBuilder::tag_specifications) / [`set_tag_specifications(Option<Vec::<TagSpecification>>)`](crate::operation::create_ipam_scope::builders::CreateIpamScopeFluentBuilder::set_tag_specifications):<br>required: **false**<br><p>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 <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p><br>
10    ///   - [`client_token(impl Into<String>)`](crate::operation::create_ipam_scope::builders::CreateIpamScopeFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_ipam_scope::builders::CreateIpamScopeFluentBuilder::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>
11    ///   - [`external_authority_configuration(ExternalAuthorityConfiguration)`](crate::operation::create_ipam_scope::builders::CreateIpamScopeFluentBuilder::external_authority_configuration) / [`set_external_authority_configuration(Option<ExternalAuthorityConfiguration>)`](crate::operation::create_ipam_scope::builders::CreateIpamScopeFluentBuilder::set_external_authority_configuration):<br>required: **false**<br><p>The configuration that links an Amazon VPC IPAM scope to an external authority system. It specifies the type of external system and the external resource identifier that identifies your account or instance in that system.</p> <p>In IPAM, an external authority is a third-party IP address management system that provides CIDR blocks when you provision address space for top-level IPAM pools. This allows you to use your existing IP management system to control which address ranges are allocated to Amazon Web Services while using Amazon VPC IPAM to manage subnets within those ranges.</p><br>
12    /// - On success, responds with [`CreateIpamScopeOutput`](crate::operation::create_ipam_scope::CreateIpamScopeOutput) with field(s):
13    ///   - [`ipam_scope(Option<IpamScope>)`](crate::operation::create_ipam_scope::CreateIpamScopeOutput::ipam_scope): <p>Information about the created scope.</p>
14    /// - On failure, responds with [`SdkError<CreateIpamScopeError>`](crate::operation::create_ipam_scope::CreateIpamScopeError)
15    pub fn create_ipam_scope(&self) -> crate::operation::create_ipam_scope::builders::CreateIpamScopeFluentBuilder {
16        crate::operation::create_ipam_scope::builders::CreateIpamScopeFluentBuilder::new(self.handle.clone())
17    }
18}