@volcengine/pulumi/tos/bucketWebsite.d.ts

A Pulumi package for creating and managing volcengine cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * Provides a resource to manage tos bucket website
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as volcengine from "@volcengine/pulumi";
 *
 * const example = new volcengine.tos.BucketWebsite("example", {
 *     bucketName: "tflyb7",
 *     errorDocument: {
 *         key: "error1.html",
 *     },
 *     indexDocument: {
 *         suffix: "index.html",
 *         supportSubDir: false,
 *     },
 *     routingRules: [{
 *         condition: {
 *             httpErrorCodeReturnedEquals: 404,
 *             keyPrefixEquals: "red/",
 *         },
 *         redirect: {
 *             hostName: "example.com",
 *             httpRedirectCode: 301,
 *             protocol: "http",
 *             replaceKeyPrefixWith: "redirect2/",
 *         },
 *     }],
 * });
 * ```
 *
 * ## Import
 *
 * TosBucketWebsite can be imported using the bucketName, e.g.
 *
 * ```sh
 * $ pulumi import volcengine:tos/bucketWebsite:BucketWebsite default bucket_name
 * ```
 */
export declare class BucketWebsite extends pulumi.CustomResource {
    /**
     * Get an existing BucketWebsite 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?: BucketWebsiteState, opts?: pulumi.CustomResourceOptions): BucketWebsite;
    /**
     * Returns true if the given object is an instance of BucketWebsite.  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 BucketWebsite;
    /**
     * The name of the TOS bucket.
     */
    readonly bucketName: pulumi.Output<string>;
    /**
     * The error document configuration for the website.
     */
    readonly errorDocument: pulumi.Output<outputs.tos.BucketWebsiteErrorDocument | undefined>;
    /**
     * The index document configuration for the website.
     */
    readonly indexDocument: pulumi.Output<outputs.tos.BucketWebsiteIndexDocument>;
    /**
     * The redirect configuration for all requests.
     */
    readonly redirectAllRequestsTo: pulumi.Output<outputs.tos.BucketWebsiteRedirectAllRequestsTo | undefined>;
    /**
     * The routing rules for the website.
     */
    readonly routingRules: pulumi.Output<outputs.tos.BucketWebsiteRoutingRule[] | undefined>;
    /**
     * Create a BucketWebsite 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: BucketWebsiteArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering BucketWebsite resources.
 */
export interface BucketWebsiteState {
    /**
     * The name of the TOS bucket.
     */
    bucketName?: pulumi.Input<string>;
    /**
     * The error document configuration for the website.
     */
    errorDocument?: pulumi.Input<inputs.tos.BucketWebsiteErrorDocument>;
    /**
     * The index document configuration for the website.
     */
    indexDocument?: pulumi.Input<inputs.tos.BucketWebsiteIndexDocument>;
    /**
     * The redirect configuration for all requests.
     */
    redirectAllRequestsTo?: pulumi.Input<inputs.tos.BucketWebsiteRedirectAllRequestsTo>;
    /**
     * The routing rules for the website.
     */
    routingRules?: pulumi.Input<pulumi.Input<inputs.tos.BucketWebsiteRoutingRule>[]>;
}
/**
 * The set of arguments for constructing a BucketWebsite resource.
 */
export interface BucketWebsiteArgs {
    /**
     * The name of the TOS bucket.
     */
    bucketName: pulumi.Input<string>;
    /**
     * The error document configuration for the website.
     */
    errorDocument?: pulumi.Input<inputs.tos.BucketWebsiteErrorDocument>;
    /**
     * The index document configuration for the website.
     */
    indexDocument: pulumi.Input<inputs.tos.BucketWebsiteIndexDocument>;
    /**
     * The redirect configuration for all requests.
     */
    redirectAllRequestsTo?: pulumi.Input<inputs.tos.BucketWebsiteRedirectAllRequestsTo>;
    /**
     * The routing rules for the website.
     */
    routingRules?: pulumi.Input<pulumi.Input<inputs.tos.BucketWebsiteRoutingRule>[]>;
}