Skip to content

EC2  >  Operations  >  create_ipam_scope

create_ipam_scope

Operation

create_ipam_scope async

create_ipam_scope(request: CreateIpamScopeInput | CreateIpamScopeInputDict, /, *, plugins: list[Plugin] | None = None) -> CreateIpamScopeOutput
create_ipam_scope(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateIpamScopeInputDict]) -> 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
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 CreateIpamScopeOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

CreateIpamScopeInput dataclass

Bases: _SerdeShape

Dataclass for CreateIpamScopeInput structure.

Attributes
client_token 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.

description class-attribute instance-attribute
description: str | None = ...

A description for the scope you're creating.

dry_run 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.

external_authority_configuration 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.

ipam_id class-attribute instance-attribute
ipam_id: str | None = ...

The ID of the IPAM for which you're creating this scope.

tag_specifications 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.

Dictionaries

CreateIpamScopeInputDict

Bases: TypedDict

Dictionary form of CreateIpamScopeInput.

Attributes
client_token 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.

description instance-attribute
description: str | None

A description for the scope you're creating.

dry_run 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.

external_authority_configuration instance-attribute
external_authority_configuration: ExternalAuthorityConfiguration | ExternalAuthorityConfigurationDict | 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.

ipam_id instance-attribute
ipam_id: Required[str]

The ID of the IPAM for which you're creating this scope.

tag_specifications instance-attribute
tag_specifications: Sequence[TagSpecification | TagSpecificationDict] | 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

CreateIpamScopeOutput dataclass

Bases: _SerdeShape

Dataclass for CreateIpamScopeOutput structure.

Attributes

ipam_scope class-attribute instance-attribute
ipam_scope: IpamScope | None = ...

Information about the created scope.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.