DirectoryBucket class

Provides an Amazon S3 Express directory bucket resource.

Example Usage

Availability Zone

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

const example = new aws.s3.DirectoryBucket("example", {
    location: {
        name: "usw2-az1",
    },
    bucket: "example--usw2-az1--x-s3",
});
import pulumi
import pulumi_aws as aws

example = aws.s3.DirectoryBucket("example",
    location={
        "name": "usw2-az1",
    },
    bucket="example--usw2-az1--x-s3")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.S3.DirectoryBucket("example", new()
    {
        Location = new Aws.S3.Inputs.DirectoryBucketLocationArgs
        {
            Name = "usw2-az1",
        },
        Bucket = "example--usw2-az1--x-s3",
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := s3.NewDirectoryBucket(ctx, "example", &s3.DirectoryBucketArgs{
			Location: &s3.DirectoryBucketLocationArgs{
				Name: pulumi.String("usw2-az1"),
			},
			Bucket: pulumi.String("example--usw2-az1--x-s3"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_s3_directorybucket" "example" {
  location = {
    name = "usw2-az1"
  }
  bucket = "example--usw2-az1--x-s3"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3.DirectoryBucket;
import com.pulumi.aws.s3.DirectoryBucketArgs;
import com.pulumi.aws.s3.inputs.DirectoryBucketLocationArgs;
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 DirectoryBucket("example", DirectoryBucketArgs.builder()
            .location(DirectoryBucketLocationArgs.builder()
                .name("usw2-az1")
                .build())
            .bucket("example--usw2-az1--x-s3")
            .build());

    }
}
resources:
  example:
    type: aws:s3:DirectoryBucket
    properties:
      location:
        name: usw2-az1
      bucket: example--usw2-az1--x-s3

Dedicated Local Zone

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

const exampleLocalZone = new aws.s3.DirectoryBucket("example_local_zone", {
    location: {
        name: "usw2-xxx-lz1",
        type: "LocalZone",
    },
    bucket: "example--usw2-xxx-lz1--x-s3",
});
import pulumi
import pulumi_aws as aws

example_local_zone = aws.s3.DirectoryBucket("example_local_zone",
    location={
        "name": "usw2-xxx-lz1",
        "type": "LocalZone",
    },
    bucket="example--usw2-xxx-lz1--x-s3")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var exampleLocalZone = new Aws.S3.DirectoryBucket("example_local_zone", new()
    {
        Location = new Aws.S3.Inputs.DirectoryBucketLocationArgs
        {
            Name = "usw2-xxx-lz1",
            Type = "LocalZone",
        },
        Bucket = "example--usw2-xxx-lz1--x-s3",
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := s3.NewDirectoryBucket(ctx, "example_local_zone", &s3.DirectoryBucketArgs{
			Location: &s3.DirectoryBucketLocationArgs{
				Name: pulumi.String("usw2-xxx-lz1"),
				Type: pulumi.String("LocalZone"),
			},
			Bucket: pulumi.String("example--usw2-xxx-lz1--x-s3"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_s3_directorybucket" "example_local_zone" {
  location = {
    name = "usw2-xxx-lz1"
    type = "LocalZone"
  }
  # LocalZone ID
  bucket = "example--usw2-xxx-lz1--x-s3"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3.DirectoryBucket;
import com.pulumi.aws.s3.DirectoryBucketArgs;
import com.pulumi.aws.s3.inputs.DirectoryBucketLocationArgs;
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 exampleLocalZone = new DirectoryBucket("exampleLocalZone", DirectoryBucketArgs.builder()
            .location(DirectoryBucketLocationArgs.builder()
                .name("usw2-xxx-lz1")
                .type("LocalZone")
                .build())
            .bucket("example--usw2-xxx-lz1--x-s3")
            .build());

    }
}
resources:
  exampleLocalZone:
    type: aws:s3:DirectoryBucket
    name: example_local_zone
    properties:
      location:
        name: usw2-xxx-lz1
        type: LocalZone
      bucket: example--usw2-xxx-lz1--x-s3

Import

Identity Schema

Required

  • bucket (String) Name of the S3 Directory Bucket.

Optional

  • accountId (String) AWS Account where this resource is managed.
  • region (String) Region where this resource is managed.

Using pulumi import, import S3 bucket using bucket. For example:

$ pulumi import aws:s3/directoryBucket:DirectoryBucket example example--usw2-az1--x-s3

Constructors

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

Properties

arn ↔ Output<String>
ARN of the bucket.
latefinal
bucket ↔ Output<String>
Name of the bucket. The name must be in the format [bucketName]--[azid]--x-s3. Use the aws.s3.Bucket resource to manage general purpose buckets.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
dataRedundancy ↔ Output<String>
Data redundancy. Valid values: SingleAvailabilityZone, SingleLocalZone. The default value depends on the value of the location.type attribute.
latefinal
forceDestroy ↔ Output<bool>
Boolean that indicates all objects should be deleted from the bucket when the bucket is destroyed so that the bucket can be destroyed without error. These objects are not recoverable. This only deletes objects when the bucket is destroyed, not when setting this parameter to true. Once this parameter is set to true, there must be a successful pulumi up run before a destroy is required to update this value in the resource state. Without a successful pulumi up after this parameter is set, this flag will have no effect. If setting this field in the same operation that would require replacing the bucket or destroying the bucket, this flag will not work. Additionally when importing a bucket, a successful pulumi up is required to set this value in state before it will take effect on a destroy operation.
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
location ↔ Output<DirectoryBucketLocation>
Bucket location. See Location below for more details.
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
tags ↔ Output<Map<String, String>?>
Map of tags to assign to the bucket. 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
type ↔ Output<String>
Bucket type. Valid values: Directory.
latefinal
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, {DirectoryBucketState? state, CustomResourceOptions? options}) → DirectoryBucket
Gets an existing DirectoryBucket resource's state with the given name and id.