@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
115 lines • 5.25 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.BucketCorsConfiguration = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Provides an S3 bucket CORS configuration resource. For more information about CORS, go to [Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/userguide/cors.html) in the Amazon S3 User Guide.
*
* > **NOTE:** S3 Buckets only support a single CORS configuration. Declaring multiple `aws.s3.BucketCorsConfiguration` resources to the same S3 Bucket will cause a perpetual difference in configuration.
*
* > This resource cannot be used with S3 directory buckets.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.s3.Bucket("example", {bucket: "mybucket"});
* const exampleBucketCorsConfiguration = new aws.s3.BucketCorsConfiguration("example", {
* bucket: example.id,
* corsRules: [
* {
* allowedHeaders: ["*"],
* allowedMethods: [
* "PUT",
* "POST",
* ],
* allowedOrigins: ["https://s3-website-test.domain.example"],
* exposeHeaders: ["ETag"],
* maxAgeSeconds: 3000,
* },
* {
* allowedMethods: ["GET"],
* allowedOrigins: ["*"],
* },
* ],
* });
* ```
*
* ## 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__ S3 bucket CORS configuration using the `bucket` or using the `bucket` and `expected_bucket_owner` 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`:
*
* ```sh
* $ pulumi import aws:s3/bucketCorsConfiguration:BucketCorsConfiguration 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 (`,`):
*
* ```sh
* $ pulumi import aws:s3/bucketCorsConfiguration:BucketCorsConfiguration example bucket-name,123456789012
* ```
*/
class BucketCorsConfiguration extends pulumi.CustomResource {
/**
* Get an existing BucketCorsConfiguration resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name, id, state, opts) {
return new BucketCorsConfiguration(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of BucketCorsConfiguration. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === BucketCorsConfiguration.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["bucket"] = state?.bucket;
resourceInputs["corsRules"] = state?.corsRules;
resourceInputs["expectedBucketOwner"] = state?.expectedBucketOwner;
resourceInputs["region"] = state?.region;
}
else {
const args = argsOrState;
if (args?.bucket === undefined && !opts.urn) {
throw new Error("Missing required property 'bucket'");
}
if (args?.corsRules === undefined && !opts.urn) {
throw new Error("Missing required property 'corsRules'");
}
resourceInputs["bucket"] = args?.bucket;
resourceInputs["corsRules"] = args?.corsRules;
resourceInputs["expectedBucketOwner"] = args?.expectedBucketOwner;
resourceInputs["region"] = args?.region;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const aliasOpts = { aliases: [{ type: "aws:s3/bucketCorsConfigurationV2:BucketCorsConfigurationV2" }] };
opts = pulumi.mergeOptions(opts, aliasOpts);
super(BucketCorsConfiguration.__pulumiType, name, resourceInputs, opts);
}
}
exports.BucketCorsConfiguration = BucketCorsConfiguration;
/** @internal */
BucketCorsConfiguration.__pulumiType = 'aws:s3/bucketCorsConfiguration:BucketCorsConfiguration';
//# sourceMappingURL=bucketCorsConfiguration.js.map