create_ipam_scope¶
Operation¶
async
¶
create_ipam_scope(input: CreateIpamScopeInput, plugins: list[Plugin] | None = None) -> CreateIpamScopeOutput
Create an IPAM scope. 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.
For more information, see Add a scope in the Amazon VPC IPAM User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateIpamScopeInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
CreateIpamScopeOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateIpamScopeInput structure.
Attributes¶
class-attribute
instance-attribute
¶
client_token: str | None = ...
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
class-attribute
instance-attribute
¶
description: str | None = ...
A description for the scope you're creating.
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
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.
class-attribute
instance-attribute
¶
external_authority_configuration: ExternalAuthorityConfiguration | None = ...
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.
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.
class-attribute
instance-attribute
¶
ipam_id: str | None = ...
The ID of the IPAM for which you're creating this scope.
class-attribute
instance-attribute
¶
tag_specifications: list[TagSpecification] | None = ...
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.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateIpamScopeOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
ipam_scope: IpamScope | None = ...
Information about the created scope.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.