IBM COS SDK for JavaScript V2 - v1.0.0
    Preparing search index...

    Interface HeadBucketCommandOutput

    The output of HeadBucketCommand.

    interface HeadBucketCommandOutput {
        IBMSSEKPEnabled?: boolean;
        IBMSSEKPCustomerRootKeyCrn?: string;
        BucketArn?: string;
        BucketLocationType?: LocationType;
        BucketLocationName?: string;
        BucketRegion?: string;
        AccessPointAlias?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    IBMSSEKPEnabled? IBMSSEKPCustomerRootKeyCrn? BucketArn? BucketLocationType? BucketLocationName? BucketRegion? AccessPointAlias?

    Properties

    IBMSSEKPEnabled?: boolean

    Indicates whether IBM Server-Side Encryption with Key Protect (SSE-KP) is enabled for this bucket.

    IBMSSEKPCustomerRootKeyCrn?: string

    The Cloud Resource Name (CRN) of the customer root key in IBM Key Protect used for SSE-KP.

    BucketArn?: string

    The Amazon Resource Name (ARN) of the S3 bucket. ARNs uniquely identify Amazon Web Services resources across all of Amazon Web Services.

    This parameter is only supported for S3 directory buckets. For more information, see Using tags with directory buckets.

    BucketLocationType?: LocationType

    The type of location where the bucket is created.

    This functionality is only supported by directory buckets.

    BucketLocationName?: string

    The name of the location where the bucket will be created.

    For directory buckets, the Zone ID of the Availability Zone or the Local Zone where the bucket is created. An example Zone ID value for an Availability Zone is usw2-az1.

    This functionality is only supported by directory buckets.

    BucketRegion?: string

    The Region that the bucket is located.

    AccessPointAlias?: boolean

    Indicates whether the bucket name used in the request is an access point alias.

    For directory buckets, the value of this field is false.

    Settings

    Member Visibility

    On This Page

    Properties