Skip to content

VpcEndpoint

Source code in docs_src/capo_ec2/types/vpc_endpoint.py
class VpcEndpoint(TypedDict, closed=True):
    vpc_endpoint_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the endpoint.</p>"""
    vpc_endpoint_type: NotRequired["capo_ec2.types.vpc_endpoint_type.VpcEndpointType"]
    """<p>The type of endpoint.</p> <p>For more information about the types of VPC endpoints, see <a href="https://docs.aws.amazon.com/vpc/latest/privatelink/concepts.html#concepts-vpc-endpoints">VPC endpoints</a> in the <i>Amazon Web Services PrivateLink User Guide</i>.</p>"""
    vpc_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the VPC to which the endpoint is associated.</p>"""
    service_name: NotRequired["capo_ec2.types.string.String"]
    """<p>The name of the service to which the endpoint is associated.</p>"""
    state: NotRequired["capo_ec2.types.state.State"]
    """<p>The state of the endpoint.</p>"""
    policy_document: NotRequired["capo_ec2.types.string.String"]
    """<p>The policy document associated with the endpoint, if applicable.</p>"""
    route_table_ids: NotRequired["capo_ec2.types.value_string_list.ValueStringList"]
    """<p>(Gateway endpoint) The IDs of the route tables associated with the endpoint.</p>"""
    subnet_ids: NotRequired["capo_ec2.types.value_string_list.ValueStringList"]
    """<p>(Interface, Gateway Load Balancer endpoints, Resource, ServiceNetwork, and Tunnel endpoints only) The subnets for the endpoint.</p>"""
    groups: NotRequired["capo_ec2.types.group_identifier_set.GroupIdentifierSet"]
    """<p>(Interface, Resource, ServiceNetwork, and Tunnel endpoints only) Information about the security groups that are associated with the network interface.</p>"""
    ip_address_type: NotRequired["capo_ec2.types.ip_address_type.IpAddressType"]
    """<p>The IP address type for the endpoint.</p>"""
    dns_options: NotRequired["capo_ec2.types.dns_options.DnsOptions"]
    """<p>The DNS options for the endpoint.</p>"""
    private_dns_enabled: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>(Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.</p>"""
    requester_managed: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Indicates whether the endpoint is being managed by its service.</p>"""
    network_interface_ids: NotRequired[
        "capo_ec2.types.value_string_list.ValueStringList"
    ]
    """<p>(Interface, Gateway Load Balancer endpoints, Resource, ServiceNetwork, and Tunnel endpoints only) The network interfaces for the endpoint.</p>"""
    dns_entries: NotRequired["capo_ec2.types.dns_entry_set.DnsEntrySet"]
    """<p>(Interface endpoint) The DNS entries for the endpoint.</p>"""
    creation_timestamp: NotRequired[
        "capo_ec2.types.millisecond_date_time.MillisecondDateTime"
    ]
    """<p>The date and time that the endpoint was created.</p>"""
    tags: NotRequired["capo_ec2.types.tag_list.TagList"]
    """<p>The tags assigned to the endpoint.</p>"""
    owner_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the Amazon Web Services account that owns the endpoint.</p>"""
    last_error: NotRequired["capo_ec2.types.last_error.LastError"]
    """<p>The last error that occurred for endpoint.</p>"""
    ipv4_prefixes: NotRequired[
        "capo_ec2.types.subnet_ip_prefixes_list.SubnetIpPrefixesList"
    ]
    """<p>Array of IPv4 prefixes.</p>"""
    ipv6_prefixes: NotRequired[
        "capo_ec2.types.subnet_ip_prefixes_list.SubnetIpPrefixesList"
    ]
    """<p>Array of IPv6 prefixes.</p>"""
    failure_reason: NotRequired["capo_ec2.types.string.String"]
    """<p>Reason for the failure.</p>"""
    service_network_arn: NotRequired[
        "capo_ec2.types.service_network_arn.ServiceNetworkArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the service network.</p>"""
    resource_configuration_arn: NotRequired[
        "capo_ec2.types.resource_configuration_arn.ResourceConfigurationArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the resource configuration.</p>"""
    service_region: NotRequired["capo_ec2.types.string.String"]
    """<p>The Region where the service is hosted.</p>"""
    payer_responsibilities: NotRequired[
        "capo_ec2.types.payer_responsibility_set.PayerResponsibilitySet"
    ]
    """<p>The payer responsibility settings for the endpoint.</p>"""

creation_timestamp instance-attribute

creation_timestamp: NotRequired[MillisecondDateTime]

The date and time that the endpoint was created.

dns_entries instance-attribute

dns_entries: NotRequired[DnsEntrySet]

(Interface endpoint) The DNS entries for the endpoint.

dns_options instance-attribute

dns_options: NotRequired[DnsOptions]

The DNS options for the endpoint.

failure_reason instance-attribute

failure_reason: NotRequired[String]

Reason for the failure.

groups instance-attribute

groups: NotRequired[GroupIdentifierSet]

(Interface, Resource, ServiceNetwork, and Tunnel endpoints only) Information about the security groups that are associated with the network interface.

ip_address_type instance-attribute

ip_address_type: NotRequired[IpAddressType]

The IP address type for the endpoint.

ipv4_prefixes instance-attribute

ipv4_prefixes: NotRequired[SubnetIpPrefixesList]

Array of IPv4 prefixes.

ipv6_prefixes instance-attribute

ipv6_prefixes: NotRequired[SubnetIpPrefixesList]

Array of IPv6 prefixes.

last_error instance-attribute

last_error: NotRequired[LastError]

The last error that occurred for endpoint.

network_interface_ids instance-attribute

network_interface_ids: NotRequired[ValueStringList]

(Interface, Gateway Load Balancer endpoints, Resource, ServiceNetwork, and Tunnel endpoints only) The network interfaces for the endpoint.

owner_id instance-attribute

owner_id: NotRequired[String]

The ID of the Amazon Web Services account that owns the endpoint.

payer_responsibilities instance-attribute

payer_responsibilities: NotRequired[PayerResponsibilitySet]

The payer responsibility settings for the endpoint.

policy_document instance-attribute

policy_document: NotRequired[String]

The policy document associated with the endpoint, if applicable.

private_dns_enabled instance-attribute

private_dns_enabled: NotRequired[Boolean]

(Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.

requester_managed instance-attribute

requester_managed: NotRequired[Boolean]

Indicates whether the endpoint is being managed by its service.

resource_configuration_arn instance-attribute

resource_configuration_arn: NotRequired[ResourceConfigurationArn]

The Amazon Resource Name (ARN) of the resource configuration.

route_table_ids instance-attribute

route_table_ids: NotRequired[ValueStringList]

(Gateway endpoint) The IDs of the route tables associated with the endpoint.

service_name instance-attribute

service_name: NotRequired[String]

The name of the service to which the endpoint is associated.

service_network_arn instance-attribute

service_network_arn: NotRequired[ServiceNetworkArn]

The Amazon Resource Name (ARN) of the service network.

service_region instance-attribute

service_region: NotRequired[String]

The Region where the service is hosted.

state instance-attribute

state: NotRequired[State]

The state of the endpoint.

subnet_ids instance-attribute

subnet_ids: NotRequired[ValueStringList]

(Interface, Gateway Load Balancer endpoints, Resource, ServiceNetwork, and Tunnel endpoints only) The subnets for the endpoint.

tags instance-attribute

tags: NotRequired[TagList]

The tags assigned to the endpoint.

vpc_endpoint_id instance-attribute

vpc_endpoint_id: NotRequired[String]

The ID of the endpoint.

vpc_endpoint_type instance-attribute

vpc_endpoint_type: NotRequired[VpcEndpointType]

The type of endpoint.

For more information about the types of VPC endpoints, see VPC endpoints in the Amazon Web Services PrivateLink User Guide.

vpc_id instance-attribute

vpc_id: NotRequired[String]

The ID of the VPC to which the endpoint is associated.