All Products
Search
Document Center

Resource Orchestration Service:DATASOURCE::OSS::Buckets

Last Updated:Dec 02, 2024

DATASOURCE::OSS::Buckets is used to query an Object Storage Service (OSS) bucket.

Syntax

{
  "Type": "DATASOURCE::OSS::Buckets",
  "Properties": {
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

RefreshOptions

String

No

Yes

The refresh policy for data source resources when the stack is updated.

Valid values:

  • Never (default): does not refresh data source resources when the stack is updated.

  • Always: refreshes data source resources when the stack is updated.

Return values

Fn::GetAtt

  • BucketNames: the names of the buckets.

  • Buckets: details of the buckets.

Property

Type

Description

Constraint

BucketNames

List

The names of the buckets.

None.

Buckets

List

Details of the buckets.

None.

IntranetEndpoint

String

The internal endpoint that is used to access the bucket from the Elastic Compute Service (ECS) instance in the same region as the bucket.

None.

Location

String

The region in which the bucket resides.  

None.

StorageClass

String

The storage class of the bucket.

None.

Owner

String

The owner.

None.

Name

String

The bucket name.

None.

ExtranetEndpoint

String

The public endpoint that is used to access the bucket over the Internet.  

None.

CreateTime

String

The time when the bucket was created.

None.

Examples

ROSTemplateFormatVersion: '2015-09-01'
Resources:
  ExtensionDataSource:
    Properties: {}
    Type: DATASOURCE::OSS::Buckets
Outputs:
  BucketNames:
    Description: The list of bucket names.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - BucketNames
  Buckets:
    Description: The list of buckets.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Buckets
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::OSS::Buckets",
      "Properties": {}
    }
  },
  "Outputs": {
    "BucketNames": {
      "Description": "The list of bucket names.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BucketNames"
        ]
      }
    },
    "Buckets": {
      "Description": "The list of buckets.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Buckets"
        ]
      }
    }
  }
}