From e18f3d3552c5f2537ea720c936e24cd7acd9e071 Mon Sep 17 00:00:00 2001 From: lmouhib Date: Wed, 7 Feb 2024 14:42:58 +0000 Subject: [PATCH] build after rebase --- framework/API.md | 347 ++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 346 insertions(+), 1 deletion(-) diff --git a/framework/API.md b/framework/API.md index 0cd859188..ee75b2419 100644 --- a/framework/API.md +++ b/framework/API.md @@ -9028,7 +9028,294 @@ public readonly eksNamespace: string; - *Type:* string - *Default:* Use the default namespace -name of the Amazon EKS namespace to be linked to the Amazon EMR virtual cluster. +The name of the EKS namespace to be linked to the EMR virtual cluster. + +--- + +##### `tags`Optional + +```typescript +public readonly tags: {[ key: string ]: string}; +``` + +- *Type:* {[ key: string ]: string} +- *Default:* none + +The tags assigned to the Virtual Cluster. + +--- + +### OpensearchProps + +Simplified configuration for the Opensearch Cluster. + +> [DataVpc *](DataVpc *) + +#### Initializer + +```typescript +import { storage } from 'aws-dsf' + +const opensearchProps: storage.OpensearchProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| deployInVpc | boolean | *No description.* | +| domainName | string | *No description.* | +| samlEntityId | string | *No description.* | +| samlMasterBackendRole | string | *No description.* | +| samlMetadataContent | string | *No description.* | +| dataNodeInstanceCount | number | *No description.* | +| dataNodeInstanceType | string | *No description.* | +| ebsSize | number | *No description.* | +| ebsVolumeType | aws-cdk-lib.aws_ec2.EbsDeviceVolumeType | *No description.* | +| enableAutoSoftwareUpdate | boolean | *No description.* | +| enableVersionUpgrade | boolean | *No description.* | +| encryptionKmsKeyArn | string | *No description.* | +| masterNodeInstanceCount | number | *No description.* | +| masterNodeInstanceType | string | *No description.* | +| multiAzWithStandbyEnabled | boolean | *No description.* | +| removalPolicy | aws-cdk-lib.RemovalPolicy | *No description.* | +| samlRolesKey | string | *No description.* | +| samlSessionTimeoutMinutes | number | *No description.* | +| samlSubjectKey | string | *No description.* | +| version | aws-cdk-lib.aws_opensearchservice.EngineVersion | *No description.* | +| vpc | aws-cdk-lib.aws_ec2.IVpc | *No description.* | +| warmInstanceCount | number | *No description.* | +| warmInstanceType | number | *No description.* | + +--- + +##### `deployInVpc`Required + +```typescript +public readonly deployInVpc: boolean; +``` + +- *Type:* boolean + +--- + +##### `domainName`Required + +```typescript +public readonly domainName: string; +``` + +- *Type:* string + +--- + +##### `samlEntityId`Required + +```typescript +public readonly samlEntityId: string; +``` + +- *Type:* string + +--- + +##### `samlMasterBackendRole`Required + +```typescript +public readonly samlMasterBackendRole: string; +``` + +- *Type:* string + +--- + +##### `samlMetadataContent`Required + +```typescript +public readonly samlMetadataContent: string; +``` + +- *Type:* string + +--- + +##### `dataNodeInstanceCount`Optional + +```typescript +public readonly dataNodeInstanceCount: number; +``` + +- *Type:* number + +--- + +##### `dataNodeInstanceType`Optional + +```typescript +public readonly dataNodeInstanceType: string; +``` + +- *Type:* string + +--- + +##### `ebsSize`Optional + +```typescript +public readonly ebsSize: number; +``` + +- *Type:* number + +--- + +##### `ebsVolumeType`Optional + +```typescript +public readonly ebsVolumeType: EbsDeviceVolumeType; +``` + +- *Type:* aws-cdk-lib.aws_ec2.EbsDeviceVolumeType + +--- + +##### `enableAutoSoftwareUpdate`Optional + +```typescript +public readonly enableAutoSoftwareUpdate: boolean; +``` + +- *Type:* boolean + +--- + +##### `enableVersionUpgrade`Optional + +```typescript +public readonly enableVersionUpgrade: boolean; +``` + +- *Type:* boolean + +--- + +##### `encryptionKmsKeyArn`Optional + +```typescript +public readonly encryptionKmsKeyArn: string; +``` + +- *Type:* string + +--- + +##### `masterNodeInstanceCount`Optional + +```typescript +public readonly masterNodeInstanceCount: number; +``` + +- *Type:* number + +--- + +##### `masterNodeInstanceType`Optional + +```typescript +public readonly masterNodeInstanceType: string; +``` + +- *Type:* string + +--- + +##### `multiAzWithStandbyEnabled`Optional + +```typescript +public readonly multiAzWithStandbyEnabled: boolean; +``` + +- *Type:* boolean + +--- + +##### `removalPolicy`Optional + +```typescript +public readonly removalPolicy: RemovalPolicy; +``` + +- *Type:* aws-cdk-lib.RemovalPolicy + +--- + +##### `samlRolesKey`Optional + +```typescript +public readonly samlRolesKey: string; +``` + +- *Type:* string + +--- + +##### `samlSessionTimeoutMinutes`Optional + +```typescript +public readonly samlSessionTimeoutMinutes: number; +``` + +- *Type:* number + +--- + +##### `samlSubjectKey`Optional + +```typescript +public readonly samlSubjectKey: string; +``` + +- *Type:* string + +--- + +##### `version`Optional + +```typescript +public readonly version: EngineVersion; +``` + +- *Type:* aws-cdk-lib.aws_opensearchservice.EngineVersion + +--- + +##### `vpc`Optional + +```typescript +public readonly vpc: IVpc; +``` + +- *Type:* aws-cdk-lib.aws_ec2.IVpc + +--- + +##### `warmInstanceCount`Optional + +```typescript +public readonly warmInstanceCount: number; +``` + +- *Type:* number + +--- + +##### `warmInstanceType`Optional + +```typescript +public readonly warmInstanceType: number; +``` + +- *Type:* number --- @@ -11848,6 +12135,64 @@ The list of supported Karpenter versions as defined [here](https://github.com/aw --- +### OpensearchNodes + +Default Node Instances for Opensearch cluster. + +#### Members + +| **Name** | **Description** | +| --- | --- | +| DATA_NODE_INSTANCE_DEFAULT | *No description.* | +| MASTER_NODE_INSTANCE_DEFAULT | *No description.* | +| WARM_NODE_INSTANCE_DEFAULT | *No description.* | + +--- + +##### `DATA_NODE_INSTANCE_DEFAULT` + +--- + + +##### `MASTER_NODE_INSTANCE_DEFAULT` + +--- + + +##### `WARM_NODE_INSTANCE_DEFAULT` + +--- + + +### RedshiftServerlessNamespaceLogExport + +Namespace log export types. + +#### Members + +| **Name** | **Description** | +| --- | --- | +| USER_LOG | *No description.* | +| CONNECTION_LOG | *No description.* | +| USER_ACTIVITY_LOG | *No description.* | + +--- + +##### `USER_LOG` + +--- + + +##### `CONNECTION_LOG` + +--- + + +##### `USER_ACTIVITY_LOG` + +--- + + ### SparkImage The list of supported Spark images to use in the SparkCICDPipeline.