import * as pulumi from "@pulumi/pulumi"; import * as outputs from "../types/output"; /** * This data source provides details about a specific Bucket resource in Oracle Cloud Infrastructure Object Storage service. * * Gets the current representation of the given bucket in the given Object Storage namespace. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testBucket = oci.objectstorage.getBucket({ * name: bucketName, * namespace: bucketNamespace, * }); * ``` */ export declare function getBucket(args: GetBucketArgs, opts?: pulumi.InvokeOptions): Promise; /** * A collection of arguments for invoking getBucket. */ export interface GetBucketArgs { /** * The name of the bucket. Avoid entering confidential information. Example: `my-new-bucket1` */ name: string; /** * The Object Storage namespace used for the request. */ namespace: string; } /** * A collection of values returned by getBucket. */ export interface GetBucketResult { /** * 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. When `ObjectReadWithoutList` is enabled on the bucket, public access is allowed for the `GetObject` and `HeadObject` operations. */ readonly accessType: string; /** * The approximate number of objects in the bucket. Count statistics are reported periodically. You will see a lag between what is displayed and the actual object count. */ readonly approximateCount: string; /** * The approximate total size in bytes of all objects in the bucket. Size statistics are reported periodically. You will see a lag between what is displayed and the actual size of the bucket. */ readonly approximateSize: string; /** * The auto tiering status on the bucket. A bucket is created with auto tiering `Disabled` by default. For auto tiering `InfrequentAccess`, objects are transitioned automatically between the 'Standard' and 'InfrequentAccess' tiers based on the access pattern of the objects. */ readonly autoTiering: string; /** * The OCID of the bucket which is a Oracle assigned unique identifier for this resource type (bucket). `bucketId` cannot be used for bucket lookup. */ readonly bucketId: string; /** * Scope in which the bucket is unique. Default value is NAMESPACE. Bucket scope as NAMESPACE means that the bucket is unique only in the owning namespace/tenancy. Other tenancies can have a bucket with same name in their namespace. Bucket scope as REGION means that the bucket is regionally unique. No other tenancy can have a bucket with same name and scope REGION. */ readonly bucketScope: string; /** * The compartment ID in which the bucket is authorized. */ readonly compartmentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the bucket. */ readonly createdBy: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ readonly definedTags: { [key: string]: string; }; /** * The entity tag (ETag) for the bucket. */ readonly etag: string; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ readonly freeformTags: { [key: string]: string; }; readonly id: string; /** * Specifies whether Object Storage should use intermediate cached Bucket Encryption Keys with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. This reduces calls to Oracle Cloud Infrastructure Vault Key Management Service (KMS). Existing objects are not affected. */ readonly isBucketKeyEnabled: boolean; /** * Whether or not this bucket is read only. By default, `isReadOnly` is set to `false`. This will be set to 'true' when this bucket is configured as a destination in a replication policy. */ readonly isReadOnly: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a master encryption key used to call the Key Management service to generate a data encryption key or to encrypt or decrypt a data encryption key. */ readonly kmsKeyId: string; /** * Arbitrary string keys and values for user-defined metadata. */ readonly metadata: { [key: string]: string; }; /** * The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1 */ readonly name: string; /** * The Object Storage namespace in which the bucket resides. */ readonly namespace: string; /** * Whether or not events are emitted for object state changes in this bucket. By default, `objectEventsEnabled` is set to `false`. Set `objectEventsEnabled` to `true` to emit events for object state changes. For more information about events, see [Overview of Events](https://docs.cloud.oracle.com/iaas/Content/Events/Concepts/eventsoverview.htm). */ readonly objectEventsEnabled: boolean; /** * The entity tag (ETag) for the live object lifecycle policy on the bucket. */ readonly objectLifecyclePolicyEtag: string; /** * Whether or not this bucket is a replication source. By default, `replicationEnabled` is set to `false`. This will be set to 'true' when you create a replication policy for the bucket. */ readonly replicationEnabled: boolean; /** * User specified list of retention rules for the bucket. */ readonly retentionRules: outputs.ObjectStorage.GetBucketRetentionRule[]; /** * The storage tier type assigned to the bucket. A bucket is set to `Standard` tier by default, which means objects uploaded or copied to the bucket will be in the standard storage tier. When the `Archive` tier type is set explicitly for a bucket, objects uploaded or copied to the bucket will be stored in archive storage. The `storageTier` property is immutable after bucket is created. */ readonly storageTier: string; /** * The date and time the bucket was created, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29). */ readonly timeCreated: string; /** * The versioning status on the bucket. A bucket is created with versioning `Disabled` by default. For versioning `Enabled`, objects are protected from overwrites and deletes, by maintaining their version history. When versioning is `Suspended`, the previous versions will still remain but new versions will no longer be created when overwitten or deleted. */ readonly versioning: string; } /** * This data source provides details about a specific Bucket resource in Oracle Cloud Infrastructure Object Storage service. * * Gets the current representation of the given bucket in the given Object Storage namespace. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testBucket = oci.objectstorage.getBucket({ * name: bucketName, * namespace: bucketNamespace, * }); * ``` */ export declare function getBucketOutput(args: GetBucketOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output; /** * A collection of arguments for invoking getBucket. */ export interface GetBucketOutputArgs { /** * The name of the bucket. Avoid entering confidential information. Example: `my-new-bucket1` */ name: pulumi.Input; /** * The Object Storage namespace used for the request. */ namespace: pulumi.Input; } //# sourceMappingURL=getBucket.d.ts.map