Package com.pulumi.aws.workspacesweb

Class UserAccessLoggingSettings

  • public class UserAccessLoggingSettings
extends com.pulumi.resources.CustomResource
    Resource for managing an AWS WorkSpaces Web User Access Logging Settings resource. Once associated with a web portal, user access logging settings control how user access events are logged to Amazon Kinesis. ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.kinesis.Stream;
 import com.pulumi.aws.kinesis.StreamArgs;
 import com.pulumi.aws.kinesis.inputs.StreamStreamModeDetailsArgs;
 import com.pulumi.aws.workspacesweb.UserAccessLoggingSettings;
 import com.pulumi.aws.workspacesweb.UserAccessLoggingSettingsArgs;
 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 Stream("example", StreamArgs.builder()
             .streamModeDetails(StreamStreamModeDetailsArgs.builder()
                 .streamMode("ON_DEMAND")
                 .build())
             .name("amazon-workspaces-web-example-stream")
             .build());
 
         var exampleUserAccessLoggingSettings = new UserAccessLoggingSettings("exampleUserAccessLoggingSettings", UserAccessLoggingSettingsArgs.builder()
             .kinesisStreamArn(example.arn())
             .build());
 
     }
 }
    ### With Tags 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.kinesis.Stream;
 import com.pulumi.aws.kinesis.StreamArgs;
 import com.pulumi.aws.kinesis.inputs.StreamStreamModeDetailsArgs;
 import com.pulumi.aws.workspacesweb.UserAccessLoggingSettings;
 import com.pulumi.aws.workspacesweb.UserAccessLoggingSettingsArgs;
 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 Stream("example", StreamArgs.builder()
             .streamModeDetails(StreamStreamModeDetailsArgs.builder()
                 .streamMode("ON_DEMAND")
                 .build())
             .name("example-stream")
             .build());
 
         var exampleUserAccessLoggingSettings = new UserAccessLoggingSettings("exampleUserAccessLoggingSettings", UserAccessLoggingSettingsArgs.builder()
             .kinesisStreamArn(example.arn())
             .tags(Map.ofEntries(
                 Map.entry("Name", "example-user-access-logging-settings"),
                 Map.entry("Environment", "Production")
             ))
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import WorkSpaces Web User Access Logging Settings using the `userAccessLoggingSettingsArn`. For example: ```sh $ pulumi import aws:workspacesweb/userAccessLoggingSettings:UserAccessLoggingSettings example arn:aws:workspaces-web:us-west-2:123456789012:userAccessLoggingSettings/abcdef12345 ```

    • 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.List<java.lang.String>> associatedPortalArns()  
      static UserAccessLoggingSettings get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, UserAccessLoggingSettingsState 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> kinesisStreamArn()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.lang.String> userAccessLoggingSettingsArn()  

      • 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

      • UserAccessLoggingSettings

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

      • UserAccessLoggingSettings

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

      • UserAccessLoggingSettings

        public UserAccessLoggingSettings​(java.lang.String name,
                                 UserAccessLoggingSettingsArgs 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

      • associatedPortalArns

        public com.pulumi.core.Output<java.util.List<java.lang.String>> associatedPortalArns()
        Returns:
        List of web portal ARNs that this user access logging settings resource is associated with.

      • kinesisStreamArn

        public com.pulumi.core.Output<java.lang.String> kinesisStreamArn()
        Returns:
        ARN of the Kinesis stream. The following arguments are optional:

      • 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.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags assigned to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • userAccessLoggingSettingsArn

        public com.pulumi.core.Output<java.lang.String> userAccessLoggingSettingsArn()
        Returns:
        ARN of the user access logging settings resource.

      • get

        public static UserAccessLoggingSettings get​(java.lang.String name,
                                            com.pulumi.core.Output<java.lang.String> id,
                                            @Nullable
                                            UserAccessLoggingSettingsState 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.