aws_sdk_ec2/client/
create_vpc_endpoint.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`CreateVpcEndpoint`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`dry_run(bool)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::set_dry_run):<br>required: **false**<br><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><br>
7    ///   - [`vpc_endpoint_type(VpcEndpointType)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::vpc_endpoint_type) / [`set_vpc_endpoint_type(Option<VpcEndpointType>)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::set_vpc_endpoint_type):<br>required: **false**<br><p>The type of endpoint.</p> <p>Default: Gateway</p><br>
8    ///   - [`vpc_id(impl Into<String>)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::vpc_id) / [`set_vpc_id(Option<String>)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::set_vpc_id):<br>required: **true**<br><p>The ID of the VPC.</p><br>
9    ///   - [`service_name(impl Into<String>)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::service_name) / [`set_service_name(Option<String>)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::set_service_name):<br>required: **false**<br><p>The name of the endpoint service.</p><br>
10    ///   - [`policy_document(impl Into<String>)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::policy_document) / [`set_policy_document(Option<String>)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::set_policy_document):<br>required: **false**<br><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><br>
11    ///   - [`route_table_ids(impl Into<String>)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::route_table_ids) / [`set_route_table_ids(Option<Vec::<String>>)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::set_route_table_ids):<br>required: **false**<br><p>(Gateway endpoint) The route table IDs.</p><br>
12    ///   - [`subnet_ids(impl Into<String>)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::subnet_ids) / [`set_subnet_ids(Option<Vec::<String>>)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::set_subnet_ids):<br>required: **false**<br><p>(Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to create endpoint network interfaces. For a Gateway Load Balancer endpoint, you can specify only one subnet.</p><br>
13    ///   - [`security_group_ids(impl Into<String>)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::security_group_ids) / [`set_security_group_ids(Option<Vec::<String>>)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::set_security_group_ids):<br>required: **false**<br><p>(Interface endpoint) 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><br>
14    ///   - [`ip_address_type(IpAddressType)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::ip_address_type) / [`set_ip_address_type(Option<IpAddressType>)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::set_ip_address_type):<br>required: **false**<br><p>The IP address type for the endpoint.</p><br>
15    ///   - [`dns_options(DnsOptionsSpecification)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::dns_options) / [`set_dns_options(Option<DnsOptionsSpecification>)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::set_dns_options):<br>required: **false**<br><p>The DNS options for the endpoint.</p><br>
16    ///   - [`client_token(impl Into<String>)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::set_client_token):<br>required: **false**<br><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><br>
17    ///   - [`private_dns_enabled(bool)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::private_dns_enabled) / [`set_private_dns_enabled(Option<bool>)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::set_private_dns_enabled):<br>required: **false**<br><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 <code>ModifyVpcAttribute</code> to set the VPC attributes.</p><br>
18    ///   - [`tag_specifications(TagSpecification)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::tag_specifications) / [`set_tag_specifications(Option<Vec::<TagSpecification>>)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::set_tag_specifications):<br>required: **false**<br><p>The tags to associate with the endpoint.</p><br>
19    ///   - [`subnet_configurations(SubnetConfiguration)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::subnet_configurations) / [`set_subnet_configurations(Option<Vec::<SubnetConfiguration>>)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::set_subnet_configurations):<br>required: **false**<br><p>The subnet configurations for the endpoint.</p><br>
20    ///   - [`service_network_arn(impl Into<String>)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::service_network_arn) / [`set_service_network_arn(Option<String>)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::set_service_network_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of a service network that will be associated with the VPC endpoint of type service-network.</p><br>
21    ///   - [`resource_configuration_arn(impl Into<String>)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::resource_configuration_arn) / [`set_resource_configuration_arn(Option<String>)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::set_resource_configuration_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of a resource configuration that will be associated with the VPC endpoint of type resource.</p><br>
22    ///   - [`service_region(impl Into<String>)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::service_region) / [`set_service_region(Option<String>)`](crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::set_service_region):<br>required: **false**<br><p>The Region where the service is hosted. The default is the current Region.</p><br>
23    /// - On success, responds with [`CreateVpcEndpointOutput`](crate::operation::create_vpc_endpoint::CreateVpcEndpointOutput) with field(s):
24    ///   - [`vpc_endpoint(Option<VpcEndpoint>)`](crate::operation::create_vpc_endpoint::CreateVpcEndpointOutput::vpc_endpoint): <p>Information about the endpoint.</p>
25    ///   - [`client_token(Option<String>)`](crate::operation::create_vpc_endpoint::CreateVpcEndpointOutput::client_token): <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
26    /// - On failure, responds with [`SdkError<CreateVpcEndpointError>`](crate::operation::create_vpc_endpoint::CreateVpcEndpointError)
27    pub fn create_vpc_endpoint(&self) -> crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder {
28        crate::operation::create_vpc_endpoint::builders::CreateVpcEndpointFluentBuilder::new(self.handle.clone())
29    }
30}