diff --git a/.projenrc.ts b/.projenrc.ts
index e2f7ae6..bd38674 100644
--- a/.projenrc.ts
+++ b/.projenrc.ts
@@ -7,29 +7,11 @@ const project = new CdklabsConstructLibrary({
cdkVersion: '2.92.0',
defaultReleaseBranch: 'main',
devDeps: ['cdklabs-projen-project-types'],
- name: 'cdk-verified-permissions',
+ name: '@cdklabs/cdk-verified-permissions',
projenrcTs: true,
prerelease: 'alpha',
stability: 'experimental',
releaseToNpm: true,
- publishToPypi: {
- distName: 'cdk-verified-permissions',
- module: 'cdk_verified_permissions',
- },
- publishToMaven: {
- javaPackage: 'io.github.cdklabs.verifiedpermissions',
- mavenGroupId: 'io.github.cdklabs',
- mavenArtifactId: 'cdk-verified-permissions',
- mavenEndpoint: 'https://s01.oss.sonatype.org',
- },
- publishToNuget: {
- dotNetNamespace: 'Cdklabs.VerifiedPermissions',
- packageId: 'Cdklabs.VerifiedPermissions',
- },
- publishToGo: {
- moduleName: 'github.com/cdklabs/cdk-verified-permissions-go',
- packageName: 'cdk-verified-permissions-go',
- },
repositoryUrl: 'https://github.com/cdklabs/cdk-verified-permissions.git',
});
project.synth();
\ No newline at end of file
diff --git a/API.md b/API.md
index b91fdbe..e538b5f 100644
--- a/API.md
+++ b/API.md
@@ -2,41 +2,41 @@
## Constructs
-### IdentitySource
+### IdentitySource
-- *Implements:* IIdentitySource
+- *Implements:* IIdentitySource
-#### Initializers
+#### Initializers
```typescript
-import { IdentitySource } from 'cdk-verified-permissions'
+import { IdentitySource } from '@cdklabs/cdk-verified-permissions'
new IdentitySource(scope: Construct, id: string, props: IdentitySourceProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
-| scope
| constructs.Construct
| *No description.* |
-| id
| string
| *No description.* |
-| props
| IdentitySourceProps
| *No description.* |
+| scope
| constructs.Construct
| *No description.* |
+| id
| string
| *No description.* |
+| props
| IdentitySourceProps
| *No description.* |
---
-##### `scope`Required
+##### `scope`Required
- *Type:* constructs.Construct
---
-##### `id`Required
+##### `id`Required
- *Type:* string
---
-##### `props`Required
+##### `props`Required
-- *Type:* IdentitySourceProps
+- *Type:* IdentitySourceProps
---
@@ -44,13 +44,13 @@ new IdentitySource(scope: Construct, id: string, props: IdentitySourceProps)
| **Name** | **Description** |
| --- | --- |
-| toString
| Returns a string representation of this construct. |
-| applyRemovalPolicy
| Apply the given removal policy to this resource. |
-| addUserPoolClient
| Add a User Pool Client. |
+| toString
| Returns a string representation of this construct. |
+| applyRemovalPolicy
| Apply the given removal policy to this resource. |
+| addUserPoolClient
| Add a User Pool Client. |
---
-##### `toString`
+##### `toString`
```typescript
public toString(): string
@@ -58,7 +58,7 @@ public toString(): string
Returns a string representation of this construct.
-##### `applyRemovalPolicy`
+##### `applyRemovalPolicy`
```typescript
public applyRemovalPolicy(policy: RemovalPolicy): void
@@ -74,13 +74,13 @@ 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`Required
+###### `policy`Required
- *Type:* aws-cdk-lib.RemovalPolicy
---
-##### `addUserPoolClient`
+##### `addUserPoolClient`
```typescript
public addUserPoolClient(userPoolClient: IUserPoolClient): void
@@ -88,7 +88,7 @@ public addUserPoolClient(userPoolClient: IUserPoolClient): void
Add a User Pool Client.
-###### `userPoolClient`Required
+###### `userPoolClient`Required
- *Type:* aws-cdk-lib.aws_cognito.IUserPoolClient
@@ -100,26 +100,26 @@ The User Pool Client Construct.
| **Name** | **Description** |
| --- | --- |
-| isConstruct
| Checks if `x` is a construct. |
-| isOwnedResource
| Returns true if the construct was created by CDK, and false otherwise. |
-| isResource
| Check whether the given construct is a Resource. |
-| fromIdentitySourceArn
| Create an Identity Source from its ARN. |
-| fromIdentitySourceAttributes
| Creates Identity Source from its attributes. |
-| fromIdentitySourceId
| Create an Identity Source from its identifier. |
+| isConstruct
| Checks if `x` is a construct. |
+| isOwnedResource
| Returns true if the construct was created by CDK, and false otherwise. |
+| isResource
| Check whether the given construct is a Resource. |
+| fromIdentitySourceArn
| Create an Identity Source from its ARN. |
+| fromIdentitySourceAttributes
| Creates Identity Source from its attributes. |
+| fromIdentitySourceId
| Create an Identity Source from its identifier. |
---
-##### ~~`isConstruct`~~
+##### ~~`isConstruct`~~
```typescript
-import { IdentitySource } from 'cdk-verified-permissions'
+import { IdentitySource } from '@cdklabs/cdk-verified-permissions'
IdentitySource.isConstruct(x: any)
```
Checks if `x` is a construct.
-###### `x`Required
+###### `x`Required
- *Type:* any
@@ -127,49 +127,49 @@ Any object.
---
-##### `isOwnedResource`
+##### `isOwnedResource`
```typescript
-import { IdentitySource } from 'cdk-verified-permissions'
+import { IdentitySource } from '@cdklabs/cdk-verified-permissions'
IdentitySource.isOwnedResource(construct: IConstruct)
```
Returns true if the construct was created by CDK, and false otherwise.
-###### `construct`Required
+###### `construct`Required
- *Type:* constructs.IConstruct
---
-##### `isResource`
+##### `isResource`
```typescript
-import { IdentitySource } from 'cdk-verified-permissions'
+import { IdentitySource } from '@cdklabs/cdk-verified-permissions'
IdentitySource.isResource(construct: IConstruct)
```
Check whether the given construct is a Resource.
-###### `construct`Required
+###### `construct`Required
- *Type:* constructs.IConstruct
---
-##### `fromIdentitySourceArn`
+##### `fromIdentitySourceArn`
```typescript
-import { IdentitySource } from 'cdk-verified-permissions'
+import { IdentitySource } from '@cdklabs/cdk-verified-permissions'
IdentitySource.fromIdentitySourceArn(scope: Construct, id: string, identitySourceArn: string)
```
Create an Identity Source from its ARN.
-###### `scope`Required
+###### `scope`Required
- *Type:* constructs.Construct
@@ -177,7 +177,7 @@ The parent creating construct (usually `this`).
---
-###### `id`Required
+###### `id`Required
- *Type:* string
@@ -185,7 +185,7 @@ The construct's name.
---
-###### `identitySourceArn`Required
+###### `identitySourceArn`Required
- *Type:* string
@@ -193,17 +193,17 @@ The Identity Source ARN.
---
-##### `fromIdentitySourceAttributes`
+##### `fromIdentitySourceAttributes`
```typescript
-import { IdentitySource } from 'cdk-verified-permissions'
+import { IdentitySource } from '@cdklabs/cdk-verified-permissions'
IdentitySource.fromIdentitySourceAttributes(scope: Construct, id: string, attrs: IdentitySourceAttributes)
```
Creates Identity Source from its attributes.
-###### `scope`Required
+###### `scope`Required
- *Type:* constructs.Construct
@@ -211,7 +211,7 @@ The parent creating construct (usually `this`).
---
-###### `id`Required
+###### `id`Required
- *Type:* string
@@ -219,25 +219,25 @@ The construct's name.
---
-###### `attrs`Required
+###### `attrs`Required
-- *Type:* IdentitySourceAttributes
+- *Type:* IdentitySourceAttributes
An `IdentitySourceAttributes` object.
---
-##### `fromIdentitySourceId`
+##### `fromIdentitySourceId`
```typescript
-import { IdentitySource } from 'cdk-verified-permissions'
+import { IdentitySource } from '@cdklabs/cdk-verified-permissions'
IdentitySource.fromIdentitySourceId(scope: Construct, id: string, identitySourceId: string)
```
Create an Identity Source from its identifier.
-###### `scope`Required
+###### `scope`Required
- *Type:* constructs.Construct
@@ -245,7 +245,7 @@ The parent creating construct (usually `this`).
---
-###### `id`Required
+###### `id`Required
- *Type:* string
@@ -253,7 +253,7 @@ The construct's name.
---
-###### `identitySourceId`Required
+###### `identitySourceId`Required
- *Type:* string
@@ -265,20 +265,20 @@ The Identity Source identifier.
| **Name** | **Type** | **Description** |
| --- | --- | --- |
-| node
| constructs.Node
| The tree node. |
-| env
| aws-cdk-lib.ResourceEnvironment
| The environment this resource belongs to. |
-| stack
| aws-cdk-lib.Stack
| The stack in which this resource is defined. |
-| clientIds
| string[]
| *No description.* |
-| discoveryUrl
| string
| *No description.* |
-| identitySourceArn
| string
| Identity Source ARN. |
-| identitySourceId
| string
| Identity Source identifier. |
-| openIdIssuer
| string
| *No description.* |
-| userPoolArn
| string
| *No description.* |
-| policyStore
| IPolicyStore
| *No description.* |
+| node
| constructs.Node
| The tree node. |
+| env
| aws-cdk-lib.ResourceEnvironment
| The environment this resource belongs to. |
+| stack
| aws-cdk-lib.Stack
| The stack in which this resource is defined. |
+| clientIds
| string[]
| *No description.* |
+| discoveryUrl
| string
| *No description.* |
+| identitySourceArn
| string
| Identity Source ARN. |
+| identitySourceId
| string
| Identity Source identifier. |
+| openIdIssuer
| string
| *No description.* |
+| userPoolArn
| string
| *No description.* |
+| policyStore
| IPolicyStore
| *No description.* |
---
-##### `node`Required
+##### `node`Required
```typescript
public readonly node: Node;
@@ -290,7 +290,7 @@ The tree node.
---
-##### `env`Required
+##### `env`Required
```typescript
public readonly env: ResourceEnvironment;
@@ -309,7 +309,7 @@ that might be different than the stack they were imported into.
---
-##### `stack`Required
+##### `stack`Required
```typescript
public readonly stack: Stack;
@@ -321,7 +321,7 @@ The stack in which this resource is defined.
---
-##### `clientIds`Required
+##### `clientIds`Required
```typescript
public readonly clientIds: string[];
@@ -331,7 +331,7 @@ public readonly clientIds: string[];
---
-##### `discoveryUrl`Required
+##### `discoveryUrl`Required
```typescript
public readonly discoveryUrl: string;
@@ -341,7 +341,7 @@ public readonly discoveryUrl: string;
---
-##### `identitySourceArn`Required
+##### `identitySourceArn`Required
```typescript
public readonly identitySourceArn: string;
@@ -353,7 +353,7 @@ Identity Source ARN.
---
-##### `identitySourceId`Required
+##### `identitySourceId`Required
```typescript
public readonly identitySourceId: string;
@@ -365,7 +365,7 @@ Identity Source identifier.
---
-##### `openIdIssuer`Required
+##### `openIdIssuer`Required
```typescript
public readonly openIdIssuer: string;
@@ -375,7 +375,7 @@ public readonly openIdIssuer: string;
---
-##### `userPoolArn`Required
+##### `userPoolArn`Required
```typescript
public readonly userPoolArn: string;
@@ -385,52 +385,52 @@ public readonly userPoolArn: string;
---
-##### `policyStore`Optional
+##### `policyStore`Optional
```typescript
public readonly policyStore: IPolicyStore;
```
-- *Type:* IPolicyStore
+- *Type:* IPolicyStore
---
-### Policy
+### Policy
-- *Implements:* IPolicy
+- *Implements:* IPolicy
-#### Initializers
+#### Initializers
```typescript
-import { Policy } from 'cdk-verified-permissions'
+import { Policy } from '@cdklabs/cdk-verified-permissions'
new Policy(scope: Construct, id: string, props: PolicyProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
-| scope
| constructs.Construct
| *No description.* |
-| id
| string
| *No description.* |
-| props
| PolicyProps
| *No description.* |
+| scope
| constructs.Construct
| *No description.* |
+| id
| string
| *No description.* |
+| props
| PolicyProps
| *No description.* |
---
-##### `scope`Required
+##### `scope`Required
- *Type:* constructs.Construct
---
-##### `id`Required
+##### `id`Required
- *Type:* string
---
-##### `props`Required
+##### `props`Required
-- *Type:* PolicyProps
+- *Type:* PolicyProps
---
@@ -438,12 +438,12 @@ new Policy(scope: Construct, id: string, props: PolicyProps)
| **Name** | **Description** |
| --- | --- |
-| toString
| Returns a string representation of this construct. |
-| applyRemovalPolicy
| Apply the given removal policy to this resource. |
+| toString
| Returns a string representation of this construct. |
+| applyRemovalPolicy
| Apply the given removal policy to this resource. |
---
-##### `toString`
+##### `toString`
```typescript
public toString(): string
@@ -451,7 +451,7 @@ public toString(): string
Returns a string representation of this construct.
-##### `applyRemovalPolicy`
+##### `applyRemovalPolicy`
```typescript
public applyRemovalPolicy(policy: RemovalPolicy): void
@@ -467,7 +467,7 @@ 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`Required
+###### `policy`Required
- *Type:* aws-cdk-lib.RemovalPolicy
@@ -477,25 +477,25 @@ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
| **Name** | **Description** |
| --- | --- |
-| isConstruct
| Checks if `x` is a construct. |
-| isOwnedResource
| Returns true if the construct was created by CDK, and false otherwise. |
-| isResource
| Check whether the given construct is a Resource. |
-| fromPolicyAttributes
| Import a Policy construct from attributes. |
-| fromPolicyId
| Import a policy into the CDK using its id. |
+| isConstruct
| Checks if `x` is a construct. |
+| isOwnedResource
| Returns true if the construct was created by CDK, and false otherwise. |
+| isResource
| Check whether the given construct is a Resource. |
+| fromPolicyAttributes
| Import a Policy construct from attributes. |
+| fromPolicyId
| Import a policy into the CDK using its id. |
---
-##### ~~`isConstruct`~~
+##### ~~`isConstruct`~~
```typescript
-import { Policy } from 'cdk-verified-permissions'
+import { Policy } from '@cdklabs/cdk-verified-permissions'
Policy.isConstruct(x: any)
```
Checks if `x` is a construct.
-###### `x`Required
+###### `x`Required
- *Type:* any
@@ -503,49 +503,49 @@ Any object.
---
-##### `isOwnedResource`
+##### `isOwnedResource`
```typescript
-import { Policy } from 'cdk-verified-permissions'
+import { Policy } from '@cdklabs/cdk-verified-permissions'
Policy.isOwnedResource(construct: IConstruct)
```
Returns true if the construct was created by CDK, and false otherwise.
-###### `construct`Required
+###### `construct`Required
- *Type:* constructs.IConstruct
---
-##### `isResource`
+##### `isResource`
```typescript
-import { Policy } from 'cdk-verified-permissions'
+import { Policy } from '@cdklabs/cdk-verified-permissions'
Policy.isResource(construct: IConstruct)
```
Check whether the given construct is a Resource.
-###### `construct`Required
+###### `construct`Required
- *Type:* constructs.IConstruct
---
-##### `fromPolicyAttributes`
+##### `fromPolicyAttributes`
```typescript
-import { Policy } from 'cdk-verified-permissions'
+import { Policy } from '@cdklabs/cdk-verified-permissions'
Policy.fromPolicyAttributes(scope: Construct, id: string, attrs: PolicyAttributes)
```
Import a Policy construct from attributes.
-###### `scope`Required
+###### `scope`Required
- *Type:* constructs.Construct
@@ -553,7 +553,7 @@ The parent creating construct (usually `this`).
---
-###### `id`Required
+###### `id`Required
- *Type:* string
@@ -561,25 +561,25 @@ The construct id.
---
-###### `attrs`Required
+###### `attrs`Required
-- *Type:* PolicyAttributes
+- *Type:* PolicyAttributes
A `PolicyAttributes` object.
---
-##### `fromPolicyId`
+##### `fromPolicyId`
```typescript
-import { Policy } from 'cdk-verified-permissions'
+import { Policy } from '@cdklabs/cdk-verified-permissions'
Policy.fromPolicyId(scope: Construct, id: string, policyId: string)
```
Import a policy into the CDK using its id.
-###### `scope`Required
+###### `scope`Required
- *Type:* constructs.Construct
@@ -587,7 +587,7 @@ The parent creating construct (usually `this`).
---
-###### `id`Required
+###### `id`Required
- *Type:* string
@@ -595,7 +595,7 @@ The construct id.
---
-###### `policyId`Required
+###### `policyId`Required
- *Type:* string
@@ -607,17 +607,17 @@ The policy id.
| **Name** | **Type** | **Description** |
| --- | --- | --- |
-| node
| constructs.Node
| The tree node. |
-| env
| aws-cdk-lib.ResourceEnvironment
| The environment this resource belongs to. |
-| stack
| aws-cdk-lib.Stack
| The stack in which this resource is defined. |
-| definition
| PolicyDefinitionProperty
| *No description.* |
-| policyId
| string
| The unique ID of the new or updated policy. |
-| policyStoreId
| string
| *No description.* |
-| policyType
| PolicyType
| The type of the policy. |
+| node
| constructs.Node
| The tree node. |
+| env
| aws-cdk-lib.ResourceEnvironment
| The environment this resource belongs to. |
+| stack
| aws-cdk-lib.Stack
| The stack in which this resource is defined. |
+| definition
| PolicyDefinitionProperty
| *No description.* |
+| policyId
| string
| The unique ID of the new or updated policy. |
+| policyStoreId
| string
| *No description.* |
+| policyType
| PolicyType
| The type of the policy. |
---
-##### `node`Required
+##### `node`Required
```typescript
public readonly node: Node;
@@ -629,7 +629,7 @@ The tree node.
---
-##### `env`Required
+##### `env`Required
```typescript
public readonly env: ResourceEnvironment;
@@ -648,7 +648,7 @@ that might be different than the stack they were imported into.
---
-##### `stack`Required
+##### `stack`Required
```typescript
public readonly stack: Stack;
@@ -660,17 +660,17 @@ The stack in which this resource is defined.
---
-##### `definition`Required
+##### `definition`Required
```typescript
public readonly definition: PolicyDefinitionProperty;
```
-- *Type:* PolicyDefinitionProperty
+- *Type:* PolicyDefinitionProperty
---
-##### `policyId`Required
+##### `policyId`Required
```typescript
public readonly policyId: string;
@@ -682,7 +682,7 @@ The unique ID of the new or updated policy.
---
-##### `policyStoreId`Required
+##### `policyStoreId`Required
```typescript
public readonly policyStoreId: string;
@@ -692,13 +692,13 @@ public readonly policyStoreId: string;
---
-##### `policyType`Required
+##### `policyType`Required
```typescript
public readonly policyType: PolicyType;
```
-- *Type:* PolicyType
+- *Type:* PolicyType
The type of the policy.
@@ -707,41 +707,41 @@ This is one of the following values: Static or TemplateLinked.
---
-### PolicyStore
+### PolicyStore
-- *Implements:* IPolicyStore
+- *Implements:* IPolicyStore
-#### Initializers
+#### Initializers
```typescript
-import { PolicyStore } from 'cdk-verified-permissions'
+import { PolicyStore } from '@cdklabs/cdk-verified-permissions'
new PolicyStore(scope: Construct, id: string, props?: PolicyStoreProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
-| scope
| constructs.Construct
| *No description.* |
-| id
| string
| *No description.* |
-| props
| PolicyStoreProps
| *No description.* |
+| scope
| constructs.Construct
| *No description.* |
+| id
| string
| *No description.* |
+| props
| PolicyStoreProps
| *No description.* |
---
-##### `scope`Required
+##### `scope`Required
- *Type:* constructs.Construct
---
-##### `id`Required
+##### `id`Required
- *Type:* string
---
-##### `props`Optional
+##### `props`Optional
-- *Type:* PolicyStoreProps
+- *Type:* PolicyStoreProps
---
@@ -749,17 +749,17 @@ new PolicyStore(scope: Construct, id: string, props?: PolicyStoreProps)
| **Name** | **Description** |
| --- | --- |
-| toString
| Returns a string representation of this construct. |
-| applyRemovalPolicy
| Apply the given removal policy to this resource. |
-| addPolicies
| Add multiple policies to the policy store. |
-| grant
| Adds an IAM policy statement associated with this policy store to an IAM principal's policy. |
-| grantAuth
| Permits an IAM principal all auth operations on the policy store: IsAuthorized, IsAuthorizedWithToken. |
-| grantRead
| Permits an IAM principal all read operations on the policy store: GetIdentitySource, GetPolicy, GetPolicyStore, GetPolicyTemplate, GetSchema, ListIdentitySources, ListPolicies, ListPolicyTemplates. |
-| grantWrite
| Permits an IAM principal all write & read operations on the policy store: CreateIdentitySource, CreatePolicy,CreatePolicyTemplate, DeleteIdentitySource, DeletePolicy, DeletePolicyTemplate, PutSchema, UpdateIdentitySource, UpdatePolicy, UpdatePolicyTemplate. |
+| toString
| Returns a string representation of this construct. |
+| applyRemovalPolicy
| Apply the given removal policy to this resource. |
+| addPolicies
| Add multiple policies to the policy store. |
+| grant
| Adds an IAM policy statement associated with this policy store to an IAM principal's policy. |
+| grantAuth
| Permits an IAM principal all auth operations on the policy store: IsAuthorized, IsAuthorizedWithToken. |
+| grantRead
| Permits an IAM principal all read operations on the policy store: GetIdentitySource, GetPolicy, GetPolicyStore, GetPolicyTemplate, GetSchema, ListIdentitySources, ListPolicies, ListPolicyTemplates. |
+| grantWrite
| Permits an IAM principal all write & read operations on the policy store: CreateIdentitySource, CreatePolicy,CreatePolicyTemplate, DeleteIdentitySource, DeletePolicy, DeletePolicyTemplate, PutSchema, UpdateIdentitySource, UpdatePolicy, UpdatePolicyTemplate. |
---
-##### `toString`
+##### `toString`
```typescript
public toString(): string
@@ -767,7 +767,7 @@ public toString(): string
Returns a string representation of this construct.
-##### `applyRemovalPolicy`
+##### `applyRemovalPolicy`
```typescript
public applyRemovalPolicy(policy: RemovalPolicy): void
@@ -783,13 +783,13 @@ 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`Required
+###### `policy`Required
- *Type:* aws-cdk-lib.RemovalPolicy
---
-##### `addPolicies`
+##### `addPolicies`
```typescript
public addPolicies(policyDefinitions: AddPolicyOptions[]): Policy[]
@@ -797,15 +797,15 @@ public addPolicies(policyDefinitions: AddPolicyOptions[]): Policy[]
Add multiple policies to the policy store.
-###### `policyDefinitions`Required
+###### `policyDefinitions`Required
-- *Type:* AddPolicyOptions[]
+- *Type:* AddPolicyOptions[]
An array of policy options for the policy stores policies.
---
-##### `grant`
+##### `grant`
```typescript
public grant(grantee: IGrantable, actions: string): Grant
@@ -813,19 +813,19 @@ public grant(grantee: IGrantable, actions: string): Grant
Adds an IAM policy statement associated with this policy store to an IAM principal's policy.
-###### `grantee`Required
+###### `grantee`Required
- *Type:* aws-cdk-lib.aws_iam.IGrantable
---
-###### `actions`Required
+###### `actions`Required
- *Type:* string
---
-##### `grantAuth`
+##### `grantAuth`
```typescript
public grantAuth(grantee: IGrantable): Grant
@@ -833,13 +833,13 @@ public grantAuth(grantee: IGrantable): Grant
Permits an IAM principal all auth operations on the policy store: IsAuthorized, IsAuthorizedWithToken.
-###### `grantee`Required
+###### `grantee`Required
- *Type:* aws-cdk-lib.aws_iam.IGrantable
---
-##### `grantRead`
+##### `grantRead`
```typescript
public grantRead(grantee: IGrantable): Grant
@@ -847,13 +847,13 @@ public grantRead(grantee: IGrantable): Grant
Permits an IAM principal all read operations on the policy store: GetIdentitySource, GetPolicy, GetPolicyStore, GetPolicyTemplate, GetSchema, ListIdentitySources, ListPolicies, ListPolicyTemplates.
-###### `grantee`Required
+###### `grantee`Required
- *Type:* aws-cdk-lib.aws_iam.IGrantable
---
-##### `grantWrite`
+##### `grantWrite`
```typescript
public grantWrite(grantee: IGrantable): Grant
@@ -861,7 +861,7 @@ public grantWrite(grantee: IGrantable): Grant
Permits an IAM principal all write & read operations on the policy store: CreateIdentitySource, CreatePolicy,CreatePolicyTemplate, DeleteIdentitySource, DeletePolicy, DeletePolicyTemplate, PutSchema, UpdateIdentitySource, UpdatePolicy, UpdatePolicyTemplate.
-###### `grantee`Required
+###### `grantee`Required
- *Type:* aws-cdk-lib.aws_iam.IGrantable
@@ -871,26 +871,26 @@ Permits an IAM principal all write & read operations on the policy store: Create
| **Name** | **Description** |
| --- | --- |
-| isConstruct
| Checks if `x` is a construct. |
-| isOwnedResource
| Returns true if the construct was created by CDK, and false otherwise. |
-| isResource
| Check whether the given construct is a Resource. |
-| fromPolicyStoreArn
| Create a PolicyStore construct that represents an external PolicyStore via policy store arn. |
-| fromPolicyStoreAttributes
| Creates a PolicyStore construct that represents an external Policy Store. |
-| fromPolicyStoreId
| Create a PolicyStore construct that represents an external policy store via policy store id. |
+| isConstruct
| Checks if `x` is a construct. |
+| isOwnedResource
| Returns true if the construct was created by CDK, and false otherwise. |
+| isResource
| Check whether the given construct is a Resource. |
+| fromPolicyStoreArn
| Create a PolicyStore construct that represents an external PolicyStore via policy store arn. |
+| fromPolicyStoreAttributes
| Creates a PolicyStore construct that represents an external Policy Store. |
+| fromPolicyStoreId
| Create a PolicyStore construct that represents an external policy store via policy store id. |
---
-##### ~~`isConstruct`~~
+##### ~~`isConstruct`~~
```typescript
-import { PolicyStore } from 'cdk-verified-permissions'
+import { PolicyStore } from '@cdklabs/cdk-verified-permissions'
PolicyStore.isConstruct(x: any)
```
Checks if `x` is a construct.
-###### `x`Required
+###### `x`Required
- *Type:* any
@@ -898,49 +898,49 @@ Any object.
---
-##### `isOwnedResource`
+##### `isOwnedResource`
```typescript
-import { PolicyStore } from 'cdk-verified-permissions'
+import { PolicyStore } from '@cdklabs/cdk-verified-permissions'
PolicyStore.isOwnedResource(construct: IConstruct)
```
Returns true if the construct was created by CDK, and false otherwise.
-###### `construct`Required
+###### `construct`Required
- *Type:* constructs.IConstruct
---
-##### `isResource`
+##### `isResource`
```typescript
-import { PolicyStore } from 'cdk-verified-permissions'
+import { PolicyStore } from '@cdklabs/cdk-verified-permissions'
PolicyStore.isResource(construct: IConstruct)
```
Check whether the given construct is a Resource.
-###### `construct`Required
+###### `construct`Required
- *Type:* constructs.IConstruct
---
-##### `fromPolicyStoreArn`
+##### `fromPolicyStoreArn`
```typescript
-import { PolicyStore } from 'cdk-verified-permissions'
+import { PolicyStore } from '@cdklabs/cdk-verified-permissions'
PolicyStore.fromPolicyStoreArn(scope: Construct, id: string, policyStoreArn: string)
```
Create a PolicyStore construct that represents an external PolicyStore via policy store arn.
-###### `scope`Required
+###### `scope`Required
- *Type:* constructs.Construct
@@ -948,7 +948,7 @@ The parent creating construct (usually `this`).
---
-###### `id`Required
+###### `id`Required
- *Type:* string
@@ -956,7 +956,7 @@ The construct's name.
---
-###### `policyStoreArn`Required
+###### `policyStoreArn`Required
- *Type:* string
@@ -964,17 +964,17 @@ The PolicyStore's ARN.
---
-##### `fromPolicyStoreAttributes`
+##### `fromPolicyStoreAttributes`
```typescript
-import { PolicyStore } from 'cdk-verified-permissions'
+import { PolicyStore } from '@cdklabs/cdk-verified-permissions'
PolicyStore.fromPolicyStoreAttributes(scope: Construct, id: string, attrs: PolicyStoreAttributes)
```
Creates a PolicyStore construct that represents an external Policy Store.
-###### `scope`Required
+###### `scope`Required
- *Type:* constructs.Construct
@@ -982,7 +982,7 @@ The parent creating construct (usually `this`).
---
-###### `id`Required
+###### `id`Required
- *Type:* string
@@ -990,25 +990,25 @@ The construct's name.
---
-###### `attrs`Required
+###### `attrs`Required
-- *Type:* PolicyStoreAttributes
+- *Type:* PolicyStoreAttributes
A `PolicyStoreAttributes` object.
---
-##### `fromPolicyStoreId`
+##### `fromPolicyStoreId`
```typescript
-import { PolicyStore } from 'cdk-verified-permissions'
+import { PolicyStore } from '@cdklabs/cdk-verified-permissions'
PolicyStore.fromPolicyStoreId(scope: Construct, id: string, policyStoreId: string)
```
Create a PolicyStore construct that represents an external policy store via policy store id.
-###### `scope`Required
+###### `scope`Required
- *Type:* constructs.Construct
@@ -1016,7 +1016,7 @@ The parent creating construct (usually `this`).
---
-###### `id`Required
+###### `id`Required
- *Type:* string
@@ -1024,7 +1024,7 @@ The construct's name.
---
-###### `policyStoreId`Required
+###### `policyStoreId`Required
- *Type:* string
@@ -1036,18 +1036,18 @@ The PolicyStore's id.
| **Name** | **Type** | **Description** |
| --- | --- | --- |
-| node
| constructs.Node
| The tree node. |
-| env
| aws-cdk-lib.ResourceEnvironment
| The environment this resource belongs to. |
-| stack
| aws-cdk-lib.Stack
| The stack in which this resource is defined. |
-| policyStoreArn
| string
| ARN of the Policy Store. |
-| policyStoreId
| string
| ID of the Policy Store. |
-| policyStoreName
| string
| Name of the Policy Store. |
-| validationSettings
| IValidationSettings
| Validation Settings of the Policy Store. |
-| schema
| ISchema
| Schema definition of the Policy Store. |
+| node
| constructs.Node
| The tree node. |
+| env
| aws-cdk-lib.ResourceEnvironment
| The environment this resource belongs to. |
+| stack
| aws-cdk-lib.Stack
| The stack in which this resource is defined. |
+| policyStoreArn
| string
| ARN of the Policy Store. |
+| policyStoreId
| string
| ID of the Policy Store. |
+| policyStoreName
| string
| Name of the Policy Store. |
+| validationSettings
| IValidationSettings
| Validation Settings of the Policy Store. |
+| schema
| ISchema
| Schema definition of the Policy Store. |
---
-##### `node`Required
+##### `node`Required
```typescript
public readonly node: Node;
@@ -1059,7 +1059,7 @@ The tree node.
---
-##### `env`Required
+##### `env`Required
```typescript
public readonly env: ResourceEnvironment;
@@ -1078,7 +1078,7 @@ that might be different than the stack they were imported into.
---
-##### `stack`Required
+##### `stack`Required
```typescript
public readonly stack: Stack;
@@ -1090,7 +1090,7 @@ The stack in which this resource is defined.
---
-##### `policyStoreArn`Required
+##### `policyStoreArn`Required
```typescript
public readonly policyStoreArn: string;
@@ -1102,7 +1102,7 @@ ARN of the Policy Store.
---
-##### `policyStoreId`Required
+##### `policyStoreId`Required
```typescript
public readonly policyStoreId: string;
@@ -1114,7 +1114,7 @@ ID of the Policy Store.
---
-##### `policyStoreName`Required
+##### `policyStoreName`Required
```typescript
public readonly policyStoreName: string;
@@ -1126,66 +1126,66 @@ Name of the Policy Store.
---
-##### `validationSettings`Required
+##### `validationSettings`Required
```typescript
public readonly validationSettings: IValidationSettings;
```
-- *Type:* IValidationSettings
+- *Type:* IValidationSettings
Validation Settings of the Policy Store.
---
-##### `schema`Optional
+##### `schema`Optional
```typescript
public readonly schema: ISchema;
```
-- *Type:* ISchema
+- *Type:* ISchema
Schema definition of the Policy Store.
---
-### PolicyTemplate
+### PolicyTemplate
-- *Implements:* IPolicyTemplate
+- *Implements:* IPolicyTemplate
-#### Initializers
+#### Initializers
```typescript
-import { PolicyTemplate } from 'cdk-verified-permissions'
+import { PolicyTemplate } from '@cdklabs/cdk-verified-permissions'
new PolicyTemplate(scope: Construct, id: string, props: PolicyTemplateProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
-| scope
| constructs.Construct
| *No description.* |
-| id
| string
| *No description.* |
-| props
| PolicyTemplateProps
| *No description.* |
+| scope
| constructs.Construct
| *No description.* |
+| id
| string
| *No description.* |
+| props
| PolicyTemplateProps
| *No description.* |
---
-##### `scope`Required
+##### `scope`Required
- *Type:* constructs.Construct
---
-##### `id`Required
+##### `id`Required
- *Type:* string
---
-##### `props`Required
+##### `props`Required
-- *Type:* PolicyTemplateProps
+- *Type:* PolicyTemplateProps
---
@@ -1193,12 +1193,12 @@ new PolicyTemplate(scope: Construct, id: string, props: PolicyTemplateProps)
| **Name** | **Description** |
| --- | --- |
-| toString
| Returns a string representation of this construct. |
-| applyRemovalPolicy
| Apply the given removal policy to this resource. |
+| toString
| Returns a string representation of this construct. |
+| applyRemovalPolicy
| Apply the given removal policy to this resource. |
---
-##### `toString`
+##### `toString`
```typescript
public toString(): string
@@ -1206,7 +1206,7 @@ public toString(): string
Returns a string representation of this construct.
-##### `applyRemovalPolicy`
+##### `applyRemovalPolicy`
```typescript
public applyRemovalPolicy(policy: RemovalPolicy): void
@@ -1222,7 +1222,7 @@ 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`Required
+###### `policy`Required
- *Type:* aws-cdk-lib.RemovalPolicy
@@ -1232,25 +1232,25 @@ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
| **Name** | **Description** |
| --- | --- |
-| isConstruct
| Checks if `x` is a construct. |
-| isOwnedResource
| Returns true if the construct was created by CDK, and false otherwise. |
-| isResource
| Check whether the given construct is a Resource. |
-| fromPolicyTemplateAttributes
| Creates a PolicyStore construct that represents an external Policy Store. |
-| fromPolicyTemplateId
| Create a PolicyTemplate construct that represents an external policy template via policy template id. |
+| isConstruct
| Checks if `x` is a construct. |
+| isOwnedResource
| Returns true if the construct was created by CDK, and false otherwise. |
+| isResource
| Check whether the given construct is a Resource. |
+| fromPolicyTemplateAttributes
| Creates a PolicyStore construct that represents an external Policy Store. |
+| fromPolicyTemplateId
| Create a PolicyTemplate construct that represents an external policy template via policy template id. |
---
-##### ~~`isConstruct`~~
+##### ~~`isConstruct`~~
```typescript
-import { PolicyTemplate } from 'cdk-verified-permissions'
+import { PolicyTemplate } from '@cdklabs/cdk-verified-permissions'
PolicyTemplate.isConstruct(x: any)
```
Checks if `x` is a construct.
-###### `x`Required
+###### `x`Required
- *Type:* any
@@ -1258,49 +1258,49 @@ Any object.
---
-##### `isOwnedResource`
+##### `isOwnedResource`
```typescript
-import { PolicyTemplate } from 'cdk-verified-permissions'
+import { PolicyTemplate } from '@cdklabs/cdk-verified-permissions'
PolicyTemplate.isOwnedResource(construct: IConstruct)
```
Returns true if the construct was created by CDK, and false otherwise.
-###### `construct`Required
+###### `construct`Required
- *Type:* constructs.IConstruct
---
-##### `isResource`
+##### `isResource`
```typescript
-import { PolicyTemplate } from 'cdk-verified-permissions'
+import { PolicyTemplate } from '@cdklabs/cdk-verified-permissions'
PolicyTemplate.isResource(construct: IConstruct)
```
Check whether the given construct is a Resource.
-###### `construct`Required
+###### `construct`Required
- *Type:* constructs.IConstruct
---
-##### `fromPolicyTemplateAttributes`
+##### `fromPolicyTemplateAttributes`
```typescript
-import { PolicyTemplate } from 'cdk-verified-permissions'
+import { PolicyTemplate } from '@cdklabs/cdk-verified-permissions'
PolicyTemplate.fromPolicyTemplateAttributes(scope: Construct, id: string, attrs: PolicyTemplateAttributes)
```
Creates a PolicyStore construct that represents an external Policy Store.
-###### `scope`Required
+###### `scope`Required
- *Type:* constructs.Construct
@@ -1308,7 +1308,7 @@ The parent creating construct (usually `this`).
---
-###### `id`Required
+###### `id`Required
- *Type:* string
@@ -1316,25 +1316,25 @@ The construct's name.
---
-###### `attrs`Required
+###### `attrs`Required
-- *Type:* PolicyTemplateAttributes
+- *Type:* PolicyTemplateAttributes
A `PolicyStoreAttributes` object.
---
-##### `fromPolicyTemplateId`
+##### `fromPolicyTemplateId`
```typescript
-import { PolicyTemplate } from 'cdk-verified-permissions'
+import { PolicyTemplate } from '@cdklabs/cdk-verified-permissions'
PolicyTemplate.fromPolicyTemplateId(scope: Construct, id: string, policyTemplateId: string)
```
Create a PolicyTemplate construct that represents an external policy template via policy template id.
-###### `scope`Required
+###### `scope`Required
- *Type:* constructs.Construct
@@ -1342,7 +1342,7 @@ The parent creating construct (usually `this`).
---
-###### `id`Required
+###### `id`Required
- *Type:* string
@@ -1350,7 +1350,7 @@ The construct's name.
---
-###### `policyTemplateId`Required
+###### `policyTemplateId`Required
- *Type:* string
@@ -1362,17 +1362,17 @@ The PolicyTemplate's id.
| **Name** | **Type** | **Description** |
| --- | --- | --- |
-| node
| constructs.Node
| The tree node. |
-| env
| aws-cdk-lib.ResourceEnvironment
| The environment this resource belongs to. |
-| stack
| aws-cdk-lib.Stack
| The stack in which this resource is defined. |
-| policyTemplateId
| string
| The ID of the policy template. |
-| statement
| string
| The statement of the policy template. |
-| description
| string
| Description of the policy template. |
-| policyStore
| IPolicyStore
| The Policy store that contains the template. |
+| node
| constructs.Node
| The tree node. |
+| env
| aws-cdk-lib.ResourceEnvironment
| The environment this resource belongs to. |
+| stack
| aws-cdk-lib.Stack
| The stack in which this resource is defined. |
+| policyTemplateId
| string
| The ID of the policy template. |
+| statement
| string
| The statement of the policy template. |
+| description
| string
| Description of the policy template. |
+| policyStore
| IPolicyStore
| The Policy store that contains the template. |
---
-##### `node`Required
+##### `node`Required
```typescript
public readonly node: Node;
@@ -1384,7 +1384,7 @@ The tree node.
---
-##### `env`Required
+##### `env`Required
```typescript
public readonly env: ResourceEnvironment;
@@ -1403,7 +1403,7 @@ that might be different than the stack they were imported into.
---
-##### `stack`Required
+##### `stack`Required
```typescript
public readonly stack: Stack;
@@ -1415,7 +1415,7 @@ The stack in which this resource is defined.
---
-##### `policyTemplateId`Required
+##### `policyTemplateId`Required
```typescript
public readonly policyTemplateId: string;
@@ -1427,7 +1427,7 @@ The ID of the policy template.
---
-##### `statement`Required
+##### `statement`Required
```typescript
public readonly statement: string;
@@ -1439,7 +1439,7 @@ The statement of the policy template.
---
-##### `description`Optional
+##### `description`Optional
```typescript
public readonly description: string;
@@ -1451,13 +1451,13 @@ Description of the policy template.
---
-##### `policyStore`Optional
+##### `policyStore`Optional
```typescript
public readonly policyStore: IPolicyStore;
```
-- *Type:* IPolicyStore
+- *Type:* IPolicyStore
The Policy store that contains the template.
@@ -1466,12 +1466,12 @@ The Policy store that contains the template.
## Structs
-### AddPolicyOptions
+### AddPolicyOptions
-#### Initializer
+#### Initializer
```typescript
-import { AddPolicyOptions } from 'cdk-verified-permissions'
+import { AddPolicyOptions } from '@cdklabs/cdk-verified-permissions'
const addPolicyOptions: AddPolicyOptions = { ... }
```
@@ -1480,24 +1480,24 @@ const addPolicyOptions: AddPolicyOptions = { ... }
| **Name** | **Type** | **Description** |
| --- | --- | --- |
-| policyConfiguration
| PolicyDefinitionProperty
| The configuration of the Policy. |
-| policyId
| string
| The id of the Policy. |
+| policyConfiguration
| PolicyDefinitionProperty
| The configuration of the Policy. |
+| policyId
| string
| The id of the Policy. |
---
-##### `policyConfiguration`Required
+##### `policyConfiguration`Required
```typescript
public readonly policyConfiguration: PolicyDefinitionProperty;
```
-- *Type:* PolicyDefinitionProperty
+- *Type:* PolicyDefinitionProperty
The configuration of the Policy.
---
-##### `policyId`Required
+##### `policyId`Required
```typescript
public readonly policyId: string;
@@ -1509,12 +1509,12 @@ The id of the Policy.
---
-### CognitoUserPoolConfiguration
+### CognitoUserPoolConfiguration
-#### Initializer
+#### Initializer
```typescript
-import { CognitoUserPoolConfiguration } from 'cdk-verified-permissions'
+import { CognitoUserPoolConfiguration } from '@cdklabs/cdk-verified-permissions'
const cognitoUserPoolConfiguration: CognitoUserPoolConfiguration = { ... }
```
@@ -1523,12 +1523,12 @@ const cognitoUserPoolConfiguration: CognitoUserPoolConfiguration = { ... }
| **Name** | **Type** | **Description** |
| --- | --- | --- |
-| userPool
| aws-cdk-lib.aws_cognito.IUserPool
| Cognito User Pool. |
-| clientIds
| string[]
| Client identifiers. |
+| userPool
| aws-cdk-lib.aws_cognito.IUserPool
| Cognito User Pool. |
+| clientIds
| string[]
| Client identifiers. |
---
-##### `userPool`Required
+##### `userPool`Required
```typescript
public readonly userPool: IUserPool;
@@ -1541,7 +1541,7 @@ Cognito User Pool.
---
-##### `clientIds`Optional
+##### `clientIds`Optional
```typescript
public readonly clientIds: string[];
@@ -1554,12 +1554,12 @@ Client identifiers.
---
-### EntityIdentifierProperty
+### EntityIdentifierProperty
-#### Initializer
+#### Initializer
```typescript
-import { EntityIdentifierProperty } from 'cdk-verified-permissions'
+import { EntityIdentifierProperty } from '@cdklabs/cdk-verified-permissions'
const entityIdentifierProperty: EntityIdentifierProperty = { ... }
```
@@ -1568,12 +1568,12 @@ const entityIdentifierProperty: EntityIdentifierProperty = { ... }
| **Name** | **Type** | **Description** |
| --- | --- | --- |
-| entityId
| string
| The identifier of an entity. |
-| entityType
| string
| The type of an entity. |
+| entityId
| string
| The identifier of an entity. |
+| entityType
| string
| The type of an entity. |
---
-##### `entityId`Required
+##### `entityId`Required
```typescript
public readonly entityId: string;
@@ -1585,7 +1585,7 @@ The identifier of an entity.
---
-##### `entityType`Required
+##### `entityType`Required
```typescript
public readonly entityType: string;
@@ -1597,12 +1597,12 @@ The type of an entity.
---
-### IdentitySourceAttributes
+### IdentitySourceAttributes
-#### Initializer
+#### Initializer
```typescript
-import { IdentitySourceAttributes } from 'cdk-verified-permissions'
+import { IdentitySourceAttributes } from '@cdklabs/cdk-verified-permissions'
const identitySourceAttributes: IdentitySourceAttributes = { ... }
```
@@ -1611,12 +1611,12 @@ const identitySourceAttributes: IdentitySourceAttributes = { ... }
| **Name** | **Type** | **Description** |
| --- | --- | --- |
-| identitySourceArn
| string
| The identity Source ARN. |
-| identitySourceId
| string
| The identity Source identifier. |
+| identitySourceArn
| string
| The identity Source ARN. |
+| identitySourceId
| string
| The identity Source identifier. |
---
-##### `identitySourceArn`Optional
+##### `identitySourceArn`Optional
```typescript
public readonly identitySourceArn: string;
@@ -1628,7 +1628,7 @@ The identity Source ARN.
---
-##### `identitySourceId`Optional
+##### `identitySourceId`Optional
```typescript
public readonly identitySourceId: string;
@@ -1640,12 +1640,12 @@ The identity Source identifier.
---
-### IdentitySourceConfiguration
+### IdentitySourceConfiguration
-#### Initializer
+#### Initializer
```typescript
-import { IdentitySourceConfiguration } from 'cdk-verified-permissions'
+import { IdentitySourceConfiguration } from '@cdklabs/cdk-verified-permissions'
const identitySourceConfiguration: IdentitySourceConfiguration = { ... }
```
@@ -1654,28 +1654,28 @@ const identitySourceConfiguration: IdentitySourceConfiguration = { ... }
| **Name** | **Type** | **Description** |
| --- | --- | --- |
-| cognitoUserPoolConfiguration
| CognitoUserPoolConfiguration
| Cognito User Pool Configuration. |
+| cognitoUserPoolConfiguration
| CognitoUserPoolConfiguration
| Cognito User Pool Configuration. |
---
-##### `cognitoUserPoolConfiguration`Required
+##### `cognitoUserPoolConfiguration`Required
```typescript
public readonly cognitoUserPoolConfiguration: CognitoUserPoolConfiguration;
```
-- *Type:* CognitoUserPoolConfiguration
+- *Type:* CognitoUserPoolConfiguration
Cognito User Pool Configuration.
---
-### IdentitySourceProps
+### IdentitySourceProps
-#### Initializer
+#### Initializer
```typescript
-import { IdentitySourceProps } from 'cdk-verified-permissions'
+import { IdentitySourceProps } from '@cdklabs/cdk-verified-permissions'
const identitySourceProps: IdentitySourceProps = { ... }
```
@@ -1684,38 +1684,38 @@ const identitySourceProps: IdentitySourceProps = { ... }
| **Name** | **Type** | **Description** |
| --- | --- | --- |
-| configuration
| IdentitySourceConfiguration
| Identity Source configuration. |
-| policyStore
| IPolicyStore
| Policy Store in which you want to store this identity source. |
-| principalEntityType
| string
| Principal entity type. |
+| configuration
| IdentitySourceConfiguration
| Identity Source configuration. |
+| policyStore
| IPolicyStore
| Policy Store in which you want to store this identity source. |
+| principalEntityType
| string
| Principal entity type. |
---
-##### `configuration`Required
+##### `configuration`Required
```typescript
public readonly configuration: IdentitySourceConfiguration;
```
-- *Type:* IdentitySourceConfiguration
+- *Type:* IdentitySourceConfiguration
Identity Source configuration.
---
-##### `policyStore`Optional
+##### `policyStore`Optional
```typescript
public readonly policyStore: IPolicyStore;
```
-- *Type:* IPolicyStore
+- *Type:* IPolicyStore
- *Default:* No policy store is set for the identity source.
Policy Store in which you want to store this identity source.
---
-##### `principalEntityType`Optional
+##### `principalEntityType`Optional
```typescript
public readonly principalEntityType: string;
@@ -1728,12 +1728,12 @@ Principal entity type.
---
-### PolicyAttributes
+### PolicyAttributes
-#### Initializer
+#### Initializer
```typescript
-import { PolicyAttributes } from 'cdk-verified-permissions'
+import { PolicyAttributes } from '@cdklabs/cdk-verified-permissions'
const policyAttributes: PolicyAttributes = { ... }
```
@@ -1742,12 +1742,12 @@ const policyAttributes: PolicyAttributes = { ... }
| **Name** | **Type** | **Description** |
| --- | --- | --- |
-| policyId
| string
| The unique ID of the new or updated policy. |
-| policyType
| PolicyType
| The type of the policy. |
+| policyId
| string
| The unique ID of the new or updated policy. |
+| policyType
| PolicyType
| The type of the policy. |
---
-##### `policyId`Required
+##### `policyId`Required
```typescript
public readonly policyId: string;
@@ -1759,13 +1759,13 @@ The unique ID of the new or updated policy.
---
-##### `policyType`Optional
+##### `policyType`Optional
```typescript
public readonly policyType: PolicyType;
```
-- *Type:* PolicyType
+- *Type:* PolicyType
- *Default:* Static
The type of the policy.
@@ -1774,12 +1774,12 @@ This is one of the following values: Static or TemplateLinked
---
-### PolicyDefinitionProperty
+### PolicyDefinitionProperty
-#### Initializer
+#### Initializer
```typescript
-import { PolicyDefinitionProperty } from 'cdk-verified-permissions'
+import { PolicyDefinitionProperty } from '@cdklabs/cdk-verified-permissions'
const policyDefinitionProperty: PolicyDefinitionProperty = { ... }
```
@@ -1788,43 +1788,43 @@ const policyDefinitionProperty: PolicyDefinitionProperty = { ... }
| **Name** | **Type** | **Description** |
| --- | --- | --- |
-| static
| StaticPolicyDefinitionProperty
| A structure that describes a static policy. |
-| templateLinked
| TemplateLinkedPolicyDefinitionProperty
| A structure that describes a policy that was instantiated from a template. |
+| static
| StaticPolicyDefinitionProperty
| A structure that describes a static policy. |
+| templateLinked
| TemplateLinkedPolicyDefinitionProperty
| A structure that describes a policy that was instantiated from a template. |
---
-##### `static`Optional
+##### `static`Optional
```typescript
public readonly static: StaticPolicyDefinitionProperty;
```
-- *Type:* StaticPolicyDefinitionProperty
+- *Type:* StaticPolicyDefinitionProperty
- *Default:* Static must be set for policies created from a static definition. Otherwise, use template linked definitions.
A structure that describes a static policy.
---
-##### `templateLinked`Optional
+##### `templateLinked`Optional
```typescript
public readonly templateLinked: TemplateLinkedPolicyDefinitionProperty;
```
-- *Type:* TemplateLinkedPolicyDefinitionProperty
+- *Type:* TemplateLinkedPolicyDefinitionProperty
- *Default:* Template linked must be set for policies created from a static definition. Otherwise, use static definitions.
A structure that describes a policy that was instantiated from a template.
---
-### PolicyProps
+### PolicyProps
-#### Initializer
+#### Initializer
```typescript
-import { PolicyProps } from 'cdk-verified-permissions'
+import { PolicyProps } from '@cdklabs/cdk-verified-permissions'
const policyProps: PolicyProps = { ... }
```
@@ -1833,18 +1833,18 @@ const policyProps: PolicyProps = { ... }
| **Name** | **Type** | **Description** |
| --- | --- | --- |
-| definition
| PolicyDefinitionProperty
| Specifies the policy type and content to use for the new or updated policy. |
-| policyStore
| IPolicyStore
| The policy store that contains the policy. |
+| definition
| PolicyDefinitionProperty
| Specifies the policy type and content to use for the new or updated policy. |
+| policyStore
| IPolicyStore
| The policy store that contains the policy. |
---
-##### `definition`Required
+##### `definition`Required
```typescript
public readonly definition: PolicyDefinitionProperty;
```
-- *Type:* PolicyDefinitionProperty
+- *Type:* PolicyDefinitionProperty
Specifies the policy type and content to use for the new or updated policy.
@@ -1852,24 +1852,24 @@ The definition structure must include either a Static or a TemplateLinked elemen
---
-##### `policyStore`Required
+##### `policyStore`Required
```typescript
public readonly policyStore: IPolicyStore;
```
-- *Type:* IPolicyStore
+- *Type:* IPolicyStore
The policy store that contains the policy.
---
-### PolicyStoreAttributes
+### PolicyStoreAttributes
-#### Initializer
+#### Initializer
```typescript
-import { PolicyStoreAttributes } from 'cdk-verified-permissions'
+import { PolicyStoreAttributes } from '@cdklabs/cdk-verified-permissions'
const policyStoreAttributes: PolicyStoreAttributes = { ... }
```
@@ -1878,12 +1878,12 @@ const policyStoreAttributes: PolicyStoreAttributes = { ... }
| **Name** | **Type** | **Description** |
| --- | --- | --- |
-| policyStoreArn
| string
| The ARN of the Amazon Verified Permissions Policy Store. |
-| policyStoreId
| string
| The id of the Amazon Verified Permissions PolicyStore. |
+| policyStoreArn
| string
| The ARN of the Amazon Verified Permissions Policy Store. |
+| policyStoreId
| string
| The id of the Amazon Verified Permissions PolicyStore. |
---
-##### `policyStoreArn`Optional
+##### `policyStoreArn`Optional
```typescript
public readonly policyStoreArn: string;
@@ -1898,7 +1898,7 @@ One of this, or `policyStoreId`, is required.
---
-##### `policyStoreId`Optional
+##### `policyStoreId`Optional
```typescript
public readonly policyStoreId: string;
@@ -1913,12 +1913,12 @@ One of this, or `policyStoreArn`, is required.
---
-### PolicyStoreProps
+### PolicyStoreProps
-#### Initializer
+#### Initializer
```typescript
-import { PolicyStoreProps } from 'cdk-verified-permissions'
+import { PolicyStoreProps } from '@cdklabs/cdk-verified-permissions'
const policyStoreProps: PolicyStoreProps = { ... }
```
@@ -1927,31 +1927,31 @@ const policyStoreProps: PolicyStoreProps = { ... }
| **Name** | **Type** | **Description** |
| --- | --- | --- |
-| validationSettings
| IValidationSettings
| The policy store's validation settings. |
-| schema
| ISchema
| This attribute is not required from an API point of view. |
+| validationSettings
| IValidationSettings
| The policy store's validation settings. |
+| schema
| ISchema
| This attribute is not required from an API point of view. |
---
-##### `validationSettings`Required
+##### `validationSettings`Required
```typescript
public readonly validationSettings: IValidationSettings;
```
-- *Type:* IValidationSettings
+- *Type:* IValidationSettings
- *Default:* If not provided, the Policy store will be created with ValidationSettingsMode = "OFF"
The policy store's validation settings.
---
-##### `schema`Optional
+##### `schema`Optional
```typescript
public readonly schema: ISchema;
```
-- *Type:* ISchema
+- *Type:* ISchema
- *Default:* The schema (in Cedar) to be applied to the PolicyStore.
This attribute is not required from an API point of view.
@@ -1960,12 +1960,12 @@ It represents the schema (in Cedar) to be applied to the PolicyStore.
---
-### PolicyTemplateAttributes
+### PolicyTemplateAttributes
-#### Initializer
+#### Initializer
```typescript
-import { PolicyTemplateAttributes } from 'cdk-verified-permissions'
+import { PolicyTemplateAttributes } from '@cdklabs/cdk-verified-permissions'
const policyTemplateAttributes: PolicyTemplateAttributes = { ... }
```
@@ -1974,11 +1974,11 @@ const policyTemplateAttributes: PolicyTemplateAttributes = { ... }
| **Name** | **Type** | **Description** |
| --- | --- | --- |
-| policyTemplateId
| string
| The id of the Amazon Verified Permissions PolicyTemplate. |
+| policyTemplateId
| string
| The id of the Amazon Verified Permissions PolicyTemplate. |
---
-##### `policyTemplateId`Required
+##### `policyTemplateId`Required
```typescript
public readonly policyTemplateId: string;
@@ -1990,12 +1990,12 @@ The id of the Amazon Verified Permissions PolicyTemplate.
---
-### PolicyTemplateProps
+### PolicyTemplateProps
-#### Initializer
+#### Initializer
```typescript
-import { PolicyTemplateProps } from 'cdk-verified-permissions'
+import { PolicyTemplateProps } from '@cdklabs/cdk-verified-permissions'
const policyTemplateProps: PolicyTemplateProps = { ... }
```
@@ -2004,13 +2004,13 @@ const policyTemplateProps: PolicyTemplateProps = { ... }
| **Name** | **Type** | **Description** |
| --- | --- | --- |
-| statement
| string
| Specifies the content that you want to use for the new policy template, written in the Cedar policy language. |
-| description
| string
| The description to attach to the new or updated policy template. |
-| policyStore
| IPolicyStore
| The policy store that contains the template. |
+| statement
| string
| Specifies the content that you want to use for the new policy template, written in the Cedar policy language. |
+| description
| string
| The description to attach to the new or updated policy template. |
+| policyStore
| IPolicyStore
| The policy store that contains the template. |
---
-##### `statement`Required
+##### `statement`Required
```typescript
public readonly statement: string;
@@ -2023,7 +2023,7 @@ Specifies the content that you want to use for the new policy template, written
---
-##### `description`Optional
+##### `description`Optional
```typescript
public readonly description: string;
@@ -2036,25 +2036,25 @@ The description to attach to the new or updated policy template.
---
-##### `policyStore`Optional
+##### `policyStore`Optional
```typescript
public readonly policyStore: IPolicyStore;
```
-- *Type:* IPolicyStore
+- *Type:* IPolicyStore
- *Default:* No policy store.
The policy store that contains the template.
---
-### StaticPolicyDefinitionProperty
+### StaticPolicyDefinitionProperty
-#### Initializer
+#### Initializer
```typescript
-import { StaticPolicyDefinitionProperty } from 'cdk-verified-permissions'
+import { StaticPolicyDefinitionProperty } from '@cdklabs/cdk-verified-permissions'
const staticPolicyDefinitionProperty: StaticPolicyDefinitionProperty = { ... }
```
@@ -2063,12 +2063,12 @@ const staticPolicyDefinitionProperty: StaticPolicyDefinitionProperty = { ... }
| **Name** | **Type** | **Description** |
| --- | --- | --- |
-| statement
| string
| The policy content of the static policy, written in the Cedar policy language. |
-| description
| string
| The description of the static policy. |
+| statement
| string
| The policy content of the static policy, written in the Cedar policy language. |
+| description
| string
| The description of the static policy. |
---
-##### `statement`Required
+##### `statement`Required
```typescript
public readonly statement: string;
@@ -2080,7 +2080,7 @@ The policy content of the static policy, written in the Cedar policy language.
---
-##### `description`Optional
+##### `description`Optional
```typescript
public readonly description: string;
@@ -2093,12 +2093,12 @@ The description of the static policy.
---
-### TemplateLinkedPolicyDefinitionProperty
+### TemplateLinkedPolicyDefinitionProperty
-#### Initializer
+#### Initializer
```typescript
-import { TemplateLinkedPolicyDefinitionProperty } from 'cdk-verified-permissions'
+import { TemplateLinkedPolicyDefinitionProperty } from '@cdklabs/cdk-verified-permissions'
const templateLinkedPolicyDefinitionProperty: TemplateLinkedPolicyDefinitionProperty = { ... }
```
@@ -2107,44 +2107,44 @@ const templateLinkedPolicyDefinitionProperty: TemplateLinkedPolicyDefinitionProp
| **Name** | **Type** | **Description** |
| --- | --- | --- |
-| policyTemplate
| IPolicyTemplate
| The unique identifier of the policy template used to create this policy. |
-| principal
| EntityIdentifierProperty
| The principal associated with this template-linked policy. |
-| resource
| EntityIdentifierProperty
| The resource associated with this template-linked policy. |
+| policyTemplate
| IPolicyTemplate
| The unique identifier of the policy template used to create this policy. |
+| principal
| EntityIdentifierProperty
| The principal associated with this template-linked policy. |
+| resource
| EntityIdentifierProperty
| The resource associated with this template-linked policy. |
---
-##### `policyTemplate`Required
+##### `policyTemplate`Required
```typescript
public readonly policyTemplate: IPolicyTemplate;
```
-- *Type:* IPolicyTemplate
+- *Type:* IPolicyTemplate
The unique identifier of the policy template used to create this policy.
---
-##### `principal`Optional
+##### `principal`Optional
```typescript
public readonly principal: EntityIdentifierProperty;
```
-- *Type:* EntityIdentifierProperty
+- *Type:* EntityIdentifierProperty
- *Default:* No Principal. It is set to unspecified.
The principal associated with this template-linked policy.
---
-##### `resource`Optional
+##### `resource`Optional
```typescript
public readonly resource: EntityIdentifierProperty;
```
-- *Type:* EntityIdentifierProperty
+- *Type:* EntityIdentifierProperty
- *Default:* No Resource. It is set to unspecified.
The resource associated with this template-linked policy.
@@ -2153,12 +2153,12 @@ The resource associated with this template-linked policy.
## Classes
-### Statement
+### Statement
-#### Initializers
+#### Initializers
```typescript
-import { Statement } from 'cdk-verified-permissions'
+import { Statement } from '@cdklabs/cdk-verified-permissions'
new Statement()
```
@@ -2173,22 +2173,22 @@ new Statement()
| **Name** | **Description** |
| --- | --- |
-| fromFile
| Loads the statement from a local disk path. |
-| fromInline
| Inline statement for policy. |
+| fromFile
| Loads the statement from a local disk path. |
+| fromInline
| Inline statement for policy. |
---
-##### `fromFile`
+##### `fromFile`
```typescript
-import { Statement } from 'cdk-verified-permissions'
+import { Statement } from '@cdklabs/cdk-verified-permissions'
Statement.fromFile(path: string)
```
Loads the statement from a local disk path.
-###### `path`Required
+###### `path`Required
- *Type:* string
@@ -2196,17 +2196,17 @@ A path with the policy statement.
---
-##### `fromInline`
+##### `fromInline`
```typescript
-import { Statement } from 'cdk-verified-permissions'
+import { Statement } from '@cdklabs/cdk-verified-permissions'
Statement.fromInline(statement: string)
```
Inline statement for policy.
-###### `statement`Required
+###### `statement`Required
- *Type:* string
@@ -2218,26 +2218,26 @@ The actual statement.
## Protocols
-### IIdentitySource
+### IIdentitySource
- *Extends:* aws-cdk-lib.IResource
-- *Implemented By:* IdentitySource, IIdentitySource
+- *Implemented By:* IdentitySource, IIdentitySource
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
-| node
| constructs.Node
| The tree node. |
-| env
| aws-cdk-lib.ResourceEnvironment
| The environment this resource belongs to. |
-| stack
| aws-cdk-lib.Stack
| The stack in which this resource is defined. |
-| identitySourceArn
| string
| Identity Source ARN. |
-| identitySourceId
| string
| Identity Source identifier. |
+| node
| constructs.Node
| The tree node. |
+| env
| aws-cdk-lib.ResourceEnvironment
| The environment this resource belongs to. |
+| stack
| aws-cdk-lib.Stack
| The stack in which this resource is defined. |
+| identitySourceArn
| string
| Identity Source ARN. |
+| identitySourceId
| string
| Identity Source identifier. |
---
-##### `node`Required
+##### `node`Required
```typescript
public readonly node: Node;
@@ -2249,7 +2249,7 @@ The tree node.
---
-##### `env`Required
+##### `env`Required
```typescript
public readonly env: ResourceEnvironment;
@@ -2268,7 +2268,7 @@ that might be different than the stack they were imported into.
---
-##### `stack`Required
+##### `stack`Required
```typescript
public readonly stack: Stack;
@@ -2280,7 +2280,7 @@ The stack in which this resource is defined.
---
-##### `identitySourceArn`Required
+##### `identitySourceArn`Required
```typescript
public readonly identitySourceArn: string;
@@ -2292,7 +2292,7 @@ Identity Source ARN.
---
-##### `identitySourceId`Required
+##### `identitySourceId`Required
```typescript
public readonly identitySourceId: string;
@@ -2304,26 +2304,26 @@ Identity Source identifier.
---
-### IPolicy
+### IPolicy
- *Extends:* aws-cdk-lib.IResource
-- *Implemented By:* Policy, IPolicy
+- *Implemented By:* Policy, IPolicy
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
-| node
| constructs.Node
| The tree node. |
-| env
| aws-cdk-lib.ResourceEnvironment
| The environment this resource belongs to. |
-| stack
| aws-cdk-lib.Stack
| The stack in which this resource is defined. |
-| policyId
| string
| The unique ID of the new or updated policy. |
-| policyType
| PolicyType
| The type of the policy. |
+| node
| constructs.Node
| The tree node. |
+| env
| aws-cdk-lib.ResourceEnvironment
| The environment this resource belongs to. |
+| stack
| aws-cdk-lib.Stack
| The stack in which this resource is defined. |
+| policyId
| string
| The unique ID of the new or updated policy. |
+| policyType
| PolicyType
| The type of the policy. |
---
-##### `node`Required
+##### `node`Required
```typescript
public readonly node: Node;
@@ -2335,7 +2335,7 @@ The tree node.
---
-##### `env`Required
+##### `env`Required
```typescript
public readonly env: ResourceEnvironment;
@@ -2354,7 +2354,7 @@ that might be different than the stack they were imported into.
---
-##### `stack`Required
+##### `stack`Required
```typescript
public readonly stack: Stack;
@@ -2366,7 +2366,7 @@ The stack in which this resource is defined.
---
-##### `policyId`Required
+##### `policyId`Required
```typescript
public readonly policyId: string;
@@ -2378,13 +2378,13 @@ The unique ID of the new or updated policy.
---
-##### `policyType`Required
+##### `policyType`Required
```typescript
public readonly policyType: PolicyType;
```
-- *Type:* PolicyType
+- *Type:* PolicyType
The type of the policy.
@@ -2392,24 +2392,24 @@ This is one of the following values: Static or TemplateLinked.
---
-### IPolicyStore
+### IPolicyStore
- *Extends:* aws-cdk-lib.IResource
-- *Implemented By:* PolicyStore, IPolicyStore
+- *Implemented By:* PolicyStore, IPolicyStore
#### Methods
| **Name** | **Description** |
| --- | --- |
-| grant
| Adds an IAM policy statement associated with this policy store to an IAM principal's policy. |
-| grantAuth
| Permits an IAM principal all auth operations on the policy store: IsAuthorized, IsAuthorizedWithToken. |
-| grantRead
| Permits an IAM principal all read operations on the policy store: GetIdentitySource, GetPolicy, GetPolicyStore, GetPolicyTemplate, GetSchema, ListIdentitySources, ListPolicies, ListPolicyTemplates. |
-| grantWrite
| Permits an IAM principal all write & read operations on the policy store: CreateIdentitySource, CreatePolicy,CreatePolicyTemplate, DeleteIdentitySource, DeletePolicy, DeletePolicyTemplate, PutSchema, UpdateIdentitySource, UpdatePolicy, UpdatePolicyTemplate. |
+| grant
| Adds an IAM policy statement associated with this policy store to an IAM principal's policy. |
+| grantAuth
| Permits an IAM principal all auth operations on the policy store: IsAuthorized, IsAuthorizedWithToken. |
+| grantRead
| Permits an IAM principal all read operations on the policy store: GetIdentitySource, GetPolicy, GetPolicyStore, GetPolicyTemplate, GetSchema, ListIdentitySources, ListPolicies, ListPolicyTemplates. |
+| grantWrite
| Permits an IAM principal all write & read operations on the policy store: CreateIdentitySource, CreatePolicy,CreatePolicyTemplate, DeleteIdentitySource, DeletePolicy, DeletePolicyTemplate, PutSchema, UpdateIdentitySource, UpdatePolicy, UpdatePolicyTemplate. |
---
-##### `grant`
+##### `grant`
```typescript
public grant(grantee: IGrantable, actions: string): Grant
@@ -2417,7 +2417,7 @@ public grant(grantee: IGrantable, actions: string): Grant
Adds an IAM policy statement associated with this policy store to an IAM principal's policy.
-###### `grantee`Required
+###### `grantee`Required
- *Type:* aws-cdk-lib.aws_iam.IGrantable
@@ -2425,7 +2425,7 @@ The principal (no-op if undefined).
---
-###### `actions`Required
+###### `actions`Required
- *Type:* string
@@ -2433,7 +2433,7 @@ The set of actions to allow (i.e. "verifiedpermissions:IsAuthorized", "verifiedp
---
-##### `grantAuth`
+##### `grantAuth`
```typescript
public grantAuth(grantee: IGrantable): Grant
@@ -2441,13 +2441,13 @@ public grantAuth(grantee: IGrantable): Grant
Permits an IAM principal all auth operations on the policy store: IsAuthorized, IsAuthorizedWithToken.
-###### `grantee`Required
+###### `grantee`Required
- *Type:* aws-cdk-lib.aws_iam.IGrantable
---
-##### `grantRead`
+##### `grantRead`
```typescript
public grantRead(grantee: IGrantable): Grant
@@ -2455,13 +2455,13 @@ public grantRead(grantee: IGrantable): Grant
Permits an IAM principal all read operations on the policy store: GetIdentitySource, GetPolicy, GetPolicyStore, GetPolicyTemplate, GetSchema, ListIdentitySources, ListPolicies, ListPolicyTemplates.
-###### `grantee`Required
+###### `grantee`Required
- *Type:* aws-cdk-lib.aws_iam.IGrantable
---
-##### `grantWrite`
+##### `grantWrite`
```typescript
public grantWrite(grantee: IGrantable): Grant
@@ -2469,7 +2469,7 @@ public grantWrite(grantee: IGrantable): Grant
Permits an IAM principal all write & read operations on the policy store: CreateIdentitySource, CreatePolicy,CreatePolicyTemplate, DeleteIdentitySource, DeletePolicy, DeletePolicyTemplate, PutSchema, UpdateIdentitySource, UpdatePolicy, UpdatePolicyTemplate.
-###### `grantee`Required
+###### `grantee`Required
- *Type:* aws-cdk-lib.aws_iam.IGrantable
@@ -2479,15 +2479,15 @@ Permits an IAM principal all write & read operations on the policy store: Create
| **Name** | **Type** | **Description** |
| --- | --- | --- |
-| node
| constructs.Node
| The tree node. |
-| env
| aws-cdk-lib.ResourceEnvironment
| The environment this resource belongs to. |
-| stack
| aws-cdk-lib.Stack
| The stack in which this resource is defined. |
-| policyStoreArn
| string
| ARN of the Policy Store. |
-| policyStoreId
| string
| ID of the Policy Store. |
+| node
| constructs.Node
| The tree node. |
+| env
| aws-cdk-lib.ResourceEnvironment
| The environment this resource belongs to. |
+| stack
| aws-cdk-lib.Stack
| The stack in which this resource is defined. |
+| policyStoreArn
| string
| ARN of the Policy Store. |
+| policyStoreId
| string
| ID of the Policy Store. |
---
-##### `node`Required
+##### `node`Required
```typescript
public readonly node: Node;
@@ -2499,7 +2499,7 @@ The tree node.
---
-##### `env`Required
+##### `env`Required
```typescript
public readonly env: ResourceEnvironment;
@@ -2518,7 +2518,7 @@ that might be different than the stack they were imported into.
---
-##### `stack`Required
+##### `stack`Required
```typescript
public readonly stack: Stack;
@@ -2530,7 +2530,7 @@ The stack in which this resource is defined.
---
-##### `policyStoreArn`Required
+##### `policyStoreArn`Required
```typescript
public readonly policyStoreArn: string;
@@ -2542,7 +2542,7 @@ ARN of the Policy Store.
---
-##### `policyStoreId`Required
+##### `policyStoreId`Required
```typescript
public readonly policyStoreId: string;
@@ -2554,25 +2554,25 @@ ID of the Policy Store.
---
-### IPolicyTemplate
+### IPolicyTemplate
- *Extends:* aws-cdk-lib.IResource
-- *Implemented By:* PolicyTemplate, IPolicyTemplate
+- *Implemented By:* PolicyTemplate, IPolicyTemplate
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
-| node
| constructs.Node
| The tree node. |
-| env
| aws-cdk-lib.ResourceEnvironment
| The environment this resource belongs to. |
-| stack
| aws-cdk-lib.Stack
| The stack in which this resource is defined. |
-| policyTemplateId
| string
| The ID of the policy template. |
+| node
| constructs.Node
| The tree node. |
+| env
| aws-cdk-lib.ResourceEnvironment
| The environment this resource belongs to. |
+| stack
| aws-cdk-lib.Stack
| The stack in which this resource is defined. |
+| policyTemplateId
| string
| The ID of the policy template. |
---
-##### `node`Required
+##### `node`Required
```typescript
public readonly node: Node;
@@ -2584,7 +2584,7 @@ The tree node.
---
-##### `env`Required
+##### `env`Required
```typescript
public readonly env: ResourceEnvironment;
@@ -2603,7 +2603,7 @@ that might be different than the stack they were imported into.
---
-##### `stack`Required
+##### `stack`Required
```typescript
public readonly stack: Stack;
@@ -2615,7 +2615,7 @@ The stack in which this resource is defined.
---
-##### `policyTemplateId`Required
+##### `policyTemplateId`Required
```typescript
public readonly policyTemplateId: string;
@@ -2627,20 +2627,20 @@ The ID of the policy template.
---
-### ISchema
+### ISchema
-- *Implemented By:* ISchema
+- *Implemented By:* ISchema
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
-| cedarJson
| string
| *No description.* |
+| cedarJson
| string
| *No description.* |
---
-##### `cedarJson`Required
+##### `cedarJson`Required
```typescript
public readonly cedarJson: string;
@@ -2650,32 +2650,32 @@ public readonly cedarJson: string;
---
-### IValidationSettings
+### IValidationSettings
-- *Implemented By:* IValidationSettings
+- *Implemented By:* IValidationSettings
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
-| mode
| ValidationSettingsMode
| *No description.* |
+| mode
| ValidationSettingsMode
| *No description.* |
---
-##### `mode`Required
+##### `mode`Required
```typescript
public readonly mode: ValidationSettingsMode;
```
-- *Type:* ValidationSettingsMode
+- *Type:* ValidationSettingsMode
---
## Enums
-### PolicyType
+### PolicyType
PolicyType options.
@@ -2683,22 +2683,22 @@ PolicyType options.
| **Name** | **Description** |
| --- | --- |
-| STATIC
| *No description.* |
-| TEMPLATELINKED
| *No description.* |
+| STATIC
| *No description.* |
+| TEMPLATELINKED
| *No description.* |
---
-##### `STATIC`
+##### `STATIC`
---
-##### `TEMPLATELINKED`
+##### `TEMPLATELINKED`
---
-### ValidationSettingsMode
+### ValidationSettingsMode
Validation Settings mode, according to the Cloudformation PolicyStore resource.
@@ -2706,17 +2706,17 @@ Validation Settings mode, according to the Cloudformation PolicyStore resource.
| **Name** | **Description** |
| --- | --- |
-| OFF
| *No description.* |
-| STRICT
| *No description.* |
+| OFF
| *No description.* |
+| STRICT
| *No description.* |
---
-##### `OFF`
+##### `OFF`
---
-##### `STRICT`
+##### `STRICT`
---
diff --git a/package.json b/package.json
index 5947eea..6c1a89b 100644
--- a/package.json
+++ b/package.json
@@ -1,5 +1,5 @@
{
- "name": "cdk-verified-permissions",
+ "name": "@cdklabs/cdk-verified-permissions",
"description": "L2 AWS CDK Constructs for Amazon Verified Permissions",
"repository": {
"type": "git",
@@ -135,23 +135,22 @@
"outdir": "dist",
"targets": {
"java": {
- "package": "io.github.cdklabs.verifiedpermissions",
+ "package": "io.github.cdklabs.cdk.verified.permissions",
"maven": {
"groupId": "io.github.cdklabs",
"artifactId": "cdk-verified-permissions"
}
},
"python": {
- "distName": "cdk-verified-permissions",
- "module": "cdk_verified_permissions"
+ "distName": "cdklabs.cdk-verified-permissions",
+ "module": "cdklabs.cdk_verified_permissions"
},
"dotnet": {
- "namespace": "Cdklabs.VerifiedPermissions",
- "packageId": "Cdklabs.VerifiedPermissions"
+ "namespace": "Cdklabs.CdkVerifiedPermissions",
+ "packageId": "Cdklabs.CdkVerifiedPermissions"
},
"go": {
- "moduleName": "github.com/cdklabs/cdk-verified-permissions-go",
- "packageName": "cdk-verified-permissions-go"
+ "moduleName": "github.com/cdklabs/cdk-verified-permissions-go"
}
},
"tsc": {
diff --git a/rosetta/default.ts-fixture b/rosetta/default.ts-fixture
index 99fc4ca..abd1030 100644
--- a/rosetta/default.ts-fixture
+++ b/rosetta/default.ts-fixture
@@ -1,5 +1,5 @@
// Fixture with packages imported, but nothing else
-import { IdentitySource, Policy, PolicyType, PolicyTemplate, AddPolicyOptions, PolicyStore, ValidationSettingsMode, Statement } from 'cdk-verified-permissions';
+import { IdentitySource, Policy, PolicyType, PolicyTemplate, AddPolicyOptions, PolicyStore, ValidationSettingsMode, Statement } from '@cdklabs/cdk-verified-permissions';
import { UserPool } from 'aws-cdk-lib/aws-cognito';
import { Stack } from 'aws-cdk-lib';
import { Construct } from 'constructs';