Package com.pulumi.aws.ec2clientvpn

Class AuthorizationRule

  • public class AuthorizationRule
extends com.pulumi.resources.CustomResource
    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 
     
 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());
 
     }
 }
    ## 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 ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> accessGroupId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> authorizeAllGroups()  
      com.pulumi.core.Output<java.lang.String> clientVpnEndpointId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      static AuthorizationRule get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, AuthorizationRuleState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> targetNetworkCidr()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • AuthorizationRule

        public AuthorizationRule​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • AuthorizationRule

        public AuthorizationRule​(java.lang.String name,
                         AuthorizationRuleArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • AuthorizationRule

        public AuthorizationRule​(java.lang.String name,
                         AuthorizationRuleArgs args,
                         @Nullable
                         com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • accessGroupId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> accessGroupId()
        Returns:
        The ID of the group to which the authorization rule grants access. One of `accessGroupId` or `authorizeAllGroups` must be set.

      • authorizeAllGroups

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> authorizeAllGroups()
        Returns:
        Indicates whether the authorization rule grants access to all clients. One of `accessGroupId` or `authorizeAllGroups` must be set.

      • clientVpnEndpointId

        public com.pulumi.core.Output<java.lang.String> clientVpnEndpointId()
        Returns:
        The ID of the Client VPN endpoint.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        A brief description of the authorization rule.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        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.

      • targetNetworkCidr

        public com.pulumi.core.Output<java.lang.String> targetNetworkCidr()
        Returns:
        The IPv4 or IPv6 address range, in CIDR notation, of the network to which the authorization rule applies.

      • get

        public static AuthorizationRule get​(java.lang.String name,
                                    com.pulumi.core.Output<java.lang.String> id,
                                    @Nullable
                                    AuthorizationRuleState state,
                                    @Nullable
                                    com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.