Skip to content

NetworkConfigurationDetails

Source code in docs_src/capo_identitystore/types/network_configuration_details.py
class NetworkConfigurationDetails(TypedDict, closed=True):
    vpce_access_required: "capo_identitystore.types.boolean_type.BooleanType"
    """<p>Specifies whether the identity store can be accessed only through a virtual private cloud (VPC) endpoint. When set to <code>true</code>, requests must originate from a VPC endpoint.</p>"""
    api_restrict_source_vpcs: NotRequired[
        "capo_identitystore.types.vpc_id_list.VpcIdList"
    ]
    """<p>A list of virtual private cloud (VPC) IDs that are allowed to access the identity store API operations. A request is denied unless it originates from a VPC in this list, or from an IP address in <code>ApiAllowSourceIps</code> if one is configured. If this field is empty, access isn't restricted to specific VPCs, but the VPC endpoint requirement from <code>VpceAccessRequired</code> still applies.</p>"""
    api_allow_source_ips: NotRequired[
        "capo_identitystore.types.ip_cidr_list.IpCidrList"
    ]
    """<p>A list of IP address CIDR ranges that are allowed to access the identity store API operations. A request from an IP address in this list bypasses the identity store's other API network controls: it's permitted even if it doesn't come through a VPC endpoint required by <code>VpceAccessRequired</code>, and even if it doesn't originate from a VPC in <code>ApiRestrictSourceVpcs</code>. If this field is empty, no such IP address exception applies.</p>"""
    scim_allow_source_ips: NotRequired[
        "capo_identitystore.types.ip_cidr_list.IpCidrList"
    ]
    """<p>A list of IP address CIDR ranges that are allowed to access the identity store through the System for Cross-domain Identity Management (SCIM) protocol. Requests from IP addresses outside these ranges are denied. If this field is empty, SCIM requests remain subject to the identity store's other network controls, such as the VPC endpoint requirement.</p>"""

api_allow_source_ips instance-attribute

api_allow_source_ips: NotRequired[IpCidrList]

A list of IP address CIDR ranges that are allowed to access the identity store API operations. A request from an IP address in this list bypasses the identity store's other API network controls: it's permitted even if it doesn't come through a VPC endpoint required by VpceAccessRequired, and even if it doesn't originate from a VPC in ApiRestrictSourceVpcs. If this field is empty, no such IP address exception applies.

api_restrict_source_vpcs instance-attribute

api_restrict_source_vpcs: NotRequired[VpcIdList]

A list of virtual private cloud (VPC) IDs that are allowed to access the identity store API operations. A request is denied unless it originates from a VPC in this list, or from an IP address in ApiAllowSourceIps if one is configured. If this field is empty, access isn't restricted to specific VPCs, but the VPC endpoint requirement from VpceAccessRequired still applies.

scim_allow_source_ips instance-attribute

scim_allow_source_ips: NotRequired[IpCidrList]

A list of IP address CIDR ranges that are allowed to access the identity store through the System for Cross-domain Identity Management (SCIM) protocol. Requests from IP addresses outside these ranges are denied. If this field is empty, SCIM requests remain subject to the identity store's other network controls, such as the VPC endpoint requirement.

vpce_access_required instance-attribute

vpce_access_required: BooleanType

Specifies whether the identity store can be accessed only through a virtual private cloud (VPC) endpoint. When set to true, requests must originate from a VPC endpoint.