1. Packages
  2. AWS
  3. API Docs
  4. workspaces
  5. WebUserAccessLoggingSettings
AWS v6.83.0 published on Monday, Jun 16, 2025 by Pulumi

aws.workspaces.WebUserAccessLoggingSettings

Explore with Pulumi AI

aws logo
AWS v6.83.0 published on Monday, Jun 16, 2025 by Pulumi
    Deprecated: aws.workspaces/webuseraccessloggingsettings.WebUserAccessLoggingSettings has been deprecated in favor of aws.workspacesweb/useraccessloggingsettings.UserAccessLoggingSettings

    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

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.kinesis.Stream("example", {
        name: "amazon-workspaces-web-example-stream",
        shardCount: 1,
    });
    const exampleUserAccessLoggingSettings = new aws.workspacesweb.UserAccessLoggingSettings("example", {kinesisStreamArn: example.arn});
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.kinesis.Stream("example",
        name="amazon-workspaces-web-example-stream",
        shard_count=1)
    example_user_access_logging_settings = aws.workspacesweb.UserAccessLoggingSettings("example", kinesis_stream_arn=example.arn)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/kinesis"
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/workspacesweb"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := kinesis.NewStream(ctx, "example", &kinesis.StreamArgs{
    			Name:       pulumi.String("amazon-workspaces-web-example-stream"),
    			ShardCount: pulumi.Int(1),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = workspacesweb.NewUserAccessLoggingSettings(ctx, "example", &workspacesweb.UserAccessLoggingSettingsArgs{
    			KinesisStreamArn: example.Arn,
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Kinesis.Stream("example", new()
        {
            Name = "amazon-workspaces-web-example-stream",
            ShardCount = 1,
        });
    
        var exampleUserAccessLoggingSettings = new Aws.WorkSpacesWeb.UserAccessLoggingSettings("example", new()
        {
            KinesisStreamArn = example.Arn,
        });
    
    });
    
    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.workspacesweb.UserAccessLoggingSettings;
    import com.pulumi.aws.workspacesweb.UserAccessLoggingSettingsArgs;
    import java.util.List;
    import java.util.ArrayList;
    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()
                .name("amazon-workspaces-web-example-stream")
                .shardCount(1)
                .build());
    
            var exampleUserAccessLoggingSettings = new UserAccessLoggingSettings("exampleUserAccessLoggingSettings", UserAccessLoggingSettingsArgs.builder()
                .kinesisStreamArn(example.arn())
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:kinesis:Stream
        properties:
          name: amazon-workspaces-web-example-stream
          shardCount: 1
      exampleUserAccessLoggingSettings:
        type: aws:workspacesweb:UserAccessLoggingSettings
        name: example
        properties:
          kinesisStreamArn: ${example.arn}
    

    With Tags

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.kinesis.Stream("example", {
        name: "example-stream",
        shardCount: 1,
    });
    const exampleUserAccessLoggingSettings = new aws.workspacesweb.UserAccessLoggingSettings("example", {
        kinesisStreamArn: example.arn,
        tags: {
            Name: "example-user-access-logging-settings",
            Environment: "Production",
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.kinesis.Stream("example",
        name="example-stream",
        shard_count=1)
    example_user_access_logging_settings = aws.workspacesweb.UserAccessLoggingSettings("example",
        kinesis_stream_arn=example.arn,
        tags={
            "Name": "example-user-access-logging-settings",
            "Environment": "Production",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/kinesis"
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/workspacesweb"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := kinesis.NewStream(ctx, "example", &kinesis.StreamArgs{
    			Name:       pulumi.String("example-stream"),
    			ShardCount: pulumi.Int(1),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = workspacesweb.NewUserAccessLoggingSettings(ctx, "example", &workspacesweb.UserAccessLoggingSettingsArgs{
    			KinesisStreamArn: example.Arn,
    			Tags: pulumi.StringMap{
    				"Name":        pulumi.String("example-user-access-logging-settings"),
    				"Environment": pulumi.String("Production"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Kinesis.Stream("example", new()
        {
            Name = "example-stream",
            ShardCount = 1,
        });
    
        var exampleUserAccessLoggingSettings = new Aws.WorkSpacesWeb.UserAccessLoggingSettings("example", new()
        {
            KinesisStreamArn = example.Arn,
            Tags = 
            {
                { "Name", "example-user-access-logging-settings" },
                { "Environment", "Production" },
            },
        });
    
    });
    
    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.workspacesweb.UserAccessLoggingSettings;
    import com.pulumi.aws.workspacesweb.UserAccessLoggingSettingsArgs;
    import java.util.List;
    import java.util.ArrayList;
    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()
                .name("example-stream")
                .shardCount(1)
                .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());
    
        }
    }
    
    resources:
      example:
        type: aws:kinesis:Stream
        properties:
          name: example-stream
          shardCount: 1
      exampleUserAccessLoggingSettings:
        type: aws:workspacesweb:UserAccessLoggingSettings
        name: example
        properties:
          kinesisStreamArn: ${example.arn}
          tags:
            Name: example-user-access-logging-settings
            Environment: Production
    

    Create WebUserAccessLoggingSettings Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new WebUserAccessLoggingSettings(name: string, args: WebUserAccessLoggingSettingsArgs, opts?: CustomResourceOptions);
    @overload
    def WebUserAccessLoggingSettings(resource_name: str,
                                     args: WebUserAccessLoggingSettingsArgs,
                                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def WebUserAccessLoggingSettings(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     kinesis_stream_arn: Optional[str] = None,
                                     tags: Optional[Mapping[str, str]] = None)
    func NewWebUserAccessLoggingSettings(ctx *Context, name string, args WebUserAccessLoggingSettingsArgs, opts ...ResourceOption) (*WebUserAccessLoggingSettings, error)
    public WebUserAccessLoggingSettings(string name, WebUserAccessLoggingSettingsArgs args, CustomResourceOptions? opts = null)
    public WebUserAccessLoggingSettings(String name, WebUserAccessLoggingSettingsArgs args)
    public WebUserAccessLoggingSettings(String name, WebUserAccessLoggingSettingsArgs args, CustomResourceOptions options)
    
    type: aws:workspaces:WebUserAccessLoggingSettings
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args WebUserAccessLoggingSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args WebUserAccessLoggingSettingsArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args WebUserAccessLoggingSettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WebUserAccessLoggingSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WebUserAccessLoggingSettingsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    WebUserAccessLoggingSettings Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The WebUserAccessLoggingSettings resource accepts the following input properties:

    KinesisStreamArn string

    ARN of the Kinesis stream.

    The following arguments are optional:

    Tags Dictionary<string, string>
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    KinesisStreamArn string

    ARN of the Kinesis stream.

    The following arguments are optional:

    Tags map[string]string
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    kinesisStreamArn String

    ARN of the Kinesis stream.

    The following arguments are optional:

    tags Map<String,String>
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    kinesisStreamArn string

    ARN of the Kinesis stream.

    The following arguments are optional:

    tags {[key: string]: string}
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    kinesis_stream_arn str

    ARN of the Kinesis stream.

    The following arguments are optional:

    tags Mapping[str, str]
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    kinesisStreamArn String

    ARN of the Kinesis stream.

    The following arguments are optional:

    tags Map<String>
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the WebUserAccessLoggingSettings resource produces the following output properties:

    AssociatedPortalArns List<string>
    List of web portal ARNs that this user access logging settings resource is associated with.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    UserAccessLoggingSettingsArn string
    ARN of the user access logging settings resource.
    AssociatedPortalArns []string
    List of web portal ARNs that this user access logging settings resource is associated with.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    UserAccessLoggingSettingsArn string
    ARN of the user access logging settings resource.
    associatedPortalArns List<String>
    List of web portal ARNs that this user access logging settings resource is associated with.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    userAccessLoggingSettingsArn String
    ARN of the user access logging settings resource.
    associatedPortalArns string[]
    List of web portal ARNs that this user access logging settings resource is associated with.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    userAccessLoggingSettingsArn string
    ARN of the user access logging settings resource.
    associated_portal_arns Sequence[str]
    List of web portal ARNs that this user access logging settings resource is associated with.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    user_access_logging_settings_arn str
    ARN of the user access logging settings resource.
    associatedPortalArns List<String>
    List of web portal ARNs that this user access logging settings resource is associated with.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    userAccessLoggingSettingsArn String
    ARN of the user access logging settings resource.

    Look up Existing WebUserAccessLoggingSettings Resource

    Get an existing WebUserAccessLoggingSettings resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: WebUserAccessLoggingSettingsState, opts?: CustomResourceOptions): WebUserAccessLoggingSettings
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            associated_portal_arns: Optional[Sequence[str]] = None,
            kinesis_stream_arn: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            user_access_logging_settings_arn: Optional[str] = None) -> WebUserAccessLoggingSettings
    func GetWebUserAccessLoggingSettings(ctx *Context, name string, id IDInput, state *WebUserAccessLoggingSettingsState, opts ...ResourceOption) (*WebUserAccessLoggingSettings, error)
    public static WebUserAccessLoggingSettings Get(string name, Input<string> id, WebUserAccessLoggingSettingsState? state, CustomResourceOptions? opts = null)
    public static WebUserAccessLoggingSettings get(String name, Output<String> id, WebUserAccessLoggingSettingsState state, CustomResourceOptions options)
    resources:  _:    type: aws:workspaces:WebUserAccessLoggingSettings    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AssociatedPortalArns List<string>
    List of web portal ARNs that this user access logging settings resource is associated with.
    KinesisStreamArn string

    ARN of the Kinesis stream.

    The following arguments are optional:

    Tags Dictionary<string, string>
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    UserAccessLoggingSettingsArn string
    ARN of the user access logging settings resource.
    AssociatedPortalArns []string
    List of web portal ARNs that this user access logging settings resource is associated with.
    KinesisStreamArn string

    ARN of the Kinesis stream.

    The following arguments are optional:

    Tags map[string]string
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    UserAccessLoggingSettingsArn string
    ARN of the user access logging settings resource.
    associatedPortalArns List<String>
    List of web portal ARNs that this user access logging settings resource is associated with.
    kinesisStreamArn String

    ARN of the Kinesis stream.

    The following arguments are optional:

    tags Map<String,String>
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    userAccessLoggingSettingsArn String
    ARN of the user access logging settings resource.
    associatedPortalArns string[]
    List of web portal ARNs that this user access logging settings resource is associated with.
    kinesisStreamArn string

    ARN of the Kinesis stream.

    The following arguments are optional:

    tags {[key: string]: string}
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    userAccessLoggingSettingsArn string
    ARN of the user access logging settings resource.
    associated_portal_arns Sequence[str]
    List of web portal ARNs that this user access logging settings resource is associated with.
    kinesis_stream_arn str

    ARN of the Kinesis stream.

    The following arguments are optional:

    tags Mapping[str, str]
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    user_access_logging_settings_arn str
    ARN of the user access logging settings resource.
    associatedPortalArns List<String>
    List of web portal ARNs that this user access logging settings resource is associated with.
    kinesisStreamArn String

    ARN of the Kinesis stream.

    The following arguments are optional:

    tags Map<String>
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    userAccessLoggingSettingsArn String
    ARN of the user access logging settings resource.

    Import

    Using pulumi import, import WorkSpaces Web User Access Logging Settings using the user_access_logging_settings_arn. For example:

    $ pulumi import aws:workspaces/webUserAccessLoggingSettings:WebUserAccessLoggingSettings example arn:aws:workspaces-web:us-west-2:123456789012:userAccessLoggingSettings/abcdef12345
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.83.0 published on Monday, Jun 16, 2025 by Pulumi