Skip to content

VpcBlockPublicAccessOptions

Source code in docs_src/capo_ec2/types/vpc_block_public_access_options.py
class VpcBlockPublicAccessOptions(TypedDict, closed=True):
    aws_account_id: NotRequired["capo_ec2.types.string.String"]
    """<p>An Amazon Web Services account ID.</p>"""
    aws_region: NotRequired["capo_ec2.types.string.String"]
    """<p>An Amazon Web Services Region.</p>"""
    state: NotRequired[
        "capo_ec2.types.vpc_block_public_access_state.VpcBlockPublicAccessState"
    ]
    """<p>The current state of VPC BPA.</p>"""
    internet_gateway_block_mode: NotRequired[
        "capo_ec2.types.internet_gateway_block_mode.InternetGatewayBlockMode"
    ]
    """<p>The current mode of VPC BPA.</p> <ul> <li> <p> <code>off</code>: VPC BPA is not enabled and traffic is allowed to and from internet gateways and egress-only internet gateways in this Region.</p> </li> <li> <p> <code>block-bidirectional</code>: Block all traffic to and from internet gateways and egress-only internet gateways in this Region (except for excluded VPCs and subnets).</p> </li> <li> <p> <code>block-ingress</code>: Block all internet traffic to the VPCs in this Region (except for VPCs or subnets which are excluded). Only traffic to and from NAT gateways and egress-only internet gateways is allowed because these gateways only allow outbound connections to be established.</p> </li> </ul>"""
    reason: NotRequired["capo_ec2.types.string.String"]
    """<p>The reason for the current state.</p>"""
    last_update_timestamp: NotRequired[
        "capo_ec2.types.millisecond_date_time.MillisecondDateTime"
    ]
    """<p>The last time the VPC BPA mode was updated.</p>"""
    managed_by: NotRequired["capo_ec2.types.managed_by.ManagedBy"]
    """<p>The entity that manages the state of VPC BPA. Possible values include:</p> <ul> <li> <p> <code>account</code> - The state is managed by the account.</p> </li> <li> <p> <code>declarative-policy</code> - The state is managed by a declarative policy and can't be modified by the account.</p> </li> </ul>"""
    exclusions_allowed: NotRequired[
        "capo_ec2.types.vpc_block_public_access_exclusions_allowed.VpcBlockPublicAccessExclusionsAllowed"
    ]
    """<p>Determines if exclusions are allowed. If you have <a href="https://docs.aws.amazon.com/vpc/latest/userguide/security-vpc-bpa.html#security-vpc-bpa-exclusions-orgs">enabled VPC BPA at the Organization level</a>, exclusions may be <code>not-allowed</code>. Otherwise, they are <code>allowed</code>.</p>"""

aws_account_id instance-attribute

aws_account_id: NotRequired[String]

An Amazon Web Services account ID.

aws_region instance-attribute

aws_region: NotRequired[String]

An Amazon Web Services Region.

exclusions_allowed instance-attribute

exclusions_allowed: NotRequired[VpcBlockPublicAccessExclusionsAllowed]

Determines if exclusions are allowed. If you have enabled VPC BPA at the Organization level, exclusions may be not-allowed. Otherwise, they are allowed.

internet_gateway_block_mode instance-attribute

internet_gateway_block_mode: NotRequired[InternetGatewayBlockMode]

The current mode of VPC BPA.

  • off: VPC BPA is not enabled and traffic is allowed to and from internet gateways and egress-only internet gateways in this Region.

  • block-bidirectional: Block all traffic to and from internet gateways and egress-only internet gateways in this Region (except for excluded VPCs and subnets).

  • block-ingress: Block all internet traffic to the VPCs in this Region (except for VPCs or subnets which are excluded). Only traffic to and from NAT gateways and egress-only internet gateways is allowed because these gateways only allow outbound connections to be established.

last_update_timestamp instance-attribute

last_update_timestamp: NotRequired[MillisecondDateTime]

The last time the VPC BPA mode was updated.

managed_by instance-attribute

managed_by: NotRequired[ManagedBy]

The entity that manages the state of VPC BPA. Possible values include:

  • account - The state is managed by the account.

  • declarative-policy - The state is managed by a declarative policy and can't be modified by the account.

reason instance-attribute

reason: NotRequired[String]

The reason for the current state.

state instance-attribute

state: NotRequired[VpcBlockPublicAccessState]

The current state of VPC BPA.