AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.10.0 published on Monday, Jul 11, 2022 by Pulumi

BucketIntelligentTieringConfiguration

Provides an S3 Intelligent-Tiering configuration resource.

Example Usage

Add intelligent tiering configuration for entire S3 bucket

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.S3.BucketV2("example", new Aws.S3.BucketV2Args
        {
        });
        var example_entire_bucket = new Aws.S3.BucketIntelligentTieringConfiguration("example-entire-bucket", new Aws.S3.BucketIntelligentTieringConfigurationArgs
        {
            Bucket = example.Bucket,
            Tierings = 
            {
                new Aws.S3.Inputs.BucketIntelligentTieringConfigurationTieringArgs
                {
                    AccessTier = "DEEP_ARCHIVE_ACCESS",
                    Days = 180,
                },
                new Aws.S3.Inputs.BucketIntelligentTieringConfigurationTieringArgs
                {
                    AccessTier = "ARCHIVE_ACCESS",
                    Days = 125,
                },
            },
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/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", nil)
		if err != nil {
			return err
		}
		_, err = s3.NewBucketIntelligentTieringConfiguration(ctx, "example-entire-bucket", &s3.BucketIntelligentTieringConfigurationArgs{
			Bucket: example.Bucket,
			Tierings: s3.BucketIntelligentTieringConfigurationTieringArray{
				&s3.BucketIntelligentTieringConfigurationTieringArgs{
					AccessTier: pulumi.String("DEEP_ARCHIVE_ACCESS"),
					Days:       pulumi.Int(180),
				},
				&s3.BucketIntelligentTieringConfigurationTieringArgs{
					AccessTier: pulumi.String("ARCHIVE_ACCESS"),
					Days:       pulumi.Int(125),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new BucketV2("example");

        var example_entire_bucket = new BucketIntelligentTieringConfiguration("example-entire-bucket", BucketIntelligentTieringConfigurationArgs.builder()        
            .bucket(example.bucket())
            .tierings(            
                BucketIntelligentTieringConfigurationTieringArgs.builder()
                    .accessTier("DEEP_ARCHIVE_ACCESS")
                    .days(180)
                    .build(),
                BucketIntelligentTieringConfigurationTieringArgs.builder()
                    .accessTier("ARCHIVE_ACCESS")
                    .days(125)
                    .build())
            .build());

    }
}
import pulumi
import pulumi_aws as aws

example = aws.s3.BucketV2("example")
example_entire_bucket = aws.s3.BucketIntelligentTieringConfiguration("example-entire-bucket",
    bucket=example.bucket,
    tierings=[
        aws.s3.BucketIntelligentTieringConfigurationTieringArgs(
            access_tier="DEEP_ARCHIVE_ACCESS",
            days=180,
        ),
        aws.s3.BucketIntelligentTieringConfigurationTieringArgs(
            access_tier="ARCHIVE_ACCESS",
            days=125,
        ),
    ])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.s3.BucketV2("example", {});
const example_entire_bucket = new aws.s3.BucketIntelligentTieringConfiguration("example-entire-bucket", {
    bucket: example.bucket,
    tierings: [
        {
            accessTier: "DEEP_ARCHIVE_ACCESS",
            days: 180,
        },
        {
            accessTier: "ARCHIVE_ACCESS",
            days: 125,
        },
    ],
});
resources:
  example-entire-bucket:
    type: aws:s3:BucketIntelligentTieringConfiguration
    properties:
      bucket: ${example.bucket}
      tierings:
        - accessTier: DEEP_ARCHIVE_ACCESS
          days: 180
        - accessTier: ARCHIVE_ACCESS
          days: 125
  example:
    type: aws:s3:BucketV2

Add intelligent tiering configuration with S3 object filter

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.S3.BucketV2("example", new Aws.S3.BucketV2Args
        {
        });
        var example_filtered = new Aws.S3.BucketIntelligentTieringConfiguration("example-filtered", new Aws.S3.BucketIntelligentTieringConfigurationArgs
        {
            Bucket = example.Bucket,
            Status = "Disabled",
            Filter = new Aws.S3.Inputs.BucketIntelligentTieringConfigurationFilterArgs
            {
                Prefix = "documents/",
                Tags = 
                {
                    { "priority", "high" },
                    { "class", "blue" },
                },
            },
            Tierings = 
            {
                new Aws.S3.Inputs.BucketIntelligentTieringConfigurationTieringArgs
                {
                    AccessTier = "ARCHIVE_ACCESS",
                    Days = 125,
                },
            },
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/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", nil)
		if err != nil {
			return err
		}
		_, err = s3.NewBucketIntelligentTieringConfiguration(ctx, "example-filtered", &s3.BucketIntelligentTieringConfigurationArgs{
			Bucket: example.Bucket,
			Status: pulumi.String("Disabled"),
			Filter: &s3.BucketIntelligentTieringConfigurationFilterArgs{
				Prefix: pulumi.String("documents/"),
				Tags: pulumi.StringMap{
					"priority": pulumi.String("high"),
					"class":    pulumi.String("blue"),
				},
			},
			Tierings: s3.BucketIntelligentTieringConfigurationTieringArray{
				&s3.BucketIntelligentTieringConfigurationTieringArgs{
					AccessTier: pulumi.String("ARCHIVE_ACCESS"),
					Days:       pulumi.Int(125),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new BucketV2("example");

        var example_filtered = new BucketIntelligentTieringConfiguration("example-filtered", BucketIntelligentTieringConfigurationArgs.builder()        
            .bucket(example.bucket())
            .status("Disabled")
            .filter(BucketIntelligentTieringConfigurationFilterArgs.builder()
                .prefix("documents/")
                .tags(Map.ofEntries(
                    Map.entry("priority", "high"),
                    Map.entry("class", "blue")
                ))
                .build())
            .tierings(BucketIntelligentTieringConfigurationTieringArgs.builder()
                .accessTier("ARCHIVE_ACCESS")
                .days(125)
                .build())
            .build());

    }
}
import pulumi
import pulumi_aws as aws

example = aws.s3.BucketV2("example")
example_filtered = aws.s3.BucketIntelligentTieringConfiguration("example-filtered",
    bucket=example.bucket,
    status="Disabled",
    filter=aws.s3.BucketIntelligentTieringConfigurationFilterArgs(
        prefix="documents/",
        tags={
            "priority": "high",
            "class": "blue",
        },
    ),
    tierings=[aws.s3.BucketIntelligentTieringConfigurationTieringArgs(
        access_tier="ARCHIVE_ACCESS",
        days=125,
    )])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.s3.BucketV2("example", {});
const example_filtered = new aws.s3.BucketIntelligentTieringConfiguration("example-filtered", {
    bucket: example.bucket,
    status: "Disabled",
    filter: {
        prefix: "documents/",
        tags: {
            priority: "high",
            "class": "blue",
        },
    },
    tierings: [{
        accessTier: "ARCHIVE_ACCESS",
        days: 125,
    }],
});
resources:
  example-filtered:
    type: aws:s3:BucketIntelligentTieringConfiguration
    properties:
      bucket: ${example.bucket}
      status: Disabled
      filter:
        prefix: documents/
        tags:
          priority: high
          class: blue
      tierings:
        - accessTier: ARCHIVE_ACCESS
          days: 125
  example:
    type: aws:s3:BucketV2

Create a BucketIntelligentTieringConfiguration Resource

new BucketIntelligentTieringConfiguration(name: string, args: BucketIntelligentTieringConfigurationArgs, opts?: CustomResourceOptions);
@overload
def BucketIntelligentTieringConfiguration(resource_name: str,
                                          opts: Optional[ResourceOptions] = None,
                                          bucket: Optional[str] = None,
                                          filter: Optional[BucketIntelligentTieringConfigurationFilterArgs] = None,
                                          name: Optional[str] = None,
                                          status: Optional[str] = None,
                                          tierings: Optional[Sequence[BucketIntelligentTieringConfigurationTieringArgs]] = None)
@overload
def BucketIntelligentTieringConfiguration(resource_name: str,
                                          args: BucketIntelligentTieringConfigurationArgs,
                                          opts: Optional[ResourceOptions] = None)
func NewBucketIntelligentTieringConfiguration(ctx *Context, name string, args BucketIntelligentTieringConfigurationArgs, opts ...ResourceOption) (*BucketIntelligentTieringConfiguration, error)
public BucketIntelligentTieringConfiguration(string name, BucketIntelligentTieringConfigurationArgs args, CustomResourceOptions? opts = null)
public BucketIntelligentTieringConfiguration(String name, BucketIntelligentTieringConfigurationArgs args)
public BucketIntelligentTieringConfiguration(String name, BucketIntelligentTieringConfigurationArgs args, CustomResourceOptions options)
type: aws:s3:BucketIntelligentTieringConfiguration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args BucketIntelligentTieringConfigurationArgs
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 BucketIntelligentTieringConfigurationArgs
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 BucketIntelligentTieringConfigurationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args BucketIntelligentTieringConfigurationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args BucketIntelligentTieringConfigurationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

BucketIntelligentTieringConfiguration Resource Properties

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

Inputs

The BucketIntelligentTieringConfiguration resource accepts the following input properties:

Bucket string

The name of the bucket this intelligent tiering configuration is associated with.

Tierings List<BucketIntelligentTieringConfigurationTieringArgs>

The S3 Intelligent-Tiering storage class tiers of the configuration (documented below).

Filter BucketIntelligentTieringConfigurationFilterArgs

A bucket filter. The configuration only includes objects that meet the filter's criteria (documented below).

Name string

The unique name used to identify the S3 Intelligent-Tiering configuration for the bucket.

Status string

Specifies the status of the configuration. Valid values: Enabled, Disabled.

Bucket string

The name of the bucket this intelligent tiering configuration is associated with.

Tierings []BucketIntelligentTieringConfigurationTieringArgs

The S3 Intelligent-Tiering storage class tiers of the configuration (documented below).

Filter BucketIntelligentTieringConfigurationFilterArgs

A bucket filter. The configuration only includes objects that meet the filter's criteria (documented below).

Name string

The unique name used to identify the S3 Intelligent-Tiering configuration for the bucket.

Status string

Specifies the status of the configuration. Valid values: Enabled, Disabled.

bucket String

The name of the bucket this intelligent tiering configuration is associated with.

tierings List<BucketIntelligentTieringConfigurationTieringArgs>

The S3 Intelligent-Tiering storage class tiers of the configuration (documented below).

filter BucketIntelligentTieringConfigurationFilterArgs

A bucket filter. The configuration only includes objects that meet the filter's criteria (documented below).

name String

The unique name used to identify the S3 Intelligent-Tiering configuration for the bucket.

status String

Specifies the status of the configuration. Valid values: Enabled, Disabled.

bucket string

The name of the bucket this intelligent tiering configuration is associated with.

tierings BucketIntelligentTieringConfigurationTieringArgs[]

The S3 Intelligent-Tiering storage class tiers of the configuration (documented below).

filter BucketIntelligentTieringConfigurationFilterArgs

A bucket filter. The configuration only includes objects that meet the filter's criteria (documented below).

name string

The unique name used to identify the S3 Intelligent-Tiering configuration for the bucket.

status string

Specifies the status of the configuration. Valid values: Enabled, Disabled.

bucket str

The name of the bucket this intelligent tiering configuration is associated with.

tierings Sequence[BucketIntelligentTieringConfigurationTieringArgs]

The S3 Intelligent-Tiering storage class tiers of the configuration (documented below).

filter BucketIntelligentTieringConfigurationFilterArgs

A bucket filter. The configuration only includes objects that meet the filter's criteria (documented below).

name str

The unique name used to identify the S3 Intelligent-Tiering configuration for the bucket.

status str

Specifies the status of the configuration. Valid values: Enabled, Disabled.

bucket String

The name of the bucket this intelligent tiering configuration is associated with.

tierings List<Property Map>

The S3 Intelligent-Tiering storage class tiers of the configuration (documented below).

filter Property Map

A bucket filter. The configuration only includes objects that meet the filter's criteria (documented below).

name String

The unique name used to identify the S3 Intelligent-Tiering configuration for the bucket.

status String

Specifies the status of the configuration. Valid values: Enabled, Disabled.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up an Existing BucketIntelligentTieringConfiguration Resource

Get an existing BucketIntelligentTieringConfiguration 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?: BucketIntelligentTieringConfigurationState, opts?: CustomResourceOptions): BucketIntelligentTieringConfiguration
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bucket: Optional[str] = None,
        filter: Optional[BucketIntelligentTieringConfigurationFilterArgs] = None,
        name: Optional[str] = None,
        status: Optional[str] = None,
        tierings: Optional[Sequence[BucketIntelligentTieringConfigurationTieringArgs]] = None) -> BucketIntelligentTieringConfiguration
func GetBucketIntelligentTieringConfiguration(ctx *Context, name string, id IDInput, state *BucketIntelligentTieringConfigurationState, opts ...ResourceOption) (*BucketIntelligentTieringConfiguration, error)
public static BucketIntelligentTieringConfiguration Get(string name, Input<string> id, BucketIntelligentTieringConfigurationState? state, CustomResourceOptions? opts = null)
public static BucketIntelligentTieringConfiguration get(String name, Output<String> id, BucketIntelligentTieringConfigurationState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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:
Bucket string

The name of the bucket this intelligent tiering configuration is associated with.

Filter BucketIntelligentTieringConfigurationFilterArgs

A bucket filter. The configuration only includes objects that meet the filter's criteria (documented below).

Name string

The unique name used to identify the S3 Intelligent-Tiering configuration for the bucket.

Status string

Specifies the status of the configuration. Valid values: Enabled, Disabled.

Tierings List<BucketIntelligentTieringConfigurationTieringArgs>

The S3 Intelligent-Tiering storage class tiers of the configuration (documented below).

Bucket string

The name of the bucket this intelligent tiering configuration is associated with.

Filter BucketIntelligentTieringConfigurationFilterArgs

A bucket filter. The configuration only includes objects that meet the filter's criteria (documented below).

Name string

The unique name used to identify the S3 Intelligent-Tiering configuration for the bucket.

Status string

Specifies the status of the configuration. Valid values: Enabled, Disabled.

Tierings []BucketIntelligentTieringConfigurationTieringArgs

The S3 Intelligent-Tiering storage class tiers of the configuration (documented below).

bucket String

The name of the bucket this intelligent tiering configuration is associated with.

filter BucketIntelligentTieringConfigurationFilterArgs

A bucket filter. The configuration only includes objects that meet the filter's criteria (documented below).

name String

The unique name used to identify the S3 Intelligent-Tiering configuration for the bucket.

status String

Specifies the status of the configuration. Valid values: Enabled, Disabled.

tierings List<BucketIntelligentTieringConfigurationTieringArgs>

The S3 Intelligent-Tiering storage class tiers of the configuration (documented below).

bucket string

The name of the bucket this intelligent tiering configuration is associated with.

filter BucketIntelligentTieringConfigurationFilterArgs

A bucket filter. The configuration only includes objects that meet the filter's criteria (documented below).

name string

The unique name used to identify the S3 Intelligent-Tiering configuration for the bucket.

status string

Specifies the status of the configuration. Valid values: Enabled, Disabled.

tierings BucketIntelligentTieringConfigurationTieringArgs[]

The S3 Intelligent-Tiering storage class tiers of the configuration (documented below).

bucket str

The name of the bucket this intelligent tiering configuration is associated with.

filter BucketIntelligentTieringConfigurationFilterArgs

A bucket filter. The configuration only includes objects that meet the filter's criteria (documented below).

name str

The unique name used to identify the S3 Intelligent-Tiering configuration for the bucket.

status str

Specifies the status of the configuration. Valid values: Enabled, Disabled.

tierings Sequence[BucketIntelligentTieringConfigurationTieringArgs]

The S3 Intelligent-Tiering storage class tiers of the configuration (documented below).

bucket String

The name of the bucket this intelligent tiering configuration is associated with.

filter Property Map

A bucket filter. The configuration only includes objects that meet the filter's criteria (documented below).

name String

The unique name used to identify the S3 Intelligent-Tiering configuration for the bucket.

status String

Specifies the status of the configuration. Valid values: Enabled, Disabled.

tierings List<Property Map>

The S3 Intelligent-Tiering storage class tiers of the configuration (documented below).

Supporting Types

BucketIntelligentTieringConfigurationFilter

Prefix string

An object key name prefix that identifies the subset of objects to which the configuration applies.

Tags Dictionary<string, string>

All of these tags must exist in the object's tag set in order for the configuration to apply.

Prefix string

An object key name prefix that identifies the subset of objects to which the configuration applies.

Tags map[string]string

All of these tags must exist in the object's tag set in order for the configuration to apply.

prefix String

An object key name prefix that identifies the subset of objects to which the configuration applies.

tags Map<String,String>

All of these tags must exist in the object's tag set in order for the configuration to apply.

prefix string

An object key name prefix that identifies the subset of objects to which the configuration applies.

tags {[key: string]: string}

All of these tags must exist in the object's tag set in order for the configuration to apply.

prefix str

An object key name prefix that identifies the subset of objects to which the configuration applies.

tags Mapping[str, str]

All of these tags must exist in the object's tag set in order for the configuration to apply.

prefix String

An object key name prefix that identifies the subset of objects to which the configuration applies.

tags Map<String>

All of these tags must exist in the object's tag set in order for the configuration to apply.

BucketIntelligentTieringConfigurationTiering

AccessTier string

S3 Intelligent-Tiering access tier. Valid values: ARCHIVE_ACCESS, DEEP_ARCHIVE_ACCESS.

Days int

The number of consecutive days of no access after which an object will be eligible to be transitioned to the corresponding tier.

AccessTier string

S3 Intelligent-Tiering access tier. Valid values: ARCHIVE_ACCESS, DEEP_ARCHIVE_ACCESS.

Days int

The number of consecutive days of no access after which an object will be eligible to be transitioned to the corresponding tier.

accessTier String

S3 Intelligent-Tiering access tier. Valid values: ARCHIVE_ACCESS, DEEP_ARCHIVE_ACCESS.

days Integer

The number of consecutive days of no access after which an object will be eligible to be transitioned to the corresponding tier.

accessTier string

S3 Intelligent-Tiering access tier. Valid values: ARCHIVE_ACCESS, DEEP_ARCHIVE_ACCESS.

days number

The number of consecutive days of no access after which an object will be eligible to be transitioned to the corresponding tier.

access_tier str

S3 Intelligent-Tiering access tier. Valid values: ARCHIVE_ACCESS, DEEP_ARCHIVE_ACCESS.

days int

The number of consecutive days of no access after which an object will be eligible to be transitioned to the corresponding tier.

accessTier String

S3 Intelligent-Tiering access tier. Valid values: ARCHIVE_ACCESS, DEEP_ARCHIVE_ACCESS.

days Number

The number of consecutive days of no access after which an object will be eligible to be transitioned to the corresponding tier.

Import

S3 bucket intelligent tiering configurations can be imported using bucket:name, e.g.

 $ pulumi import aws:s3/bucketIntelligentTieringConfiguration:BucketIntelligentTieringConfiguration my-bucket-entire-bucket my-bucket:EntireBucket

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.