1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. oss
  5. BucketCnameToken
Viewing docs for Alibaba Cloud v3.97.0
published on Saturday, Mar 14, 2026 by Pulumi
alicloud logo
Viewing docs for Alibaba Cloud v3.97.0
published on Saturday, Mar 14, 2026 by Pulumi

    Provides a OSS Bucket Cname Token resource.

    The token used to verify the ownership of the bucket custom domain name.

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

    NOTE: Available since v1.233.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 createBucket = new alicloud.oss.Bucket("CreateBucket", {
        bucket: name,
        storageClass: "Standard",
    });
    const defaultZaWJfG = new alicloud.oss.BucketCnameToken("defaultZaWJfG", {
        bucket: createBucket.bucket,
        domain: "terraform-example.com",
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    config = pulumi.Config()
    name = config.get("name")
    if name is None:
        name = "terraform-example"
    create_bucket = alicloud.oss.Bucket("CreateBucket",
        bucket=name,
        storage_class="Standard")
    default_za_w_jf_g = alicloud.oss.BucketCnameToken("defaultZaWJfG",
        bucket=create_bucket.bucket,
        domain="terraform-example.com")
    
    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
    		}
    		createBucket, err := oss.NewBucket(ctx, "CreateBucket", &oss.BucketArgs{
    			Bucket:       pulumi.String(name),
    			StorageClass: pulumi.String("Standard"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = oss.NewBucketCnameToken(ctx, "defaultZaWJfG", &oss.BucketCnameTokenArgs{
    			Bucket: createBucket.Bucket,
    			Domain: pulumi.String("terraform-example.com"),
    		})
    		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 createBucket = new AliCloud.Oss.Bucket("CreateBucket", new()
        {
            BucketName = name,
            StorageClass = "Standard",
        });
    
        var defaultZaWJfG = new AliCloud.Oss.BucketCnameToken("defaultZaWJfG", new()
        {
            Bucket = createBucket.BucketName,
            Domain = "terraform-example.com",
        });
    
    });
    
    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.BucketCnameToken;
    import com.pulumi.alicloud.oss.BucketCnameTokenArgs;
    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 createBucket = new Bucket("createBucket", BucketArgs.builder()
                .bucket(name)
                .storageClass("Standard")
                .build());
    
            var defaultZaWJfG = new BucketCnameToken("defaultZaWJfG", BucketCnameTokenArgs.builder()
                .bucket(createBucket.bucket())
                .domain("terraform-example.com")
                .build());
    
        }
    }
    
    configuration:
      name:
        type: string
        default: terraform-example
    resources:
      createBucket:
        type: alicloud:oss:Bucket
        name: CreateBucket
        properties:
          bucket: ${name}
          storageClass: Standard
      defaultZaWJfG:
        type: alicloud:oss:BucketCnameToken
        properties:
          bucket: ${createBucket.bucket}
          domain: terraform-example.com
    

    Deleting alicloud.oss.BucketCnameToken or removing it from your configuration

    Terraform cannot destroy resource alicloud.oss.BucketCnameToken. Terraform will remove this resource from the state file, however resources may remain.

    📚 Need more examples? VIEW MORE EXAMPLES

    Create BucketCnameToken Resource

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

    Constructor syntax

    new BucketCnameToken(name: string, args: BucketCnameTokenArgs, opts?: CustomResourceOptions);
    @overload
    def BucketCnameToken(resource_name: str,
                         args: BucketCnameTokenArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def BucketCnameToken(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         bucket: Optional[str] = None,
                         domain: Optional[str] = None)
    func NewBucketCnameToken(ctx *Context, name string, args BucketCnameTokenArgs, opts ...ResourceOption) (*BucketCnameToken, error)
    public BucketCnameToken(string name, BucketCnameTokenArgs args, CustomResourceOptions? opts = null)
    public BucketCnameToken(String name, BucketCnameTokenArgs args)
    public BucketCnameToken(String name, BucketCnameTokenArgs args, CustomResourceOptions options)
    
    type: alicloud:oss:BucketCnameToken
    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 BucketCnameTokenArgs
    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 BucketCnameTokenArgs
    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 BucketCnameTokenArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BucketCnameTokenArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BucketCnameTokenArgs
    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 bucketCnameTokenResource = new AliCloud.Oss.BucketCnameToken("bucketCnameTokenResource", new()
    {
        Bucket = "string",
        Domain = "string",
    });
    
    example, err := oss.NewBucketCnameToken(ctx, "bucketCnameTokenResource", &oss.BucketCnameTokenArgs{
    	Bucket: pulumi.String("string"),
    	Domain: pulumi.String("string"),
    })
    
    var bucketCnameTokenResource = new BucketCnameToken("bucketCnameTokenResource", BucketCnameTokenArgs.builder()
        .bucket("string")
        .domain("string")
        .build());
    
    bucket_cname_token_resource = alicloud.oss.BucketCnameToken("bucketCnameTokenResource",
        bucket="string",
        domain="string")
    
    const bucketCnameTokenResource = new alicloud.oss.BucketCnameToken("bucketCnameTokenResource", {
        bucket: "string",
        domain: "string",
    });
    
    type: alicloud:oss:BucketCnameToken
    properties:
        bucket: string
        domain: string
    

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

    Bucket string
    The name of the bucket
    Domain string
    The custom domain
    Bucket string
    The name of the bucket
    Domain string
    The custom domain
    bucket String
    The name of the bucket
    domain String
    The custom domain
    bucket string
    The name of the bucket
    domain string
    The custom domain
    bucket str
    The name of the bucket
    domain str
    The custom domain
    bucket String
    The name of the bucket
    domain String
    The custom domain

    Outputs

    All input properties are implicitly available as output properties. Additionally, the BucketCnameToken resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    Token used to verify domain ownership
    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    Token used to verify domain ownership
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    Token used to verify domain ownership
    id string
    The provider-assigned unique ID for this managed resource.
    token string
    Token used to verify domain ownership
    id str
    The provider-assigned unique ID for this managed resource.
    token str
    Token used to verify domain ownership
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    Token used to verify domain ownership

    Look up Existing BucketCnameToken Resource

    Get an existing BucketCnameToken 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?: BucketCnameTokenState, opts?: CustomResourceOptions): BucketCnameToken
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            bucket: Optional[str] = None,
            domain: Optional[str] = None,
            token: Optional[str] = None) -> BucketCnameToken
    func GetBucketCnameToken(ctx *Context, name string, id IDInput, state *BucketCnameTokenState, opts ...ResourceOption) (*BucketCnameToken, error)
    public static BucketCnameToken Get(string name, Input<string> id, BucketCnameTokenState? state, CustomResourceOptions? opts = null)
    public static BucketCnameToken get(String name, Output<String> id, BucketCnameTokenState state, CustomResourceOptions options)
    resources:  _:    type: alicloud:oss:BucketCnameToken    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.
    The following state arguments are supported:
    Bucket string
    The name of the bucket
    Domain string
    The custom domain
    Token string
    Token used to verify domain ownership
    Bucket string
    The name of the bucket
    Domain string
    The custom domain
    Token string
    Token used to verify domain ownership
    bucket String
    The name of the bucket
    domain String
    The custom domain
    token String
    Token used to verify domain ownership
    bucket string
    The name of the bucket
    domain string
    The custom domain
    token string
    Token used to verify domain ownership
    bucket str
    The name of the bucket
    domain str
    The custom domain
    token str
    Token used to verify domain ownership
    bucket String
    The name of the bucket
    domain String
    The custom domain
    token String
    Token used to verify domain ownership

    Import

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

    $ pulumi import alicloud:oss/bucketCnameToken:BucketCnameToken example <bucket>:<domain>
    

    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
    Viewing docs for Alibaba Cloud v3.97.0
    published on Saturday, Mar 14, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.