1. Packages
  2. AWS Classic
  3. API Docs
  4. s3
  5. BucketAccelerateConfigurationV2

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

AWS Classic v6.31.0 published on Monday, Apr 15, 2024 by Pulumi

aws.s3.BucketAccelerateConfigurationV2

Explore with Pulumi AI

aws logo

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

AWS Classic v6.31.0 published on Monday, Apr 15, 2024 by Pulumi

    Provides an S3 bucket accelerate configuration resource. See the Requirements for using Transfer Acceleration for more details.

    This resource cannot be used with S3 directory buckets.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const mybucket = new aws.s3.BucketV2("mybucket", {bucket: "mybucket"});
    const example = new aws.s3.BucketAccelerateConfigurationV2("example", {
        bucket: mybucket.id,
        status: "Enabled",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    mybucket = aws.s3.BucketV2("mybucket", bucket="mybucket")
    example = aws.s3.BucketAccelerateConfigurationV2("example",
        bucket=mybucket.id,
        status="Enabled")
    
    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 {
    		mybucket, err := s3.NewBucketV2(ctx, "mybucket", &s3.BucketV2Args{
    			Bucket: pulumi.String("mybucket"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = s3.NewBucketAccelerateConfigurationV2(ctx, "example", &s3.BucketAccelerateConfigurationV2Args{
    			Bucket: mybucket.ID(),
    			Status: pulumi.String("Enabled"),
    		})
    		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 mybucket = new Aws.S3.BucketV2("mybucket", new()
        {
            Bucket = "mybucket",
        });
    
        var example = new Aws.S3.BucketAccelerateConfigurationV2("example", new()
        {
            Bucket = mybucket.Id,
            Status = "Enabled",
        });
    
    });
    
    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.BucketAccelerateConfigurationV2;
    import com.pulumi.aws.s3.BucketAccelerateConfigurationV2Args;
    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 mybucket = new BucketV2("mybucket", BucketV2Args.builder()        
                .bucket("mybucket")
                .build());
    
            var example = new BucketAccelerateConfigurationV2("example", BucketAccelerateConfigurationV2Args.builder()        
                .bucket(mybucket.id())
                .status("Enabled")
                .build());
    
        }
    }
    
    resources:
      mybucket:
        type: aws:s3:BucketV2
        properties:
          bucket: mybucket
      example:
        type: aws:s3:BucketAccelerateConfigurationV2
        properties:
          bucket: ${mybucket.id}
          status: Enabled
    

    Create BucketAccelerateConfigurationV2 Resource

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

    Constructor syntax

    new BucketAccelerateConfigurationV2(name: string, args: BucketAccelerateConfigurationV2Args, opts?: CustomResourceOptions);
    @overload
    def BucketAccelerateConfigurationV2(resource_name: str,
                                        args: BucketAccelerateConfigurationV2Args,
                                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def BucketAccelerateConfigurationV2(resource_name: str,
                                        opts: Optional[ResourceOptions] = None,
                                        bucket: Optional[str] = None,
                                        status: Optional[str] = None,
                                        expected_bucket_owner: Optional[str] = None)
    func NewBucketAccelerateConfigurationV2(ctx *Context, name string, args BucketAccelerateConfigurationV2Args, opts ...ResourceOption) (*BucketAccelerateConfigurationV2, error)
    public BucketAccelerateConfigurationV2(string name, BucketAccelerateConfigurationV2Args args, CustomResourceOptions? opts = null)
    public BucketAccelerateConfigurationV2(String name, BucketAccelerateConfigurationV2Args args)
    public BucketAccelerateConfigurationV2(String name, BucketAccelerateConfigurationV2Args args, CustomResourceOptions options)
    
    type: aws:s3:BucketAccelerateConfigurationV2
    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 BucketAccelerateConfigurationV2Args
    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 BucketAccelerateConfigurationV2Args
    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 BucketAccelerateConfigurationV2Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BucketAccelerateConfigurationV2Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BucketAccelerateConfigurationV2Args
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var bucketAccelerateConfigurationV2Resource = new Aws.S3.BucketAccelerateConfigurationV2("bucketAccelerateConfigurationV2Resource", new()
    {
        Bucket = "string",
        Status = "string",
        ExpectedBucketOwner = "string",
    });
    
    example, err := s3.NewBucketAccelerateConfigurationV2(ctx, "bucketAccelerateConfigurationV2Resource", &s3.BucketAccelerateConfigurationV2Args{
    	Bucket:              pulumi.String("string"),
    	Status:              pulumi.String("string"),
    	ExpectedBucketOwner: pulumi.String("string"),
    })
    
    var bucketAccelerateConfigurationV2Resource = new BucketAccelerateConfigurationV2("bucketAccelerateConfigurationV2Resource", BucketAccelerateConfigurationV2Args.builder()        
        .bucket("string")
        .status("string")
        .expectedBucketOwner("string")
        .build());
    
    bucket_accelerate_configuration_v2_resource = aws.s3.BucketAccelerateConfigurationV2("bucketAccelerateConfigurationV2Resource",
        bucket="string",
        status="string",
        expected_bucket_owner="string")
    
    const bucketAccelerateConfigurationV2Resource = new aws.s3.BucketAccelerateConfigurationV2("bucketAccelerateConfigurationV2Resource", {
        bucket: "string",
        status: "string",
        expectedBucketOwner: "string",
    });
    
    type: aws:s3:BucketAccelerateConfigurationV2
    properties:
        bucket: string
        expectedBucketOwner: string
        status: string
    

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

    Bucket string
    Name of the bucket.
    Status string
    Transfer acceleration state of the bucket. Valid values: Enabled, Suspended.
    ExpectedBucketOwner string
    Account ID of the expected bucket owner.
    Bucket string
    Name of the bucket.
    Status string
    Transfer acceleration state of the bucket. Valid values: Enabled, Suspended.
    ExpectedBucketOwner string
    Account ID of the expected bucket owner.
    bucket String
    Name of the bucket.
    status String
    Transfer acceleration state of the bucket. Valid values: Enabled, Suspended.
    expectedBucketOwner String
    Account ID of the expected bucket owner.
    bucket string
    Name of the bucket.
    status string
    Transfer acceleration state of the bucket. Valid values: Enabled, Suspended.
    expectedBucketOwner string
    Account ID of the expected bucket owner.
    bucket str
    Name of the bucket.
    status str
    Transfer acceleration state of the bucket. Valid values: Enabled, Suspended.
    expected_bucket_owner str
    Account ID of the expected bucket owner.
    bucket String
    Name of the bucket.
    status String
    Transfer acceleration state of the bucket. Valid values: Enabled, Suspended.
    expectedBucketOwner String
    Account ID of the expected bucket owner.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the BucketAccelerateConfigurationV2 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 Existing BucketAccelerateConfigurationV2 Resource

    Get an existing BucketAccelerateConfigurationV2 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?: BucketAccelerateConfigurationV2State, opts?: CustomResourceOptions): BucketAccelerateConfigurationV2
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            bucket: Optional[str] = None,
            expected_bucket_owner: Optional[str] = None,
            status: Optional[str] = None) -> BucketAccelerateConfigurationV2
    func GetBucketAccelerateConfigurationV2(ctx *Context, name string, id IDInput, state *BucketAccelerateConfigurationV2State, opts ...ResourceOption) (*BucketAccelerateConfigurationV2, error)
    public static BucketAccelerateConfigurationV2 Get(string name, Input<string> id, BucketAccelerateConfigurationV2State? state, CustomResourceOptions? opts = null)
    public static BucketAccelerateConfigurationV2 get(String name, Output<String> id, BucketAccelerateConfigurationV2State 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
    Name of the bucket.
    ExpectedBucketOwner string
    Account ID of the expected bucket owner.
    Status string
    Transfer acceleration state of the bucket. Valid values: Enabled, Suspended.
    Bucket string
    Name of the bucket.
    ExpectedBucketOwner string
    Account ID of the expected bucket owner.
    Status string
    Transfer acceleration state of the bucket. Valid values: Enabled, Suspended.
    bucket String
    Name of the bucket.
    expectedBucketOwner String
    Account ID of the expected bucket owner.
    status String
    Transfer acceleration state of the bucket. Valid values: Enabled, Suspended.
    bucket string
    Name of the bucket.
    expectedBucketOwner string
    Account ID of the expected bucket owner.
    status string
    Transfer acceleration state of the bucket. Valid values: Enabled, Suspended.
    bucket str
    Name of the bucket.
    expected_bucket_owner str
    Account ID of the expected bucket owner.
    status str
    Transfer acceleration state of the bucket. Valid values: Enabled, Suspended.
    bucket String
    Name of the bucket.
    expectedBucketOwner String
    Account ID of the expected bucket owner.
    status String
    Transfer acceleration state of the bucket. Valid values: Enabled, Suspended.

    Import

    If the owner (account ID) of the source bucket differs from the account used to configure the AWS Provider, import using the bucket and expected_bucket_owner separated by a comma (,):

    Using pulumi import to import. For example:

    If the owner (account ID) of the source bucket is the same account used to configure the AWS Provider, import using the bucket:

    $ pulumi import aws:s3/bucketAccelerateConfigurationV2:BucketAccelerateConfigurationV2 example bucket-name
    

    If the owner (account ID) of the source bucket differs from the account used to configure the AWS Provider, import using the bucket and expected_bucket_owner separated by a comma (,):

    $ pulumi import aws:s3/bucketAccelerateConfigurationV2:BucketAccelerateConfigurationV2 example bucket-name,123456789012
    

    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.31.0 published on Monday, Apr 15, 2024 by Pulumi