@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
100 lines (99 loc) • 3.48 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Amazon OpenSearchServerless vpc endpoint resource
*
* ## Example Usage
* ### Example
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws_native from "@pulumi/aws-native";
*
* const testAOSSVpcEndpoint = new aws_native.opensearchserverless.VpcEndpoint("testAOSSVpcEndpoint", {
* name: "test-vpcendpoint",
* vpcId: "vpc-0d728b8430292b3f4",
* subnetIds: ["subnet-0e855f5722a9598ee"],
* securityGroupIds: ["sg-03843b03f369eb245"],
* });
*
* ```
* ### Example
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws_native from "@pulumi/aws-native";
*
* const testAOSSVpcEndpoint = new aws_native.opensearchserverless.VpcEndpoint("testAOSSVpcEndpoint", {
* name: "test-vpcendpoint",
* vpcId: "vpc-0d728b8430292b3f4",
* subnetIds: ["subnet-0e855f5722a9598ee"],
* securityGroupIds: ["sg-03843b03f369eb245"],
* });
*
* ```
*/
export declare class VpcEndpoint extends pulumi.CustomResource {
/**
* Get an existing VpcEndpoint resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): VpcEndpoint;
/**
* Returns true if the given object is an instance of VpcEndpoint. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is VpcEndpoint;
/**
* The identifier of the VPC Endpoint
*/
readonly awsId: pulumi.Output<string>;
/**
* The name of the VPC Endpoint
*/
readonly name: pulumi.Output<string>;
/**
* The ID of one or more security groups to associate with the endpoint network interface
*/
readonly securityGroupIds: pulumi.Output<string[] | undefined>;
/**
* The ID of one or more subnets in which to create an endpoint network interface
*/
readonly subnetIds: pulumi.Output<string[]>;
/**
* The ID of the VPC in which the endpoint will be used.
*/
readonly vpcId: pulumi.Output<string>;
/**
* Create a VpcEndpoint resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: VpcEndpointArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a VpcEndpoint resource.
*/
export interface VpcEndpointArgs {
/**
* The name of the VPC Endpoint
*/
name?: pulumi.Input<string>;
/**
* The ID of one or more security groups to associate with the endpoint network interface
*/
securityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The ID of one or more subnets in which to create an endpoint network interface
*/
subnetIds: pulumi.Input<pulumi.Input<string>[]>;
/**
* The ID of the VPC in which the endpoint will be used.
*/
vpcId: pulumi.Input<string>;
}