1. Packages
  2. Opentelekomcloud Provider
  3. API Docs
  4. getObsBucket
opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud

opentelekomcloud.getObsBucket

Explore with Pulumi AI

opentelekomcloud logo
opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud

    Up-to-date reference of API arguments for OBS bucket you can get at documentation portal

    Use this data source to get details about bucket within OpenTelekomCloud.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as opentelekomcloud from "@pulumi/opentelekomcloud";
    
    const bucket = opentelekomcloud.getObsBucket({
        bucket: "my-test-bucket",
    });
    
    import pulumi
    import pulumi_opentelekomcloud as opentelekomcloud
    
    bucket = opentelekomcloud.get_obs_bucket(bucket="my-test-bucket")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/opentelekomcloud/opentelekomcloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := opentelekomcloud.LookupObsBucket(ctx, &opentelekomcloud.LookupObsBucketArgs{
    			Bucket: "my-test-bucket",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Opentelekomcloud = Pulumi.Opentelekomcloud;
    
    return await Deployment.RunAsync(() => 
    {
        var bucket = Opentelekomcloud.GetObsBucket.Invoke(new()
        {
            Bucket = "my-test-bucket",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.opentelekomcloud.OpentelekomcloudFunctions;
    import com.pulumi.opentelekomcloud.inputs.GetObsBucketArgs;
    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 bucket = OpentelekomcloudFunctions.getObsBucket(GetObsBucketArgs.builder()
                .bucket("my-test-bucket")
                .build());
    
        }
    }
    
    variables:
      bucket:
        fn::invoke:
          function: opentelekomcloud:getObsBucket
          arguments:
            bucket: my-test-bucket
    

    Using getObsBucket

    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 getObsBucket(args: GetObsBucketArgs, opts?: InvokeOptions): Promise<GetObsBucketResult>
    function getObsBucketOutput(args: GetObsBucketOutputArgs, opts?: InvokeOptions): Output<GetObsBucketResult>
    def get_obs_bucket(bucket: Optional[str] = None,
                       id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetObsBucketResult
    def get_obs_bucket_output(bucket: Optional[pulumi.Input[str]] = None,
                       id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetObsBucketResult]
    func LookupObsBucket(ctx *Context, args *LookupObsBucketArgs, opts ...InvokeOption) (*LookupObsBucketResult, error)
    func LookupObsBucketOutput(ctx *Context, args *LookupObsBucketOutputArgs, opts ...InvokeOption) LookupObsBucketResultOutput

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

    public static class GetObsBucket 
    {
        public static Task<GetObsBucketResult> InvokeAsync(GetObsBucketArgs args, InvokeOptions? opts = null)
        public static Output<GetObsBucketResult> Invoke(GetObsBucketInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetObsBucketResult> getObsBucket(GetObsBucketArgs args, InvokeOptions options)
    public static Output<GetObsBucketResult> getObsBucket(GetObsBucketArgs args, InvokeOptions options)
    
    fn::invoke:
      function: opentelekomcloud:index/getObsBucket:getObsBucket
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Bucket string
    The name of the bucket to read.
    Id string
    Bucket string
    The name of the bucket to read.
    Id string
    bucket String
    The name of the bucket to read.
    id String
    bucket string
    The name of the bucket to read.
    id string
    bucket str
    The name of the bucket to read.
    id str
    bucket String
    The name of the bucket to read.
    id String

    getObsBucket Result

    The following output properties are available:

    Bucket string
    BucketDomainName string
    The bucket domain name. Will be of format bucketname.obs.region.otc.t-systems.com.
    CorsRules List<GetObsBucketCorsRule>
    A rule of Cross-Origin Resource Sharing (documented below).
    EventNotifications List<GetObsBucketEventNotification>
    A configuration of bucket event notifications (documented below).
    Id string
    LifecycleRules List<GetObsBucketLifecycleRule>
    A configuration of object lifecycle management (documented below).
    Loggings List<GetObsBucketLogging>
    A settings of bucket logging (documented below).
    Region string
    The region this bucket resides in.
    ServerSideEncryptions List<GetObsBucketServerSideEncryption>
    A configuration of server side encryption (documented below).
    StorageClass string
    The class of storage used to store the object.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the bucket. Each tag is represented by one key-value pair.
    Versioning bool
    Websites List<GetObsBucketWebsite>
    A website object (documented below).
    Bucket string
    BucketDomainName string
    The bucket domain name. Will be of format bucketname.obs.region.otc.t-systems.com.
    CorsRules []GetObsBucketCorsRule
    A rule of Cross-Origin Resource Sharing (documented below).
    EventNotifications []GetObsBucketEventNotification
    A configuration of bucket event notifications (documented below).
    Id string
    LifecycleRules []GetObsBucketLifecycleRule
    A configuration of object lifecycle management (documented below).
    Loggings []GetObsBucketLogging
    A settings of bucket logging (documented below).
    Region string
    The region this bucket resides in.
    ServerSideEncryptions []GetObsBucketServerSideEncryption
    A configuration of server side encryption (documented below).
    StorageClass string
    The class of storage used to store the object.
    Tags map[string]string
    A mapping of tags to assign to the bucket. Each tag is represented by one key-value pair.
    Versioning bool
    Websites []GetObsBucketWebsite
    A website object (documented below).
    bucket String
    bucketDomainName String
    The bucket domain name. Will be of format bucketname.obs.region.otc.t-systems.com.
    corsRules List<GetObsBucketCorsRule>
    A rule of Cross-Origin Resource Sharing (documented below).
    eventNotifications List<GetObsBucketEventNotification>
    A configuration of bucket event notifications (documented below).
    id String
    lifecycleRules List<GetObsBucketLifecycleRule>
    A configuration of object lifecycle management (documented below).
    loggings List<GetObsBucketLogging>
    A settings of bucket logging (documented below).
    region String
    The region this bucket resides in.
    serverSideEncryptions List<GetObsBucketServerSideEncryption>
    A configuration of server side encryption (documented below).
    storageClass String
    The class of storage used to store the object.
    tags Map<String,String>
    A mapping of tags to assign to the bucket. Each tag is represented by one key-value pair.
    versioning Boolean
    websites List<GetObsBucketWebsite>
    A website object (documented below).
    bucket string
    bucketDomainName string
    The bucket domain name. Will be of format bucketname.obs.region.otc.t-systems.com.
    corsRules GetObsBucketCorsRule[]
    A rule of Cross-Origin Resource Sharing (documented below).
    eventNotifications GetObsBucketEventNotification[]
    A configuration of bucket event notifications (documented below).
    id string
    lifecycleRules GetObsBucketLifecycleRule[]
    A configuration of object lifecycle management (documented below).
    loggings GetObsBucketLogging[]
    A settings of bucket logging (documented below).
    region string
    The region this bucket resides in.
    serverSideEncryptions GetObsBucketServerSideEncryption[]
    A configuration of server side encryption (documented below).
    storageClass string
    The class of storage used to store the object.
    tags {[key: string]: string}
    A mapping of tags to assign to the bucket. Each tag is represented by one key-value pair.
    versioning boolean
    websites GetObsBucketWebsite[]
    A website object (documented below).
    bucket str
    bucket_domain_name str
    The bucket domain name. Will be of format bucketname.obs.region.otc.t-systems.com.
    cors_rules Sequence[GetObsBucketCorsRule]
    A rule of Cross-Origin Resource Sharing (documented below).
    event_notifications Sequence[GetObsBucketEventNotification]
    A configuration of bucket event notifications (documented below).
    id str
    lifecycle_rules Sequence[GetObsBucketLifecycleRule]
    A configuration of object lifecycle management (documented below).
    loggings Sequence[GetObsBucketLogging]
    A settings of bucket logging (documented below).
    region str
    The region this bucket resides in.
    server_side_encryptions Sequence[GetObsBucketServerSideEncryption]
    A configuration of server side encryption (documented below).
    storage_class str
    The class of storage used to store the object.
    tags Mapping[str, str]
    A mapping of tags to assign to the bucket. Each tag is represented by one key-value pair.
    versioning bool
    websites Sequence[GetObsBucketWebsite]
    A website object (documented below).
    bucket String
    bucketDomainName String
    The bucket domain name. Will be of format bucketname.obs.region.otc.t-systems.com.
    corsRules List<Property Map>
    A rule of Cross-Origin Resource Sharing (documented below).
    eventNotifications List<Property Map>
    A configuration of bucket event notifications (documented below).
    id String
    lifecycleRules List<Property Map>
    A configuration of object lifecycle management (documented below).
    loggings List<Property Map>
    A settings of bucket logging (documented below).
    region String
    The region this bucket resides in.
    serverSideEncryptions List<Property Map>
    A configuration of server side encryption (documented below).
    storageClass String
    The class of storage used to store the object.
    tags Map<String>
    A mapping of tags to assign to the bucket. Each tag is represented by one key-value pair.
    versioning Boolean
    websites List<Property Map>
    A website object (documented below).

    Supporting Types

    GetObsBucketCorsRule

    AllowedHeaders List<string>
    AllowedMethods List<string>
    AllowedOrigins List<string>
    ExposeHeaders List<string>
    MaxAgeSeconds double
    allowedHeaders List<String>
    allowedMethods List<String>
    allowedOrigins List<String>
    exposeHeaders List<String>
    maxAgeSeconds Double
    allowed_headers Sequence[str]
    allowed_methods Sequence[str]
    allowed_origins Sequence[str]
    expose_headers Sequence[str]
    max_age_seconds float
    allowedHeaders List<String>
    allowedMethods List<String>
    allowedOrigins List<String>
    exposeHeaders List<String>
    maxAgeSeconds Number

    GetObsBucketEventNotification

    events List<String>
    filterRules List<Property Map>
    id String
    topic String

    GetObsBucketEventNotificationFilterRule

    Name string
    Unique identifier for lifecycle rules. The Rule Name contains a maximum of 255 characters.
    Value string
    Name string
    Unique identifier for lifecycle rules. The Rule Name contains a maximum of 255 characters.
    Value string
    name String
    Unique identifier for lifecycle rules. The Rule Name contains a maximum of 255 characters.
    value String
    name string
    Unique identifier for lifecycle rules. The Rule Name contains a maximum of 255 characters.
    value string
    name str
    Unique identifier for lifecycle rules. The Rule Name contains a maximum of 255 characters.
    value str
    name String
    Unique identifier for lifecycle rules. The Rule Name contains a maximum of 255 characters.
    value String

    GetObsBucketLifecycleRule

    Enabled bool
    Specifies lifecycle rule status.
    Expirations List<GetObsBucketLifecycleRuleExpiration>
    Specifies a period when objects that have been last updated are automatically deleted. (documented below).
    Name string
    Unique identifier for lifecycle rules. The Rule Name contains a maximum of 255 characters.
    NoncurrentVersionExpirations List<GetObsBucketLifecycleRuleNoncurrentVersionExpiration>
    Specifies a period when noncurrent object versions are automatically deleted. (documented below).
    NoncurrentVersionTransitions List<GetObsBucketLifecycleRuleNoncurrentVersionTransition>
    Specifies a period when noncurrent object versions are automatically transitioned to WARM or COLD storage class (documented below).
    Prefix string
    Object key prefix identifying one or more objects to which the rule applies.
    Transitions List<GetObsBucketLifecycleRuleTransition>
    Specifies a period when objects that have been last updated are automatically transitioned to WARM or COLD storage class (documented below).
    Enabled bool
    Specifies lifecycle rule status.
    Expirations []GetObsBucketLifecycleRuleExpiration
    Specifies a period when objects that have been last updated are automatically deleted. (documented below).
    Name string
    Unique identifier for lifecycle rules. The Rule Name contains a maximum of 255 characters.
    NoncurrentVersionExpirations []GetObsBucketLifecycleRuleNoncurrentVersionExpiration
    Specifies a period when noncurrent object versions are automatically deleted. (documented below).
    NoncurrentVersionTransitions []GetObsBucketLifecycleRuleNoncurrentVersionTransition
    Specifies a period when noncurrent object versions are automatically transitioned to WARM or COLD storage class (documented below).
    Prefix string
    Object key prefix identifying one or more objects to which the rule applies.
    Transitions []GetObsBucketLifecycleRuleTransition
    Specifies a period when objects that have been last updated are automatically transitioned to WARM or COLD storage class (documented below).
    enabled Boolean
    Specifies lifecycle rule status.
    expirations List<GetObsBucketLifecycleRuleExpiration>
    Specifies a period when objects that have been last updated are automatically deleted. (documented below).
    name String
    Unique identifier for lifecycle rules. The Rule Name contains a maximum of 255 characters.
    noncurrentVersionExpirations List<GetObsBucketLifecycleRuleNoncurrentVersionExpiration>
    Specifies a period when noncurrent object versions are automatically deleted. (documented below).
    noncurrentVersionTransitions List<GetObsBucketLifecycleRuleNoncurrentVersionTransition>
    Specifies a period when noncurrent object versions are automatically transitioned to WARM or COLD storage class (documented below).
    prefix String
    Object key prefix identifying one or more objects to which the rule applies.
    transitions List<GetObsBucketLifecycleRuleTransition>
    Specifies a period when objects that have been last updated are automatically transitioned to WARM or COLD storage class (documented below).
    enabled boolean
    Specifies lifecycle rule status.
    expirations GetObsBucketLifecycleRuleExpiration[]
    Specifies a period when objects that have been last updated are automatically deleted. (documented below).
    name string
    Unique identifier for lifecycle rules. The Rule Name contains a maximum of 255 characters.
    noncurrentVersionExpirations GetObsBucketLifecycleRuleNoncurrentVersionExpiration[]
    Specifies a period when noncurrent object versions are automatically deleted. (documented below).
    noncurrentVersionTransitions GetObsBucketLifecycleRuleNoncurrentVersionTransition[]
    Specifies a period when noncurrent object versions are automatically transitioned to WARM or COLD storage class (documented below).
    prefix string
    Object key prefix identifying one or more objects to which the rule applies.
    transitions GetObsBucketLifecycleRuleTransition[]
    Specifies a period when objects that have been last updated are automatically transitioned to WARM or COLD storage class (documented below).
    enabled bool
    Specifies lifecycle rule status.
    expirations Sequence[GetObsBucketLifecycleRuleExpiration]
    Specifies a period when objects that have been last updated are automatically deleted. (documented below).
    name str
    Unique identifier for lifecycle rules. The Rule Name contains a maximum of 255 characters.
    noncurrent_version_expirations Sequence[GetObsBucketLifecycleRuleNoncurrentVersionExpiration]
    Specifies a period when noncurrent object versions are automatically deleted. (documented below).
    noncurrent_version_transitions Sequence[GetObsBucketLifecycleRuleNoncurrentVersionTransition]
    Specifies a period when noncurrent object versions are automatically transitioned to WARM or COLD storage class (documented below).
    prefix str
    Object key prefix identifying one or more objects to which the rule applies.
    transitions Sequence[GetObsBucketLifecycleRuleTransition]
    Specifies a period when objects that have been last updated are automatically transitioned to WARM or COLD storage class (documented below).
    enabled Boolean
    Specifies lifecycle rule status.
    expirations List<Property Map>
    Specifies a period when objects that have been last updated are automatically deleted. (documented below).
    name String
    Unique identifier for lifecycle rules. The Rule Name contains a maximum of 255 characters.
    noncurrentVersionExpirations List<Property Map>
    Specifies a period when noncurrent object versions are automatically deleted. (documented below).
    noncurrentVersionTransitions List<Property Map>
    Specifies a period when noncurrent object versions are automatically transitioned to WARM or COLD storage class (documented below).
    prefix String
    Object key prefix identifying one or more objects to which the rule applies.
    transitions List<Property Map>
    Specifies a period when objects that have been last updated are automatically transitioned to WARM or COLD storage class (documented below).

    GetObsBucketLifecycleRuleExpiration

    Days double
    Specifies the number of days when noncurrent object versions are automatically transitioned to the specified storage class.
    Days float64
    Specifies the number of days when noncurrent object versions are automatically transitioned to the specified storage class.
    days Double
    Specifies the number of days when noncurrent object versions are automatically transitioned to the specified storage class.
    days number
    Specifies the number of days when noncurrent object versions are automatically transitioned to the specified storage class.
    days float
    Specifies the number of days when noncurrent object versions are automatically transitioned to the specified storage class.
    days Number
    Specifies the number of days when noncurrent object versions are automatically transitioned to the specified storage class.

    GetObsBucketLifecycleRuleNoncurrentVersionExpiration

    Days double
    Specifies the number of days when noncurrent object versions are automatically transitioned to the specified storage class.
    Days float64
    Specifies the number of days when noncurrent object versions are automatically transitioned to the specified storage class.
    days Double
    Specifies the number of days when noncurrent object versions are automatically transitioned to the specified storage class.
    days number
    Specifies the number of days when noncurrent object versions are automatically transitioned to the specified storage class.
    days float
    Specifies the number of days when noncurrent object versions are automatically transitioned to the specified storage class.
    days Number
    Specifies the number of days when noncurrent object versions are automatically transitioned to the specified storage class.

    GetObsBucketLifecycleRuleNoncurrentVersionTransition

    Days double
    Specifies the number of days when noncurrent object versions are automatically transitioned to the specified storage class.
    StorageClass string
    The class of storage used to store the object.
    Days float64
    Specifies the number of days when noncurrent object versions are automatically transitioned to the specified storage class.
    StorageClass string
    The class of storage used to store the object.
    days Double
    Specifies the number of days when noncurrent object versions are automatically transitioned to the specified storage class.
    storageClass String
    The class of storage used to store the object.
    days number
    Specifies the number of days when noncurrent object versions are automatically transitioned to the specified storage class.
    storageClass string
    The class of storage used to store the object.
    days float
    Specifies the number of days when noncurrent object versions are automatically transitioned to the specified storage class.
    storage_class str
    The class of storage used to store the object.
    days Number
    Specifies the number of days when noncurrent object versions are automatically transitioned to the specified storage class.
    storageClass String
    The class of storage used to store the object.

    GetObsBucketLifecycleRuleTransition

    Days double
    Specifies the number of days when noncurrent object versions are automatically transitioned to the specified storage class.
    StorageClass string
    The class of storage used to store the object.
    Days float64
    Specifies the number of days when noncurrent object versions are automatically transitioned to the specified storage class.
    StorageClass string
    The class of storage used to store the object.
    days Double
    Specifies the number of days when noncurrent object versions are automatically transitioned to the specified storage class.
    storageClass String
    The class of storage used to store the object.
    days number
    Specifies the number of days when noncurrent object versions are automatically transitioned to the specified storage class.
    storageClass string
    The class of storage used to store the object.
    days float
    Specifies the number of days when noncurrent object versions are automatically transitioned to the specified storage class.
    storage_class str
    The class of storage used to store the object.
    days Number
    Specifies the number of days when noncurrent object versions are automatically transitioned to the specified storage class.
    storageClass String
    The class of storage used to store the object.

    GetObsBucketLogging

    TargetBucket string
    The name of the bucket that will receive the log objects.
    TargetPrefix string
    To specify a key prefix for log objects.
    TargetBucket string
    The name of the bucket that will receive the log objects.
    TargetPrefix string
    To specify a key prefix for log objects.
    targetBucket String
    The name of the bucket that will receive the log objects.
    targetPrefix String
    To specify a key prefix for log objects.
    targetBucket string
    The name of the bucket that will receive the log objects.
    targetPrefix string
    To specify a key prefix for log objects.
    target_bucket str
    The name of the bucket that will receive the log objects.
    target_prefix str
    To specify a key prefix for log objects.
    targetBucket String
    The name of the bucket that will receive the log objects.
    targetPrefix String
    To specify a key prefix for log objects.

    GetObsBucketServerSideEncryption

    Algorithm string
    KmsKeyId string
    Algorithm string
    KmsKeyId string
    algorithm String
    kmsKeyId String
    algorithm string
    kmsKeyId string
    algorithm String
    kmsKeyId String

    GetObsBucketWebsite

    ErrorDocument string
    Specifies the error page returned when an error occurs during static website access.
    IndexDocument string
    Specifies the default homepage of the static website, only HTML web pages are supported.
    RedirectAllRequestsTo string
    A hostname to redirect all website requests for this bucket to.
    RoutingRules string
    A JSON or XML format containing routing rules describing redirect behavior and when redirects are applied.
    ErrorDocument string
    Specifies the error page returned when an error occurs during static website access.
    IndexDocument string
    Specifies the default homepage of the static website, only HTML web pages are supported.
    RedirectAllRequestsTo string
    A hostname to redirect all website requests for this bucket to.
    RoutingRules string
    A JSON or XML format containing routing rules describing redirect behavior and when redirects are applied.
    errorDocument String
    Specifies the error page returned when an error occurs during static website access.
    indexDocument String
    Specifies the default homepage of the static website, only HTML web pages are supported.
    redirectAllRequestsTo String
    A hostname to redirect all website requests for this bucket to.
    routingRules String
    A JSON or XML format containing routing rules describing redirect behavior and when redirects are applied.
    errorDocument string
    Specifies the error page returned when an error occurs during static website access.
    indexDocument string
    Specifies the default homepage of the static website, only HTML web pages are supported.
    redirectAllRequestsTo string
    A hostname to redirect all website requests for this bucket to.
    routingRules string
    A JSON or XML format containing routing rules describing redirect behavior and when redirects are applied.
    error_document str
    Specifies the error page returned when an error occurs during static website access.
    index_document str
    Specifies the default homepage of the static website, only HTML web pages are supported.
    redirect_all_requests_to str
    A hostname to redirect all website requests for this bucket to.
    routing_rules str
    A JSON or XML format containing routing rules describing redirect behavior and when redirects are applied.
    errorDocument String
    Specifies the error page returned when an error occurs during static website access.
    indexDocument String
    Specifies the default homepage of the static website, only HTML web pages are supported.
    redirectAllRequestsTo String
    A hostname to redirect all website requests for this bucket to.
    routingRules String
    A JSON or XML format containing routing rules describing redirect behavior and when redirects are applied.

    Package Details

    Repository
    opentelekomcloud opentelekomcloud/terraform-provider-opentelekomcloud
    License
    Notes
    This Pulumi package is based on the opentelekomcloud Terraform Provider.
    opentelekomcloud logo
    opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud