Package software.amazon.awssdk.services.macie2.model

Interface BucketMetadata.Builder

    • Method Detail

      • accountId

        BucketMetadata.Builder accountId​(String accountId)

        The unique identifier for the Amazon Web Services account that owns the bucket.

        Parameters:
        accountId - The unique identifier for the Amazon Web Services account that owns the bucket.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • allowsUnencryptedObjectUploads

        BucketMetadata.Builder allowsUnencryptedObjectUploads​(String allowsUnencryptedObjectUploads)

        Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are added to the bucket. Possible values are:

        • FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include a valid server-side encryption header.

        • TRUE - The bucket doesn't have a bucket policy or it has a bucket policy that doesn't require server-side encryption of new objects. If a bucket policy exists, it doesn't require PutObject requests to include a valid server-side encryption header.

        • UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of new objects.

        Valid server-side encryption headers are: x-amz-server-side-encryption with a value of AES256 or aws:kms, and x-amz-server-side-encryption-customer-algorithm with a value of AES256.

        Parameters:
        allowsUnencryptedObjectUploads - Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are added to the bucket. Possible values are:

        • FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include a valid server-side encryption header.

        • TRUE - The bucket doesn't have a bucket policy or it has a bucket policy that doesn't require server-side encryption of new objects. If a bucket policy exists, it doesn't require PutObject requests to include a valid server-side encryption header.

        • UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of new objects.

        Valid server-side encryption headers are: x-amz-server-side-encryption with a value of AES256 or aws:kms, and x-amz-server-side-encryption-customer-algorithm with a value of AES256.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AllowsUnencryptedObjectUploads, AllowsUnencryptedObjectUploads

      • allowsUnencryptedObjectUploads

        BucketMetadata.Builder allowsUnencryptedObjectUploads​(AllowsUnencryptedObjectUploads allowsUnencryptedObjectUploads)

        Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are added to the bucket. Possible values are:

        • FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include a valid server-side encryption header.

        • TRUE - The bucket doesn't have a bucket policy or it has a bucket policy that doesn't require server-side encryption of new objects. If a bucket policy exists, it doesn't require PutObject requests to include a valid server-side encryption header.

        • UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of new objects.

        Valid server-side encryption headers are: x-amz-server-side-encryption with a value of AES256 or aws:kms, and x-amz-server-side-encryption-customer-algorithm with a value of AES256.

        Parameters:
        allowsUnencryptedObjectUploads - Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are added to the bucket. Possible values are:

        • FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include a valid server-side encryption header.

        • TRUE - The bucket doesn't have a bucket policy or it has a bucket policy that doesn't require server-side encryption of new objects. If a bucket policy exists, it doesn't require PutObject requests to include a valid server-side encryption header.

        • UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of new objects.

        Valid server-side encryption headers are: x-amz-server-side-encryption with a value of AES256 or aws:kms, and x-amz-server-side-encryption-customer-algorithm with a value of AES256.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AllowsUnencryptedObjectUploads, AllowsUnencryptedObjectUploads

      • bucketArn

        BucketMetadata.Builder bucketArn​(String bucketArn)

        The Amazon Resource Name (ARN) of the bucket.

        Parameters:
        bucketArn - The Amazon Resource Name (ARN) of the bucket.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • bucketCreatedAt

        BucketMetadata.Builder bucketCreatedAt​(Instant bucketCreatedAt)

        The date and time, in UTC and extended ISO 8601 format, when the bucket was created. This value can also indicate when changes such as edits to the bucket's policy were most recently made to the bucket.

        Parameters:
        bucketCreatedAt - The date and time, in UTC and extended ISO 8601 format, when the bucket was created. This value can also indicate when changes such as edits to the bucket's policy were most recently made to the bucket.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • bucketName

        BucketMetadata.Builder bucketName​(String bucketName)

        The name of the bucket.

        Parameters:
        bucketName - The name of the bucket.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • classifiableObjectCount

        BucketMetadata.Builder classifiableObjectCount​(Long classifiableObjectCount)

        The total number of objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.

        Parameters:
        classifiableObjectCount - The total number of objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • classifiableSizeInBytes

        BucketMetadata.Builder classifiableSizeInBytes​(Long classifiableSizeInBytes)

        The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.

        If versioning is enabled for the bucket, Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.

        Parameters:
        classifiableSizeInBytes - The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.

        If versioning is enabled for the bucket, Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • errorCode

        BucketMetadata.Builder errorCode​(String errorCode)

        The error code for an error that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. If this value is ACCESS_DENIED, Macie doesn't have permission to retrieve the information. For example, the bucket has a restrictive bucket policy and Amazon S3 denied the request. If this value is null, Macie was able to retrieve and process the information.

        Parameters:
        errorCode - The error code for an error that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. If this value is ACCESS_DENIED, Macie doesn't have permission to retrieve the information. For example, the bucket has a restrictive bucket policy and Amazon S3 denied the request. If this value is null, Macie was able to retrieve and process the information.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        BucketMetadataErrorCode, BucketMetadataErrorCode

      • errorCode

        BucketMetadata.Builder errorCode​(BucketMetadataErrorCode errorCode)

        The error code for an error that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. If this value is ACCESS_DENIED, Macie doesn't have permission to retrieve the information. For example, the bucket has a restrictive bucket policy and Amazon S3 denied the request. If this value is null, Macie was able to retrieve and process the information.

        Parameters:
        errorCode - The error code for an error that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. If this value is ACCESS_DENIED, Macie doesn't have permission to retrieve the information. For example, the bucket has a restrictive bucket policy and Amazon S3 denied the request. If this value is null, Macie was able to retrieve and process the information.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        BucketMetadataErrorCode, BucketMetadataErrorCode

      • errorMessage

        BucketMetadata.Builder errorMessage​(String errorMessage)

        A brief description of the error (errorCode) that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. This value is null if Macie was able to retrieve and process the information.

        Parameters:
        errorMessage - A brief description of the error (errorCode) that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. This value is null if Macie was able to retrieve and process the information.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • jobDetails

        BucketMetadata.Builder jobDetails​(JobDetails jobDetails)

        Specifies whether any one-time or recurring classification jobs are configured to analyze data in the bucket, and, if so, the details of the job that ran most recently.

        Parameters:
        jobDetails - Specifies whether any one-time or recurring classification jobs are configured to analyze data in the bucket, and, if so, the details of the job that ran most recently.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lastAutomatedDiscoveryTime

        BucketMetadata.Builder lastAutomatedDiscoveryTime​(Instant lastAutomatedDiscoveryTime)

        The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently analyzed data in the bucket while performing automated sensitive data discovery for your account. This value is null if automated sensitive data discovery is currently disabled for your account.

        Parameters:
        lastAutomatedDiscoveryTime - The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently analyzed data in the bucket while performing automated sensitive data discovery for your account. This value is null if automated sensitive data discovery is currently disabled for your account.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lastUpdated

        BucketMetadata.Builder lastUpdated​(Instant lastUpdated)

        The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved bucket or object metadata from Amazon S3 for the bucket.

        Parameters:
        lastUpdated - The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved bucket or object metadata from Amazon S3 for the bucket.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • objectCount

        BucketMetadata.Builder objectCount​(Long objectCount)

        The total number of objects in the bucket.

        Parameters:
        objectCount - The total number of objects in the bucket.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • objectCountByEncryptionType

        BucketMetadata.Builder objectCountByEncryptionType​(ObjectCountByEncryptionType objectCountByEncryptionType)

        The total number of objects in the bucket, grouped by server-side encryption type. This includes a grouping that reports the total number of objects that aren't encrypted or use client-side encryption.

        Parameters:
        objectCountByEncryptionType - The total number of objects in the bucket, grouped by server-side encryption type. This includes a grouping that reports the total number of objects that aren't encrypted or use client-side encryption.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • publicAccess

        BucketMetadata.Builder publicAccess​(BucketPublicAccess publicAccess)

        Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket, and provides information about those settings.

        Parameters:
        publicAccess - Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket, and provides information about those settings.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • region

        BucketMetadata.Builder region​(String region)

        The Amazon Web Services Region that hosts the bucket.

        Parameters:
        region - The Amazon Web Services Region that hosts the bucket.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • replicationDetails

        BucketMetadata.Builder replicationDetails​(ReplicationDetails replicationDetails)

        Specifies whether the bucket is configured to replicate one or more objects to buckets for other Amazon Web Services accounts and, if so, which accounts.

        Parameters:
        replicationDetails - Specifies whether the bucket is configured to replicate one or more objects to buckets for other Amazon Web Services accounts and, if so, which accounts.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sensitivityScore

        BucketMetadata.Builder sensitivityScore​(Integer sensitivityScore)

        The sensitivity score for the bucket, ranging from -1 (classification error) to 100 (sensitive). This value is null if automated sensitive data discovery is currently disabled for your account.

        Parameters:
        sensitivityScore - The sensitivity score for the bucket, ranging from -1 (classification error) to 100 (sensitive). This value is null if automated sensitive data discovery is currently disabled for your account.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • serverSideEncryption

        BucketMetadata.Builder serverSideEncryption​(BucketServerSideEncryption serverSideEncryption)

        The default server-side encryption settings for the bucket.

        Parameters:
        serverSideEncryption - The default server-side encryption settings for the bucket.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sharedAccess

        BucketMetadata.Builder sharedAccess​(String sharedAccess)

        Specifies whether the bucket is shared with another Amazon Web Services account, an Amazon CloudFront origin access identity (OAI), or a CloudFront origin access control (OAC). Possible values are:

        • EXTERNAL - The bucket is shared with one or more of the following or any combination of the following: a CloudFront OAI, a CloudFront OAC, or an Amazon Web Services account that isn't part of your Amazon Macie organization.

        • INTERNAL - The bucket is shared with one or more Amazon Web Services accounts that are part of your Amazon Macie organization. It isn't shared with a CloudFront OAI or OAC.

        • NOT_SHARED - The bucket isn't shared with another Amazon Web Services account, a CloudFront OAI, or a CloudFront OAC.

        • UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.

        An Amazon Macie organization is a set of Macie accounts that are centrally managed as a group of related accounts through Organizations or by Macie invitation.

        Parameters:
        sharedAccess - Specifies whether the bucket is shared with another Amazon Web Services account, an Amazon CloudFront origin access identity (OAI), or a CloudFront origin access control (OAC). Possible values are:

        • EXTERNAL - The bucket is shared with one or more of the following or any combination of the following: a CloudFront OAI, a CloudFront OAC, or an Amazon Web Services account that isn't part of your Amazon Macie organization.

        • INTERNAL - The bucket is shared with one or more Amazon Web Services accounts that are part of your Amazon Macie organization. It isn't shared with a CloudFront OAI or OAC.

        • NOT_SHARED - The bucket isn't shared with another Amazon Web Services account, a CloudFront OAI, or a CloudFront OAC.

        • UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.

        An Amazon Macie organization is a set of Macie accounts that are centrally managed as a group of related accounts through Organizations or by Macie invitation.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SharedAccess, SharedAccess

      • sharedAccess

        BucketMetadata.Builder sharedAccess​(SharedAccess sharedAccess)

        Specifies whether the bucket is shared with another Amazon Web Services account, an Amazon CloudFront origin access identity (OAI), or a CloudFront origin access control (OAC). Possible values are:

        • EXTERNAL - The bucket is shared with one or more of the following or any combination of the following: a CloudFront OAI, a CloudFront OAC, or an Amazon Web Services account that isn't part of your Amazon Macie organization.

        • INTERNAL - The bucket is shared with one or more Amazon Web Services accounts that are part of your Amazon Macie organization. It isn't shared with a CloudFront OAI or OAC.

        • NOT_SHARED - The bucket isn't shared with another Amazon Web Services account, a CloudFront OAI, or a CloudFront OAC.

        • UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.

        An Amazon Macie organization is a set of Macie accounts that are centrally managed as a group of related accounts through Organizations or by Macie invitation.

        Parameters:
        sharedAccess - Specifies whether the bucket is shared with another Amazon Web Services account, an Amazon CloudFront origin access identity (OAI), or a CloudFront origin access control (OAC). Possible values are:

        • EXTERNAL - The bucket is shared with one or more of the following or any combination of the following: a CloudFront OAI, a CloudFront OAC, or an Amazon Web Services account that isn't part of your Amazon Macie organization.

        • INTERNAL - The bucket is shared with one or more Amazon Web Services accounts that are part of your Amazon Macie organization. It isn't shared with a CloudFront OAI or OAC.

        • NOT_SHARED - The bucket isn't shared with another Amazon Web Services account, a CloudFront OAI, or a CloudFront OAC.

        • UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.

        An Amazon Macie organization is a set of Macie accounts that are centrally managed as a group of related accounts through Organizations or by Macie invitation.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SharedAccess, SharedAccess

      • sizeInBytes

        BucketMetadata.Builder sizeInBytes​(Long sizeInBytes)

        The total storage size, in bytes, of the bucket.

        If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each object in the bucket. This value doesn't reflect the storage size of all versions of each object in the bucket.

        Parameters:
        sizeInBytes - The total storage size, in bytes, of the bucket.

        If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each object in the bucket. This value doesn't reflect the storage size of all versions of each object in the bucket.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sizeInBytesCompressed

        BucketMetadata.Builder sizeInBytesCompressed​(Long sizeInBytesCompressed)

        The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the bucket.

        If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.

        Parameters:
        sizeInBytesCompressed - The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the bucket.

        If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        BucketMetadata.Builder tags​(Collection<KeyValuePair> tags)

        An array that specifies the tags (keys and values) that are associated with the bucket.

        Parameters:
        tags - An array that specifies the tags (keys and values) that are associated with the bucket.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        BucketMetadata.Builder tags​(KeyValuePair... tags)

        An array that specifies the tags (keys and values) that are associated with the bucket.

        Parameters:
        tags - An array that specifies the tags (keys and values) that are associated with the bucket.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • unclassifiableObjectCount

        BucketMetadata.Builder unclassifiableObjectCount​(ObjectLevelStatistics unclassifiableObjectCount)

        The total number of objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.

        Parameters:
        unclassifiableObjectCount - The total number of objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • unclassifiableObjectSizeInBytes

        BucketMetadata.Builder unclassifiableObjectSizeInBytes​(ObjectLevelStatistics unclassifiableObjectSizeInBytes)

        The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.

        Parameters:
        unclassifiableObjectSizeInBytes - The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • versioning

        BucketMetadata.Builder versioning​(Boolean versioning)

        Specifies whether versioning is enabled for the bucket.

        Parameters:
        versioning - Specifies whether versioning is enabled for the bucket.
        Returns:
        Returns a reference to this object so that method calls can be chained together.