BucketRequestPaymentConfigurationV2 class

Provides an S3 bucket request payment configuration resource. For more information, see Requester Pays Buckets.

> NOTE: Destroying an aws.s3.BucketRequestPaymentConfiguration resource resets the bucket's payer to the S3 default: the bucket owner.

> This resource cannot be used with S3 directory buckets.

Example Usage

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

const example = new aws.s3.BucketRequestPaymentConfiguration("example", {
    bucket: exampleAwsS3Bucket.id,
    payer: "Requester",
});
import pulumi
import pulumi_aws as aws

example = aws.s3.BucketRequestPaymentConfiguration("example",
    bucket=example_aws_s3_bucket["id"],
    payer="Requester")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.S3.BucketRequestPaymentConfiguration("example", new()
    {
        Bucket = exampleAwsS3Bucket.Id,
        Payer = "Requester",
    });

});
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.NewBucketRequestPaymentConfiguration(ctx, "example", &s3.BucketRequestPaymentConfigurationArgs{
			Bucket: pulumi.Any(exampleAwsS3Bucket.Id),
			Payer:  pulumi.String("Requester"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_s3_bucketrequestpaymentconfiguration" "example" {
  bucket = exampleAwsS3Bucket.id
  payer  = "Requester"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3.BucketRequestPaymentConfiguration;
import com.pulumi.aws.s3.BucketRequestPaymentConfigurationArgs;
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 BucketRequestPaymentConfiguration("example", BucketRequestPaymentConfigurationArgs.builder()
            .bucket(exampleAwsS3Bucket.id())
            .payer("Requester")
            .build());

    }
}
resources:
  example:
    type: aws:s3:BucketRequestPaymentConfiguration
    properties:
      bucket: ${exampleAwsS3Bucket.id}
      payer: Requester

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 expectedBucketOwner separated by a comma (,):

Using pulumi import to import S3 bucket request payment configuration using the bucket or using the bucket and expectedBucketOwner separated by a comma (,). 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/bucketRequestPaymentConfigurationV2:BucketRequestPaymentConfigurationV2 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 expectedBucketOwner separated by a comma (,):

$ pulumi import aws:s3/bucketRequestPaymentConfigurationV2:BucketRequestPaymentConfigurationV2 example bucket-name,123456789012

Constructors

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

Properties

bucket ↔ Output<String>
Name of the bucket.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
expectedBucketOwner ↔ Output<String?>
Account ID of the expected bucket owner.
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
payer ↔ Output<String>
Who pays for the download and request fees. Valid values: BucketOwner, Requester.
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
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
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, {BucketRequestPaymentConfigurationV2State? state, CustomResourceOptions? options}) → BucketRequestPaymentConfigurationV2
Gets an existing BucketRequestPaymentConfigurationV2 resource's state with the given name and id.