StorageLensConfiguration class

Provides a resource to manage an S3 Storage Lens configuration.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const current = aws.getCallerIdentity({});
const example = new aws.s3control.StorageLensConfiguration("example", {
    storageLensConfiguration: {
        accountLevel: {
            activityMetrics: {
                enabled: true,
            },
            bucketLevel: {
                activityMetrics: {
                    enabled: true,
                },
            },
        },
        dataExport: {
            cloudWatchMetrics: {
                enabled: true,
            },
            s3BucketDestination: {
                encryption: {
                    sseS3s: [{}],
                },
                accountId: current.then(current => current.accountId),
                arn: target.arn,
                format: "CSV",
                outputSchemaVersion: "V_1",
            },
        },
        exclude: {
            buckets: [
                b1.arn,
                b2.arn,
            ],
            regions: ["us-east-2"],
        },
        enabled: true,
    },
    configId: "example-1",
});
import pulumi
import pulumi_aws as aws

current = aws.get_caller_identity()
example = aws.s3control.StorageLensConfiguration("example",
    storage_lens_configuration={
        "account_level": {
            "activity_metrics": {
                "enabled": True,
            },
            "bucket_level": {
                "activity_metrics": {
                    "enabled": True,
                },
            },
        },
        "data_export": {
            "cloud_watch_metrics": {
                "enabled": True,
            },
            "s3_bucket_destination": {
                "encryption": {
                    "sse_s3s": [{}],
                },
                "account_id": current.account_id,
                "arn": target["arn"],
                "format": "CSV",
                "output_schema_version": "V_1",
            },
        },
        "exclude": {
            "buckets": [
                b1["arn"],
                b2["arn"],
            ],
            "regions": ["us-east-2"],
        },
        "enabled": True,
    },
    config_id="example-1")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var current = Aws.GetCallerIdentity.Invoke();

    var example = new Aws.S3Control.StorageLensConfiguration("example", new()
    {
        StorageLensConfigurationDetail = new Aws.S3Control.Inputs.StorageLensConfigurationStorageLensConfigurationArgs
        {
            AccountLevel = new Aws.S3Control.Inputs.StorageLensConfigurationStorageLensConfigurationAccountLevelArgs
            {
                ActivityMetrics = new Aws.S3Control.Inputs.StorageLensConfigurationStorageLensConfigurationAccountLevelActivityMetricsArgs
                {
                    Enabled = true,
                },
                BucketLevel = new Aws.S3Control.Inputs.StorageLensConfigurationStorageLensConfigurationAccountLevelBucketLevelArgs
                {
                    ActivityMetrics = new Aws.S3Control.Inputs.StorageLensConfigurationStorageLensConfigurationAccountLevelBucketLevelActivityMetricsArgs
                    {
                        Enabled = true,
                    },
                },
            },
            DataExport = new Aws.S3Control.Inputs.StorageLensConfigurationStorageLensConfigurationDataExportArgs
            {
                CloudWatchMetrics = new Aws.S3Control.Inputs.StorageLensConfigurationStorageLensConfigurationDataExportCloudWatchMetricsArgs
                {
                    Enabled = true,
                },
                S3BucketDestination = new Aws.S3Control.Inputs.StorageLensConfigurationStorageLensConfigurationDataExportS3BucketDestinationArgs
                {
                    Encryption = new Aws.S3Control.Inputs.StorageLensConfigurationStorageLensConfigurationDataExportS3BucketDestinationEncryptionArgs
                    {
                        SseS3s = new[]
                        {
                            null,
                        },
                    },
                    AccountId = current.Apply(getCallerIdentityResult => getCallerIdentityResult.AccountId),
                    Arn = target.Arn,
                    Format = "CSV",
                    OutputSchemaVersion = "V_1",
                },
            },
            Exclude = new Aws.S3Control.Inputs.StorageLensConfigurationStorageLensConfigurationExcludeArgs
            {
                Buckets = new[]
                {
                    b1.Arn,
                    b2.Arn,
                },
                Regions = new[]
                {
                    "us-east-2",
                },
            },
            Enabled = true,
        },
        ConfigId = "example-1",
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		current, err := aws.GetCallerIdentity(ctx, &aws.GetCallerIdentityArgs{}, nil)
		if err != nil {
			return err
		}
		_, err = s3control.NewStorageLensConfiguration(ctx, "example", &s3control.StorageLensConfigurationArgs{
			StorageLensConfiguration: &s3control.StorageLensConfigurationStorageLensConfigurationArgs{
				AccountLevel: &s3control.StorageLensConfigurationStorageLensConfigurationAccountLevelArgs{
					ActivityMetrics: &s3control.StorageLensConfigurationStorageLensConfigurationAccountLevelActivityMetricsArgs{
						Enabled: pulumi.Bool(true),
					},
					BucketLevel: &s3control.StorageLensConfigurationStorageLensConfigurationAccountLevelBucketLevelArgs{
						ActivityMetrics: &s3control.StorageLensConfigurationStorageLensConfigurationAccountLevelBucketLevelActivityMetricsArgs{
							Enabled: pulumi.Bool(true),
						},
					},
				},
				DataExport: &s3control.StorageLensConfigurationStorageLensConfigurationDataExportArgs{
					CloudWatchMetrics: &s3control.StorageLensConfigurationStorageLensConfigurationDataExportCloudWatchMetricsArgs{
						Enabled: pulumi.Bool(true),
					},
					S3BucketDestination: &s3control.StorageLensConfigurationStorageLensConfigurationDataExportS3BucketDestinationArgs{
						Encryption: &s3control.StorageLensConfigurationStorageLensConfigurationDataExportS3BucketDestinationEncryptionArgs{
							SseS3s: s3control.StorageLensConfigurationStorageLensConfigurationDataExportS3BucketDestinationEncryptionSseS3Array{
								&s3control.StorageLensConfigurationStorageLensConfigurationDataExportS3BucketDestinationEncryptionSseS3Args{},
							},
						},
						AccountId:           pulumi.String(current.AccountId),
						Arn:                 pulumi.Any(target.Arn),
						Format:              pulumi.String("CSV"),
						OutputSchemaVersion: pulumi.String("V_1"),
					},
				},
				Exclude: &s3control.StorageLensConfigurationStorageLensConfigurationExcludeArgs{
					Buckets: pulumi.StringArray{
						b1.Arn,
						b2.Arn,
					},
					Regions: pulumi.StringArray{
						pulumi.String("us-east-2"),
					},
				},
				Enabled: pulumi.Bool(true),
			},
			ConfigId: pulumi.String("example-1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_getcalleridentity" "current" {
}

resource "aws_s3control_storagelensconfiguration" "example" {
  storage_lens_configuration = {
    account_level = {
      activity_metrics = {
        enabled = true
      }
      bucket_level = {
        activity_metrics = {
          enabled = true
        }
      }
    }
    data_export = {
      cloud_watch_metrics = {
        enabled = true
      }
      s3_bucket_destination = {
        encryption = {
          sse_s3s = [{}]
        }
        account_id            = data.aws_getcalleridentity.current.account_id
        arn                   = target.arn
        format                = "CSV"
        output_schema_version = "V_1"
      }
    }
    exclude = {
      buckets = [b1.arn, b2.arn]
      regions = ["us-east-2"]
    }
    enabled = true
  }
  config_id = "example-1"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.AwsFunctions;
import com.pulumi.aws.inputs.GetCallerIdentityArgs;
import com.pulumi.aws.s3control.StorageLensConfiguration;
import com.pulumi.aws.s3control.StorageLensConfigurationArgs;
import com.pulumi.aws.s3control.inputs.StorageLensConfigurationStorageLensConfigurationArgs;
import com.pulumi.aws.s3control.inputs.StorageLensConfigurationStorageLensConfigurationAccountLevelArgs;
import com.pulumi.aws.s3control.inputs.StorageLensConfigurationStorageLensConfigurationAccountLevelActivityMetricsArgs;
import com.pulumi.aws.s3control.inputs.StorageLensConfigurationStorageLensConfigurationAccountLevelBucketLevelArgs;
import com.pulumi.aws.s3control.inputs.StorageLensConfigurationStorageLensConfigurationAccountLevelBucketLevelActivityMetricsArgs;
import com.pulumi.aws.s3control.inputs.StorageLensConfigurationStorageLensConfigurationDataExportArgs;
import com.pulumi.aws.s3control.inputs.StorageLensConfigurationStorageLensConfigurationDataExportCloudWatchMetricsArgs;
import com.pulumi.aws.s3control.inputs.StorageLensConfigurationStorageLensConfigurationDataExportS3BucketDestinationArgs;
import com.pulumi.aws.s3control.inputs.StorageLensConfigurationStorageLensConfigurationDataExportS3BucketDestinationEncryptionArgs;
import com.pulumi.aws.s3control.inputs.StorageLensConfigurationStorageLensConfigurationDataExportS3BucketDestinationEncryptionSseS3Args;
import com.pulumi.aws.s3control.inputs.StorageLensConfigurationStorageLensConfigurationExcludeArgs;
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) {
        final var current = AwsFunctions.getCallerIdentity(GetCallerIdentityArgs.builder()
            .build());

        var example = new StorageLensConfiguration("example", StorageLensConfigurationArgs.builder()
            .storageLensConfiguration(StorageLensConfigurationStorageLensConfigurationArgs.builder()
                .accountLevel(StorageLensConfigurationStorageLensConfigurationAccountLevelArgs.builder()
                    .activityMetrics(StorageLensConfigurationStorageLensConfigurationAccountLevelActivityMetricsArgs.builder()
                        .enabled(true)
                        .build())
                    .bucketLevel(StorageLensConfigurationStorageLensConfigurationAccountLevelBucketLevelArgs.builder()
                        .activityMetrics(StorageLensConfigurationStorageLensConfigurationAccountLevelBucketLevelActivityMetricsArgs.builder()
                            .enabled(true)
                            .build())
                        .build())
                    .build())
                .dataExport(StorageLensConfigurationStorageLensConfigurationDataExportArgs.builder()
                    .cloudWatchMetrics(StorageLensConfigurationStorageLensConfigurationDataExportCloudWatchMetricsArgs.builder()
                        .enabled(true)
                        .build())
                    .s3BucketDestination(StorageLensConfigurationStorageLensConfigurationDataExportS3BucketDestinationArgs.builder()
                        .encryption(StorageLensConfigurationStorageLensConfigurationDataExportS3BucketDestinationEncryptionArgs.builder()
                            .sseS3s(StorageLensConfigurationStorageLensConfigurationDataExportS3BucketDestinationEncryptionSseS3Args.builder()
                                .build())
                            .build())
                        .accountId(current.accountId())
                        .arn(target.arn())
                        .format("CSV")
                        .outputSchemaVersion("V_1")
                        .build())
                    .build())
                .exclude(StorageLensConfigurationStorageLensConfigurationExcludeArgs.builder()
                    .buckets(
                        b1.arn(),
                        b2.arn())
                    .regions("us-east-2")
                    .build())
                .enabled(true)
                .build())
            .configId("example-1")
            .build());

    }
}
resources:
  example:
    type: aws:s3control:StorageLensConfiguration
    properties:
      storageLensConfiguration:
        accountLevel:
          activityMetrics:
            enabled: true
          bucketLevel:
            activityMetrics:
              enabled: true
        dataExport:
          cloudWatchMetrics:
            enabled: true
          s3BucketDestination:
            encryption:
              sseS3s:
                - {}
            accountId: ${current.accountId}
            arn: ${target.arn}
            format: CSV
            outputSchemaVersion: V_1
        exclude:
          buckets:
            - ${b1.arn}
            - ${b2.arn}
          regions:
            - us-east-2
        enabled: true
      configId: example-1
variables:
  current:
    fn::invoke:
      function: aws:getCallerIdentity
      arguments: {}

Import

Using pulumi import, import S3 Storage Lens configurations using the accountId and configId, separated by a colon (:). For example:

$ pulumi import aws:s3control/storageLensConfiguration:StorageLensConfiguration example 123456789012:example-1

Constructors

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

Properties

accountId ↔ Output<String>
AWS account ID for the S3 Storage Lens configuration. Defaults to automatically determined account ID of the AWS provider.
latefinal
arn ↔ Output<String>
ARN of the S3 Storage Lens configuration.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
configId ↔ Output<String>
ID of the S3 Storage Lens configuration.
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
storageLensConfiguration ↔ Output<StorageLensConfigurationStorageLensConfiguration>
S3 Storage Lens configuration. See storageLensConfiguration below for more details.
latefinal
tags ↔ Output<Map<String, String>?>
Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
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, {StorageLensConfigurationState? state, CustomResourceOptions? options}) → StorageLensConfiguration
Gets an existing StorageLensConfiguration resource's state with the given name and id.