@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
113 lines (112 loc) • 4.47 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides network associations for AWS Client VPN endpoints. For more information on usage, please see the
* [AWS Client VPN Administrator's Guide](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/what-is.html).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.ec2clientvpn.NetworkAssociation("example", {
* clientVpnEndpointId: exampleAwsEc2ClientVpnEndpoint.id,
* subnetId: exampleAwsSubnet.id,
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import AWS Client VPN network associations using the endpoint ID and the association ID. Values are separated by a `,`. For example:
*
* ```sh
* $ pulumi import aws:ec2clientvpn/networkAssociation:NetworkAssociation example cvpn-endpoint-0ac3a1abbccddd666,cvpn-assoc-0b8db902465d069ad
* ```
*/
export declare class NetworkAssociation extends pulumi.CustomResource {
/**
* Get an existing NetworkAssociation 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 state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NetworkAssociationState, opts?: pulumi.CustomResourceOptions): NetworkAssociation;
/**
* Returns true if the given object is an instance of NetworkAssociation. 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 NetworkAssociation;
/**
* The unique ID of the target network association.
*/
readonly associationId: pulumi.Output<string>;
/**
* The ID of the Client VPN endpoint.
*/
readonly clientVpnEndpointId: pulumi.Output<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* The ID of the subnet to associate with the Client VPN endpoint.
*/
readonly subnetId: pulumi.Output<string>;
/**
* The ID of the VPC in which the target subnet is located.
*/
readonly vpcId: pulumi.Output<string>;
/**
* Create a NetworkAssociation 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: NetworkAssociationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering NetworkAssociation resources.
*/
export interface NetworkAssociationState {
/**
* The unique ID of the target network association.
*/
associationId?: pulumi.Input<string>;
/**
* The ID of the Client VPN endpoint.
*/
clientVpnEndpointId?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* The ID of the subnet to associate with the Client VPN endpoint.
*/
subnetId?: pulumi.Input<string>;
/**
* The ID of the VPC in which the target subnet is located.
*/
vpcId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a NetworkAssociation resource.
*/
export interface NetworkAssociationArgs {
/**
* The ID of the Client VPN endpoint.
*/
clientVpnEndpointId: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* The ID of the subnet to associate with the Client VPN endpoint.
*/
subnetId: pulumi.Input<string>;
}