Skip to content

S3ExportDestination

Source code in docs_src/capo_securityhub/types/s3_export_destination.py 
12
13
14
15
16
17
18
class S3ExportDestination(TypedDict, closed=True):
    bucket_arn: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The Amazon Resource Name (ARN) of the Amazon S3 bucket that Security Hub writes the export to. You must own the bucket, and its bucket policy must grant the Security Hub service principal (<code>exportv2.securityhub.amazonaws.com</code>) permission to write objects. For the required bucket policy, see the Examples section of <code>StartExportJobV2</code>.</p>"""
    kms_key_arn: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The ARN of the Amazon Web Services KMS key that Security Hub uses to encrypt the export objects with server-side encryption. The key policy must allow the Security Hub service principal (<code>exportv2.securityhub.amazonaws.com</code>) to use the key through Amazon S3. For the required key policy, see the Examples section of <code>StartExportJobV2</code>.</p> <p>The key must meet all of the following requirements:</p> <ul> <li> <p>It must be a symmetric key with a key usage of <code>ENCRYPT_DECRYPT</code>.</p> </li> <li> <p>It must be a single-Region key. Multi-Region keys, whose key IDs begin with <code>mrk-</code>, are rejected.</p> </li> <li> <p>You must specify the full key ARN. Key IDs and aliases are rejected.</p> </li> <li> <p>The key must be in the same Amazon Web Services account as the export job.</p> </li> <li> <p>The key must be in the same Amazon Web Services Region as the export job.</p> </li> <li> <p>The key must be in the <code>aws</code>, <code>aws-cn</code>, or <code>aws-us-gov</code> partition.</p> </li> </ul>"""
    object_prefix: NotRequired["capo_securityhub.types.s3_object_prefix.S3ObjectPrefix"]
    """<p>An optional key prefix that Security Hub prepends to the Amazon S3 object keys of the export output. Use a prefix to organize exports within the bucket. The value can be up to 512 characters.</p>"""

bucket_arn instance-attribute 

bucket_arn: NotRequired[NonEmptyString]

The Amazon Resource Name (ARN) of the Amazon S3 bucket that Security Hub writes the export to. You must own the bucket, and its bucket policy must grant the Security Hub service principal (exportv2.securityhub.amazonaws.com) permission to write objects. For the required bucket policy, see the Examples section of StartExportJobV2.

kms_key_arn instance-attribute 

kms_key_arn: NotRequired[NonEmptyString]

The ARN of the Amazon Web Services KMS key that Security Hub uses to encrypt the export objects with server-side encryption. The key policy must allow the Security Hub service principal (exportv2.securityhub.amazonaws.com) to use the key through Amazon S3. For the required key policy, see the Examples section of StartExportJobV2.

The key must meet all of the following requirements:

  • It must be a symmetric key with a key usage of ENCRYPT_DECRYPT.

  • It must be a single-Region key. Multi-Region keys, whose key IDs begin with mrk-, are rejected.

  • You must specify the full key ARN. Key IDs and aliases are rejected.

  • The key must be in the same Amazon Web Services account as the export job.

  • The key must be in the same Amazon Web Services Region as the export job.

  • The key must be in the aws, aws-cn, or aws-us-gov partition.

object_prefix instance-attribute 

object_prefix: NotRequired[S3ObjectPrefix]

An optional key prefix that Security Hub prepends to the Amazon S3 object keys of the export output. Use a prefix to organize exports within the bucket. The value can be up to 512 characters.