API.md

API Reference

Constructs

PrivateAssetBucket

Initializers

import { PrivateAssetBucket } from 'cdk-private-asset-bucket'

new PrivateAssetBucket(scope: Construct, id: string, props: PrivateAssetBucketProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	PrivateAssetBucketProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: PrivateAssetBucketProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.

---

toString

public toString(): string

Returns a string representation of this construct.

Properties

Name	Type	Description
assetBucketCloudfrontUrl	string	No description.
assetBucketName	string	No description.
assetBucketRecordDomainName	string	No description.

---

assetBucketCloudfrontUrl^Required

public readonly assetBucketCloudfrontUrl: string;

• Type: string

---

assetBucketName^Required

public readonly assetBucketName: string;

• Type: string

---

assetBucketRecordDomainName^Optional

public readonly assetBucketRecordDomainName: string;

• Type: string

---

Structs

CustomDomain

Initializer

import { CustomDomain } from 'cdk-private-asset-bucket'

const customDomain: CustomDomain = { ... }

Properties

Name	Type	Description
domainName	string	domainName needs to be part of the hosted zone e.g.: image.example.com.
zone	aws-cdk-lib.aws_route53.IHostedZone	No description.

---

domainName^Required

public readonly domainName: string;

• Type: string

domainName needs to be part of the hosted zone e.g.: image.example.com.

---

zone^Required

public readonly zone: IHostedZone;

• Type: aws-cdk-lib.aws_route53.IHostedZone

---

PrivateAssetBucketProps

Initializer

import { PrivateAssetBucketProps } from 'cdk-private-asset-bucket'

const privateAssetBucketProps: PrivateAssetBucketProps = { ... }

Properties

Name	Type	Description
userPoolClientId	string	No description.
userPoolId	string	No description.
assetBucketName	string	No description.
assetBucketNameImport	string	if you want to use an imported bucket instead.
customDomain	CustomDomain	No description.
tokenUse	string	The token use that you expect to be present in the JWT's token_use claim.

---

userPoolClientId^Required

public readonly userPoolClientId: string;

• Type: string

---

userPoolId^Required

public readonly userPoolId: string;

• Type: string

---

assetBucketName^Optional

public readonly assetBucketName: string;

• Type: string

---

assetBucketNameImport^Optional

public readonly assetBucketNameImport: string;

• Type: string

if you want to use an imported bucket instead.

---

customDomain^Optional

public readonly customDomain: CustomDomain;

• Type: CustomDomain

---

tokenUse^Optional

public readonly tokenUse: string;

• Type: string

The token use that you expect to be present in the JWT's token_use claim.

Usually you are verifying either Access token (common) or ID token (less common). Pass null explicitly to not check the JWT's token use--if you know what you're doing

---