Struct aws_sdk_macie2::types::builders::BucketMetadataBuilder

#[non_exhaustive]
pub struct BucketMetadataBuilder { /* private fields */ }

A builder for BucketMetadata.

Implementations

impl BucketMetadataBuilder

pub fn account_id(self, input: impl Into<String>) -> Self

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

pub fn set_account_id(self, input: Option<String>) -> Self

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

pub fn get_account_id(&self) -> &Option<String>

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

pub fn allows_unencrypted_object_uploads( self, input: AllowsUnencryptedObjectUploads ) -> Self

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.

pub fn set_allows_unencrypted_object_uploads( self, input: Option<AllowsUnencryptedObjectUploads> ) -> Self

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.

pub fn get_allows_unencrypted_object_uploads( &self ) -> &Option<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.

pub fn bucket_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the bucket.

pub fn set_bucket_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the bucket.

pub fn get_bucket_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) of the bucket.

pub fn bucket_created_at(self, input: DateTime) -> Self

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.

pub fn set_bucket_created_at(self, input: Option<DateTime>) -> Self

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.

pub fn get_bucket_created_at(&self) -> &Option<DateTime>

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.

pub fn bucket_name(self, input: impl Into<String>) -> Self

The name of the bucket.

pub fn set_bucket_name(self, input: Option<String>) -> Self

The name of the bucket.

pub fn get_bucket_name(&self) -> &Option<String>

The name of the bucket.

pub fn classifiable_object_count(self, input: i64) -> Self

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.

pub fn set_classifiable_object_count(self, input: Option<i64>) -> Self

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.

pub fn get_classifiable_object_count(&self) -> &Option<i64>

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.

pub fn classifiable_size_in_bytes(self, input: i64) -> Self

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.

pub fn set_classifiable_size_in_bytes(self, input: Option<i64>) -> Self

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.

pub fn get_classifiable_size_in_bytes(&self) -> &Option<i64>

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.

pub fn error_code(self, input: BucketMetadataErrorCode) -> Self

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.

pub fn set_error_code(self, input: Option<BucketMetadataErrorCode>) -> Self

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.

pub fn get_error_code(&self) -> &Option<BucketMetadataErrorCode>

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.

pub fn error_message(self, input: impl Into<String>) -> Self

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.

pub fn set_error_message(self, input: Option<String>) -> Self

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.

pub fn get_error_message(&self) -> &Option<String>

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.

pub fn job_details(self, input: JobDetails) -> Self

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.

pub fn set_job_details(self, input: Option<JobDetails>) -> Self

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.

pub fn get_job_details(&self) -> &Option<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.

pub fn last_automated_discovery_time(self, input: DateTime) -> Self

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.

pub fn set_last_automated_discovery_time(self, input: Option<DateTime>) -> Self

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.

pub fn get_last_automated_discovery_time(&self) -> &Option<DateTime>

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.

pub fn last_updated(self, input: DateTime) -> Self

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.

pub fn set_last_updated(self, input: Option<DateTime>) -> Self

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.

pub fn get_last_updated(&self) -> &Option<DateTime>

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.

pub fn object_count(self, input: i64) -> Self

The total number of objects in the bucket.

pub fn set_object_count(self, input: Option<i64>) -> Self

The total number of objects in the bucket.

pub fn get_object_count(&self) -> &Option<i64>

The total number of objects in the bucket.

pub fn object_count_by_encryption_type( self, input: ObjectCountByEncryptionType ) -> Self

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.

pub fn set_object_count_by_encryption_type( self, input: Option<ObjectCountByEncryptionType> ) -> Self

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.

pub fn get_object_count_by_encryption_type( &self ) -> &Option<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.

pub fn public_access(self, input: BucketPublicAccess) -> Self

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.

pub fn set_public_access(self, input: Option<BucketPublicAccess>) -> Self

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.

pub fn get_public_access(&self) -> &Option<BucketPublicAccess>

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.

pub fn region(self, input: impl Into<String>) -> Self

The Amazon Web Services Region that hosts the bucket.

pub fn set_region(self, input: Option<String>) -> Self

The Amazon Web Services Region that hosts the bucket.

pub fn get_region(&self) -> &Option<String>

The Amazon Web Services Region that hosts the bucket.

pub fn replication_details(self, input: ReplicationDetails) -> Self

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.

pub fn set_replication_details(self, input: Option<ReplicationDetails>) -> Self

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.

pub fn get_replication_details(&self) -> &Option<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.

pub fn sensitivity_score(self, input: i32) -> Self

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.

pub fn set_sensitivity_score(self, input: Option<i32>) -> Self

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.

pub fn get_sensitivity_score(&self) -> &Option<i32>

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.

pub fn server_side_encryption(self, input: BucketServerSideEncryption) -> Self

The default server-side encryption settings for the bucket.

pub fn set_server_side_encryption( self, input: Option<BucketServerSideEncryption> ) -> Self

The default server-side encryption settings for the bucket.

pub fn get_server_side_encryption(&self) -> &Option<BucketServerSideEncryption>

The default server-side encryption settings for the bucket.

pub fn shared_access(self, input: SharedAccess) -> Self

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.

pub fn set_shared_access(self, input: Option<SharedAccess>) -> Self

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.

pub fn get_shared_access(&self) -> &Option<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.

pub fn size_in_bytes(self, input: i64) -> Self

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.

pub fn set_size_in_bytes(self, input: Option<i64>) -> Self

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.

pub fn get_size_in_bytes(&self) -> &Option<i64>

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.

pub fn size_in_bytes_compressed(self, input: i64) -> Self

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.

pub fn set_size_in_bytes_compressed(self, input: Option<i64>) -> Self

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.

pub fn get_size_in_bytes_compressed(&self) -> &Option<i64>

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.

pub fn tags(self, input: KeyValuePair) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

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

pub fn set_tags(self, input: Option<Vec<KeyValuePair>>) -> Self

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

pub fn get_tags(&self) -> &Option<Vec<KeyValuePair>>

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

pub fn unclassifiable_object_count(self, input: ObjectLevelStatistics) -> Self

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.

pub fn set_unclassifiable_object_count( self, input: Option<ObjectLevelStatistics> ) -> Self

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.

pub fn get_unclassifiable_object_count(&self) -> &Option<ObjectLevelStatistics>

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.

pub fn unclassifiable_object_size_in_bytes( self, input: ObjectLevelStatistics ) -> Self

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.

pub fn set_unclassifiable_object_size_in_bytes( self, input: Option<ObjectLevelStatistics> ) -> Self

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.

pub fn get_unclassifiable_object_size_in_bytes( &self ) -> &Option<ObjectLevelStatistics>

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.

pub fn versioning(self, input: bool) -> Self

Specifies whether versioning is enabled for the bucket.

pub fn set_versioning(self, input: Option<bool>) -> Self

Specifies whether versioning is enabled for the bucket.

pub fn get_versioning(&self) -> &Option<bool>

Specifies whether versioning is enabled for the bucket.

pub fn build(self) -> BucketMetadata

Consumes the builder and constructs a BucketMetadata.

Trait Implementations

impl Clone for BucketMetadataBuilder

fn clone(&self) -> BucketMetadataBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BucketMetadataBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for BucketMetadataBuilder

fn default() -> BucketMetadataBuilder

Returns the “default value” for a type.

impl PartialEq for BucketMetadataBuilder

fn eq(&self, other: &BucketMetadataBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BucketMetadataBuilder