diff --git a/API.md b/API.md index 7a4c417d..bc0b54bc 100644 --- a/API.md +++ b/API.md @@ -19267,631 +19267,6 @@ The CloudFormation resource type name for this resource class. --- -### CfnPrivateEndpointAdl - -A CloudFormation `MongoDB::Atlas::PrivateEndpointADL`. - -#### Initializers - -```typescript -import { CfnPrivateEndpointAdl } from 'awscdk-resources-mongodbatlas' - -new CfnPrivateEndpointAdl(scope: Construct, id: string, props: CfnPrivateEndpointAdlProps) -``` - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnPrivateEndpointAdlProps | - resource properties. | - ---- - -##### `scope`Required - -- *Type:* constructs.Construct - -scope in which this resource is defined. - ---- - -##### `id`Required - -- *Type:* string - -scoped id of the resource. - ---- - -##### `props`Required - -- *Type:* CfnPrivateEndpointAdlProps - -resource properties. - ---- - -#### Methods - -| **Name** | **Description** | -| --- | --- | -| toString | Returns a string representation of this construct. | -| overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | -| addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | -| addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | -| addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | -| addMetadata | Add a value to the CloudFormation Resource Metadata. | -| addOverride | Adds an override to the synthesized CloudFormation resource. | -| addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | -| addPropertyOverride | Adds an override to a resource property. | -| applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | -| getAtt | Returns a token for an runtime attribute of this resource. | -| getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | -| obtainDependencies | Retrieves an array of resources this resource depends on. | -| obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | -| removeDependency | Indicates that this resource no longer depends on another resource. | -| replaceDependency | Replaces one dependency with another. | - ---- - -##### `toString` - -```typescript -public toString(): string -``` - -Returns a string representation of this construct. - -##### `overrideLogicalId` - -```typescript -public overrideLogicalId(newLogicalId: string): void -``` - -Overrides the auto-generated logical ID with a specific ID. - -###### `newLogicalId`Required - -- *Type:* string - -The new logical ID to use for this stack element. - ---- - -##### `addDeletionOverride` - -```typescript -public addDeletionOverride(path: string): void -``` - -Syntactic sugar for `addOverride(path, undefined)`. - -###### `path`Required - -- *Type:* string - -The path of the value to delete. - ---- - -##### `addDependency` - -```typescript -public addDependency(target: CfnResource): void -``` - -Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. - -This can be used for resources across stacks (or nested stack) boundaries -and the dependency will automatically be transferred to the relevant scope. - -###### `target`Required - -- *Type:* aws-cdk-lib.CfnResource - ---- - -##### ~~`addDependsOn`~~ - -```typescript -public addDependsOn(target: CfnResource): void -``` - -Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. - -###### `target`Required - -- *Type:* aws-cdk-lib.CfnResource - ---- - -##### `addMetadata` - -```typescript -public addMetadata(key: string, value: any): void -``` - -Add a value to the CloudFormation Resource Metadata. - -> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html - -Note that this is a different set of metadata from CDK node metadata; this -metadata ends up in the stack template under the resource, whereas CDK -node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html - -Note that this is a different set of metadata from CDK node metadata; this -metadata ends up in the stack template under the resource, whereas CDK -node metadata ends up in the Cloud Assembly.) - -###### `key`Required - -- *Type:* string - ---- - -###### `value`Required - -- *Type:* any - ---- - -##### `addOverride` - -```typescript -public addOverride(path: string, value: any): void -``` - -Adds an override to the synthesized CloudFormation resource. - -To add a -property override, either use `addPropertyOverride` or prefix `path` with -"Properties." (i.e. `Properties.TopicName`). - -If the override is nested, separate each nested level using a dot (.) in the path parameter. -If there is an array as part of the nesting, specify the index in the path. - -To include a literal `.` in the property name, prefix with a `\`. In most -programming languages you will need to write this as `"\\."` because the -`\` itself will need to be escaped. - -For example, -```typescript -cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); -cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); -``` -would add the overrides -```json -"Properties": { - "GlobalSecondaryIndexes": [ - { - "Projection": { - "NonKeyAttributes": [ "myattribute" ] - ... - } - ... - }, - { - "ProjectionType": "INCLUDE" - ... - }, - ] - ... -} -``` - -The `value` argument to `addOverride` will not be processed or translated -in any way. Pass raw JSON values in here with the correct capitalization -for CloudFormation. If you pass CDK classes or structs, they will be -rendered with lowercased key names, and CloudFormation will reject the -template. - -###### `path`Required - -- *Type:* string - -The path of the property, you can use dot notation to override values in complex types. - -Any intermediate keys -will be created as needed. - ---- - -###### `value`Required - -- *Type:* any - -The value. - -Could be primitive or complex. - ---- - -##### `addPropertyDeletionOverride` - -```typescript -public addPropertyDeletionOverride(propertyPath: string): void -``` - -Adds an override that deletes the value of a property from the resource definition. - -###### `propertyPath`Required - -- *Type:* string - -The path to the property. - ---- - -##### `addPropertyOverride` - -```typescript -public addPropertyOverride(propertyPath: string, value: any): void -``` - -Adds an override to a resource property. - -Syntactic sugar for `addOverride("Properties.<...>", value)`. - -###### `propertyPath`Required - -- *Type:* string - -The path of the property. - ---- - -###### `value`Required - -- *Type:* any - -The value. - ---- - -##### `applyRemovalPolicy` - -```typescript -public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void -``` - -Sets the deletion policy of the resource based on the removal policy specified. - -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`). In some -cases, a snapshot can be taken of the resource prior to deletion -(`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy -can be found in the following link: - -> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) - -###### `policy`Optional - -- *Type:* aws-cdk-lib.RemovalPolicy - ---- - -###### `options`Optional - -- *Type:* aws-cdk-lib.RemovalPolicyOptions - ---- - -##### `getAtt` - -```typescript -public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference -``` - -Returns a token for an runtime attribute of this resource. - -Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility -in case there is no generated attribute. - -###### `attributeName`Required - -- *Type:* string - -The name of the attribute. - ---- - -###### `typeHint`Optional - -- *Type:* aws-cdk-lib.ResolutionTypeHint - ---- - -##### `getMetadata` - -```typescript -public getMetadata(key: string): any -``` - -Retrieve a value value from the CloudFormation Resource Metadata. - -> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html - -Note that this is a different set of metadata from CDK node metadata; this -metadata ends up in the stack template under the resource, whereas CDK -node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html - -Note that this is a different set of metadata from CDK node metadata; this -metadata ends up in the stack template under the resource, whereas CDK -node metadata ends up in the Cloud Assembly.) - -###### `key`Required - -- *Type:* string - ---- - -##### `obtainDependencies` - -```typescript -public obtainDependencies(): (Stack | CfnResource)[] -``` - -Retrieves an array of resources this resource depends on. - -This assembles dependencies on resources across stacks (including nested stacks) -automatically. - -##### `obtainResourceDependencies` - -```typescript -public obtainResourceDependencies(): CfnResource[] -``` - -Get a shallow copy of dependencies between this resource and other resources in the same stack. - -##### `removeDependency` - -```typescript -public removeDependency(target: CfnResource): void -``` - -Indicates that this resource no longer depends on another resource. - -This can be used for resources across stacks (including nested stacks) -and the dependency will automatically be removed from the relevant scope. - -###### `target`Required - -- *Type:* aws-cdk-lib.CfnResource - ---- - -##### `replaceDependency` - -```typescript -public replaceDependency(target: CfnResource, newTarget: CfnResource): void -``` - -Replaces one dependency with another. - -###### `target`Required - -- *Type:* aws-cdk-lib.CfnResource - -The dependency to replace. - ---- - -###### `newTarget`Required - -- *Type:* aws-cdk-lib.CfnResource - -The new dependency to add. - ---- - -#### Static Functions - -| **Name** | **Description** | -| --- | --- | -| isConstruct | Checks if `x` is a construct. | -| isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | -| isCfnResource | Check whether the given object is a CfnResource. | - ---- - -##### ~~`isConstruct`~~ - -```typescript -import { CfnPrivateEndpointAdl } from 'awscdk-resources-mongodbatlas' - -CfnPrivateEndpointAdl.isConstruct(x: any) -``` - -Checks if `x` is a construct. - -###### `x`Required - -- *Type:* any - -Any object. - ---- - -##### `isCfnElement` - -```typescript -import { CfnPrivateEndpointAdl } from 'awscdk-resources-mongodbatlas' - -CfnPrivateEndpointAdl.isCfnElement(x: any) -``` - -Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). - -Uses duck-typing instead of `instanceof` to allow stack elements from different -versions of this library to be included in the same stack. - -###### `x`Required - -- *Type:* any - ---- - -##### `isCfnResource` - -```typescript -import { CfnPrivateEndpointAdl } from 'awscdk-resources-mongodbatlas' - -CfnPrivateEndpointAdl.isCfnResource(x: any) -``` - -Check whether the given object is a CfnResource. - -###### `x`Required - -- *Type:* any - ---- - -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| node | constructs.Node | The tree node. | -| creationStack | string[] | *No description.* | -| logicalId | string | The logical ID for this CloudFormation stack element. | -| stack | aws-cdk-lib.Stack | The stack in which this element is defined. | -| ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | -| cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | -| cfnResourceType | string | AWS resource type. | -| props | CfnPrivateEndpointAdlProps | Resource props. | - ---- - -##### `node`Required - -```typescript -public readonly node: Node; -``` - -- *Type:* constructs.Node - -The tree node. - ---- - -##### `creationStack`Required - -```typescript -public readonly creationStack: string[]; -``` - -- *Type:* string[] - ---- - -##### `logicalId`Required - -```typescript -public readonly logicalId: string; -``` - -- *Type:* string - -The logical ID for this CloudFormation stack element. - -The logical ID of the element -is calculated from the path of the resource node in the construct tree. - -To override this value, use `overrideLogicalId(newLogicalId)`. - ---- - -##### `stack`Required - -```typescript -public readonly stack: Stack; -``` - -- *Type:* aws-cdk-lib.Stack - -The stack in which this element is defined. - -CfnElements must be defined within a stack scope (directly or indirectly). - ---- - -##### `ref`Required - -```typescript -public readonly ref: string; -``` - -- *Type:* string - -Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. - -If, by any chance, the intrinsic reference of a resource is not a string, you could -coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. - ---- - -##### `cfnOptions`Required - -```typescript -public readonly cfnOptions: ICfnResourceOptions; -``` - -- *Type:* aws-cdk-lib.ICfnResourceOptions - -Options for this resource, such as condition, update policy etc. - ---- - -##### `cfnResourceType`Required - -```typescript -public readonly cfnResourceType: string; -``` - -- *Type:* string - -AWS resource type. - ---- - -##### `props`Required - -```typescript -public readonly props: CfnPrivateEndpointAdlProps; -``` - -- *Type:* CfnPrivateEndpointAdlProps - -Resource props. - ---- - -#### Constants - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | - ---- - -##### `CFN_RESOURCE_TYPE_NAME`Required - -```typescript -public readonly CFN_RESOURCE_TYPE_NAME: string; -``` - -- *Type:* string - -The CloudFormation resource type name for this resource class. - ---- - ### CfnPrivateEndpointAws A CloudFormation `MongoDB::Atlas::PrivateEndpointAWS`. @@ -36314,7 +35689,7 @@ const cfnDatabaseUserProps: CfnDatabaseUserProps = { ... } | ldapAuthType | CfnDatabaseUserPropsLdapAuthType | Method by which the provided username is authenticated. | | password | string | The user’s password. | | profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided `default` is used. | -| scopes | ScopeDefinition[] | List that contains clusters and MongoDB Atlas Data Lakes that this database user can access. | +| scopes | ScopeDefinition[] | List that contains clusters and MongoDB Atlas Data Federation that this database user can access. | | x509Type | CfnDatabaseUserPropsX509Type | Method that briefs who owns the certificate provided. | --- @@ -36473,9 +35848,9 @@ public readonly scopes: ScopeDefinition[]; - *Type:* ScopeDefinition[] -List that contains clusters and MongoDB Atlas Data Lakes that this database user can access. +List that contains clusters and MongoDB Atlas Data Federation that this database user can access. -If omitted, MongoDB Cloud grants the database user access to all the clusters and MongoDB Atlas Data Lakes in the project. +If omitted, MongoDB Cloud grants the database user access to all the clusters and MongoDB Atlas Data Federation in the project. --- @@ -36569,8 +35944,8 @@ const cfnFederatedDatabaseInstanceProps: CfnFederatedDatabaseInstanceProps = { . | --- | --- | --- | | projectId | string | Unique 24-hexadecimal digit string that identifies your project. | | tenantName | string | Human-readable label that identifies the data federation. | -| cloudProviderConfig | CloudProviderConfig | Cloud provider linked to this data lake. | -| dataProcessRegion | DataProcessRegion | Information about the cloud provider region to which the data lake routes client connections. | +| cloudProviderConfig | CloudProviderConfig | Cloud provider linked to this Atlas Data Federation. | +| dataProcessRegion | DataProcessRegion | Information about the cloud provider region to which the Atlas Data Federation routes client connections. | | profile | string | The profile is defined in AWS Secret manager. | | skipRoleValidation | boolean | Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. | | storage | Storage | Configuration information for each data store and its mapping to MongoDB Cloud databases. | @@ -36609,7 +35984,7 @@ public readonly cloudProviderConfig: CloudProviderConfig; - *Type:* CloudProviderConfig -Cloud provider linked to this data lake. +Cloud provider linked to this Atlas Data Federation. --- @@ -36621,7 +35996,7 @@ public readonly dataProcessRegion: DataProcessRegion; - *Type:* DataProcessRegion -Information about the cloud provider region to which the data lake routes client connections. +Information about the cloud provider region to which the Atlas Data Federation routes client connections. MongoDB Cloud supports AWS only. @@ -38269,107 +37644,6 @@ Email address of the MongoDB Cloud user invited to join the organization. --- -### CfnPrivateEndpointAdlProps - -Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. - -To use this resource, the requesting API Key must have the Project Atlas Admin or Project Charts Admin roles. This resource doesn't require the API Key to have an Access List. - -#### Initializer - -```typescript -import { CfnPrivateEndpointAdlProps } from 'awscdk-resources-mongodbatlas' - -const cfnPrivateEndpointAdlProps: CfnPrivateEndpointAdlProps = { ... } -``` - -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| projectId | string | Unique 24-hexadecimal digit string that identifies your project. | -| provider | string | Human-readable label that identifies the cloud service provider. | -| comment | string | Human-readable string to associate with this private endpoint. | -| endpointId | string | Unique 22-character alphanumeric string that identifies the private endpoint. | -| profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | -| type | string | Human-readable label that identifies the resource type associated with this private endpoint. | - ---- - -##### `projectId`Required - -```typescript -public readonly projectId: string; -``` - -- *Type:* string - -Unique 24-hexadecimal digit string that identifies your project. - ---- - -##### `provider`Required - -```typescript -public readonly provider: string; -``` - -- *Type:* string - -Human-readable label that identifies the cloud service provider. - -Atlas Data Lake supports Amazon Web Services only. - ---- - -##### `comment`Optional - -```typescript -public readonly comment: string; -``` - -- *Type:* string - -Human-readable string to associate with this private endpoint. - ---- - -##### `endpointId`Optional - -```typescript -public readonly endpointId: string; -``` - -- *Type:* string - -Unique 22-character alphanumeric string that identifies the private endpoint. - ---- - -##### `profile`Optional - -```typescript -public readonly profile: string; -``` - -- *Type:* string - -Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. - ---- - -##### `type`Optional - -```typescript -public readonly type: string; -``` - -- *Type:* string - -Human-readable label that identifies the resource type associated with this private endpoint. - ---- - ### CfnPrivateEndpointAwsProps Creates one private endpoint for the specified cloud service provider. @@ -38760,7 +38034,7 @@ public readonly endpointId: string; Unique 22-character alphanumeric string that identifies the private endpoint.Reg ex ^vpce-[0-9a-f]{17}$ . -Atlas Data Lake supports Amazon Web Services private endpoints using the AWS PrivateLink feature. +Atlas Data Federation supports Amazon Web Services private endpoints using the AWS PrivateLink feature. --- @@ -40734,7 +40008,7 @@ Username of the database user to create a certificate for. ### CloudProviderConfig -Cloud provider linked to this data lake.. +Cloud provider linked to this Atlas Data Federation. #### Initializer @@ -40748,10 +40022,10 @@ const cloudProviderConfig: CloudProviderConfig = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| externalId | string | Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig. | -| iamAssumedRoleArn | string | Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the data lake assumes when accessing data stores. | -| iamUserArn | string | Amazon Resource Name (ARN) of the user that the data lake assumes when accessing data stores. | -| roleId | string | Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig. | +| externalId | string | Unique identifier of the role that the Atlas Data Federation can use to access the data stores.Required if specifying cloudProviderConfig. | +| iamAssumedRoleArn | string | Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the Atlas Data Federation assumes when accessing data stores. | +| iamUserArn | string | Amazon Resource Name (ARN) of the user that the Atlas Data Federation assumes when accessing data stores. | +| roleId | string | Unique identifier of the role that the Atlas Data Federation can use to access the data stores.Required if specifying cloudProviderConfig. | | testS3Bucket | string | Name of the S3 data bucket that the provided role ID is authorized to access.Required if specifying cloudProviderConfig. | --- @@ -40764,7 +40038,7 @@ public readonly externalId: string; - *Type:* string -Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig. +Unique identifier of the role that the Atlas Data Federation can use to access the data stores.Required if specifying cloudProviderConfig. --- @@ -40776,7 +40050,7 @@ public readonly iamAssumedRoleArn: string; - *Type:* string -Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the data lake assumes when accessing data stores. +Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the Atlas Data Federation assumes when accessing data stores. --- @@ -40788,7 +40062,7 @@ public readonly iamUserArn: string; - *Type:* string -Amazon Resource Name (ARN) of the user that the data lake assumes when accessing data stores. +Amazon Resource Name (ARN) of the user that the Atlas Data Federation assumes when accessing data stores. --- @@ -40800,7 +40074,7 @@ public readonly roleId: string; - *Type:* string -Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig. +Unique identifier of the role that the Atlas Data Federation can use to access the data stores.Required if specifying cloudProviderConfig. --- @@ -41038,7 +40312,7 @@ const collection: Collection = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| dataSources | DataSource[] | Array that contains the data stores that map to a collection for this data lake. | +| dataSources | DataSource[] | Array that contains the data stores that map to a collection for this Atlas Data Federation. | | name | string | *No description.* | --- @@ -41051,7 +40325,7 @@ public readonly dataSources: DataSource[]; - *Type:* DataSource[] -Array that contains the data stores that map to a collection for this data lake. +Array that contains the data stores that map to a collection for this Atlas Data Federation. --- @@ -41330,7 +40604,7 @@ const database: Database = { ... } | --- | --- | --- | | collections | Collection[] | Array of collections and data sources that map to a stores data store. | | maxWildcardCollections | string | Maximum number of wildcard collections in the database. | -| name | string | Human-readable label that identifies the database to which the data lake maps data. | +| name | string | Human-readable label that identifies the database to which the Atlas Data Federation maps data. | | views | View[] | Array of aggregation pipelines that apply to the collection. | --- @@ -41369,7 +40643,7 @@ public readonly name: string; - *Type:* string -Human-readable label that identifies the database to which the data lake maps data. +Human-readable label that identifies the database to which the Atlas Data Federation maps data. --- @@ -41788,7 +41062,7 @@ Two-letter code that indicates which regional URL MongoDB uses to access the Dat ### DataProcessRegion -Information about the cloud provider region to which the data lake routes client connections. +Information about the cloud provider region to which the Atlas Data Federation routes client connections. MongoDB Cloud supports AWS only. @@ -41804,8 +41078,8 @@ const dataProcessRegion: DataProcessRegion = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| region | string | Name of the region to which the data lake routes client connections. | -| cloudProvider | string | Name of the cloud service that hosts the data lake's data stores. | +| region | string | Name of the region to which the Atlas Data Federation routes client connections. | +| cloudProvider | string | Name of the cloud service that hosts the Atlas Data Federation data stores. | --- @@ -41817,7 +41091,7 @@ public readonly region: string; - *Type:* string -Name of the region to which the data lake routes client connections. +Name of the region to which the Atlas Data Federation routes client connections. --- @@ -41829,7 +41103,7 @@ public readonly cloudProvider: string; - *Type:* string -Name of the cloud service that hosts the data lake's data stores. +Name of the cloud service that hosts the Atlas Data Federation data stores. --- @@ -41990,7 +41264,7 @@ public readonly urls: string[]; URLs of the publicly accessible data files. -You can't specify URLs that require authentication. Atlas Data Lake creates a partition for each URL. If empty or omitted, Data Lake uses the URLs from the store specified in the dataSources.storeName parameter. +You can't specify URLs that require authentication. Atlas Data Federation creates a partition for each URL. If empty or omitted, Data Federation uses the URLs from the store specified in the dataSources.storeName parameter. --- @@ -44362,7 +43636,7 @@ public readonly tagSets: TagSet[][]; List that contains tag sets or tag specification documents. -If specified, Atlas Data Lake routes read requests to replica set member or members that are associated with the specified tags. +If specified, Atlas Data Federation routes read requests to replica set member or members that are associated with the specified tags. --- @@ -45036,8 +44310,8 @@ const storage: Storage = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| databases | Database[] | Array that contains the queryable databases and collections for this data lake. | -| stores | Store[] | Array that contains the data stores for the data lake. | +| databases | Database[] | Array that contains the queryable databases and collections for this Atlas Data Federation. | +| stores | Store[] | Array that contains the data stores for the Atlas Data Federation. | --- @@ -45049,7 +44323,7 @@ public readonly databases: Database[]; - *Type:* Database[] -Array that contains the queryable databases and collections for this data lake. +Array that contains the queryable databases and collections for this Atlas Data Federation. --- @@ -45061,13 +44335,13 @@ public readonly stores: Store[]; - *Type:* Store[] -Array that contains the data stores for the data lake. +Array that contains the data stores for the Atlas Data Federation. --- ### Store -Array that contains the data stores for the data lake. +Array that contains the data stores for the Atlas Data Federation. #### Initializer @@ -45111,7 +44385,7 @@ public readonly name: string; Human-readable label that identifies the data store. -The databases.[n].collections.[n].dataSources.[n].storeName field references this values as part of the mapping configuration. To use MongoDB Cloud as a data store, the data lake requires a serverless instance or an M10 or higher cluster. +The databases.[n].collections.[n].dataSources.[n].storeName field references this values as part of the mapping configuration. To use MongoDB Cloud as a data store, the Atlas Data Federation requires a serverless instance or an M10 or higher cluster. --- diff --git a/examples/l1-resources/private-endpoint-adl.ts b/examples/l1-resources/private-endpoint-adl.ts deleted file mode 100644 index f4b65c2d..00000000 --- a/examples/l1-resources/private-endpoint-adl.ts +++ /dev/null @@ -1,49 +0,0 @@ -import * as cdk from 'aws-cdk-lib'; -import { Construct } from 'constructs'; -import { CfnPrivateEndpointAdl } from 'awscdk-resources-mongodbatlas'; - -interface AtlasStackProps { - readonly projId: string; - readonly profile: string; - readonly type: string; - readonly endpointId: string; - readonly comment: string; -} - -export class CdkTestingStack extends cdk.Stack { - constructor(scope: Construct, id: string, props?: cdk.StackProps) { - super(scope, id, props); - - const atlasProps = this.getContextProps(); - - const myPrivateEndpointAdl = new CfnPrivateEndpointAdl(this, 'MyPrivateEndpointAdl', { - projectId: atlasProps.projId, - profile: atlasProps.profile, - provider: 'AWS', - type: atlasProps.type, - endpointId: atlasProps.endpointId, - comment: atlasProps.comment, - }); - } - - getContextProps(): AtlasStackProps { - const projId = this.node.tryGetContext('projId'); - if (!projId){ - throw "No context value specified for orgId. Please specify via the cdk context." - } - - const profile = this.node.tryGetContext('profile') ?? 'default'; - const type = this.node.tryGetContext('type'); - const endpointId = this.node.tryGetContext('endpointId'); - const comment = this.node.tryGetContext('comment'); - - - return { - projId, - profile, - type, - endpointId, - comment, - } - } -} diff --git a/examples/l1-resources/private-endpoint-regional-mode.ts b/examples/l1-resources/private-endpoint-regional-mode.ts index ed931489..30b515ae 100644 --- a/examples/l1-resources/private-endpoint-regional-mode.ts +++ b/examples/l1-resources/private-endpoint-regional-mode.ts @@ -12,18 +12,18 @@ export class CdkTestingStack extends cdk.Stack { super(scope, id, props); const atlasProps = this.getContextProps(); - const myPrivateEndpointAdl = new CfnPrivateEndPointRegionalMode(this, 'MyPrivateEndpointAdl', { + const myPrivateEndpoint = new CfnPrivateEndPointRegionalMode(this, 'MyPrivateEndpoint', { projectId: atlasProps.projId, - profile: atlasProps.profile, + profile: atlasProps.profile, }); } getContextProps(): AtlasStackProps { const projId = this.node.tryGetContext('projId'); - if (!projId){ + if (!projId) { throw "No context value specified for projId. Please specify via the cdk context." } - + const profile = this.node.tryGetContext('profile') ?? 'default'; diff --git a/src/README.md b/src/README.md index 4919e952..82744aa2 100644 --- a/src/README.md +++ b/src/README.md @@ -32,7 +32,6 @@ L1 constructs are called Cfn (short for CloudFormation) resources. These resourc | online-archive | Returns, adds, edits, or removes an online archive. | [README.md](l1-resources/online-archive/README.md) | | | org-invitation | Returns, adds, and edits organizational units in MongoDB Cloud. | [README.md](l1-resources/org-invitation/README.md) | | private-endpoint | The Private Endpoint creation flow consists of the creation of three related resources in the next order: 1. Atlas Private Endpoint Service 2. Aws VPC private Endpoint 3. Atlas Private Endpoint | [README.md](l1-resources/private-endpoint/README.md) | -| private-endpoint-adl | Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. To use this resource, the requesting API Key must have the Project Atlas Admin or Project Charts Admin roles. This resource doesn't require the API Key to have an Access List. | [README.md](l1-resources/private-endpoint-adl/README.md) | | private-endpoint-regional-mode | This resource manages the private enpoint regional mode. | [README.md](l1-resources/private-endpoint-regional-mode/README.md) | | project | Retrieves or creates projects in any given Atlas organization. | [README.md](l1-resources/project/README.md) | | project-invitation | Returns, send project invitations. | [README.md](l1-resources/project-invitation/README.md) | diff --git a/src/index.ts b/src/index.ts index 81cd03bf..32d840b7 100644 --- a/src/index.ts +++ b/src/index.ts @@ -242,11 +242,6 @@ export { PrivateEndpoint, } from "./l1-resources/private-endpoint"; -export { - CfnPrivateEndpointAdl, - CfnPrivateEndpointAdlProps, -} from "./l1-resources/private-endpoint-adl"; - export { CfnPrivateEndpointAwsProps, CfnPrivateEndpointAws, diff --git a/src/l1-resources/database-user/index.ts b/src/l1-resources/database-user/index.ts index 3ebac3cb..e243fcd5 100644 --- a/src/l1-resources/database-user/index.ts +++ b/src/l1-resources/database-user/index.ts @@ -79,7 +79,7 @@ export interface CfnDatabaseUserProps { readonly roles: RoleDefinition[]; /** - * List that contains clusters and MongoDB Atlas Data Lakes that this database user can access. If omitted, MongoDB Cloud grants the database user access to all the clusters and MongoDB Atlas Data Lakes in the project. + * List that contains clusters and MongoDB Atlas Data Federation that this database user can access. If omitted, MongoDB Cloud grants the database user access to all the clusters and MongoDB Atlas Data Federation in the project. * * @schema CfnDatabaseUserProps#Scopes */ diff --git a/src/l1-resources/federated-database-instance/index.ts b/src/l1-resources/federated-database-instance/index.ts index 36ff3bad..ba223fe3 100644 --- a/src/l1-resources/federated-database-instance/index.ts +++ b/src/l1-resources/federated-database-instance/index.ts @@ -9,14 +9,14 @@ import * as constructs from "constructs"; */ export interface CfnFederatedDatabaseInstanceProps { /** - * Cloud provider linked to this data lake. + * Cloud provider linked to this Atlas Data Federation. * * @schema CfnFederatedDatabaseInstanceProps#CloudProviderConfig */ readonly cloudProviderConfig?: CloudProviderConfig; /** - * Information about the cloud provider region to which the data lake routes client connections. MongoDB Cloud supports AWS only. + * Information about the cloud provider region to which the Atlas Data Federation routes client connections. MongoDB Cloud supports AWS only. * * @schema CfnFederatedDatabaseInstanceProps#DataProcessRegion */ @@ -86,34 +86,34 @@ export function toJson_CfnFederatedDatabaseInstanceProps( /* eslint-enable max-len, quote-props */ /** - * Cloud provider linked to this data lake.. + * Cloud provider linked to this Atlas Data Federation. * * @schema CloudProviderConfig */ export interface CloudProviderConfig { /** - * Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig. + * Unique identifier of the role that the Atlas Data Federation can use to access the data stores.Required if specifying cloudProviderConfig. * * @schema CloudProviderConfig#ExternalId */ readonly externalId?: string; /** - * Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the data lake assumes when accessing data stores. + * Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the Atlas Data Federation assumes when accessing data stores. * * @schema CloudProviderConfig#IamAssumedRoleARN */ readonly iamAssumedRoleArn?: string; /** - * Amazon Resource Name (ARN) of the user that the data lake assumes when accessing data stores. + * Amazon Resource Name (ARN) of the user that the Atlas Data Federation assumes when accessing data stores. * * @schema CloudProviderConfig#IamUserARN */ readonly iamUserArn?: string; /** - * Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig. + * Unique identifier of the role that the Atlas Data Federation can use to access the data stores.Required if specifying cloudProviderConfig. * * @schema CloudProviderConfig#RoleId */ @@ -153,20 +153,20 @@ export function toJson_CloudProviderConfig( /* eslint-enable max-len, quote-props */ /** - * Information about the cloud provider region to which the data lake routes client connections. MongoDB Cloud supports AWS only. + * Information about the cloud provider region to which the Atlas Data Federation routes client connections. MongoDB Cloud supports AWS only. * * @schema DataProcessRegion */ export interface DataProcessRegion { /** - * Name of the cloud service that hosts the data lake's data stores. + * Name of the cloud service that hosts the Atlas Data Federation data stores. * * @schema DataProcessRegion#CloudProvider */ readonly cloudProvider?: string; /** - * Name of the region to which the data lake routes client connections. + * Name of the region to which the Atlas Data Federation routes client connections. * * @schema DataProcessRegion#Region */ @@ -202,14 +202,14 @@ export function toJson_DataProcessRegion( */ export interface Storage { /** - * Array that contains the queryable databases and collections for this data lake. + * Array that contains the queryable databases and collections for this Atlas Data Federation. * * @schema Storage#Databases */ readonly databases?: Database[]; /** - * Array that contains the data stores for the data lake. + * Array that contains the data stores for the Atlas Data Federation. * * @schema Storage#Stores */ @@ -257,7 +257,7 @@ export interface Database { readonly maxWildcardCollections?: string; /** - * Human-readable label that identifies the database to which the data lake maps data. + * Human-readable label that identifies the database to which the Atlas Data Federation maps data. * * @schema Database#Name */ @@ -296,13 +296,13 @@ export function toJson_Database( /* eslint-enable max-len, quote-props */ /** - * Array that contains the data stores for the data lake. + * Array that contains the data stores for the Atlas Data Federation. * * @schema Store */ export interface Store { /** - * Human-readable label that identifies the data store. The databases.[n].collections.[n].dataSources.[n].storeName field references this values as part of the mapping configuration. To use MongoDB Cloud as a data store, the data lake requires a serverless instance or an M10 or higher cluster. + * Human-readable label that identifies the data store. The databases.[n].collections.[n].dataSources.[n].storeName field references this values as part of the mapping configuration. To use MongoDB Cloud as a data store, the Atlas Data Federation requires a serverless instance or an M10 or higher cluster. * * @schema Store#Name */ @@ -369,7 +369,7 @@ export function toJson_Store( */ export interface Collection { /** - * Array that contains the data stores that map to a collection for this data lake. + * Array that contains the data stores that map to a collection for this Atlas Data Federation. * * @schema Collection#DataSources */ @@ -472,7 +472,7 @@ export interface ReadPreference { readonly maxStalenessSeconds?: string; /** - * List that contains tag sets or tag specification documents. If specified, Atlas Data Lake routes read requests to replica set member or members that are associated with the specified tags. + * List that contains tag sets or tag specification documents. If specified, Atlas Data Federation routes read requests to replica set member or members that are associated with the specified tags. * * @schema ReadPreference#TagSets */ @@ -570,7 +570,7 @@ export interface DataSource { readonly storeName?: string; /** - * URLs of the publicly accessible data files. You can't specify URLs that require authentication. Atlas Data Lake creates a partition for each URL. If empty or omitted, Data Lake uses the URLs from the store specified in the dataSources.storeName parameter. + * URLs of the publicly accessible data files. You can't specify URLs that require authentication. Atlas Data Federation creates a partition for each URL. If empty or omitted, Data Federation uses the URLs from the store specified in the dataSources.storeName parameter. * * @schema DataSource#Urls */ diff --git a/src/l1-resources/private-endpoint-adl/README.md b/src/l1-resources/private-endpoint-adl/README.md deleted file mode 100644 index 61e1e41f..00000000 --- a/src/l1-resources/private-endpoint-adl/README.md +++ /dev/null @@ -1,68 +0,0 @@ -# private-endpoint-adl - -The official [MongoDB Atlas](https://www.mongodb.com/) AWS CDK resource for Node.js. - -> AWS CDK [L1 construct] and data structures for the [AWS CloudFormation Registry] type `MongoDB::Atlas::PrivateEndpointADL` v1.0.0. - -[L1 construct]: https://docs.aws.amazon.com/cdk/latest/guide/constructs.html -[AWS CloudFormation Registry]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html - -## Description - -Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. To use this resource, the requesting API Key must have the Project Atlas Admin or Project Charts Admin roles. This resource doesn't require the API Key to have an Access List. - -## MongoDB Atlas API Docs - -For more information about the API refer to: [API Endpoints](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/group/endpoint-data-federation-private-networks) - -## Usage - -In order to use this library, you will need to activate this AWS CloudFormation Registry type in your account. You can do this via the AWS Management Console or using the [AWS CLI](https://aws.amazon.com/cli/) using the following command: - -```sh -aws cloudformation activate-type \ - --type-name MongoDB::Atlas::PrivateEndpointADL \ - --publisher-id bb989456c78c398a858fef18f2ca1bfc1fbba082 \ - --type RESOURCE \ - --execution-role-arn ROLE-ARN -``` - -Alternatively: - -```sh -aws cloudformation activate-type \ - --public-type-arn arn:aws:cloudformation:us-east-1::type/resource/bb989456c78c398a858fef18f2ca1bfc1fbba082/MongoDB-Atlas-PrivateEndpointADL \ - --execution-role-arn ROLE-ARN -``` - -You can find more information about activating this type in the [AWS CloudFormation documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html). - -## Example: [private-endpint-adl](../../../examples/l1-resources/private-endpoint-adl.ts) -```ts -import { CfnPrivateEndpointAdl } from 'awscdk-resources-mongodbatlas'; - -const myPrivateEndpointAdl = new CfnPrivateEndpointAdl(this, 'MyPrivateEndpointAdl', { - projectId: atlasProps.projId, - profile: atlasProps.profile, - provider: 'AWS', - type: atlasProps.type, - endpointId: atlasProps.endpointId, - comment: atlasProps.comment, -}); - -``` - - -## Feedback - -This library is auto-generated and published to all supported programming languages by the [cdklabs/cdk-cloudformation] project based on the API schema published for `MongoDB::Atlas::PrivateEndpointADL`. - -* Issues related to this generated library should be [reported here](https://github.com/cdklabs/cdk-cloudformation/issues/new?title=Issue+with+%40cdk-cloudformation%2Fmongodb-atlas-privateendpointadl+v1.0.0). -* Issues related to `MongoDB::Atlas::PrivateEndpointADL` should be reported to the [publisher](https://github.com/mongodb/mongodbatlas-cloudformation-resources/issues). -* Feature requests should be [reported here](https://feedback.mongodb.com/ideas?category=7548141186718564699) - -[cdklabs/cdk-cloudformation]: https://github.com/cdklabs/cdk-cloudformation - -## License - -Distributed under the Apache-2.0 License. diff --git a/src/l1-resources/private-endpoint-adl/index.ts b/src/l1-resources/private-endpoint-adl/index.ts deleted file mode 100644 index be93c796..00000000 --- a/src/l1-resources/private-endpoint-adl/index.ts +++ /dev/null @@ -1,117 +0,0 @@ -// Generated by cdk-import -import * as cdk from "aws-cdk-lib"; -import * as constructs from "constructs"; - -/** - * Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. To use this resource, the requesting API Key must have the Project Atlas Admin or Project Charts Admin roles. This resource doesn't require the API Key to have an Access List. - * - * @schema CfnPrivateEndpointAdlProps - */ -export interface CfnPrivateEndpointAdlProps { - /** - * Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used - * - * @schema CfnPrivateEndpointAdlProps#Profile - */ - readonly profile?: string; - - /** - * Unique 24-hexadecimal digit string that identifies your project. - * - * @schema CfnPrivateEndpointAdlProps#ProjectId - */ - readonly projectId: string; - - /** - * Human-readable string to associate with this private endpoint. - * - * @schema CfnPrivateEndpointAdlProps#Comment - */ - readonly comment?: string; - - /** - * Unique 22-character alphanumeric string that identifies the private endpoint. - * - * @schema CfnPrivateEndpointAdlProps#EndpointId - */ - readonly endpointId?: string; - - /** - * Human-readable label that identifies the cloud service provider. Atlas Data Lake supports Amazon Web Services only. - * - * @schema CfnPrivateEndpointAdlProps#Provider - */ - readonly provider: string; - - /** - * Human-readable label that identifies the resource type associated with this private endpoint. - * - * @schema CfnPrivateEndpointAdlProps#Type - */ - readonly type?: string; -} - -/** - * Converts an object of type 'CfnPrivateEndpointAdlProps' to JSON representation. - */ -/* eslint-disable max-len, quote-props */ -export function toJson_CfnPrivateEndpointAdlProps( - obj: CfnPrivateEndpointAdlProps | undefined -): Record | undefined { - if (obj === undefined) { - return undefined; - } - const result = { - Profile: obj.profile, - ProjectId: obj.projectId, - Comment: obj.comment, - EndpointId: obj.endpointId, - Provider: obj.provider, - Type: obj.type, - }; - // filter undefined values - return Object.entries(result).reduce( - (r, i) => (i[1] === undefined ? r : { ...r, [i[0]]: i[1] }), - {} - ); -} -/* eslint-enable max-len, quote-props */ - -/** - * A CloudFormation `MongoDB::Atlas::PrivateEndpointADL` - * - * @cloudformationResource MongoDB::Atlas::PrivateEndpointADL - * @stability external - */ -export class CfnPrivateEndpointAdl extends cdk.CfnResource { - /** - * The CloudFormation resource type name for this resource class. - */ - public static readonly CFN_RESOURCE_TYPE_NAME = - "MongoDB::Atlas::PrivateEndpointADL"; - - /** - * Resource props. - */ - public readonly props: CfnPrivateEndpointAdlProps; - - /** - * Create a new `MongoDB::Atlas::PrivateEndpointADL`. - * - * @param scope - scope in which this resource is defined - * @param id - scoped id of the resource - * @param props - resource properties - */ - constructor( - scope: constructs.Construct, - id: string, - props: CfnPrivateEndpointAdlProps - ) { - super(scope, id, { - type: CfnPrivateEndpointAdl.CFN_RESOURCE_TYPE_NAME, - properties: toJson_CfnPrivateEndpointAdlProps(props)!, - }); - - this.props = props; - } -} diff --git a/src/l1-resources/private-endpoint-regional-mode/README.md b/src/l1-resources/private-endpoint-regional-mode/README.md index 6d3c0443..d6fc26a6 100644 --- a/src/l1-resources/private-endpoint-regional-mode/README.md +++ b/src/l1-resources/private-endpoint-regional-mode/README.md @@ -41,7 +41,7 @@ You can find more information about activating this type in the [AWS CloudFormat ```ts import { CfnPrivateEndPointRegionalMode } from 'awscdk-resources-mongodbatlas'; -const myPrivateEndpointAdl = new CfnPrivateEndPointRegionalMode(this, 'MyPrivateEndpointAdl', { +const myPrivateEndpoint = new CfnPrivateEndPointRegionalMode(this, 'MyPrivateEndpoint', { projectId: atlasProps.projId, profile: atlasProps.profile, }); diff --git a/src/l1-resources/privatelink-endpoint-service-data-federation-online-archive/index.ts b/src/l1-resources/privatelink-endpoint-service-data-federation-online-archive/index.ts index f9e76511..a8596139 100644 --- a/src/l1-resources/privatelink-endpoint-service-data-federation-online-archive/index.ts +++ b/src/l1-resources/privatelink-endpoint-service-data-federation-online-archive/index.ts @@ -25,7 +25,7 @@ export interface CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps { /** * Unique 22-character alphanumeric string that identifies the private endpoint.Reg ex ^vpce-[0-9a-f]{17}$ . * - * Atlas Data Lake supports Amazon Web Services private endpoints using the AWS PrivateLink feature. + * Atlas Data Federation supports Amazon Web Services private endpoints using the AWS PrivateLink feature. * * @schema CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps#EndpointId */ diff --git a/src/l3-resources/common/props.ts b/src/l3-resources/common/props.ts index 7984bcb9..ee84417c 100644 --- a/src/l3-resources/common/props.ts +++ b/src/l3-resources/common/props.ts @@ -306,7 +306,7 @@ export interface DatabaseUserProps { */ readonly roles?: atlas.RoleDefinition[]; /** - * @description List that contains clusters and MongoDB Atlas Data Lakes that this database user can access. If omitted, MongoDB Cloud grants the database user access to all the clusters and MongoDB Atlas Data Lakes in the project. + * @description List that contains clusters and MongoDB Atlas Data Federation that this database user can access. If omitted, MongoDB Cloud grants the database user access to all the clusters and MongoDB Atlas Data Federation in the project. * @type {user.ScopeDefinition[]} * @memberof DatabaseUserProps */ diff --git a/test/l1-resources/private-endpoint-adl/README.md b/test/l1-resources/private-endpoint-adl/README.md deleted file mode 100644 index ecf2c73a..00000000 --- a/test/l1-resources/private-endpoint-adl/README.md +++ /dev/null @@ -1,24 +0,0 @@ -# Private Endpoint ADL - -## CFN resource type used -- MongoDB::Atlas::PrivateEndpointADL - -This CFN resource must be active in your AWS account while using this constructor. - -## Manual QA -- Follow prerequisite steps for testing a CDK construct in [TESTING.md](../../../TESTING.md). -- Follow prerequisite steps for the corresponding [PrivateEndpointADL CFN resource](https://github.com/mongodb/mongodbatlas-cloudformation-resources/blob/master/cfn-resources/private-endpoint-adl/test/README.md). -- Set any additional required configuration options/parameters as per your needs. -- Please follow the steps in [TESTING.md](../../../TESTING.md). - - -### Success criteria when testing the resource -1. Private Endpoint should be correctly set up in your Atlas Project as per configuration specified in the inputs/example: - -![image](https://user-images.githubusercontent.com/122359335/227305880-c6c70d20-7f38-4885-a3ed-1de7b4921aa3.png) - -2. Ensure general [CDK resource success criteria](../../../TESTING.md) for this resource is met. - -## Important Links -- [API Documentation](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/group/endpoint-private-endpoint-services) -- [Resource Usage Documentation](https://www.mongodb.com/docs/atlas/security-cluster-private-endpoint/#set-up-a-private-endpoint-for-a-dedicated-cluster) \ No newline at end of file diff --git a/test/l1-resources/private-endpoint-adl/index.test.ts b/test/l1-resources/private-endpoint-adl/index.test.ts deleted file mode 100644 index 05decb48..00000000 --- a/test/l1-resources/private-endpoint-adl/index.test.ts +++ /dev/null @@ -1,38 +0,0 @@ -// Copyright 2023 MongoDB Inc -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -import { App, Stack } from "aws-cdk-lib"; -import { Template } from "aws-cdk-lib/assertions"; -import { CfnPrivateEndpointAdl } from "../../../src"; - -const RESOURCE_NAME = "MongoDB::Atlas::PrivateEndpointADL"; -const PROJECT_ID = "testProjectId"; -const PROVIDER = "AWS"; - -test("CfnPrivateEndpointAdl construct should contain default properties", () => { - const mockApp = new App(); - const stack = new Stack(mockApp); - - new CfnPrivateEndpointAdl(stack, "testing-stack", { - projectId: PROJECT_ID, - provider: PROVIDER, - }); - - const template = Template.fromStack(stack); - - template.hasResourceProperties(RESOURCE_NAME, { - ProjectId: PROJECT_ID, - Provider: PROVIDER, - }); -});