Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. tos
  6. getBucketWebsite
Viewing docs for volcenginecc v0.0.51
published on Monday, Jul 27, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.tos.getBucketWebsite

volcenginecc logo
Viewing docs for volcenginecc v0.0.51
published on Monday, Jul 27, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Data Source schema for Volcengine::TOS::BucketWebsite

    Using getBucketWebsite

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getBucketWebsite(args: GetBucketWebsiteArgs, opts?: InvokeOptions): Promise<GetBucketWebsiteResult>
function getBucketWebsiteOutput(args: GetBucketWebsiteOutputArgs, opts?: InvokeOptions): Output<GetBucketWebsiteResult>
    def get_bucket_website(id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetBucketWebsiteResult
def get_bucket_website_output(id: pulumi.Input[Optional[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetBucketWebsiteResult]
    func LookupBucketWebsite(ctx *Context, args *LookupBucketWebsiteArgs, opts ...InvokeOption) (*LookupBucketWebsiteResult, error)
func LookupBucketWebsiteOutput(ctx *Context, args *LookupBucketWebsiteOutputArgs, opts ...InvokeOption) LookupBucketWebsiteResultOutput

    > Note: This function is named LookupBucketWebsite in the Go SDK.

    public static class GetBucketWebsite 
{
    public static Task<GetBucketWebsiteResult> InvokeAsync(GetBucketWebsiteArgs args, InvokeOptions? opts = null)
    public static Output<GetBucketWebsiteResult> Invoke(GetBucketWebsiteInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBucketWebsiteResult> getBucketWebsite(GetBucketWebsiteArgs args, InvokeOptions options)
public static Output<GetBucketWebsiteResult> getBucketWebsite(GetBucketWebsiteArgs args, InvokeOptions options)

    fn::invoke:
  function: volcenginecc:tos/getBucketWebsite:getBucketWebsite
  arguments:
    # arguments dictionary
    data "volcenginecc_tos_get_bucket_website" "name" {
    # arguments
}

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getBucketWebsite Result

    The following output properties are available:

    Bucket string
    Bucket name
    ErrorDocument Volcengine.GetBucketWebsiteErrorDocument
    Error page configuration
    Id string
    Uniquely identifies the resource.
    IndexDocument Volcengine.GetBucketWebsiteIndexDocument
    Default homepage configuration
    RedirectAllRequestsTo Volcengine.GetBucketWebsiteRedirectAllRequestsTo
    Rule for redirecting all requests
    RoutingRules List<Volcengine.GetBucketWebsiteRoutingRule>
    Redirect rule
    Bucket string
    Bucket name
    ErrorDocument GetBucketWebsiteErrorDocument
    Error page configuration
    Id string
    Uniquely identifies the resource.
    IndexDocument GetBucketWebsiteIndexDocument
    Default homepage configuration
    RedirectAllRequestsTo GetBucketWebsiteRedirectAllRequestsTo
    Rule for redirecting all requests
    RoutingRules []GetBucketWebsiteRoutingRule
    Redirect rule
    bucket string
    Bucket name
    error_document object
    Error page configuration
    id string
    Uniquely identifies the resource.
    index_document object
    Default homepage configuration
    redirect_all_requests_to object
    Rule for redirecting all requests
    routing_rules list(object)
    Redirect rule
    bucket String
    Bucket name
    errorDocument GetBucketWebsiteErrorDocument
    Error page configuration
    id String
    Uniquely identifies the resource.
    indexDocument GetBucketWebsiteIndexDocument
    Default homepage configuration
    redirectAllRequestsTo GetBucketWebsiteRedirectAllRequestsTo
    Rule for redirecting all requests
    routingRules List<GetBucketWebsiteRoutingRule>
    Redirect rule
    bucket string
    Bucket name
    errorDocument GetBucketWebsiteErrorDocument
    Error page configuration
    id string
    Uniquely identifies the resource.
    indexDocument GetBucketWebsiteIndexDocument
    Default homepage configuration
    redirectAllRequestsTo GetBucketWebsiteRedirectAllRequestsTo
    Rule for redirecting all requests
    routingRules GetBucketWebsiteRoutingRule[]
    Redirect rule
    bucket str
    Bucket name
    error_document GetBucketWebsiteErrorDocument
    Error page configuration
    id str
    Uniquely identifies the resource.
    index_document GetBucketWebsiteIndexDocument
    Default homepage configuration
    redirect_all_requests_to GetBucketWebsiteRedirectAllRequestsTo
    Rule for redirecting all requests
    routing_rules Sequence[GetBucketWebsiteRoutingRule]
    Redirect rule
    bucket String
    Bucket name
    errorDocument Property Map
    Error page configuration
    id String
    Uniquely identifies the resource.
    indexDocument Property Map
    Default homepage configuration
    redirectAllRequestsTo Property Map
    Rule for redirecting all requests
    routingRules List<Property Map>
    Redirect rule

    Supporting Types

    GetBucketWebsiteErrorDocument

    Key string
    When a 4xx error occurs, this page is returned
    Key string
    When a 4xx error occurs, this page is returned
    key string
    When a 4xx error occurs, this page is returned
    key String
    When a 4xx error occurs, this page is returned
    key string
    When a 4xx error occurs, this page is returned
    key str
    When a 4xx error occurs, this page is returned
    key String
    When a 4xx error occurs, this page is returned

    GetBucketWebsiteIndexDocument

    ForbiddenSubDir bool
    Whether to support redirecting to the default homepage of a subdirectory. Value description: false (default): Does not support redirecting to the default homepage of a subdirectory. true: Supports redirecting to the default homepage of a subdirectory
    Suffix string
    When requesting a directory (ending with /), returns the object specified by Suffix in that directory. For example, if Suffix is set to index.html, accessing document/ returns document/index.html
    ForbiddenSubDir bool
    Whether to support redirecting to the default homepage of a subdirectory. Value description: false (default): Does not support redirecting to the default homepage of a subdirectory. true: Supports redirecting to the default homepage of a subdirectory
    Suffix string
    When requesting a directory (ending with /), returns the object specified by Suffix in that directory. For example, if Suffix is set to index.html, accessing document/ returns document/index.html
    forbidden_sub_dir bool
    Whether to support redirecting to the default homepage of a subdirectory. Value description: false (default): Does not support redirecting to the default homepage of a subdirectory. true: Supports redirecting to the default homepage of a subdirectory
    suffix string
    When requesting a directory (ending with /), returns the object specified by Suffix in that directory. For example, if Suffix is set to index.html, accessing document/ returns document/index.html
    forbiddenSubDir Boolean
    Whether to support redirecting to the default homepage of a subdirectory. Value description: false (default): Does not support redirecting to the default homepage of a subdirectory. true: Supports redirecting to the default homepage of a subdirectory
    suffix String
    When requesting a directory (ending with /), returns the object specified by Suffix in that directory. For example, if Suffix is set to index.html, accessing document/ returns document/index.html
    forbiddenSubDir boolean
    Whether to support redirecting to the default homepage of a subdirectory. Value description: false (default): Does not support redirecting to the default homepage of a subdirectory. true: Supports redirecting to the default homepage of a subdirectory
    suffix string
    When requesting a directory (ending with /), returns the object specified by Suffix in that directory. For example, if Suffix is set to index.html, accessing document/ returns document/index.html
    forbidden_sub_dir bool
    Whether to support redirecting to the default homepage of a subdirectory. Value description: false (default): Does not support redirecting to the default homepage of a subdirectory. true: Supports redirecting to the default homepage of a subdirectory
    suffix str
    When requesting a directory (ending with /), returns the object specified by Suffix in that directory. For example, if Suffix is set to index.html, accessing document/ returns document/index.html
    forbiddenSubDir Boolean
    Whether to support redirecting to the default homepage of a subdirectory. Value description: false (default): Does not support redirecting to the default homepage of a subdirectory. true: Supports redirecting to the default homepage of a subdirectory
    suffix String
    When requesting a directory (ending with /), returns the object specified by Suffix in that directory. For example, if Suffix is set to index.html, accessing document/ returns document/index.html

    GetBucketWebsiteRedirectAllRequestsTo

    HostName string
    Redirect site name
    Protocol string
    Protocol used for redirect requests. Supports http and https. Default is http
    HostName string
    Redirect site name
    Protocol string
    Protocol used for redirect requests. Supports http and https. Default is http
    host_name string
    Redirect site name
    protocol string
    Protocol used for redirect requests. Supports http and https. Default is http
    hostName String
    Redirect site name
    protocol String
    Protocol used for redirect requests. Supports http and https. Default is http
    hostName string
    Redirect site name
    protocol string
    Protocol used for redirect requests. Supports http and https. Default is http
    host_name str
    Redirect site name
    protocol str
    Protocol used for redirect requests. Supports http and https. Default is http
    hostName String
    Redirect site name
    protocol String
    Protocol used for redirect requests. Supports http and https. Default is http

    GetBucketWebsiteRoutingRule

    Condition Volcengine.GetBucketWebsiteRoutingRuleCondition
    Set the matching conditions for the redirect rule. The redirect rule only takes effect when all specified conditions are met
    Redirect Volcengine.GetBucketWebsiteRoutingRuleRedirect
    Set redirect rule
    Condition GetBucketWebsiteRoutingRuleCondition
    Set the matching conditions for the redirect rule. The redirect rule only takes effect when all specified conditions are met
    Redirect GetBucketWebsiteRoutingRuleRedirect
    Set redirect rule
    condition object
    Set the matching conditions for the redirect rule. The redirect rule only takes effect when all specified conditions are met
    redirect object
    Set redirect rule
    condition GetBucketWebsiteRoutingRuleCondition
    Set the matching conditions for the redirect rule. The redirect rule only takes effect when all specified conditions are met
    redirect GetBucketWebsiteRoutingRuleRedirect
    Set redirect rule
    condition GetBucketWebsiteRoutingRuleCondition
    Set the matching conditions for the redirect rule. The redirect rule only takes effect when all specified conditions are met
    redirect GetBucketWebsiteRoutingRuleRedirect
    Set redirect rule
    condition GetBucketWebsiteRoutingRuleCondition
    Set the matching conditions for the redirect rule. The redirect rule only takes effect when all specified conditions are met
    redirect GetBucketWebsiteRoutingRuleRedirect
    Set redirect rule
    condition Property Map
    Set the matching conditions for the redirect rule. The redirect rule only takes effect when all specified conditions are met
    redirect Property Map
    Set redirect rule

    GetBucketWebsiteRoutingRuleCondition

    HttpErrorCodeReturnedEquals int
    Set the HTTP error code that triggers the redirect rule. For example, if HttpErrorCodeReturnedEquals is set to 404, the rule takes effect when the specified object does not exist. If KeyPrefixEquals is set, the redirect rule only takes effect when both HttpErrorCodeReturnedEquals and KeyPrefixEquals conditions are met
    KeyPrefixEquals string
    Set the object name prefix for the redirect rule to take effect. If HttpErrorCodeReturnedEquals is set, the redirect rule only takes effect when both HttpErrorCodeReturnedEquals and KeyPrefixEquals conditions are met
    HttpErrorCodeReturnedEquals int
    Set the HTTP error code that triggers the redirect rule. For example, if HttpErrorCodeReturnedEquals is set to 404, the rule takes effect when the specified object does not exist. If KeyPrefixEquals is set, the redirect rule only takes effect when both HttpErrorCodeReturnedEquals and KeyPrefixEquals conditions are met
    KeyPrefixEquals string
    Set the object name prefix for the redirect rule to take effect. If HttpErrorCodeReturnedEquals is set, the redirect rule only takes effect when both HttpErrorCodeReturnedEquals and KeyPrefixEquals conditions are met
    http_error_code_returned_equals number
    Set the HTTP error code that triggers the redirect rule. For example, if HttpErrorCodeReturnedEquals is set to 404, the rule takes effect when the specified object does not exist. If KeyPrefixEquals is set, the redirect rule only takes effect when both HttpErrorCodeReturnedEquals and KeyPrefixEquals conditions are met
    key_prefix_equals string
    Set the object name prefix for the redirect rule to take effect. If HttpErrorCodeReturnedEquals is set, the redirect rule only takes effect when both HttpErrorCodeReturnedEquals and KeyPrefixEquals conditions are met
    httpErrorCodeReturnedEquals Integer
    Set the HTTP error code that triggers the redirect rule. For example, if HttpErrorCodeReturnedEquals is set to 404, the rule takes effect when the specified object does not exist. If KeyPrefixEquals is set, the redirect rule only takes effect when both HttpErrorCodeReturnedEquals and KeyPrefixEquals conditions are met
    keyPrefixEquals String
    Set the object name prefix for the redirect rule to take effect. If HttpErrorCodeReturnedEquals is set, the redirect rule only takes effect when both HttpErrorCodeReturnedEquals and KeyPrefixEquals conditions are met
    httpErrorCodeReturnedEquals number
    Set the HTTP error code that triggers the redirect rule. For example, if HttpErrorCodeReturnedEquals is set to 404, the rule takes effect when the specified object does not exist. If KeyPrefixEquals is set, the redirect rule only takes effect when both HttpErrorCodeReturnedEquals and KeyPrefixEquals conditions are met
    keyPrefixEquals string
    Set the object name prefix for the redirect rule to take effect. If HttpErrorCodeReturnedEquals is set, the redirect rule only takes effect when both HttpErrorCodeReturnedEquals and KeyPrefixEquals conditions are met
    http_error_code_returned_equals int
    Set the HTTP error code that triggers the redirect rule. For example, if HttpErrorCodeReturnedEquals is set to 404, the rule takes effect when the specified object does not exist. If KeyPrefixEquals is set, the redirect rule only takes effect when both HttpErrorCodeReturnedEquals and KeyPrefixEquals conditions are met
    key_prefix_equals str
    Set the object name prefix for the redirect rule to take effect. If HttpErrorCodeReturnedEquals is set, the redirect rule only takes effect when both HttpErrorCodeReturnedEquals and KeyPrefixEquals conditions are met
    httpErrorCodeReturnedEquals Number
    Set the HTTP error code that triggers the redirect rule. For example, if HttpErrorCodeReturnedEquals is set to 404, the rule takes effect when the specified object does not exist. If KeyPrefixEquals is set, the redirect rule only takes effect when both HttpErrorCodeReturnedEquals and KeyPrefixEquals conditions are met
    keyPrefixEquals String
    Set the object name prefix for the redirect rule to take effect. If HttpErrorCodeReturnedEquals is set, the redirect rule only takes effect when both HttpErrorCodeReturnedEquals and KeyPrefixEquals conditions are met

    GetBucketWebsiteRoutingRuleRedirect

    HostName string
    Set the redirect site name
    HttpRedirectCode int
    Status code returned during redirect. Only 3XX status codes can be set; 300 cannot be set. Default is 301
    Protocol string
    Protocol used for redirect requests, including http and https. Default is http
    ReplaceKeyPrefixWith string
    Object name prefix used for redirect
    ReplaceKeyWith string
    Object name used for redirect
    HostName string
    Set the redirect site name
    HttpRedirectCode int
    Status code returned during redirect. Only 3XX status codes can be set; 300 cannot be set. Default is 301
    Protocol string
    Protocol used for redirect requests, including http and https. Default is http
    ReplaceKeyPrefixWith string
    Object name prefix used for redirect
    ReplaceKeyWith string
    Object name used for redirect
    host_name string
    Set the redirect site name
    http_redirect_code number
    Status code returned during redirect. Only 3XX status codes can be set; 300 cannot be set. Default is 301
    protocol string
    Protocol used for redirect requests, including http and https. Default is http
    replace_key_prefix_with string
    Object name prefix used for redirect
    replace_key_with string
    Object name used for redirect
    hostName String
    Set the redirect site name
    httpRedirectCode Integer
    Status code returned during redirect. Only 3XX status codes can be set; 300 cannot be set. Default is 301
    protocol String
    Protocol used for redirect requests, including http and https. Default is http
    replaceKeyPrefixWith String
    Object name prefix used for redirect
    replaceKeyWith String
    Object name used for redirect
    hostName string
    Set the redirect site name
    httpRedirectCode number
    Status code returned during redirect. Only 3XX status codes can be set; 300 cannot be set. Default is 301
    protocol string
    Protocol used for redirect requests, including http and https. Default is http
    replaceKeyPrefixWith string
    Object name prefix used for redirect
    replaceKeyWith string
    Object name used for redirect
    host_name str
    Set the redirect site name
    http_redirect_code int
    Status code returned during redirect. Only 3XX status codes can be set; 300 cannot be set. Default is 301
    protocol str
    Protocol used for redirect requests, including http and https. Default is http
    replace_key_prefix_with str
    Object name prefix used for redirect
    replace_key_with str
    Object name used for redirect
    hostName String
    Set the redirect site name
    httpRedirectCode Number
    Status code returned during redirect. Only 3XX status codes can be set; 300 cannot be set. Default is 301
    protocol String
    Protocol used for redirect requests, including http and https. Default is http
    replaceKeyPrefixWith String
    Object name prefix used for redirect
    replaceKeyWith String
    Object name used for redirect

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.51
    published on Monday, Jul 27, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial