1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. oss
  5. BucketReferer
Alibaba Cloud v3.59.0 published on Friday, Jul 12, 2024 by Pulumi

alicloud.oss.BucketReferer

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.59.0 published on Friday, Jul 12, 2024 by Pulumi

    Provides a OSS Bucket Referer resource. Bucket Referer configuration (Hotlink protection).

    For information about OSS Bucket Referer and how to use it, see What is Bucket Referer.

    NOTE: Available since v1.220.0.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    import * as random from "@pulumi/random";
    
    const config = new pulumi.Config();
    const name = config.get("name") || "terraform-example";
    const _default = new random.index.Integer("default", {
        min: 10000,
        max: 99999,
    });
    const createBucket = new alicloud.oss.Bucket("CreateBucket", {
        storageClass: "Standard",
        bucket: `${name}-${_default.result}`,
    });
    const defaultBucketReferer = new alicloud.oss.BucketReferer("default", {
        allowEmptyReferer: true,
        refererBlacklists: ["*.forbidden.com"],
        bucket: createBucket.bucket,
        truncatePath: false,
        allowTruncateQueryString: true,
        refererLists: [
            "*.aliyun.com",
            "*.example.com",
        ],
    }, {
        dependsOn: [createBucket],
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    import pulumi_random as random
    
    config = pulumi.Config()
    name = config.get("name")
    if name is None:
        name = "terraform-example"
    default = random.index.Integer("default",
        min=10000,
        max=99999)
    create_bucket = alicloud.oss.Bucket("CreateBucket",
        storage_class="Standard",
        bucket=f"{name}-{default['result']}")
    default_bucket_referer = alicloud.oss.BucketReferer("default",
        allow_empty_referer=True,
        referer_blacklists=["*.forbidden.com"],
        bucket=create_bucket.bucket,
        truncate_path=False,
        allow_truncate_query_string=True,
        referer_lists=[
            "*.aliyun.com",
            "*.example.com",
        ],
        opts = pulumi.ResourceOptions(depends_on=[create_bucket]))
    
    package main
    
    import (
    	"fmt"
    
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/oss"
    	"github.com/pulumi/pulumi-random/sdk/v4/go/random"
    	"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
    		}
    		_, err := random.NewInteger(ctx, "default", &random.IntegerArgs{
    			Min: 10000,
    			Max: 99999,
    		})
    		if err != nil {
    			return err
    		}
    		createBucket, err := oss.NewBucket(ctx, "CreateBucket", &oss.BucketArgs{
    			StorageClass: pulumi.String("Standard"),
    			Bucket:       pulumi.String(fmt.Sprintf("%v-%v", name, _default.Result)),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = oss.NewBucketReferer(ctx, "default", &oss.BucketRefererArgs{
    			AllowEmptyReferer: pulumi.Bool(true),
    			RefererBlacklists: pulumi.StringArray{
    				pulumi.String("*.forbidden.com"),
    			},
    			Bucket:                   createBucket.Bucket,
    			TruncatePath:             pulumi.Bool(false),
    			AllowTruncateQueryString: pulumi.Bool(true),
    			RefererLists: pulumi.StringArray{
    				pulumi.String("*.aliyun.com"),
    				pulumi.String("*.example.com"),
    			},
    		}, pulumi.DependsOn([]pulumi.Resource{
    			createBucket,
    		}))
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    using Random = Pulumi.Random;
    
    return await Deployment.RunAsync(() => 
    {
        var config = new Config();
        var name = config.Get("name") ?? "terraform-example";
        var @default = new Random.Index.Integer("default", new()
        {
            Min = 10000,
            Max = 99999,
        });
    
        var createBucket = new AliCloud.Oss.Bucket("CreateBucket", new()
        {
            StorageClass = "Standard",
            BucketName = $"{name}-{@default.Result}",
        });
    
        var defaultBucketReferer = new AliCloud.Oss.BucketReferer("default", new()
        {
            AllowEmptyReferer = true,
            RefererBlacklists = new[]
            {
                "*.forbidden.com",
            },
            Bucket = createBucket.BucketName,
            TruncatePath = false,
            AllowTruncateQueryString = true,
            RefererLists = new[]
            {
                "*.aliyun.com",
                "*.example.com",
            },
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                createBucket,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.random.integer;
    import com.pulumi.random.IntegerArgs;
    import com.pulumi.alicloud.oss.Bucket;
    import com.pulumi.alicloud.oss.BucketArgs;
    import com.pulumi.alicloud.oss.BucketReferer;
    import com.pulumi.alicloud.oss.BucketRefererArgs;
    import com.pulumi.resources.CustomResourceOptions;
    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 default_ = new Integer("default", IntegerArgs.builder()
                .min(10000)
                .max(99999)
                .build());
    
            var createBucket = new Bucket("createBucket", BucketArgs.builder()
                .storageClass("Standard")
                .bucket(String.format("%s-%s", name,default_.result()))
                .build());
    
            var defaultBucketReferer = new BucketReferer("defaultBucketReferer", BucketRefererArgs.builder()
                .allowEmptyReferer("true")
                .refererBlacklists("*.forbidden.com")
                .bucket(createBucket.bucket())
                .truncatePath("false")
                .allowTruncateQueryString("true")
                .refererLists(            
                    "*.aliyun.com",
                    "*.example.com")
                .build(), CustomResourceOptions.builder()
                    .dependsOn(createBucket)
                    .build());
    
        }
    }
    
    configuration:
      name:
        type: string
        default: terraform-example
    resources:
      default:
        type: random:integer
        properties:
          min: 10000
          max: 99999
      createBucket:
        type: alicloud:oss:Bucket
        name: CreateBucket
        properties:
          storageClass: Standard
          bucket: ${name}-${default.result}
      defaultBucketReferer:
        type: alicloud:oss:BucketReferer
        name: default
        properties:
          allowEmptyReferer: 'true'
          refererBlacklists:
            - '*.forbidden.com'
          bucket: ${createBucket.bucket}
          truncatePath: 'false'
          allowTruncateQueryString: 'true'
          refererLists:
            - '*.aliyun.com'
            - '*.example.com'
        options:
          dependson:
            - ${createBucket}
    

    Create BucketReferer Resource

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

    Constructor syntax

    new BucketReferer(name: string, args: BucketRefererArgs, opts?: CustomResourceOptions);
    @overload
    def BucketReferer(resource_name: str,
                      args: BucketRefererArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def BucketReferer(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      allow_empty_referer: Optional[bool] = None,
                      bucket: Optional[str] = None,
                      allow_truncate_query_string: Optional[bool] = None,
                      referer_blacklists: Optional[Sequence[str]] = None,
                      referer_lists: Optional[Sequence[str]] = None,
                      truncate_path: Optional[bool] = None)
    func NewBucketReferer(ctx *Context, name string, args BucketRefererArgs, opts ...ResourceOption) (*BucketReferer, error)
    public BucketReferer(string name, BucketRefererArgs args, CustomResourceOptions? opts = null)
    public BucketReferer(String name, BucketRefererArgs args)
    public BucketReferer(String name, BucketRefererArgs args, CustomResourceOptions options)
    
    type: alicloud:oss:BucketReferer
    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 BucketRefererArgs
    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 BucketRefererArgs
    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 BucketRefererArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BucketRefererArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BucketRefererArgs
    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 bucketRefererResource = new AliCloud.Oss.BucketReferer("bucketRefererResource", new()
    {
        AllowEmptyReferer = false,
        Bucket = "string",
        AllowTruncateQueryString = false,
        RefererBlacklists = new[]
        {
            "string",
        },
        RefererLists = new[]
        {
            "string",
        },
        TruncatePath = false,
    });
    
    example, err := oss.NewBucketReferer(ctx, "bucketRefererResource", &oss.BucketRefererArgs{
    	AllowEmptyReferer:        pulumi.Bool(false),
    	Bucket:                   pulumi.String("string"),
    	AllowTruncateQueryString: pulumi.Bool(false),
    	RefererBlacklists: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	RefererLists: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	TruncatePath: pulumi.Bool(false),
    })
    
    var bucketRefererResource = new BucketReferer("bucketRefererResource", BucketRefererArgs.builder()
        .allowEmptyReferer(false)
        .bucket("string")
        .allowTruncateQueryString(false)
        .refererBlacklists("string")
        .refererLists("string")
        .truncatePath(false)
        .build());
    
    bucket_referer_resource = alicloud.oss.BucketReferer("bucketRefererResource",
        allow_empty_referer=False,
        bucket="string",
        allow_truncate_query_string=False,
        referer_blacklists=["string"],
        referer_lists=["string"],
        truncate_path=False)
    
    const bucketRefererResource = new alicloud.oss.BucketReferer("bucketRefererResource", {
        allowEmptyReferer: false,
        bucket: "string",
        allowTruncateQueryString: false,
        refererBlacklists: ["string"],
        refererLists: ["string"],
        truncatePath: false,
    });
    
    type: alicloud:oss:BucketReferer
    properties:
        allowEmptyReferer: false
        allowTruncateQueryString: false
        bucket: string
        refererBlacklists:
            - string
        refererLists:
            - string
        truncatePath: false
    

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

    AllowEmptyReferer bool
    Whether to allow empty Referer request headers.
    Bucket string
    Name of the Bucket.
    AllowTruncateQueryString bool
    Specifies whether to truncate the query string in the URL when the Referer is matched. Valid values: true, false.
    RefererBlacklists List<string>
    The container that holds the Referer blacklist.
    RefererLists List<string>
    The container that holds the Referer whitelist.
    TruncatePath bool
    Specifies whether to truncate the path and parts that follow the path in the URL when the Referer is matched. Valid values: true, false. If TruncatePath is set to true, the value of AllowTruncateQueryString must be also true because the query string follows the path component. When the path is truncated, the query string is also truncated.
    AllowEmptyReferer bool
    Whether to allow empty Referer request headers.
    Bucket string
    Name of the Bucket.
    AllowTruncateQueryString bool
    Specifies whether to truncate the query string in the URL when the Referer is matched. Valid values: true, false.
    RefererBlacklists []string
    The container that holds the Referer blacklist.
    RefererLists []string
    The container that holds the Referer whitelist.
    TruncatePath bool
    Specifies whether to truncate the path and parts that follow the path in the URL when the Referer is matched. Valid values: true, false. If TruncatePath is set to true, the value of AllowTruncateQueryString must be also true because the query string follows the path component. When the path is truncated, the query string is also truncated.
    allowEmptyReferer Boolean
    Whether to allow empty Referer request headers.
    bucket String
    Name of the Bucket.
    allowTruncateQueryString Boolean
    Specifies whether to truncate the query string in the URL when the Referer is matched. Valid values: true, false.
    refererBlacklists List<String>
    The container that holds the Referer blacklist.
    refererLists List<String>
    The container that holds the Referer whitelist.
    truncatePath Boolean
    Specifies whether to truncate the path and parts that follow the path in the URL when the Referer is matched. Valid values: true, false. If TruncatePath is set to true, the value of AllowTruncateQueryString must be also true because the query string follows the path component. When the path is truncated, the query string is also truncated.
    allowEmptyReferer boolean
    Whether to allow empty Referer request headers.
    bucket string
    Name of the Bucket.
    allowTruncateQueryString boolean
    Specifies whether to truncate the query string in the URL when the Referer is matched. Valid values: true, false.
    refererBlacklists string[]
    The container that holds the Referer blacklist.
    refererLists string[]
    The container that holds the Referer whitelist.
    truncatePath boolean
    Specifies whether to truncate the path and parts that follow the path in the URL when the Referer is matched. Valid values: true, false. If TruncatePath is set to true, the value of AllowTruncateQueryString must be also true because the query string follows the path component. When the path is truncated, the query string is also truncated.
    allow_empty_referer bool
    Whether to allow empty Referer request headers.
    bucket str
    Name of the Bucket.
    allow_truncate_query_string bool
    Specifies whether to truncate the query string in the URL when the Referer is matched. Valid values: true, false.
    referer_blacklists Sequence[str]
    The container that holds the Referer blacklist.
    referer_lists Sequence[str]
    The container that holds the Referer whitelist.
    truncate_path bool
    Specifies whether to truncate the path and parts that follow the path in the URL when the Referer is matched. Valid values: true, false. If TruncatePath is set to true, the value of AllowTruncateQueryString must be also true because the query string follows the path component. When the path is truncated, the query string is also truncated.
    allowEmptyReferer Boolean
    Whether to allow empty Referer request headers.
    bucket String
    Name of the Bucket.
    allowTruncateQueryString Boolean
    Specifies whether to truncate the query string in the URL when the Referer is matched. Valid values: true, false.
    refererBlacklists List<String>
    The container that holds the Referer blacklist.
    refererLists List<String>
    The container that holds the Referer whitelist.
    truncatePath Boolean
    Specifies whether to truncate the path and parts that follow the path in the URL when the Referer is matched. Valid values: true, false. If TruncatePath is set to true, the value of AllowTruncateQueryString must be also true because the query string follows the path component. When the path is truncated, the query string is also truncated.

    Outputs

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

    Get an existing BucketReferer 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?: BucketRefererState, opts?: CustomResourceOptions): BucketReferer
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            allow_empty_referer: Optional[bool] = None,
            allow_truncate_query_string: Optional[bool] = None,
            bucket: Optional[str] = None,
            referer_blacklists: Optional[Sequence[str]] = None,
            referer_lists: Optional[Sequence[str]] = None,
            truncate_path: Optional[bool] = None) -> BucketReferer
    func GetBucketReferer(ctx *Context, name string, id IDInput, state *BucketRefererState, opts ...ResourceOption) (*BucketReferer, error)
    public static BucketReferer Get(string name, Input<string> id, BucketRefererState? state, CustomResourceOptions? opts = null)
    public static BucketReferer get(String name, Output<String> id, BucketRefererState 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:
    AllowEmptyReferer bool
    Whether to allow empty Referer request headers.
    AllowTruncateQueryString bool
    Specifies whether to truncate the query string in the URL when the Referer is matched. Valid values: true, false.
    Bucket string
    Name of the Bucket.
    RefererBlacklists List<string>
    The container that holds the Referer blacklist.
    RefererLists List<string>
    The container that holds the Referer whitelist.
    TruncatePath bool
    Specifies whether to truncate the path and parts that follow the path in the URL when the Referer is matched. Valid values: true, false. If TruncatePath is set to true, the value of AllowTruncateQueryString must be also true because the query string follows the path component. When the path is truncated, the query string is also truncated.
    AllowEmptyReferer bool
    Whether to allow empty Referer request headers.
    AllowTruncateQueryString bool
    Specifies whether to truncate the query string in the URL when the Referer is matched. Valid values: true, false.
    Bucket string
    Name of the Bucket.
    RefererBlacklists []string
    The container that holds the Referer blacklist.
    RefererLists []string
    The container that holds the Referer whitelist.
    TruncatePath bool
    Specifies whether to truncate the path and parts that follow the path in the URL when the Referer is matched. Valid values: true, false. If TruncatePath is set to true, the value of AllowTruncateQueryString must be also true because the query string follows the path component. When the path is truncated, the query string is also truncated.
    allowEmptyReferer Boolean
    Whether to allow empty Referer request headers.
    allowTruncateQueryString Boolean
    Specifies whether to truncate the query string in the URL when the Referer is matched. Valid values: true, false.
    bucket String
    Name of the Bucket.
    refererBlacklists List<String>
    The container that holds the Referer blacklist.
    refererLists List<String>
    The container that holds the Referer whitelist.
    truncatePath Boolean
    Specifies whether to truncate the path and parts that follow the path in the URL when the Referer is matched. Valid values: true, false. If TruncatePath is set to true, the value of AllowTruncateQueryString must be also true because the query string follows the path component. When the path is truncated, the query string is also truncated.
    allowEmptyReferer boolean
    Whether to allow empty Referer request headers.
    allowTruncateQueryString boolean
    Specifies whether to truncate the query string in the URL when the Referer is matched. Valid values: true, false.
    bucket string
    Name of the Bucket.
    refererBlacklists string[]
    The container that holds the Referer blacklist.
    refererLists string[]
    The container that holds the Referer whitelist.
    truncatePath boolean
    Specifies whether to truncate the path and parts that follow the path in the URL when the Referer is matched. Valid values: true, false. If TruncatePath is set to true, the value of AllowTruncateQueryString must be also true because the query string follows the path component. When the path is truncated, the query string is also truncated.
    allow_empty_referer bool
    Whether to allow empty Referer request headers.
    allow_truncate_query_string bool
    Specifies whether to truncate the query string in the URL when the Referer is matched. Valid values: true, false.
    bucket str
    Name of the Bucket.
    referer_blacklists Sequence[str]
    The container that holds the Referer blacklist.
    referer_lists Sequence[str]
    The container that holds the Referer whitelist.
    truncate_path bool
    Specifies whether to truncate the path and parts that follow the path in the URL when the Referer is matched. Valid values: true, false. If TruncatePath is set to true, the value of AllowTruncateQueryString must be also true because the query string follows the path component. When the path is truncated, the query string is also truncated.
    allowEmptyReferer Boolean
    Whether to allow empty Referer request headers.
    allowTruncateQueryString Boolean
    Specifies whether to truncate the query string in the URL when the Referer is matched. Valid values: true, false.
    bucket String
    Name of the Bucket.
    refererBlacklists List<String>
    The container that holds the Referer blacklist.
    refererLists List<String>
    The container that holds the Referer whitelist.
    truncatePath Boolean
    Specifies whether to truncate the path and parts that follow the path in the URL when the Referer is matched. Valid values: true, false. If TruncatePath is set to true, the value of AllowTruncateQueryString must be also true because the query string follows the path component. When the path is truncated, the query string is also truncated.

    Import

    OSS Bucket Referer can be imported using the id, e.g.

    $ pulumi import alicloud:oss/bucketReferer:BucketReferer example <id>
    

    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 alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.59.0 published on Friday, Jul 12, 2024 by Pulumi