oci_bucket_facts - Fetches details of a bucket or all available buckets within a namespace

New in version 2.5.

Synopsis

  • This module retrieves details of a bucket or all the buckets available for specified namespace and compartment identifier.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_OCID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_type
    Choices:
  • api_key ←
  • instance_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
compartment_id
Identifier of the compartment from which facts of constituent buckets needs to be fetched. Required to get details of all buckets in a specified namespace and compartment.
config_file_location
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name Default:
DEFAULT
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
name
Name of the bucket. Required to fetch details of a specific bucket.

aliases: bucket
namespace_name
required
Name of the namespace from which facts of constituent buckets needs to be fetched.
region
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
tenancy
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm

Examples

#Note: These examples do not set authentication details.

#Listing facts of all buckets in a given namespace and compartment

- name: List bucket facts
  oci_bucket_facts:
    namespace_name: 'mynamespace'
    compartment_id: 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx'

#Fetch facts of a specific bucket
- name: Fetch a bucket
  oci_bucket_facts:
    namespace_name: 'mynamespace'
    name: 'Bucket1'

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
buckets
complex
 on success
The specified bucket or a list of all available buckets in the specified namespace and compartment.

Sample:
[{'etag': '7d48fea5-ghfc', 'name': 'Bucket1', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'created_by': 'ocid1.user.oc1..xxxxxEXAMPLExxxxx', 'namespace': 'mynamespace', 'time_created': '2017-10-07T16:20:33.933000+00:00'}, {'etag': '3f0158f2-68ea', 'name': 'Bucket2', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'created_by': 'ocid1.user.oc1..xxxxxEXAMPLExxxxx', 'namespace': 'mynamespace', 'time_created': '2017-10-06T13:47:38.544000+00:00'}]
  name
string
 always
The name of the bucket

Sample:
my-new-bucket1
  compartment_id
string
 always
The ID of the compartment in which the bucket is authorized

Sample:
ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
  namespace
string
 always
The namespace in which the bucket lives

Sample:
mynamespace
  created_by
string
 always
The OCID of the user who created the bucket.

Sample:
ocid1.user.oc1..xxxxxEXAMPLExxxxx
  etag
string
 always
The entity tag for the bucket.

Sample:
7d48fea5-ghfc
  time_created
string
 always
The date and time the bucket was created, as described in RFC 2616, section 14.29

Sample:
2017-10-07 16:20:33.933000
  public_access_type
string
 On retrieving a specific bucket
The type of public access enabled on this bucket. A bucket is set to NoPublicAccess by default, which only allows an authenticated caller to access the bucket and its contents. When ObjectRead is enabled on the bucket, public access is allowed for the GetObject, HeadObject, and ListObjects operations.

Sample:
NoPublicAccess
  metadata
dict(str,str)
 On retrieving a specific bucket
Arbitrary string keys and values for user-defined metadata.

Sample:
{'foo': 'bar'}


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Debayan Gupta(@debayan_gupta)

Hint

If you notice any issues in this documentation you can edit this document to improve it.