@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
164 lines (163 loc) • 6.51 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* 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
*
* ### Identity Schema
*
* #### Required
*
* * `bucket` (String) S3 bucket name.
*
* #### Optional
*
* * `account_id` (String) AWS Account where this resource is managed.
*
* * `expected_bucket_owner` (String) Account ID of the expected bucket owner.
*
* * `region` (String) Region where this resource is managed.
*
* 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 (`,`):
*
* terraform
*
* import {
*
* to = aws_s3_bucket_cors_configuration.example
*
* id = "bucket-name,123456789012"
*
* }
*
* **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`:
*
* console
*
* % pulumi import aws_s3_bucket_cors_configuration.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 (`,`):
*
* console
*
* % pulumi import aws_s3_bucket_cors_configuration.example bucket-name,123456789012
*/
export declare 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: string, id: pulumi.Input<pulumi.ID>, state?: BucketCorsConfigurationState, opts?: pulumi.CustomResourceOptions): BucketCorsConfiguration;
/**
* 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: any): obj is BucketCorsConfiguration;
/**
* Name of the bucket.
*/
readonly bucket: pulumi.Output<string>;
/**
* Set of origins and methods (cross-origin access that you want to allow). See below. You can configure up to 100 rules.
*/
readonly corsRules: pulumi.Output<outputs.s3.BucketCorsConfigurationCorsRule[]>;
/**
* Account ID of the expected bucket owner.
*/
readonly expectedBucketOwner: pulumi.Output<string | undefined>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* Create a BucketCorsConfiguration resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: BucketCorsConfigurationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering BucketCorsConfiguration resources.
*/
export interface BucketCorsConfigurationState {
/**
* Name of the bucket.
*/
bucket?: pulumi.Input<string>;
/**
* Set of origins and methods (cross-origin access that you want to allow). See below. You can configure up to 100 rules.
*/
corsRules?: pulumi.Input<pulumi.Input<inputs.s3.BucketCorsConfigurationCorsRule>[]>;
/**
* Account ID of the expected bucket owner.
*/
expectedBucketOwner?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a BucketCorsConfiguration resource.
*/
export interface BucketCorsConfigurationArgs {
/**
* Name of the bucket.
*/
bucket: pulumi.Input<string>;
/**
* Set of origins and methods (cross-origin access that you want to allow). See below. You can configure up to 100 rules.
*/
corsRules: pulumi.Input<pulumi.Input<inputs.s3.BucketCorsConfigurationCorsRule>[]>;
/**
* Account ID of the expected bucket owner.
*/
expectedBucketOwner?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
}