UserAccessLoggingSettings class
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)
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 main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/kinesis"
"github.com/pulumi/pulumi-aws/sdk/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_kinesis_stream" "example" {
name = "amazon-workspaces-web-example-stream"
shard_count = 1
}
resource "aws_workspacesweb_useraccessloggingsettings" "example" {
kinesis_stream_arn = aws_kinesis_stream.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.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()
.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",
})
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 main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/kinesis"
"github.com/pulumi/pulumi-aws/sdk/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_kinesis_stream" "example" {
name = "example-stream"
shard_count = 1
}
resource "aws_workspacesweb_useraccessloggingsettings" "example" {
kinesis_stream_arn = aws_kinesis_stream.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.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()
.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
Import
Using pulumi import, import WorkSpaces Web User Access Logging Settings using the userAccessLoggingSettingsArn. For example:
$ pulumi import aws:workspacesweb/userAccessLoggingSettings:UserAccessLoggingSettings example arn:aws:workspaces-web:us-west-2:123456789012:userAccessLoggingSettings/abcdef12345
Constructors
- UserAccessLoggingSettings(String name, {UserAccessLoggingSettingsArgs? args, CustomResourceOptions? options})
-
Creates a new UserAccessLoggingSettings.
nameThe Pulumi resource name.argsArguments used to configure this UserAccessLoggingSettings. The set of arguments for UserAccessLoggingSettings.optionsResource options controlling this resource's behavior. - UserAccessLoggingSettings.reference(String urn)
- Creates a typed reference to an existing UserAccessLoggingSettings resource.
Properties
-
associatedPortalArns
↔ Output<
List< String> > -
List of web portal ARNs that this user access logging settings resource is associated with.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- 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
-
kinesisStreamArn
↔ Output<
String> -
ARN of the Kinesis stream.
latefinal
-
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
-
Map of tags assigned to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
userAccessLoggingSettingsArn
↔ Output<
String> -
ARN of the user access logging settings resource.
latefinal
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, {UserAccessLoggingSettingsState? state, CustomResourceOptions? options}) → UserAccessLoggingSettings -
Gets an existing UserAccessLoggingSettings resource's state with the given
nameandid.