create_ipam¶
Operation¶
async
¶
create_ipam(input: CreateIpamInput, plugins: list[Plugin] | None = None) -> CreateIpamOutput
Create an IPAM. Amazon VPC IP Address Manager (IPAM) is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization.
For more information, see Create an IPAM in the Amazon VPC IPAM User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateIpamInput
|
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 |
|---|---|
CreateIpamOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateIpamInput 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.
This field is autopopulated if not provided.
class-attribute
instance-attribute
¶
description: str | None = ...
A description for the IPAM.
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
¶
enable_private_gua: bool | None = ...
Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.
class-attribute
instance-attribute
¶
metered_account: str | None = ...
A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide.
Possible values:
-
ipam-owner(default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM. -
resource-owner: The Amazon Web Services account that owns the IP address is charged for the active IP address.
class-attribute
instance-attribute
¶
operating_regions: list[AddIpamOperatingRegion] | None = ...
The operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
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.
class-attribute
instance-attribute
¶
tier: str | None = ...
IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateIpamOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
Information about the IPAM created.
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.