Skip to content

CreateVpcEndpointRequest

Source code in docs_src/capo_ec2/types/create_vpc_endpoint_request.py
class CreateVpcEndpointRequest(TypedDict, closed=True):
    dry_run: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Checks 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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</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> <p>Default: Gateway</p>"""
    vpc_id: NotRequired["capo_ec2.types.vpc_id.VpcId"]
    """<p>The ID of the VPC.</p>"""
    service_name: NotRequired["capo_ec2.types.string.String"]
    """<p>The name of the endpoint service.</p>"""
    policy_document: NotRequired["capo_ec2.types.string.String"]
    """<p>(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.</p>"""
    route_table_ids: NotRequired[
        "capo_ec2.types.vpc_endpoint_route_table_id_list.VpcEndpointRouteTableIdList"
    ]
    """<p>(Gateway endpoint) The route table IDs.</p>"""
    subnet_ids: NotRequired[
        "capo_ec2.types.vpc_endpoint_subnet_id_list.VpcEndpointSubnetIdList"
    ]
    """<p>(Interface, Gateway Load Balancer endpoints, Resource, ServiceNetwork, and Tunnel endpoints only) The IDs of the subnets in which to create endpoint network interfaces. For a Gateway Load Balancer endpoint, you can specify only one subnet. For a <code>Tunnel</code> endpoint, the subnets must be in the Availability Zones of the resource gateway associated with the shared resource configuration. An endpoint network interface is created only in an Availability Zone that the resource gateway is also in.</p>"""
    security_group_ids: NotRequired[
        "capo_ec2.types.vpc_endpoint_security_group_id_list.VpcEndpointSecurityGroupIdList"
    ]
    """<p>(Interface, Resource, ServiceNetwork, and Tunnel endpoints only) The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC.</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_specification.DnsOptionsSpecification"
    ]
    """<p>The DNS options for the endpoint.</p>"""
    client_token: NotRequired["capo_ec2.types.string.String"]
    """<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html">How to ensure idempotency</a>.</p>"""
    private_dns_enabled: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>(Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, <code>kinesis.us-east-1.amazonaws.com</code>), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.</p> <p>To use a private hosted zone, you must set the following VPC attributes to <code>true</code>: <code>enableDnsHostnames</code> and <code>enableDnsSupport</code>. Use <a>ModifyVpcAttribute</a> to set the VPC attributes.</p>"""
    tag_specifications: NotRequired[
        "capo_ec2.types.tag_specification_list.TagSpecificationList"
    ]
    """<p>The tags to associate with the endpoint.</p>"""
    subnet_configurations: NotRequired[
        "capo_ec2.types.subnet_configurations_list.SubnetConfigurationsList"
    ]
    """<p>The subnet configurations for the endpoint.</p>"""
    service_network_arn: NotRequired[
        "capo_ec2.types.service_network_arn.ServiceNetworkArn"
    ]
    """<p>The Amazon Resource Name (ARN) of a service network that will be associated with the VPC endpoint of type service-network.</p>"""
    resource_configuration_arn: NotRequired[
        "capo_ec2.types.resource_configuration_arn.ResourceConfigurationArn"
    ]
    """<p>(Resource and Tunnel endpoints only) The Amazon Resource Name (ARN) of a resource configuration associated with the VPC endpoint. The type of resource configuration depends on the endpoint type:</p> <ul> <li> <p>For a Resource endpoint, you can specify a resource configuration that is of type <code>SINGLE</code>, <code>GROUP</code>, or <code>ARN</code>. To reach a resource that belongs to a group, specify the parent <code>GROUP</code> resource configuration.</p> </li> <li> <p>For a Tunnel endpoint, you can specify a resource configuration that is of type <code>CIDR</code>.</p> </li> </ul> <p>For more information about the types of resource configurations, see <a href="https://docs.aws.amazon.com/vpc/latest/privatelink/resource-configuration.html">Types of resource configurations</a> in the <i>Amazon Web Services PrivateLink User Guide</i>.</p> <p>This request fails if a VPC endpoint owned by a different Amazon Web Services account already exists on a resource gateway that is enabled for <code>ResourceGatewayCharges</code> payer responsibility.</p>"""
    service_region: NotRequired["capo_ec2.types.string.String"]
    """<p>The Region where the service is hosted. The default is the current Region.</p>"""

client_token instance-attribute

client_token: NotRequired[String]

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

dns_options instance-attribute

dns_options: NotRequired[DnsOptionsSpecification]

The DNS options for the endpoint.

dry_run instance-attribute

dry_run: NotRequired[Boolean]

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

ip_address_type instance-attribute

ip_address_type: NotRequired[IpAddressType]

The IP address type for the endpoint.

policy_document instance-attribute

policy_document: NotRequired[String]

(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.

private_dns_enabled instance-attribute

private_dns_enabled: NotRequired[Boolean]

(Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.

To use a private hosted zone, you must set the following VPC attributes to true: enableDnsHostnames and enableDnsSupport. Use ModifyVpcAttribute to set the VPC attributes.

resource_configuration_arn instance-attribute

resource_configuration_arn: NotRequired[ResourceConfigurationArn]

(Resource and Tunnel endpoints only) The Amazon Resource Name (ARN) of a resource configuration associated with the VPC endpoint. The type of resource configuration depends on the endpoint type:

  • For a Resource endpoint, you can specify a resource configuration that is of type SINGLE, GROUP, or ARN. To reach a resource that belongs to a group, specify the parent GROUP resource configuration.

  • For a Tunnel endpoint, you can specify a resource configuration that is of type CIDR.

For more information about the types of resource configurations, see Types of resource configurations in the Amazon Web Services PrivateLink User Guide.

This request fails if a VPC endpoint owned by a different Amazon Web Services account already exists on a resource gateway that is enabled for ResourceGatewayCharges payer responsibility.

route_table_ids instance-attribute

route_table_ids: NotRequired[VpcEndpointRouteTableIdList]

(Gateway endpoint) The route table IDs.

security_group_ids instance-attribute

security_group_ids: NotRequired[VpcEndpointSecurityGroupIdList]

(Interface, Resource, ServiceNetwork, and Tunnel endpoints only) The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC.

service_name instance-attribute

service_name: NotRequired[String]

The name of the endpoint service.

service_network_arn instance-attribute

service_network_arn: NotRequired[ServiceNetworkArn]

The Amazon Resource Name (ARN) of a service network that will be associated with the VPC endpoint of type service-network.

service_region instance-attribute

service_region: NotRequired[String]

The Region where the service is hosted. The default is the current Region.

subnet_configurations instance-attribute

subnet_configurations: NotRequired[SubnetConfigurationsList]

The subnet configurations for the endpoint.

subnet_ids instance-attribute

subnet_ids: NotRequired[VpcEndpointSubnetIdList]

(Interface, Gateway Load Balancer endpoints, Resource, ServiceNetwork, and Tunnel endpoints only) The IDs of the subnets in which to create endpoint network interfaces. For a Gateway Load Balancer endpoint, you can specify only one subnet. For a Tunnel endpoint, the subnets must be in the Availability Zones of the resource gateway associated with the shared resource configuration. An endpoint network interface is created only in an Availability Zone that the resource gateway is also in.

tag_specifications instance-attribute

tag_specifications: NotRequired[TagSpecificationList]

The tags to associate with 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.

Default: Gateway

vpc_id instance-attribute

vpc_id: NotRequired[VpcId]

The ID of the VPC.