Skip to content

IpamScope

Source code in docs_src/capo_ec2/types/ipam_scope.py
class IpamScope(TypedDict, closed=True):
    owner_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The Amazon Web Services account ID of the owner of the scope.</p>"""
    ipam_scope_id: NotRequired["capo_ec2.types.ipam_scope_id.IpamScopeId"]
    """<p>The ID of the scope.</p>"""
    ipam_scope_arn: NotRequired["capo_ec2.types.resource_arn.ResourceArn"]
    """<p>The Amazon Resource Name (ARN) of the scope.</p>"""
    ipam_arn: NotRequired["capo_ec2.types.resource_arn.ResourceArn"]
    """<p>The ARN of the IPAM.</p>"""
    ipam_region: NotRequired["capo_ec2.types.string.String"]
    """<p>The Amazon Web Services Region of the IPAM scope.</p>"""
    ipam_scope_type: NotRequired["capo_ec2.types.ipam_scope_type.IpamScopeType"]
    """<p>The type of the scope.</p>"""
    is_default: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Defines if the scope is the default scope or not.</p>"""
    description: NotRequired["capo_ec2.types.string.String"]
    """<p>The description of the scope.</p>"""
    pool_count: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>The number of pools in the scope.</p>"""
    state: NotRequired["capo_ec2.types.ipam_scope_state.IpamScopeState"]
    """<p>The state of the IPAM scope.</p>"""
    tags: NotRequired["capo_ec2.types.tag_list.TagList"]
    """<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>"""
    external_authority_configuration: NotRequired[
        "capo_ec2.types.ipam_scope_external_authority_configuration.IpamScopeExternalAuthorityConfiguration"
    ]
    """<p>The external authority configuration for this IPAM scope, if configured.</p> <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>"""

description instance-attribute

description: NotRequired[String]

The description of the scope.

external_authority_configuration instance-attribute

external_authority_configuration: NotRequired[IpamScopeExternalAuthorityConfiguration]

The external authority configuration for this IPAM scope, if configured.

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_arn instance-attribute

ipam_arn: NotRequired[ResourceArn]

The ARN of the IPAM.

ipam_region instance-attribute

ipam_region: NotRequired[String]

The Amazon Web Services Region of the IPAM scope.

ipam_scope_arn instance-attribute

ipam_scope_arn: NotRequired[ResourceArn]

The Amazon Resource Name (ARN) of the scope.

ipam_scope_id instance-attribute

ipam_scope_id: NotRequired[IpamScopeId]

The ID of the scope.

ipam_scope_type instance-attribute

ipam_scope_type: NotRequired[IpamScopeType]

The type of the scope.

is_default instance-attribute

is_default: NotRequired[Boolean]

Defines if the scope is the default scope or not.

owner_id instance-attribute

owner_id: NotRequired[String]

The Amazon Web Services account ID of the owner of the scope.

pool_count instance-attribute

pool_count: NotRequired[Integer]

The number of pools in the scope.

state instance-attribute

state: NotRequired[IpamScopeState]

The state of the IPAM scope.

tags instance-attribute

tags: NotRequired[TagList]

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.