Provides a OSS Bucket Response Header resource.
Response header configuration of a bucket.
For information about OSS Bucket Response Header and how to use it, see What is Bucket Response Header.
NOTE: Available since v1.271.0.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const config = new pulumi.Config();
const name = config.get("name") || "terraform-example";
const defaultrdrM3m = new alicloud.oss.Bucket("defaultrdrM3m", {storageClass: "Standard"});
const _default = new alicloud.oss.BucketOverwriteConfig("default", {
bucket: defaultrdrM3m.id,
rules: [
{
id: "rule1",
action: "forbid",
prefix: "rule1-prefix/",
suffix: "rule1-suffix/",
principals: {
principals: [
"a",
"b",
"c",
],
},
},
{
id: "rule2",
action: "forbid",
prefix: "rule2-prefix/",
suffix: "rule2-suffix/",
principals: {
principals: [
"d",
"e",
"f",
],
},
},
{
id: "rule3",
action: "forbid",
prefix: "rule3-prefix/",
suffix: "rule3-suffix/",
principals: {
principals: [
"1",
"2",
"3",
],
},
},
],
});
import pulumi
import pulumi_alicloud as alicloud
config = pulumi.Config()
name = config.get("name")
if name is None:
name = "terraform-example"
defaultrdr_m3m = alicloud.oss.Bucket("defaultrdrM3m", storage_class="Standard")
default = alicloud.oss.BucketOverwriteConfig("default",
bucket=defaultrdr_m3m.id,
rules=[
{
"id": "rule1",
"action": "forbid",
"prefix": "rule1-prefix/",
"suffix": "rule1-suffix/",
"principals": {
"principals": [
"a",
"b",
"c",
],
},
},
{
"id": "rule2",
"action": "forbid",
"prefix": "rule2-prefix/",
"suffix": "rule2-suffix/",
"principals": {
"principals": [
"d",
"e",
"f",
],
},
},
{
"id": "rule3",
"action": "forbid",
"prefix": "rule3-prefix/",
"suffix": "rule3-suffix/",
"principals": {
"principals": [
"1",
"2",
"3",
],
},
},
])
package main
import (
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/oss"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
cfg := config.New(ctx, "")
name := "terraform-example"
if param := cfg.Get("name"); param != "" {
name = param
}
defaultrdrM3m, err := oss.NewBucket(ctx, "defaultrdrM3m", &oss.BucketArgs{
StorageClass: pulumi.String("Standard"),
})
if err != nil {
return err
}
_, err = oss.NewBucketOverwriteConfig(ctx, "default", &oss.BucketOverwriteConfigArgs{
Bucket: defaultrdrM3m.ID(),
Rules: oss.BucketOverwriteConfigRuleArray{
&oss.BucketOverwriteConfigRuleArgs{
Id: pulumi.String("rule1"),
Action: pulumi.String("forbid"),
Prefix: pulumi.String("rule1-prefix/"),
Suffix: pulumi.String("rule1-suffix/"),
Principals: &oss.BucketOverwriteConfigRulePrincipalsArgs{
Principals: pulumi.StringArray{
pulumi.String("a"),
pulumi.String("b"),
pulumi.String("c"),
},
},
},
&oss.BucketOverwriteConfigRuleArgs{
Id: pulumi.String("rule2"),
Action: pulumi.String("forbid"),
Prefix: pulumi.String("rule2-prefix/"),
Suffix: pulumi.String("rule2-suffix/"),
Principals: &oss.BucketOverwriteConfigRulePrincipalsArgs{
Principals: pulumi.StringArray{
pulumi.String("d"),
pulumi.String("e"),
pulumi.String("f"),
},
},
},
&oss.BucketOverwriteConfigRuleArgs{
Id: pulumi.String("rule3"),
Action: pulumi.String("forbid"),
Prefix: pulumi.String("rule3-prefix/"),
Suffix: pulumi.String("rule3-suffix/"),
Principals: &oss.BucketOverwriteConfigRulePrincipalsArgs{
Principals: pulumi.StringArray{
pulumi.String("1"),
pulumi.String("2"),
pulumi.String("3"),
},
},
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var name = config.Get("name") ?? "terraform-example";
var defaultrdrM3m = new AliCloud.Oss.Bucket("defaultrdrM3m", new()
{
StorageClass = "Standard",
});
var @default = new AliCloud.Oss.BucketOverwriteConfig("default", new()
{
Bucket = defaultrdrM3m.Id,
Rules = new[]
{
new AliCloud.Oss.Inputs.BucketOverwriteConfigRuleArgs
{
Id = "rule1",
Action = "forbid",
Prefix = "rule1-prefix/",
Suffix = "rule1-suffix/",
Principals = new AliCloud.Oss.Inputs.BucketOverwriteConfigRulePrincipalsArgs
{
Principals = new[]
{
"a",
"b",
"c",
},
},
},
new AliCloud.Oss.Inputs.BucketOverwriteConfigRuleArgs
{
Id = "rule2",
Action = "forbid",
Prefix = "rule2-prefix/",
Suffix = "rule2-suffix/",
Principals = new AliCloud.Oss.Inputs.BucketOverwriteConfigRulePrincipalsArgs
{
Principals = new[]
{
"d",
"e",
"f",
},
},
},
new AliCloud.Oss.Inputs.BucketOverwriteConfigRuleArgs
{
Id = "rule3",
Action = "forbid",
Prefix = "rule3-prefix/",
Suffix = "rule3-suffix/",
Principals = new AliCloud.Oss.Inputs.BucketOverwriteConfigRulePrincipalsArgs
{
Principals = new[]
{
"1",
"2",
"3",
},
},
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.oss.Bucket;
import com.pulumi.alicloud.oss.BucketArgs;
import com.pulumi.alicloud.oss.BucketOverwriteConfig;
import com.pulumi.alicloud.oss.BucketOverwriteConfigArgs;
import com.pulumi.alicloud.oss.inputs.BucketOverwriteConfigRuleArgs;
import com.pulumi.alicloud.oss.inputs.BucketOverwriteConfigRulePrincipalsArgs;
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) {
final var config = ctx.config();
final var name = config.get("name").orElse("terraform-example");
var defaultrdrM3m = new Bucket("defaultrdrM3m", BucketArgs.builder()
.storageClass("Standard")
.build());
var default_ = new BucketOverwriteConfig("default", BucketOverwriteConfigArgs.builder()
.bucket(defaultrdrM3m.id())
.rules(
BucketOverwriteConfigRuleArgs.builder()
.id("rule1")
.action("forbid")
.prefix("rule1-prefix/")
.suffix("rule1-suffix/")
.principals(BucketOverwriteConfigRulePrincipalsArgs.builder()
.principals(
"a",
"b",
"c")
.build())
.build(),
BucketOverwriteConfigRuleArgs.builder()
.id("rule2")
.action("forbid")
.prefix("rule2-prefix/")
.suffix("rule2-suffix/")
.principals(BucketOverwriteConfigRulePrincipalsArgs.builder()
.principals(
"d",
"e",
"f")
.build())
.build(),
BucketOverwriteConfigRuleArgs.builder()
.id("rule3")
.action("forbid")
.prefix("rule3-prefix/")
.suffix("rule3-suffix/")
.principals(BucketOverwriteConfigRulePrincipalsArgs.builder()
.principals(
"1",
"2",
"3")
.build())
.build())
.build());
}
}
configuration:
name:
type: string
default: terraform-example
resources:
defaultrdrM3m:
type: alicloud:oss:Bucket
properties:
storageClass: Standard
default:
type: alicloud:oss:BucketOverwriteConfig
properties:
bucket: ${defaultrdrM3m.id}
rules:
- id: rule1
action: forbid
prefix: rule1-prefix/
suffix: rule1-suffix/
principals:
principals:
- a
- b
- c
- id: rule2
action: forbid
prefix: rule2-prefix/
suffix: rule2-suffix/
principals:
principals:
- d
- e
- f
- id: rule3
action: forbid
prefix: rule3-prefix/
suffix: rule3-suffix/
principals:
principals:
- '1'
- '2'
- '3'
📚 Need more examples? VIEW MORE EXAMPLES
Create BucketResponseHeader Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new BucketResponseHeader(name: string, args: BucketResponseHeaderArgs, opts?: CustomResourceOptions);@overload
def BucketResponseHeader(resource_name: str,
args: BucketResponseHeaderArgs,
opts: Optional[ResourceOptions] = None)
@overload
def BucketResponseHeader(resource_name: str,
opts: Optional[ResourceOptions] = None,
bucket: Optional[str] = None,
rules: Optional[Sequence[BucketResponseHeaderRuleArgs]] = None)func NewBucketResponseHeader(ctx *Context, name string, args BucketResponseHeaderArgs, opts ...ResourceOption) (*BucketResponseHeader, error)public BucketResponseHeader(string name, BucketResponseHeaderArgs args, CustomResourceOptions? opts = null)
public BucketResponseHeader(String name, BucketResponseHeaderArgs args)
public BucketResponseHeader(String name, BucketResponseHeaderArgs args, CustomResourceOptions options)
type: alicloud:oss:BucketResponseHeader
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 BucketResponseHeaderArgs
- 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 BucketResponseHeaderArgs
- 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 BucketResponseHeaderArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BucketResponseHeaderArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args BucketResponseHeaderArgs
- 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 bucketResponseHeaderResource = new AliCloud.Oss.BucketResponseHeader("bucketResponseHeaderResource", new()
{
Bucket = "string",
Rules = new[]
{
new AliCloud.Oss.Inputs.BucketResponseHeaderRuleArgs
{
Filters = new AliCloud.Oss.Inputs.BucketResponseHeaderRuleFiltersArgs
{
Operations = new[]
{
"string",
},
},
HideHeaders = new AliCloud.Oss.Inputs.BucketResponseHeaderRuleHideHeadersArgs
{
Headers = new[]
{
"string",
},
},
Name = "string",
},
},
});
example, err := oss.NewBucketResponseHeader(ctx, "bucketResponseHeaderResource", &oss.BucketResponseHeaderArgs{
Bucket: pulumi.String("string"),
Rules: oss.BucketResponseHeaderRuleArray{
&oss.BucketResponseHeaderRuleArgs{
Filters: &oss.BucketResponseHeaderRuleFiltersArgs{
Operations: pulumi.StringArray{
pulumi.String("string"),
},
},
HideHeaders: &oss.BucketResponseHeaderRuleHideHeadersArgs{
Headers: pulumi.StringArray{
pulumi.String("string"),
},
},
Name: pulumi.String("string"),
},
},
})
var bucketResponseHeaderResource = new BucketResponseHeader("bucketResponseHeaderResource", BucketResponseHeaderArgs.builder()
.bucket("string")
.rules(BucketResponseHeaderRuleArgs.builder()
.filters(BucketResponseHeaderRuleFiltersArgs.builder()
.operations("string")
.build())
.hideHeaders(BucketResponseHeaderRuleHideHeadersArgs.builder()
.headers("string")
.build())
.name("string")
.build())
.build());
bucket_response_header_resource = alicloud.oss.BucketResponseHeader("bucketResponseHeaderResource",
bucket="string",
rules=[{
"filters": {
"operations": ["string"],
},
"hide_headers": {
"headers": ["string"],
},
"name": "string",
}])
const bucketResponseHeaderResource = new alicloud.oss.BucketResponseHeader("bucketResponseHeaderResource", {
bucket: "string",
rules: [{
filters: {
operations: ["string"],
},
hideHeaders: {
headers: ["string"],
},
name: "string",
}],
});
type: alicloud:oss:BucketResponseHeader
properties:
bucket: string
rules:
- filters:
operations:
- string
hideHeaders:
headers:
- string
name: string
BucketResponseHeader Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The BucketResponseHeader resource accepts the following input properties:
- Bucket string
- The name of the bucket
- Rules
List<Pulumi.
Ali Cloud. Oss. Inputs. Bucket Response Header Rule> - The container that holds the response header rules. See
rulebelow.
- Bucket string
- The name of the bucket
- Rules
[]Bucket
Response Header Rule Args - The container that holds the response header rules. See
rulebelow.
- bucket String
- The name of the bucket
- rules
List<Bucket
Response Header Rule> - The container that holds the response header rules. See
rulebelow.
- bucket string
- The name of the bucket
- rules
Bucket
Response Header Rule[] - The container that holds the response header rules. See
rulebelow.
- bucket str
- The name of the bucket
- rules
Sequence[Bucket
Response Header Rule Args] - The container that holds the response header rules. See
rulebelow.
- bucket String
- The name of the bucket
- rules List<Property Map>
- The container that holds the response header rules. See
rulebelow.
Outputs
All input properties are implicitly available as output properties. Additionally, the BucketResponseHeader 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 BucketResponseHeader Resource
Get an existing BucketResponseHeader 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?: BucketResponseHeaderState, opts?: CustomResourceOptions): BucketResponseHeader@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
bucket: Optional[str] = None,
rules: Optional[Sequence[BucketResponseHeaderRuleArgs]] = None) -> BucketResponseHeaderfunc GetBucketResponseHeader(ctx *Context, name string, id IDInput, state *BucketResponseHeaderState, opts ...ResourceOption) (*BucketResponseHeader, error)public static BucketResponseHeader Get(string name, Input<string> id, BucketResponseHeaderState? state, CustomResourceOptions? opts = null)public static BucketResponseHeader get(String name, Output<String> id, BucketResponseHeaderState state, CustomResourceOptions options)resources: _: type: alicloud:oss:BucketResponseHeader get: id: ${id}- 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.
- Bucket string
- The name of the bucket
- Rules
List<Pulumi.
Ali Cloud. Oss. Inputs. Bucket Response Header Rule> - The container that holds the response header rules. See
rulebelow.
- Bucket string
- The name of the bucket
- Rules
[]Bucket
Response Header Rule Args - The container that holds the response header rules. See
rulebelow.
- bucket String
- The name of the bucket
- rules
List<Bucket
Response Header Rule> - The container that holds the response header rules. See
rulebelow.
- bucket string
- The name of the bucket
- rules
Bucket
Response Header Rule[] - The container that holds the response header rules. See
rulebelow.
- bucket str
- The name of the bucket
- rules
Sequence[Bucket
Response Header Rule Args] - The container that holds the response header rules. See
rulebelow.
- bucket String
- The name of the bucket
- rules List<Property Map>
- The container that holds the response header rules. See
rulebelow.
Supporting Types
BucketResponseHeaderRule, BucketResponseHeaderRuleArgs
- Filters
Pulumi.
Ali Cloud. Oss. Inputs. Bucket Response Header Rule Filters - The container that holds the operations that need to be apply rules. See
filtersbelow. - Hide
Headers Pulumi.Ali Cloud. Oss. Inputs. Bucket Response Header Rule Hide Headers - The container that holds the response headers that need to be hidden. See
hide_headersbelow. - Name string
- The response header rule name.
- Filters
Bucket
Response Header Rule Filters - The container that holds the operations that need to be apply rules. See
filtersbelow. - Hide
Headers BucketResponse Header Rule Hide Headers - The container that holds the response headers that need to be hidden. See
hide_headersbelow. - Name string
- The response header rule name.
- filters
Bucket
Response Header Rule Filters - The container that holds the operations that need to be apply rules. See
filtersbelow. - hide
Headers BucketResponse Header Rule Hide Headers - The container that holds the response headers that need to be hidden. See
hide_headersbelow. - name String
- The response header rule name.
- filters
Bucket
Response Header Rule Filters - The container that holds the operations that need to be apply rules. See
filtersbelow. - hide
Headers BucketResponse Header Rule Hide Headers - The container that holds the response headers that need to be hidden. See
hide_headersbelow. - name string
- The response header rule name.
- filters
Bucket
Response Header Rule Filters - The container that holds the operations that need to be apply rules. See
filtersbelow. - hide_
headers BucketResponse Header Rule Hide Headers - The container that holds the response headers that need to be hidden. See
hide_headersbelow. - name str
- The response header rule name.
- filters Property Map
- The container that holds the operations that need to be apply rules. See
filtersbelow. - hide
Headers Property Map - The container that holds the response headers that need to be hidden. See
hide_headersbelow. - name String
- The response header rule name.
BucketResponseHeaderRuleFilters, BucketResponseHeaderRuleFiltersArgs
- Operations List<string>
- The operation to which the rule applies.
- Operations []string
- The operation to which the rule applies.
- operations List<String>
- The operation to which the rule applies.
- operations string[]
- The operation to which the rule applies.
- operations Sequence[str]
- The operation to which the rule applies.
- operations List<String>
- The operation to which the rule applies.
BucketResponseHeaderRuleHideHeaders, BucketResponseHeaderRuleHideHeadersArgs
- Headers List<string>
- The response header needs to be hidden.
- Headers []string
- The response header needs to be hidden.
- headers List<String>
- The response header needs to be hidden.
- headers string[]
- The response header needs to be hidden.
- headers Sequence[str]
- The response header needs to be hidden.
- headers List<String>
- The response header needs to be hidden.
Import
OSS Bucket Response Header can be imported using the id, e.g.
$ pulumi import alicloud:oss/bucketResponseHeader:BucketResponseHeader example <bucket>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
alicloudTerraform Provider.
