AuthorizationRule class

Provides authorization rules for AWS Client VPN endpoints. For more information on usage, please see the AWS Client VPN Administrator's Guide.

Example Usage

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 pulumi
import pulumi_aws as aws

example = aws.ec2clientvpn.AuthorizationRule("example",
    client_vpn_endpoint_id=example_aws_ec2_client_vpn_endpoint["id"],
    target_network_cidr=example_aws_subnet["cidrBlock"],
    authorize_all_groups=True)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Ec2ClientVpn.AuthorizationRule("example", new()
    {
        ClientVpnEndpointId = exampleAwsEc2ClientVpnEndpoint.Id,
        TargetNetworkCidr = exampleAwsSubnet.CidrBlock,
        AuthorizeAllGroups = true,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ec2clientvpn"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2clientvpn.NewAuthorizationRule(ctx, "example", &ec2clientvpn.AuthorizationRuleArgs{
			ClientVpnEndpointId: pulumi.Any(exampleAwsEc2ClientVpnEndpoint.Id),
			TargetNetworkCidr:   pulumi.Any(exampleAwsSubnet.CidrBlock),
			AuthorizeAllGroups:  pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_ec2clientvpn_authorizationrule" "example" {
  client_vpn_endpoint_id = exampleAwsEc2ClientVpnEndpoint.id
  target_network_cidr    = exampleAwsSubnet.cidrBlock
  authorize_all_groups   = true
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2clientvpn.AuthorizationRule;
import com.pulumi.aws.ec2clientvpn.AuthorizationRuleArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
        var example = new AuthorizationRule("example", AuthorizationRuleArgs.builder()
            .clientVpnEndpointId(exampleAwsEc2ClientVpnEndpoint.id())
            .targetNetworkCidr(exampleAwsSubnet.cidrBlock())
            .authorizeAllGroups(true)
            .build());

    }
}
resources:
  example:
    type: aws:ec2clientvpn:AuthorizationRule
    properties:
      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:

$ 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:

$ pulumi import aws:ec2clientvpn/authorizationRule:AuthorizationRule example cvpn-endpoint-0ac3a1abbccddd666,10.1.0.0/24,team-a

Constructors

AuthorizationRule(String name, {AuthorizationRuleArgs? args, CustomResourceOptions? options})
Creates a new AuthorizationRule. name The Pulumi resource name. args Arguments used to configure this AuthorizationRule. The set of arguments for AuthorizationRule. options Resource options controlling this resource's behavior.
AuthorizationRule.reference(String urn)
Creates a typed reference to an existing AuthorizationRule resource.

Properties

accessGroupId ↔ Output<String?>
The ID of the group to which the authorization rule grants access. One of accessGroupId or authorizeAllGroups must be set.
latefinal
authorizeAllGroups ↔ Output<bool?>
Indicates whether the authorization rule grants access to all clients. One of accessGroupId or authorizeAllGroups must be set.
latefinal
childResources → Set<Resource>
finalinherited
clientVpnEndpointId ↔ Output<String>
The ID of the Client VPN endpoint.
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
description ↔ Output<String?>
A brief description of the authorization rule.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
targetNetworkCidr ↔ Output<String>
The IPv4 or IPv6 address range, in CIDR notation, of the network to which the authorization rule applies.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {AuthorizationRuleState? state, CustomResourceOptions? options}) → AuthorizationRule
Gets an existing AuthorizationRule resource's state with the given name and id.