pulumi-aws-kotlin/com.pulumi.aws.ec2.kotlin/Ec2Functions/getVpcEndpointService

getVpcEndpointService

suspend fun getVpcEndpointService(argument: GetVpcEndpointServicePlainArgs): GetVpcEndpointServiceResult

The VPC Endpoint Service data source details about a specific service that can be specified when creating a VPC endpoint within the region configured in the provider.

Example Usage

AWS Service

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.Ec2Functions;
import com.pulumi.aws.ec2.inputs.GetVpcEndpointServiceArgs;
import com.pulumi.aws.ec2.Vpc;
import com.pulumi.aws.ec2.VpcArgs;
import com.pulumi.aws.ec2.VpcEndpoint;
import com.pulumi.aws.ec2.VpcEndpointArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var s3 = Ec2Functions.getVpcEndpointService(GetVpcEndpointServiceArgs.builder()
            .service("s3")
            .serviceType("Gateway")
            .build());
        var foo = new Vpc("foo", VpcArgs.builder()
            .cidrBlock("10.0.0.0/16")
            .build());
        var ep = new VpcEndpoint("ep", VpcEndpointArgs.builder()
            .vpcId(foo.id())
            .serviceName(s3.applyValue(getVpcEndpointServiceResult -> getVpcEndpointServiceResult.serviceName()))
            .build());
    }
}
Content copied to clipboard

Non-AWS Service

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.Ec2Functions;
import com.pulumi.aws.ec2.inputs.GetVpcEndpointServiceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var custome = Ec2Functions.getVpcEndpointService(GetVpcEndpointServiceArgs.builder()
            .serviceName("com.amazonaws.vpce.us-west-2.vpce-svc-0e87519c997c63cd8")
            .build());
    }
}
Content copied to clipboard

Filter

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.Ec2Functions;
import com.pulumi.aws.ec2.inputs.GetVpcEndpointServiceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var test = Ec2Functions.getVpcEndpointService(GetVpcEndpointServiceArgs.builder()
            .filters(GetVpcEndpointServiceFilterArgs.builder()
                .name("service-name")
                .values("some-service")
                .build())
            .build());
    }
}
Content copied to clipboard

Return

A collection of values returned by getVpcEndpointService.

Parameters

argument

A collection of arguments for invoking getVpcEndpointService.

suspend fun getVpcEndpointService(filters: List<GetVpcEndpointServiceFilter>? = null, service: String? = null, serviceName: String? = null, serviceType: String? = null, tags: Map<String, String>? = null): GetVpcEndpointServiceResult

Return

A collection of values returned by getVpcEndpointService.

See also

Parameters

filters

Configuration block(s) for filtering. Detailed below.

service

Common name of an AWS service (e.g., s3).

serviceName

Service name that is specified when creating a VPC endpoint. For AWS services the service name is usually in the form com.amazonaws.<region>.<service> (the SageMaker Notebook service is an exception to this rule, the service name is in the form aws.sagemaker.<region>.notebook).

serviceType

Service type, Gateway or Interface.

tags

Map of tags, each pair of which must exactly match a pair on the desired VPC Endpoint Service.

NOTE: Specifying service will not work for non-AWS services or AWS services that don't follow the standard service_name pattern of com.amazonaws.<region>.<service>.

suspend fun getVpcEndpointService(argument: suspend GetVpcEndpointServicePlainArgsBuilder.() -> Unit): GetVpcEndpointServiceResult

Return

A collection of values returned by getVpcEndpointService.

See also

Parameters

argument

Builder for com.pulumi.aws.ec2.kotlin.inputs.GetVpcEndpointServicePlainArgs.