# API Reference ## Constructs ### CostReport Represents a Cost Report construct in AWS CDK. This class creates an AWS Cost and Usage Report, stored in an S3 bucket, and configures the necessary permissions. *Example* ```typescript const report = new CostReport(stack, 'MyReport', { costReportName: 'business-report', reportGranularity: ReportGranularity.MONTHLY, format: CurFormat.PARQUET }); ``` #### Initializers ```typescript import { aws_cur } from '@open-constructs/aws-cdk' new aws_cur.CostReport(scope: Construct, id: string, props: CostReportProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | @open-constructs/aws-cdk.aws_cur.CostReportProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* @open-constructs/aws-cdk.aws_cur.CostReportProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```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`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **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. | --- ##### `isConstruct` ```typescript import { aws_cur } from '@open-constructs/aws-cdk' aws_cur.CostReport.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`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { aws_cur } from '@open-constructs/aws-cdk' aws_cur.CostReport.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { aws_cur } from '@open-constructs/aws-cdk' aws_cur.CostReport.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- #### 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. | | costReportName | string | The name of the cost report. | | reportBucket | aws-cdk-lib.aws_s3.IBucket | The S3 bucket that stores the cost report. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `costReportName`^Required ```typescript public readonly costReportName: string; ``` - *Type:* string The name of the cost report. --- ##### `reportBucket`^Required ```typescript public readonly reportBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket The S3 bucket that stores the cost report. --- ### Domain - *Implements:* @open-constructs/aws-cdk.aws_codeartifact.IDomain Deploys a CodeArtifact domain. #### Initializers ```typescript import { aws_codeartifact } from '@open-constructs/aws-cdk' new aws_codeartifact.Domain(scope: Construct, id: string, props: DomainProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | @open-constructs/aws-cdk.aws_codeartifact.DomainProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* @open-constructs/aws-cdk.aws_codeartifact.DomainProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addToResourcePolicy | Adds a statement to the Codeartifact domain resource policy. | | grant | Grants permissions to the specified grantee on this CodeArtifact domain. | | grantContribute | Grants contribute permissions to the specified grantee on this CodeArtifact domain. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```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`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- ##### `addToResourcePolicy` ```typescript public addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResult ``` Adds a statement to the Codeartifact domain resource policy. ###### `statement`^Required - *Type:* aws-cdk-lib.aws_iam.PolicyStatement The policy statement to add. --- ##### `grant` ```typescript public grant(grantee: IGrantable, actions: ...string[]): Grant ``` Grants permissions to the specified grantee on this CodeArtifact domain. It handles both same-environment and cross-environment scenarios: - For same-environment grants, it adds the permissions to the principal or resource. - For cross-environment grants, it adds the permissions to both the principal and the resource. ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable The principal to grant permissions to. --- ###### `actions`^Required - *Type:* ...string[] The actions to grant. These should be valid CodeArtifact actions. --- ##### `grantContribute` ```typescript public grantContribute(grantee: IGrantable): Grant ``` Grants contribute permissions to the specified grantee on this CodeArtifact domain. ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable The principal to grant contribute permissions to. --- #### Static Functions | **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. | | fromDomainArn | Creates an IDomain object from an existing CodeArtifact domain ARN. | | fromDomainAttributes | Creates a Domain object from existing domain attributes. | --- ##### `isConstruct` ```typescript import { aws_codeartifact } from '@open-constructs/aws-cdk' aws_codeartifact.Domain.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`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { aws_codeartifact } from '@open-constructs/aws-cdk' aws_codeartifact.Domain.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { aws_codeartifact } from '@open-constructs/aws-cdk' aws_codeartifact.Domain.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromDomainArn` ```typescript import { aws_codeartifact } from '@open-constructs/aws-cdk' aws_codeartifact.Domain.fromDomainArn(scope: Construct, id: string, domainArn: string) ``` Creates an IDomain object from an existing CodeArtifact domain ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent construct. --- ###### `id`^Required - *Type:* string The construct id. --- ###### `domainArn`^Required - *Type:* string The ARN (Amazon Resource Name) of the existing CodeArtifact domain. --- ##### `fromDomainAttributes` ```typescript import { aws_codeartifact } from '@open-constructs/aws-cdk' aws_codeartifact.Domain.fromDomainAttributes(scope: Construct, id: string, attrs: DomainAttributes) ``` Creates a Domain object from existing domain attributes. ###### `scope`^Required - *Type:* constructs.Construct The parent construct. --- ###### `id`^Required - *Type:* string The construct id. --- ###### `attrs`^Required - *Type:* @open-constructs/aws-cdk.aws_codeartifact.DomainAttributes The attributes of the domain to import. --- #### 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. | | domainArn | string | The ARN (Amazon Resource Name) of this CodeArtifact domain. | | domainName | string | The name of this CodeArtifact domain. | | domainOwner | string | The AWS account ID that owns this domain. | | domainEncryptionKey | string | The ARN of the key used to encrypt the Domain. | | encryptionKey | aws-cdk-lib.aws_kms.IKey | The AWS KMS encryption key associated with this domain, if any. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `domainArn`^Required ```typescript public readonly domainArn: string; ``` - *Type:* string The ARN (Amazon Resource Name) of this CodeArtifact domain. --- ##### `domainName`^Required ```typescript public readonly domainName: string; ``` - *Type:* string The name of this CodeArtifact domain. --- ##### `domainOwner`^Required ```typescript public readonly domainOwner: string; ``` - *Type:* string The AWS account ID that owns this domain. --- ##### `domainEncryptionKey`^Optional ```typescript public readonly domainEncryptionKey: string; ``` - *Type:* string The ARN of the key used to encrypt the Domain. --- ##### `encryptionKey`^Optional ```typescript public readonly encryptionKey: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey The AWS KMS encryption key associated with this domain, if any. --- ### IamUser - *Implements:* @open-constructs/aws-cdk.aws_elasticache.IIamUser, @open-constructs/aws-cdk.aws_elasticache.IUser Represents an IAM-enabled user construct in AWS CDK. *Example* ```typescript const user = new IamUser( stack, 'User', { accessString: 'on ~* +@all', }, ); ``` #### Initializers ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' new aws_elasticache.IamUser(scope: Construct, id: string, props?: IamUserProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | @open-constructs/aws-cdk.aws_elasticache.IamUserProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Optional - *Type:* @open-constructs/aws-cdk.aws_elasticache.IamUserProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | grant | Grant the given identity the specified actions. | | grantConnect | Permits an IAM principal to perform connect to the user. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```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`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- ##### `grant` ```typescript public grant(grantee: IGrantable, actions: ...string[]): Grant ``` Grant the given identity the specified actions. > [https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonelasticache.html](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonelasticache.html) ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable the identity to be granted the actions. --- ###### `actions`^Required - *Type:* ...string[] the data-access actions. --- ##### `grantConnect` ```typescript public grantConnect(grantee: IGrantable): Grant ``` Permits an IAM principal to perform connect to the user. Actions: Connect > [https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/auth-iam.html](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/auth-iam.html) ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable The principal to grant access to. --- #### Static Functions | **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. | | fromUserId | Imports an existing IAM-enabled user from userId. | --- ##### `isConstruct` ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' aws_elasticache.IamUser.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`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' aws_elasticache.IamUser.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' aws_elasticache.IamUser.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromUserId` ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' aws_elasticache.IamUser.fromUserId(scope: Construct, id: string, userId: string) ``` Imports an existing IAM-enabled user from userId. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `userId`^Required - *Type:* string --- #### 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. | | userArn | string | The ARN of the user. | | userId | string | The ID of the user. | | userName | string | The name of the user. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `userArn`^Required ```typescript public readonly userArn: string; ``` - *Type:* string The ARN of the user. --- ##### `userId`^Required ```typescript public readonly userId: string; ``` - *Type:* string The ID of the user. --- ##### `userName`^Required ```typescript public readonly userName: string; ``` - *Type:* string The name of the user. --- ### InstanceConnectEndpoint - *Implements:* @open-constructs/aws-cdk.aws_ec2.IInstanceConnectEndpoint Represents an EC2 Instance Connect Endpoint construct in AWS CDK. *Example* ```typescript declare const securityGroups: aws_ec2.ISecurityGroup[]; declare const vpc: aws_ec2.IVpc; const instanceConnectEndpoint = new InstanceConnectEndpoint( stack, 'InstanceConnectEndpoint', { clientToken: 'my-client-token', preserveClientIp: true, securityGroups, vpc, }, ); ``` #### Initializers ```typescript import { aws_ec2 } from '@open-constructs/aws-cdk' new aws_ec2.InstanceConnectEndpoint(scope: Construct, id: string, props: InstanceConnectEndpointProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | @open-constructs/aws-cdk.aws_ec2.InstanceConnectEndpointProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* @open-constructs/aws-cdk.aws_ec2.InstanceConnectEndpointProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```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`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **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. | | fromInstanceConnectEndpointAttributes | Import an existing endpoint to the stack from its attributes. | --- ##### `isConstruct` ```typescript import { aws_ec2 } from '@open-constructs/aws-cdk' aws_ec2.InstanceConnectEndpoint.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`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { aws_ec2 } from '@open-constructs/aws-cdk' aws_ec2.InstanceConnectEndpoint.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { aws_ec2 } from '@open-constructs/aws-cdk' aws_ec2.InstanceConnectEndpoint.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromInstanceConnectEndpointAttributes` ```typescript import { aws_ec2 } from '@open-constructs/aws-cdk' aws_ec2.InstanceConnectEndpoint.fromInstanceConnectEndpointAttributes(scope: Construct, id: string, attrs: InstanceConnectEndpointAttributes) ``` Import an existing endpoint to the stack from its attributes. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `attrs`^Required - *Type:* @open-constructs/aws-cdk.aws_ec2.InstanceConnectEndpointAttributes --- #### 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. | | connections | aws-cdk-lib.aws_ec2.Connections | The connection object associated with the EC2 Instance Connect Endpoint. | | instanceConnectEndpointId | string | The ID of the EC2 Instance Connect Endpoint. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `connections`^Required ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections The connection object associated with the EC2 Instance Connect Endpoint. --- ##### `instanceConnectEndpointId`^Required ```typescript public readonly instanceConnectEndpointId: string; ``` - *Type:* string The ID of the EC2 Instance Connect Endpoint. --- ### Namespace - *Implements:* @open-constructs/aws-cdk.aws_redshiftserverless.INamespace Represents a Redshift Serverless Namespace construct in AWS CDK. *Example* ```typescript const nameSpace = new Namespace( stack, 'Namespace', { namespaceName: 'my-namespace', }, ); ``` #### Initializers ```typescript import { aws_redshiftserverless } from '@open-constructs/aws-cdk' new aws_redshiftserverless.Namespace(scope: Construct, id: string, props: NamespaceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | @open-constructs/aws-cdk.aws_redshiftserverless.NamespaceProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* @open-constructs/aws-cdk.aws_redshiftserverless.NamespaceProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addIamRole | Adds a role to the namespace. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```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`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- ##### `addIamRole` ```typescript public addIamRole(role: IRole): void ``` Adds a role to the namespace. ###### `role`^Required - *Type:* aws-cdk-lib.aws_iam.IRole the role to add. --- #### Static Functions | **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. | | fromNamespaceAttributes | Imports an existing Namespace from attributes. | --- ##### `isConstruct` ```typescript import { aws_redshiftserverless } from '@open-constructs/aws-cdk' aws_redshiftserverless.Namespace.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`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { aws_redshiftserverless } from '@open-constructs/aws-cdk' aws_redshiftserverless.Namespace.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { aws_redshiftserverless } from '@open-constructs/aws-cdk' aws_redshiftserverless.Namespace.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromNamespaceAttributes` ```typescript import { aws_redshiftserverless } from '@open-constructs/aws-cdk' aws_redshiftserverless.Namespace.fromNamespaceAttributes(scope: Construct, id: string, attrs: NamespaceAttributes) ``` Imports an existing Namespace from attributes. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `attrs`^Required - *Type:* @open-constructs/aws-cdk.aws_redshiftserverless.NamespaceAttributes --- #### 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. | | namespaceArn | string | The namespace Arn. | | namespaceId | string | The namespace id. | | namespaceName | string | The namespace name. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `namespaceArn`^Required ```typescript public readonly namespaceArn: string; ``` - *Type:* string The namespace Arn. --- ##### `namespaceId`^Required ```typescript public readonly namespaceId: string; ``` - *Type:* string The namespace id. --- ##### `namespaceName`^Required ```typescript public readonly namespaceName: string; ``` - *Type:* string The namespace name. --- ### NoPasswordRequiredUser - *Implements:* @open-constructs/aws-cdk.aws_elasticache.INoPasswordRequiredUser, @open-constructs/aws-cdk.aws_elasticache.IUser Represents a no password required user construct in AWS CDK. *Example* ```typescript const user = new NoPasswordRequiredUser( stack, 'User', { userName: 'my-user', accessString: 'on ~* +@all', }, ); ``` #### Initializers ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' new aws_elasticache.NoPasswordRequiredUser(scope: Construct, id: string, props?: NoPasswordRequiredUserProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | @open-constructs/aws-cdk.aws_elasticache.NoPasswordRequiredUserProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Optional - *Type:* @open-constructs/aws-cdk.aws_elasticache.NoPasswordRequiredUserProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```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`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **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. | | fromUserAttributes | Imports an existing no password required user from attributes. | --- ##### `isConstruct` ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' aws_elasticache.NoPasswordRequiredUser.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`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' aws_elasticache.NoPasswordRequiredUser.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' aws_elasticache.NoPasswordRequiredUser.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromUserAttributes` ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' aws_elasticache.NoPasswordRequiredUser.fromUserAttributes(scope: Construct, id: string, attrs: NoPasswordUserAttributes) ``` Imports an existing no password required user from attributes. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `attrs`^Required - *Type:* @open-constructs/aws-cdk.aws_elasticache.NoPasswordUserAttributes --- #### 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. | | userArn | string | The ARN of the user. | | userId | string | The ID of the user. | | userName | string | The name of the user. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `userArn`^Required ```typescript public readonly userArn: string; ``` - *Type:* string The ARN of the user. --- ##### `userId`^Required ```typescript public readonly userId: string; ``` - *Type:* string The ID of the user. --- ##### `userName`^Required ```typescript public readonly userName: string; ``` - *Type:* string The name of the user. --- ### OntapFileSystem The FSx for NetApp ONTAP File System implementation of IFileSystem. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html) #### Initializers ```typescript import { aws_fsx } from '@open-constructs/aws-cdk' new aws_fsx.OntapFileSystem(scope: Construct, id: string, props: OntapFileSystemProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | @open-constructs/aws-cdk.aws_fsx.OntapFileSystemProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* @open-constructs/aws-cdk.aws_fsx.OntapFileSystemProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```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`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **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. | | fromOntapFileSystemAttributes | Import an existing FSx for NetApp ONTAP file system from the given properties. | --- ##### `isConstruct` ```typescript import { aws_fsx } from '@open-constructs/aws-cdk' aws_fsx.OntapFileSystem.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`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { aws_fsx } from '@open-constructs/aws-cdk' aws_fsx.OntapFileSystem.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { aws_fsx } from '@open-constructs/aws-cdk' aws_fsx.OntapFileSystem.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromOntapFileSystemAttributes` ```typescript import { aws_fsx } from '@open-constructs/aws-cdk' aws_fsx.OntapFileSystem.fromOntapFileSystemAttributes(scope: Construct, id: string, attrs: FileSystemAttributes) ``` Import an existing FSx for NetApp ONTAP file system from the given properties. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `attrs`^Required - *Type:* aws-cdk-lib.aws_fsx.FileSystemAttributes --- #### 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. | | connections | aws-cdk-lib.aws_ec2.Connections | The security groups/rules used to allow network connections to the file system. | | dnsName | string | The management endpoint DNS name assigned to this file system. | | fileSystemId | string | The ID that AWS assigns to the file system. | | interClusterDnsName | string | The inter cluster endpoint DNS name assigned to this file system. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `connections`^Required ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections The security groups/rules used to allow network connections to the file system. --- ##### `dnsName`^Required ```typescript public readonly dnsName: string; ``` - *Type:* string The management endpoint DNS name assigned to this file system. --- ##### `fileSystemId`^Required ```typescript public readonly fileSystemId: string; ``` - *Type:* string The ID that AWS assigns to the file system. --- ##### `interClusterDnsName`^Required ```typescript public readonly interClusterDnsName: string; ``` - *Type:* string The inter cluster endpoint DNS name assigned to this file system. --- ### PasswordUser - *Implements:* @open-constructs/aws-cdk.aws_elasticache.IPasswordUser, @open-constructs/aws-cdk.aws_elasticache.IUser Represents a password authentication user construct in AWS CDK. *Example* ```typescript const user = new PasswordUser( stack, 'User', { passwords: [ cdk.SecretValue.unsafePlainText('exampleUserPassword123'), cdk.SecretValue.unsafePlainText('anotherUserPassword123'), ], }, ); ``` #### Initializers ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' new aws_elasticache.PasswordUser(scope: Construct, id: string, props: PasswordUserProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | @open-constructs/aws-cdk.aws_elasticache.PasswordUserProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* @open-constructs/aws-cdk.aws_elasticache.PasswordUserProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```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`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **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. | | fromUserAttributes | Imports an existing password authentication user from attributes. | --- ##### `isConstruct` ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' aws_elasticache.PasswordUser.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`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' aws_elasticache.PasswordUser.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' aws_elasticache.PasswordUser.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromUserAttributes` ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' aws_elasticache.PasswordUser.fromUserAttributes(scope: Construct, id: string, attrs: PasswordUserAttributes) ``` Imports an existing password authentication user from attributes. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `attrs`^Required - *Type:* @open-constructs/aws-cdk.aws_elasticache.PasswordUserAttributes --- #### 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. | | generatedSecret | aws-cdk-lib.aws_secretsmanager.ISecret | The secret containing the generated password. | | userArn | string | The ARN of the user. | | userId | string | The ID of the user. | | userName | string | The name of the user. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `generatedSecret`^Required ```typescript public readonly generatedSecret: ISecret; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret The secret containing the generated password. Throws an exception if `passwords` is provided in the props --- ##### `userArn`^Required ```typescript public readonly userArn: string; ``` - *Type:* string The ARN of the user. --- ##### `userId`^Required ```typescript public readonly userId: string; ``` - *Type:* string The ID of the user. --- ##### `userName`^Required ```typescript public readonly userName: string; ``` - *Type:* string The name of the user. --- ### Repository - *Implements:* @open-constructs/aws-cdk.aws_codeartifact.IRepository Deploys a CodeArtifact repository. #### Initializers ```typescript import { aws_codeartifact } from '@open-constructs/aws-cdk' new aws_codeartifact.Repository(scope: Construct, id: string, props: RepositoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | @open-constructs/aws-cdk.aws_codeartifact.RepositoryProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* @open-constructs/aws-cdk.aws_codeartifact.RepositoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addToResourcePolicy | Adds a statement to the CodeArtifact repository resource policy. | | grant | Grants permissions to the specified grantee on this CodeArtifact repository. | | grantRead | Grants read permissions to the specified grantee on this CodeArtifact repository. | | grantReadAndPublish | Grants read and publish permissions to the specified grantee on this CodeArtifact repository. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```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`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- ##### `addToResourcePolicy` ```typescript public addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResult ``` Adds a statement to the CodeArtifact repository resource policy. ###### `statement`^Required - *Type:* aws-cdk-lib.aws_iam.PolicyStatement The policy statement to add. --- ##### `grant` ```typescript public grant(grantee: IGrantable, actions: ...string[]): Grant ``` Grants permissions to the specified grantee on this CodeArtifact repository. ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable The principal to grant permissions to. --- ###### `actions`^Required - *Type:* ...string[] The actions to grant. --- ##### `grantRead` ```typescript public grantRead(grantee: IGrantable): Grant ``` Grants read permissions to the specified grantee on this CodeArtifact repository. ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable The principal to grant read permissions to. --- ##### `grantReadAndPublish` ```typescript public grantReadAndPublish(grantee: IGrantable): Grant ``` Grants read and publish permissions to the specified grantee on this CodeArtifact repository. ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable The principal to grant read and publish permissions to. --- #### Static Functions | **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. | | fromRepositoryArn | Creates an IRepository object from an existing repository ARN. | | fromRepositoryAttributes | Creates an IRepository object from existing repository attributes. | --- ##### `isConstruct` ```typescript import { aws_codeartifact } from '@open-constructs/aws-cdk' aws_codeartifact.Repository.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`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { aws_codeartifact } from '@open-constructs/aws-cdk' aws_codeartifact.Repository.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { aws_codeartifact } from '@open-constructs/aws-cdk' aws_codeartifact.Repository.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromRepositoryArn` ```typescript import { aws_codeartifact } from '@open-constructs/aws-cdk' aws_codeartifact.Repository.fromRepositoryArn(scope: Construct, id: string, repositoryArn: string) ``` Creates an IRepository object from an existing repository ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent construct in which to create this repository reference. --- ###### `id`^Required - *Type:* string The identifier of the construct. --- ###### `repositoryArn`^Required - *Type:* string The ARN of the repository to import. --- ##### `fromRepositoryAttributes` ```typescript import { aws_codeartifact } from '@open-constructs/aws-cdk' aws_codeartifact.Repository.fromRepositoryAttributes(scope: Construct, id: string, attrs: RepositoryAttributes) ``` Creates an IRepository object from existing repository attributes. ###### `scope`^Required - *Type:* constructs.Construct The parent construct in which to create this repository reference. --- ###### `id`^Required - *Type:* string The identifier of the construct. --- ###### `attrs`^Required - *Type:* @open-constructs/aws-cdk.aws_codeartifact.RepositoryAttributes The attributes of the repository to import. --- #### 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. | | domain | @open-constructs/aws-cdk.aws_codeartifact.IDomain | The domain that contains this repository. | | repositoryArn | string | The ARN (Amazon Resource Name) of this CodeArtifact repository. | | repositoryDomainName | string | The domain that contains this repository. | | repositoryDomainOwner | string | The domain owner of this repository. | | repositoryName | string | The name of this CodeArtifact repository. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `domain`^Required ```typescript public readonly domain: IDomain; ``` - *Type:* @open-constructs/aws-cdk.aws_codeartifact.IDomain The domain that contains this repository. --- ##### `repositoryArn`^Required ```typescript public readonly repositoryArn: string; ``` - *Type:* string The ARN (Amazon Resource Name) of this CodeArtifact repository. --- ##### `repositoryDomainName`^Required ```typescript public readonly repositoryDomainName: string; ``` - *Type:* string The domain that contains this repository. --- ##### `repositoryDomainOwner`^Required ```typescript public readonly repositoryDomainOwner: string; ``` - *Type:* string The domain owner of this repository. --- ##### `repositoryName`^Required ```typescript public readonly repositoryName: string; ``` - *Type:* string The name of this CodeArtifact repository. --- ### ServerlessCache - *Implements:* @open-constructs/aws-cdk.aws_elasticache.IServerlessCache Represents an ElastiCache Serverless Cache construct in AWS CDK. *Example* ```typescript declare const vpc: aws_ec2.IVpc; const serverlessCache = new ServerlessCache( stack, 'ServerlessCache', { serverlessCacheName: 'my-serverlessCache', engine: Engine.VALKEY, vpc, }, ); ``` #### Initializers ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' new aws_elasticache.ServerlessCache(scope: Construct, id: string, props: ServerlessCacheProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | @open-constructs/aws-cdk.aws_elasticache.ServerlessCacheProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* @open-constructs/aws-cdk.aws_elasticache.ServerlessCacheProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | grant | Grant the given identity the specified actions. | | grantConnect | Permits an IAM principal to perform connect to the serverless cache. | | metric | Create a CloudWatch metric for serverless cache. | | metricBytesUsedForCache | Metric for the total number of bytes used by the data stored in your cache. | | metricElastiCacheProcessingUnits | Metric for the total number of ElastiCacheProcessingUnits (ECPUs) consumed by the requests executed on your cache. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```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`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- ##### `grant` ```typescript public grant(grantee: IGrantable, actions: ...string[]): Grant ``` Grant the given identity the specified actions. > [https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonelasticache.html](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonelasticache.html) ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable the identity to be granted the actions. --- ###### `actions`^Required - *Type:* ...string[] the data-access actions. --- ##### `grantConnect` ```typescript public grantConnect(grantee: IGrantable): Grant ``` Permits an IAM principal to perform connect to the serverless cache. Actions: Connect > [https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/auth-iam.html](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/auth-iam.html) ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable The principal to grant access to. --- ##### `metric` ```typescript public metric(metricName: string, props?: MetricOptions): Metric ``` Create a CloudWatch metric for serverless cache. > [https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/serverless-metrics-events.memcached.html](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/serverless-metrics-events.memcached.html) ###### `metricName`^Required - *Type:* string name of the metric. --- ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions metric options. --- ##### `metricBytesUsedForCache` ```typescript public metricBytesUsedForCache(props?: MetricOptions): Metric ``` Metric for the total number of bytes used by the data stored in your cache. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricElastiCacheProcessingUnits` ```typescript public metricElastiCacheProcessingUnits(props?: MetricOptions): Metric ``` Metric for the total number of ElastiCacheProcessingUnits (ECPUs) consumed by the requests executed on your cache. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- #### Static Functions | **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. | | fromServerlessCacheAttributes | Imports an existing ServerlessCache from attributes. | --- ##### `isConstruct` ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' aws_elasticache.ServerlessCache.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`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' aws_elasticache.ServerlessCache.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' aws_elasticache.ServerlessCache.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromServerlessCacheAttributes` ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' aws_elasticache.ServerlessCache.fromServerlessCacheAttributes(scope: Construct, id: string, attrs: ServerlessCacheAttributes) ``` Imports an existing ServerlessCache from attributes. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `attrs`^Required - *Type:* @open-constructs/aws-cdk.aws_elasticache.ServerlessCacheAttributes --- #### 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. | | connections | aws-cdk-lib.aws_ec2.Connections | The connection object associated with the ElastiCache Serverless Cache. | | endpointAddress | string | The DNS hostname of the cache node. | | endpointPort | number | The port number that the cache engine is listening on. | | serverlessCacheArn | string | The serverless cache ARN. | | serverlessCacheName | string | The serverless cache name. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `connections`^Required ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections The connection object associated with the ElastiCache Serverless Cache. --- ##### `endpointAddress`^Required ```typescript public readonly endpointAddress: string; ``` - *Type:* string The DNS hostname of the cache node. --- ##### `endpointPort`^Required ```typescript public readonly endpointPort: number; ``` - *Type:* number The port number that the cache engine is listening on. --- ##### `serverlessCacheArn`^Required ```typescript public readonly serverlessCacheArn: string; ``` - *Type:* string The serverless cache ARN. --- ##### `serverlessCacheName`^Required ```typescript public readonly serverlessCacheName: string; ``` - *Type:* string The serverless cache name. --- ### UserGroup - *Implements:* @open-constructs/aws-cdk.aws_elasticache.IUserGroup Represents a user group construct in AWS CDK. *Example* ```typescript declare const user: User; const userGroup = new UserGroup( stack, 'UserGroup', { users: [user], }, ); ``` #### Initializers ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' new aws_elasticache.UserGroup(scope: Construct, id: string, props: UserGroupProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | @open-constructs/aws-cdk.aws_elasticache.UserGroupProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* @open-constructs/aws-cdk.aws_elasticache.UserGroupProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addUser | Adds a user to the user group. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```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`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- ##### `addUser` ```typescript public addUser(user: IUser): void ``` Adds a user to the user group. ###### `user`^Required - *Type:* @open-constructs/aws-cdk.aws_elasticache.IUser the user to add. --- #### Static Functions | **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. | | fromUserGroupId | Imports an existing user group from attributes. | --- ##### `isConstruct` ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' aws_elasticache.UserGroup.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`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' aws_elasticache.UserGroup.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' aws_elasticache.UserGroup.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromUserGroupId` ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' aws_elasticache.UserGroup.fromUserGroupId(scope: Construct, id: string, userGroupId: string) ``` Imports an existing user group from attributes. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `userGroupId`^Required - *Type:* string --- #### 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. | | userGroupArn | string | The ARN of the user group. | | userGroupId | string | The ID of the user group. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `userGroupArn`^Required ```typescript public readonly userGroupArn: string; ``` - *Type:* string The ARN of the user group. --- ##### `userGroupId`^Required ```typescript public readonly userGroupId: string; ``` - *Type:* string The ID of the user group. --- ### Workgroup - *Implements:* @open-constructs/aws-cdk.aws_redshiftserverless.IWorkgroup Represents a Redshift Serverless Workgroup construct in AWS CDK. *Example* ```typescript declare const namespace: Namespace; declare const vpc: aws_ec2.IVpc; const nameSpace = new Workgroup( stack, 'Workgroup', { workgroupName: 'my-workgroup', namespace: namespace, vpc, }, ); ``` #### Initializers ```typescript import { aws_redshiftserverless } from '@open-constructs/aws-cdk' new aws_redshiftserverless.Workgroup(scope: Construct, id: string, props: WorkgroupProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | @open-constructs/aws-cdk.aws_redshiftserverless.WorkgroupProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* @open-constructs/aws-cdk.aws_redshiftserverless.WorkgroupProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```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`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **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. | | fromWorkgroupAttributes | Import an existing workgroup to the stack from its attributes. | --- ##### `isConstruct` ```typescript import { aws_redshiftserverless } from '@open-constructs/aws-cdk' aws_redshiftserverless.Workgroup.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`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { aws_redshiftserverless } from '@open-constructs/aws-cdk' aws_redshiftserverless.Workgroup.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { aws_redshiftserverless } from '@open-constructs/aws-cdk' aws_redshiftserverless.Workgroup.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromWorkgroupAttributes` ```typescript import { aws_redshiftserverless } from '@open-constructs/aws-cdk' aws_redshiftserverless.Workgroup.fromWorkgroupAttributes(scope: Construct, id: string, attrs: WorkgroupAttributes) ``` Import an existing workgroup to the stack from its attributes. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `attrs`^Required - *Type:* @open-constructs/aws-cdk.aws_redshiftserverless.WorkgroupAttributes --- #### 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. | | connections | aws-cdk-lib.aws_ec2.Connections | The connection object associated with the Redshift Serverless Workgroup. | | endpointAddress | string | The workgroup endpoint address. | | port | number | The workgroup port. | | workgroupArn | string | The workgroup Arn. | | workgroupId | string | The workgroup id. | | workgroupName | string | The workgroup name. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `connections`^Required ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections The connection object associated with the Redshift Serverless Workgroup. --- ##### `endpointAddress`^Required ```typescript public readonly endpointAddress: string; ``` - *Type:* string The workgroup endpoint address. --- ##### `port`^Required ```typescript public readonly port: number; ``` - *Type:* number The workgroup port. --- ##### `workgroupArn`^Required ```typescript public readonly workgroupArn: string; ``` - *Type:* string The workgroup Arn. --- ##### `workgroupId`^Required ```typescript public readonly workgroupId: string; ``` - *Type:* string The workgroup id. --- ##### `workgroupName`^Required ```typescript public readonly workgroupName: string; ``` - *Type:* string The workgroup name. --- ## Structs ### BaseUserProps Properties for all user types. #### Initializer ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' const baseUserProps: aws_elasticache.BaseUserProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | accessString | string | Access permissions string used for this user. | | userId | string | The ID of the user. | --- ##### `accessString`^Optional ```typescript public readonly accessString: string; ``` - *Type:* string - *Default:* 'off -@all' Access permissions string used for this user. > [https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Clusters.RBAC.html#Access-string](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Clusters.RBAC.html#Access-string) --- ##### `userId`^Optional ```typescript public readonly userId: string; ``` - *Type:* string - *Default:* auto generated The ID of the user. Must consist only of alphanumeric characters or hyphens, with the first character as a letter. Cannot end with a hyphen or contain two consecutive hyphens. --- ### CacheUsageLimits The usage limits for storage and ElastiCache Processing Units for the cache. #### Initializer ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' const cacheUsageLimits: aws_elasticache.CacheUsageLimits = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | dataStorage | @open-constructs/aws-cdk.aws_elasticache.DataStorage | The data storage limit. | | ecpuPerSecond | @open-constructs/aws-cdk.aws_elasticache.ECPUPerSecond | The configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second. | --- ##### `dataStorage`^Optional ```typescript public readonly dataStorage: DataStorage; ``` - *Type:* @open-constructs/aws-cdk.aws_elasticache.DataStorage - *Default:* no limits The data storage limit. --- ##### `ecpuPerSecond`^Optional ```typescript public readonly ecpuPerSecond: ECPUPerSecond; ``` - *Type:* @open-constructs/aws-cdk.aws_elasticache.ECPUPerSecond - *Default:* no limits The configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second. --- ### CostReportProps Properties for defining a Cost and Usage Report. #### Initializer ```typescript import { aws_cur } from '@open-constructs/aws-cdk' const costReportProps: aws_cur.CostReportProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | bucket | aws-cdk-lib.aws_s3.IBucket | The bucket to place the cost report into. | | costReportName | string | The name of the cost report. | | enableDefaultUniqueReportName | boolean | Whether to generate a unique report name automatically if the `costReportName` property is not specified. | | format | @open-constructs/aws-cdk.aws_cur.CurFormat | The format to use for the cost and usage report. | | reportGranularity | @open-constructs/aws-cdk.aws_cur.ReportGranularity | The granularity of the line items in the report. | --- ##### `bucket`^Optional ```typescript public readonly bucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket - *Default:* a new bucket will be created. The bucket to place the cost report into. If non is provided, a new bucket will be created. --- ##### `costReportName`^Optional ```typescript public readonly costReportName: string; ``` - *Type:* string - *Default:* a unique name automatically generated if `enableDefaultUniqueReportName` is true, otherwise 'default-cur'. The name of the cost report. The name must be unique, is case sensitive, and can't include spaces. The length of this name must be between 1 and 256. --- ##### `enableDefaultUniqueReportName`^Optional ```typescript public readonly enableDefaultUniqueReportName: boolean; ``` - *Type:* boolean - *Default:* false Whether to generate a unique report name automatically if the `costReportName` property is not specified. The default value of the `costReportName` is normally ‘default-cur’, but setting this flag to true will generate a unique default value. This flag is ignored if the `costReportName` property is specified. --- ##### `format`^Optional ```typescript public readonly format: CurFormat; ``` - *Type:* @open-constructs/aws-cdk.aws_cur.CurFormat - *Default:* TEXT_OR_CSV The format to use for the cost and usage report. --- ##### `reportGranularity`^Optional ```typescript public readonly reportGranularity: ReportGranularity; ``` - *Type:* @open-constructs/aws-cdk.aws_cur.ReportGranularity - *Default:* HOURLY The granularity of the line items in the report. --- ### DailyAutomaticBackupStartTimeProps Properties required for setting up a daily automatic backup time. #### Initializer ```typescript import { aws_fsx } from '@open-constructs/aws-cdk' const dailyAutomaticBackupStartTimeProps: aws_fsx.DailyAutomaticBackupStartTimeProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | hour | number | The hour of the day (from 0-23) for automatic backup starts. | | minute | number | The minute of the hour (from 0-59) for automatic backup starts. | --- ##### `hour`^Required ```typescript public readonly hour: number; ``` - *Type:* number The hour of the day (from 0-23) for automatic backup starts. --- ##### `minute`^Required ```typescript public readonly minute: number; ``` - *Type:* number The minute of the hour (from 0-59) for automatic backup starts. --- ### DailySnapshotTimeProps Properties required for setting up a daily snapshot time. #### Initializer ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' const dailySnapshotTimeProps: aws_elasticache.DailySnapshotTimeProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | hour | number | The hour of the day (from 0-23) for snapshot starts. | | minute | number | The minute of the hour (from 0-59) for snapshot starts. | --- ##### `hour`^Required ```typescript public readonly hour: number; ``` - *Type:* number The hour of the day (from 0-23) for snapshot starts. --- ##### `minute`^Required ```typescript public readonly minute: number; ``` - *Type:* number The minute of the hour (from 0-59) for snapshot starts. --- ### DataStorageOptions Interface for configuring data storage limits. #### Initializer ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' const dataStorageOptions: aws_elasticache.DataStorageOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | maximum | number | The upper limit for data storage the cache is set to use. | | minimum | number | The lower limit for data storage the cache is set to use. | --- ##### `maximum`^Optional ```typescript public readonly maximum: number; ``` - *Type:* number - *Default:* no upper limit The upper limit for data storage the cache is set to use. --- ##### `minimum`^Optional ```typescript public readonly minimum: number; ``` - *Type:* number - *Default:* no lower limit The lower limit for data storage the cache is set to use. --- ### DomainAttributes Interface representing the attributes of a CodeArtifact domain. #### Initializer ```typescript import { aws_codeartifact } from '@open-constructs/aws-cdk' const domainAttributes: aws_codeartifact.DomainAttributes = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | domainArn | string | The ARN (Amazon Resource Name) of the CodeArtifact domain. | | domainName | string | The name of the CodeArtifact domain. | | domainOwner | string | The AWS account ID that owns the domain. | | encryptionKey | aws-cdk-lib.aws_kms.IKey | The AWS KMS encryption key associated with the domain, if any. | --- ##### `domainArn`^Required ```typescript public readonly domainArn: string; ``` - *Type:* string The ARN (Amazon Resource Name) of the CodeArtifact domain. --- ##### `domainName`^Required ```typescript public readonly domainName: string; ``` - *Type:* string The name of the CodeArtifact domain. --- ##### `domainOwner`^Required ```typescript public readonly domainOwner: string; ``` - *Type:* string The AWS account ID that owns the domain. --- ##### `encryptionKey`^Optional ```typescript public readonly encryptionKey: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey The AWS KMS encryption key associated with the domain, if any. --- ### DomainProps Construction properties for `Domain`. #### Initializer ```typescript import { aws_codeartifact } from '@open-constructs/aws-cdk' const domainProps: aws_codeartifact.DomainProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | domainName | string | The name of the Domain. | | encryptionKey | aws-cdk-lib.aws_kms.IKey | The key used to encrypt the Domain. | --- ##### `domainName`^Required ```typescript public readonly domainName: string; ``` - *Type:* string The name of the Domain. --- ##### `encryptionKey`^Optional ```typescript public readonly encryptionKey: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey - *Default:* An AWS managed KMS key is used The key used to encrypt the Domain. --- ### ECPUPerSecondOptions Interface for configuring ECPU per second limits. #### Initializer ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' const eCPUPerSecondOptions: aws_elasticache.ECPUPerSecondOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | maximum | number | The configuration for the maximum number of ECPUs the cache can consume per second. | | minimum | number | The configuration for the minimum number of ECPUs the cache should be able consume per second. | --- ##### `maximum`^Optional ```typescript public readonly maximum: number; ``` - *Type:* number - *Default:* no maximum configuration The configuration for the maximum number of ECPUs the cache can consume per second. --- ##### `minimum`^Optional ```typescript public readonly minimum: number; ``` - *Type:* number - *Default:* no minimum configuration The configuration for the minimum number of ECPUs the cache should be able consume per second. --- ### IamUserProps Properties for IAM-enabled users. #### Initializer ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' const iamUserProps: aws_elasticache.IamUserProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | accessString | string | Access permissions string used for this user. | | userId | string | The ID of the user. | --- ##### `accessString`^Optional ```typescript public readonly accessString: string; ``` - *Type:* string - *Default:* 'off -@all' Access permissions string used for this user. > [https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Clusters.RBAC.html#Access-string](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Clusters.RBAC.html#Access-string) --- ##### `userId`^Optional ```typescript public readonly userId: string; ``` - *Type:* string - *Default:* auto generated The ID of the user. Must consist only of alphanumeric characters or hyphens, with the first character as a letter. Cannot end with a hyphen or contain two consecutive hyphens. --- ### InstanceConnectEndpointAttributes Attributes for importing an EC2 Instance Connect Endpoint. #### Initializer ```typescript import { aws_ec2 } from '@open-constructs/aws-cdk' const instanceConnectEndpointAttributes: aws_ec2.InstanceConnectEndpointAttributes = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | instanceConnectEndpointId | string | The ID of the EC2 Instance Connect Endpoint. | | securityGroups | aws-cdk-lib.aws_ec2.ISecurityGroup[] | The security groups associated with the EC2 Instance Connect Endpoint. | --- ##### `instanceConnectEndpointId`^Required ```typescript public readonly instanceConnectEndpointId: string; ``` - *Type:* string The ID of the EC2 Instance Connect Endpoint. --- ##### `securityGroups`^Required ```typescript public readonly securityGroups: ISecurityGroup[]; ``` - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[] The security groups associated with the EC2 Instance Connect Endpoint. --- ### InstanceConnectEndpointProps Properties for defining an EC2 Instance Connect Endpoint. #### Initializer ```typescript import { aws_ec2 } from '@open-constructs/aws-cdk' const instanceConnectEndpointProps: aws_ec2.InstanceConnectEndpointProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC in which the EC2 Instance Connect Endpoint is created. | | clientToken | string | Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. | | preserveClientIp | boolean | Indicates whether your client's IP address is preserved as the source. | | securityGroups | aws-cdk-lib.aws_ec2.ISecurityGroup[] | The security groups to associate with the EC2 Instance Connect Endpoint. | --- ##### `vpc`^Required ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc The VPC in which the EC2 Instance Connect Endpoint is created. --- ##### `clientToken`^Optional ```typescript public readonly clientToken: string; ``` - *Type:* string Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. > [https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instanceconnectendpoint.html#cfn-ec2-instanceconnectendpoint-clienttoken](https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instanceconnectendpoint.html#cfn-ec2-instanceconnectendpoint-clienttoken) --- ##### `preserveClientIp`^Optional ```typescript public readonly preserveClientIp: boolean; ``` - *Type:* boolean - *Default:* true Indicates whether your client's IP address is preserved as the source. > [https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instanceconnectendpoint.html#cfn-ec2-instanceconnectendpoint-preserveclientip](https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instanceconnectendpoint.html#cfn-ec2-instanceconnectendpoint-preserveclientip) --- ##### `securityGroups`^Optional ```typescript public readonly securityGroups: ISecurityGroup[]; ``` - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[] - *Default:* a new security group is created The security groups to associate with the EC2 Instance Connect Endpoint. --- ### MaintenanceTimeProps Properties required for setting up a weekly maintenance time. #### Initializer ```typescript import { aws_fsx } from '@open-constructs/aws-cdk' const maintenanceTimeProps: aws_fsx.MaintenanceTimeProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | day | aws-cdk-lib.aws_fsx.Weekday | The day of the week for maintenance to be performed. | | hour | number | The hour of the day (from 0-23) for maintenance to be performed. | | minute | number | The minute of the hour (from 0-59) for maintenance to be performed. | --- ##### `day`^Required ```typescript public readonly day: Weekday; ``` - *Type:* aws-cdk-lib.aws_fsx.Weekday The day of the week for maintenance to be performed. --- ##### `hour`^Required ```typescript public readonly hour: number; ``` - *Type:* number The hour of the day (from 0-23) for maintenance to be performed. --- ##### `minute`^Required ```typescript public readonly minute: number; ``` - *Type:* number The minute of the hour (from 0-59) for maintenance to be performed. --- ### NamespaceAttributes Attributes for importing a Redshift Serverless Namespace. #### Initializer ```typescript import { aws_redshiftserverless } from '@open-constructs/aws-cdk' const namespaceAttributes: aws_redshiftserverless.NamespaceAttributes = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | namespaceId | string | The namespace id. | | namespaceName | string | The namespace name. | --- ##### `namespaceId`^Required ```typescript public readonly namespaceId: string; ``` - *Type:* string The namespace id. --- ##### `namespaceName`^Required ```typescript public readonly namespaceName: string; ``` - *Type:* string The namespace name. --- ### NamespaceProps Properties for defining a Redshift Serverless Namespace. #### Initializer ```typescript import { aws_redshiftserverless } from '@open-constructs/aws-cdk' const namespaceProps: aws_redshiftserverless.NamespaceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | adminUsername | string | The username of the administrator for the primary database created in the namespace. | | adminUserPassword | aws-cdk-lib.SecretValue | The password of the administrator for the primary database created in the namespace. | | dbName | string | The name of the primary database created in the namespace. | | defaultIamRole | aws-cdk-lib.aws_iam.IRole | The IAM role to set as a default in the namespace. | | finalSnapshotName | string | The name of the snapshot to be created before the namespace is deleted. | | finalSnapshotRetentionPeriod | number | How long days to retain the final snapshot. | | iamRoles | aws-cdk-lib.aws_iam.IRole[] | A list of IAM roles to associate with the namespace. | | kmsKey | aws-cdk-lib.aws_kms.IKey | A Customer Managed Key used to encrypt your data. | | logExports | @open-constructs/aws-cdk.aws_redshiftserverless.LogExport[] | The types of logs the namespace can export. | | namespaceName | string | The namespace name. | --- ##### `adminUsername`^Optional ```typescript public readonly adminUsername: string; ``` - *Type:* string - *Default:* no admin user The username of the administrator for the primary database created in the namespace. You must specify both `adminUsername` and `adminUserPassword`, or neither. --- ##### `adminUserPassword`^Optional ```typescript public readonly adminUserPassword: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue - *Default:* no admin user The password of the administrator for the primary database created in the namespace. You must specify both `adminUsername` and `adminUserPassword`, or neither. --- ##### `dbName`^Optional ```typescript public readonly dbName: string; ``` - *Type:* string - *Default:* 'dev' The name of the primary database created in the namespace. --- ##### `defaultIamRole`^Optional ```typescript public readonly defaultIamRole: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole - *Default:* no default IAM role The IAM role to set as a default in the namespace. `defaultIamRole` must be included in `iamRoles`. --- ##### `finalSnapshotName`^Optional ```typescript public readonly finalSnapshotName: string; ``` - *Type:* string - *Default:* no final snapshot The name of the snapshot to be created before the namespace is deleted. If not specified, the final snapshot will not be taken. --- ##### `finalSnapshotRetentionPeriod`^Optional ```typescript public readonly finalSnapshotRetentionPeriod: number; ``` - *Type:* number - *Default:* Retained indefinitely if `finalSnapshotName` is specified, otherwise no final snapshot How long days to retain the final snapshot. You must set `finalSnapshotName` when you specify `finalSnapshotRetentionPeriod`. --- ##### `iamRoles`^Optional ```typescript public readonly iamRoles: IRole[]; ``` - *Type:* aws-cdk-lib.aws_iam.IRole[] - *Default:* no IAM role associated A list of IAM roles to associate with the namespace. --- ##### `kmsKey`^Optional ```typescript public readonly kmsKey: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey - *Default:* use AWS managed key A Customer Managed Key used to encrypt your data. --- ##### `logExports`^Optional ```typescript public readonly logExports: LogExport[]; ``` - *Type:* @open-constructs/aws-cdk.aws_redshiftserverless.LogExport[] - *Default:* no logs export The types of logs the namespace can export. --- ##### `namespaceName`^Optional ```typescript public readonly namespaceName: string; ``` - *Type:* string - *Default:* auto generate The namespace name. --- ### NoPasswordRequiredUserProps Properties for no password required users. #### Initializer ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' const noPasswordRequiredUserProps: aws_elasticache.NoPasswordRequiredUserProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | accessString | string | Access permissions string used for this user. | | userId | string | The ID of the user. | | userName | string | The username of the user. | --- ##### `accessString`^Optional ```typescript public readonly accessString: string; ``` - *Type:* string - *Default:* 'off -@all' Access permissions string used for this user. > [https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Clusters.RBAC.html#Access-string](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Clusters.RBAC.html#Access-string) --- ##### `userId`^Optional ```typescript public readonly userId: string; ``` - *Type:* string - *Default:* auto generated The ID of the user. Must consist only of alphanumeric characters or hyphens, with the first character as a letter. Cannot end with a hyphen or contain two consecutive hyphens. --- ##### `userName`^Optional ```typescript public readonly userName: string; ``` - *Type:* string - *Default:* same as userId The username of the user. --- ### NoPasswordUserAttributes Attributes for importing a no password required user. #### Initializer ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' const noPasswordUserAttributes: aws_elasticache.NoPasswordUserAttributes = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | userId | string | The ID of the user. | | userName | string | The name of the user. | --- ##### `userId`^Required ```typescript public readonly userId: string; ``` - *Type:* string The ID of the user. --- ##### `userName`^Required ```typescript public readonly userName: string; ``` - *Type:* string The name of the user. --- ### OntapConfiguration The configuration for the Amazon FSx for NetApp ONTAP file system. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html) #### Initializer ```typescript import { aws_fsx } from '@open-constructs/aws-cdk' const ontapConfiguration: aws_fsx.OntapConfiguration = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | automaticBackupRetention | aws-cdk-lib.Duration | The number of days to retain automatic backups. | | dailyAutomaticBackupStartTime | @open-constructs/aws-cdk.aws_fsx.DailyAutomaticBackupStartTime | Start time for 30-minute daily automatic backup window in Coordinated Universal Time (UTC). | | deploymentType | @open-constructs/aws-cdk.aws_fsx.OntapDeploymentType | The FSx for ONTAP file system deployment type to use in creating the file system. | | diskIops | number | The total number of SSD IOPS provisioned for the file system. | | endpointIpAddressRange | string | The IP address range in which the endpoints to access your file system will be created. | | fsxAdminPassword | aws-cdk-lib.SecretValue | The ONTAP administrative password for the `fsxadmin` user with which you administer your file system using the NetApp ONTAP CLI and REST API. | | haPairs | number | How many high-availability (HA) pairs of file servers will power your file system. | | preferredSubnet | aws-cdk-lib.aws_ec2.ISubnet | The subnet in which you want the preferred file server to be located. | | routeTables | aws-cdk-lib.aws_ec2.IRouteTable[] | The route tables in which Amazon FSx creates the rules for routing traffic to the correct file server. | | throughputCapacityPerHaPair | @open-constructs/aws-cdk.aws_fsx.ThroughputCapacityPerHaPair | The throughput capacity per HA pair for the file system. | | weeklyMaintenanceStartTime | @open-constructs/aws-cdk.aws_fsx.MaintenanceTime | The preferred day and time to perform weekly maintenance. | --- ##### `automaticBackupRetention`^Optional ```typescript public readonly automaticBackupRetention: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* 30 days The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. --- ##### `dailyAutomaticBackupStartTime`^Optional ```typescript public readonly dailyAutomaticBackupStartTime: DailyAutomaticBackupStartTime; ``` - *Type:* @open-constructs/aws-cdk.aws_fsx.DailyAutomaticBackupStartTime - *Default:* no backup window Start time for 30-minute daily automatic backup window in Coordinated Universal Time (UTC). --- ##### `deploymentType`^Optional ```typescript public readonly deploymentType: OntapDeploymentType; ``` - *Type:* @open-constructs/aws-cdk.aws_fsx.OntapDeploymentType - *Default:* OntapDeploymentType.MULTI_AZ_2 The FSx for ONTAP file system deployment type to use in creating the file system. --- ##### `diskIops`^Optional ```typescript public readonly diskIops: number; ``` - *Type:* number - *Default:* 3 IOPS * GB of storage capacity * HAPairs The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs. --- ##### `endpointIpAddressRange`^Optional ```typescript public readonly endpointIpAddressRange: string; ``` - *Type:* string - *Default:* an unused IP address range from the 198.19.* range The IP address range in which the endpoints to access your file system will be created. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables, as long as they don't overlap with any subnet. --- ##### `fsxAdminPassword`^Optional ```typescript public readonly fsxAdminPassword: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue - *Default:* do not set an admin password The ONTAP administrative password for the `fsxadmin` user with which you administer your file system using the NetApp ONTAP CLI and REST API. If you don't specify a password, Amazon FSx will not set one. In that case, the user will not be able to log in. You can change the admin password at any time through the management console. --- ##### `haPairs`^Optional ```typescript public readonly haPairs: number; ``` - *Type:* number - *Default:* 1 How many high-availability (HA) pairs of file servers will power your file system. First-generation file systems are powered by 1 HA pair. Second-generation multi-AZ file systems are powered by 1 HA pair. Second generation single-AZ file systems are powered by up to 12 HA pairs. The value of this property affects the values of `storageCapacity`, `iops`, and `throughputCapacity`. Block storage protocol support (iSCSI and NVMe over TCP) is disabled on file systems with more than 6 HA pairs. > [https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/supported-fsx-clients.html#using-block-storage](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/supported-fsx-clients.html#using-block-storage) --- ##### `preferredSubnet`^Optional ```typescript public readonly preferredSubnet: ISubnet; ``` - *Type:* aws-cdk-lib.aws_ec2.ISubnet - *Default:* no default value (This value is not used for single-AZ file systems, but it is required for multi-AZ file systems) The subnet in which you want the preferred file server to be located. This value is required when `deploymentType` is set to `MULTI_AZ_1` or `MULTI_AZ_2`. --- ##### `routeTables`^Optional ```typescript public readonly routeTables: IRouteTable[]; ``` - *Type:* aws-cdk-lib.aws_ec2.IRouteTable[] - *Default:* Amazon FSx selects your VPC's default route table. The route tables in which Amazon FSx creates the rules for routing traffic to the correct file server. You should specify all virtual private cloud (VPC) route tables associated with the subnets in which your clients are located. Amazon FSx manages VPC route tables for Multi-AZ file systems using tag-based authentication. These route tables are tagged with Key: AmazonFSx; Value: ManagedByAmazonFSx. > [https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/unable-to-access.html#vpc-route-tables-not-tagged](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/unable-to-access.html#vpc-route-tables-not-tagged) --- ##### `throughputCapacityPerHaPair`^Optional ```typescript public readonly throughputCapacityPerHaPair: ThroughputCapacityPerHaPair; ``` - *Type:* @open-constructs/aws-cdk.aws_fsx.ThroughputCapacityPerHaPair - *Default:* Amazon FSx determines the throughput capacity based on the storage capacity The throughput capacity per HA pair for the file system. > [https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-throughput-capacity.html](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-throughput-capacity.html) --- ##### `weeklyMaintenanceStartTime`^Optional ```typescript public readonly weeklyMaintenanceStartTime: MaintenanceTime; ``` - *Type:* @open-constructs/aws-cdk.aws_fsx.MaintenanceTime - *Default:* automatically set by Amazon FSx The preferred day and time to perform weekly maintenance. --- ### OntapFileSystemProps Properties specific to the NetApp ONTAP version of the FSx file system. #### Initializer ```typescript import { aws_fsx } from '@open-constructs/aws-cdk' const ontapFileSystemProps: aws_fsx.OntapFileSystemProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | storageCapacityGiB | number | The storage capacity of the file system being created. | | vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC to launch the file system in. | | backupId | string | The ID of the backup. | | kmsKey | aws-cdk-lib.aws_kms.IKey | The KMS key used for encryption to protect your data at rest. | | removalPolicy | aws-cdk-lib.RemovalPolicy | Policy to apply when the file system is removed from the stack. | | securityGroup | aws-cdk-lib.aws_ec2.ISecurityGroup | Security Group to assign to this file system. | | storageType | aws-cdk-lib.aws_fsx.StorageType | The storage type for the file system that you're creating. | | ontapConfiguration | @open-constructs/aws-cdk.aws_fsx.OntapConfiguration | Additional configuration for FSx specific to NetApp ONTAP. | | vpcSubnets | aws-cdk-lib.aws_ec2.ISubnet[] | The subnet that the file system will be accessible from. | --- ##### `storageCapacityGiB`^Required ```typescript public readonly storageCapacityGiB: number; ``` - *Type:* number The storage capacity of the file system being created. For Windows file systems, valid values are 32 GiB to 65,536 GiB. For SCRATCH_1 deployment types, valid values are 1,200, 2,400, 3,600, then continuing in increments of 3,600 GiB. For SCRATCH_2, PERSISTENT_2 and PERSISTENT_1 deployment types using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB. For PERSISTENT_1 HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems. --- ##### `vpc`^Required ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc The VPC to launch the file system in. --- ##### `backupId`^Optional ```typescript public readonly backupId: string; ``` - *Type:* string - *Default:* no backup will be used. The ID of the backup. Specifies the backup to use if you're creating a file system from an existing backup. --- ##### `kmsKey`^Optional ```typescript public readonly kmsKey: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey - *Default:* the aws/fsx default KMS key for the AWS account being deployed into. The KMS key used for encryption to protect your data at rest. --- ##### `removalPolicy`^Optional ```typescript public readonly removalPolicy: RemovalPolicy; ``` - *Type:* aws-cdk-lib.RemovalPolicy - *Default:* RemovalPolicy.RETAIN Policy to apply when the file system is removed from the stack. --- ##### `securityGroup`^Optional ```typescript public readonly securityGroup: ISecurityGroup; ``` - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup - *Default:* creates new security group which allows all outbound traffic. Security Group to assign to this file system. --- ##### `storageType`^Optional ```typescript public readonly storageType: StorageType; ``` - *Type:* aws-cdk-lib.aws_fsx.StorageType - *Default:* StorageType.SSD The storage type for the file system that you're creating. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-storagetype](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-storagetype) --- ##### `ontapConfiguration`^Required ```typescript public readonly ontapConfiguration: OntapConfiguration; ``` - *Type:* @open-constructs/aws-cdk.aws_fsx.OntapConfiguration Additional configuration for FSx specific to NetApp ONTAP. --- ##### `vpcSubnets`^Required ```typescript public readonly vpcSubnets: ISubnet[]; ``` - *Type:* aws-cdk-lib.aws_ec2.ISubnet[] The subnet that the file system will be accessible from. For MULTI_AZ_1 deployment types, provide exactly two subnets, one for the preferred file server and one for the standby file server. Specify one of these subnets as the preferred subnet using `OntapConfiguration.preferredSubnet` property for multi-AZ file system. --- ### PasswordUserAttributes Attributes for importing a password-authenticated user. #### Initializer ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' const passwordUserAttributes: aws_elasticache.PasswordUserAttributes = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | userId | string | The ID of the user. | | userName | string | The name of the user. | --- ##### `userId`^Required ```typescript public readonly userId: string; ``` - *Type:* string The ID of the user. --- ##### `userName`^Required ```typescript public readonly userName: string; ``` - *Type:* string The name of the user. --- ### PasswordUserProps Properties for password-authenticated users. #### Initializer ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' const passwordUserProps: aws_elasticache.PasswordUserProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | accessString | string | Access permissions string used for this user. | | userId | string | The ID of the user. | | passwords | aws-cdk-lib.SecretValue[] | Passwords used for this user account. | | userName | string | The username of the user. | --- ##### `accessString`^Optional ```typescript public readonly accessString: string; ``` - *Type:* string - *Default:* 'off -@all' Access permissions string used for this user. > [https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Clusters.RBAC.html#Access-string](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Clusters.RBAC.html#Access-string) --- ##### `userId`^Optional ```typescript public readonly userId: string; ``` - *Type:* string - *Default:* auto generated The ID of the user. Must consist only of alphanumeric characters or hyphens, with the first character as a letter. Cannot end with a hyphen or contain two consecutive hyphens. --- ##### `passwords`^Optional ```typescript public readonly passwords: SecretValue[]; ``` - *Type:* aws-cdk-lib.SecretValue[] - *Default:* automatically generate a password for the user Passwords used for this user account. You can create up to two passwords for each user. --- ##### `userName`^Optional ```typescript public readonly userName: string; ``` - *Type:* string - *Default:* same as userId The username of the user. --- ### RepositoryAttributes Represents the attributes of an existing CodeArtifact repository. #### Initializer ```typescript import { aws_codeartifact } from '@open-constructs/aws-cdk' const repositoryAttributes: aws_codeartifact.RepositoryAttributes = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | domain | @open-constructs/aws-cdk.aws_codeartifact.IDomain | The CodeArtifact domain associated with this repository. | | repositoryArn | string | The ARN (Amazon Resource Name) of the CodeArtifact repository. | | repositoryName | string | The name of the CodeArtifact repository. | --- ##### `domain`^Required ```typescript public readonly domain: IDomain; ``` - *Type:* @open-constructs/aws-cdk.aws_codeartifact.IDomain The CodeArtifact domain associated with this repository. --- ##### `repositoryArn`^Required ```typescript public readonly repositoryArn: string; ``` - *Type:* string The ARN (Amazon Resource Name) of the CodeArtifact repository. --- ##### `repositoryName`^Required ```typescript public readonly repositoryName: string; ``` - *Type:* string The name of the CodeArtifact repository. --- ### RepositoryProps Properties for creating a new CodeArtifact repository. #### Initializer ```typescript import { aws_codeartifact } from '@open-constructs/aws-cdk' const repositoryProps: aws_codeartifact.RepositoryProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | domain | @open-constructs/aws-cdk.aws_codeartifact.IDomain | The domain that contains the repository. | | description | string | The description of the repository. | | externalConnection | @open-constructs/aws-cdk.aws_codeartifact.RepositoryConnection | The connections to external repositories (like npmjs, pypi, etc.). | | repositoryName | string | The name of the repository. | | upstreams | @open-constructs/aws-cdk.aws_codeartifact.IRepository[] | A list of upstream Codeartifact repositories to associate with the repository. | --- ##### `domain`^Required ```typescript public readonly domain: IDomain; ``` - *Type:* @open-constructs/aws-cdk.aws_codeartifact.IDomain The domain that contains the repository. --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* No description The description of the repository. --- ##### `externalConnection`^Optional ```typescript public readonly externalConnection: RepositoryConnection; ``` - *Type:* @open-constructs/aws-cdk.aws_codeartifact.RepositoryConnection - *Default:* No external connections The connections to external repositories (like npmjs, pypi, etc.). You can use the AWS CLI to connect your CodeArtifact repository to an external repository by adding an external connection directly to the repository. This will allow users connected to the CodeArtifact repository, or any of its downstream repositories, to fetch packages from the configured external repository. Each CodeArtifact repository can only have one external connection. --- ##### `repositoryName`^Optional ```typescript public readonly repositoryName: string; ``` - *Type:* string - *Default:* A name is automatically generated The name of the repository. --- ##### `upstreams`^Optional ```typescript public readonly upstreams: IRepository[]; ``` - *Type:* @open-constructs/aws-cdk.aws_codeartifact.IRepository[] - *Default:* No upstream repositories A list of upstream Codeartifact repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when CodeArtifact looks for a requested package version. see https://docs.aws.amazon.com/codeartifact/latest/ug/repo-upstream-behavior.html#package-retention-intermediate-repositories --- ### ServerlessCacheAttributes Attributes for importing an ElastiCache Serverless Cache. #### Initializer ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' const serverlessCacheAttributes: aws_elasticache.ServerlessCacheAttributes = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | endpointAddress | string | The DNS hostname of the cache node. | | endpointPort | number | The port number that the cache engine is listening on. | | securityGroups | aws-cdk-lib.aws_ec2.ISecurityGroup[] | The security groups to associate with the serverless cache. | | serverlessCacheName | string | The serverless cache name. | --- ##### `endpointAddress`^Required ```typescript public readonly endpointAddress: string; ``` - *Type:* string The DNS hostname of the cache node. --- ##### `endpointPort`^Required ```typescript public readonly endpointPort: number; ``` - *Type:* number The port number that the cache engine is listening on. --- ##### `securityGroups`^Required ```typescript public readonly securityGroups: ISecurityGroup[]; ``` - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[] The security groups to associate with the serverless cache. --- ##### `serverlessCacheName`^Required ```typescript public readonly serverlessCacheName: string; ``` - *Type:* string The serverless cache name. --- ### ServerlessCacheProps Properties for defining an ElastiCache Serverless Cache. #### Initializer ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' const serverlessCacheProps: aws_elasticache.ServerlessCacheProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | engine | @open-constructs/aws-cdk.aws_elasticache.Engine | The engine the serverless cache is compatible with. | | majorEngineVersion | @open-constructs/aws-cdk.aws_elasticache.MajorVersion | The version number of the engine the serverless cache is compatible with. | | vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC to place the serverless cache in. | | cacheUsageLimits | @open-constructs/aws-cdk.aws_elasticache.CacheUsageLimits | The usage limits for storage and ElastiCache Processing Units for the cache. | | dailySnapshotTime | @open-constructs/aws-cdk.aws_elasticache.DailySnapshotTime | The daily time when a cache snapshot will be created. | | description | string | A description of the serverless cache. | | finalSnapshotName | string | The name of the final snapshot taken of a cache before the cache is deleted. | | kmsKey | aws-cdk-lib.aws_kms.IKey | The Customer Managed Key that is used to encrypt data at rest in the serverless cache. | | securityGroups | aws-cdk-lib.aws_ec2.ISecurityGroup[] | The security groups to associate with the serverless cache. | | serverlessCacheName | string | The unique identifier of the serverless cache. | | snapshotArnsToRestore | string[] | The ARN of the snapshot from which to restore data into the new cache. | | snapshotRetentionLimit | number | The number of serverless cache snapshots the system will retain. To enable automatic backups, this property must be set. | | userGroup | @open-constructs/aws-cdk.aws_elasticache.IUserGroup | The user group associated with the serverless cache. | | vpcSubnets | aws-cdk-lib.aws_ec2.SubnetSelection | Where to place the serverless cache within the VPC. | --- ##### `engine`^Required ```typescript public readonly engine: Engine; ``` - *Type:* @open-constructs/aws-cdk.aws_elasticache.Engine The engine the serverless cache is compatible with. --- ##### `majorEngineVersion`^Required ```typescript public readonly majorEngineVersion: MajorVersion; ``` - *Type:* @open-constructs/aws-cdk.aws_elasticache.MajorVersion The version number of the engine the serverless cache is compatible with. --- ##### `vpc`^Required ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc The VPC to place the serverless cache in. --- ##### `cacheUsageLimits`^Optional ```typescript public readonly cacheUsageLimits: CacheUsageLimits; ``` - *Type:* @open-constructs/aws-cdk.aws_elasticache.CacheUsageLimits - *Default:* no limits. The usage limits for storage and ElastiCache Processing Units for the cache. --- ##### `dailySnapshotTime`^Optional ```typescript public readonly dailySnapshotTime: DailySnapshotTime; ``` - *Type:* @open-constructs/aws-cdk.aws_elasticache.DailySnapshotTime - *Default:* ElastiCache automatically assigns the backup window if \`snapshotRetentionLimit\` is set. Otherwise, no snapshots are taken. The daily time when a cache snapshot will be created. This property must be set along with `snapshotRetentionLimit`. > [https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/backups-automatic.html](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/backups-automatic.html) --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* no description A description of the serverless cache. The description can have up to 255 characters and must not contain < and > characters. --- ##### `finalSnapshotName`^Optional ```typescript public readonly finalSnapshotName: string; ``` - *Type:* string - *Default:* no final snapshot taken The name of the final snapshot taken of a cache before the cache is deleted. --- ##### `kmsKey`^Optional ```typescript public readonly kmsKey: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey - *Default:* use AWS managed key The Customer Managed Key that is used to encrypt data at rest in the serverless cache. --- ##### `securityGroups`^Optional ```typescript public readonly securityGroups: ISecurityGroup[]; ``` - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[] - *Default:* a new security group is created The security groups to associate with the serverless cache. --- ##### `serverlessCacheName`^Optional ```typescript public readonly serverlessCacheName: string; ``` - *Type:* string - *Default:* auto generate The unique identifier of the serverless cache. The name can have up to 40 characters, and must not contain spaces. --- ##### `snapshotArnsToRestore`^Optional ```typescript public readonly snapshotArnsToRestore: string[]; ``` - *Type:* string[] - *Default:* not restored The ARN of the snapshot from which to restore data into the new cache. --- ##### `snapshotRetentionLimit`^Optional ```typescript public readonly snapshotRetentionLimit: number; ``` - *Type:* number - *Default:* no automatic backups The number of serverless cache snapshots the system will retain. To enable automatic backups, this property must be set. \`snapshotRetentionLimit\` must be between 1 and 35. --- ##### `userGroup`^Optional ```typescript public readonly userGroup: IUserGroup; ``` - *Type:* @open-constructs/aws-cdk.aws_elasticache.IUserGroup - *Default:* no user group associated The user group associated with the serverless cache. Available for Valkey and Redis OSS only. --- ##### `vpcSubnets`^Optional ```typescript public readonly vpcSubnets: SubnetSelection; ``` - *Type:* aws-cdk-lib.aws_ec2.SubnetSelection - *Default:* private subnets Where to place the serverless cache within the VPC. --- ### UserGroupAttributes Attributes for importing a User Group. #### Initializer ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' const userGroupAttributes: aws_elasticache.UserGroupAttributes = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | userGroupId | string | The ID of the user group. | --- ##### `userGroupId`^Required ```typescript public readonly userGroupId: string; ``` - *Type:* string The ID of the user group. --- ### UserGroupProps Properties for defining a User Group. #### Initializer ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' const userGroupProps: aws_elasticache.UserGroupProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | users | @open-constructs/aws-cdk.aws_elasticache.IUser[] | The list of User that belong to the user group. | | userGroupId | string | The ID of the user group. | --- ##### `users`^Required ```typescript public readonly users: IUser[]; ``` - *Type:* @open-constructs/aws-cdk.aws_elasticache.IUser[] The list of User that belong to the user group. A user with the username `default` must be included in `users`. --- ##### `userGroupId`^Optional ```typescript public readonly userGroupId: string; ``` - *Type:* string - *Default:* auto generate The ID of the user group. \`userGroupId\` can have up to 40 characters. \`userGroupId\` must consist only of alphanumeric characters or hyphens, with the first character as a letter, and it can't end with a hyphen or contain two consecutive hyphens. --- ### WorkgroupAttributes Attributes for importing a Redshift Serverless Workgroup. #### Initializer ```typescript import { aws_redshiftserverless } from '@open-constructs/aws-cdk' const workgroupAttributes: aws_redshiftserverless.WorkgroupAttributes = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | endpointAddress | string | The workgroup endpoint address. | | port | number | The workgroup port. | | securityGroups | aws-cdk-lib.aws_ec2.ISecurityGroup[] | The security groups associated with the Redshift Serverless Workgroup. | | workgroupId | string | The workgroup id. | | workgroupName | string | The workgroup name. | --- ##### `endpointAddress`^Required ```typescript public readonly endpointAddress: string; ``` - *Type:* string The workgroup endpoint address. --- ##### `port`^Required ```typescript public readonly port: number; ``` - *Type:* number The workgroup port. --- ##### `securityGroups`^Required ```typescript public readonly securityGroups: ISecurityGroup[]; ``` - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[] The security groups associated with the Redshift Serverless Workgroup. --- ##### `workgroupId`^Required ```typescript public readonly workgroupId: string; ``` - *Type:* string The workgroup id. --- ##### `workgroupName`^Required ```typescript public readonly workgroupName: string; ``` - *Type:* string The workgroup name. --- ### WorkgroupProps Properties for defining a Redshift Serverless Workgroup. #### Initializer ```typescript import { aws_redshiftserverless } from '@open-constructs/aws-cdk' const workgroupProps: aws_redshiftserverless.WorkgroupProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC to place the workgroup in. | | baseCapacity | number | The base compute capacity of the workgroup in Redshift Processing Units (RPUs). | | configParameters | {[ key: string ]: string} | A list of parameters to set for finer control over a database. | | enhancedVpcRouting | boolean | The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC. | | namespace | @open-constructs/aws-cdk.aws_redshiftserverless.INamespace | The namespace the workgroup is associated with. | | port | number | The custom port to use when connecting to a workgroup. | | publiclyAccessible | boolean | A value that specifies whether the workgroup can be accessible from a public network. | | securityGroups | aws-cdk-lib.aws_ec2.ISecurityGroup[] | The security groups to associate with the workgroup. | | vpcSubnets | aws-cdk-lib.aws_ec2.SubnetSelection | Where to place the workgroup within the VPC. | | workgroupName | string | The workgroup name. | --- ##### `vpc`^Required ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc The VPC to place the workgroup in. `vpc` must have at least 3 subnets, and they must span across 3 Availability Zones. --- ##### `baseCapacity`^Optional ```typescript public readonly baseCapacity: number; ``` - *Type:* number - *Default:* 128 The base compute capacity of the workgroup in Redshift Processing Units (RPUs). You can adjust the base capacity setting from 8 RPUs to 512 RPUs in units of 8. Also you can increment or decrement RPUs in units of 32 when setting a base capacity between 512-1024. > [https://docs.aws.amazon.com/redshift/latest/mgmt/serverless-capacity.html](https://docs.aws.amazon.com/redshift/latest/mgmt/serverless-capacity.html) --- ##### `configParameters`^Optional ```typescript public readonly configParameters: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* no config parameters A list of parameters to set for finer control over a database. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-configparameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-configparameters) --- ##### `enhancedVpcRouting`^Optional ```typescript public readonly enhancedVpcRouting: boolean; ``` - *Type:* boolean - *Default:* false The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC. --- ##### `namespace`^Optional ```typescript public readonly namespace: INamespace; ``` - *Type:* @open-constructs/aws-cdk.aws_redshiftserverless.INamespace - *Default:* the workgroup is not associated with any namespace The namespace the workgroup is associated with. --- ##### `port`^Optional ```typescript public readonly port: number; ``` - *Type:* number - *Default:* 5439 The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. --- ##### `publiclyAccessible`^Optional ```typescript public readonly publiclyAccessible: boolean; ``` - *Type:* boolean - *Default:* false A value that specifies whether the workgroup can be accessible from a public network. --- ##### `securityGroups`^Optional ```typescript public readonly securityGroups: ISecurityGroup[]; ``` - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[] - *Default:* a new security group is created The security groups to associate with the workgroup. --- ##### `vpcSubnets`^Optional ```typescript public readonly vpcSubnets: SubnetSelection; ``` - *Type:* aws-cdk-lib.aws_ec2.SubnetSelection - *Default:* private subnets Where to place the workgroup within the VPC. --- ##### `workgroupName`^Optional ```typescript public readonly workgroupName: string; ``` - *Type:* string - *Default:* auto generate The workgroup name. \`workgroupName\` must be between 3 and 64 characters long, contain only lowercase letters, numbers, and hyphens. --- ## Classes ### CurFormat Enum for the possible formats of a cost report. #### Initializers ```typescript import { aws_cur } from '@open-constructs/aws-cdk' new aws_cur.CurFormat(compression: string, format: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | compression | string | *No description.* | | format | string | *No description.* | --- ##### `compression`^Required - *Type:* string --- ##### `format`^Required - *Type:* string --- #### Static Functions | **Name** | **Description** | | --- | --- | | for | Returns a CurFormat instance for the given compression and format string values. | --- ##### `for` ```typescript import { aws_cur } from '@open-constructs/aws-cdk' aws_cur.CurFormat.for(compression: string, format: string) ``` Returns a CurFormat instance for the given compression and format string values. ###### `compression`^Required - *Type:* string The compression string value. --- ###### `format`^Required - *Type:* string The format string value. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | compression | string | *No description.* | | format | string | *No description.* | --- ##### `compression`^Required ```typescript public readonly compression: string; ``` - *Type:* string --- ##### `format`^Required ```typescript public readonly format: string; ``` - *Type:* string --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | PARQUET | @open-constructs/aws-cdk.aws_cur.CurFormat | Parquet format. | | TEXT_OR_CSV | @open-constructs/aws-cdk.aws_cur.CurFormat | GZIP compressed text or CSV format. | --- ##### `PARQUET`^Required ```typescript public readonly PARQUET: CurFormat; ``` - *Type:* @open-constructs/aws-cdk.aws_cur.CurFormat Parquet format. --- ##### `TEXT_OR_CSV`^Required ```typescript public readonly TEXT_OR_CSV: CurFormat; ``` - *Type:* @open-constructs/aws-cdk.aws_cur.CurFormat GZIP compressed text or CSV format. --- ### DailyAutomaticBackupStartTime Class for scheduling a daily automatic backup time. #### Initializers ```typescript import { aws_fsx } from '@open-constructs/aws-cdk' new aws_fsx.DailyAutomaticBackupStartTime(props: DailyAutomaticBackupStartTimeProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | @open-constructs/aws-cdk.aws_fsx.DailyAutomaticBackupStartTimeProps | *No description.* | --- ##### `props`^Required - *Type:* @open-constructs/aws-cdk.aws_fsx.DailyAutomaticBackupStartTimeProps --- #### Methods | **Name** | **Description** | | --- | --- | | toTimestamp | Converts an hour, and minute into HH:MM string. | --- ##### `toTimestamp` ```typescript public toTimestamp(): string ``` Converts an hour, and minute into HH:MM string. ### DailySnapshotTime Class for scheduling a daily snapshot time. #### Initializers ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' new aws_elasticache.DailySnapshotTime(props: DailySnapshotTimeProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | @open-constructs/aws-cdk.aws_elasticache.DailySnapshotTimeProps | *No description.* | --- ##### `props`^Required - *Type:* @open-constructs/aws-cdk.aws_elasticache.DailySnapshotTimeProps --- #### Methods | **Name** | **Description** | | --- | --- | | toTimestamp | Converts an hour, and minute into HH:MM string. | --- ##### `toTimestamp` ```typescript public toTimestamp(): string ``` Converts an hour, and minute into HH:MM string. ### DataStorage The data storage limit. #### Static Functions | **Name** | **Description** | | --- | --- | | gb | Creates data storage settings with gigabytes as the unit. | --- ##### `gb` ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' aws_elasticache.DataStorage.gb(options: DataStorageOptions) ``` Creates data storage settings with gigabytes as the unit. ###### `options`^Required - *Type:* @open-constructs/aws-cdk.aws_elasticache.DataStorageOptions The configuration options containing min and/or max values. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | unit | @open-constructs/aws-cdk.aws_elasticache.StorageUnit | The unit of the storage sizes. | | maximum | number | The upper limit for data storage the cache is set to use. | | minimum | number | The lower limit for data storage the cache is set to use. | --- ##### `unit`^Required ```typescript public readonly unit: StorageUnit; ``` - *Type:* @open-constructs/aws-cdk.aws_elasticache.StorageUnit The unit of the storage sizes. --- ##### `maximum`^Optional ```typescript public readonly maximum: number; ``` - *Type:* number The upper limit for data storage the cache is set to use. --- ##### `minimum`^Optional ```typescript public readonly minimum: number; ``` - *Type:* number The lower limit for data storage the cache is set to use. --- ### ECPUPerSecond The configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second. #### Static Functions | **Name** | **Description** | | --- | --- | | of | Creates ECPU per second settings. | --- ##### `of` ```typescript import { aws_elasticache } from '@open-constructs/aws-cdk' aws_elasticache.ECPUPerSecond.of(options: ECPUPerSecondOptions) ``` Creates ECPU per second settings. ###### `options`^Required - *Type:* @open-constructs/aws-cdk.aws_elasticache.ECPUPerSecondOptions The configuration options containing min and/or max values. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | maximum | number | The configuration for the maximum number of ECPUs the cache can consume per second. | | minimum | number | The configuration for the minimum number of ECPUs the cache should be able consume per second. | --- ##### `maximum`^Optional ```typescript public readonly maximum: number; ``` - *Type:* number The configuration for the maximum number of ECPUs the cache can consume per second. --- ##### `minimum`^Optional ```typescript public readonly minimum: number; ``` - *Type:* number The configuration for the minimum number of ECPUs the cache should be able consume per second. --- ### MaintenanceTime Class for scheduling a weekly maintenance time. #### Initializers ```typescript import { aws_fsx } from '@open-constructs/aws-cdk' new aws_fsx.MaintenanceTime(props: MaintenanceTimeProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | @open-constructs/aws-cdk.aws_fsx.MaintenanceTimeProps | *No description.* | --- ##### `props`^Required - *Type:* @open-constructs/aws-cdk.aws_fsx.MaintenanceTimeProps --- #### Methods | **Name** | **Description** | | --- | --- | | toTimestamp | Converts a day, hour, and minute into a timestamp as used by FSx for Lustre's weeklyMaintenanceStartTime field. | --- ##### `toTimestamp` ```typescript public toTimestamp(): string ``` Converts a day, hour, and minute into a timestamp as used by FSx for Lustre's weeklyMaintenanceStartTime field. ### MultiAz1ThroughputCapacityPerHaPair The throughput capacity for the Multi-AZ 1 deployment type. #### Initializers ```typescript import { aws_fsx } from '@open-constructs/aws-cdk' new aws_fsx.MultiAz1ThroughputCapacityPerHaPair(capacity: number) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | capacity | number | *No description.* | --- ##### `capacity`^Required - *Type:* number --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | capacity | number | *No description.* | | deploymentType | @open-constructs/aws-cdk.aws_fsx.OntapDeploymentType | The deployment type of the throughput capacity. | --- ##### `capacity`^Required ```typescript public readonly capacity: number; ``` - *Type:* number --- ##### `deploymentType`^Required ```typescript public readonly deploymentType: OntapDeploymentType; ``` - *Type:* @open-constructs/aws-cdk.aws_fsx.OntapDeploymentType The deployment type of the throughput capacity. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | MB_PER_SEC_1024 | @open-constructs/aws-cdk.aws_fsx.MultiAz1ThroughputCapacityPerHaPair | The throughput capacity of 1024 MBps per HA pair. | | MB_PER_SEC_128 | @open-constructs/aws-cdk.aws_fsx.MultiAz1ThroughputCapacityPerHaPair | The throughput capacity of 128 MBps per HA pair. | | MB_PER_SEC_2048 | @open-constructs/aws-cdk.aws_fsx.MultiAz1ThroughputCapacityPerHaPair | The throughput capacity of 2048 MBps per HA pair. | | MB_PER_SEC_256 | @open-constructs/aws-cdk.aws_fsx.MultiAz1ThroughputCapacityPerHaPair | The throughput capacity of 256 MBps per HA pair. | | MB_PER_SEC_4096 | @open-constructs/aws-cdk.aws_fsx.MultiAz1ThroughputCapacityPerHaPair | The throughput capacity of 4096 MBps per HA pair. | | MB_PER_SEC_512 | @open-constructs/aws-cdk.aws_fsx.MultiAz1ThroughputCapacityPerHaPair | The throughput capacity of 512 MBps per HA pair. | --- ##### `MB_PER_SEC_1024`^Required ```typescript public readonly MB_PER_SEC_1024: MultiAz1ThroughputCapacityPerHaPair; ``` - *Type:* @open-constructs/aws-cdk.aws_fsx.MultiAz1ThroughputCapacityPerHaPair The throughput capacity of 1024 MBps per HA pair. --- ##### `MB_PER_SEC_128`^Required ```typescript public readonly MB_PER_SEC_128: MultiAz1ThroughputCapacityPerHaPair; ``` - *Type:* @open-constructs/aws-cdk.aws_fsx.MultiAz1ThroughputCapacityPerHaPair The throughput capacity of 128 MBps per HA pair. --- ##### `MB_PER_SEC_2048`^Required ```typescript public readonly MB_PER_SEC_2048: MultiAz1ThroughputCapacityPerHaPair; ``` - *Type:* @open-constructs/aws-cdk.aws_fsx.MultiAz1ThroughputCapacityPerHaPair The throughput capacity of 2048 MBps per HA pair. --- ##### `MB_PER_SEC_256`^Required ```typescript public readonly MB_PER_SEC_256: MultiAz1ThroughputCapacityPerHaPair; ``` - *Type:* @open-constructs/aws-cdk.aws_fsx.MultiAz1ThroughputCapacityPerHaPair The throughput capacity of 256 MBps per HA pair. --- ##### `MB_PER_SEC_4096`^Required ```typescript public readonly MB_PER_SEC_4096: MultiAz1ThroughputCapacityPerHaPair; ``` - *Type:* @open-constructs/aws-cdk.aws_fsx.MultiAz1ThroughputCapacityPerHaPair The throughput capacity of 4096 MBps per HA pair. --- ##### `MB_PER_SEC_512`^Required ```typescript public readonly MB_PER_SEC_512: MultiAz1ThroughputCapacityPerHaPair; ``` - *Type:* @open-constructs/aws-cdk.aws_fsx.MultiAz1ThroughputCapacityPerHaPair The throughput capacity of 512 MBps per HA pair. --- ### MultiAz2ThroughputCapacityPerHaPair The throughput capacity for the Multi-AZ 2 deployment type. #### Initializers ```typescript import { aws_fsx } from '@open-constructs/aws-cdk' new aws_fsx.MultiAz2ThroughputCapacityPerHaPair(capacity: number) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | capacity | number | *No description.* | --- ##### `capacity`^Required - *Type:* number --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | capacity | number | *No description.* | | deploymentType | @open-constructs/aws-cdk.aws_fsx.OntapDeploymentType | The deployment type of the throughput capacity. | --- ##### `capacity`^Required ```typescript public readonly capacity: number; ``` - *Type:* number --- ##### `deploymentType`^Required ```typescript public readonly deploymentType: OntapDeploymentType; ``` - *Type:* @open-constructs/aws-cdk.aws_fsx.OntapDeploymentType The deployment type of the throughput capacity. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | MB_PER_SEC_1536 | @open-constructs/aws-cdk.aws_fsx.MultiAz2ThroughputCapacityPerHaPair | The throughput capacity of 1536 MBps per HA pair. | | MB_PER_SEC_3072 | @open-constructs/aws-cdk.aws_fsx.MultiAz2ThroughputCapacityPerHaPair | The throughput capacity of 3072 MBps per HA pair. | | MB_PER_SEC_384 | @open-constructs/aws-cdk.aws_fsx.MultiAz2ThroughputCapacityPerHaPair | The throughput capacity of 384 MBps per HA pair. | | MB_PER_SEC_6144 | @open-constructs/aws-cdk.aws_fsx.MultiAz2ThroughputCapacityPerHaPair | The throughput capacity of 6144 MBps per HA pair. | | MB_PER_SEC_768 | @open-constructs/aws-cdk.aws_fsx.MultiAz2ThroughputCapacityPerHaPair | The throughput capacity of 768 MBps per HA pair. | --- ##### `MB_PER_SEC_1536`^Required ```typescript public readonly MB_PER_SEC_1536: MultiAz2ThroughputCapacityPerHaPair; ``` - *Type:* @open-constructs/aws-cdk.aws_fsx.MultiAz2ThroughputCapacityPerHaPair The throughput capacity of 1536 MBps per HA pair. --- ##### `MB_PER_SEC_3072`^Required ```typescript public readonly MB_PER_SEC_3072: MultiAz2ThroughputCapacityPerHaPair; ``` - *Type:* @open-constructs/aws-cdk.aws_fsx.MultiAz2ThroughputCapacityPerHaPair The throughput capacity of 3072 MBps per HA pair. --- ##### `MB_PER_SEC_384`^Required ```typescript public readonly MB_PER_SEC_384: MultiAz2ThroughputCapacityPerHaPair; ``` - *Type:* @open-constructs/aws-cdk.aws_fsx.MultiAz2ThroughputCapacityPerHaPair The throughput capacity of 384 MBps per HA pair. --- ##### `MB_PER_SEC_6144`^Required ```typescript public readonly MB_PER_SEC_6144: MultiAz2ThroughputCapacityPerHaPair; ``` - *Type:* @open-constructs/aws-cdk.aws_fsx.MultiAz2ThroughputCapacityPerHaPair The throughput capacity of 6144 MBps per HA pair. --- ##### `MB_PER_SEC_768`^Required ```typescript public readonly MB_PER_SEC_768: MultiAz2ThroughputCapacityPerHaPair; ``` - *Type:* @open-constructs/aws-cdk.aws_fsx.MultiAz2ThroughputCapacityPerHaPair The throughput capacity of 768 MBps per HA pair. --- ### ReportGranularity Enum for the possible granularities of a cost report. #### Initializers ```typescript import { aws_cur } from '@open-constructs/aws-cdk' new aws_cur.ReportGranularity(value: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | value | string | *No description.* | --- ##### `value`^Required - *Type:* string --- #### Static Functions | **Name** | **Description** | | --- | --- | | for | Returns a ReportGranularity instance for the given granularity string value. | --- ##### `for` ```typescript import { aws_cur } from '@open-constructs/aws-cdk' aws_cur.ReportGranularity.for(granularity: string) ``` Returns a ReportGranularity instance for the given granularity string value. ###### `granularity`^Required - *Type:* string The granularity string value to create an instance for. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | value | string | *No description.* | --- ##### `value`^Required ```typescript public readonly value: string; ``` - *Type:* string --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DAILY | @open-constructs/aws-cdk.aws_cur.ReportGranularity | Daily granularity. | | HOURLY | @open-constructs/aws-cdk.aws_cur.ReportGranularity | Hourly granularity. | | MONTHLY | @open-constructs/aws-cdk.aws_cur.ReportGranularity | Weekly granularity. | --- ##### `DAILY`^Required ```typescript public readonly DAILY: ReportGranularity; ``` - *Type:* @open-constructs/aws-cdk.aws_cur.ReportGranularity Daily granularity. --- ##### `HOURLY`^Required ```typescript public readonly HOURLY: ReportGranularity; ``` - *Type:* @open-constructs/aws-cdk.aws_cur.ReportGranularity Hourly granularity. --- ##### `MONTHLY`^Required ```typescript public readonly MONTHLY: ReportGranularity; ``` - *Type:* @open-constructs/aws-cdk.aws_cur.ReportGranularity Weekly granularity. --- ### SingleAz1ThroughputCapacityPerHaPair The throughput capacity for the Single-AZ 1 deployment type. #### Initializers ```typescript import { aws_fsx } from '@open-constructs/aws-cdk' new aws_fsx.SingleAz1ThroughputCapacityPerHaPair(capacity: number) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | capacity | number | *No description.* | --- ##### `capacity`^Required - *Type:* number --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | capacity | number | *No description.* | | deploymentType | @open-constructs/aws-cdk.aws_fsx.OntapDeploymentType | The deployment type of the throughput capacity. | --- ##### `capacity`^Required ```typescript public readonly capacity: number; ``` - *Type:* number --- ##### `deploymentType`^Required ```typescript public readonly deploymentType: OntapDeploymentType; ``` - *Type:* @open-constructs/aws-cdk.aws_fsx.OntapDeploymentType The deployment type of the throughput capacity. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | MB_PER_SEC_1024 | @open-constructs/aws-cdk.aws_fsx.SingleAz1ThroughputCapacityPerHaPair | The throughput capacity of 1024 MBps per HA pair. | | MB_PER_SEC_128 | @open-constructs/aws-cdk.aws_fsx.SingleAz1ThroughputCapacityPerHaPair | The throughput capacity of 128 MBps per HA pair. | | MB_PER_SEC_2048 | @open-constructs/aws-cdk.aws_fsx.SingleAz1ThroughputCapacityPerHaPair | The throughput capacity of 2048 MBps per HA pair. | | MB_PER_SEC_256 | @open-constructs/aws-cdk.aws_fsx.SingleAz1ThroughputCapacityPerHaPair | The throughput capacity of 256 MBps per HA pair. | | MB_PER_SEC_4096 | @open-constructs/aws-cdk.aws_fsx.SingleAz1ThroughputCapacityPerHaPair | The throughput capacity of 4096 MBps per HA pair. | | MB_PER_SEC_512 | @open-constructs/aws-cdk.aws_fsx.SingleAz1ThroughputCapacityPerHaPair | The throughput capacity of 512 MBps per HA pair. | --- ##### `MB_PER_SEC_1024`^Required ```typescript public readonly MB_PER_SEC_1024: SingleAz1ThroughputCapacityPerHaPair; ``` - *Type:* @open-constructs/aws-cdk.aws_fsx.SingleAz1ThroughputCapacityPerHaPair The throughput capacity of 1024 MBps per HA pair. --- ##### `MB_PER_SEC_128`^Required ```typescript public readonly MB_PER_SEC_128: SingleAz1ThroughputCapacityPerHaPair; ``` - *Type:* @open-constructs/aws-cdk.aws_fsx.SingleAz1ThroughputCapacityPerHaPair The throughput capacity of 128 MBps per HA pair. --- ##### `MB_PER_SEC_2048`^Required ```typescript public readonly MB_PER_SEC_2048: SingleAz1ThroughputCapacityPerHaPair; ``` - *Type:* @open-constructs/aws-cdk.aws_fsx.SingleAz1ThroughputCapacityPerHaPair The throughput capacity of 2048 MBps per HA pair. --- ##### `MB_PER_SEC_256`^Required ```typescript public readonly MB_PER_SEC_256: SingleAz1ThroughputCapacityPerHaPair; ``` - *Type:* @open-constructs/aws-cdk.aws_fsx.SingleAz1ThroughputCapacityPerHaPair The throughput capacity of 256 MBps per HA pair. --- ##### `MB_PER_SEC_4096`^Required ```typescript public readonly MB_PER_SEC_4096: SingleAz1ThroughputCapacityPerHaPair; ``` - *Type:* @open-constructs/aws-cdk.aws_fsx.SingleAz1ThroughputCapacityPerHaPair The throughput capacity of 4096 MBps per HA pair. --- ##### `MB_PER_SEC_512`^Required ```typescript public readonly MB_PER_SEC_512: SingleAz1ThroughputCapacityPerHaPair; ``` - *Type:* @open-constructs/aws-cdk.aws_fsx.SingleAz1ThroughputCapacityPerHaPair The throughput capacity of 512 MBps per HA pair. --- ### SingleAz2ThroughputCapacityPerHaPair The throughput capacity for the Single-AZ 2 deployment type. #### Initializers ```typescript import { aws_fsx } from '@open-constructs/aws-cdk' new aws_fsx.SingleAz2ThroughputCapacityPerHaPair(capacity: number) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | capacity | number | *No description.* | --- ##### `capacity`^Required - *Type:* number --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | capacity | number | *No description.* | | deploymentType | @open-constructs/aws-cdk.aws_fsx.OntapDeploymentType | The deployment type of the throughput capacity. | --- ##### `capacity`^Required ```typescript public readonly capacity: number; ``` - *Type:* number --- ##### `deploymentType`^Required ```typescript public readonly deploymentType: OntapDeploymentType; ``` - *Type:* @open-constructs/aws-cdk.aws_fsx.OntapDeploymentType The deployment type of the throughput capacity. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | MB_PER_SEC_1536 | @open-constructs/aws-cdk.aws_fsx.SingleAz2ThroughputCapacityPerHaPair | The throughput capacity of 1536 MBps per HA pair. | | MB_PER_SEC_3072 | @open-constructs/aws-cdk.aws_fsx.SingleAz2ThroughputCapacityPerHaPair | The throughput capacity of 3072 MBps per HA pair. | | MB_PER_SEC_6144 | @open-constructs/aws-cdk.aws_fsx.SingleAz2ThroughputCapacityPerHaPair | The throughput capacity of 6144 MBps per HA pair. | --- ##### `MB_PER_SEC_1536`^Required ```typescript public readonly MB_PER_SEC_1536: SingleAz2ThroughputCapacityPerHaPair; ``` - *Type:* @open-constructs/aws-cdk.aws_fsx.SingleAz2ThroughputCapacityPerHaPair The throughput capacity of 1536 MBps per HA pair. --- ##### `MB_PER_SEC_3072`^Required ```typescript public readonly MB_PER_SEC_3072: SingleAz2ThroughputCapacityPerHaPair; ``` - *Type:* @open-constructs/aws-cdk.aws_fsx.SingleAz2ThroughputCapacityPerHaPair The throughput capacity of 3072 MBps per HA pair. --- ##### `MB_PER_SEC_6144`^Required ```typescript public readonly MB_PER_SEC_6144: SingleAz2ThroughputCapacityPerHaPair; ``` - *Type:* @open-constructs/aws-cdk.aws_fsx.SingleAz2ThroughputCapacityPerHaPair The throughput capacity of 6144 MBps per HA pair. --- ### ThroughputCapacityPerHaPair The throughput capacity per HA pair for an Amazon FSx for NetApp ONTAP file system. #### Initializers ```typescript import { aws_fsx } from '@open-constructs/aws-cdk' new aws_fsx.ThroughputCapacityPerHaPair(capacity: number) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | capacity | number | *No description.* | --- ##### `capacity`^Required - *Type:* number --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | capacity | number | *No description.* | | deploymentType | @open-constructs/aws-cdk.aws_fsx.OntapDeploymentType | The deployment type of the throughput capacity. | --- ##### `capacity`^Required ```typescript public readonly capacity: number; ``` - *Type:* number --- ##### `deploymentType`^Required ```typescript public readonly deploymentType: OntapDeploymentType; ``` - *Type:* @open-constructs/aws-cdk.aws_fsx.OntapDeploymentType The deployment type of the throughput capacity. --- ## Protocols ### IDomain - *Extends:* aws-cdk-lib.IResource - *Implemented By:* @open-constructs/aws-cdk.aws_codeartifact.Domain, @open-constructs/aws-cdk.aws_codeartifact.IDomain Represents a CodeArtifact Domain. #### Methods | **Name** | **Description** | | --- | --- | | addToResourcePolicy | Adds a statement to the Codeartifact domain resource policy. | | grant | Grants permissions to the specified grantee on this CodeArtifact domain. | | grantContribute | Grants contribute permissions to the specified grantee on this CodeArtifact domain. | --- ##### `addToResourcePolicy` ```typescript public addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResult ``` Adds a statement to the Codeartifact domain resource policy. ###### `statement`^Required - *Type:* aws-cdk-lib.aws_iam.PolicyStatement The policy statement to add. --- ##### `grant` ```typescript public grant(grantee: IGrantable, actions: ...string[]): Grant ``` Grants permissions to the specified grantee on this CodeArtifact domain. It handles both same-environment and cross-environment scenarios: - For same-environment grants, it adds the permissions to the principal or resource. - For cross-environment grants, it adds the permissions to both the principal and the resource. ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable The principal to grant permissions to. --- ###### `actions`^Required - *Type:* ...string[] The actions to grant. These should be valid CodeArtifact actions. --- ##### `grantContribute` ```typescript public grantContribute(grantee: IGrantable): Grant ``` Grants contribute permissions to the specified grantee on this CodeArtifact domain. ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable The principal to grant contribute permissions to. --- #### 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. | | domainArn | string | The ARN of the Domain. | | domainName | string | The name of the Domain. | | domainOwner | string | 12-digit account number of the AWS account that owns the domain that contains the Domain. | | domainEncryptionKey | string | The ARN of the key used to encrypt the Domain. | | encryptionKey | aws-cdk-lib.aws_kms.IKey | The KMS key used to encrypt the Domain. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `domainArn`^Required ```typescript public readonly domainArn: string; ``` - *Type:* string The ARN of the Domain. --- ##### `domainName`^Required ```typescript public readonly domainName: string; ``` - *Type:* string The name of the Domain. --- ##### `domainOwner`^Required ```typescript public readonly domainOwner: string; ``` - *Type:* string 12-digit account number of the AWS account that owns the domain that contains the Domain. --- ##### `domainEncryptionKey`^Optional ```typescript public readonly domainEncryptionKey: string; ``` - *Type:* string The ARN of the key used to encrypt the Domain. --- ##### `encryptionKey`^Optional ```typescript public readonly encryptionKey: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey The KMS key used to encrypt the Domain. --- ### IIamUser - *Extends:* @open-constructs/aws-cdk.aws_elasticache.IUser - *Implemented By:* @open-constructs/aws-cdk.aws_elasticache.IamUser, @open-constructs/aws-cdk.aws_elasticache.IIamUser Interface for IAM-enabled users. #### Methods | **Name** | **Description** | | --- | --- | | grant | Grant permissions to this user. | | grantConnect | Grant connect permissions to this user. | --- ##### `grant` ```typescript public grant(grantee: IGrantable, actions: ...string[]): Grant ``` Grant permissions to this user. ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable --- ###### `actions`^Required - *Type:* ...string[] --- ##### `grantConnect` ```typescript public grantConnect(grantee: IGrantable): Grant ``` Grant connect permissions to this user. ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable --- #### 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. | | userArn | string | The ARN of the user. | | userId | string | The ID of the user. | | userName | string | The name of the user. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `userArn`^Required ```typescript public readonly userArn: string; ``` - *Type:* string The ARN of the user. --- ##### `userId`^Required ```typescript public readonly userId: string; ``` - *Type:* string The ID of the user. --- ##### `userName`^Required ```typescript public readonly userName: string; ``` - *Type:* string The name of the user. --- ### IInstanceConnectEndpoint - *Extends:* aws-cdk-lib.aws_ec2.IConnectable, aws-cdk-lib.IResource - *Implemented By:* @open-constructs/aws-cdk.aws_ec2.InstanceConnectEndpoint, @open-constructs/aws-cdk.aws_ec2.IInstanceConnectEndpoint An EC2 Instance Connect Endpoint. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connections | aws-cdk-lib.aws_ec2.Connections | The network connections associated with this resource. | | 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. | | instanceConnectEndpointId | string | The ID of the EC2 Instance Connect Endpoint. | --- ##### `connections`^Required ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections The network connections associated with this resource. --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `instanceConnectEndpointId`^Required ```typescript public readonly instanceConnectEndpointId: string; ``` - *Type:* string The ID of the EC2 Instance Connect Endpoint. --- ### INamespace - *Extends:* aws-cdk-lib.IResource - *Implemented By:* @open-constructs/aws-cdk.aws_redshiftserverless.Namespace, @open-constructs/aws-cdk.aws_redshiftserverless.INamespace A Redshift Serverless Namespace. #### 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. | | namespaceArn | string | The namespace ARN. | | namespaceId | string | The namespace id. | | namespaceName | string | The namespace name. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `namespaceArn`^Required ```typescript public readonly namespaceArn: string; ``` - *Type:* string The namespace ARN. --- ##### `namespaceId`^Required ```typescript public readonly namespaceId: string; ``` - *Type:* string The namespace id. --- ##### `namespaceName`^Required ```typescript public readonly namespaceName: string; ``` - *Type:* string The namespace name. --- ### INoPasswordRequiredUser - *Extends:* @open-constructs/aws-cdk.aws_elasticache.IUser - *Implemented By:* @open-constructs/aws-cdk.aws_elasticache.NoPasswordRequiredUser, @open-constructs/aws-cdk.aws_elasticache.INoPasswordRequiredUser Interface for no password required users. #### 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. | | userArn | string | The ARN of the user. | | userId | string | The ID of the user. | | userName | string | The name of the user. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `userArn`^Required ```typescript public readonly userArn: string; ``` - *Type:* string The ARN of the user. --- ##### `userId`^Required ```typescript public readonly userId: string; ``` - *Type:* string The ID of the user. --- ##### `userName`^Required ```typescript public readonly userName: string; ``` - *Type:* string The name of the user. --- ### IPasswordUser - *Extends:* @open-constructs/aws-cdk.aws_elasticache.IUser - *Implemented By:* @open-constructs/aws-cdk.aws_elasticache.PasswordUser, @open-constructs/aws-cdk.aws_elasticache.IPasswordUser Interface for password-authenticated users. #### 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. | | userArn | string | The ARN of the user. | | userId | string | The ID of the user. | | userName | string | The name of the user. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `userArn`^Required ```typescript public readonly userArn: string; ``` - *Type:* string The ARN of the user. --- ##### `userId`^Required ```typescript public readonly userId: string; ``` - *Type:* string The ID of the user. --- ##### `userName`^Required ```typescript public readonly userName: string; ``` - *Type:* string The name of the user. --- ### IRepository - *Extends:* aws-cdk-lib.IResource - *Implemented By:* @open-constructs/aws-cdk.aws_codeartifact.Repository, @open-constructs/aws-cdk.aws_codeartifact.IRepository Represents an CodeArtifact Repository. #### Methods | **Name** | **Description** | | --- | --- | | addToResourcePolicy | Adds a statement to the CodeArtifact repository resource policy. | | grant | Grants the given principal identity permissions to perform the actions on the repository. | | grantRead | Grants the given principal identity permissions to perform the actions on the repository. | | grantReadAndPublish | Grants the given principal identity permissions to perform the actions on the repository. | --- ##### `addToResourcePolicy` ```typescript public addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResult ``` Adds a statement to the CodeArtifact repository resource policy. ###### `statement`^Required - *Type:* aws-cdk-lib.aws_iam.PolicyStatement The policy statement to add. --- ##### `grant` ```typescript public grant(grantee: IGrantable, actions: ...string[]): Grant ``` Grants the given principal identity permissions to perform the actions on the repository. ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable The principal to grant permissions to. --- ###### `actions`^Required - *Type:* ...string[] The actions to grant. --- ##### `grantRead` ```typescript public grantRead(grantee: IGrantable): Grant ``` Grants the given principal identity permissions to perform the actions on the repository. ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable The principal to grant permissions to. --- ##### `grantReadAndPublish` ```typescript public grantReadAndPublish(grantee: IGrantable): Grant ``` Grants the given principal identity permissions to perform the actions on the repository. ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable The principal to grant permissions to. --- #### 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. | | domain | @open-constructs/aws-cdk.aws_codeartifact.IDomain | The domain that contains the repository. | | repositoryArn | string | The ARN of the repository. | | repositoryDomainName | string | The domain that contains the repository. | | repositoryDomainOwner | string | The domain owner of the repository. | | repositoryName | string | The name of the repository. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `domain`^Required ```typescript public readonly domain: IDomain; ``` - *Type:* @open-constructs/aws-cdk.aws_codeartifact.IDomain The domain that contains the repository. --- ##### `repositoryArn`^Required ```typescript public readonly repositoryArn: string; ``` - *Type:* string The ARN of the repository. --- ##### `repositoryDomainName`^Required ```typescript public readonly repositoryDomainName: string; ``` - *Type:* string The domain that contains the repository. --- ##### `repositoryDomainOwner`^Required ```typescript public readonly repositoryDomainOwner: string; ``` - *Type:* string The domain owner of the repository. --- ##### `repositoryName`^Required ```typescript public readonly repositoryName: string; ``` - *Type:* string The name of the repository. --- ### IServerlessCache - *Extends:* aws-cdk-lib.IResource, aws-cdk-lib.aws_ec2.IConnectable - *Implemented By:* @open-constructs/aws-cdk.aws_elasticache.ServerlessCache, @open-constructs/aws-cdk.aws_elasticache.IServerlessCache Interface for an ElastiCache Serverless Cache. #### Methods | **Name** | **Description** | | --- | --- | | grant | Grant the given identity the specified actions. | | grantConnect | Grant the given identity connection access to the cache. | | metric | Create a CloudWatch metric. | --- ##### `grant` ```typescript public grant(grantee: IGrantable, actions: ...string[]): Grant ``` Grant the given identity the specified actions. ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable --- ###### `actions`^Required - *Type:* ...string[] --- ##### `grantConnect` ```typescript public grantConnect(grantee: IGrantable): Grant ``` Grant the given identity connection access to the cache. ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable --- ##### `metric` ```typescript public metric(metricName: string, props?: MetricOptions): Metric ``` Create a CloudWatch metric. ###### `metricName`^Required - *Type:* string --- ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- #### 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. | | connections | aws-cdk-lib.aws_ec2.Connections | The network connections associated with this resource. | | endpointAddress | string | The DNS hostname of the cache node. | | endpointPort | number | The port number that the cache engine is listening on. | | serverlessCacheArn | string | The serverless cache ARN. | | serverlessCacheName | string | The serverless cache name. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `connections`^Required ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections The network connections associated with this resource. --- ##### `endpointAddress`^Required ```typescript public readonly endpointAddress: string; ``` - *Type:* string The DNS hostname of the cache node. --- ##### `endpointPort`^Required ```typescript public readonly endpointPort: number; ``` - *Type:* number The port number that the cache engine is listening on. --- ##### `serverlessCacheArn`^Required ```typescript public readonly serverlessCacheArn: string; ``` - *Type:* string The serverless cache ARN. --- ##### `serverlessCacheName`^Required ```typescript public readonly serverlessCacheName: string; ``` - *Type:* string The serverless cache name. --- ### IUser - *Extends:* aws-cdk-lib.IResource - *Implemented By:* @open-constructs/aws-cdk.aws_elasticache.IamUser, @open-constructs/aws-cdk.aws_elasticache.NoPasswordRequiredUser, @open-constructs/aws-cdk.aws_elasticache.PasswordUser, @open-constructs/aws-cdk.aws_elasticache.IIamUser, @open-constructs/aws-cdk.aws_elasticache.INoPasswordRequiredUser, @open-constructs/aws-cdk.aws_elasticache.IPasswordUser, @open-constructs/aws-cdk.aws_elasticache.IUser Interface for a User. #### 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. | | userArn | string | The ARN of the user. | | userId | string | The ID of the user. | | userName | string | The name of the user. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `userArn`^Required ```typescript public readonly userArn: string; ``` - *Type:* string The ARN of the user. --- ##### `userId`^Required ```typescript public readonly userId: string; ``` - *Type:* string The ID of the user. --- ##### `userName`^Required ```typescript public readonly userName: string; ``` - *Type:* string The name of the user. --- ### IUserGroup - *Extends:* aws-cdk-lib.IResource - *Implemented By:* @open-constructs/aws-cdk.aws_elasticache.UserGroup, @open-constructs/aws-cdk.aws_elasticache.IUserGroup Interface for a User Group. #### 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. | | userGroupArn | string | The ARN of the user group. | | userGroupId | string | The ID of the user group. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `userGroupArn`^Required ```typescript public readonly userGroupArn: string; ``` - *Type:* string The ARN of the user group. --- ##### `userGroupId`^Required ```typescript public readonly userGroupId: string; ``` - *Type:* string The ID of the user group. --- ### IWorkgroup - *Extends:* aws-cdk-lib.IResource, aws-cdk-lib.aws_ec2.IConnectable - *Implemented By:* @open-constructs/aws-cdk.aws_redshiftserverless.Workgroup, @open-constructs/aws-cdk.aws_redshiftserverless.IWorkgroup A Redshift Serverless Workgroup. #### 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. | | connections | aws-cdk-lib.aws_ec2.Connections | The network connections associated with this resource. | | endpointAddress | string | The workgroup endpoint address. | | port | number | The workgroup port. | | workgroupArn | string | The workgroup Arn. | | workgroupId | string | The workgroup id. | | workgroupName | string | The workgroup name. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `connections`^Required ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections The network connections associated with this resource. --- ##### `endpointAddress`^Required ```typescript public readonly endpointAddress: string; ``` - *Type:* string The workgroup endpoint address. --- ##### `port`^Required ```typescript public readonly port: number; ``` - *Type:* number The workgroup port. --- ##### `workgroupArn`^Required ```typescript public readonly workgroupArn: string; ``` - *Type:* string The workgroup Arn. --- ##### `workgroupId`^Required ```typescript public readonly workgroupId: string; ``` - *Type:* string The workgroup id. --- ##### `workgroupName`^Required ```typescript public readonly workgroupName: string; ``` - *Type:* string The workgroup name. --- ## Enums ### Engine The engine the cache uses. #### Members | **Name** | **Description** | | --- | --- | | REDIS | Redis. | | VALKEY | Valkey. | | MEMCACHED | Memcached. | --- ##### `REDIS` Redis. --- ##### `VALKEY` Valkey. --- ##### `MEMCACHED` Memcached. --- ### LogExport The types of logs the namespace can export. #### Members | **Name** | **Description** | | --- | --- | | USER_LOG | User log. | | CONNECTION_LOG | Connection log. | | USER_ACTIVITY_LOG | User activity log. | --- ##### `USER_LOG` User log. --- ##### `CONNECTION_LOG` Connection log. --- ##### `USER_ACTIVITY_LOG` User activity log. --- ### MajorVersion The version number of the engine the serverless cache is compatible with. #### Members | **Name** | **Description** | | --- | --- | | VER_7 | Version 7. | | VER_8 | Version 8. | --- ##### `VER_7` Version 7. --- ##### `VER_8` Version 8. --- ### OntapDeploymentType The different kinds of file system deployments used by NetApp ONTAP. #### Members | **Name** | **Description** | | --- | --- | | MULTI_AZ_1 | A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. | | MULTI_AZ_2 | A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. | | SINGLE_AZ_1 | A file system configured for Single-AZ redundancy. | | SINGLE_AZ_2 | A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. | --- ##### `MULTI_AZ_1` A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system. --- ##### `MULTI_AZ_2` A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second-generation FSx for ONTAP file system. --- ##### `SINGLE_AZ_1` A file system configured for Single-AZ redundancy. This is a first-generation FSx for ONTAP file system. --- ##### `SINGLE_AZ_2` A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second-generation FSx for ONTAP file system. --- ### RepositoryConnection Represents the supported external connections for CodeArtifact repositories. #### Members | **Name** | **Description** | | --- | --- | | PYTHON | Python Package Index (PyPI). | | NPM | Node Package Manager (npm). | | NUGET | NuGet Gallery. | | RUBY | RubyGems. | | RUST | Crates.io (Rust). | | MAVEN_CENTRAL | Maven Central Repository. | | GRADLE_PLUGINS | Gradle Plugins. | | MAVEN_GOOGLE | Maven Google. | | MAVEN_APACHE | Maven Apache. | | MAVEN_ATLASSIAN | Maven Atlassian. | | MAVEN_ECLIPSE | Maven Eclipse. | | MAVEN_JBOSS | Maven JBoss. | | MAVEN_SPRING | Maven Spring. | | MAVEN_SPRING_PLUGINS | Maven Spring Plugins. | --- ##### `PYTHON` Python Package Index (PyPI). --- ##### `NPM` Node Package Manager (npm). --- ##### `NUGET` NuGet Gallery. --- ##### `RUBY` RubyGems. --- ##### `RUST` Crates.io (Rust). --- ##### `MAVEN_CENTRAL` Maven Central Repository. --- ##### `GRADLE_PLUGINS` Gradle Plugins. --- ##### `MAVEN_GOOGLE` Maven Google. --- ##### `MAVEN_APACHE` Maven Apache. --- ##### `MAVEN_ATLASSIAN` Maven Atlassian. --- ##### `MAVEN_ECLIPSE` Maven Eclipse. --- ##### `MAVEN_JBOSS` Maven JBoss. --- ##### `MAVEN_SPRING` Maven Spring. --- ##### `MAVEN_SPRING_PLUGINS` Maven Spring Plugins. --- ### StorageUnit Storage unit for data storage in ElastiCache Serverless. #### Members | **Name** | **Description** | | --- | --- | | GB | Gigabytes. | --- ##### `GB` Gigabytes. ---