# Module `netapp_ontap.models.xc_s3_bucket`

Copyright © 2022 NetApp Inc. All rights reserved.

## Classes

`class XcS3BucketSchema (*, only: Union[Sequence[str], Set[str]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Dict = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: str = None)`

  The fields of the XcS3Bucket object

  ### Ancestors

  - netapp_ontap.resource.ResourceSchema
  - marshmallow.schema.Schema
  - marshmallow.base.SchemaABC

  ### Class variables

  `aggregates POST`

    A list of aggregates for FlexGroup volume constituents where the bucket is hosted. If this option is not specified, the bucket is auto-provisioned as a FlexGroup volume.

  `audit_event_selector GET POST PATCH`

    The audit_event_selector field of the xc_s3_bucket.

  `comment GET POST PATCH`

    Can contain any additional information about the bucket being created or modified.

    Example: S3 bucket.

  `constituents_per_aggregate POST`

    Specifies the number of constituents or FlexVol volumes per aggregate. A FlexGroup volume consisting of all such constituents across all specified aggregates is created. This option is used along with the aggregates option and cannot be used independently.

    Example: 4

  `encryption GET POST PATCH`

    The encryption field of the xc_s3_bucket.

  `links GET`

    The links field of the xc_s3_bucket.

  `logical_used_size GET`

    Specifies the bucket logical used size up to this point.

  `name GET POST`

    Specifies the name of the bucket. Bucket name is a string that can only contain the following combination of ASCII-range alphanumeric characters 0-9, a-z, ".", and "-".

    Example: bucket1

  `policy GET POST PATCH`

    The policy field of the xc_s3_bucket.

  `protection_status GET POST PATCH`

    The protection_status field of the xc_s3_bucket.

  `qos_policy GET POST PATCH`

    The qos_policy field of the xc_s3_bucket.

  `role GET`

    Specifies the role of the bucket.

    Valid choices:

    - standalone
    - active
    - passive
  `size GET POST PATCH`

    Specifies the bucket size in bytes; ranges from 80MB to 64TB.

    Example: 1677721600

  `storage_service_level POST`

    Specifies the storage service level of the FlexGroup volume on which the bucket should be created. Valid values are "value", "performance" or "extreme".

    Valid choices:

    - value
    - performance
    - extreme
  `svm GET POST`

    The svm field of the xc_s3_bucket.

  `uuid GET`

    Specifies the unique identifier of the bucket.

    Example: 414b29a1-3b26-11e9-bd58-0050568ea055

  `volume GET POST PATCH`

    The volume field of the xc_s3_bucket.