Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.pulumi.aws.s3.kotlin.BucketMetric.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.aws.s3.kotlin
import com.pulumi.aws.s3.kotlin.outputs.BucketMetricFilter
import com.pulumi.aws.s3.kotlin.outputs.BucketMetricFilter.Companion.toKotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
/**
* Builder for [BucketMetric].
*/
@PulumiTagMarker
public class BucketMetricResourceBuilder internal constructor() {
public var name: String? = null
public var args: BucketMetricArgs = BucketMetricArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend BucketMetricArgsBuilder.() -> Unit) {
val builder = BucketMetricArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): BucketMetric {
val builtJavaResource = com.pulumi.aws.s3.BucketMetric(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return BucketMetric(builtJavaResource)
}
}
/**
* Provides a S3 bucket [metrics configuration](http://docs.aws.amazon.com/AmazonS3/latest/dev/metrics-configurations.html) resource.
* > This resource cannot be used with S3 directory buckets.
* ## Example Usage
* ### Add metrics configuration for entire S3 bucket
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* const example = new aws.s3.BucketV2("example", {bucket: "example"});
* const example_entire_bucket = new aws.s3.BucketMetric("example-entire-bucket", {
* bucket: example.id,
* name: "EntireBucket",
* });
* ```
* ```python
* import pulumi
* import pulumi_aws as aws
* example = aws.s3.BucketV2("example", bucket="example")
* example_entire_bucket = aws.s3.BucketMetric("example-entire-bucket",
* bucket=example.id,
* name="EntireBucket")
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Aws = Pulumi.Aws;
* return await Deployment.RunAsync(() =>
* {
* var example = new Aws.S3.BucketV2("example", new()
* {
* Bucket = "example",
* });
* var example_entire_bucket = new Aws.S3.BucketMetric("example-entire-bucket", new()
* {
* Bucket = example.Id,
* Name = "EntireBucket",
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/s3"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* example, err := s3.NewBucketV2(ctx, "example", &s3.BucketV2Args{
* Bucket: pulumi.String("example"),
* })
* if err != nil {
* return err
* }
* _, err = s3.NewBucketMetric(ctx, "example-entire-bucket", &s3.BucketMetricArgs{
* Bucket: example.ID(),
* Name: pulumi.String("EntireBucket"),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.aws.s3.BucketV2;
* import com.pulumi.aws.s3.BucketV2Args;
* import com.pulumi.aws.s3.BucketMetric;
* import com.pulumi.aws.s3.BucketMetricArgs;
* 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 BucketV2("example", BucketV2Args.builder()
* .bucket("example")
* .build());
* var example_entire_bucket = new BucketMetric("example-entire-bucket", BucketMetricArgs.builder()
* .bucket(example.id())
* .name("EntireBucket")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: aws:s3:BucketV2
* properties:
* bucket: example
* example-entire-bucket:
* type: aws:s3:BucketMetric
* properties:
* bucket: ${example.id}
* name: EntireBucket
* ```
*
* ### Add metrics configuration with S3 object filter
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* const example = new aws.s3.BucketV2("example", {bucket: "example"});
* const example_filtered = new aws.s3.BucketMetric("example-filtered", {
* bucket: example.id,
* name: "ImportantBlueDocuments",
* filter: {
* prefix: "documents/",
* tags: {
* priority: "high",
* "class": "blue",
* },
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_aws as aws
* example = aws.s3.BucketV2("example", bucket="example")
* example_filtered = aws.s3.BucketMetric("example-filtered",
* bucket=example.id,
* name="ImportantBlueDocuments",
* filter={
* "prefix": "documents/",
* "tags": {
* "priority": "high",
* "class_": "blue",
* },
* })
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Aws = Pulumi.Aws;
* return await Deployment.RunAsync(() =>
* {
* var example = new Aws.S3.BucketV2("example", new()
* {
* Bucket = "example",
* });
* var example_filtered = new Aws.S3.BucketMetric("example-filtered", new()
* {
* Bucket = example.Id,
* Name = "ImportantBlueDocuments",
* Filter = new Aws.S3.Inputs.BucketMetricFilterArgs
* {
* Prefix = "documents/",
* Tags =
* {
* { "priority", "high" },
* { "class", "blue" },
* },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/s3"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* example, err := s3.NewBucketV2(ctx, "example", &s3.BucketV2Args{
* Bucket: pulumi.String("example"),
* })
* if err != nil {
* return err
* }
* _, err = s3.NewBucketMetric(ctx, "example-filtered", &s3.BucketMetricArgs{
* Bucket: example.ID(),
* Name: pulumi.String("ImportantBlueDocuments"),
* Filter: &s3.BucketMetricFilterArgs{
* Prefix: pulumi.String("documents/"),
* Tags: pulumi.StringMap{
* "priority": pulumi.String("high"),
* "class": pulumi.String("blue"),
* },
* },
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.aws.s3.BucketV2;
* import com.pulumi.aws.s3.BucketV2Args;
* import com.pulumi.aws.s3.BucketMetric;
* import com.pulumi.aws.s3.BucketMetricArgs;
* import com.pulumi.aws.s3.inputs.BucketMetricFilterArgs;
* 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 BucketV2("example", BucketV2Args.builder()
* .bucket("example")
* .build());
* var example_filtered = new BucketMetric("example-filtered", BucketMetricArgs.builder()
* .bucket(example.id())
* .name("ImportantBlueDocuments")
* .filter(BucketMetricFilterArgs.builder()
* .prefix("documents/")
* .tags(Map.ofEntries(
* Map.entry("priority", "high"),
* Map.entry("class", "blue")
* ))
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: aws:s3:BucketV2
* properties:
* bucket: example
* example-filtered:
* type: aws:s3:BucketMetric
* properties:
* bucket: ${example.id}
* name: ImportantBlueDocuments
* filter:
* prefix: documents/
* tags:
* priority: high
* class: blue
* ```
*
* ### Add metrics configuration with S3 object filter for S3 Access Point
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* const example = new aws.s3.BucketV2("example", {bucket: "example"});
* const example_access_point = new aws.s3.AccessPoint("example-access-point", {
* bucket: example.id,
* name: "example-access-point",
* });
* const example_filtered = new aws.s3.BucketMetric("example-filtered", {
* bucket: example.id,
* name: "ImportantBlueDocuments",
* filter: {
* accessPoint: example_access_point.arn,
* tags: {
* priority: "high",
* "class": "blue",
* },
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_aws as aws
* example = aws.s3.BucketV2("example", bucket="example")
* example_access_point = aws.s3.AccessPoint("example-access-point",
* bucket=example.id,
* name="example-access-point")
* example_filtered = aws.s3.BucketMetric("example-filtered",
* bucket=example.id,
* name="ImportantBlueDocuments",
* filter={
* "access_point": example_access_point.arn,
* "tags": {
* "priority": "high",
* "class_": "blue",
* },
* })
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Aws = Pulumi.Aws;
* return await Deployment.RunAsync(() =>
* {
* var example = new Aws.S3.BucketV2("example", new()
* {
* Bucket = "example",
* });
* var example_access_point = new Aws.S3.AccessPoint("example-access-point", new()
* {
* Bucket = example.Id,
* Name = "example-access-point",
* });
* var example_filtered = new Aws.S3.BucketMetric("example-filtered", new()
* {
* Bucket = example.Id,
* Name = "ImportantBlueDocuments",
* Filter = new Aws.S3.Inputs.BucketMetricFilterArgs
* {
* AccessPoint = example_access_point.Arn,
* Tags =
* {
* { "priority", "high" },
* { "class", "blue" },
* },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/s3"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* example, err := s3.NewBucketV2(ctx, "example", &s3.BucketV2Args{
* Bucket: pulumi.String("example"),
* })
* if err != nil {
* return err
* }
* _, err = s3.NewAccessPoint(ctx, "example-access-point", &s3.AccessPointArgs{
* Bucket: example.ID(),
* Name: pulumi.String("example-access-point"),
* })
* if err != nil {
* return err
* }
* _, err = s3.NewBucketMetric(ctx, "example-filtered", &s3.BucketMetricArgs{
* Bucket: example.ID(),
* Name: pulumi.String("ImportantBlueDocuments"),
* Filter: &s3.BucketMetricFilterArgs{
* AccessPoint: example_access_point.Arn,
* Tags: pulumi.StringMap{
* "priority": pulumi.String("high"),
* "class": pulumi.String("blue"),
* },
* },
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.aws.s3.BucketV2;
* import com.pulumi.aws.s3.BucketV2Args;
* import com.pulumi.aws.s3.AccessPoint;
* import com.pulumi.aws.s3.AccessPointArgs;
* import com.pulumi.aws.s3.BucketMetric;
* import com.pulumi.aws.s3.BucketMetricArgs;
* import com.pulumi.aws.s3.inputs.BucketMetricFilterArgs;
* 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 BucketV2("example", BucketV2Args.builder()
* .bucket("example")
* .build());
* var example_access_point = new AccessPoint("example-access-point", AccessPointArgs.builder()
* .bucket(example.id())
* .name("example-access-point")
* .build());
* var example_filtered = new BucketMetric("example-filtered", BucketMetricArgs.builder()
* .bucket(example.id())
* .name("ImportantBlueDocuments")
* .filter(BucketMetricFilterArgs.builder()
* .accessPoint(example_access_point.arn())
* .tags(Map.ofEntries(
* Map.entry("priority", "high"),
* Map.entry("class", "blue")
* ))
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: aws:s3:BucketV2
* properties:
* bucket: example
* example-access-point:
* type: aws:s3:AccessPoint
* properties:
* bucket: ${example.id}
* name: example-access-point
* example-filtered:
* type: aws:s3:BucketMetric
* properties:
* bucket: ${example.id}
* name: ImportantBlueDocuments
* filter:
* accessPoint: ${["example-access-point"].arn}
* tags:
* priority: high
* class: blue
* ```
*
* ## Import
* Using `pulumi import`, import S3 bucket metric configurations using `bucket:metric`. For example:
* ```sh
* $ pulumi import aws:s3/bucketMetric:BucketMetric my-bucket-entire-bucket my-bucket:EntireBucket
* ```
*/
public class BucketMetric internal constructor(
override val javaResource: com.pulumi.aws.s3.BucketMetric,
) : KotlinCustomResource(javaResource, BucketMetricMapper) {
/**
* Name of the bucket to put metric configuration.
*/
public val bucket: Output
get() = javaResource.bucket().applyValue({ args0 -> args0 })
/**
* [Object filtering](http://docs.aws.amazon.com/AmazonS3/latest/dev/metrics-configurations.html#metrics-configurations-filter) that accepts a prefix, tags, or a logical AND of prefix and tags (documented below).
*/
public val filter: Output?
get() = javaResource.filter().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
toKotlin(args0)
})
}).orElse(null)
})
/**
* Unique identifier of the metrics configuration for the bucket. Must be less than or equal to 64 characters in length.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
}
public object BucketMetricMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.aws.s3.BucketMetric::class == javaResource::class
override fun map(javaResource: Resource): BucketMetric = BucketMetric(
javaResource as
com.pulumi.aws.s3.BucketMetric,
)
}
/**
* @see [BucketMetric].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [BucketMetric].
*/
public suspend fun bucketMetric(
name: String,
block: suspend BucketMetricResourceBuilder.() -> Unit,
): BucketMetric {
val builder = BucketMetricResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [BucketMetric].
* @param name The _unique_ name of the resulting resource.
*/
public fun bucketMetric(name: String): BucketMetric {
val builder = BucketMetricResourceBuilder()
builder.name(name)
return builder.build()
}
