1. Packages
  2. AWS Classic
  3. API Docs
  4. lightsail
  5. Bucket

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.44.0 published on Monday, Jul 8, 2024 by Pulumi

aws.lightsail.Bucket

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.44.0 published on Monday, Jul 8, 2024 by Pulumi

    Provides a lightsail bucket.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const test = new aws.lightsail.Bucket("test", {
        name: "mytestbucket",
        bundleId: "small_1_0",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    test = aws.lightsail.Bucket("test",
        name="mytestbucket",
        bundle_id="small_1_0")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/lightsail"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := lightsail.NewBucket(ctx, "test", &lightsail.BucketArgs{
    			Name:     pulumi.String("mytestbucket"),
    			BundleId: pulumi.String("small_1_0"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var test = new Aws.LightSail.Bucket("test", new()
        {
            Name = "mytestbucket",
            BundleId = "small_1_0",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.lightsail.Bucket;
    import com.pulumi.aws.lightsail.BucketArgs;
    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 test = new Bucket("test", BucketArgs.builder()
                .name("mytestbucket")
                .bundleId("small_1_0")
                .build());
    
        }
    }
    
    resources:
      test:
        type: aws:lightsail:Bucket
        properties:
          name: mytestbucket
          bundleId: small_1_0
    

    Create Bucket Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Bucket(name: string, args: BucketArgs, opts?: CustomResourceOptions);
    @overload
    def Bucket(resource_name: str,
               args: BucketArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Bucket(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               bundle_id: Optional[str] = None,
               force_delete: Optional[bool] = None,
               name: Optional[str] = None,
               tags: Optional[Mapping[str, str]] = None)
    func NewBucket(ctx *Context, name string, args BucketArgs, opts ...ResourceOption) (*Bucket, error)
    public Bucket(string name, BucketArgs args, CustomResourceOptions? opts = null)
    public Bucket(String name, BucketArgs args)
    public Bucket(String name, BucketArgs args, CustomResourceOptions options)
    
    type: aws:lightsail:Bucket
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

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

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var bucketResource = new Aws.LightSail.Bucket("bucketResource", new()
    {
        BundleId = "string",
        ForceDelete = false,
        Name = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := lightsail.NewBucket(ctx, "bucketResource", &lightsail.BucketArgs{
    	BundleId:    pulumi.String("string"),
    	ForceDelete: pulumi.Bool(false),
    	Name:        pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var bucketResource = new Bucket("bucketResource", BucketArgs.builder()
        .bundleId("string")
        .forceDelete(false)
        .name("string")
        .tags(Map.of("string", "string"))
        .build());
    
    bucket_resource = aws.lightsail.Bucket("bucketResource",
        bundle_id="string",
        force_delete=False,
        name="string",
        tags={
            "string": "string",
        })
    
    const bucketResource = new aws.lightsail.Bucket("bucketResource", {
        bundleId: "string",
        forceDelete: false,
        name: "string",
        tags: {
            string: "string",
        },
    });
    
    type: aws:lightsail:Bucket
    properties:
        bundleId: string
        forceDelete: false
        name: string
        tags:
            string: string
    

    Bucket 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 Bucket resource accepts the following input properties:

    BundleId string
    The ID of the bundle to use for the bucket. A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. Use the get-bucket-bundles cli command to get a list of bundle IDs that you can specify.
    ForceDelete bool
    Force Delete non-empty buckets using pulumi destroy. AWS by default will not delete an s3 bucket which is not empty, to prevent losing bucket data and affecting other resources in lightsail. If force_delete is set to true the bucket will be deleted even when not empty.
    Name string
    The name for the bucket.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. To create a key-only tag, use an empty string as the value. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    BundleId string
    The ID of the bundle to use for the bucket. A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. Use the get-bucket-bundles cli command to get a list of bundle IDs that you can specify.
    ForceDelete bool
    Force Delete non-empty buckets using pulumi destroy. AWS by default will not delete an s3 bucket which is not empty, to prevent losing bucket data and affecting other resources in lightsail. If force_delete is set to true the bucket will be deleted even when not empty.
    Name string
    The name for the bucket.
    Tags map[string]string
    A map of tags to assign to the resource. To create a key-only tag, use an empty string as the value. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    bundleId String
    The ID of the bundle to use for the bucket. A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. Use the get-bucket-bundles cli command to get a list of bundle IDs that you can specify.
    forceDelete Boolean
    Force Delete non-empty buckets using pulumi destroy. AWS by default will not delete an s3 bucket which is not empty, to prevent losing bucket data and affecting other resources in lightsail. If force_delete is set to true the bucket will be deleted even when not empty.
    name String
    The name for the bucket.
    tags Map<String,String>
    A map of tags to assign to the resource. To create a key-only tag, use an empty string as the value. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    bundleId string
    The ID of the bundle to use for the bucket. A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. Use the get-bucket-bundles cli command to get a list of bundle IDs that you can specify.
    forceDelete boolean
    Force Delete non-empty buckets using pulumi destroy. AWS by default will not delete an s3 bucket which is not empty, to prevent losing bucket data and affecting other resources in lightsail. If force_delete is set to true the bucket will be deleted even when not empty.
    name string
    The name for the bucket.
    tags {[key: string]: string}
    A map of tags to assign to the resource. To create a key-only tag, use an empty string as the value. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    bundle_id str
    The ID of the bundle to use for the bucket. A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. Use the get-bucket-bundles cli command to get a list of bundle IDs that you can specify.
    force_delete bool
    Force Delete non-empty buckets using pulumi destroy. AWS by default will not delete an s3 bucket which is not empty, to prevent losing bucket data and affecting other resources in lightsail. If force_delete is set to true the bucket will be deleted even when not empty.
    name str
    The name for the bucket.
    tags Mapping[str, str]
    A map of tags to assign to the resource. To create a key-only tag, use an empty string as the value. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    bundleId String
    The ID of the bundle to use for the bucket. A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. Use the get-bucket-bundles cli command to get a list of bundle IDs that you can specify.
    forceDelete Boolean
    Force Delete non-empty buckets using pulumi destroy. AWS by default will not delete an s3 bucket which is not empty, to prevent losing bucket data and affecting other resources in lightsail. If force_delete is set to true the bucket will be deleted even when not empty.
    name String
    The name for the bucket.
    tags Map<String>
    A map of tags to assign to the resource. To create a key-only tag, use an empty string as the value. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string
    The ARN of the lightsail bucket.
    AvailabilityZone string
    The resource Availability Zone. Follows the format us-east-2a (case-sensitive).
    CreatedAt string
    The timestamp when the bucket was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Region string
    The Amazon Web Services Region name.
    SupportCode string
    The support code for the resource. Include this code in your email to support when you have questions about a resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Url string
    Arn string
    The ARN of the lightsail bucket.
    AvailabilityZone string
    The resource Availability Zone. Follows the format us-east-2a (case-sensitive).
    CreatedAt string
    The timestamp when the bucket was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Region string
    The Amazon Web Services Region name.
    SupportCode string
    The support code for the resource. Include this code in your email to support when you have questions about a resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Url string
    arn String
    The ARN of the lightsail bucket.
    availabilityZone String
    The resource Availability Zone. Follows the format us-east-2a (case-sensitive).
    createdAt String
    The timestamp when the bucket was created.
    id String
    The provider-assigned unique ID for this managed resource.
    region String
    The Amazon Web Services Region name.
    supportCode String
    The support code for the resource. Include this code in your email to support when you have questions about a resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    url String
    arn string
    The ARN of the lightsail bucket.
    availabilityZone string
    The resource Availability Zone. Follows the format us-east-2a (case-sensitive).
    createdAt string
    The timestamp when the bucket was created.
    id string
    The provider-assigned unique ID for this managed resource.
    region string
    The Amazon Web Services Region name.
    supportCode string
    The support code for the resource. Include this code in your email to support when you have questions about a resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    url string
    arn str
    The ARN of the lightsail bucket.
    availability_zone str
    The resource Availability Zone. Follows the format us-east-2a (case-sensitive).
    created_at str
    The timestamp when the bucket was created.
    id str
    The provider-assigned unique ID for this managed resource.
    region str
    The Amazon Web Services Region name.
    support_code str
    The support code for the resource. Include this code in your email to support when you have questions about a resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    url str
    arn String
    The ARN of the lightsail bucket.
    availabilityZone String
    The resource Availability Zone. Follows the format us-east-2a (case-sensitive).
    createdAt String
    The timestamp when the bucket was created.
    id String
    The provider-assigned unique ID for this managed resource.
    region String
    The Amazon Web Services Region name.
    supportCode String
    The support code for the resource. Include this code in your email to support when you have questions about a resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    url String

    Look up Existing Bucket Resource

    Get an existing Bucket 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?: BucketState, opts?: CustomResourceOptions): Bucket
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            availability_zone: Optional[str] = None,
            bundle_id: Optional[str] = None,
            created_at: Optional[str] = None,
            force_delete: Optional[bool] = None,
            name: Optional[str] = None,
            region: Optional[str] = None,
            support_code: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            url: Optional[str] = None) -> Bucket
    func GetBucket(ctx *Context, name string, id IDInput, state *BucketState, opts ...ResourceOption) (*Bucket, error)
    public static Bucket Get(string name, Input<string> id, BucketState? state, CustomResourceOptions? opts = null)
    public static Bucket get(String name, Output<String> id, BucketState 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:
    Arn string
    The ARN of the lightsail bucket.
    AvailabilityZone string
    The resource Availability Zone. Follows the format us-east-2a (case-sensitive).
    BundleId string
    The ID of the bundle to use for the bucket. A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. Use the get-bucket-bundles cli command to get a list of bundle IDs that you can specify.
    CreatedAt string
    The timestamp when the bucket was created.
    ForceDelete bool
    Force Delete non-empty buckets using pulumi destroy. AWS by default will not delete an s3 bucket which is not empty, to prevent losing bucket data and affecting other resources in lightsail. If force_delete is set to true the bucket will be deleted even when not empty.
    Name string
    The name for the bucket.
    Region string
    The Amazon Web Services Region name.
    SupportCode string
    The support code for the resource. Include this code in your email to support when you have questions about a resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. To create a key-only tag, use an empty string as the value. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Url string
    Arn string
    The ARN of the lightsail bucket.
    AvailabilityZone string
    The resource Availability Zone. Follows the format us-east-2a (case-sensitive).
    BundleId string
    The ID of the bundle to use for the bucket. A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. Use the get-bucket-bundles cli command to get a list of bundle IDs that you can specify.
    CreatedAt string
    The timestamp when the bucket was created.
    ForceDelete bool
    Force Delete non-empty buckets using pulumi destroy. AWS by default will not delete an s3 bucket which is not empty, to prevent losing bucket data and affecting other resources in lightsail. If force_delete is set to true the bucket will be deleted even when not empty.
    Name string
    The name for the bucket.
    Region string
    The Amazon Web Services Region name.
    SupportCode string
    The support code for the resource. Include this code in your email to support when you have questions about a resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
    Tags map[string]string
    A map of tags to assign to the resource. To create a key-only tag, use an empty string as the value. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Url string
    arn String
    The ARN of the lightsail bucket.
    availabilityZone String
    The resource Availability Zone. Follows the format us-east-2a (case-sensitive).
    bundleId String
    The ID of the bundle to use for the bucket. A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. Use the get-bucket-bundles cli command to get a list of bundle IDs that you can specify.
    createdAt String
    The timestamp when the bucket was created.
    forceDelete Boolean
    Force Delete non-empty buckets using pulumi destroy. AWS by default will not delete an s3 bucket which is not empty, to prevent losing bucket data and affecting other resources in lightsail. If force_delete is set to true the bucket will be deleted even when not empty.
    name String
    The name for the bucket.
    region String
    The Amazon Web Services Region name.
    supportCode String
    The support code for the resource. Include this code in your email to support when you have questions about a resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
    tags Map<String,String>
    A map of tags to assign to the resource. To create a key-only tag, use an empty string as the value. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    url String
    arn string
    The ARN of the lightsail bucket.
    availabilityZone string
    The resource Availability Zone. Follows the format us-east-2a (case-sensitive).
    bundleId string
    The ID of the bundle to use for the bucket. A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. Use the get-bucket-bundles cli command to get a list of bundle IDs that you can specify.
    createdAt string
    The timestamp when the bucket was created.
    forceDelete boolean
    Force Delete non-empty buckets using pulumi destroy. AWS by default will not delete an s3 bucket which is not empty, to prevent losing bucket data and affecting other resources in lightsail. If force_delete is set to true the bucket will be deleted even when not empty.
    name string
    The name for the bucket.
    region string
    The Amazon Web Services Region name.
    supportCode string
    The support code for the resource. Include this code in your email to support when you have questions about a resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
    tags {[key: string]: string}
    A map of tags to assign to the resource. To create a key-only tag, use an empty string as the value. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    url string
    arn str
    The ARN of the lightsail bucket.
    availability_zone str
    The resource Availability Zone. Follows the format us-east-2a (case-sensitive).
    bundle_id str
    The ID of the bundle to use for the bucket. A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. Use the get-bucket-bundles cli command to get a list of bundle IDs that you can specify.
    created_at str
    The timestamp when the bucket was created.
    force_delete bool
    Force Delete non-empty buckets using pulumi destroy. AWS by default will not delete an s3 bucket which is not empty, to prevent losing bucket data and affecting other resources in lightsail. If force_delete is set to true the bucket will be deleted even when not empty.
    name str
    The name for the bucket.
    region str
    The Amazon Web Services Region name.
    support_code str
    The support code for the resource. Include this code in your email to support when you have questions about a resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
    tags Mapping[str, str]
    A map of tags to assign to the resource. To create a key-only tag, use an empty string as the value. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    url str
    arn String
    The ARN of the lightsail bucket.
    availabilityZone String
    The resource Availability Zone. Follows the format us-east-2a (case-sensitive).
    bundleId String
    The ID of the bundle to use for the bucket. A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. Use the get-bucket-bundles cli command to get a list of bundle IDs that you can specify.
    createdAt String
    The timestamp when the bucket was created.
    forceDelete Boolean
    Force Delete non-empty buckets using pulumi destroy. AWS by default will not delete an s3 bucket which is not empty, to prevent losing bucket data and affecting other resources in lightsail. If force_delete is set to true the bucket will be deleted even when not empty.
    name String
    The name for the bucket.
    region String
    The Amazon Web Services Region name.
    supportCode String
    The support code for the resource. Include this code in your email to support when you have questions about a resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
    tags Map<String>
    A map of tags to assign to the resource. To create a key-only tag, use an empty string as the value. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    url String

    Import

    Using pulumi import, import aws_lightsail_bucket using the name attribute. For example:

    $ pulumi import aws:lightsail/bucket:Bucket test example-bucket
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.44.0 published on Monday, Jul 8, 2024 by Pulumi