@renovosolutions/cdk-library-crowdstrike-ingestion
Version:
A CDK library to ease repetetive construct creation for CrowdStrike data ingestion
1,100 lines (655 loc) • 102 kB
Markdown
# API Reference <a name="API Reference" id="api-reference"></a>
## Constructs <a name="Constructs" id="Constructs"></a>
### CrowdStrikeBucket <a name="CrowdStrikeBucket" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket"></a>
A construct that creates an S3 bucket for CrowdStrike data ingestion, along with an SQS queue for notifications, an IAM role for access, and optionally a KMS key for encryption.
#### Initializers <a name="Initializers" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.Initializer"></a>
```typescript
import { CrowdStrikeBucket } from '@renovosolutions/cdk-library-crowdstrike-ingestion'
new CrowdStrikeBucket(scope: Construct, id: string, props: CrowdStrikeBucketProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | The scope in which this construct is defined. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.Initializer.parameter.id">id</a></code> | <code>string</code> | The scoped construct ID. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.Initializer.parameter.props">props</a></code> | <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucketProps">CrowdStrikeBucketProps</a></code> | The properties for the bucket, queue, role, and optional KMS key. |
---
##### `scope`<sup>Required</sup> <a name="scope" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.Initializer.parameter.scope"></a>
- *Type:* constructs.Construct
The scope in which this construct is defined.
---
##### `id`<sup>Required</sup> <a name="id" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.Initializer.parameter.id"></a>
- *Type:* string
The scoped construct ID.
---
##### `props`<sup>Required</sup> <a name="props" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.Initializer.parameter.props"></a>
- *Type:* <a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucketProps">CrowdStrikeBucketProps</a>
The properties for the bucket, queue, role, and optional KMS key.
---
#### Methods <a name="Methods" id="Methods"></a>
| **Name** | **Description** |
| --- | --- |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.toString">toString</a></code> | Returns a string representation of this construct. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.with">with</a></code> | Applies one or more mixins to this construct. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addEventNotification">addEventNotification</a></code> | Adds a bucket notification event destination. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addObjectCreatedNotification">addObjectCreatedNotification</a></code> | Subscribes a destination to receive notifications when an object is created in the bucket. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addObjectRemovedNotification">addObjectRemovedNotification</a></code> | Subscribes a destination to receive notifications when an object is removed from the bucket. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addReplicationPolicy">addReplicationPolicy</a></code> | Function to add required permissions to the destination bucket for cross account replication. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addToResourcePolicy">addToResourcePolicy</a></code> | Adds a statement to the resource policy for a principal (i.e. account/role/service) to perform actions on this bucket and/or its contents. Use `bucketArn` and `arnForObjects(keys)` to obtain ARNs for this bucket or objects. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.arnForObjects">arnForObjects</a></code> | Returns an ARN that represents all objects within the bucket that match the key pattern specified. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.enableEventBridgeNotification">enableEventBridgeNotification</a></code> | Enables event bridge notification, causing all events below to be sent to EventBridge:. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantDelete">grantDelete</a></code> | Grants s3:DeleteObject* permission to an IAM principal for objects in this bucket. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantOnKey">grantOnKey</a></code> | Gives permissions to a grantable entity to perform actions on the encryption key. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantPublicAccess">grantPublicAccess</a></code> | Allows unrestricted access to objects from this bucket. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantPut">grantPut</a></code> | Grants s3:PutObject* and s3:Abort* permissions for this bucket to an IAM principal. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantPutAcl">grantPutAcl</a></code> | The use of this method is discouraged. Please use `grants.putAcl()` instead. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantRead">grantRead</a></code> | Grant read permissions for this bucket and it's contents to an IAM principal (Role/Group/User). |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantReadWrite">grantReadWrite</a></code> | The use of this method is discouraged. Please use `grants.readWrite()` instead. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantReplicationPermission">grantReplicationPermission</a></code> | Grant replication permission to a principal. This method allows the principal to perform replication operations on this bucket. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantWrite">grantWrite</a></code> | The use of this method is discouraged. Please use `grants.write()` instead. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.onCloudTrailEvent">onCloudTrailEvent</a></code> | Define a CloudWatch event that triggers when something happens to this repository. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.onCloudTrailPutObject">onCloudTrailPutObject</a></code> | Defines an AWS CloudWatch event that triggers when an object is uploaded to the specified paths (keys) in this bucket using the PutObject API call. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.onCloudTrailWriteObject">onCloudTrailWriteObject</a></code> | Defines an AWS CloudWatch event that triggers when an object at the specified paths (keys) in this bucket are written to. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.s3UrlForObject">s3UrlForObject</a></code> | The S3 URL of an S3 object. For example:. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.transferAccelerationUrlForObject">transferAccelerationUrlForObject</a></code> | The https Transfer Acceleration URL of an S3 object. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.urlForObject">urlForObject</a></code> | The https URL of an S3 object. Specify `regional: false` at the options for non-regional URLs. For example:. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.virtualHostedUrlForObject">virtualHostedUrlForObject</a></code> | The virtual hosted-style URL of an S3 object. Specify `regional: false` at the options for non-regional URL. For example:. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addCorsRule">addCorsRule</a></code> | Adds a cross-origin access configuration for objects in an Amazon S3 bucket. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addInventory">addInventory</a></code> | Add an inventory configuration. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addLifecycleRule">addLifecycleRule</a></code> | Add a lifecycle rule to the bucket. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addMetric">addMetric</a></code> | Adds a metrics configuration for the CloudWatch request metrics from the bucket. |
---
##### `toString` <a name="toString" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.toString"></a>
```typescript
public toString(): string
```
Returns a string representation of this construct.
##### `with` <a name="with" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.with"></a>
```typescript
public with(mixins: ...IMixin[]): IConstruct
```
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple `with()` calls if subsequent mixins should apply to added
constructs.
###### `mixins`<sup>Required</sup> <a name="mixins" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.with.parameter.mixins"></a>
- *Type:* ...constructs.IMixin[]
The mixins to apply.
---
##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.applyRemovalPolicy"></a>
```typescript
public applyRemovalPolicy(policy: RemovalPolicy): void
```
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops
being managed by CloudFormation, either because you've removed it from the
CDK application or because you've made a change that requires the resource
to be replaced.
The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
###### `policy`<sup>Required</sup> <a name="policy" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.applyRemovalPolicy.parameter.policy"></a>
- *Type:* aws-cdk-lib.RemovalPolicy
---
##### `addEventNotification` <a name="addEventNotification" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addEventNotification"></a>
```typescript
public addEventNotification(event: EventType, dest: IBucketNotificationDestination, filters: ...NotificationKeyFilter[]): void
```
Adds a bucket notification event destination.
> [https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html)
*Example*
```typescript
declare const myLambda: lambda.Function;
const bucket = new s3.Bucket(this, 'MyBucket');
bucket.addEventNotification(s3.EventType.OBJECT_CREATED, new s3n.LambdaDestination(myLambda), {prefix: 'home/myusername/*'});
```
###### `event`<sup>Required</sup> <a name="event" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addEventNotification.parameter.event"></a>
- *Type:* aws-cdk-lib.aws_s3.EventType
The event to trigger the notification.
---
###### `dest`<sup>Required</sup> <a name="dest" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addEventNotification.parameter.dest"></a>
- *Type:* aws-cdk-lib.aws_s3.IBucketNotificationDestination
The notification destination (Lambda, SNS Topic or SQS Queue).
---
###### `filters`<sup>Required</sup> <a name="filters" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addEventNotification.parameter.filters"></a>
- *Type:* ...aws-cdk-lib.aws_s3.NotificationKeyFilter[]
S3 object key filter rules to determine which objects trigger this event.
Each filter must include a `prefix` and/or `suffix`
that will be matched against the s3 object key. Refer to the S3 Developer Guide
for details about allowed filter rules.
---
##### `addObjectCreatedNotification` <a name="addObjectCreatedNotification" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addObjectCreatedNotification"></a>
```typescript
public addObjectCreatedNotification(dest: IBucketNotificationDestination, filters: ...NotificationKeyFilter[]): void
```
Subscribes a destination to receive notifications when an object is created in the bucket.
This is identical to calling
`onEvent(EventType.OBJECT_CREATED)`.
###### `dest`<sup>Required</sup> <a name="dest" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addObjectCreatedNotification.parameter.dest"></a>
- *Type:* aws-cdk-lib.aws_s3.IBucketNotificationDestination
The notification destination (see onEvent).
---
###### `filters`<sup>Required</sup> <a name="filters" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addObjectCreatedNotification.parameter.filters"></a>
- *Type:* ...aws-cdk-lib.aws_s3.NotificationKeyFilter[]
Filters (see onEvent).
---
##### `addObjectRemovedNotification` <a name="addObjectRemovedNotification" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addObjectRemovedNotification"></a>
```typescript
public addObjectRemovedNotification(dest: IBucketNotificationDestination, filters: ...NotificationKeyFilter[]): void
```
Subscribes a destination to receive notifications when an object is removed from the bucket.
This is identical to calling
`onEvent(EventType.OBJECT_REMOVED)`.
###### `dest`<sup>Required</sup> <a name="dest" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addObjectRemovedNotification.parameter.dest"></a>
- *Type:* aws-cdk-lib.aws_s3.IBucketNotificationDestination
The notification destination (see onEvent).
---
###### `filters`<sup>Required</sup> <a name="filters" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addObjectRemovedNotification.parameter.filters"></a>
- *Type:* ...aws-cdk-lib.aws_s3.NotificationKeyFilter[]
Filters (see onEvent).
---
##### `addReplicationPolicy` <a name="addReplicationPolicy" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addReplicationPolicy"></a>
```typescript
public addReplicationPolicy(roleArn: string, accessControlTransition?: boolean, account?: string): void
```
Function to add required permissions to the destination bucket for cross account replication.
These permissions will be added as a resource based policy on the bucket
> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-accesscontroltranslation.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-accesscontroltranslation.html)
###### `roleArn`<sup>Required</sup> <a name="roleArn" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addReplicationPolicy.parameter.roleArn"></a>
- *Type:* string
---
###### `accessControlTransition`<sup>Optional</sup> <a name="accessControlTransition" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addReplicationPolicy.parameter.accessControlTransition"></a>
- *Type:* boolean
---
###### `account`<sup>Optional</sup> <a name="account" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addReplicationPolicy.parameter.account"></a>
- *Type:* string
---
##### `addToResourcePolicy` <a name="addToResourcePolicy" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addToResourcePolicy"></a>
```typescript
public addToResourcePolicy(permission: PolicyStatement): AddToResourcePolicyResult
```
Adds a statement to the resource policy for a principal (i.e. account/role/service) to perform actions on this bucket and/or its contents. Use `bucketArn` and `arnForObjects(keys)` to obtain ARNs for this bucket or objects.
Note that the policy statement may or may not be added to the policy.
For example, when an `IBucket` is created from an existing bucket,
it's not possible to tell whether the bucket already has a policy
attached, let alone to re-use that policy to add more statements to it.
So it's safest to do nothing in these cases.
###### `permission`<sup>Required</sup> <a name="permission" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addToResourcePolicy.parameter.permission"></a>
- *Type:* aws-cdk-lib.aws_iam.PolicyStatement
the policy statement to be added to the bucket's policy.
---
##### `arnForObjects` <a name="arnForObjects" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.arnForObjects"></a>
```typescript
public arnForObjects(keyPattern: string): string
```
Returns an ARN that represents all objects within the bucket that match the key pattern specified.
To represent all keys, specify ``"*"``.
If you need to specify a keyPattern with multiple components, concatenate them into a single string, e.g.:
arnForObjects(`home/${team}/${user}/*`)
###### `keyPattern`<sup>Required</sup> <a name="keyPattern" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.arnForObjects.parameter.keyPattern"></a>
- *Type:* string
---
##### `enableEventBridgeNotification` <a name="enableEventBridgeNotification" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.enableEventBridgeNotification"></a>
```typescript
public enableEventBridgeNotification(): void
```
Enables event bridge notification, causing all events below to be sent to EventBridge:.
Object Deleted (DeleteObject)
- Object Deleted (Lifecycle expiration)
- Object Restore Initiated
- Object Restore Completed
- Object Restore Expired
- Object Storage Class Changed
- Object Access Tier Changed
- Object ACL Updated
- Object Tags Added
- Object Tags Deleted
##### `grantDelete` <a name="grantDelete" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantDelete"></a>
```typescript
public grantDelete(identity: IGrantable, objectsKeyPattern?: any): Grant
```
Grants s3:DeleteObject* permission to an IAM principal for objects in this bucket.
The use of this method is discouraged. Please use `grants.delete()` instead.
[disable-awslint:no-grants]
###### `identity`<sup>Required</sup> <a name="identity" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantDelete.parameter.identity"></a>
- *Type:* aws-cdk-lib.aws_iam.IGrantable
The principal.
---
###### `objectsKeyPattern`<sup>Optional</sup> <a name="objectsKeyPattern" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantDelete.parameter.objectsKeyPattern"></a>
- *Type:* any
Restrict the permission to a certain key pattern (default '*').
Parameter type is `any` but `string` should be passed in.
---
##### `grantOnKey` <a name="grantOnKey" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantOnKey"></a>
```typescript
public grantOnKey(grantee: IGrantable, actions: ...string[]): GrantOnKeyResult
```
Gives permissions to a grantable entity to perform actions on the encryption key.
###### `grantee`<sup>Required</sup> <a name="grantee" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantOnKey.parameter.grantee"></a>
- *Type:* aws-cdk-lib.aws_iam.IGrantable
---
###### `actions`<sup>Required</sup> <a name="actions" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantOnKey.parameter.actions"></a>
- *Type:* ...string[]
---
##### `grantPublicAccess` <a name="grantPublicAccess" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantPublicAccess"></a>
```typescript
public grantPublicAccess(allowedActions: ...string[], keyPrefix?: string): Grant
```
Allows unrestricted access to objects from this bucket.
IMPORTANT: This permission allows anyone to perform actions on S3 objects
in this bucket, which is useful for when you configure your bucket as a
website and want everyone to be able to read objects in the bucket without
needing to authenticate.
Without arguments, this method will grant read ("s3:GetObject") access to
all objects ("*") in the bucket.
The method returns the `iam.Grant` object, which can then be modified
as needed. For example, you can add a condition that will restrict access only
to an IPv4 range like this:
const grant = bucket.grantPublicAccess();
grant.resourceStatement!.addCondition(‘IpAddress’, { “aws:SourceIp”: “54.240.143.0/24” });
Note that if this `IBucket` refers to an existing bucket, possibly not
managed by CloudFormation, this method will have no effect, since it's
impossible to modify the policy of an existing bucket.
The use of this method is discouraged. Please use `grants.publicAccess()` instead.
[disable-awslint:no-grants]
###### `allowedActions`<sup>Required</sup> <a name="allowedActions" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantPublicAccess.parameter.allowedActions"></a>
- *Type:* ...string[]
the set of S3 actions to allow.
Default is "s3:GetObject".
---
###### `keyPrefix`<sup>Optional</sup> <a name="keyPrefix" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantPublicAccess.parameter.keyPrefix"></a>
- *Type:* string
the prefix of S3 object keys (e.g. `home/*`). Default is "*".
---
##### `grantPut` <a name="grantPut" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantPut"></a>
```typescript
public grantPut(identity: IGrantable, objectsKeyPattern?: any): Grant
```
Grants s3:PutObject* and s3:Abort* permissions for this bucket to an IAM principal.
If encryption is used, permission to use the key to encrypt the contents
of written files will also be granted to the same principal.
The use of this method is discouraged. Please use `grants.put()` instead.
[disable-awslint:no-grants]
###### `identity`<sup>Required</sup> <a name="identity" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantPut.parameter.identity"></a>
- *Type:* aws-cdk-lib.aws_iam.IGrantable
The principal.
---
###### `objectsKeyPattern`<sup>Optional</sup> <a name="objectsKeyPattern" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantPut.parameter.objectsKeyPattern"></a>
- *Type:* any
Restrict the permission to a certain key pattern (default '*').
Parameter type is `any` but `string` should be passed in.
---
##### `grantPutAcl` <a name="grantPutAcl" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantPutAcl"></a>
```typescript
public grantPutAcl(identity: IGrantable, objectsKeyPattern?: string): Grant
```
The use of this method is discouraged. Please use `grants.putAcl()` instead.
[disable-awslint:no-grants]
###### `identity`<sup>Required</sup> <a name="identity" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantPutAcl.parameter.identity"></a>
- *Type:* aws-cdk-lib.aws_iam.IGrantable
---
###### `objectsKeyPattern`<sup>Optional</sup> <a name="objectsKeyPattern" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantPutAcl.parameter.objectsKeyPattern"></a>
- *Type:* string
---
##### `grantRead` <a name="grantRead" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantRead"></a>
```typescript
public grantRead(identity: IGrantable, objectsKeyPattern?: any): Grant
```
Grant read permissions for this bucket and it's contents to an IAM principal (Role/Group/User).
If encryption is used, permission to use the key to decrypt the contents
of the bucket will also be granted to the same principal.
The use of this method is discouraged. Please use `grants.read()` instead.
[disable-awslint:no-grants]
###### `identity`<sup>Required</sup> <a name="identity" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantRead.parameter.identity"></a>
- *Type:* aws-cdk-lib.aws_iam.IGrantable
The principal.
---
###### `objectsKeyPattern`<sup>Optional</sup> <a name="objectsKeyPattern" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantRead.parameter.objectsKeyPattern"></a>
- *Type:* any
Restrict the permission to a certain key pattern (default '*').
Parameter type is `any` but `string` should be passed in.
---
##### `grantReadWrite` <a name="grantReadWrite" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantReadWrite"></a>
```typescript
public grantReadWrite(identity: IGrantable, objectsKeyPattern?: any): Grant
```
The use of this method is discouraged. Please use `grants.readWrite()` instead.
[disable-awslint:no-grants]
###### `identity`<sup>Required</sup> <a name="identity" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantReadWrite.parameter.identity"></a>
- *Type:* aws-cdk-lib.aws_iam.IGrantable
---
###### `objectsKeyPattern`<sup>Optional</sup> <a name="objectsKeyPattern" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantReadWrite.parameter.objectsKeyPattern"></a>
- *Type:* any
---
##### `grantReplicationPermission` <a name="grantReplicationPermission" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantReplicationPermission"></a>
```typescript
public grantReplicationPermission(identity: IGrantable, props: GrantReplicationPermissionProps): Grant
```
Grant replication permission to a principal. This method allows the principal to perform replication operations on this bucket.
Note that when calling this function for source or destination buckets that support KMS encryption,
you need to specify the KMS key for encryption and the KMS key for decryption, respectively.
The use of this method is discouraged. Please use `grants.replicationPermission()` instead.
[disable-awslint:no-grants]
###### `identity`<sup>Required</sup> <a name="identity" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantReplicationPermission.parameter.identity"></a>
- *Type:* aws-cdk-lib.aws_iam.IGrantable
The principal to grant replication permission to.
---
###### `props`<sup>Required</sup> <a name="props" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantReplicationPermission.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_s3.GrantReplicationPermissionProps
The properties of the replication source and destination buckets.
---
##### `grantWrite` <a name="grantWrite" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantWrite"></a>
```typescript
public grantWrite(identity: IGrantable, objectsKeyPattern?: any, allowedActionPatterns?: string[]): Grant
```
The use of this method is discouraged. Please use `grants.write()` instead.
[disable-awslint:no-grants]
###### `identity`<sup>Required</sup> <a name="identity" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantWrite.parameter.identity"></a>
- *Type:* aws-cdk-lib.aws_iam.IGrantable
---
###### `objectsKeyPattern`<sup>Optional</sup> <a name="objectsKeyPattern" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantWrite.parameter.objectsKeyPattern"></a>
- *Type:* any
---
###### `allowedActionPatterns`<sup>Optional</sup> <a name="allowedActionPatterns" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.grantWrite.parameter.allowedActionPatterns"></a>
- *Type:* string[]
---
##### `onCloudTrailEvent` <a name="onCloudTrailEvent" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.onCloudTrailEvent"></a>
```typescript
public onCloudTrailEvent(id: string, options?: OnCloudTrailBucketEventOptions): Rule
```
Define a CloudWatch event that triggers when something happens to this repository.
Requires that there exists at least one CloudTrail Trail in your account
that captures the event. This method will not create the Trail.
###### `id`<sup>Required</sup> <a name="id" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.onCloudTrailEvent.parameter.id"></a>
- *Type:* string
The id of the rule.
---
###### `options`<sup>Optional</sup> <a name="options" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.onCloudTrailEvent.parameter.options"></a>
- *Type:* aws-cdk-lib.aws_s3.OnCloudTrailBucketEventOptions
Options for adding the rule.
---
##### `onCloudTrailPutObject` <a name="onCloudTrailPutObject" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.onCloudTrailPutObject"></a>
```typescript
public onCloudTrailPutObject(id: string, options?: OnCloudTrailBucketEventOptions): Rule
```
Defines an AWS CloudWatch event that triggers when an object is uploaded to the specified paths (keys) in this bucket using the PutObject API call.
Note that some tools like `aws s3 cp` will automatically use either
PutObject or the multipart upload API depending on the file size,
so using `onCloudTrailWriteObject` may be preferable.
Requires that there exists at least one CloudTrail Trail in your account
that captures the event. This method will not create the Trail.
###### `id`<sup>Required</sup> <a name="id" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.onCloudTrailPutObject.parameter.id"></a>
- *Type:* string
The id of the rule.
---
###### `options`<sup>Optional</sup> <a name="options" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.onCloudTrailPutObject.parameter.options"></a>
- *Type:* aws-cdk-lib.aws_s3.OnCloudTrailBucketEventOptions
Options for adding the rule.
---
##### `onCloudTrailWriteObject` <a name="onCloudTrailWriteObject" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.onCloudTrailWriteObject"></a>
```typescript
public onCloudTrailWriteObject(id: string, options?: OnCloudTrailBucketEventOptions): Rule
```
Defines an AWS CloudWatch event that triggers when an object at the specified paths (keys) in this bucket are written to.
This includes
the events PutObject, CopyObject, and CompleteMultipartUpload.
Note that some tools like `aws s3 cp` will automatically use either
PutObject or the multipart upload API depending on the file size,
so using this method may be preferable to `onCloudTrailPutObject`.
Requires that there exists at least one CloudTrail Trail in your account
that captures the event. This method will not create the Trail.
###### `id`<sup>Required</sup> <a name="id" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.onCloudTrailWriteObject.parameter.id"></a>
- *Type:* string
The id of the rule.
---
###### `options`<sup>Optional</sup> <a name="options" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.onCloudTrailWriteObject.parameter.options"></a>
- *Type:* aws-cdk-lib.aws_s3.OnCloudTrailBucketEventOptions
Options for adding the rule.
---
##### `s3UrlForObject` <a name="s3UrlForObject" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.s3UrlForObject"></a>
```typescript
public s3UrlForObject(key?: string): string
```
The S3 URL of an S3 object. For example:.
`s3://onlybucket`
- `s3://bucket/key`
###### `key`<sup>Optional</sup> <a name="key" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.s3UrlForObject.parameter.key"></a>
- *Type:* string
The S3 key of the object.
If not specified, the S3 URL of the
bucket is returned.
---
##### `transferAccelerationUrlForObject` <a name="transferAccelerationUrlForObject" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.transferAccelerationUrlForObject"></a>
```typescript
public transferAccelerationUrlForObject(key?: string, options?: TransferAccelerationUrlOptions): string
```
The https Transfer Acceleration URL of an S3 object.
Specify `dualStack: true` at the options
for dual-stack endpoint (connect to the bucket over IPv6). For example:
- `https://bucket.s3-accelerate.amazonaws.com`
- `https://bucket.s3-accelerate.amazonaws.com/key`
###### `key`<sup>Optional</sup> <a name="key" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.transferAccelerationUrlForObject.parameter.key"></a>
- *Type:* string
The S3 key of the object.
If not specified, the URL of the
bucket is returned.
---
###### `options`<sup>Optional</sup> <a name="options" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.transferAccelerationUrlForObject.parameter.options"></a>
- *Type:* aws-cdk-lib.aws_s3.TransferAccelerationUrlOptions
Options for generating URL.
---
##### `urlForObject` <a name="urlForObject" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.urlForObject"></a>
```typescript
public urlForObject(key?: string): string
```
The https URL of an S3 object. Specify `regional: false` at the options for non-regional URLs. For example:.
`https://s3.us-west-1.amazonaws.com/onlybucket`
- `https://s3.us-west-1.amazonaws.com/bucket/key`
- `https://s3.cn-north-1.amazonaws.com.cn/china-bucket/mykey`
###### `key`<sup>Optional</sup> <a name="key" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.urlForObject.parameter.key"></a>
- *Type:* string
The S3 key of the object.
If not specified, the URL of the
bucket is returned.
---
##### `virtualHostedUrlForObject` <a name="virtualHostedUrlForObject" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.virtualHostedUrlForObject"></a>
```typescript
public virtualHostedUrlForObject(key?: string, options?: VirtualHostedStyleUrlOptions): string
```
The virtual hosted-style URL of an S3 object. Specify `regional: false` at the options for non-regional URL. For example:.
`https://only-bucket.s3.us-west-1.amazonaws.com`
- `https://bucket.s3.us-west-1.amazonaws.com/key`
- `https://bucket.s3.amazonaws.com/key`
- `https://china-bucket.s3.cn-north-1.amazonaws.com.cn/mykey`
###### `key`<sup>Optional</sup> <a name="key" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.virtualHostedUrlForObject.parameter.key"></a>
- *Type:* string
The S3 key of the object.
If not specified, the URL of the
bucket is returned.
---
###### `options`<sup>Optional</sup> <a name="options" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.virtualHostedUrlForObject.parameter.options"></a>
- *Type:* aws-cdk-lib.aws_s3.VirtualHostedStyleUrlOptions
Options for generating URL.
---
##### `addCorsRule` <a name="addCorsRule" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addCorsRule"></a>
```typescript
public addCorsRule(rule: CorsRule): void
```
Adds a cross-origin access configuration for objects in an Amazon S3 bucket.
###### `rule`<sup>Required</sup> <a name="rule" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addCorsRule.parameter.rule"></a>
- *Type:* aws-cdk-lib.aws_s3.CorsRule
The CORS configuration rule to add.
---
##### `addInventory` <a name="addInventory" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addInventory"></a>
```typescript
public addInventory(inventory: Inventory): void
```
Add an inventory configuration.
###### `inventory`<sup>Required</sup> <a name="inventory" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addInventory.parameter.inventory"></a>
- *Type:* aws-cdk-lib.aws_s3.Inventory
configuration to add.
---
##### `addLifecycleRule` <a name="addLifecycleRule" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addLifecycleRule"></a>
```typescript
public addLifecycleRule(rule: LifecycleRule): void
```
Add a lifecycle rule to the bucket.
###### `rule`<sup>Required</sup> <a name="rule" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addLifecycleRule.parameter.rule"></a>
- *Type:* aws-cdk-lib.aws_s3.LifecycleRule
The rule to add.
---
##### `addMetric` <a name="addMetric" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addMetric"></a>
```typescript
public addMetric(metric: BucketMetrics): void
```
Adds a metrics configuration for the CloudWatch request metrics from the bucket.
###### `metric`<sup>Required</sup> <a name="metric" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.addMetric.parameter.metric"></a>
- *Type:* aws-cdk-lib.aws_s3.BucketMetrics
The metric configuration to add.
---
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
| **Name** | **Description** |
| --- | --- |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.isOwnedResource">isOwnedResource</a></code> | Returns true if the construct was created by CDK, and false otherwise. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.fromBucketArn">fromBucketArn</a></code> | *No description.* |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.fromBucketAttributes">fromBucketAttributes</a></code> | Creates a Bucket construct that represents an external bucket. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.fromBucketName">fromBucketName</a></code> | *No description.* |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.fromCfnBucket">fromCfnBucket</a></code> | Create a mutable `IBucket` based on a low-level `CfnBucket`. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.validateBucketName">validateBucketName</a></code> | Thrown an exception if the given bucket name is not valid. |
---
##### `isConstruct` <a name="isConstruct" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.isConstruct"></a>
```typescript
import { CrowdStrikeBucket } from '@renovosolutions/cdk-library-crowdstrike-ingestion'
CrowdStrikeBucket.isConstruct(x: any)
```
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct`
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on
disk are seen as independent, completely different libraries. As a
consequence, the class `Construct` in each copy of the `constructs` library
is seen as a different class, and an instance of one class will not test as
`instanceof` the other class. `npm install` will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the `constructs`
library can be accidentally installed, and `instanceof` will behave
unpredictably. It is safest to avoid using `instanceof`, and using
this type-testing method instead.
###### `x`<sup>Required</sup> <a name="x" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.isConstruct.parameter.x"></a>
- *Type:* any
Any object.
---
##### `isOwnedResource` <a name="isOwnedResource" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.isOwnedResource"></a>
```typescript
import { CrowdStrikeBucket } from '@renovosolutions/cdk-library-crowdstrike-ingestion'
CrowdStrikeBucket.isOwnedResource(construct: IConstruct)
```
Returns true if the construct was created by CDK, and false otherwise.
###### `construct`<sup>Required</sup> <a name="construct" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.isOwnedResource.parameter.construct"></a>
- *Type:* constructs.IConstruct
---
##### `isResource` <a name="isResource" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.isResource"></a>
```typescript
import { CrowdStrikeBucket } from '@renovosolutions/cdk-library-crowdstrike-ingestion'
CrowdStrikeBucket.isResource(construct: IConstruct)
```
Check whether the given construct is a Resource.
###### `construct`<sup>Required</sup> <a name="construct" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.isResource.parameter.construct"></a>
- *Type:* constructs.IConstruct
---
##### `fromBucketArn` <a name="fromBucketArn" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.fromBucketArn"></a>
```typescript
import { CrowdStrikeBucket } from '@renovosolutions/cdk-library-crowdstrike-ingestion'
CrowdStrikeBucket.fromBucketArn(scope: Construct, id: string, bucketArn: string)
```
###### `scope`<sup>Required</sup> <a name="scope" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.fromBucketArn.parameter.scope"></a>
- *Type:* constructs.Construct
---
###### `id`<sup>Required</sup> <a name="id" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.fromBucketArn.parameter.id"></a>
- *Type:* string
---
###### `bucketArn`<sup>Required</sup> <a name="bucketArn" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.fromBucketArn.parameter.bucketArn"></a>
- *Type:* string
---
##### `fromBucketAttributes` <a name="fromBucketAttributes" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.fromBucketAttributes"></a>
```typescript
import { CrowdStrikeBucket } from '@renovosolutions/cdk-library-crowdstrike-ingestion'
CrowdStrikeBucket.fromBucketAttributes(scope: Construct, id: string, attrs: BucketAttributes)
```
Creates a Bucket construct that represents an external bucket.
###### `scope`<sup>Required</sup> <a name="scope" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.fromBucketAttributes.parameter.scope"></a>
- *Type:* constructs.Construct
The parent creating construct (usually `this`).
---
###### `id`<sup>Required</sup> <a name="id" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.fromBucketAttributes.parameter.id"></a>
- *Type:* string
The construct's name.
---
###### `attrs`<sup>Required</sup> <a name="attrs" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.fromBucketAttributes.parameter.attrs"></a>
- *Type:* aws-cdk-lib.aws_s3.BucketAttributes
A `BucketAttributes` object.
Can be obtained from a call to
`bucket.export()` or manually created.
---
##### `fromBucketName` <a name="fromBucketName" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.fromBucketName"></a>
```typescript
import { CrowdStrikeBucket } from '@renovosolutions/cdk-library-crowdstrike-ingestion'
CrowdStrikeBucket.fromBucketName(scope: Construct, id: string, bucketName: string)
```
###### `scope`<sup>Required</sup> <a name="scope" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.fromBucketName.parameter.scope"></a>
- *Type:* constructs.Construct
---
###### `id`<sup>Required</sup> <a name="id" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.fromBucketName.parameter.id"></a>
- *Type:* string
---
###### `bucketName`<sup>Required</sup> <a name="bucketName" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.fromBucketName.parameter.bucketName"></a>
- *Type:* string
---
##### `fromCfnBucket` <a name="fromCfnBucket" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.fromCfnBucket"></a>
```typescript
import { CrowdStrikeBucket } from '@renovosolutions/cdk-library-crowdstrike-ingestion'
CrowdStrikeBucket.fromCfnBucket(cfnBucket: CfnBucket)
```
Create a mutable `IBucket` based on a low-level `CfnBucket`.
###### `cfnBucket`<sup>Required</sup> <a name="cfnBucket" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.fromCfnBucket.parameter.cfnBucket"></a>
- *Type:* aws-cdk-lib.aws_s3.CfnBucket
---
##### `validateBucketName` <a name="validateBucketName" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.validateBucketName"></a>
```typescript
import { CrowdStrikeBucket } from '@renovosolutions/cdk-library-crowdstrike-ingestion'
CrowdStrikeBucket.validateBucketName(physicalName: string, allowLegacyBucketNaming?: boolean)
```
Thrown an exception if the given bucket name is not valid.
###### `physicalName`<sup>Required</sup> <a name="physicalName" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.validateBucketName.parameter.physicalName"></a>
- *Type:* string
name of the bucket.
---
###### `allowLegacyBucketNaming`<sup>Optional</sup> <a name="allowLegacyBucketNaming" id="@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.validateBucketName.parameter.allowLegacyBucketNaming"></a>
- *Type:* boolean
allow legacy bucket naming style, default is false.
---
#### Properties <a name="Properties" id="Properties"></a>
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.property.env">env</a></code> | <code>aws-cdk-lib.interfaces.ResourceEnvironment</code> | The environment this resource belongs to. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.property.bucketArn">bucketArn</a></code> | <code>string</code> | The ARN of the bucket. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.property.bucketDomainName">bucketDomainName</a></code> | <code>string</code> | The IPv4 DNS name of the specified bucket. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.property.bucketDualStackDomainName">bucketDualStackDomainName</a></code> | <code>string</code> | The IPv6 DNS name of the specified bucket. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.property.bucketName">bucketName</a></code> | <code>string</code> | The name of the bucket. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.property.bucketRef">bucketRef</a></code> | <code>aws-cdk-lib.interfaces.aws_s3.BucketReference</code> | A reference to a Bucket resource. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.property.bucketRegionalDomainName">bucketRegionalDomainName</a></code> | <code>string</code> | The regional domain name of the specified bucket. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.property.bucketWebsiteDomainName">bucketWebsiteDomainName</a></code> | <code>string</code> | The Domain name of the static website. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.property.bucketWebsiteUrl">bucketWebsiteUrl</a></code> | <code>string</code> | The URL of the static website. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.property.encryptionKey">encryptionKey</a></code> | <code>aws-cdk-lib.aws_kms.IKey</code> | Optional KMS encryption key associated with this bucket. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.property.isWebsite">isWebsite</a></code> | <code>boolean</code> | If this bucket has been configured for static website hosting. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.property.grants">grants</a></code> | <code>aws-cdk-lib.aws_s3.BucketGrants</code> | Collection of grant methods for a Bucket. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.property.disallowPublicAccess">disallowPublicAccess</a></code> | <code>boolean</code> | Whether to disallow public access. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.property.policy">policy</a></code> | <code>aws-cdk-lib.aws_s3.BucketPolicy</code> | The resource policy associated with this bucket. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.property.replicationRoleArn">replicationRoleArn</a></code> | <code>string</code> | Role used to set up permissions on this bucket for replication. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.property.queue">queue</a></code> | <code>aws-cdk-lib.aws_sqs.Queue</code> | The SQS queue that receives notifications for new objects in the bucket. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.property.role">role</a></code> | <code>aws-cdk-lib.aws_iam.Role</code> | The IAM role that CrowdStrike will assume to access the data in the bucket. |
| <code><a href="#@renovosolutions/cdk-library-crowdstrike-ingestion.CrowdStrikeBucket.property.key">key<