Skip to content

Latest commit

 

History

History
131 lines (97 loc) · 4.74 KB

s3_bucket.md

File metadata and controls

131 lines (97 loc) · 4.74 KB
Raw
title linkTitle page_title subcategory description
powerscale_s3_bucket data source
powerscale_s3_bucket
powerscale_s3_bucket Data Source - terraform-provider-powerscale
Access S3 Buckets. This datasource is used to query the existing S3 Bucket from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. PowerScale S3 Bucket map to the PowerScale file system as base directory for Objects.

powerscale_s3_bucket (Data Source)

Access S3 Buckets. This datasource is used to query the existing S3 Bucket from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. PowerScale S3 Bucket map to the PowerScale file system as base directory for Objects.

Example Usage

/*
Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://mozilla.org/MPL/2.0/


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# This Terraform DataSource is used to query the details of existing S3 Bucket from PowerScale array.

# Returns a list of PowerScale s3 bucket based on filter block
data "powerscale_s3_bucket" "example_s3_buckets" {
  filter {
    # Used for query parameter, supported by PowerScale Platform API

    # Only list s3 bucket in this zone.
    # zone = "System"

    # Only list s3 bucket owned by this.
    # owner = "root"
  }
}

# Output value of above block by executing 'terraform output' command
# The user can use the fetched information by the variable data.powerscale_s3_bucket.example_s3_buckets
output "powerscale_s3_bucket" {
  value = data.powerscale_s3_bucket.example_s3_buckets
}

# Returns all of the PowerScale S3 Bucket in default zone
data "powerscale_s3_bucket" "all" {
}

# Output value of above block by executing 'terraform output' command
# The user can use the fetched information by the variable data.powerscale_s3_bucket.all
output "powerscale_s3_bucket_all" {
  value = data.powerscale_s3_bucket.all
}

Schema

Optional

Read-Only

Nested Schema for filter

Optional:

  • owner (String) Specifies the name of the owner.
  • zone (String) Specifies which access zone to use.

Nested Schema for s3_buckets

Read-Only:

  • acl (Attributes List) Specifies properties for an S3 Access Control Entry. (see below for nested schema)
  • description (String) Description for this S3 bucket.
  • id (String) Bucket ID.
  • name (String) Bucket name.
  • object_acl_policy (String) Set behavior of modifying object acls
  • owner (String) Specifies the name of the owner.
  • path (String) Path of bucket within /ifs.
  • zid (Number) Zone ID

Nested Schema for s3_buckets.acl

Read-Only:

  • grantee (Attributes) Specifies the persona of the file group. (see below for nested schema)
  • permission (String) Specifies the S3 rights being allowed.

Nested Schema for s3_buckets.acl.grantee

Read-Only:

  • id (String) Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'.
  • name (String) Specifies the persona name, which must be combined with a type.
  • type (String) Specifies the type of persona, which must be combined with a name.