Skip to content

EC2  >  Operations  >  create_vpc_endpoint_service_configuration

create_vpc_endpoint_service_configuration

Operation

create_vpc_endpoint_service_configuration async

create_vpc_endpoint_service_configuration(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateVpcEndpointServiceConfigurationInputDict]) -> CreateVpcEndpointServiceConfigurationOutput

Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts, users, and IAM roles) can connect.

Before you create an endpoint service, you must create one of the following for your service:

If you set the private DNS name, you must prove that you own the private DNS domain name.

For more information, see the Amazon Web Services PrivateLink Guide.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
CreateVpcEndpointServiceConfigurationOutput

An instance of CreateVpcEndpointServiceConfigurationOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

CreateVpcEndpointServiceConfigurationInput dataclass

Bases: _SerdeShape

Dataclass for CreateVpcEndpointServiceConfigurationInput structure.

Attributes
acceptance_required class-attribute instance-attribute
acceptance_required: bool | None = ...

Indicates whether requests from service consumers to create an endpoint to your service must be accepted manually.

client_token class-attribute instance-attribute
client_token: str | None = ...

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

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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.

gateway_load_balancer_arns class-attribute instance-attribute
gateway_load_balancer_arns: list[str] | None = ...

The Amazon Resource Names (ARNs) of the Gateway Load Balancers.

network_load_balancer_arns class-attribute instance-attribute
network_load_balancer_arns: list[str] | None = ...

The Amazon Resource Names (ARNs) of the Network Load Balancers.

private_dns_name class-attribute instance-attribute
private_dns_name: str | None = ...

(Interface endpoint configuration) The private DNS name to assign to the VPC endpoint service.

supported_ip_address_types class-attribute instance-attribute
supported_ip_address_types: list[str] | None = ...

The supported IP address types. The possible values are ipv4 and ipv6.

supported_regions class-attribute instance-attribute
supported_regions: list[str] | None = ...

The Regions from which service consumers can access the service.

tag_specifications class-attribute instance-attribute
tag_specifications: list[TagSpecification] | None = ...

The tags to associate with the service.

Dictionaries

CreateVpcEndpointServiceConfigurationInputDict

Bases: TypedDict

Dictionary form of CreateVpcEndpointServiceConfigurationInput.

Attributes
acceptance_required instance-attribute
acceptance_required: bool | None

Indicates whether requests from service consumers to create an endpoint to your service must be accepted manually.

client_token instance-attribute
client_token: str | None

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

dry_run instance-attribute
dry_run: bool | None

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.

gateway_load_balancer_arns instance-attribute
gateway_load_balancer_arns: Sequence[str] | None

The Amazon Resource Names (ARNs) of the Gateway Load Balancers.

network_load_balancer_arns instance-attribute
network_load_balancer_arns: Sequence[str] | None

The Amazon Resource Names (ARNs) of the Network Load Balancers.

private_dns_name instance-attribute
private_dns_name: str | None

(Interface endpoint configuration) The private DNS name to assign to the VPC endpoint service.

supported_ip_address_types instance-attribute
supported_ip_address_types: Sequence[str] | None

The supported IP address types. The possible values are ipv4 and ipv6.

supported_regions instance-attribute
supported_regions: Sequence[str] | None

The Regions from which service consumers can access the service.

tag_specifications instance-attribute
tag_specifications: Sequence[TagSpecification | TagSpecificationDict] | None

The tags to associate with the service.

Output

CreateVpcEndpointServiceConfigurationOutput dataclass

Bases: _SerdeShape

Dataclass for CreateVpcEndpointServiceConfigurationOutput structure.

Attributes

client_token class-attribute instance-attribute
client_token: str | None = ...

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

service_configuration class-attribute instance-attribute
service_configuration: ServiceConfiguration | None = ...

Information about the service configuration.