@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
143 lines (142 loc) • 6.13 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides authorization rules 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.AuthorizationRule("example", {
* clientVpnEndpointId: exampleAwsEc2ClientVpnEndpoint.id,
* targetNetworkCidr: exampleAwsSubnet.cidrBlock,
* authorizeAllGroups: true,
* });
* ```
*
* ## Import
*
* Using the endpoint ID, target network CIDR, and group name:
*
* __Using `pulumi import` to import__ AWS Client VPN authorization rules using the endpoint ID and target network CIDR. If there is a specific group name, include that also. All values are separated by a `,`. For example:
*
* Using the endpoint ID and target network CIDR:
*
* ```sh
* $ pulumi import aws:ec2clientvpn/authorizationRule:AuthorizationRule example cvpn-endpoint-0ac3a1abbccddd666,10.1.0.0/24
* ```
* Using the endpoint ID, target network CIDR, and group name:
*
* ```sh
* $ pulumi import aws:ec2clientvpn/authorizationRule:AuthorizationRule example cvpn-endpoint-0ac3a1abbccddd666,10.1.0.0/24,team-a
* ```
*/
export declare class AuthorizationRule extends pulumi.CustomResource {
/**
* Get an existing AuthorizationRule 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?: AuthorizationRuleState, opts?: pulumi.CustomResourceOptions): AuthorizationRule;
/**
* Returns true if the given object is an instance of AuthorizationRule. 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 AuthorizationRule;
/**
* The ID of the group to which the authorization rule grants access. One of `accessGroupId` or `authorizeAllGroups` must be set.
*/
readonly accessGroupId: pulumi.Output<string | undefined>;
/**
* Indicates whether the authorization rule grants access to all clients. One of `accessGroupId` or `authorizeAllGroups` must be set.
*/
readonly authorizeAllGroups: pulumi.Output<boolean | undefined>;
/**
* The ID of the Client VPN endpoint.
*/
readonly clientVpnEndpointId: pulumi.Output<string>;
/**
* A brief description of the authorization rule.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* 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 IPv4 or IPv6 address range, in CIDR notation, of the network to which the authorization rule applies.
*/
readonly targetNetworkCidr: pulumi.Output<string>;
/**
* Create a AuthorizationRule 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: AuthorizationRuleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AuthorizationRule resources.
*/
export interface AuthorizationRuleState {
/**
* The ID of the group to which the authorization rule grants access. One of `accessGroupId` or `authorizeAllGroups` must be set.
*/
accessGroupId?: pulumi.Input<string>;
/**
* Indicates whether the authorization rule grants access to all clients. One of `accessGroupId` or `authorizeAllGroups` must be set.
*/
authorizeAllGroups?: pulumi.Input<boolean>;
/**
* The ID of the Client VPN endpoint.
*/
clientVpnEndpointId?: pulumi.Input<string>;
/**
* A brief description of the authorization rule.
*/
description?: 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 IPv4 or IPv6 address range, in CIDR notation, of the network to which the authorization rule applies.
*/
targetNetworkCidr?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a AuthorizationRule resource.
*/
export interface AuthorizationRuleArgs {
/**
* The ID of the group to which the authorization rule grants access. One of `accessGroupId` or `authorizeAllGroups` must be set.
*/
accessGroupId?: pulumi.Input<string>;
/**
* Indicates whether the authorization rule grants access to all clients. One of `accessGroupId` or `authorizeAllGroups` must be set.
*/
authorizeAllGroups?: pulumi.Input<boolean>;
/**
* The ID of the Client VPN endpoint.
*/
clientVpnEndpointId: pulumi.Input<string>;
/**
* A brief description of the authorization rule.
*/
description?: 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 IPv4 or IPv6 address range, in CIDR notation, of the network to which the authorization rule applies.
*/
targetNetworkCidr: pulumi.Input<string>;
}