diff --git a/API.md b/API.md index b3320ad9..84452dad 100644 --- a/API.md +++ b/API.md @@ -9476,27 +9476,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnDataLakePipeline +### CfnEncryptionAtRest -A CloudFormation `MongoDB::Atlas::DataLakePipeline`. +A CloudFormation `MongoDB::Atlas::EncryptionAtRest`. -#### Initializers +#### Initializers ```typescript -import { CfnDataLakePipeline } from 'awscdk-resources-mongodbatlas' +import { CfnEncryptionAtRest } from 'awscdk-resources-mongodbatlas' -new CfnDataLakePipeline(scope: Construct, id: string, props: CfnDataLakePipelineProps) +new CfnEncryptionAtRest(scope: Construct, id: string, props: CfnEncryptionAtRestProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnDataLakePipelineProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnEncryptionAtRestProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -9504,7 +9504,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -9512,9 +9512,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnDataLakePipelineProps +- *Type:* CfnEncryptionAtRestProps resource properties. @@ -9524,26 +9524,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -9551,7 +9551,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -9559,7 +9559,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -9567,7 +9567,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -9575,7 +9575,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -9583,7 +9583,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -9594,13 +9594,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -9608,13 +9608,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -9632,19 +9632,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -9694,7 +9694,7 @@ 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 +###### `path`Required - *Type:* string @@ -9705,7 +9705,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -9715,7 +9715,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -9723,7 +9723,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -9731,7 +9731,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -9741,7 +9741,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -9749,7 +9749,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -9757,7 +9757,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -9778,19 +9778,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -9801,7 +9801,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -9809,13 +9809,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -9833,13 +9833,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -9850,7 +9850,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -9858,7 +9858,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -9869,13 +9869,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -9883,7 +9883,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -9891,7 +9891,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -9903,23 +9903,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnDataLakePipeline } from 'awscdk-resources-mongodbatlas' +import { CfnEncryptionAtRest } from 'awscdk-resources-mongodbatlas' -CfnDataLakePipeline.isConstruct(x: any) +CfnEncryptionAtRest.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -9927,12 +9927,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnDataLakePipeline } from 'awscdk-resources-mongodbatlas' +import { CfnEncryptionAtRest } from 'awscdk-resources-mongodbatlas' -CfnDataLakePipeline.isCfnElement(x: any) +CfnEncryptionAtRest.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -9940,23 +9940,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnDataLakePipeline } from 'awscdk-resources-mongodbatlas' +import { CfnEncryptionAtRest } from 'awscdk-resources-mongodbatlas' -CfnDataLakePipeline.isCfnResource(x: any) +CfnEncryptionAtRest.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -9966,21 +9966,19 @@ Check whether the given object is a CfnResource. | **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. | -| attrCreatedDate | string | Attribute `MongoDB::Atlas::DataLakePipeline.CreatedDate`. | -| attrId | string | Attribute `MongoDB::Atlas::DataLakePipeline.Id`. | -| attrLastUpdatedDate | string | Attribute `MongoDB::Atlas::DataLakePipeline.LastUpdatedDate`. | -| props | CfnDataLakePipelineProps | Resource props. | +| 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. | +| attrId | string | Attribute `MongoDB::Atlas::EncryptionAtRest.Id`. | +| props | CfnEncryptionAtRestProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -9992,7 +9990,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -10002,7 +10000,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -10019,7 +10017,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -10033,7 +10031,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -10048,7 +10046,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -10060,7 +10058,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -10072,19 +10070,7 @@ AWS resource type. --- -##### `attrCreatedDate`Required - -```typescript -public readonly attrCreatedDate: string; -``` - -- *Type:* string - -Attribute `MongoDB::Atlas::DataLakePipeline.CreatedDate`. - ---- - -##### `attrId`Required +##### `attrId`Required ```typescript public readonly attrId: string; @@ -10092,29 +10078,17 @@ public readonly attrId: string; - *Type:* string -Attribute `MongoDB::Atlas::DataLakePipeline.Id`. - ---- - -##### `attrLastUpdatedDate`Required - -```typescript -public readonly attrLastUpdatedDate: string; -``` - -- *Type:* string - -Attribute `MongoDB::Atlas::DataLakePipeline.LastUpdatedDate`. +Attribute `MongoDB::Atlas::EncryptionAtRest.Id`. --- -##### `props`Required +##### `props`Required ```typescript -public readonly props: CfnDataLakePipelineProps; +public readonly props: CfnEncryptionAtRestProps; ``` -- *Type:* CfnDataLakePipelineProps +- *Type:* CfnEncryptionAtRestProps Resource props. @@ -10124,11 +10098,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -10140,27 +10114,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnDataLakes +### CfnFederatedDatabaseInstance -A CloudFormation `MongoDB::Atlas::DataLakes`. +A CloudFormation `MongoDB::Atlas::FederatedDatabaseInstance`. -#### Initializers +#### Initializers ```typescript -import { CfnDataLakes } from 'awscdk-resources-mongodbatlas' +import { CfnFederatedDatabaseInstance } from 'awscdk-resources-mongodbatlas' -new CfnDataLakes(scope: Construct, id: string, props: CfnDataLakesProps) +new CfnFederatedDatabaseInstance(scope: Construct, id: string, props: CfnFederatedDatabaseInstanceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnDataLakesProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnFederatedDatabaseInstanceProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -10168,7 +10142,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -10176,9 +10150,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnDataLakesProps +- *Type:* CfnFederatedDatabaseInstanceProps resource properties. @@ -10188,26 +10162,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -10215,7 +10189,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -10223,7 +10197,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -10231,7 +10205,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -10239,7 +10213,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -10247,7 +10221,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -10258,13 +10232,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -10272,13 +10246,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -10296,19 +10270,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -10358,7 +10332,7 @@ 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 +###### `path`Required - *Type:* string @@ -10369,7 +10343,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -10379,7 +10353,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -10387,7 +10361,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -10395,7 +10369,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -10405,7 +10379,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -10413,7 +10387,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -10421,7 +10395,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -10442,19 +10416,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -10465,7 +10439,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -10473,13 +10447,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -10497,13 +10471,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -10514,7 +10488,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -10522,7 +10496,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -10533,13 +10507,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -10547,7 +10521,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -10555,7 +10529,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -10567,23 +10541,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnDataLakes } from 'awscdk-resources-mongodbatlas' +import { CfnFederatedDatabaseInstance } from 'awscdk-resources-mongodbatlas' -CfnDataLakes.isConstruct(x: any) +CfnFederatedDatabaseInstance.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -10591,12 +10565,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnDataLakes } from 'awscdk-resources-mongodbatlas' +import { CfnFederatedDatabaseInstance } from 'awscdk-resources-mongodbatlas' -CfnDataLakes.isCfnElement(x: any) +CfnFederatedDatabaseInstance.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -10604,23 +10578,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnDataLakes } from 'awscdk-resources-mongodbatlas' +import { CfnFederatedDatabaseInstance } from 'awscdk-resources-mongodbatlas' -CfnDataLakes.isCfnResource(x: any) +CfnFederatedDatabaseInstance.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -10630,21 +10604,20 @@ Check whether the given object is a CfnResource. | **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. | -| attrHostnames | string[] | Attribute `MongoDB::Atlas::DataLakes.Hostnames`. | -| attrStartDate | number | Attribute `MongoDB::Atlas::DataLakes.StartDate`. | -| attrState | string | Attribute `MongoDB::Atlas::DataLakes.State`. | -| props | CfnDataLakesProps | Resource props. | +| 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. | +| attrHostNames | string[] | Attribute `MongoDB::Atlas::FederatedDatabaseInstance.HostNames`. | +| attrState | string | Attribute `MongoDB::Atlas::FederatedDatabaseInstance.State`. | +| props | CfnFederatedDatabaseInstanceProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -10656,7 +10629,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -10666,7 +10639,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -10683,7 +10656,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -10697,7 +10670,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -10712,7 +10685,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -10724,7 +10697,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -10736,31 +10709,19 @@ AWS resource type. --- -##### `attrHostnames`Required +##### `attrHostNames`Required ```typescript -public readonly attrHostnames: string[]; +public readonly attrHostNames: string[]; ``` - *Type:* string[] -Attribute `MongoDB::Atlas::DataLakes.Hostnames`. - ---- - -##### `attrStartDate`Required - -```typescript -public readonly attrStartDate: number; -``` - -- *Type:* number - -Attribute `MongoDB::Atlas::DataLakes.StartDate`. +Attribute `MongoDB::Atlas::FederatedDatabaseInstance.HostNames`. --- -##### `attrState`Required +##### `attrState`Required ```typescript public readonly attrState: string; @@ -10768,17 +10729,17 @@ public readonly attrState: string; - *Type:* string -Attribute `MongoDB::Atlas::DataLakes.State`. +Attribute `MongoDB::Atlas::FederatedDatabaseInstance.State`. --- -##### `props`Required +##### `props`Required ```typescript -public readonly props: CfnDataLakesProps; +public readonly props: CfnFederatedDatabaseInstanceProps; ``` -- *Type:* CfnDataLakesProps +- *Type:* CfnFederatedDatabaseInstanceProps Resource props. @@ -10788,11 +10749,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -10804,27 +10765,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnEncryptionAtRest +### CfnFederatedQueryLimit -A CloudFormation `MongoDB::Atlas::EncryptionAtRest`. +A CloudFormation `MongoDB::Atlas::FederatedQueryLimit`. -#### Initializers +#### Initializers ```typescript -import { CfnEncryptionAtRest } from 'awscdk-resources-mongodbatlas' +import { CfnFederatedQueryLimit } from 'awscdk-resources-mongodbatlas' -new CfnEncryptionAtRest(scope: Construct, id: string, props: CfnEncryptionAtRestProps) +new CfnFederatedQueryLimit(scope: Construct, id: string, props: CfnFederatedQueryLimitProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnEncryptionAtRestProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnFederatedQueryLimitProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -10832,7 +10793,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -10840,9 +10801,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnEncryptionAtRestProps +- *Type:* CfnFederatedQueryLimitProps resource properties. @@ -10852,26 +10813,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -10879,7 +10840,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -10887,7 +10848,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -10895,7 +10856,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -10903,7 +10864,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -10911,7 +10872,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -10922,13 +10883,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -10936,13 +10897,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -10960,19 +10921,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -11022,7 +10983,7 @@ 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 +###### `path`Required - *Type:* string @@ -11033,7 +10994,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -11043,7 +11004,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -11051,7 +11012,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -11059,7 +11020,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -11069,7 +11030,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -11077,7 +11038,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -11085,7 +11046,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -11106,19 +11067,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -11129,7 +11090,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -11137,13 +11098,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -11161,13 +11122,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -11178,7 +11139,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -11186,7 +11147,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -11197,13 +11158,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -11211,7 +11172,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -11219,7 +11180,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -11231,23 +11192,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnEncryptionAtRest } from 'awscdk-resources-mongodbatlas' +import { CfnFederatedQueryLimit } from 'awscdk-resources-mongodbatlas' -CfnEncryptionAtRest.isConstruct(x: any) +CfnFederatedQueryLimit.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -11255,12 +11216,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnEncryptionAtRest } from 'awscdk-resources-mongodbatlas' +import { CfnFederatedQueryLimit } from 'awscdk-resources-mongodbatlas' -CfnEncryptionAtRest.isCfnElement(x: any) +CfnFederatedQueryLimit.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -11268,23 +11229,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnEncryptionAtRest } from 'awscdk-resources-mongodbatlas' +import { CfnFederatedQueryLimit } from 'awscdk-resources-mongodbatlas' -CfnEncryptionAtRest.isCfnResource(x: any) +CfnFederatedQueryLimit.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -11294,19 +11255,22 @@ Check whether the given object is a CfnResource. | **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. | -| attrId | string | Attribute `MongoDB::Atlas::EncryptionAtRest.Id`. | -| props | CfnEncryptionAtRestProps | Resource props. | +| 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. | +| attrCurrentUsage | string | Attribute `MongoDB::Atlas::FederatedQueryLimit.CurrentUsage`. | +| attrDefaultLimit | string | Attribute `MongoDB::Atlas::FederatedQueryLimit.DefaultLimit`. | +| attrLastModifiedDate | string | Attribute `MongoDB::Atlas::FederatedQueryLimit.LastModifiedDate`. | +| attrMaximumLimit | string | Attribute `MongoDB::Atlas::FederatedQueryLimit.MaximumLimit`. | +| props | CfnFederatedQueryLimitProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -11318,7 +11282,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -11328,7 +11292,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -11345,7 +11309,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -11359,7 +11323,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -11374,7 +11338,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -11386,7 +11350,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -11398,25 +11362,61 @@ AWS resource type. --- -##### `attrId`Required +##### `attrCurrentUsage`Required ```typescript -public readonly attrId: string; +public readonly attrCurrentUsage: string; ``` - *Type:* string -Attribute `MongoDB::Atlas::EncryptionAtRest.Id`. +Attribute `MongoDB::Atlas::FederatedQueryLimit.CurrentUsage`. --- -##### `props`Required +##### `attrDefaultLimit`Required ```typescript -public readonly props: CfnEncryptionAtRestProps; +public readonly attrDefaultLimit: string; ``` -- *Type:* CfnEncryptionAtRestProps +- *Type:* string + +Attribute `MongoDB::Atlas::FederatedQueryLimit.DefaultLimit`. + +--- + +##### `attrLastModifiedDate`Required + +```typescript +public readonly attrLastModifiedDate: string; +``` + +- *Type:* string + +Attribute `MongoDB::Atlas::FederatedQueryLimit.LastModifiedDate`. + +--- + +##### `attrMaximumLimit`Required + +```typescript +public readonly attrMaximumLimit: string; +``` + +- *Type:* string + +Attribute `MongoDB::Atlas::FederatedQueryLimit.MaximumLimit`. + +--- + +##### `props`Required + +```typescript +public readonly props: CfnFederatedQueryLimitProps; +``` + +- *Type:* CfnFederatedQueryLimitProps Resource props. @@ -11426,11 +11426,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -11442,27 +11442,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnFederatedDatabaseInstance +### CfnFederatedSettingsOrgRoleMapping -A CloudFormation `MongoDB::Atlas::FederatedDatabaseInstance`. +A CloudFormation `MongoDB::Atlas::FederatedSettingsOrgRoleMapping`. -#### Initializers +#### Initializers ```typescript -import { CfnFederatedDatabaseInstance } from 'awscdk-resources-mongodbatlas' +import { CfnFederatedSettingsOrgRoleMapping } from 'awscdk-resources-mongodbatlas' -new CfnFederatedDatabaseInstance(scope: Construct, id: string, props: CfnFederatedDatabaseInstanceProps) +new CfnFederatedSettingsOrgRoleMapping(scope: Construct, id: string, props: CfnFederatedSettingsOrgRoleMappingProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnFederatedDatabaseInstanceProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnFederatedSettingsOrgRoleMappingProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -11470,7 +11470,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -11478,9 +11478,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnFederatedDatabaseInstanceProps +- *Type:* CfnFederatedSettingsOrgRoleMappingProps resource properties. @@ -11490,26 +11490,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -11517,7 +11517,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -11525,7 +11525,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -11533,7 +11533,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -11541,7 +11541,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -11549,7 +11549,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -11560,13 +11560,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -11574,13 +11574,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -11598,19 +11598,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -11660,7 +11660,7 @@ 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 +###### `path`Required - *Type:* string @@ -11671,7 +11671,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -11681,7 +11681,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -11689,7 +11689,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -11697,7 +11697,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -11707,7 +11707,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -11715,7 +11715,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -11723,7 +11723,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -11744,19 +11744,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -11767,7 +11767,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -11775,13 +11775,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -11799,13 +11799,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -11816,7 +11816,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -11824,7 +11824,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -11835,13 +11835,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -11849,7 +11849,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -11857,7 +11857,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -11869,23 +11869,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnFederatedDatabaseInstance } from 'awscdk-resources-mongodbatlas' +import { CfnFederatedSettingsOrgRoleMapping } from 'awscdk-resources-mongodbatlas' -CfnFederatedDatabaseInstance.isConstruct(x: any) +CfnFederatedSettingsOrgRoleMapping.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -11893,12 +11893,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnFederatedDatabaseInstance } from 'awscdk-resources-mongodbatlas' +import { CfnFederatedSettingsOrgRoleMapping } from 'awscdk-resources-mongodbatlas' -CfnFederatedDatabaseInstance.isCfnElement(x: any) +CfnFederatedSettingsOrgRoleMapping.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -11906,23 +11906,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnFederatedDatabaseInstance } from 'awscdk-resources-mongodbatlas' +import { CfnFederatedSettingsOrgRoleMapping } from 'awscdk-resources-mongodbatlas' -CfnFederatedDatabaseInstance.isCfnResource(x: any) +CfnFederatedSettingsOrgRoleMapping.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -11932,20 +11932,19 @@ Check whether the given object is a CfnResource. | **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. | -| attrHostNames | string[] | Attribute `MongoDB::Atlas::FederatedDatabaseInstance.HostNames`. | -| attrState | string | Attribute `MongoDB::Atlas::FederatedDatabaseInstance.State`. | -| props | CfnFederatedDatabaseInstanceProps | Resource props. | +| 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. | +| attrId | string | Attribute `MongoDB::Atlas::FederatedSettingsOrgRoleMapping.Id`. | +| props | CfnFederatedSettingsOrgRoleMappingProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -11957,7 +11956,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -11967,7 +11966,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -11984,7 +11983,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -11998,7 +11997,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -12013,7 +12012,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -12025,7 +12024,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -12037,37 +12036,25 @@ AWS resource type. --- -##### `attrHostNames`Required - -```typescript -public readonly attrHostNames: string[]; -``` - -- *Type:* string[] - -Attribute `MongoDB::Atlas::FederatedDatabaseInstance.HostNames`. - ---- - -##### `attrState`Required +##### `attrId`Required ```typescript -public readonly attrState: string; +public readonly attrId: string; ``` - *Type:* string -Attribute `MongoDB::Atlas::FederatedDatabaseInstance.State`. +Attribute `MongoDB::Atlas::FederatedSettingsOrgRoleMapping.Id`. --- -##### `props`Required +##### `props`Required ```typescript -public readonly props: CfnFederatedDatabaseInstanceProps; +public readonly props: CfnFederatedSettingsOrgRoleMappingProps; ``` -- *Type:* CfnFederatedDatabaseInstanceProps +- *Type:* CfnFederatedSettingsOrgRoleMappingProps Resource props. @@ -12077,11 +12064,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -12093,27 +12080,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnFederatedQueryLimit +### CfnFlexCluster -A CloudFormation `MongoDB::Atlas::FederatedQueryLimit`. +A CloudFormation `MongoDB::Atlas::FlexCluster`. -#### Initializers +#### Initializers ```typescript -import { CfnFederatedQueryLimit } from 'awscdk-resources-mongodbatlas' +import { CfnFlexCluster } from 'awscdk-resources-mongodbatlas' -new CfnFederatedQueryLimit(scope: Construct, id: string, props: CfnFederatedQueryLimitProps) +new CfnFlexCluster(scope: Construct, id: string, props: CfnFlexClusterProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnFederatedQueryLimitProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnFlexClusterProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -12121,7 +12108,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -12129,9 +12116,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnFederatedQueryLimitProps +- *Type:* CfnFlexClusterProps resource properties. @@ -12141,26 +12128,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -12168,7 +12155,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -12176,7 +12163,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -12184,7 +12171,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -12192,7 +12179,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -12200,7 +12187,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -12211,13 +12198,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -12225,13 +12212,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -12249,19 +12236,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -12311,7 +12298,7 @@ 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 +###### `path`Required - *Type:* string @@ -12322,7 +12309,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -12332,7 +12319,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -12340,7 +12327,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -12348,7 +12335,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -12358,7 +12345,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -12366,7 +12353,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -12374,7 +12361,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -12395,19 +12382,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -12418,7 +12405,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -12426,13 +12413,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -12450,13 +12437,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -12467,7 +12454,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -12475,7 +12462,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -12486,13 +12473,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -12500,7 +12487,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -12508,7 +12495,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -12520,23 +12507,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnFederatedQueryLimit } from 'awscdk-resources-mongodbatlas' +import { CfnFlexCluster } from 'awscdk-resources-mongodbatlas' -CfnFederatedQueryLimit.isConstruct(x: any) +CfnFlexCluster.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -12544,12 +12531,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnFederatedQueryLimit } from 'awscdk-resources-mongodbatlas' +import { CfnFlexCluster } from 'awscdk-resources-mongodbatlas' -CfnFederatedQueryLimit.isCfnElement(x: any) +CfnFlexCluster.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -12557,23 +12544,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnFederatedQueryLimit } from 'awscdk-resources-mongodbatlas' +import { CfnFlexCluster } from 'awscdk-resources-mongodbatlas' -CfnFederatedQueryLimit.isCfnResource(x: any) +CfnFlexCluster.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -12583,22 +12570,24 @@ Check whether the given object is a CfnResource. | **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. | -| attrCurrentUsage | string | Attribute `MongoDB::Atlas::FederatedQueryLimit.CurrentUsage`. | -| attrDefaultLimit | string | Attribute `MongoDB::Atlas::FederatedQueryLimit.DefaultLimit`. | -| attrLastModifiedDate | string | Attribute `MongoDB::Atlas::FederatedQueryLimit.LastModifiedDate`. | -| attrMaximumLimit | string | Attribute `MongoDB::Atlas::FederatedQueryLimit.MaximumLimit`. | -| props | CfnFederatedQueryLimitProps | Resource props. | +| 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. | +| attrClusterType | string | Attribute `MongoDB::Atlas::FlexCluster.ClusterType`. | +| attrCreateDate | string | Attribute `MongoDB::Atlas::FlexCluster.CreateDate`. | +| attrId | string | Attribute `MongoDB::Atlas::FlexCluster.Id`. | +| attrMongoDBVersion | string | Attribute `MongoDB::Atlas::FlexCluster.MongoDBVersion`. | +| attrStateName | string | Attribute `MongoDB::Atlas::FlexCluster.StateName`. | +| attrVersionReleaseSystem | string | Attribute `MongoDB::Atlas::FlexCluster.VersionReleaseSystem`. | +| props | CfnFlexClusterProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -12610,7 +12599,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -12620,7 +12609,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -12637,7 +12626,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -12651,7 +12640,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -12666,7 +12655,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -12678,7 +12667,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -12690,61 +12679,85 @@ AWS resource type. --- -##### `attrCurrentUsage`Required +##### `attrClusterType`Required ```typescript -public readonly attrCurrentUsage: string; +public readonly attrClusterType: string; ``` - *Type:* string -Attribute `MongoDB::Atlas::FederatedQueryLimit.CurrentUsage`. +Attribute `MongoDB::Atlas::FlexCluster.ClusterType`. --- -##### `attrDefaultLimit`Required +##### `attrCreateDate`Required ```typescript -public readonly attrDefaultLimit: string; +public readonly attrCreateDate: string; ``` - *Type:* string -Attribute `MongoDB::Atlas::FederatedQueryLimit.DefaultLimit`. +Attribute `MongoDB::Atlas::FlexCluster.CreateDate`. --- -##### `attrLastModifiedDate`Required +##### `attrId`Required ```typescript -public readonly attrLastModifiedDate: string; +public readonly attrId: string; ``` - *Type:* string -Attribute `MongoDB::Atlas::FederatedQueryLimit.LastModifiedDate`. +Attribute `MongoDB::Atlas::FlexCluster.Id`. --- -##### `attrMaximumLimit`Required +##### `attrMongoDBVersion`Required ```typescript -public readonly attrMaximumLimit: string; +public readonly attrMongoDBVersion: string; ``` - *Type:* string -Attribute `MongoDB::Atlas::FederatedQueryLimit.MaximumLimit`. +Attribute `MongoDB::Atlas::FlexCluster.MongoDBVersion`. --- -##### `props`Required +##### `attrStateName`Required ```typescript -public readonly props: CfnFederatedQueryLimitProps; +public readonly attrStateName: string; ``` -- *Type:* CfnFederatedQueryLimitProps +- *Type:* string + +Attribute `MongoDB::Atlas::FlexCluster.StateName`. + +--- + +##### `attrVersionReleaseSystem`Required + +```typescript +public readonly attrVersionReleaseSystem: string; +``` + +- *Type:* string + +Attribute `MongoDB::Atlas::FlexCluster.VersionReleaseSystem`. + +--- + +##### `props`Required + +```typescript +public readonly props: CfnFlexClusterProps; +``` + +- *Type:* CfnFlexClusterProps Resource props. @@ -12754,11 +12767,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -12770,27 +12783,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnFederatedSettingsOrgRoleMapping +### CfnGlobalClusterConfig -A CloudFormation `MongoDB::Atlas::FederatedSettingsOrgRoleMapping`. +A CloudFormation `MongoDB::Atlas::GlobalClusterConfig`. -#### Initializers +#### Initializers ```typescript -import { CfnFederatedSettingsOrgRoleMapping } from 'awscdk-resources-mongodbatlas' +import { CfnGlobalClusterConfig } from 'awscdk-resources-mongodbatlas' -new CfnFederatedSettingsOrgRoleMapping(scope: Construct, id: string, props: CfnFederatedSettingsOrgRoleMappingProps) +new CfnGlobalClusterConfig(scope: Construct, id: string, props: CfnGlobalClusterConfigProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnFederatedSettingsOrgRoleMappingProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnGlobalClusterConfigProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -12798,7 +12811,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -12806,9 +12819,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnFederatedSettingsOrgRoleMappingProps +- *Type:* CfnGlobalClusterConfigProps resource properties. @@ -12818,26 +12831,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -12845,7 +12858,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -12853,7 +12866,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -12861,7 +12874,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -12869,7 +12882,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -12877,7 +12890,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -12888,13 +12901,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -12902,13 +12915,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -12926,19 +12939,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -12988,7 +13001,7 @@ 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 +###### `path`Required - *Type:* string @@ -12999,7 +13012,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -13009,7 +13022,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -13017,7 +13030,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -13025,7 +13038,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -13035,7 +13048,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -13043,7 +13056,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -13051,7 +13064,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -13072,19 +13085,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -13095,7 +13108,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -13103,13 +13116,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -13127,13 +13140,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -13144,7 +13157,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -13152,7 +13165,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -13163,13 +13176,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -13177,7 +13190,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -13185,7 +13198,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -13197,23 +13210,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnFederatedSettingsOrgRoleMapping } from 'awscdk-resources-mongodbatlas' +import { CfnGlobalClusterConfig } from 'awscdk-resources-mongodbatlas' -CfnFederatedSettingsOrgRoleMapping.isConstruct(x: any) +CfnGlobalClusterConfig.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -13221,12 +13234,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnFederatedSettingsOrgRoleMapping } from 'awscdk-resources-mongodbatlas' +import { CfnGlobalClusterConfig } from 'awscdk-resources-mongodbatlas' -CfnFederatedSettingsOrgRoleMapping.isCfnElement(x: any) +CfnGlobalClusterConfig.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -13234,23 +13247,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnFederatedSettingsOrgRoleMapping } from 'awscdk-resources-mongodbatlas' +import { CfnGlobalClusterConfig } from 'awscdk-resources-mongodbatlas' -CfnFederatedSettingsOrgRoleMapping.isCfnResource(x: any) +CfnGlobalClusterConfig.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -13260,19 +13273,19 @@ Check whether the given object is a CfnResource. | **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. | -| attrId | string | Attribute `MongoDB::Atlas::FederatedSettingsOrgRoleMapping.Id`. | -| props | CfnFederatedSettingsOrgRoleMappingProps | Resource props. | +| 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. | +| attrRemoveAllZoneMapping | aws-cdk-lib.IResolvable | Attribute `MongoDB::Atlas::GlobalClusterConfig.RemoveAllZoneMapping`. | +| props | CfnGlobalClusterConfigProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -13284,7 +13297,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -13294,7 +13307,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -13311,7 +13324,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -13325,7 +13338,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -13340,7 +13353,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -13352,7 +13365,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -13364,25 +13377,25 @@ AWS resource type. --- -##### `attrId`Required +##### `attrRemoveAllZoneMapping`Required ```typescript -public readonly attrId: string; +public readonly attrRemoveAllZoneMapping: IResolvable; ``` -- *Type:* string +- *Type:* aws-cdk-lib.IResolvable -Attribute `MongoDB::Atlas::FederatedSettingsOrgRoleMapping.Id`. +Attribute `MongoDB::Atlas::GlobalClusterConfig.RemoveAllZoneMapping`. --- -##### `props`Required +##### `props`Required ```typescript -public readonly props: CfnFederatedSettingsOrgRoleMappingProps; +public readonly props: CfnGlobalClusterConfigProps; ``` -- *Type:* CfnFederatedSettingsOrgRoleMappingProps +- *Type:* CfnGlobalClusterConfigProps Resource props. @@ -13392,11 +13405,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -13408,27 +13421,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnFlexCluster +### CfnLdapConfiguration -A CloudFormation `MongoDB::Atlas::FlexCluster`. +A CloudFormation `MongoDB::Atlas::LDAPConfiguration`. -#### Initializers +#### Initializers ```typescript -import { CfnFlexCluster } from 'awscdk-resources-mongodbatlas' +import { CfnLdapConfiguration } from 'awscdk-resources-mongodbatlas' -new CfnFlexCluster(scope: Construct, id: string, props: CfnFlexClusterProps) +new CfnLdapConfiguration(scope: Construct, id: string, props: CfnLdapConfigurationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnFlexClusterProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnLdapConfigurationProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -13436,7 +13449,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -13444,9 +13457,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnFlexClusterProps +- *Type:* CfnLdapConfigurationProps resource properties. @@ -13456,26 +13469,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -13483,7 +13496,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -13491,7 +13504,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -13499,7 +13512,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -13507,7 +13520,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -13515,7 +13528,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -13526,13 +13539,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -13540,13 +13553,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -13564,19 +13577,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -13626,7 +13639,7 @@ 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 +###### `path`Required - *Type:* string @@ -13637,7 +13650,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -13647,7 +13660,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -13655,7 +13668,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -13663,7 +13676,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -13673,7 +13686,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -13681,7 +13694,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -13689,7 +13702,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -13710,19 +13723,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -13733,7 +13746,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -13741,13 +13754,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -13765,13 +13778,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -13782,7 +13795,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -13790,7 +13803,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -13801,13 +13814,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -13815,7 +13828,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -13823,7 +13836,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -13835,23 +13848,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnFlexCluster } from 'awscdk-resources-mongodbatlas' +import { CfnLdapConfiguration } from 'awscdk-resources-mongodbatlas' -CfnFlexCluster.isConstruct(x: any) +CfnLdapConfiguration.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -13859,12 +13872,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnFlexCluster } from 'awscdk-resources-mongodbatlas' +import { CfnLdapConfiguration } from 'awscdk-resources-mongodbatlas' -CfnFlexCluster.isCfnElement(x: any) +CfnLdapConfiguration.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -13872,23 +13885,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnFlexCluster } from 'awscdk-resources-mongodbatlas' +import { CfnLdapConfiguration } from 'awscdk-resources-mongodbatlas' -CfnFlexCluster.isCfnResource(x: any) +CfnLdapConfiguration.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -13898,24 +13911,18 @@ Check whether the given object is a CfnResource. | **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. | -| attrClusterType | string | Attribute `MongoDB::Atlas::FlexCluster.ClusterType`. | -| attrCreateDate | string | Attribute `MongoDB::Atlas::FlexCluster.CreateDate`. | -| attrId | string | Attribute `MongoDB::Atlas::FlexCluster.Id`. | -| attrMongoDBVersion | string | Attribute `MongoDB::Atlas::FlexCluster.MongoDBVersion`. | -| attrStateName | string | Attribute `MongoDB::Atlas::FlexCluster.StateName`. | -| attrVersionReleaseSystem | string | Attribute `MongoDB::Atlas::FlexCluster.VersionReleaseSystem`. | -| props | CfnFlexClusterProps | Resource props. | +| 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 | CfnLdapConfigurationProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -13927,7 +13934,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -13937,7 +13944,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -13954,7 +13961,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -13968,7 +13975,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -13983,7 +13990,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -13995,7 +14002,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -14007,85 +14014,13 @@ AWS resource type. --- -##### `attrClusterType`Required - -```typescript -public readonly attrClusterType: string; -``` - -- *Type:* string - -Attribute `MongoDB::Atlas::FlexCluster.ClusterType`. - ---- - -##### `attrCreateDate`Required - -```typescript -public readonly attrCreateDate: string; -``` - -- *Type:* string - -Attribute `MongoDB::Atlas::FlexCluster.CreateDate`. - ---- - -##### `attrId`Required - -```typescript -public readonly attrId: string; -``` - -- *Type:* string - -Attribute `MongoDB::Atlas::FlexCluster.Id`. - ---- - -##### `attrMongoDBVersion`Required - -```typescript -public readonly attrMongoDBVersion: string; -``` - -- *Type:* string - -Attribute `MongoDB::Atlas::FlexCluster.MongoDBVersion`. - ---- - -##### `attrStateName`Required - -```typescript -public readonly attrStateName: string; -``` - -- *Type:* string - -Attribute `MongoDB::Atlas::FlexCluster.StateName`. - ---- - -##### `attrVersionReleaseSystem`Required - -```typescript -public readonly attrVersionReleaseSystem: string; -``` - -- *Type:* string - -Attribute `MongoDB::Atlas::FlexCluster.VersionReleaseSystem`. - ---- - -##### `props`Required +##### `props`Required ```typescript -public readonly props: CfnFlexClusterProps; +public readonly props: CfnLdapConfigurationProps; ``` -- *Type:* CfnFlexClusterProps +- *Type:* CfnLdapConfigurationProps Resource props. @@ -14095,11 +14030,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -14111,27 +14046,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnGlobalClusterConfig +### CfnLdapVerify -A CloudFormation `MongoDB::Atlas::GlobalClusterConfig`. +A CloudFormation `MongoDB::Atlas::LDAPVerify`. -#### Initializers +#### Initializers ```typescript -import { CfnGlobalClusterConfig } from 'awscdk-resources-mongodbatlas' +import { CfnLdapVerify } from 'awscdk-resources-mongodbatlas' -new CfnGlobalClusterConfig(scope: Construct, id: string, props: CfnGlobalClusterConfigProps) +new CfnLdapVerify(scope: Construct, id: string, props: CfnLdapVerifyProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnGlobalClusterConfigProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnLdapVerifyProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -14139,7 +14074,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -14147,9 +14082,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnGlobalClusterConfigProps +- *Type:* CfnLdapVerifyProps resource properties. @@ -14159,26 +14094,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -14186,7 +14121,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -14194,7 +14129,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -14202,7 +14137,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -14210,7 +14145,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -14218,7 +14153,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -14229,13 +14164,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -14243,13 +14178,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -14267,19 +14202,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -14329,7 +14264,7 @@ 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 +###### `path`Required - *Type:* string @@ -14340,7 +14275,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -14350,7 +14285,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -14358,7 +14293,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -14366,7 +14301,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -14376,7 +14311,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -14384,7 +14319,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -14392,7 +14327,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -14413,19 +14348,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -14436,7 +14371,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -14444,13 +14379,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -14468,13 +14403,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -14485,7 +14420,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -14493,7 +14428,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -14504,13 +14439,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -14518,7 +14453,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -14526,7 +14461,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -14538,23 +14473,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnGlobalClusterConfig } from 'awscdk-resources-mongodbatlas' +import { CfnLdapVerify } from 'awscdk-resources-mongodbatlas' -CfnGlobalClusterConfig.isConstruct(x: any) +CfnLdapVerify.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -14562,12 +14497,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnGlobalClusterConfig } from 'awscdk-resources-mongodbatlas' +import { CfnLdapVerify } from 'awscdk-resources-mongodbatlas' -CfnGlobalClusterConfig.isCfnElement(x: any) +CfnLdapVerify.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -14575,23 +14510,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnGlobalClusterConfig } from 'awscdk-resources-mongodbatlas' +import { CfnLdapVerify } from 'awscdk-resources-mongodbatlas' -CfnGlobalClusterConfig.isCfnResource(x: any) +CfnLdapVerify.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -14601,19 +14536,20 @@ Check whether the given object is a CfnResource. | **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. | -| attrRemoveAllZoneMapping | aws-cdk-lib.IResolvable | Attribute `MongoDB::Atlas::GlobalClusterConfig.RemoveAllZoneMapping`. | -| props | CfnGlobalClusterConfigProps | Resource props. | +| 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. | +| attrRequestId | string | Attribute `MongoDB::Atlas::LDAPVerify.RequestId`. | +| attrStatus | string | Attribute `MongoDB::Atlas::LDAPVerify.Status`. | +| props | CfnLdapVerifyProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -14625,7 +14561,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -14635,7 +14571,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -14652,7 +14588,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -14666,7 +14602,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -14681,7 +14617,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -14693,7 +14629,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -14705,25 +14641,37 @@ AWS resource type. --- -##### `attrRemoveAllZoneMapping`Required +##### `attrRequestId`Required ```typescript -public readonly attrRemoveAllZoneMapping: IResolvable; +public readonly attrRequestId: string; ``` -- *Type:* aws-cdk-lib.IResolvable +- *Type:* string -Attribute `MongoDB::Atlas::GlobalClusterConfig.RemoveAllZoneMapping`. +Attribute `MongoDB::Atlas::LDAPVerify.RequestId`. --- -##### `props`Required +##### `attrStatus`Required ```typescript -public readonly props: CfnGlobalClusterConfigProps; +public readonly attrStatus: string; ``` -- *Type:* CfnGlobalClusterConfigProps +- *Type:* string + +Attribute `MongoDB::Atlas::LDAPVerify.Status`. + +--- + +##### `props`Required + +```typescript +public readonly props: CfnLdapVerifyProps; +``` + +- *Type:* CfnLdapVerifyProps Resource props. @@ -14733,11 +14681,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -14749,27 +14697,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnLdapConfiguration +### CfnMaintenanceWindow -A CloudFormation `MongoDB::Atlas::LDAPConfiguration`. +A CloudFormation `MongoDB::Atlas::MaintenanceWindow`. -#### Initializers +#### Initializers ```typescript -import { CfnLdapConfiguration } from 'awscdk-resources-mongodbatlas' +import { CfnMaintenanceWindow } from 'awscdk-resources-mongodbatlas' -new CfnLdapConfiguration(scope: Construct, id: string, props: CfnLdapConfigurationProps) +new CfnMaintenanceWindow(scope: Construct, id: string, props: CfnMaintenanceWindowProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnLdapConfigurationProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnMaintenanceWindowProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -14777,7 +14725,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -14785,9 +14733,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnLdapConfigurationProps +- *Type:* CfnMaintenanceWindowProps resource properties. @@ -14797,26 +14745,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -14824,7 +14772,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -14832,7 +14780,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -14840,7 +14788,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -14848,7 +14796,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -14856,7 +14804,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -14867,13 +14815,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -14881,13 +14829,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -14905,19 +14853,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -14967,7 +14915,7 @@ 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 +###### `path`Required - *Type:* string @@ -14978,7 +14926,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -14988,7 +14936,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -14996,7 +14944,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -15004,7 +14952,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -15014,7 +14962,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -15022,7 +14970,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -15030,7 +14978,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -15051,19 +14999,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -15074,7 +15022,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -15082,13 +15030,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -15106,13 +15054,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -15123,7 +15071,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -15131,7 +15079,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -15142,13 +15090,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -15156,7 +15104,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -15164,7 +15112,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -15176,23 +15124,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnLdapConfiguration } from 'awscdk-resources-mongodbatlas' +import { CfnMaintenanceWindow } from 'awscdk-resources-mongodbatlas' -CfnLdapConfiguration.isConstruct(x: any) +CfnMaintenanceWindow.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -15200,12 +15148,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnLdapConfiguration } from 'awscdk-resources-mongodbatlas' +import { CfnMaintenanceWindow } from 'awscdk-resources-mongodbatlas' -CfnLdapConfiguration.isCfnElement(x: any) +CfnMaintenanceWindow.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -15213,23 +15161,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnLdapConfiguration } from 'awscdk-resources-mongodbatlas' +import { CfnMaintenanceWindow } from 'awscdk-resources-mongodbatlas' -CfnLdapConfiguration.isCfnResource(x: any) +CfnMaintenanceWindow.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -15239,18 +15187,18 @@ Check whether the given object is a CfnResource. | **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 | CfnLdapConfigurationProps | Resource props. | +| 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 | CfnMaintenanceWindowProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -15262,7 +15210,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -15272,7 +15220,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -15289,7 +15237,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -15303,7 +15251,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -15318,7 +15266,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -15330,7 +15278,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -15342,13 +15290,13 @@ AWS resource type. --- -##### `props`Required +##### `props`Required ```typescript -public readonly props: CfnLdapConfigurationProps; +public readonly props: CfnMaintenanceWindowProps; ``` -- *Type:* CfnLdapConfigurationProps +- *Type:* CfnMaintenanceWindowProps Resource props. @@ -15358,11 +15306,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -15374,27 +15322,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnLdapVerify +### CfnNetworkContainer -A CloudFormation `MongoDB::Atlas::LDAPVerify`. +A CloudFormation `MongoDB::Atlas::NetworkContainer`. -#### Initializers +#### Initializers ```typescript -import { CfnLdapVerify } from 'awscdk-resources-mongodbatlas' +import { CfnNetworkContainer } from 'awscdk-resources-mongodbatlas' -new CfnLdapVerify(scope: Construct, id: string, props: CfnLdapVerifyProps) +new CfnNetworkContainer(scope: Construct, id: string, props: CfnNetworkContainerProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnLdapVerifyProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnNetworkContainerProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -15402,7 +15350,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -15410,9 +15358,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnLdapVerifyProps +- *Type:* CfnNetworkContainerProps resource properties. @@ -15422,26 +15370,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -15449,7 +15397,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -15457,7 +15405,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -15465,7 +15413,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -15473,7 +15421,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -15481,7 +15429,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -15492,13 +15440,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -15506,13 +15454,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -15530,19 +15478,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -15592,7 +15540,7 @@ 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 +###### `path`Required - *Type:* string @@ -15603,7 +15551,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -15613,7 +15561,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -15621,7 +15569,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -15629,7 +15577,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -15639,7 +15587,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -15647,7 +15595,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -15655,7 +15603,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -15676,19 +15624,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -15699,7 +15647,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -15707,13 +15655,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -15731,13 +15679,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -15748,7 +15696,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -15756,7 +15704,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -15767,13 +15715,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -15781,7 +15729,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -15789,7 +15737,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -15801,23 +15749,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnLdapVerify } from 'awscdk-resources-mongodbatlas' +import { CfnNetworkContainer } from 'awscdk-resources-mongodbatlas' -CfnLdapVerify.isConstruct(x: any) +CfnNetworkContainer.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -15825,12 +15773,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnLdapVerify } from 'awscdk-resources-mongodbatlas' +import { CfnNetworkContainer } from 'awscdk-resources-mongodbatlas' -CfnLdapVerify.isCfnElement(x: any) +CfnNetworkContainer.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -15838,23 +15786,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnLdapVerify } from 'awscdk-resources-mongodbatlas' +import { CfnNetworkContainer } from 'awscdk-resources-mongodbatlas' -CfnLdapVerify.isCfnResource(x: any) +CfnNetworkContainer.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -15864,20 +15812,19 @@ Check whether the given object is a CfnResource. | **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. | -| attrRequestId | string | Attribute `MongoDB::Atlas::LDAPVerify.RequestId`. | -| attrStatus | string | Attribute `MongoDB::Atlas::LDAPVerify.Status`. | -| props | CfnLdapVerifyProps | Resource props. | +| 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. | +| attrId | string | Attribute `MongoDB::Atlas::NetworkContainer.Id`. | +| props | CfnNetworkContainerProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -15889,7 +15836,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -15899,7 +15846,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -15916,7 +15863,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -15930,7 +15877,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -15945,7 +15892,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -15957,7 +15904,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -15969,37 +15916,25 @@ AWS resource type. --- -##### `attrRequestId`Required - -```typescript -public readonly attrRequestId: string; -``` - -- *Type:* string - -Attribute `MongoDB::Atlas::LDAPVerify.RequestId`. - ---- - -##### `attrStatus`Required +##### `attrId`Required ```typescript -public readonly attrStatus: string; +public readonly attrId: string; ``` - *Type:* string -Attribute `MongoDB::Atlas::LDAPVerify.Status`. +Attribute `MongoDB::Atlas::NetworkContainer.Id`. --- -##### `props`Required +##### `props`Required ```typescript -public readonly props: CfnLdapVerifyProps; +public readonly props: CfnNetworkContainerProps; ``` -- *Type:* CfnLdapVerifyProps +- *Type:* CfnNetworkContainerProps Resource props. @@ -16009,11 +15944,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -16025,27 +15960,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnMaintenanceWindow +### CfnNetworkPeering -A CloudFormation `MongoDB::Atlas::MaintenanceWindow`. +A CloudFormation `MongoDB::Atlas::NetworkPeering`. -#### Initializers +#### Initializers ```typescript -import { CfnMaintenanceWindow } from 'awscdk-resources-mongodbatlas' +import { CfnNetworkPeering } from 'awscdk-resources-mongodbatlas' -new CfnMaintenanceWindow(scope: Construct, id: string, props: CfnMaintenanceWindowProps) +new CfnNetworkPeering(scope: Construct, id: string, props: CfnNetworkPeeringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnMaintenanceWindowProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnNetworkPeeringProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -16053,7 +15988,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -16061,9 +15996,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnMaintenanceWindowProps +- *Type:* CfnNetworkPeeringProps resource properties. @@ -16073,26 +16008,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -16100,7 +16035,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -16108,7 +16043,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -16116,7 +16051,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -16124,7 +16059,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -16132,7 +16067,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -16143,13 +16078,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -16157,13 +16092,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -16181,19 +16116,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -16243,7 +16178,7 @@ 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 +###### `path`Required - *Type:* string @@ -16254,7 +16189,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -16264,7 +16199,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -16272,7 +16207,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -16280,7 +16215,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -16290,7 +16225,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -16298,7 +16233,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -16306,7 +16241,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -16327,19 +16262,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -16350,7 +16285,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -16358,13 +16293,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -16382,13 +16317,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -16399,7 +16334,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -16407,7 +16342,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -16418,13 +16353,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -16432,7 +16367,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -16440,7 +16375,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -16452,23 +16387,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnMaintenanceWindow } from 'awscdk-resources-mongodbatlas' +import { CfnNetworkPeering } from 'awscdk-resources-mongodbatlas' -CfnMaintenanceWindow.isConstruct(x: any) +CfnNetworkPeering.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -16476,12 +16411,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnMaintenanceWindow } from 'awscdk-resources-mongodbatlas' +import { CfnNetworkPeering } from 'awscdk-resources-mongodbatlas' -CfnMaintenanceWindow.isCfnElement(x: any) +CfnNetworkPeering.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -16489,23 +16424,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnMaintenanceWindow } from 'awscdk-resources-mongodbatlas' +import { CfnNetworkPeering } from 'awscdk-resources-mongodbatlas' -CfnMaintenanceWindow.isCfnResource(x: any) +CfnNetworkPeering.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -16515,18 +16450,22 @@ Check whether the given object is a CfnResource. | **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 | CfnMaintenanceWindowProps | Resource props. | +| 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. | +| attrConnectionId | string | Attribute `MongoDB::Atlas::NetworkPeering.ConnectionId`. | +| attrErrorStateName | string | Attribute `MongoDB::Atlas::NetworkPeering.ErrorStateName`. | +| attrId | string | Attribute `MongoDB::Atlas::NetworkPeering.Id`. | +| attrStatusName | string | Attribute `MongoDB::Atlas::NetworkPeering.StatusName`. | +| props | CfnNetworkPeeringProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -16538,7 +16477,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -16548,7 +16487,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -16565,7 +16504,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -16579,7 +16518,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -16594,7 +16533,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -16606,7 +16545,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -16618,13 +16557,61 @@ AWS resource type. --- -##### `props`Required +##### `attrConnectionId`Required ```typescript -public readonly props: CfnMaintenanceWindowProps; +public readonly attrConnectionId: string; ``` -- *Type:* CfnMaintenanceWindowProps +- *Type:* string + +Attribute `MongoDB::Atlas::NetworkPeering.ConnectionId`. + +--- + +##### `attrErrorStateName`Required + +```typescript +public readonly attrErrorStateName: string; +``` + +- *Type:* string + +Attribute `MongoDB::Atlas::NetworkPeering.ErrorStateName`. + +--- + +##### `attrId`Required + +```typescript +public readonly attrId: string; +``` + +- *Type:* string + +Attribute `MongoDB::Atlas::NetworkPeering.Id`. + +--- + +##### `attrStatusName`Required + +```typescript +public readonly attrStatusName: string; +``` + +- *Type:* string + +Attribute `MongoDB::Atlas::NetworkPeering.StatusName`. + +--- + +##### `props`Required + +```typescript +public readonly props: CfnNetworkPeeringProps; +``` + +- *Type:* CfnNetworkPeeringProps Resource props. @@ -16634,11 +16621,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -16650,27 +16637,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnNetworkContainer +### CfnOnlineArchive -A CloudFormation `MongoDB::Atlas::NetworkContainer`. +A CloudFormation `MongoDB::Atlas::OnlineArchive`. -#### Initializers +#### Initializers ```typescript -import { CfnNetworkContainer } from 'awscdk-resources-mongodbatlas' +import { CfnOnlineArchive } from 'awscdk-resources-mongodbatlas' -new CfnNetworkContainer(scope: Construct, id: string, props: CfnNetworkContainerProps) +new CfnOnlineArchive(scope: Construct, id: string, props: CfnOnlineArchiveProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnNetworkContainerProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnOnlineArchiveProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -16678,7 +16665,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -16686,9 +16673,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnNetworkContainerProps +- *Type:* CfnOnlineArchiveProps resource properties. @@ -16698,26 +16685,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -16725,7 +16712,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -16733,7 +16720,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -16741,7 +16728,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -16749,7 +16736,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -16757,7 +16744,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -16768,13 +16755,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -16782,13 +16769,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -16806,19 +16793,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -16868,7 +16855,7 @@ 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 +###### `path`Required - *Type:* string @@ -16879,7 +16866,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -16889,7 +16876,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -16897,7 +16884,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -16905,7 +16892,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -16915,7 +16902,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -16923,7 +16910,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -16931,7 +16918,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -16952,19 +16939,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -16975,7 +16962,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -16983,13 +16970,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -17007,13 +16994,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -17024,7 +17011,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -17032,7 +17019,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -17043,13 +17030,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -17057,7 +17044,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -17065,7 +17052,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -17077,23 +17064,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnNetworkContainer } from 'awscdk-resources-mongodbatlas' +import { CfnOnlineArchive } from 'awscdk-resources-mongodbatlas' -CfnNetworkContainer.isConstruct(x: any) +CfnOnlineArchive.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -17101,12 +17088,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnNetworkContainer } from 'awscdk-resources-mongodbatlas' +import { CfnOnlineArchive } from 'awscdk-resources-mongodbatlas' -CfnNetworkContainer.isCfnElement(x: any) +CfnOnlineArchive.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -17114,23 +17101,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnNetworkContainer } from 'awscdk-resources-mongodbatlas' +import { CfnOnlineArchive } from 'awscdk-resources-mongodbatlas' -CfnNetworkContainer.isCfnResource(x: any) +CfnOnlineArchive.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -17140,19 +17127,21 @@ Check whether the given object is a CfnResource. | **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. | -| attrId | string | Attribute `MongoDB::Atlas::NetworkContainer.Id`. | -| props | CfnNetworkContainerProps | Resource props. | +| 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. | +| attrArchiveId | string | Attribute `MongoDB::Atlas::OnlineArchive.ArchiveId`. | +| attrState | string | Attribute `MongoDB::Atlas::OnlineArchive.State`. | +| attrTotalCount | number | Attribute `MongoDB::Atlas::OnlineArchive.TotalCount`. | +| props | CfnOnlineArchiveProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -17164,7 +17153,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -17174,7 +17163,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -17191,7 +17180,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -17205,7 +17194,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -17220,7 +17209,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -17232,7 +17221,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -17244,25 +17233,49 @@ AWS resource type. --- -##### `attrId`Required +##### `attrArchiveId`Required ```typescript -public readonly attrId: string; +public readonly attrArchiveId: string; ``` - *Type:* string -Attribute `MongoDB::Atlas::NetworkContainer.Id`. +Attribute `MongoDB::Atlas::OnlineArchive.ArchiveId`. --- -##### `props`Required +##### `attrState`Required ```typescript -public readonly props: CfnNetworkContainerProps; +public readonly attrState: string; ``` -- *Type:* CfnNetworkContainerProps +- *Type:* string + +Attribute `MongoDB::Atlas::OnlineArchive.State`. + +--- + +##### `attrTotalCount`Required + +```typescript +public readonly attrTotalCount: number; +``` + +- *Type:* number + +Attribute `MongoDB::Atlas::OnlineArchive.TotalCount`. + +--- + +##### `props`Required + +```typescript +public readonly props: CfnOnlineArchiveProps; +``` + +- *Type:* CfnOnlineArchiveProps Resource props. @@ -17272,11 +17285,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -17288,27 +17301,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnNetworkPeering +### CfnOrganization -A CloudFormation `MongoDB::Atlas::NetworkPeering`. +A CloudFormation `MongoDB::Atlas::Organization`. -#### Initializers +#### Initializers ```typescript -import { CfnNetworkPeering } from 'awscdk-resources-mongodbatlas' +import { CfnOrganization } from 'awscdk-resources-mongodbatlas' -new CfnNetworkPeering(scope: Construct, id: string, props: CfnNetworkPeeringProps) +new CfnOrganization(scope: Construct, id: string, props: CfnOrganizationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnNetworkPeeringProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnOrganizationProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -17316,7 +17329,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -17324,9 +17337,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnNetworkPeeringProps +- *Type:* CfnOrganizationProps resource properties. @@ -17336,26 +17349,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -17363,7 +17376,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -17371,7 +17384,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -17379,7 +17392,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -17387,7 +17400,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -17395,7 +17408,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -17406,13 +17419,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -17420,13 +17433,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -17444,19 +17457,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -17506,7 +17519,7 @@ 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 +###### `path`Required - *Type:* string @@ -17517,7 +17530,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -17527,7 +17540,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -17535,7 +17548,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -17543,7 +17556,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -17553,7 +17566,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -17561,7 +17574,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -17569,7 +17582,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -17590,19 +17603,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -17613,7 +17626,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -17621,13 +17634,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -17645,13 +17658,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -17662,7 +17675,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -17670,7 +17683,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -17681,13 +17694,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -17695,7 +17708,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -17703,7 +17716,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -17715,23 +17728,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnNetworkPeering } from 'awscdk-resources-mongodbatlas' +import { CfnOrganization } from 'awscdk-resources-mongodbatlas' -CfnNetworkPeering.isConstruct(x: any) +CfnOrganization.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -17739,12 +17752,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnNetworkPeering } from 'awscdk-resources-mongodbatlas' +import { CfnOrganization } from 'awscdk-resources-mongodbatlas' -CfnNetworkPeering.isCfnElement(x: any) +CfnOrganization.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -17752,23 +17765,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnNetworkPeering } from 'awscdk-resources-mongodbatlas' +import { CfnOrganization } from 'awscdk-resources-mongodbatlas' -CfnNetworkPeering.isCfnResource(x: any) +CfnOrganization.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -17778,22 +17791,19 @@ Check whether the given object is a CfnResource. | **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. | -| attrConnectionId | string | Attribute `MongoDB::Atlas::NetworkPeering.ConnectionId`. | -| attrErrorStateName | string | Attribute `MongoDB::Atlas::NetworkPeering.ErrorStateName`. | -| attrId | string | Attribute `MongoDB::Atlas::NetworkPeering.Id`. | -| attrStatusName | string | Attribute `MongoDB::Atlas::NetworkPeering.StatusName`. | -| props | CfnNetworkPeeringProps | Resource props. | +| 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. | +| attrOrgId | string | Attribute `MongoDB::Atlas::Organization.OrgId`. | +| props | CfnOrganizationProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -17805,7 +17815,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -17815,7 +17825,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -17832,7 +17842,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -17846,7 +17856,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -17861,7 +17871,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -17873,7 +17883,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -17885,61 +17895,25 @@ AWS resource type. --- -##### `attrConnectionId`Required - -```typescript -public readonly attrConnectionId: string; -``` - -- *Type:* string - -Attribute `MongoDB::Atlas::NetworkPeering.ConnectionId`. - ---- - -##### `attrErrorStateName`Required - -```typescript -public readonly attrErrorStateName: string; -``` - -- *Type:* string - -Attribute `MongoDB::Atlas::NetworkPeering.ErrorStateName`. - ---- - -##### `attrId`Required - -```typescript -public readonly attrId: string; -``` - -- *Type:* string - -Attribute `MongoDB::Atlas::NetworkPeering.Id`. - ---- - -##### `attrStatusName`Required +##### `attrOrgId`Required ```typescript -public readonly attrStatusName: string; +public readonly attrOrgId: string; ``` - *Type:* string -Attribute `MongoDB::Atlas::NetworkPeering.StatusName`. +Attribute `MongoDB::Atlas::Organization.OrgId`. --- -##### `props`Required +##### `props`Required ```typescript -public readonly props: CfnNetworkPeeringProps; +public readonly props: CfnOrganizationProps; ``` -- *Type:* CfnNetworkPeeringProps +- *Type:* CfnOrganizationProps Resource props. @@ -17949,11 +17923,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -17965,27 +17939,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnOnlineArchive +### CfnOrgInvitation -A CloudFormation `MongoDB::Atlas::OnlineArchive`. +A CloudFormation `MongoDB::Atlas::OrgInvitation`. -#### Initializers +#### Initializers ```typescript -import { CfnOnlineArchive } from 'awscdk-resources-mongodbatlas' +import { CfnOrgInvitation } from 'awscdk-resources-mongodbatlas' -new CfnOnlineArchive(scope: Construct, id: string, props: CfnOnlineArchiveProps) +new CfnOrgInvitation(scope: Construct, id: string, props: CfnOrgInvitationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnOnlineArchiveProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnOrgInvitationProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -17993,7 +17967,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -18001,9 +17975,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnOnlineArchiveProps +- *Type:* CfnOrgInvitationProps resource properties. @@ -18013,26 +17987,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -18040,7 +18014,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -18048,7 +18022,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -18056,7 +18030,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -18064,7 +18038,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -18072,7 +18046,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -18083,13 +18057,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -18097,13 +18071,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -18121,19 +18095,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -18183,7 +18157,7 @@ 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 +###### `path`Required - *Type:* string @@ -18194,7 +18168,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -18204,7 +18178,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -18212,7 +18186,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -18220,7 +18194,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -18230,7 +18204,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -18238,7 +18212,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -18246,7 +18220,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -18267,19 +18241,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -18290,7 +18264,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -18298,13 +18272,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -18322,13 +18296,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -18339,7 +18313,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -18347,7 +18321,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -18358,13 +18332,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -18372,7 +18346,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -18380,7 +18354,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -18392,23 +18366,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnOnlineArchive } from 'awscdk-resources-mongodbatlas' +import { CfnOrgInvitation } from 'awscdk-resources-mongodbatlas' -CfnOnlineArchive.isConstruct(x: any) +CfnOrgInvitation.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -18416,12 +18390,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnOnlineArchive } from 'awscdk-resources-mongodbatlas' +import { CfnOrgInvitation } from 'awscdk-resources-mongodbatlas' -CfnOnlineArchive.isCfnElement(x: any) +CfnOrgInvitation.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -18429,23 +18403,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnOnlineArchive } from 'awscdk-resources-mongodbatlas' +import { CfnOrgInvitation } from 'awscdk-resources-mongodbatlas' -CfnOnlineArchive.isCfnResource(x: any) +CfnOrgInvitation.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -18455,21 +18429,22 @@ Check whether the given object is a CfnResource. | **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. | -| attrArchiveId | string | Attribute `MongoDB::Atlas::OnlineArchive.ArchiveId`. | -| attrState | string | Attribute `MongoDB::Atlas::OnlineArchive.State`. | -| attrTotalCount | number | Attribute `MongoDB::Atlas::OnlineArchive.TotalCount`. | -| props | CfnOnlineArchiveProps | Resource props. | +| 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. | +| attrCreatedAt | string | Attribute `MongoDB::Atlas::OrgInvitation.CreatedAt`. | +| attrExpiresAt | string | Attribute `MongoDB::Atlas::OrgInvitation.ExpiresAt`. | +| attrId | string | Attribute `MongoDB::Atlas::OrgInvitation.Id`. | +| attrInviterUsername | string | Attribute `MongoDB::Atlas::OrgInvitation.InviterUsername`. | +| props | CfnOrgInvitationProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -18481,7 +18456,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -18491,7 +18466,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -18508,7 +18483,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -18522,7 +18497,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -18537,7 +18512,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -18549,7 +18524,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -18561,49 +18536,61 @@ AWS resource type. --- -##### `attrArchiveId`Required +##### `attrCreatedAt`Required ```typescript -public readonly attrArchiveId: string; +public readonly attrCreatedAt: string; ``` - *Type:* string -Attribute `MongoDB::Atlas::OnlineArchive.ArchiveId`. +Attribute `MongoDB::Atlas::OrgInvitation.CreatedAt`. --- -##### `attrState`Required +##### `attrExpiresAt`Required ```typescript -public readonly attrState: string; +public readonly attrExpiresAt: string; ``` - *Type:* string -Attribute `MongoDB::Atlas::OnlineArchive.State`. +Attribute `MongoDB::Atlas::OrgInvitation.ExpiresAt`. --- -##### `attrTotalCount`Required +##### `attrId`Required ```typescript -public readonly attrTotalCount: number; +public readonly attrId: string; ``` -- *Type:* number +- *Type:* string -Attribute `MongoDB::Atlas::OnlineArchive.TotalCount`. +Attribute `MongoDB::Atlas::OrgInvitation.Id`. --- -##### `props`Required +##### `attrInviterUsername`Required ```typescript -public readonly props: CfnOnlineArchiveProps; +public readonly attrInviterUsername: string; ``` -- *Type:* CfnOnlineArchiveProps +- *Type:* string + +Attribute `MongoDB::Atlas::OrgInvitation.InviterUsername`. + +--- + +##### `props`Required + +```typescript +public readonly props: CfnOrgInvitationProps; +``` + +- *Type:* CfnOrgInvitationProps Resource props. @@ -18613,11 +18600,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -18629,27 +18616,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnOrganization +### CfnPrivateEndpoint -A CloudFormation `MongoDB::Atlas::Organization`. +A CloudFormation `MongoDB::Atlas::PrivateEndpoint`. -#### Initializers +#### Initializers ```typescript -import { CfnOrganization } from 'awscdk-resources-mongodbatlas' +import { CfnPrivateEndpoint } from 'awscdk-resources-mongodbatlas' -new CfnOrganization(scope: Construct, id: string, props: CfnOrganizationProps) +new CfnPrivateEndpoint(scope: Construct, id: string, props: CfnPrivateEndpointProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnOrganizationProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnPrivateEndpointProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -18657,7 +18644,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -18665,9 +18652,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnOrganizationProps +- *Type:* CfnPrivateEndpointProps resource properties. @@ -18677,26 +18664,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -18704,7 +18691,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -18712,7 +18699,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -18720,7 +18707,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -18728,7 +18715,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -18736,7 +18723,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -18747,13 +18734,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -18761,13 +18748,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -18785,19 +18772,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -18847,7 +18834,7 @@ 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 +###### `path`Required - *Type:* string @@ -18858,7 +18845,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -18868,7 +18855,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -18876,7 +18863,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -18884,7 +18871,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -18894,7 +18881,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -18902,7 +18889,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -18910,7 +18897,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -18931,19 +18918,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -18954,7 +18941,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -18962,13 +18949,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -18986,13 +18973,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -19003,7 +18990,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -19011,7 +18998,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -19022,13 +19009,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -19036,7 +19023,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -19044,7 +19031,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -19056,23 +19043,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnOrganization } from 'awscdk-resources-mongodbatlas' +import { CfnPrivateEndpoint } from 'awscdk-resources-mongodbatlas' -CfnOrganization.isConstruct(x: any) +CfnPrivateEndpoint.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -19080,12 +19067,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnOrganization } from 'awscdk-resources-mongodbatlas' +import { CfnPrivateEndpoint } from 'awscdk-resources-mongodbatlas' -CfnOrganization.isCfnElement(x: any) +CfnPrivateEndpoint.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -19093,23 +19080,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnOrganization } from 'awscdk-resources-mongodbatlas' +import { CfnPrivateEndpoint } from 'awscdk-resources-mongodbatlas' -CfnOrganization.isCfnResource(x: any) +CfnPrivateEndpoint.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -19119,19 +19106,20 @@ Check whether the given object is a CfnResource. | **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. | -| attrOrgId | string | Attribute `MongoDB::Atlas::Organization.OrgId`. | -| props | CfnOrganizationProps | Resource props. | +| 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. | +| attrId | string | Attribute `MongoDB::Atlas::PrivateEndpoint.Id`. | +| attrInterfaceEndpoints | string[] | Attribute `MongoDB::Atlas::PrivateEndpoint.InterfaceEndpoints`. | +| props | CfnPrivateEndpointProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -19143,7 +19131,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -19153,7 +19141,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -19170,7 +19158,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -19184,7 +19172,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -19199,7 +19187,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -19211,7 +19199,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -19223,25 +19211,37 @@ AWS resource type. --- -##### `attrOrgId`Required +##### `attrId`Required ```typescript -public readonly attrOrgId: string; +public readonly attrId: string; ``` - *Type:* string -Attribute `MongoDB::Atlas::Organization.OrgId`. +Attribute `MongoDB::Atlas::PrivateEndpoint.Id`. --- -##### `props`Required +##### `attrInterfaceEndpoints`Required ```typescript -public readonly props: CfnOrganizationProps; +public readonly attrInterfaceEndpoints: string[]; ``` -- *Type:* CfnOrganizationProps +- *Type:* string[] + +Attribute `MongoDB::Atlas::PrivateEndpoint.InterfaceEndpoints`. + +--- + +##### `props`Required + +```typescript +public readonly props: CfnPrivateEndpointProps; +``` + +- *Type:* CfnPrivateEndpointProps Resource props. @@ -19251,11 +19251,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -19267,27 +19267,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnOrgInvitation +### CfnPrivateEndpointAdl -A CloudFormation `MongoDB::Atlas::OrgInvitation`. +A CloudFormation `MongoDB::Atlas::PrivateEndpointADL`. -#### Initializers +#### Initializers ```typescript -import { CfnOrgInvitation } from 'awscdk-resources-mongodbatlas' +import { CfnPrivateEndpointAdl } from 'awscdk-resources-mongodbatlas' -new CfnOrgInvitation(scope: Construct, id: string, props: CfnOrgInvitationProps) +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 | CfnOrgInvitationProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnPrivateEndpointAdlProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -19295,7 +19295,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -19303,9 +19303,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnOrgInvitationProps +- *Type:* CfnPrivateEndpointAdlProps resource properties. @@ -19315,26 +19315,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -19342,7 +19342,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -19350,7 +19350,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -19358,7 +19358,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -19366,7 +19366,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -19374,7 +19374,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -19385,13 +19385,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -19399,13 +19399,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -19423,19 +19423,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -19485,7 +19485,7 @@ 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 +###### `path`Required - *Type:* string @@ -19496,7 +19496,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -19506,7 +19506,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -19514,7 +19514,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -19522,7 +19522,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -19532,7 +19532,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -19540,7 +19540,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -19548,7 +19548,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -19569,19 +19569,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -19592,7 +19592,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -19600,13 +19600,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -19624,13 +19624,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -19641,7 +19641,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -19649,7 +19649,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -19660,13 +19660,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -19674,7 +19674,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -19682,7 +19682,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -19694,23 +19694,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnOrgInvitation } from 'awscdk-resources-mongodbatlas' +import { CfnPrivateEndpointAdl } from 'awscdk-resources-mongodbatlas' -CfnOrgInvitation.isConstruct(x: any) +CfnPrivateEndpointAdl.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -19718,12 +19718,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnOrgInvitation } from 'awscdk-resources-mongodbatlas' +import { CfnPrivateEndpointAdl } from 'awscdk-resources-mongodbatlas' -CfnOrgInvitation.isCfnElement(x: any) +CfnPrivateEndpointAdl.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -19731,23 +19731,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnOrgInvitation } from 'awscdk-resources-mongodbatlas' +import { CfnPrivateEndpointAdl } from 'awscdk-resources-mongodbatlas' -CfnOrgInvitation.isCfnResource(x: any) +CfnPrivateEndpointAdl.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -19757,22 +19757,18 @@ Check whether the given object is a CfnResource. | **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. | -| attrCreatedAt | string | Attribute `MongoDB::Atlas::OrgInvitation.CreatedAt`. | -| attrExpiresAt | string | Attribute `MongoDB::Atlas::OrgInvitation.ExpiresAt`. | -| attrId | string | Attribute `MongoDB::Atlas::OrgInvitation.Id`. | -| attrInviterUsername | string | Attribute `MongoDB::Atlas::OrgInvitation.InviterUsername`. | -| props | CfnOrgInvitationProps | Resource props. | +| 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 +##### `node`Required ```typescript public readonly node: Node; @@ -19784,7 +19780,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -19794,7 +19790,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -19811,7 +19807,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -19825,7 +19821,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -19840,7 +19836,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -19852,7 +19848,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -19864,61 +19860,13 @@ AWS resource type. --- -##### `attrCreatedAt`Required - -```typescript -public readonly attrCreatedAt: string; -``` - -- *Type:* string - -Attribute `MongoDB::Atlas::OrgInvitation.CreatedAt`. - ---- - -##### `attrExpiresAt`Required - -```typescript -public readonly attrExpiresAt: string; -``` - -- *Type:* string - -Attribute `MongoDB::Atlas::OrgInvitation.ExpiresAt`. - ---- - -##### `attrId`Required - -```typescript -public readonly attrId: string; -``` - -- *Type:* string - -Attribute `MongoDB::Atlas::OrgInvitation.Id`. - ---- - -##### `attrInviterUsername`Required - -```typescript -public readonly attrInviterUsername: string; -``` - -- *Type:* string - -Attribute `MongoDB::Atlas::OrgInvitation.InviterUsername`. - ---- - -##### `props`Required +##### `props`Required ```typescript -public readonly props: CfnOrgInvitationProps; +public readonly props: CfnPrivateEndpointAdlProps; ``` -- *Type:* CfnOrgInvitationProps +- *Type:* CfnPrivateEndpointAdlProps Resource props. @@ -19928,11 +19876,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -19944,27 +19892,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnPrivateEndpoint +### CfnPrivateEndpointAws -A CloudFormation `MongoDB::Atlas::PrivateEndpoint`. +A CloudFormation `MongoDB::Atlas::PrivateEndpointAWS`. -#### Initializers +#### Initializers ```typescript -import { CfnPrivateEndpoint } from 'awscdk-resources-mongodbatlas' +import { CfnPrivateEndpointAws } from 'awscdk-resources-mongodbatlas' -new CfnPrivateEndpoint(scope: Construct, id: string, props: CfnPrivateEndpointProps) +new CfnPrivateEndpointAws(scope: Construct, id: string, props: CfnPrivateEndpointAwsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnPrivateEndpointProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnPrivateEndpointAwsProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -19972,7 +19920,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -19980,9 +19928,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnPrivateEndpointProps +- *Type:* CfnPrivateEndpointAwsProps resource properties. @@ -19992,26 +19940,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -20019,7 +19967,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -20027,7 +19975,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -20035,7 +19983,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -20043,7 +19991,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -20051,7 +19999,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -20062,13 +20010,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -20076,13 +20024,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -20100,19 +20048,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -20162,7 +20110,7 @@ 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 +###### `path`Required - *Type:* string @@ -20173,7 +20121,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -20183,7 +20131,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -20191,7 +20139,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -20199,7 +20147,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -20209,7 +20157,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -20217,7 +20165,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -20225,7 +20173,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -20246,19 +20194,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -20269,7 +20217,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -20277,13 +20225,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -20301,13 +20249,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -20318,7 +20266,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -20326,7 +20274,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -20337,13 +20285,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -20351,7 +20299,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -20359,7 +20307,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -20371,23 +20319,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnPrivateEndpoint } from 'awscdk-resources-mongodbatlas' +import { CfnPrivateEndpointAws } from 'awscdk-resources-mongodbatlas' -CfnPrivateEndpoint.isConstruct(x: any) +CfnPrivateEndpointAws.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -20395,12 +20343,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnPrivateEndpoint } from 'awscdk-resources-mongodbatlas' +import { CfnPrivateEndpointAws } from 'awscdk-resources-mongodbatlas' -CfnPrivateEndpoint.isCfnElement(x: any) +CfnPrivateEndpointAws.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -20408,23 +20356,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnPrivateEndpoint } from 'awscdk-resources-mongodbatlas' +import { CfnPrivateEndpointAws } from 'awscdk-resources-mongodbatlas' -CfnPrivateEndpoint.isCfnResource(x: any) +CfnPrivateEndpointAws.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -20434,20 +20382,18 @@ Check whether the given object is a CfnResource. | **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. | -| attrId | string | Attribute `MongoDB::Atlas::PrivateEndpoint.Id`. | -| attrInterfaceEndpoints | string[] | Attribute `MongoDB::Atlas::PrivateEndpoint.InterfaceEndpoints`. | -| props | CfnPrivateEndpointProps | Resource props. | +| 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 | CfnPrivateEndpointAwsProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -20459,7 +20405,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -20469,7 +20415,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -20486,7 +20432,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -20500,7 +20446,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -20515,7 +20461,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -20527,7 +20473,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -20539,37 +20485,13 @@ AWS resource type. --- -##### `attrId`Required - -```typescript -public readonly attrId: string; -``` - -- *Type:* string - -Attribute `MongoDB::Atlas::PrivateEndpoint.Id`. - ---- - -##### `attrInterfaceEndpoints`Required - -```typescript -public readonly attrInterfaceEndpoints: string[]; -``` - -- *Type:* string[] - -Attribute `MongoDB::Atlas::PrivateEndpoint.InterfaceEndpoints`. - ---- - -##### `props`Required +##### `props`Required ```typescript -public readonly props: CfnPrivateEndpointProps; +public readonly props: CfnPrivateEndpointAwsProps; ``` -- *Type:* CfnPrivateEndpointProps +- *Type:* CfnPrivateEndpointAwsProps Resource props. @@ -20579,11 +20501,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -20595,27 +20517,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnPrivateEndpointAdl +### CfnPrivateEndPointRegionalMode -A CloudFormation `MongoDB::Atlas::PrivateEndpointADL`. +A CloudFormation `MongoDB::Atlas::PrivateEndPointRegionalMode`. -#### Initializers +#### Initializers ```typescript -import { CfnPrivateEndpointAdl } from 'awscdk-resources-mongodbatlas' +import { CfnPrivateEndPointRegionalMode } from 'awscdk-resources-mongodbatlas' -new CfnPrivateEndpointAdl(scope: Construct, id: string, props: CfnPrivateEndpointAdlProps) +new CfnPrivateEndPointRegionalMode(scope: Construct, id: string, props: CfnPrivateEndPointRegionalModeProps) ``` | **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 | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnPrivateEndPointRegionalModeProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -20623,7 +20545,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -20631,9 +20553,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnPrivateEndpointAdlProps +- *Type:* CfnPrivateEndPointRegionalModeProps resource properties. @@ -20643,26 +20565,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -20670,7 +20592,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -20678,7 +20600,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -20686,7 +20608,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -20694,7 +20616,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -20702,7 +20624,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -20713,13 +20635,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -20727,13 +20649,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -20751,19 +20673,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -20813,7 +20735,7 @@ 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 +###### `path`Required - *Type:* string @@ -20824,7 +20746,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -20834,7 +20756,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -20842,7 +20764,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -20850,7 +20772,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -20860,7 +20782,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -20868,7 +20790,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -20876,7 +20798,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -20897,19 +20819,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -20920,7 +20842,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -20928,13 +20850,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -20952,13 +20874,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -20969,7 +20891,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -20977,7 +20899,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -20988,13 +20910,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -21002,7 +20924,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -21010,7 +20932,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -21022,23 +20944,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnPrivateEndpointAdl } from 'awscdk-resources-mongodbatlas' +import { CfnPrivateEndPointRegionalMode } from 'awscdk-resources-mongodbatlas' -CfnPrivateEndpointAdl.isConstruct(x: any) +CfnPrivateEndPointRegionalMode.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -21046,12 +20968,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnPrivateEndpointAdl } from 'awscdk-resources-mongodbatlas' +import { CfnPrivateEndPointRegionalMode } from 'awscdk-resources-mongodbatlas' -CfnPrivateEndpointAdl.isCfnElement(x: any) +CfnPrivateEndPointRegionalMode.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -21059,23 +20981,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnPrivateEndpointAdl } from 'awscdk-resources-mongodbatlas' +import { CfnPrivateEndPointRegionalMode } from 'awscdk-resources-mongodbatlas' -CfnPrivateEndpointAdl.isCfnResource(x: any) +CfnPrivateEndPointRegionalMode.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -21085,18 +21007,18 @@ Check whether the given object is a CfnResource. | **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 | 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 | CfnPrivateEndPointRegionalModeProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -21108,7 +21030,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -21118,7 +21040,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -21135,7 +21057,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -21149,7 +21071,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -21164,7 +21086,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -21176,7 +21098,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -21188,13 +21110,13 @@ AWS resource type. --- -##### `props`Required +##### `props`Required ```typescript -public readonly props: CfnPrivateEndpointAdlProps; +public readonly props: CfnPrivateEndPointRegionalModeProps; ``` -- *Type:* CfnPrivateEndpointAdlProps +- *Type:* CfnPrivateEndPointRegionalModeProps Resource props. @@ -21204,11 +21126,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -21220,27 +21142,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnPrivateEndpointAws +### CfnPrivateEndpointService -A CloudFormation `MongoDB::Atlas::PrivateEndpointAWS`. +A CloudFormation `MongoDB::Atlas::PrivateEndpointService`. -#### Initializers +#### Initializers ```typescript -import { CfnPrivateEndpointAws } from 'awscdk-resources-mongodbatlas' +import { CfnPrivateEndpointService } from 'awscdk-resources-mongodbatlas' -new CfnPrivateEndpointAws(scope: Construct, id: string, props: CfnPrivateEndpointAwsProps) +new CfnPrivateEndpointService(scope: Construct, id: string, props: CfnPrivateEndpointServiceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnPrivateEndpointAwsProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnPrivateEndpointServiceProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -21248,7 +21170,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -21256,9 +21178,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnPrivateEndpointAwsProps +- *Type:* CfnPrivateEndpointServiceProps resource properties. @@ -21268,26 +21190,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -21295,7 +21217,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -21303,7 +21225,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -21311,7 +21233,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -21319,7 +21241,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -21327,7 +21249,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -21338,13 +21260,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -21352,13 +21274,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -21376,19 +21298,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -21438,7 +21360,7 @@ 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 +###### `path`Required - *Type:* string @@ -21449,7 +21371,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -21459,7 +21381,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -21467,7 +21389,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -21475,7 +21397,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -21485,7 +21407,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -21493,7 +21415,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -21501,7 +21423,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -21522,19 +21444,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -21545,7 +21467,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -21553,13 +21475,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -21577,13 +21499,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -21594,7 +21516,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -21602,7 +21524,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -21613,13 +21535,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -21627,7 +21549,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -21635,7 +21557,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -21647,23 +21569,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnPrivateEndpointAws } from 'awscdk-resources-mongodbatlas' +import { CfnPrivateEndpointService } from 'awscdk-resources-mongodbatlas' -CfnPrivateEndpointAws.isConstruct(x: any) +CfnPrivateEndpointService.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -21671,12 +21593,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnPrivateEndpointAws } from 'awscdk-resources-mongodbatlas' +import { CfnPrivateEndpointService } from 'awscdk-resources-mongodbatlas' -CfnPrivateEndpointAws.isCfnElement(x: any) +CfnPrivateEndpointService.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -21684,23 +21606,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnPrivateEndpointAws } from 'awscdk-resources-mongodbatlas' +import { CfnPrivateEndpointService } from 'awscdk-resources-mongodbatlas' -CfnPrivateEndpointAws.isCfnResource(x: any) +CfnPrivateEndpointService.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -21710,18 +21632,23 @@ Check whether the given object is a CfnResource. | **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 | CfnPrivateEndpointAwsProps | Resource props. | +| 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. | +| attrEndpointServiceName | string | Attribute `MongoDB::Atlas::PrivateEndpointService.EndpointServiceName`. | +| attrErrorMessage | string | Attribute `MongoDB::Atlas::PrivateEndpointService.ErrorMessage`. | +| attrId | string | Attribute `MongoDB::Atlas::PrivateEndpointService.Id`. | +| attrInterfaceEndpoints | string[] | Attribute `MongoDB::Atlas::PrivateEndpointService.InterfaceEndpoints`. | +| attrStatus | string | Attribute `MongoDB::Atlas::PrivateEndpointService.Status`. | +| props | CfnPrivateEndpointServiceProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -21733,7 +21660,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -21743,7 +21670,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -21760,7 +21687,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -21774,7 +21701,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -21789,7 +21716,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -21801,7 +21728,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -21813,13 +21740,73 @@ AWS resource type. --- -##### `props`Required +##### `attrEndpointServiceName`Required ```typescript -public readonly props: CfnPrivateEndpointAwsProps; +public readonly attrEndpointServiceName: string; ``` -- *Type:* CfnPrivateEndpointAwsProps +- *Type:* string + +Attribute `MongoDB::Atlas::PrivateEndpointService.EndpointServiceName`. + +--- + +##### `attrErrorMessage`Required + +```typescript +public readonly attrErrorMessage: string; +``` + +- *Type:* string + +Attribute `MongoDB::Atlas::PrivateEndpointService.ErrorMessage`. + +--- + +##### `attrId`Required + +```typescript +public readonly attrId: string; +``` + +- *Type:* string + +Attribute `MongoDB::Atlas::PrivateEndpointService.Id`. + +--- + +##### `attrInterfaceEndpoints`Required + +```typescript +public readonly attrInterfaceEndpoints: string[]; +``` + +- *Type:* string[] + +Attribute `MongoDB::Atlas::PrivateEndpointService.InterfaceEndpoints`. + +--- + +##### `attrStatus`Required + +```typescript +public readonly attrStatus: string; +``` + +- *Type:* string + +Attribute `MongoDB::Atlas::PrivateEndpointService.Status`. + +--- + +##### `props`Required + +```typescript +public readonly props: CfnPrivateEndpointServiceProps; +``` + +- *Type:* CfnPrivateEndpointServiceProps Resource props. @@ -21829,11 +21816,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -21845,27 +21832,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnPrivateEndPointRegionalMode +### CfnPrivatelinkEndpointServiceDataFederationOnlineArchive -A CloudFormation `MongoDB::Atlas::PrivateEndPointRegionalMode`. +A CloudFormation `MongoDB::Atlas::PrivatelinkEndpointServiceDataFederationOnlineArchive`. -#### Initializers +#### Initializers ```typescript -import { CfnPrivateEndPointRegionalMode } from 'awscdk-resources-mongodbatlas' +import { CfnPrivatelinkEndpointServiceDataFederationOnlineArchive } from 'awscdk-resources-mongodbatlas' -new CfnPrivateEndPointRegionalMode(scope: Construct, id: string, props: CfnPrivateEndPointRegionalModeProps) +new CfnPrivatelinkEndpointServiceDataFederationOnlineArchive(scope: Construct, id: string, props: CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnPrivateEndPointRegionalModeProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -21873,7 +21860,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -21881,9 +21868,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnPrivateEndPointRegionalModeProps +- *Type:* CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps resource properties. @@ -21893,26 +21880,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -21920,7 +21907,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -21928,7 +21915,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -21936,7 +21923,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -21944,7 +21931,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -21952,7 +21939,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -21963,13 +21950,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -21977,13 +21964,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -22001,19 +21988,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -22063,7 +22050,7 @@ 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 +###### `path`Required - *Type:* string @@ -22074,7 +22061,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -22084,7 +22071,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -22092,7 +22079,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -22100,7 +22087,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -22110,7 +22097,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -22118,7 +22105,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -22126,7 +22113,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -22147,19 +22134,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -22170,7 +22157,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -22178,13 +22165,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -22202,13 +22189,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -22219,7 +22206,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -22227,7 +22214,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -22238,13 +22225,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -22252,7 +22239,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -22260,7 +22247,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -22272,23 +22259,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnPrivateEndPointRegionalMode } from 'awscdk-resources-mongodbatlas' +import { CfnPrivatelinkEndpointServiceDataFederationOnlineArchive } from 'awscdk-resources-mongodbatlas' -CfnPrivateEndPointRegionalMode.isConstruct(x: any) +CfnPrivatelinkEndpointServiceDataFederationOnlineArchive.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -22296,12 +22283,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnPrivateEndPointRegionalMode } from 'awscdk-resources-mongodbatlas' +import { CfnPrivatelinkEndpointServiceDataFederationOnlineArchive } from 'awscdk-resources-mongodbatlas' -CfnPrivateEndPointRegionalMode.isCfnElement(x: any) +CfnPrivatelinkEndpointServiceDataFederationOnlineArchive.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -22309,23 +22296,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnPrivateEndPointRegionalMode } from 'awscdk-resources-mongodbatlas' +import { CfnPrivatelinkEndpointServiceDataFederationOnlineArchive } from 'awscdk-resources-mongodbatlas' -CfnPrivateEndPointRegionalMode.isCfnResource(x: any) +CfnPrivatelinkEndpointServiceDataFederationOnlineArchive.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -22335,18 +22322,18 @@ Check whether the given object is a CfnResource. | **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 | CfnPrivateEndPointRegionalModeProps | Resource props. | +| 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 | CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -22358,7 +22345,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -22368,7 +22355,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -22385,7 +22372,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -22399,7 +22386,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -22414,7 +22401,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -22426,7 +22413,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -22438,13 +22425,13 @@ AWS resource type. --- -##### `props`Required +##### `props`Required ```typescript -public readonly props: CfnPrivateEndPointRegionalModeProps; +public readonly props: CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps; ``` -- *Type:* CfnPrivateEndPointRegionalModeProps +- *Type:* CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps Resource props. @@ -22454,11 +22441,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -22470,27 +22457,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnPrivateEndpointService +### CfnProject -A CloudFormation `MongoDB::Atlas::PrivateEndpointService`. +A CloudFormation `MongoDB::Atlas::Project`. -#### Initializers +#### Initializers ```typescript -import { CfnPrivateEndpointService } from 'awscdk-resources-mongodbatlas' +import { CfnProject } from 'awscdk-resources-mongodbatlas' -new CfnPrivateEndpointService(scope: Construct, id: string, props: CfnPrivateEndpointServiceProps) +new CfnProject(scope: Construct, id: string, props: CfnProjectProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnPrivateEndpointServiceProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnProjectProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -22498,7 +22485,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -22506,9 +22493,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnPrivateEndpointServiceProps +- *Type:* CfnProjectProps resource properties. @@ -22518,26 +22505,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -22545,7 +22532,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -22553,7 +22540,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -22561,7 +22548,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -22569,7 +22556,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -22577,7 +22564,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -22588,13 +22575,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -22602,13 +22589,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -22626,19 +22613,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -22688,7 +22675,7 @@ 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 +###### `path`Required - *Type:* string @@ -22699,7 +22686,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -22709,7 +22696,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -22717,7 +22704,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -22725,7 +22712,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -22735,7 +22722,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -22743,7 +22730,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -22751,7 +22738,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -22772,19 +22759,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -22795,7 +22782,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -22803,13 +22790,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -22827,13 +22814,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -22844,7 +22831,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -22852,7 +22839,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -22863,13 +22850,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -22877,7 +22864,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -22885,7 +22872,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -22897,23 +22884,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnPrivateEndpointService } from 'awscdk-resources-mongodbatlas' +import { CfnProject } from 'awscdk-resources-mongodbatlas' -CfnPrivateEndpointService.isConstruct(x: any) +CfnProject.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -22921,12 +22908,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnPrivateEndpointService } from 'awscdk-resources-mongodbatlas' +import { CfnProject } from 'awscdk-resources-mongodbatlas' -CfnPrivateEndpointService.isCfnElement(x: any) +CfnProject.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -22934,23 +22921,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnPrivateEndpointService } from 'awscdk-resources-mongodbatlas' +import { CfnProject } from 'awscdk-resources-mongodbatlas' -CfnPrivateEndpointService.isCfnResource(x: any) +CfnProject.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -22960,23 +22947,21 @@ Check whether the given object is a CfnResource. | **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. | -| attrEndpointServiceName | string | Attribute `MongoDB::Atlas::PrivateEndpointService.EndpointServiceName`. | -| attrErrorMessage | string | Attribute `MongoDB::Atlas::PrivateEndpointService.ErrorMessage`. | -| attrId | string | Attribute `MongoDB::Atlas::PrivateEndpointService.Id`. | -| attrInterfaceEndpoints | string[] | Attribute `MongoDB::Atlas::PrivateEndpointService.InterfaceEndpoints`. | -| attrStatus | string | Attribute `MongoDB::Atlas::PrivateEndpointService.Status`. | -| props | CfnPrivateEndpointServiceProps | Resource props. | +| 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. | +| attrClusterCount | number | Attribute `MongoDB::Atlas::Project.ClusterCount`. | +| attrCreated | string | Attribute `MongoDB::Atlas::Project.Created`. | +| attrId | string | Attribute `MongoDB::Atlas::Project.Id`. | +| props | CfnProjectProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -22988,7 +22973,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -22998,7 +22983,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -23015,7 +23000,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -23029,7 +23014,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -23044,7 +23029,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -23056,7 +23041,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -23068,31 +23053,31 @@ AWS resource type. --- -##### `attrEndpointServiceName`Required +##### `attrClusterCount`Required ```typescript -public readonly attrEndpointServiceName: string; +public readonly attrClusterCount: number; ``` -- *Type:* string +- *Type:* number -Attribute `MongoDB::Atlas::PrivateEndpointService.EndpointServiceName`. +Attribute `MongoDB::Atlas::Project.ClusterCount`. --- -##### `attrErrorMessage`Required +##### `attrCreated`Required ```typescript -public readonly attrErrorMessage: string; +public readonly attrCreated: string; ``` - *Type:* string -Attribute `MongoDB::Atlas::PrivateEndpointService.ErrorMessage`. +Attribute `MongoDB::Atlas::Project.Created`. --- -##### `attrId`Required +##### `attrId`Required ```typescript public readonly attrId: string; @@ -23100,41 +23085,17 @@ public readonly attrId: string; - *Type:* string -Attribute `MongoDB::Atlas::PrivateEndpointService.Id`. - ---- - -##### `attrInterfaceEndpoints`Required - -```typescript -public readonly attrInterfaceEndpoints: string[]; -``` - -- *Type:* string[] - -Attribute `MongoDB::Atlas::PrivateEndpointService.InterfaceEndpoints`. - ---- - -##### `attrStatus`Required - -```typescript -public readonly attrStatus: string; -``` - -- *Type:* string - -Attribute `MongoDB::Atlas::PrivateEndpointService.Status`. +Attribute `MongoDB::Atlas::Project.Id`. --- -##### `props`Required +##### `props`Required ```typescript -public readonly props: CfnPrivateEndpointServiceProps; +public readonly props: CfnProjectProps; ``` -- *Type:* CfnPrivateEndpointServiceProps +- *Type:* CfnProjectProps Resource props. @@ -23144,11 +23105,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -23160,27 +23121,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnPrivatelinkEndpointServiceDataFederationOnlineArchive +### CfnProjectInvitation -A CloudFormation `MongoDB::Atlas::PrivatelinkEndpointServiceDataFederationOnlineArchive`. +A CloudFormation `MongoDB::Atlas::ProjectInvitation`. -#### Initializers +#### Initializers ```typescript -import { CfnPrivatelinkEndpointServiceDataFederationOnlineArchive } from 'awscdk-resources-mongodbatlas' +import { CfnProjectInvitation } from 'awscdk-resources-mongodbatlas' -new CfnPrivatelinkEndpointServiceDataFederationOnlineArchive(scope: Construct, id: string, props: CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps) +new CfnProjectInvitation(scope: Construct, id: string, props: CfnProjectInvitationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnProjectInvitationProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -23188,7 +23149,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -23196,9 +23157,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps +- *Type:* CfnProjectInvitationProps resource properties. @@ -23208,26 +23169,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -23235,7 +23196,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -23243,7 +23204,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -23251,7 +23212,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -23259,7 +23220,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -23267,7 +23228,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -23278,13 +23239,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -23292,13 +23253,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -23316,19 +23277,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -23378,7 +23339,7 @@ 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 +###### `path`Required - *Type:* string @@ -23389,7 +23350,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -23399,7 +23360,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -23407,7 +23368,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -23415,7 +23376,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -23425,7 +23386,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -23433,7 +23394,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -23441,7 +23402,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -23462,19 +23423,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -23485,7 +23446,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -23493,13 +23454,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -23517,13 +23478,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -23534,7 +23495,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -23542,7 +23503,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -23553,13 +23514,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -23567,7 +23528,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -23575,7 +23536,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -23587,23 +23548,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnPrivatelinkEndpointServiceDataFederationOnlineArchive } from 'awscdk-resources-mongodbatlas' +import { CfnProjectInvitation } from 'awscdk-resources-mongodbatlas' -CfnPrivatelinkEndpointServiceDataFederationOnlineArchive.isConstruct(x: any) +CfnProjectInvitation.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -23611,12 +23572,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnPrivatelinkEndpointServiceDataFederationOnlineArchive } from 'awscdk-resources-mongodbatlas' +import { CfnProjectInvitation } from 'awscdk-resources-mongodbatlas' -CfnPrivatelinkEndpointServiceDataFederationOnlineArchive.isCfnElement(x: any) +CfnProjectInvitation.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -23624,23 +23585,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnPrivatelinkEndpointServiceDataFederationOnlineArchive } from 'awscdk-resources-mongodbatlas' +import { CfnProjectInvitation } from 'awscdk-resources-mongodbatlas' -CfnPrivatelinkEndpointServiceDataFederationOnlineArchive.isCfnResource(x: any) +CfnProjectInvitation.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -23650,18 +23611,22 @@ Check whether the given object is a CfnResource. | **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 | CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps | Resource props. | +| 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. | +| attrCreatedAt | string | Attribute `MongoDB::Atlas::ProjectInvitation.CreatedAt`. | +| attrExpiresAt | string | Attribute `MongoDB::Atlas::ProjectInvitation.ExpiresAt`. | +| attrId | string | Attribute `MongoDB::Atlas::ProjectInvitation.Id`. | +| attrInviterUsername | string | Attribute `MongoDB::Atlas::ProjectInvitation.InviterUsername`. | +| props | CfnProjectInvitationProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -23673,7 +23638,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -23683,7 +23648,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -23700,7 +23665,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -23714,7 +23679,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -23729,7 +23694,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -23741,7 +23706,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -23753,13 +23718,61 @@ AWS resource type. --- -##### `props`Required +##### `attrCreatedAt`Required ```typescript -public readonly props: CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps; +public readonly attrCreatedAt: string; ``` -- *Type:* CfnPrivatelinkEndpointServiceDataFederationOnlineArchiveProps +- *Type:* string + +Attribute `MongoDB::Atlas::ProjectInvitation.CreatedAt`. + +--- + +##### `attrExpiresAt`Required + +```typescript +public readonly attrExpiresAt: string; +``` + +- *Type:* string + +Attribute `MongoDB::Atlas::ProjectInvitation.ExpiresAt`. + +--- + +##### `attrId`Required + +```typescript +public readonly attrId: string; +``` + +- *Type:* string + +Attribute `MongoDB::Atlas::ProjectInvitation.Id`. + +--- + +##### `attrInviterUsername`Required + +```typescript +public readonly attrInviterUsername: string; +``` + +- *Type:* string + +Attribute `MongoDB::Atlas::ProjectInvitation.InviterUsername`. + +--- + +##### `props`Required + +```typescript +public readonly props: CfnProjectInvitationProps; +``` + +- *Type:* CfnProjectInvitationProps Resource props. @@ -23769,11 +23782,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -23785,27 +23798,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnProject +### CfnProjectIpAccessList -A CloudFormation `MongoDB::Atlas::Project`. +A CloudFormation `MongoDB::Atlas::ProjectIpAccessList`. -#### Initializers +#### Initializers ```typescript -import { CfnProject } from 'awscdk-resources-mongodbatlas' +import { CfnProjectIpAccessList } from 'awscdk-resources-mongodbatlas' -new CfnProject(scope: Construct, id: string, props: CfnProjectProps) +new CfnProjectIpAccessList(scope: Construct, id: string, props: CfnProjectIpAccessListProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnProjectProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnProjectIpAccessListProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -23813,7 +23826,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -23821,9 +23834,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnProjectProps +- *Type:* CfnProjectIpAccessListProps resource properties. @@ -23833,26 +23846,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -23860,7 +23873,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -23868,7 +23881,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -23876,7 +23889,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -23884,7 +23897,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -23892,7 +23905,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -23903,13 +23916,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -23917,13 +23930,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -23941,19 +23954,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -24003,7 +24016,7 @@ 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 +###### `path`Required - *Type:* string @@ -24014,7 +24027,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -24024,7 +24037,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -24032,7 +24045,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -24040,7 +24053,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -24050,7 +24063,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -24058,7 +24071,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -24066,7 +24079,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -24087,19 +24100,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -24110,7 +24123,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -24118,13 +24131,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -24142,13 +24155,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -24159,7 +24172,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -24167,7 +24180,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -24178,13 +24191,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -24192,7 +24205,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -24200,7 +24213,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -24212,23 +24225,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnProject } from 'awscdk-resources-mongodbatlas' +import { CfnProjectIpAccessList } from 'awscdk-resources-mongodbatlas' -CfnProject.isConstruct(x: any) +CfnProjectIpAccessList.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -24236,12 +24249,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnProject } from 'awscdk-resources-mongodbatlas' +import { CfnProjectIpAccessList } from 'awscdk-resources-mongodbatlas' -CfnProject.isCfnElement(x: any) +CfnProjectIpAccessList.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -24249,23 +24262,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnProject } from 'awscdk-resources-mongodbatlas' +import { CfnProjectIpAccessList } from 'awscdk-resources-mongodbatlas' -CfnProject.isCfnResource(x: any) +CfnProjectIpAccessList.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -24275,21 +24288,19 @@ Check whether the given object is a CfnResource. | **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. | -| attrClusterCount | number | Attribute `MongoDB::Atlas::Project.ClusterCount`. | -| attrCreated | string | Attribute `MongoDB::Atlas::Project.Created`. | -| attrId | string | Attribute `MongoDB::Atlas::Project.Id`. | -| props | CfnProjectProps | Resource props. | +| 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. | +| attrTotalCount | number | Attribute `MongoDB::Atlas::ProjectIpAccessList.TotalCount`. | +| props | CfnProjectIpAccessListProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -24301,7 +24312,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -24311,7 +24322,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -24328,7 +24339,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -24342,7 +24353,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -24357,7 +24368,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -24369,7 +24380,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -24381,49 +24392,25 @@ AWS resource type. --- -##### `attrClusterCount`Required +##### `attrTotalCount`Required ```typescript -public readonly attrClusterCount: number; +public readonly attrTotalCount: number; ``` - *Type:* number -Attribute `MongoDB::Atlas::Project.ClusterCount`. - ---- - -##### `attrCreated`Required - -```typescript -public readonly attrCreated: string; -``` - -- *Type:* string - -Attribute `MongoDB::Atlas::Project.Created`. - ---- - -##### `attrId`Required - -```typescript -public readonly attrId: string; -``` - -- *Type:* string - -Attribute `MongoDB::Atlas::Project.Id`. +Attribute `MongoDB::Atlas::ProjectIpAccessList.TotalCount`. --- -##### `props`Required +##### `props`Required ```typescript -public readonly props: CfnProjectProps; +public readonly props: CfnProjectIpAccessListProps; ``` -- *Type:* CfnProjectProps +- *Type:* CfnProjectIpAccessListProps Resource props. @@ -24433,11 +24420,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -24449,27 +24436,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnProjectInvitation +### CfnResourcePolicy -A CloudFormation `MongoDB::Atlas::ProjectInvitation`. +A CloudFormation `MongoDB::Atlas::ResourcePolicy`. -#### Initializers +#### Initializers ```typescript -import { CfnProjectInvitation } from 'awscdk-resources-mongodbatlas' +import { CfnResourcePolicy } from 'awscdk-resources-mongodbatlas' -new CfnProjectInvitation(scope: Construct, id: string, props: CfnProjectInvitationProps) +new CfnResourcePolicy(scope: Construct, id: string, props: CfnResourcePolicyProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnProjectInvitationProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnResourcePolicyProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -24477,7 +24464,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -24485,9 +24472,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnProjectInvitationProps +- *Type:* CfnResourcePolicyProps resource properties. @@ -24497,26 +24484,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -24524,7 +24511,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -24532,7 +24519,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -24540,7 +24527,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -24548,7 +24535,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -24556,7 +24543,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -24567,13 +24554,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -24581,13 +24568,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -24605,19 +24592,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -24667,7 +24654,7 @@ 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 +###### `path`Required - *Type:* string @@ -24678,7 +24665,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -24688,7 +24675,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -24696,7 +24683,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -24704,7 +24691,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -24714,7 +24701,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -24722,7 +24709,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -24730,7 +24717,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -24751,19 +24738,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -24774,7 +24761,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -24782,13 +24769,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -24806,13 +24793,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -24823,7 +24810,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -24831,7 +24818,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -24842,13 +24829,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -24856,7 +24843,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -24864,7 +24851,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -24876,23 +24863,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnProjectInvitation } from 'awscdk-resources-mongodbatlas' +import { CfnResourcePolicy } from 'awscdk-resources-mongodbatlas' -CfnProjectInvitation.isConstruct(x: any) +CfnResourcePolicy.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -24900,12 +24887,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnProjectInvitation } from 'awscdk-resources-mongodbatlas' +import { CfnResourcePolicy } from 'awscdk-resources-mongodbatlas' -CfnProjectInvitation.isCfnElement(x: any) +CfnResourcePolicy.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -24913,23 +24900,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnProjectInvitation } from 'awscdk-resources-mongodbatlas' +import { CfnResourcePolicy } from 'awscdk-resources-mongodbatlas' -CfnProjectInvitation.isCfnResource(x: any) +CfnResourcePolicy.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -24939,22 +24926,22 @@ Check whether the given object is a CfnResource. | **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. | -| attrCreatedAt | string | Attribute `MongoDB::Atlas::ProjectInvitation.CreatedAt`. | -| attrExpiresAt | string | Attribute `MongoDB::Atlas::ProjectInvitation.ExpiresAt`. | -| attrId | string | Attribute `MongoDB::Atlas::ProjectInvitation.Id`. | -| attrInviterUsername | string | Attribute `MongoDB::Atlas::ProjectInvitation.InviterUsername`. | -| props | CfnProjectInvitationProps | Resource props. | +| 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. | +| attrCreatedDate | string | Attribute `MongoDB::Atlas::ResourcePolicy.CreatedDate`. | +| attrId | string | Attribute `MongoDB::Atlas::ResourcePolicy.Id`. | +| attrLastUpdatedDate | string | Attribute `MongoDB::Atlas::ResourcePolicy.LastUpdatedDate`. | +| attrVersion | string | Attribute `MongoDB::Atlas::ResourcePolicy.Version`. | +| props | CfnResourcePolicyProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -24966,7 +24953,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -24976,7 +24963,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -24993,7 +24980,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -25007,7 +24994,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -25022,7 +25009,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -25034,7 +25021,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -25046,61 +25033,61 @@ AWS resource type. --- -##### `attrCreatedAt`Required +##### `attrCreatedDate`Required ```typescript -public readonly attrCreatedAt: string; +public readonly attrCreatedDate: string; ``` - *Type:* string -Attribute `MongoDB::Atlas::ProjectInvitation.CreatedAt`. +Attribute `MongoDB::Atlas::ResourcePolicy.CreatedDate`. --- -##### `attrExpiresAt`Required +##### `attrId`Required ```typescript -public readonly attrExpiresAt: string; +public readonly attrId: string; ``` - *Type:* string -Attribute `MongoDB::Atlas::ProjectInvitation.ExpiresAt`. +Attribute `MongoDB::Atlas::ResourcePolicy.Id`. --- -##### `attrId`Required +##### `attrLastUpdatedDate`Required ```typescript -public readonly attrId: string; +public readonly attrLastUpdatedDate: string; ``` - *Type:* string -Attribute `MongoDB::Atlas::ProjectInvitation.Id`. +Attribute `MongoDB::Atlas::ResourcePolicy.LastUpdatedDate`. --- -##### `attrInviterUsername`Required +##### `attrVersion`Required ```typescript -public readonly attrInviterUsername: string; +public readonly attrVersion: string; ``` - *Type:* string -Attribute `MongoDB::Atlas::ProjectInvitation.InviterUsername`. +Attribute `MongoDB::Atlas::ResourcePolicy.Version`. --- -##### `props`Required +##### `props`Required ```typescript -public readonly props: CfnProjectInvitationProps; +public readonly props: CfnResourcePolicyProps; ``` -- *Type:* CfnProjectInvitationProps +- *Type:* CfnResourcePolicyProps Resource props. @@ -25110,11 +25097,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -25126,27 +25113,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnProjectIpAccessList +### CfnSearchDeployment -A CloudFormation `MongoDB::Atlas::ProjectIpAccessList`. +A CloudFormation `MongoDB::Atlas::SearchDeployment`. -#### Initializers +#### Initializers ```typescript -import { CfnProjectIpAccessList } from 'awscdk-resources-mongodbatlas' +import { CfnSearchDeployment } from 'awscdk-resources-mongodbatlas' -new CfnProjectIpAccessList(scope: Construct, id: string, props: CfnProjectIpAccessListProps) +new CfnSearchDeployment(scope: Construct, id: string, props: CfnSearchDeploymentProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnProjectIpAccessListProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnSearchDeploymentProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -25154,7 +25141,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -25162,9 +25149,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnProjectIpAccessListProps +- *Type:* CfnSearchDeploymentProps resource properties. @@ -25174,26 +25161,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -25201,7 +25188,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -25209,7 +25196,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -25217,7 +25204,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -25225,7 +25212,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -25233,7 +25220,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -25244,13 +25231,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -25258,13 +25245,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -25282,19 +25269,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -25344,7 +25331,7 @@ 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 +###### `path`Required - *Type:* string @@ -25355,7 +25342,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -25365,7 +25352,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -25373,7 +25360,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -25381,7 +25368,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -25391,7 +25378,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -25399,7 +25386,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -25407,7 +25394,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -25428,19 +25415,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -25451,7 +25438,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -25459,13 +25446,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -25483,13 +25470,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -25500,7 +25487,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -25508,7 +25495,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -25519,13 +25506,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -25533,7 +25520,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -25541,7 +25528,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -25553,23 +25540,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnProjectIpAccessList } from 'awscdk-resources-mongodbatlas' +import { CfnSearchDeployment } from 'awscdk-resources-mongodbatlas' -CfnProjectIpAccessList.isConstruct(x: any) +CfnSearchDeployment.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -25577,12 +25564,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnProjectIpAccessList } from 'awscdk-resources-mongodbatlas' +import { CfnSearchDeployment } from 'awscdk-resources-mongodbatlas' -CfnProjectIpAccessList.isCfnElement(x: any) +CfnSearchDeployment.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -25590,23 +25577,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnProjectIpAccessList } from 'awscdk-resources-mongodbatlas' +import { CfnSearchDeployment } from 'awscdk-resources-mongodbatlas' -CfnProjectIpAccessList.isCfnResource(x: any) +CfnSearchDeployment.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -25616,19 +25603,20 @@ Check whether the given object is a CfnResource. | **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. | -| attrTotalCount | number | Attribute `MongoDB::Atlas::ProjectIpAccessList.TotalCount`. | -| props | CfnProjectIpAccessListProps | Resource props. | +| 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. | +| attrId | string | Attribute `MongoDB::Atlas::SearchDeployment.Id`. | +| attrStateName | string | Attribute `MongoDB::Atlas::SearchDeployment.StateName`. | +| props | CfnSearchDeploymentProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -25640,7 +25628,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -25650,7 +25638,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -25667,7 +25655,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -25681,7 +25669,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -25696,7 +25684,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -25708,7 +25696,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -25720,25 +25708,37 @@ AWS resource type. --- -##### `attrTotalCount`Required +##### `attrId`Required ```typescript -public readonly attrTotalCount: number; +public readonly attrId: string; ``` -- *Type:* number +- *Type:* string -Attribute `MongoDB::Atlas::ProjectIpAccessList.TotalCount`. +Attribute `MongoDB::Atlas::SearchDeployment.Id`. --- -##### `props`Required +##### `attrStateName`Required ```typescript -public readonly props: CfnProjectIpAccessListProps; +public readonly attrStateName: string; ``` -- *Type:* CfnProjectIpAccessListProps +- *Type:* string + +Attribute `MongoDB::Atlas::SearchDeployment.StateName`. + +--- + +##### `props`Required + +```typescript +public readonly props: CfnSearchDeploymentProps; +``` + +- *Type:* CfnSearchDeploymentProps Resource props. @@ -25748,11 +25748,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -25764,27 +25764,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnResourcePolicy +### CfnSearchIndex -A CloudFormation `MongoDB::Atlas::ResourcePolicy`. +A CloudFormation `MongoDB::Atlas::SearchIndex`. -#### Initializers +#### Initializers ```typescript -import { CfnResourcePolicy } from 'awscdk-resources-mongodbatlas' +import { CfnSearchIndex } from 'awscdk-resources-mongodbatlas' -new CfnResourcePolicy(scope: Construct, id: string, props: CfnResourcePolicyProps) +new CfnSearchIndex(scope: Construct, id: string, props: CfnSearchIndexProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnResourcePolicyProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnSearchIndexProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -25792,7 +25792,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -25800,9 +25800,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnResourcePolicyProps +- *Type:* CfnSearchIndexProps resource properties. @@ -25812,26 +25812,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -25839,7 +25839,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -25847,7 +25847,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -25855,7 +25855,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -25863,7 +25863,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -25871,7 +25871,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -25882,13 +25882,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -25896,13 +25896,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -25920,19 +25920,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -25982,7 +25982,7 @@ 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 +###### `path`Required - *Type:* string @@ -25993,7 +25993,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -26003,7 +26003,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -26011,7 +26011,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -26019,7 +26019,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -26029,7 +26029,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -26037,7 +26037,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -26045,7 +26045,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -26066,19 +26066,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -26089,7 +26089,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -26097,13 +26097,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -26121,13 +26121,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -26138,7 +26138,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -26146,7 +26146,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -26157,13 +26157,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -26171,7 +26171,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -26179,7 +26179,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -26191,23 +26191,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnResourcePolicy } from 'awscdk-resources-mongodbatlas' +import { CfnSearchIndex } from 'awscdk-resources-mongodbatlas' -CfnResourcePolicy.isConstruct(x: any) +CfnSearchIndex.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -26215,12 +26215,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnResourcePolicy } from 'awscdk-resources-mongodbatlas' +import { CfnSearchIndex } from 'awscdk-resources-mongodbatlas' -CfnResourcePolicy.isCfnElement(x: any) +CfnSearchIndex.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -26228,23 +26228,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnResourcePolicy } from 'awscdk-resources-mongodbatlas' +import { CfnSearchIndex } from 'awscdk-resources-mongodbatlas' -CfnResourcePolicy.isCfnResource(x: any) +CfnSearchIndex.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -26254,22 +26254,20 @@ Check whether the given object is a CfnResource. | **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. | -| attrCreatedDate | string | Attribute `MongoDB::Atlas::ResourcePolicy.CreatedDate`. | -| attrId | string | Attribute `MongoDB::Atlas::ResourcePolicy.Id`. | -| attrLastUpdatedDate | string | Attribute `MongoDB::Atlas::ResourcePolicy.LastUpdatedDate`. | -| attrVersion | string | Attribute `MongoDB::Atlas::ResourcePolicy.Version`. | -| props | CfnResourcePolicyProps | Resource props. | +| 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. | +| attrIndexId | string | Attribute `MongoDB::Atlas::SearchIndex.IndexId`. | +| attrStatus | string | Attribute `MongoDB::Atlas::SearchIndex.Status`. | +| props | CfnSearchIndexProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -26281,7 +26279,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -26291,7 +26289,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -26308,7 +26306,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -26322,7 +26320,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -26337,7 +26335,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -26349,7 +26347,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -26361,61 +26359,37 @@ AWS resource type. --- -##### `attrCreatedDate`Required - -```typescript -public readonly attrCreatedDate: string; -``` - -- *Type:* string - -Attribute `MongoDB::Atlas::ResourcePolicy.CreatedDate`. - ---- - -##### `attrId`Required - -```typescript -public readonly attrId: string; -``` - -- *Type:* string - -Attribute `MongoDB::Atlas::ResourcePolicy.Id`. - ---- - -##### `attrLastUpdatedDate`Required +##### `attrIndexId`Required ```typescript -public readonly attrLastUpdatedDate: string; +public readonly attrIndexId: string; ``` - *Type:* string -Attribute `MongoDB::Atlas::ResourcePolicy.LastUpdatedDate`. +Attribute `MongoDB::Atlas::SearchIndex.IndexId`. --- -##### `attrVersion`Required +##### `attrStatus`Required ```typescript -public readonly attrVersion: string; +public readonly attrStatus: string; ``` - *Type:* string -Attribute `MongoDB::Atlas::ResourcePolicy.Version`. +Attribute `MongoDB::Atlas::SearchIndex.Status`. --- -##### `props`Required +##### `props`Required ```typescript -public readonly props: CfnResourcePolicyProps; +public readonly props: CfnSearchIndexProps; ``` -- *Type:* CfnResourcePolicyProps +- *Type:* CfnSearchIndexProps Resource props. @@ -26425,11 +26399,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -26441,27 +26415,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnSearchDeployment +### CfnServerlessInstance -A CloudFormation `MongoDB::Atlas::SearchDeployment`. +A CloudFormation `MongoDB::Atlas::ServerlessInstance`. -#### Initializers +#### Initializers ```typescript -import { CfnSearchDeployment } from 'awscdk-resources-mongodbatlas' +import { CfnServerlessInstance } from 'awscdk-resources-mongodbatlas' -new CfnSearchDeployment(scope: Construct, id: string, props: CfnSearchDeploymentProps) +new CfnServerlessInstance(scope: Construct, id: string, props: CfnServerlessInstanceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnSearchDeploymentProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnServerlessInstanceProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -26469,7 +26443,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -26477,9 +26451,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnSearchDeploymentProps +- *Type:* CfnServerlessInstanceProps resource properties. @@ -26489,26 +26463,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -26516,7 +26490,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -26524,7 +26498,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -26532,7 +26506,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -26540,7 +26514,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -26548,7 +26522,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -26559,13 +26533,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -26573,13 +26547,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -26597,19 +26571,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -26659,7 +26633,7 @@ 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 +###### `path`Required - *Type:* string @@ -26670,7 +26644,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -26680,7 +26654,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -26688,7 +26662,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -26696,7 +26670,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -26706,7 +26680,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -26714,7 +26688,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -26722,7 +26696,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -26743,19 +26717,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -26766,7 +26740,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -26774,13 +26748,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -26798,13 +26772,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -26815,7 +26789,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -26823,7 +26797,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -26834,13 +26808,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -26848,7 +26822,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -26856,7 +26830,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -26868,23 +26842,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnSearchDeployment } from 'awscdk-resources-mongodbatlas' +import { CfnServerlessInstance } from 'awscdk-resources-mongodbatlas' -CfnSearchDeployment.isConstruct(x: any) +CfnServerlessInstance.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -26892,12 +26866,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnSearchDeployment } from 'awscdk-resources-mongodbatlas' +import { CfnServerlessInstance } from 'awscdk-resources-mongodbatlas' -CfnSearchDeployment.isCfnElement(x: any) +CfnServerlessInstance.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -26905,23 +26879,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnSearchDeployment } from 'awscdk-resources-mongodbatlas' +import { CfnServerlessInstance } from 'awscdk-resources-mongodbatlas' -CfnSearchDeployment.isCfnResource(x: any) +CfnServerlessInstance.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -26931,20 +26905,23 @@ Check whether the given object is a CfnResource. | **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. | -| attrId | string | Attribute `MongoDB::Atlas::SearchDeployment.Id`. | -| attrStateName | string | Attribute `MongoDB::Atlas::SearchDeployment.StateName`. | -| props | CfnSearchDeploymentProps | Resource props. | +| 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. | +| attrCreateDate | string | Attribute `MongoDB::Atlas::ServerlessInstance.CreateDate`. | +| attrId | string | Attribute `MongoDB::Atlas::ServerlessInstance.Id`. | +| attrMongoDBVersion | string | Attribute `MongoDB::Atlas::ServerlessInstance.MongoDBVersion`. | +| attrStateName | string | Attribute `MongoDB::Atlas::ServerlessInstance.StateName`. | +| attrTotalCount | number | Attribute `MongoDB::Atlas::ServerlessInstance.TotalCount`. | +| props | CfnServerlessInstanceProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -26956,7 +26933,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -26966,7 +26943,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -26983,7 +26960,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -26997,7 +26974,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -27012,7 +26989,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -27024,7 +27001,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -27036,7 +27013,19 @@ AWS resource type. --- -##### `attrId`Required +##### `attrCreateDate`Required + +```typescript +public readonly attrCreateDate: string; +``` + +- *Type:* string + +Attribute `MongoDB::Atlas::ServerlessInstance.CreateDate`. + +--- + +##### `attrId`Required ```typescript public readonly attrId: string; @@ -27044,11 +27033,23 @@ public readonly attrId: string; - *Type:* string -Attribute `MongoDB::Atlas::SearchDeployment.Id`. +Attribute `MongoDB::Atlas::ServerlessInstance.Id`. --- -##### `attrStateName`Required +##### `attrMongoDBVersion`Required + +```typescript +public readonly attrMongoDBVersion: string; +``` + +- *Type:* string + +Attribute `MongoDB::Atlas::ServerlessInstance.MongoDBVersion`. + +--- + +##### `attrStateName`Required ```typescript public readonly attrStateName: string; @@ -27056,17 +27057,29 @@ public readonly attrStateName: string; - *Type:* string -Attribute `MongoDB::Atlas::SearchDeployment.StateName`. +Attribute `MongoDB::Atlas::ServerlessInstance.StateName`. --- -##### `props`Required +##### `attrTotalCount`Required ```typescript -public readonly props: CfnSearchDeploymentProps; +public readonly attrTotalCount: number; ``` -- *Type:* CfnSearchDeploymentProps +- *Type:* number + +Attribute `MongoDB::Atlas::ServerlessInstance.TotalCount`. + +--- + +##### `props`Required + +```typescript +public readonly props: CfnServerlessInstanceProps; +``` + +- *Type:* CfnServerlessInstanceProps Resource props. @@ -27076,11 +27089,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -27092,27 +27105,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnSearchIndex +### CfnServerlessPrivateEndpoint -A CloudFormation `MongoDB::Atlas::SearchIndex`. +A CloudFormation `MongoDB::Atlas::ServerlessPrivateEndpoint`. -#### Initializers +#### Initializers ```typescript -import { CfnSearchIndex } from 'awscdk-resources-mongodbatlas' +import { CfnServerlessPrivateEndpoint } from 'awscdk-resources-mongodbatlas' -new CfnSearchIndex(scope: Construct, id: string, props: CfnSearchIndexProps) +new CfnServerlessPrivateEndpoint(scope: Construct, id: string, props: CfnServerlessPrivateEndpointProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnSearchIndexProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnServerlessPrivateEndpointProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -27120,7 +27133,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -27128,9 +27141,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnSearchIndexProps +- *Type:* CfnServerlessPrivateEndpointProps resource properties. @@ -27140,26 +27153,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -27167,7 +27180,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -27175,7 +27188,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -27183,7 +27196,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -27191,7 +27204,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -27199,7 +27212,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -27210,13 +27223,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -27224,13 +27237,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -27248,19 +27261,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -27310,7 +27323,7 @@ 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 +###### `path`Required - *Type:* string @@ -27321,7 +27334,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -27331,7 +27344,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -27339,7 +27352,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -27347,7 +27360,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -27357,7 +27370,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -27365,7 +27378,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -27373,7 +27386,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -27394,19 +27407,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -27417,7 +27430,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -27425,13 +27438,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -27449,13 +27462,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -27466,7 +27479,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -27474,7 +27487,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -27485,13 +27498,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -27499,7 +27512,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -27507,7 +27520,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -27519,23 +27532,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnSearchIndex } from 'awscdk-resources-mongodbatlas' +import { CfnServerlessPrivateEndpoint } from 'awscdk-resources-mongodbatlas' -CfnSearchIndex.isConstruct(x: any) +CfnServerlessPrivateEndpoint.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -27543,12 +27556,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnSearchIndex } from 'awscdk-resources-mongodbatlas' +import { CfnServerlessPrivateEndpoint } from 'awscdk-resources-mongodbatlas' -CfnSearchIndex.isCfnElement(x: any) +CfnServerlessPrivateEndpoint.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -27556,23 +27569,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnSearchIndex } from 'awscdk-resources-mongodbatlas' +import { CfnServerlessPrivateEndpoint } from 'awscdk-resources-mongodbatlas' -CfnSearchIndex.isCfnResource(x: any) +CfnServerlessPrivateEndpoint.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -27582,20 +27595,24 @@ Check whether the given object is a CfnResource. | **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. | -| attrIndexId | string | Attribute `MongoDB::Atlas::SearchIndex.IndexId`. | -| attrStatus | string | Attribute `MongoDB::Atlas::SearchIndex.Status`. | -| props | CfnSearchIndexProps | Resource props. | +| 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. | +| attrAwsPrivateEndpointMetaData | string | Attribute `MongoDB::Atlas::ServerlessPrivateEndpoint.AwsPrivateEndpointMetaData`. | +| attrEndpointServiceName | string | Attribute `MongoDB::Atlas::ServerlessPrivateEndpoint.EndpointServiceName`. | +| attrErrorMessage | string | Attribute `MongoDB::Atlas::ServerlessPrivateEndpoint.ErrorMessage`. | +| attrId | string | Attribute `MongoDB::Atlas::ServerlessPrivateEndpoint.Id`. | +| attrProviderName | string | Attribute `MongoDB::Atlas::ServerlessPrivateEndpoint.ProviderName`. | +| attrStatus | string | Attribute `MongoDB::Atlas::ServerlessPrivateEndpoint.Status`. | +| props | CfnServerlessPrivateEndpointProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -27607,7 +27624,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -27617,7 +27634,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -27634,7 +27651,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -27648,7 +27665,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -27663,7 +27680,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -27675,7 +27692,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -27687,19 +27704,67 @@ AWS resource type. --- -##### `attrIndexId`Required +##### `attrAwsPrivateEndpointMetaData`Required ```typescript -public readonly attrIndexId: string; +public readonly attrAwsPrivateEndpointMetaData: string; ``` - *Type:* string -Attribute `MongoDB::Atlas::SearchIndex.IndexId`. +Attribute `MongoDB::Atlas::ServerlessPrivateEndpoint.AwsPrivateEndpointMetaData`. --- -##### `attrStatus`Required +##### `attrEndpointServiceName`Required + +```typescript +public readonly attrEndpointServiceName: string; +``` + +- *Type:* string + +Attribute `MongoDB::Atlas::ServerlessPrivateEndpoint.EndpointServiceName`. + +--- + +##### `attrErrorMessage`Required + +```typescript +public readonly attrErrorMessage: string; +``` + +- *Type:* string + +Attribute `MongoDB::Atlas::ServerlessPrivateEndpoint.ErrorMessage`. + +--- + +##### `attrId`Required + +```typescript +public readonly attrId: string; +``` + +- *Type:* string + +Attribute `MongoDB::Atlas::ServerlessPrivateEndpoint.Id`. + +--- + +##### `attrProviderName`Required + +```typescript +public readonly attrProviderName: string; +``` + +- *Type:* string + +Attribute `MongoDB::Atlas::ServerlessPrivateEndpoint.ProviderName`. + +--- + +##### `attrStatus`Required ```typescript public readonly attrStatus: string; @@ -27707,17 +27772,17 @@ public readonly attrStatus: string; - *Type:* string -Attribute `MongoDB::Atlas::SearchIndex.Status`. +Attribute `MongoDB::Atlas::ServerlessPrivateEndpoint.Status`. --- -##### `props`Required +##### `props`Required ```typescript -public readonly props: CfnSearchIndexProps; +public readonly props: CfnServerlessPrivateEndpointProps; ``` -- *Type:* CfnSearchIndexProps +- *Type:* CfnServerlessPrivateEndpointProps Resource props. @@ -27727,11 +27792,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -27743,27 +27808,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnServerlessInstance +### CfnStreamConnection -A CloudFormation `MongoDB::Atlas::ServerlessInstance`. +A CloudFormation `MongoDB::Atlas::StreamConnection`. -#### Initializers +#### Initializers ```typescript -import { CfnServerlessInstance } from 'awscdk-resources-mongodbatlas' +import { CfnStreamConnection } from 'awscdk-resources-mongodbatlas' -new CfnServerlessInstance(scope: Construct, id: string, props: CfnServerlessInstanceProps) +new CfnStreamConnection(scope: Construct, id: string, props: CfnStreamConnectionProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnServerlessInstanceProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnStreamConnectionProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -27771,7 +27836,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -27779,9 +27844,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnServerlessInstanceProps +- *Type:* CfnStreamConnectionProps resource properties. @@ -27791,26 +27856,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -27818,7 +27883,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -27826,7 +27891,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -27834,7 +27899,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -27842,7 +27907,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -27850,7 +27915,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -27861,13 +27926,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -27875,13 +27940,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -27899,19 +27964,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -27961,7 +28026,7 @@ 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 +###### `path`Required - *Type:* string @@ -27972,7 +28037,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -27982,7 +28047,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -27990,7 +28055,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -27998,7 +28063,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -28008,7 +28073,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -28016,7 +28081,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -28024,7 +28089,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -28045,19 +28110,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -28068,7 +28133,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -28076,13 +28141,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -28100,13 +28165,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -28117,7 +28182,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -28125,7 +28190,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -28136,13 +28201,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -28150,7 +28215,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -28158,7 +28223,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -28170,23 +28235,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnServerlessInstance } from 'awscdk-resources-mongodbatlas' +import { CfnStreamConnection } from 'awscdk-resources-mongodbatlas' -CfnServerlessInstance.isConstruct(x: any) +CfnStreamConnection.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -28194,12 +28259,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnServerlessInstance } from 'awscdk-resources-mongodbatlas' +import { CfnStreamConnection } from 'awscdk-resources-mongodbatlas' -CfnServerlessInstance.isCfnElement(x: any) +CfnStreamConnection.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -28207,23 +28272,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnServerlessInstance } from 'awscdk-resources-mongodbatlas' +import { CfnStreamConnection } from 'awscdk-resources-mongodbatlas' -CfnServerlessInstance.isCfnResource(x: any) +CfnStreamConnection.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -28233,23 +28298,18 @@ Check whether the given object is a CfnResource. | **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. | -| attrCreateDate | string | Attribute `MongoDB::Atlas::ServerlessInstance.CreateDate`. | -| attrId | string | Attribute `MongoDB::Atlas::ServerlessInstance.Id`. | -| attrMongoDBVersion | string | Attribute `MongoDB::Atlas::ServerlessInstance.MongoDBVersion`. | -| attrStateName | string | Attribute `MongoDB::Atlas::ServerlessInstance.StateName`. | -| attrTotalCount | number | Attribute `MongoDB::Atlas::ServerlessInstance.TotalCount`. | -| props | CfnServerlessInstanceProps | Resource props. | +| 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 | CfnStreamConnectionProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -28261,7 +28321,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -28271,7 +28331,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -28288,7 +28348,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -28302,7 +28362,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -28317,7 +28377,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -28329,7 +28389,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -28341,73 +28401,13 @@ AWS resource type. --- -##### `attrCreateDate`Required - -```typescript -public readonly attrCreateDate: string; -``` - -- *Type:* string - -Attribute `MongoDB::Atlas::ServerlessInstance.CreateDate`. - ---- - -##### `attrId`Required - -```typescript -public readonly attrId: string; -``` - -- *Type:* string - -Attribute `MongoDB::Atlas::ServerlessInstance.Id`. - ---- - -##### `attrMongoDBVersion`Required - -```typescript -public readonly attrMongoDBVersion: string; -``` - -- *Type:* string - -Attribute `MongoDB::Atlas::ServerlessInstance.MongoDBVersion`. - ---- - -##### `attrStateName`Required - -```typescript -public readonly attrStateName: string; -``` - -- *Type:* string - -Attribute `MongoDB::Atlas::ServerlessInstance.StateName`. - ---- - -##### `attrTotalCount`Required - -```typescript -public readonly attrTotalCount: number; -``` - -- *Type:* number - -Attribute `MongoDB::Atlas::ServerlessInstance.TotalCount`. - ---- - -##### `props`Required +##### `props`Required ```typescript -public readonly props: CfnServerlessInstanceProps; +public readonly props: CfnStreamConnectionProps; ``` -- *Type:* CfnServerlessInstanceProps +- *Type:* CfnStreamConnectionProps Resource props. @@ -28417,11 +28417,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -28433,27 +28433,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnServerlessPrivateEndpoint +### CfnStreamInstance -A CloudFormation `MongoDB::Atlas::ServerlessPrivateEndpoint`. +A CloudFormation `MongoDB::Atlas::StreamInstance`. -#### Initializers +#### Initializers ```typescript -import { CfnServerlessPrivateEndpoint } from 'awscdk-resources-mongodbatlas' +import { CfnStreamInstance } from 'awscdk-resources-mongodbatlas' -new CfnServerlessPrivateEndpoint(scope: Construct, id: string, props: CfnServerlessPrivateEndpointProps) +new CfnStreamInstance(scope: Construct, id: string, props: CfnStreamInstanceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnServerlessPrivateEndpointProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnStreamInstanceProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -28461,7 +28461,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -28469,9 +28469,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnServerlessPrivateEndpointProps +- *Type:* CfnStreamInstanceProps resource properties. @@ -28481,26 +28481,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -28508,7 +28508,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -28516,7 +28516,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -28524,7 +28524,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -28532,7 +28532,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -28540,7 +28540,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -28551,13 +28551,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -28565,13 +28565,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -28589,19 +28589,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -28651,7 +28651,7 @@ 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 +###### `path`Required - *Type:* string @@ -28662,7 +28662,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -28672,7 +28672,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -28680,7 +28680,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -28688,7 +28688,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -28698,7 +28698,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -28706,7 +28706,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -28714,7 +28714,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -28735,19 +28735,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -28758,7 +28758,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -28766,13 +28766,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -28790,13 +28790,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -28807,7 +28807,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -28815,7 +28815,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -28826,13 +28826,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -28840,7 +28840,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -28848,7 +28848,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -28860,23 +28860,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnServerlessPrivateEndpoint } from 'awscdk-resources-mongodbatlas' +import { CfnStreamInstance } from 'awscdk-resources-mongodbatlas' -CfnServerlessPrivateEndpoint.isConstruct(x: any) +CfnStreamInstance.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -28884,12 +28884,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnServerlessPrivateEndpoint } from 'awscdk-resources-mongodbatlas' +import { CfnStreamInstance } from 'awscdk-resources-mongodbatlas' -CfnServerlessPrivateEndpoint.isCfnElement(x: any) +CfnStreamInstance.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -28897,23 +28897,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnServerlessPrivateEndpoint } from 'awscdk-resources-mongodbatlas' +import { CfnStreamInstance } from 'awscdk-resources-mongodbatlas' -CfnServerlessPrivateEndpoint.isCfnResource(x: any) +CfnStreamInstance.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -28923,24 +28923,20 @@ Check whether the given object is a CfnResource. | **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. | -| attrAwsPrivateEndpointMetaData | string | Attribute `MongoDB::Atlas::ServerlessPrivateEndpoint.AwsPrivateEndpointMetaData`. | -| attrEndpointServiceName | string | Attribute `MongoDB::Atlas::ServerlessPrivateEndpoint.EndpointServiceName`. | -| attrErrorMessage | string | Attribute `MongoDB::Atlas::ServerlessPrivateEndpoint.ErrorMessage`. | -| attrId | string | Attribute `MongoDB::Atlas::ServerlessPrivateEndpoint.Id`. | -| attrProviderName | string | Attribute `MongoDB::Atlas::ServerlessPrivateEndpoint.ProviderName`. | -| attrStatus | string | Attribute `MongoDB::Atlas::ServerlessPrivateEndpoint.Status`. | -| props | CfnServerlessPrivateEndpointProps | Resource props. | +| 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. | +| attrHostnames | string[] | Attribute `MongoDB::Atlas::StreamInstance.Hostnames`. | +| attrId | string | Attribute `MongoDB::Atlas::StreamInstance.Id`. | +| props | CfnStreamInstanceProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -28952,7 +28948,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -28962,7 +28958,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -28979,7 +28975,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -28993,7 +28989,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -29008,7 +29004,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -29020,7 +29016,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -29032,43 +29028,19 @@ AWS resource type. --- -##### `attrAwsPrivateEndpointMetaData`Required - -```typescript -public readonly attrAwsPrivateEndpointMetaData: string; -``` - -- *Type:* string - -Attribute `MongoDB::Atlas::ServerlessPrivateEndpoint.AwsPrivateEndpointMetaData`. - ---- - -##### `attrEndpointServiceName`Required - -```typescript -public readonly attrEndpointServiceName: string; -``` - -- *Type:* string - -Attribute `MongoDB::Atlas::ServerlessPrivateEndpoint.EndpointServiceName`. - ---- - -##### `attrErrorMessage`Required +##### `attrHostnames`Required ```typescript -public readonly attrErrorMessage: string; +public readonly attrHostnames: string[]; ``` -- *Type:* string +- *Type:* string[] -Attribute `MongoDB::Atlas::ServerlessPrivateEndpoint.ErrorMessage`. +Attribute `MongoDB::Atlas::StreamInstance.Hostnames`. --- -##### `attrId`Required +##### `attrId`Required ```typescript public readonly attrId: string; @@ -29076,41 +29048,17 @@ public readonly attrId: string; - *Type:* string -Attribute `MongoDB::Atlas::ServerlessPrivateEndpoint.Id`. - ---- - -##### `attrProviderName`Required - -```typescript -public readonly attrProviderName: string; -``` - -- *Type:* string - -Attribute `MongoDB::Atlas::ServerlessPrivateEndpoint.ProviderName`. - ---- - -##### `attrStatus`Required - -```typescript -public readonly attrStatus: string; -``` - -- *Type:* string - -Attribute `MongoDB::Atlas::ServerlessPrivateEndpoint.Status`. +Attribute `MongoDB::Atlas::StreamInstance.Id`. --- -##### `props`Required +##### `props`Required ```typescript -public readonly props: CfnServerlessPrivateEndpointProps; +public readonly props: CfnStreamInstanceProps; ``` -- *Type:* CfnServerlessPrivateEndpointProps +- *Type:* CfnStreamInstanceProps Resource props. @@ -29120,11 +29068,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -29136,27 +29084,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnStreamConnection +### CfnTeams -A CloudFormation `MongoDB::Atlas::StreamConnection`. +A CloudFormation `MongoDB::Atlas::Teams`. -#### Initializers +#### Initializers ```typescript -import { CfnStreamConnection } from 'awscdk-resources-mongodbatlas' +import { CfnTeams } from 'awscdk-resources-mongodbatlas' -new CfnStreamConnection(scope: Construct, id: string, props: CfnStreamConnectionProps) +new CfnTeams(scope: Construct, id: string, props: CfnTeamsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnStreamConnectionProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnTeamsProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -29164,7 +29112,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -29172,9 +29120,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnStreamConnectionProps +- *Type:* CfnTeamsProps resource properties. @@ -29184,26 +29132,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -29211,7 +29159,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -29219,7 +29167,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -29227,7 +29175,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -29235,7 +29183,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -29243,7 +29191,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -29254,13 +29202,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -29268,13 +29216,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -29292,19 +29240,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -29354,7 +29302,7 @@ 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 +###### `path`Required - *Type:* string @@ -29365,7 +29313,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -29375,7 +29323,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -29383,7 +29331,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -29391,7 +29339,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -29401,7 +29349,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -29409,7 +29357,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -29417,7 +29365,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -29438,19 +29386,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -29461,7 +29409,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -29469,13 +29417,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -29493,13 +29441,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -29510,7 +29458,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -29518,7 +29466,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -29529,13 +29477,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -29543,7 +29491,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -29551,7 +29499,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -29563,23 +29511,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnStreamConnection } from 'awscdk-resources-mongodbatlas' +import { CfnTeams } from 'awscdk-resources-mongodbatlas' -CfnStreamConnection.isConstruct(x: any) +CfnTeams.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -29587,12 +29535,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnStreamConnection } from 'awscdk-resources-mongodbatlas' +import { CfnTeams } from 'awscdk-resources-mongodbatlas' -CfnStreamConnection.isCfnElement(x: any) +CfnTeams.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -29600,23 +29548,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnStreamConnection } from 'awscdk-resources-mongodbatlas' +import { CfnTeams } from 'awscdk-resources-mongodbatlas' -CfnStreamConnection.isCfnResource(x: any) +CfnTeams.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -29626,18 +29574,19 @@ Check whether the given object is a CfnResource. | **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 | CfnStreamConnectionProps | Resource props. | +| 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. | +| attrTeamId | string | Attribute `MongoDB::Atlas::Teams.TeamId`. | +| props | CfnTeamsProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -29649,7 +29598,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -29659,7 +29608,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -29676,7 +29625,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -29690,7 +29639,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -29705,7 +29654,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -29717,7 +29666,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -29729,13 +29678,25 @@ AWS resource type. --- -##### `props`Required +##### `attrTeamId`Required ```typescript -public readonly props: CfnStreamConnectionProps; +public readonly attrTeamId: string; ``` -- *Type:* CfnStreamConnectionProps +- *Type:* string + +Attribute `MongoDB::Atlas::Teams.TeamId`. + +--- + +##### `props`Required + +```typescript +public readonly props: CfnTeamsProps; +``` + +- *Type:* CfnTeamsProps Resource props. @@ -29745,11 +29706,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -29761,27 +29722,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnStreamInstance +### CfnThirdPartyIntegration -A CloudFormation `MongoDB::Atlas::StreamInstance`. +A CloudFormation `MongoDB::Atlas::ThirdPartyIntegration`. -#### Initializers +#### Initializers ```typescript -import { CfnStreamInstance } from 'awscdk-resources-mongodbatlas' +import { CfnThirdPartyIntegration } from 'awscdk-resources-mongodbatlas' -new CfnStreamInstance(scope: Construct, id: string, props: CfnStreamInstanceProps) +new CfnThirdPartyIntegration(scope: Construct, id: string, props: CfnThirdPartyIntegrationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnStreamInstanceProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnThirdPartyIntegrationProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -29789,7 +29750,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -29797,9 +29758,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnStreamInstanceProps +- *Type:* CfnThirdPartyIntegrationProps resource properties. @@ -29809,26 +29770,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -29836,7 +29797,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -29844,7 +29805,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -29852,7 +29813,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -29860,7 +29821,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -29868,7 +29829,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -29879,13 +29840,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -29893,13 +29854,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -29917,19 +29878,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -29979,7 +29940,7 @@ 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 +###### `path`Required - *Type:* string @@ -29990,7 +29951,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -30000,7 +29961,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -30008,7 +29969,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -30016,7 +29977,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -30026,7 +29987,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -30034,7 +29995,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -30042,7 +30003,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -30063,19 +30024,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -30086,7 +30047,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -30094,13 +30055,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -30118,13 +30079,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -30135,7 +30096,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -30143,7 +30104,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -30154,13 +30115,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -30168,7 +30129,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -30176,7 +30137,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -30188,23 +30149,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnStreamInstance } from 'awscdk-resources-mongodbatlas' +import { CfnThirdPartyIntegration } from 'awscdk-resources-mongodbatlas' -CfnStreamInstance.isConstruct(x: any) +CfnThirdPartyIntegration.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -30212,12 +30173,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnStreamInstance } from 'awscdk-resources-mongodbatlas' +import { CfnThirdPartyIntegration } from 'awscdk-resources-mongodbatlas' -CfnStreamInstance.isCfnElement(x: any) +CfnThirdPartyIntegration.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -30225,23 +30186,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnStreamInstance } from 'awscdk-resources-mongodbatlas' +import { CfnThirdPartyIntegration } from 'awscdk-resources-mongodbatlas' -CfnStreamInstance.isCfnResource(x: any) +CfnThirdPartyIntegration.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -30251,20 +30212,18 @@ Check whether the given object is a CfnResource. | **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. | -| attrHostnames | string[] | Attribute `MongoDB::Atlas::StreamInstance.Hostnames`. | -| attrId | string | Attribute `MongoDB::Atlas::StreamInstance.Id`. | -| props | CfnStreamInstanceProps | Resource props. | +| 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 | CfnThirdPartyIntegrationProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -30276,7 +30235,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -30286,7 +30245,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -30303,7 +30262,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -30317,7 +30276,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -30332,7 +30291,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -30344,7 +30303,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -30356,37 +30315,13 @@ AWS resource type. --- -##### `attrHostnames`Required - -```typescript -public readonly attrHostnames: string[]; -``` - -- *Type:* string[] - -Attribute `MongoDB::Atlas::StreamInstance.Hostnames`. - ---- - -##### `attrId`Required - -```typescript -public readonly attrId: string; -``` - -- *Type:* string - -Attribute `MongoDB::Atlas::StreamInstance.Id`. - ---- - -##### `props`Required +##### `props`Required ```typescript -public readonly props: CfnStreamInstanceProps; +public readonly props: CfnThirdPartyIntegrationProps; ``` -- *Type:* CfnStreamInstanceProps +- *Type:* CfnThirdPartyIntegrationProps Resource props. @@ -30396,11 +30331,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -30412,27 +30347,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnTeams +### CfnTrigger -A CloudFormation `MongoDB::Atlas::Teams`. +A CloudFormation `MongoDB::Atlas::Trigger`. -#### Initializers +#### Initializers ```typescript -import { CfnTeams } from 'awscdk-resources-mongodbatlas' +import { CfnTrigger } from 'awscdk-resources-mongodbatlas' -new CfnTeams(scope: Construct, id: string, props: CfnTeamsProps) +new CfnTrigger(scope: Construct, id: string, props: CfnTriggerProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnTeamsProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnTriggerProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -30440,7 +30375,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -30448,9 +30383,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnTeamsProps +- *Type:* CfnTriggerProps resource properties. @@ -30460,26 +30395,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -30487,7 +30422,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -30495,7 +30430,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -30503,7 +30438,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -30511,7 +30446,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -30519,7 +30454,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -30530,13 +30465,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -30544,13 +30479,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -30568,19 +30503,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -30630,7 +30565,7 @@ 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 +###### `path`Required - *Type:* string @@ -30641,7 +30576,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -30651,7 +30586,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -30659,7 +30594,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -30667,7 +30602,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -30677,7 +30612,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -30685,7 +30620,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -30693,7 +30628,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -30714,19 +30649,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -30737,7 +30672,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -30745,13 +30680,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -30769,13 +30704,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -30786,7 +30721,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -30794,7 +30729,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -30805,13 +30740,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -30819,7 +30754,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -30827,7 +30762,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -30839,23 +30774,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnTeams } from 'awscdk-resources-mongodbatlas' +import { CfnTrigger } from 'awscdk-resources-mongodbatlas' -CfnTeams.isConstruct(x: any) +CfnTrigger.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -30863,12 +30798,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnTeams } from 'awscdk-resources-mongodbatlas' +import { CfnTrigger } from 'awscdk-resources-mongodbatlas' -CfnTeams.isCfnElement(x: any) +CfnTrigger.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -30876,23 +30811,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnTeams } from 'awscdk-resources-mongodbatlas' +import { CfnTrigger } from 'awscdk-resources-mongodbatlas' -CfnTeams.isCfnResource(x: any) +CfnTrigger.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -30902,19 +30837,19 @@ Check whether the given object is a CfnResource. | **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. | -| attrTeamId | string | Attribute `MongoDB::Atlas::Teams.TeamId`. | -| props | CfnTeamsProps | Resource props. | +| 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. | +| attrId | string | Attribute `MongoDB::Atlas::Trigger.Id`. | +| props | CfnTriggerProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -30926,7 +30861,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -30936,7 +30871,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -30953,7 +30888,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -30967,7 +30902,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -30982,7 +30917,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -30994,7 +30929,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -31006,25 +30941,25 @@ AWS resource type. --- -##### `attrTeamId`Required +##### `attrId`Required ```typescript -public readonly attrTeamId: string; +public readonly attrId: string; ``` - *Type:* string -Attribute `MongoDB::Atlas::Teams.TeamId`. +Attribute `MongoDB::Atlas::Trigger.Id`. --- -##### `props`Required +##### `props`Required ```typescript -public readonly props: CfnTeamsProps; +public readonly props: CfnTriggerProps; ``` -- *Type:* CfnTeamsProps +- *Type:* CfnTriggerProps Resource props. @@ -31034,11 +30969,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -31050,27 +30985,27 @@ The CloudFormation resource type name for this resource class. --- -### CfnThirdPartyIntegration +### CfnX509AuthenticationDatabaseUser -A CloudFormation `MongoDB::Atlas::ThirdPartyIntegration`. +A CloudFormation `MongoDB::Atlas::X509AuthenticationDatabaseUser`. -#### Initializers +#### Initializers ```typescript -import { CfnThirdPartyIntegration } from 'awscdk-resources-mongodbatlas' +import { CfnX509AuthenticationDatabaseUser } from 'awscdk-resources-mongodbatlas' -new CfnThirdPartyIntegration(scope: Construct, id: string, props: CfnThirdPartyIntegrationProps) +new CfnX509AuthenticationDatabaseUser(scope: Construct, id: string, props: CfnX509AuthenticationDatabaseUserProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnThirdPartyIntegrationProps | - resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnX509AuthenticationDatabaseUserProps | - resource properties. | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -31078,7 +31013,7 @@ scope in which this resource is defined. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -31086,9 +31021,9 @@ scoped id of the resource. --- -##### `props`Required +##### `props`Required -- *Type:* CfnThirdPartyIntegrationProps +- *Type:* CfnX509AuthenticationDatabaseUserProps resource properties. @@ -31098,26 +31033,26 @@ resource properties. | **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 | 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` +##### `toString` ```typescript public toString(): string @@ -31125,7 +31060,7 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -31133,7 +31068,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -31141,7 +31076,7 @@ The new logical ID to use for this stack element. --- -##### `addDeletionOverride` +##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void @@ -31149,7 +31084,7 @@ public addDeletionOverride(path: string): void Syntactic sugar for `addOverride(path, undefined)`. -###### `path`Required +###### `path`Required - *Type:* string @@ -31157,7 +31092,7 @@ The path of the value to delete. --- -##### `addDependency` +##### `addDependency` ```typescript public addDependency(target: CfnResource): void @@ -31168,13 +31103,13 @@ Indicates that this resource depends on another resource and cannot be provision 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### ~~`addDependsOn`~~ +##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void @@ -31182,13 +31117,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `addMetadata` +##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void @@ -31206,19 +31141,19 @@ 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 +###### `key`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void @@ -31268,7 +31203,7 @@ 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 +###### `path`Required - *Type:* string @@ -31279,7 +31214,7 @@ will be created as needed. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -31289,7 +31224,7 @@ Could be primitive or complex. --- -##### `addPropertyDeletionOverride` +##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void @@ -31297,7 +31232,7 @@ public addPropertyDeletionOverride(propertyPath: string): void Adds an override that deletes the value of a property from the resource definition. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -31305,7 +31240,7 @@ The path to the property. --- -##### `addPropertyOverride` +##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void @@ -31315,7 +31250,7 @@ Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. -###### `propertyPath`Required +###### `propertyPath`Required - *Type:* string @@ -31323,7 +31258,7 @@ The path of the property. --- -###### `value`Required +###### `value`Required - *Type:* any @@ -31331,7 +31266,7 @@ The value. --- -##### `applyRemovalPolicy` +##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void @@ -31352,19 +31287,19 @@ 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 +###### `policy`Optional - *Type:* aws-cdk-lib.RemovalPolicy --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- -##### `getAtt` +##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference @@ -31375,7 +31310,7 @@ 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 +###### `attributeName`Required - *Type:* string @@ -31383,13 +31318,13 @@ The name of the attribute. --- -###### `typeHint`Optional +###### `typeHint`Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- -##### `getMetadata` +##### `getMetadata` ```typescript public getMetadata(key: string): any @@ -31407,13 +31342,13 @@ 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 +###### `key`Required - *Type:* string --- -##### `obtainDependencies` +##### `obtainDependencies` ```typescript public obtainDependencies(): Stack | CfnResource[] @@ -31424,7 +31359,7 @@ Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. -##### `obtainResourceDependencies` +##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] @@ -31432,7 +31367,7 @@ public obtainResourceDependencies(): CfnResource[] Get a shallow copy of dependencies between this resource and other resources in the same stack. -##### `removeDependency` +##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void @@ -31443,13 +31378,13 @@ 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 +###### `target`Required - *Type:* aws-cdk-lib.CfnResource --- -##### `replaceDependency` +##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void @@ -31457,7 +31392,7 @@ public replaceDependency(target: CfnResource, newTarget: CfnResource): void Replaces one dependency with another. -###### `target`Required +###### `target`Required - *Type:* aws-cdk-lib.CfnResource @@ -31465,7 +31400,7 @@ The dependency to replace. --- -###### `newTarget`Required +###### `newTarget`Required - *Type:* aws-cdk-lib.CfnResource @@ -31477,23 +31412,23 @@ The new dependency to add. | **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 | 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`~~ +##### ~~`isConstruct`~~ ```typescript -import { CfnThirdPartyIntegration } from 'awscdk-resources-mongodbatlas' +import { CfnX509AuthenticationDatabaseUser } from 'awscdk-resources-mongodbatlas' -CfnThirdPartyIntegration.isConstruct(x: any) +CfnX509AuthenticationDatabaseUser.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -31501,12 +31436,12 @@ Any object. --- -##### `isCfnElement` +##### `isCfnElement` ```typescript -import { CfnThirdPartyIntegration } from 'awscdk-resources-mongodbatlas' +import { CfnX509AuthenticationDatabaseUser } from 'awscdk-resources-mongodbatlas' -CfnThirdPartyIntegration.isCfnElement(x: any) +CfnX509AuthenticationDatabaseUser.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). @@ -31514,23 +31449,23 @@ Returns `true` if a construct is a stack element (i.e. part of the synthesized c 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 +###### `x`Required - *Type:* any --- -##### `isCfnResource` +##### `isCfnResource` ```typescript -import { CfnThirdPartyIntegration } from 'awscdk-resources-mongodbatlas' +import { CfnX509AuthenticationDatabaseUser } from 'awscdk-resources-mongodbatlas' -CfnThirdPartyIntegration.isCfnResource(x: any) +CfnX509AuthenticationDatabaseUser.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. -###### `x`Required +###### `x`Required - *Type:* any @@ -31540,18 +31475,20 @@ Check whether the given object is a CfnResource. | **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 | CfnThirdPartyIntegrationProps | Resource props. | +| 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. | +| attrMonthsUntilExpiration | number | Attribute `MongoDB::Atlas::X509AuthenticationDatabaseUser.MonthsUntilExpiration`. | +| attrTotalCount | number | Attribute `MongoDB::Atlas::X509AuthenticationDatabaseUser.TotalCount`. | +| props | CfnX509AuthenticationDatabaseUserProps | Resource props. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -31563,7 +31500,7 @@ The tree node. --- -##### `creationStack`Required +##### `creationStack`Required ```typescript public readonly creationStack: string[]; @@ -31573,7 +31510,7 @@ public readonly creationStack: string[]; --- -##### `logicalId`Required +##### `logicalId`Required ```typescript public readonly logicalId: string; @@ -31590,7 +31527,7 @@ To override this value, use `overrideLogicalId(newLogicalId)`. --- -##### `stack`Required +##### `stack`Required ```typescript public readonly stack: Stack; @@ -31604,7 +31541,7 @@ CfnElements must be defined within a stack scope (directly or indirectly). --- -##### `ref`Required +##### `ref`Required ```typescript public readonly ref: string; @@ -31619,7 +31556,7 @@ coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- -##### `cfnOptions`Required +##### `cfnOptions`Required ```typescript public readonly cfnOptions: ICfnResourceOptions; @@ -31631,7 +31568,7 @@ Options for this resource, such as condition, update policy etc. --- -##### `cfnResourceType`Required +##### `cfnResourceType`Required ```typescript public readonly cfnResourceType: string; @@ -31643,13 +31580,37 @@ AWS resource type. --- -##### `props`Required +##### `attrMonthsUntilExpiration`Required ```typescript -public readonly props: CfnThirdPartyIntegrationProps; +public readonly attrMonthsUntilExpiration: number; ``` -- *Type:* CfnThirdPartyIntegrationProps +- *Type:* number + +Attribute `MongoDB::Atlas::X509AuthenticationDatabaseUser.MonthsUntilExpiration`. + +--- + +##### `attrTotalCount`Required + +```typescript +public readonly attrTotalCount: number; +``` + +- *Type:* number + +Attribute `MongoDB::Atlas::X509AuthenticationDatabaseUser.TotalCount`. + +--- + +##### `props`Required + +```typescript +public readonly props: CfnX509AuthenticationDatabaseUserProps; +``` + +- *Type:* CfnX509AuthenticationDatabaseUserProps Resource props. @@ -31659,11 +31620,11 @@ Resource props. | **Name** | **Type** | **Description** | | --- | --- | --- | -| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### `CFN_RESOURCE_TYPE_NAME`Required +##### `CFN_RESOURCE_TYPE_NAME`Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; @@ -31675,47 +31636,39 @@ The CloudFormation resource type name for this resource class. --- -### CfnTrigger - -A CloudFormation `MongoDB::Atlas::Trigger`. +### DatadogIntegration -#### Initializers +#### Initializers ```typescript -import { CfnTrigger } from 'awscdk-resources-mongodbatlas' +import { DatadogIntegration } from 'awscdk-resources-mongodbatlas' -new CfnTrigger(scope: Construct, id: string, props: CfnTriggerProps) +new DatadogIntegration(scope: Construct, id: string, props: DatadogIntegrationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnTriggerProps | - resource properties. | +| scope | constructs.Construct | *No description.* | +| id | string | *No description.* | +| props | DatadogIntegrationProps | *No description.* | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct -scope in which this resource is defined. - --- -##### `id`Required +##### `id`Required - *Type:* string -scoped id of the resource. - --- -##### `props`Required - -- *Type:* CfnTriggerProps +##### `props`Required -resource properties. +- *Type:* DatadogIntegrationProps --- @@ -31723,26 +31676,11 @@ resource properties. | **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 | Returns a string representation of this construct. | --- -##### `toString` +##### `toString` ```typescript public toString(): string @@ -31750,1389 +31688,123 @@ public toString(): string Returns a string representation of this construct. -##### `overrideLogicalId` +#### Static Functions -```typescript -public overrideLogicalId(newLogicalId: string): void -``` +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | -Overrides the auto-generated logical ID with a specific ID. +--- -###### `newLogicalId`Required +##### ~~`isConstruct`~~ -- *Type:* string +```typescript +import { DatadogIntegration } from 'awscdk-resources-mongodbatlas' -The new logical ID to use for this stack element. +DatadogIntegration.isConstruct(x: any) +``` ---- +Checks if `x` is a construct. -##### `addDeletionOverride` +###### `x`Required -```typescript -public addDeletionOverride(path: string): void -``` +- *Type:* any -Syntactic sugar for `addOverride(path, undefined)`. +Any object. -###### `path`Required +--- -- *Type:* string +#### Properties -The path of the value to delete. +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| node | constructs.Node | The tree node. | +| cfnThirdPartyIntegration | CfnThirdPartyIntegration | *No description.* | --- -##### `addDependency` +##### `node`Required ```typescript -public addDependency(target: CfnResource): void +public readonly node: Node; ``` -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:* constructs.Node -- *Type:* aws-cdk-lib.CfnResource +The tree node. --- -##### ~~`addDependsOn`~~ +##### `cfnThirdPartyIntegration`Required ```typescript -public addDependsOn(target: CfnResource): void +public readonly cfnThirdPartyIntegration: CfnThirdPartyIntegration; ``` -Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. +- *Type:* CfnThirdPartyIntegration -###### `target`Required +--- -- *Type:* aws-cdk-lib.CfnResource ---- +### MicrosoftTeamsIntegration -##### `addMetadata` +#### Initializers ```typescript -public addMetadata(key: string, value: any): void +import { MicrosoftTeamsIntegration } from 'awscdk-resources-mongodbatlas' + +new MicrosoftTeamsIntegration(scope: Construct, id: string, props: MicrosoftTeamsIntegrationProps) ``` -Add a value to the CloudFormation Resource Metadata. +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | *No description.* | +| id | string | *No description.* | +| props | MicrosoftTeamsIntegrationProps | *No description.* | -> [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 +##### `scope`Required -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.) +- *Type:* constructs.Construct -###### `key`Required +--- + +##### `id`Required - *Type:* string --- -###### `value`Required +##### `props`Required -- *Type:* any +- *Type:* MicrosoftTeamsIntegrationProps --- -##### `addOverride` +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | + +--- + +##### `toString` ```typescript -public addOverride(path: string, value: any): void +public toString(): string ``` -Adds an override to the synthesized CloudFormation resource. +Returns a string representation of this construct. -To add a -property override, either use `addPropertyOverride` or prefix `path` with -"Properties." (i.e. `Properties.TopicName`). +#### Static Functions -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. +| **Name** | **Description** | +| --- | --- | +| isConstruct | Checks if `x` is a construct. | -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 { CfnTrigger } from 'awscdk-resources-mongodbatlas' - -CfnTrigger.isConstruct(x: any) -``` - -Checks if `x` is a construct. - -###### `x`Required - -- *Type:* any - -Any object. - ---- - -##### `isCfnElement` - -```typescript -import { CfnTrigger } from 'awscdk-resources-mongodbatlas' - -CfnTrigger.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 { CfnTrigger } from 'awscdk-resources-mongodbatlas' - -CfnTrigger.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. | -| attrId | string | Attribute `MongoDB::Atlas::Trigger.Id`. | -| props | CfnTriggerProps | 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. - ---- - -##### `attrId`Required - -```typescript -public readonly attrId: string; -``` - -- *Type:* string - -Attribute `MongoDB::Atlas::Trigger.Id`. - ---- - -##### `props`Required - -```typescript -public readonly props: CfnTriggerProps; -``` - -- *Type:* CfnTriggerProps - -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. - ---- - -### CfnX509AuthenticationDatabaseUser - -A CloudFormation `MongoDB::Atlas::X509AuthenticationDatabaseUser`. - -#### Initializers - -```typescript -import { CfnX509AuthenticationDatabaseUser } from 'awscdk-resources-mongodbatlas' - -new CfnX509AuthenticationDatabaseUser(scope: Construct, id: string, props: CfnX509AuthenticationDatabaseUserProps) -``` - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| scope | constructs.Construct | - scope in which this resource is defined. | -| id | string | - scoped id of the resource. | -| props | CfnX509AuthenticationDatabaseUserProps | - 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:* CfnX509AuthenticationDatabaseUserProps - -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 { CfnX509AuthenticationDatabaseUser } from 'awscdk-resources-mongodbatlas' - -CfnX509AuthenticationDatabaseUser.isConstruct(x: any) -``` - -Checks if `x` is a construct. - -###### `x`Required - -- *Type:* any - -Any object. - ---- - -##### `isCfnElement` - -```typescript -import { CfnX509AuthenticationDatabaseUser } from 'awscdk-resources-mongodbatlas' - -CfnX509AuthenticationDatabaseUser.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 { CfnX509AuthenticationDatabaseUser } from 'awscdk-resources-mongodbatlas' - -CfnX509AuthenticationDatabaseUser.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. | -| attrMonthsUntilExpiration | number | Attribute `MongoDB::Atlas::X509AuthenticationDatabaseUser.MonthsUntilExpiration`. | -| attrTotalCount | number | Attribute `MongoDB::Atlas::X509AuthenticationDatabaseUser.TotalCount`. | -| props | CfnX509AuthenticationDatabaseUserProps | 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. - ---- - -##### `attrMonthsUntilExpiration`Required - -```typescript -public readonly attrMonthsUntilExpiration: number; -``` - -- *Type:* number - -Attribute `MongoDB::Atlas::X509AuthenticationDatabaseUser.MonthsUntilExpiration`. - ---- - -##### `attrTotalCount`Required - -```typescript -public readonly attrTotalCount: number; -``` - -- *Type:* number - -Attribute `MongoDB::Atlas::X509AuthenticationDatabaseUser.TotalCount`. - ---- - -##### `props`Required - -```typescript -public readonly props: CfnX509AuthenticationDatabaseUserProps; -``` - -- *Type:* CfnX509AuthenticationDatabaseUserProps - -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. - ---- - -### DatadogIntegration - -#### Initializers - -```typescript -import { DatadogIntegration } from 'awscdk-resources-mongodbatlas' - -new DatadogIntegration(scope: Construct, id: string, props: DatadogIntegrationProps) -``` - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| scope | constructs.Construct | *No description.* | -| id | string | *No description.* | -| props | DatadogIntegrationProps | *No description.* | - ---- - -##### `scope`Required - -- *Type:* constructs.Construct - ---- - -##### `id`Required - -- *Type:* string - ---- - -##### `props`Required - -- *Type:* DatadogIntegrationProps - ---- - -#### Methods - -| **Name** | **Description** | -| --- | --- | -| toString | Returns a string representation of this construct. | - ---- - -##### `toString` - -```typescript -public toString(): string -``` - -Returns a string representation of this construct. - -#### Static Functions - -| **Name** | **Description** | -| --- | --- | -| isConstruct | Checks if `x` is a construct. | - ---- - -##### ~~`isConstruct`~~ - -```typescript -import { DatadogIntegration } from 'awscdk-resources-mongodbatlas' - -DatadogIntegration.isConstruct(x: any) -``` - -Checks if `x` is a construct. - -###### `x`Required - -- *Type:* any - -Any object. - ---- - -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| node | constructs.Node | The tree node. | -| cfnThirdPartyIntegration | CfnThirdPartyIntegration | *No description.* | - ---- - -##### `node`Required - -```typescript -public readonly node: Node; -``` - -- *Type:* constructs.Node - -The tree node. - ---- - -##### `cfnThirdPartyIntegration`Required - -```typescript -public readonly cfnThirdPartyIntegration: CfnThirdPartyIntegration; -``` - -- *Type:* CfnThirdPartyIntegration - ---- - - -### MicrosoftTeamsIntegration - -#### Initializers - -```typescript -import { MicrosoftTeamsIntegration } from 'awscdk-resources-mongodbatlas' - -new MicrosoftTeamsIntegration(scope: Construct, id: string, props: MicrosoftTeamsIntegrationProps) -``` - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| scope | constructs.Construct | *No description.* | -| id | string | *No description.* | -| props | MicrosoftTeamsIntegrationProps | *No description.* | - ---- - -##### `scope`Required - -- *Type:* constructs.Construct - ---- - -##### `id`Required - -- *Type:* string - ---- - -##### `props`Required - -- *Type:* MicrosoftTeamsIntegrationProps - ---- - -#### Methods - -| **Name** | **Description** | -| --- | --- | -| toString | Returns a string representation of this construct. | - ---- - -##### `toString` - -```typescript -public toString(): string -``` - -Returns a string representation of this construct. - -#### Static Functions - -| **Name** | **Description** | -| --- | --- | -| isConstruct | Checks if `x` is a construct. | - ---- +--- ##### ~~`isConstruct`~~ @@ -37821,245 +36493,6 @@ Default value is `NONE`. --- -### CfnDataLakePipelineProps - -Data Lake is deprecated. - -As of September 2024, Data Lake is deprecated. If you use Data Lake, you should migrate to alternative solutions before the service is removed. To learn more, see . This resource returns, adds, edits, and removes data lake pipelines. - -#### Initializer - -```typescript -import { CfnDataLakePipelineProps } from 'awscdk-resources-mongodbatlas' - -const cfnDataLakePipelineProps: CfnDataLakePipelineProps = { ... } -``` - -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| name | string | Name of this Data Lake Pipeline. | -| projectId | string | Unique 24-hexadecimal digit string that identifies your project. | -| sink | Sink | *No description.* | -| transformations | Transformations[] | Ingestion destination of a Data Lake Pipeline. | -| profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | -| source | Source | *No description.* | -| state | string | State of the Data Lake Pipeline. | - ---- - -##### `name`Required - -```typescript -public readonly name: string; -``` - -- *Type:* string - -Name of this Data Lake Pipeline. - ---- - -##### `projectId`Required - -```typescript -public readonly projectId: string; -``` - -- *Type:* string - -Unique 24-hexadecimal digit string that identifies your project. - ---- - -##### `sink`Required - -```typescript -public readonly sink: Sink; -``` - -- *Type:* Sink - ---- - -##### `transformations`Required - -```typescript -public readonly transformations: Transformations[]; -``` - -- *Type:* Transformations[] - -Ingestion destination of a Data Lake Pipeline. - ---- - -##### `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. - ---- - -##### `source`Optional - -```typescript -public readonly source: Source; -``` - -- *Type:* Source - ---- - -##### `state`Optional - -```typescript -public readonly state: string; -``` - -- *Type:* string - -State of the Data Lake Pipeline. - ---- - -### CfnDataLakesProps - -Returns, adds, edits, and removes Federated Database Instances. - -#### Initializer - -```typescript -import { CfnDataLakesProps } from 'awscdk-resources-mongodbatlas' - -const cfnDataLakesProps: CfnDataLakesProps = { ... } -``` - -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| cloudProviderConfig | DataLakeCloudProviderConfigView | Cloud provider linked to this data lake. | -| dataProcessRegion | DataLakeDataProcessRegionView | Information about the cloud provider region to which the data lake routes client connections. | -| endDate | number | Timestamp that specifies the end point for the range of log messages to download. | -| profile | string | The profile is defined in AWS Secret manager. | -| projectId | string | Unique 24-hexadecimal digit string that identifies your project. | -| skipRoleValidation | boolean | Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. | -| storage | DataLakeStorageView | Configuration information for each data store and its mapping to MongoDB Cloud databases. | -| tenantName | string | Human-readable label that identifies the Federated Database to remove. | - ---- - -##### `cloudProviderConfig`Optional - -```typescript -public readonly cloudProviderConfig: DataLakeCloudProviderConfigView; -``` - -- *Type:* DataLakeCloudProviderConfigView - -Cloud provider linked to this data lake. - ---- - -##### `dataProcessRegion`Optional - -```typescript -public readonly dataProcessRegion: DataLakeDataProcessRegionView; -``` - -- *Type:* DataLakeDataProcessRegionView - -Information about the cloud provider region to which the data lake routes client connections. - -MongoDB Cloud supports AWS only. - ---- - -##### `endDate`Optional - -```typescript -public readonly endDate: number; -``` - -- *Type:* number - -Timestamp that specifies the end point for the range of log messages to download. - -MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. - ---- - -##### `profile`Optional - -```typescript -public readonly profile: string; -``` - -- *Type:* string - -The profile is defined in AWS Secret manager. - -See [Secret Manager Profile setup](../../../examples/profile-secret.yaml). - ---- - -##### `projectId`Optional - -```typescript -public readonly projectId: string; -``` - -- *Type:* string - -Unique 24-hexadecimal digit string that identifies your project. - ---- - -##### `skipRoleValidation`Optional - -```typescript -public readonly skipRoleValidation: boolean; -``` - -- *Type:* boolean - -Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. - -AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check. - ---- - -##### `storage`Optional - -```typescript -public readonly storage: DataLakeStorageView; -``` - -- *Type:* DataLakeStorageView - -Configuration information for each data store and its mapping to MongoDB Cloud databases. - ---- - -##### `tenantName`Optional - -```typescript -public readonly tenantName: string; -``` - -- *Type:* string - -Human-readable label that identifies the Federated Database to remove. - ---- - ### CfnEncryptionAtRestProps Returns and edits the Encryption at Rest using Customer Key Management configuration. @@ -42150,1707 +40583,1206 @@ If `true`, the trigger is disabled and does not listen for events or execute. ##### `eventProcessors`Optional -```typescript -public readonly eventProcessors: Event; -``` - -- *Type:* Event - -An object where each field name is an event processor ID and each value is an object that configures its corresponding event processor. - -For an example configuration object, see -[Send Trigger Events to AWS -EventBridge](https://www.mongodb.com/docs/atlas/app-services/triggers/aws-eventbridge/#std-label-event_processor_example). - ---- - -##### `functionId`Optional - -```typescript -public readonly functionId: string; -``` - -- *Type:* string - -The ID of the function that the trigger calls when it fires. - -This value is the same as `event_processors.FUNCTION.function_id`. -You can either define the value here or in `event_processors.FUNCTION.function_id`. -The App Services backend duplicates the value to the configuration location where you did not define it. - -For example, if you define `function_id`, the backend duplicates it to `event_processors.FUNCTION.function_id`. - ---- - -##### `functionName`Optional - -```typescript -public readonly functionName: string; -``` - -- *Type:* string - -The name of the function that the trigger calls when it fires, i.e. the function described by `function_id`. - -This value is the same as `event_processors.FUNCTION.function_name`. -You can either define the value here or in `event_processors.FUNCTION.function_name`. -The App Services backend duplicates the value to the configuration location where you did not define it. - -For example, if you define `function_name`, the backend duplicates it to `event_processors.FUNCTION.function_name`. - ---- - -##### `profile`Optional - -```typescript -public readonly profile: string; -``` - -- *Type:* string - -The profile is defined in AWS Secret manager. - -See [Secret Manager Profile setup](../../../examples/profile-secret.yaml). - ---- - -##### `scheduleTrigger`Optional - -```typescript -public readonly scheduleTrigger: ScheduleConfig; -``` - -- *Type:* ScheduleConfig - ---- - -### CfnX509AuthenticationDatabaseUserProps - -Generates one X.509 certificate for the specified MongoDB user. Atlas manages the certificate and MongoDB user that belong to one project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List. - -To get MongoDB Cloud to generate a managed certificate for a database user, set `"x509Type" : "MANAGED"` on the desired MongoDB Database User. - -If you are managing your own Certificate Authority (CA) in Self-Managed X.509 mode, you must generate certificates for database users using your own CA. - -#### Initializer - -```typescript -import { CfnX509AuthenticationDatabaseUserProps } from 'awscdk-resources-mongodbatlas' - -const cfnX509AuthenticationDatabaseUserProps: CfnX509AuthenticationDatabaseUserProps = { ... } -``` - -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| customerX509 | CustomerX509 | CustomerX509 represents Customer-managed X.509 configuration for an Atlas project. | -| profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | -| projectId | string | The unique identifier for the project . | -| userName | string | Username of the database user to create a certificate for. | - ---- - -##### `customerX509`Optional - -```typescript -public readonly customerX509: CustomerX509; -``` - -- *Type:* CustomerX509 - -CustomerX509 represents Customer-managed X.509 configuration for an Atlas project. - ---- - -##### `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. - ---- - -##### `projectId`Optional - -```typescript -public readonly projectId: string; -``` - -- *Type:* string - -The unique identifier for the project . - ---- - -##### `userName`Optional - -```typescript -public readonly userName: string; -``` - -- *Type:* string - -Username of the database user to create a certificate for. - ---- - -### CloudProviderConfig - -Cloud provider linked to this data lake.. - -#### Initializer - -```typescript -import { CloudProviderConfig } from 'awscdk-resources-mongodbatlas' - -const cloudProviderConfig: CloudProviderConfig = { ... } -``` - -#### Properties - -| **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. | -| testS3Bucket | string | Name of the S3 data bucket that the provided role ID is authorized to access.Required if specifying cloudProviderConfig. | - ---- - -##### `externalId`Optional - -```typescript -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. - ---- - -##### `iamAssumedRoleArn`Optional - -```typescript -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. - ---- - -##### `iamUserArn`Optional - -```typescript -public readonly iamUserArn: string; -``` - -- *Type:* string - -Amazon Resource Name (ARN) of the user that the data lake assumes when accessing data stores. - ---- - -##### `roleId`Optional - -```typescript -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. - ---- - -##### `testS3Bucket`Optional - -```typescript -public readonly testS3Bucket: string; -``` - -- *Type:* string - -Name of the S3 data bucket that the provided role ID is authorized to access.Required if specifying cloudProviderConfig. - ---- - -### ClusterProps - -#### Initializer - -```typescript -import { ClusterProps } from 'awscdk-resources-mongodbatlas' - -const clusterProps: ClusterProps = { ... } -``` - -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| advancedSettings | ProcessArgs | *No description.* | -| backupEnabled | boolean | *No description.* | -| biConnector | CfnClusterPropsBiConnector | *No description.* | -| clusterType | string | *No description.* | -| connectionStrings | ConnectionStrings | *No description.* | -| diskSizeGb | number | *No description.* | -| encryptionAtRestProvider | CfnClusterPropsEncryptionAtRestProvider | *No description.* | -| labels | CfnClusterPropsLabels[] | *No description.* | -| mongoDbMajorVersion | string | *No description.* | -| name | string | *No description.* | -| paused | boolean | *No description.* | -| pitEnabled | boolean | *No description.* | -| projectId | string | *No description.* | -| replicationSpecs | AdvancedReplicationSpec[] | *No description.* | -| rootCertType | string | *No description.* | -| terminationProtectionEnabled | boolean | *No description.* | -| versionReleaseSystem | string | *No description.* | - ---- - -##### `advancedSettings`Optional - -```typescript -public readonly advancedSettings: ProcessArgs; -``` - -- *Type:* ProcessArgs - ---- - -##### `backupEnabled`Optional - -```typescript -public readonly backupEnabled: boolean; -``` - -- *Type:* boolean - ---- - -##### `biConnector`Optional - -```typescript -public readonly biConnector: CfnClusterPropsBiConnector; -``` - -- *Type:* CfnClusterPropsBiConnector - ---- - -##### `clusterType`Optional - -```typescript -public readonly clusterType: string; -``` - -- *Type:* string - ---- - -##### `connectionStrings`Optional - -```typescript -public readonly connectionStrings: ConnectionStrings; -``` - -- *Type:* ConnectionStrings -- *Default:* REPLICASET - ---- - -##### `diskSizeGb`Optional - -```typescript -public readonly diskSizeGb: number; -``` - -- *Type:* number - ---- - -##### `encryptionAtRestProvider`Optional - -```typescript -public readonly encryptionAtRestProvider: CfnClusterPropsEncryptionAtRestProvider; -``` - -- *Type:* CfnClusterPropsEncryptionAtRestProvider - ---- - -##### `labels`Optional - -```typescript -public readonly labels: CfnClusterPropsLabels[]; -``` - -- *Type:* CfnClusterPropsLabels[] - ---- - -##### `mongoDbMajorVersion`Optional - -```typescript -public readonly mongoDbMajorVersion: string; -``` - -- *Type:* string - ---- - -##### `name`Optional - -```typescript -public readonly name: string; -``` - -- *Type:* string - ---- - -##### `paused`Optional - -```typescript -public readonly paused: boolean; -``` - -- *Type:* boolean -- *Default:* auto-generated - ---- - -##### `pitEnabled`Optional - -```typescript -public readonly pitEnabled: boolean; -``` - -- *Type:* boolean - ---- - -##### `projectId`Optional - -```typescript -public readonly projectId: string; -``` - -- *Type:* string - ---- - -##### `replicationSpecs`Optional - -```typescript -public readonly replicationSpecs: AdvancedReplicationSpec[]; -``` - -- *Type:* AdvancedReplicationSpec[] - ---- - -##### `rootCertType`Optional - -```typescript -public readonly rootCertType: string; -``` - -- *Type:* string - ---- - -##### `terminationProtectionEnabled`Optional - -```typescript -public readonly terminationProtectionEnabled: boolean; -``` - -- *Type:* boolean - ---- - -##### `versionReleaseSystem`Optional - -```typescript -public readonly versionReleaseSystem: string; -``` - -- *Type:* string - ---- - -### Collection - -Array of collections and data sources that map to a stores data store. - -#### Initializer - -```typescript -import { Collection } from 'awscdk-resources-mongodbatlas' - -const collection: Collection = { ... } -``` - -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| dataSources | DataSource[] | Array that contains the data stores that map to a collection for this data lake. | -| name | string | *No description.* | - ---- - -##### `dataSources`Optional - -```typescript -public readonly dataSources: DataSource[]; -``` - -- *Type:* DataSource[] - -Array that contains the data stores that map to a collection for this data lake. - ---- - -##### `name`Optional - -```typescript -public readonly name: string; -``` - -- *Type:* string - ---- - -### Compute - -Automatic Compute Scaling. - -#### Initializer - -```typescript -import { Compute } from 'awscdk-resources-mongodbatlas' - -const compute: Compute = { ... } +```typescript +public readonly eventProcessors: Event; ``` -#### Properties +- *Type:* Event -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| enabled | boolean | Flag that indicates whether someone enabled instance size auto-scaling. | -| maxInstanceSize | string | Maximum instance size to which your cluster can automatically scale. | -| minInstanceSize | string | Minimum instance size to which your cluster can automatically scale. | -| scaleDownEnabled | boolean | Flag that indicates whether the instance size may scale down. | +An object where each field name is an event processor ID and each value is an object that configures its corresponding event processor. + +For an example configuration object, see +[Send Trigger Events to AWS +EventBridge](https://www.mongodb.com/docs/atlas/app-services/triggers/aws-eventbridge/#std-label-event_processor_example). --- -##### `enabled`Optional +##### `functionId`Optional ```typescript -public readonly enabled: boolean; +public readonly functionId: string; ``` -- *Type:* boolean +- *Type:* string -Flag that indicates whether someone enabled instance size auto-scaling. +The ID of the function that the trigger calls when it fires. -Set to true to enable instance size auto-scaling. If enabled, you must specify a value for replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize. -Set to false to disable instance size automatic scaling. +This value is the same as `event_processors.FUNCTION.function_id`. +You can either define the value here or in `event_processors.FUNCTION.function_id`. +The App Services backend duplicates the value to the configuration location where you did not define it. + +For example, if you define `function_id`, the backend duplicates it to `event_processors.FUNCTION.function_id`. --- -##### `maxInstanceSize`Optional +##### `functionName`Optional ```typescript -public readonly maxInstanceSize: string; +public readonly functionName: string; ``` - *Type:* string -Maximum instance size to which your cluster can automatically scale. +The name of the function that the trigger calls when it fires, i.e. the function described by `function_id`. -MongoDB Cloud requires this parameter if "replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled" : true. +This value is the same as `event_processors.FUNCTION.function_name`. +You can either define the value here or in `event_processors.FUNCTION.function_name`. +The App Services backend duplicates the value to the configuration location where you did not define it. + +For example, if you define `function_name`, the backend duplicates it to `event_processors.FUNCTION.function_name`. --- -##### `minInstanceSize`Optional +##### `profile`Optional ```typescript -public readonly minInstanceSize: string; +public readonly profile: string; ``` - *Type:* string -Minimum instance size to which your cluster can automatically scale. +The profile is defined in AWS Secret manager. -MongoDB Cloud requires this parameter if "replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled" : true. +See [Secret Manager Profile setup](../../../examples/profile-secret.yaml). --- -##### `scaleDownEnabled`Optional +##### `scheduleTrigger`Optional ```typescript -public readonly scaleDownEnabled: boolean; +public readonly scheduleTrigger: ScheduleConfig; ``` -- *Type:* boolean +- *Type:* ScheduleConfig -Flag that indicates whether the instance size may scale down. +--- -MongoDB Cloud requires this parameter if "replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled" : true. If you enable this option, specify a value for replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize. +### CfnX509AuthenticationDatabaseUserProps ---- +Generates one X.509 certificate for the specified MongoDB user. Atlas manages the certificate and MongoDB user that belong to one project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List. -### ConnectionStrings +To get MongoDB Cloud to generate a managed certificate for a database user, set `"x509Type" : "MANAGED"` on the desired MongoDB Database User. -Collection of Uniform Resource Locators that point to the MongoDB database. +If you are managing your own Certificate Authority (CA) in Self-Managed X.509 mode, you must generate certificates for database users using your own CA. -#### Initializer +#### Initializer ```typescript -import { ConnectionStrings } from 'awscdk-resources-mongodbatlas' +import { CfnX509AuthenticationDatabaseUserProps } from 'awscdk-resources-mongodbatlas' -const connectionStrings: ConnectionStrings = { ... } +const cfnX509AuthenticationDatabaseUserProps: CfnX509AuthenticationDatabaseUserProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| standard | string | Public connection string that you can use to connect to this cluster. | -| standardSrv | string | Public connection string that you can use to connect to this flex cluster. | +| customerX509 | CustomerX509 | CustomerX509 represents Customer-managed X.509 configuration for an Atlas project. | +| profile | string | Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. | +| projectId | string | The unique identifier for the project . | +| userName | string | Username of the database user to create a certificate for. | --- -##### `standard`Optional +##### `customerX509`Optional ```typescript -public readonly standard: string; +public readonly customerX509: CustomerX509; ``` -- *Type:* string - -Public connection string that you can use to connect to this cluster. +- *Type:* CustomerX509 -This connection string uses the mongodb:// protocol. +CustomerX509 represents Customer-managed X.509 configuration for an Atlas project. --- -##### `standardSrv`Optional +##### `profile`Optional ```typescript -public readonly standardSrv: string; +public readonly profile: string; ``` - *Type:* string -Public connection string that you can use to connect to this flex cluster. - -This connection string uses the mongodb+srv:// protocol. +Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. --- -### CriteriaView - -#### Initializer +##### `projectId`Optional ```typescript -import { CriteriaView } from 'awscdk-resources-mongodbatlas' - -const criteriaView: CriteriaView = { ... } +public readonly projectId: string; ``` -#### Properties +- *Type:* string -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| dateField | string | Indexed database parameter that stores the date that determines when data moves to the online archive. | -| dateFormat | CriteriaViewDateFormat | Syntax used to write the date after which data moves to the online archive. | -| expireAfterDays | number | Number of days after the value in the criteria.dateField when MongoDB Cloud archives data in the specified cluster. Set this parameter when you set "criteria.type" : "DATE". | -| query | string | MongoDB find query that selects documents to archive. | -| type | CriteriaViewType | Means by which MongoDB Cloud selects data to archive. | +The unique identifier for the project . --- -##### `dateField`Optional +##### `userName`Optional ```typescript -public readonly dateField: string; +public readonly userName: string; ``` - *Type:* string -Indexed database parameter that stores the date that determines when data moves to the online archive. - -MongoDB Cloud archives the data when the current date exceeds the date in this database parameter plus the number of days specified through the expireAfterDays parameter. Set this parameter when you set "criteria.type" : "DATE". +Username of the database user to create a certificate for. --- -##### `dateFormat`Optional +### CloudProviderConfig + +Cloud provider linked to this data lake.. + +#### Initializer ```typescript -public readonly dateFormat: CriteriaViewDateFormat; -``` +import { CloudProviderConfig } from 'awscdk-resources-mongodbatlas' -- *Type:* CriteriaViewDateFormat +const cloudProviderConfig: CloudProviderConfig = { ... } +``` -Syntax used to write the date after which data moves to the online archive. +#### Properties -Date can be expressed as ISO 8601 or Epoch timestamps. The Epoch timestamp can be expressed as nanoseconds, milliseconds, or seconds. Set this parameter when "criteria.type" : "DATE". You must set "criteria.type" : "DATE" if "collectionType": "TIMESERIES". +| **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. | +| testS3Bucket | string | Name of the S3 data bucket that the provided role ID is authorized to access.Required if specifying cloudProviderConfig. | --- -##### `expireAfterDays`Optional +##### `externalId`Optional ```typescript -public readonly expireAfterDays: number; +public readonly externalId: string; ``` -- *Type:* number +- *Type:* string -Number of days after the value in the criteria.dateField when MongoDB Cloud archives data in the specified cluster. Set this parameter when you set "criteria.type" : "DATE". +Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig. --- -##### `query`Optional +##### `iamAssumedRoleArn`Optional ```typescript -public readonly query: string; +public readonly iamAssumedRoleArn: string; ``` - *Type:* string -MongoDB find query that selects documents to archive. - -The specified query follows the syntax of the db.collection.find(query) command. This query can't use the empty document ({}) to return all documents. Set this parameter when "criteria.type" : "CUSTOM". +Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the data lake assumes when accessing data stores. --- -##### `type`Optional +##### `iamUserArn`Optional ```typescript -public readonly type: CriteriaViewType; +public readonly iamUserArn: string; ``` -- *Type:* CriteriaViewType - -Means by which MongoDB Cloud selects data to archive. +- *Type:* string -Data can be chosen using the age of the data or a MongoDB query. **DATE** selects documents to archive based on a date. (if DATE is selected, the PartitionFields.FieldName must be completed with the Criteria.DateField value)**CUSTOM** selects documents to archive based on a custom JSON query (When selecting this option, the Query property must be inputted). MongoDB Cloud doesn't support **CUSTOM** when `collectionType: TIMESERIES`. +Amazon Resource Name (ARN) of the user that the data lake assumes when accessing data stores. --- -### CustomerX509 - -#### Initializer +##### `roleId`Optional ```typescript -import { CustomerX509 } from 'awscdk-resources-mongodbatlas' - -const customerX509: CustomerX509 = { ... } +public readonly roleId: string; ``` -#### Properties +- *Type:* string -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| cas | string | PEM string containing one or more customer CAs for database user authentication. | +Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig. --- -##### `cas`Optional +##### `testS3Bucket`Optional ```typescript -public readonly cas: string; +public readonly testS3Bucket: string; ``` - *Type:* string -PEM string containing one or more customer CAs for database user authentication. +Name of the S3 data bucket that the provided role ID is authorized to access.Required if specifying cloudProviderConfig. --- -### Database +### ClusterProps -#### Initializer +#### Initializer ```typescript -import { Database } from 'awscdk-resources-mongodbatlas' +import { ClusterProps } from 'awscdk-resources-mongodbatlas' -const database: Database = { ... } +const clusterProps: ClusterProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| 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. | -| views | View[] | Array of aggregation pipelines that apply to the collection. | +| advancedSettings | ProcessArgs | *No description.* | +| backupEnabled | boolean | *No description.* | +| biConnector | CfnClusterPropsBiConnector | *No description.* | +| clusterType | string | *No description.* | +| connectionStrings | ConnectionStrings | *No description.* | +| diskSizeGb | number | *No description.* | +| encryptionAtRestProvider | CfnClusterPropsEncryptionAtRestProvider | *No description.* | +| labels | CfnClusterPropsLabels[] | *No description.* | +| mongoDbMajorVersion | string | *No description.* | +| name | string | *No description.* | +| paused | boolean | *No description.* | +| pitEnabled | boolean | *No description.* | +| projectId | string | *No description.* | +| replicationSpecs | AdvancedReplicationSpec[] | *No description.* | +| rootCertType | string | *No description.* | +| terminationProtectionEnabled | boolean | *No description.* | +| versionReleaseSystem | string | *No description.* | --- -##### `collections`Optional +##### `advancedSettings`Optional ```typescript -public readonly collections: Collection[]; +public readonly advancedSettings: ProcessArgs; ``` -- *Type:* Collection[] - -Array of collections and data sources that map to a stores data store. +- *Type:* ProcessArgs --- -##### `maxWildcardCollections`Optional +##### `backupEnabled`Optional ```typescript -public readonly maxWildcardCollections: string; +public readonly backupEnabled: boolean; ``` -- *Type:* string - -Maximum number of wildcard collections in the database. - -This only applies to S3 data sources. +- *Type:* boolean --- -##### `name`Optional +##### `biConnector`Optional ```typescript -public readonly name: string; +public readonly biConnector: CfnClusterPropsBiConnector; ``` -- *Type:* string - -Human-readable label that identifies the database to which the data lake maps data. +- *Type:* CfnClusterPropsBiConnector --- -##### `views`Optional +##### `clusterType`Optional ```typescript -public readonly views: View[]; +public readonly clusterType: string; ``` -- *Type:* View[] - -Array of aggregation pipelines that apply to the collection. - -This only applies to S3 data sources. +- *Type:* string --- -### DatabaseConfig - -#### Initializer +##### `connectionStrings`Optional ```typescript -import { DatabaseConfig } from 'awscdk-resources-mongodbatlas' - -const databaseConfig: DatabaseConfig = { ... } +public readonly connectionStrings: ConnectionStrings; ``` -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| collection | string | The name of a collection in the specified database. | -| database | string | The name of a database in the linked data source. | -| fullDocument | boolean | If `true`, indicates that `UPDATE` change events should include the most current [majority-committed](https://www.mongodb.com/docs/manual/reference/read-concern-majority/) version of the modified document in the `fullDocument` field. | -| fullDocumentBeforeChange | boolean | If true, indicates that `UPDATE` change events should include a snapshot of the modified document from immediately before the update was applied. | -| match | string | stringify version of a [$match](https://www.mongodb.com/docs/manual/reference/operator/aggregation/match) expression filters change events. The trigger will only fire if the expression evaluates to true for a given change event. | -| maximumThroughput | boolean | If `true`, the trigger will use the maximize throughput option (https://www.mongodb.com/docs/atlas/app-services/triggers/database-triggers/#std-label-triggers-maximum-throughput). | -| operationTypes | DatabaseConfigOperationTypes[] | The type(s) of MongoDB change event that the trigger listens for. | -| project | string | stringify version of a [$project](https://www.mongodb.com/docs/manual/reference/operator/aggregation/project/) expressions to limit the data included in each event. | -| serviceId | string | The _id value of a linked MongoDB data source. | -| skipCatchupEvents | boolean | If `true`, enabling the Trigger after it was disabled will not invoke events that occurred while the Trigger was disabled. | -| tolerateResumeErrors | boolean | If `true`, when this Trigger's resume token cannot be found in the cluster's oplog, the Trigger automatically resumes processing events at the next relevant change stream event. | -| unordered | boolean | If `true`, event ordering is disabled and this Trigger can process events in parallel. | +- *Type:* ConnectionStrings +- *Default:* REPLICASET --- -##### `collection`Optional +##### `diskSizeGb`Optional ```typescript -public readonly collection: string; +public readonly diskSizeGb: number; ``` -- *Type:* string - -The name of a collection in the specified database. - -The -trigger listens to events from this collection. +- *Type:* number --- -##### `database`Optional +##### `encryptionAtRestProvider`Optional ```typescript -public readonly database: string; +public readonly encryptionAtRestProvider: CfnClusterPropsEncryptionAtRestProvider; ``` -- *Type:* string - -The name of a database in the linked data source. +- *Type:* CfnClusterPropsEncryptionAtRestProvider --- -##### `fullDocument`Optional +##### `labels`Optional ```typescript -public readonly fullDocument: boolean; +public readonly labels: CfnClusterPropsLabels[]; ``` -- *Type:* boolean - -If `true`, indicates that `UPDATE` change events should include the most current [majority-committed](https://www.mongodb.com/docs/manual/reference/read-concern-majority/) version of the modified document in the `fullDocument` field. +- *Type:* CfnClusterPropsLabels[] --- -##### `fullDocumentBeforeChange`Optional +##### `mongoDbMajorVersion`Optional ```typescript -public readonly fullDocumentBeforeChange: boolean; +public readonly mongoDbMajorVersion: string; ``` -- *Type:* boolean - -If true, indicates that `UPDATE` change events should include a snapshot of the modified document from immediately before the update was applied. - -You must enable [document -preimages](https://www.mongodb.com/docs/atlas/app-services/mongodb/preimages/) -for your cluster to include these snapshots. +- *Type:* string --- -##### `match`Optional +##### `name`Optional ```typescript -public readonly match: string; +public readonly name: string; ``` - *Type:* string -stringify version of a [$match](https://www.mongodb.com/docs/manual/reference/operator/aggregation/match) expression filters change events. The trigger will only fire if the expression evaluates to true for a given change event. - --- -##### `maximumThroughput`Optional +##### `paused`Optional ```typescript -public readonly maximumThroughput: boolean; +public readonly paused: boolean; ``` - *Type:* boolean - -If `true`, the trigger will use the maximize throughput option (https://www.mongodb.com/docs/atlas/app-services/triggers/database-triggers/#std-label-triggers-maximum-throughput). +- *Default:* auto-generated --- -##### `operationTypes`Optional +##### `pitEnabled`Optional ```typescript -public readonly operationTypes: DatabaseConfigOperationTypes[]; +public readonly pitEnabled: boolean; ``` -- *Type:* DatabaseConfigOperationTypes[] - -The type(s) of MongoDB change event that the trigger listens for. +- *Type:* boolean --- -##### `project`Optional +##### `projectId`Optional ```typescript -public readonly project: string; +public readonly projectId: string; ``` - *Type:* string -stringify version of a [$project](https://www.mongodb.com/docs/manual/reference/operator/aggregation/project/) expressions to limit the data included in each event. - --- -##### `serviceId`Optional +##### `replicationSpecs`Optional ```typescript -public readonly serviceId: string; +public readonly replicationSpecs: AdvancedReplicationSpec[]; ``` -- *Type:* string - -The _id value of a linked MongoDB data source. - -See [Get a Data Source](#operation/adminGetService). +- *Type:* AdvancedReplicationSpec[] --- -##### `skipCatchupEvents`Optional +##### `rootCertType`Optional ```typescript -public readonly skipCatchupEvents: boolean; +public readonly rootCertType: string; ``` -- *Type:* boolean - -If `true`, enabling the Trigger after it was disabled will not invoke events that occurred while the Trigger was disabled. +- *Type:* string --- -##### `tolerateResumeErrors`Optional +##### `terminationProtectionEnabled`Optional ```typescript -public readonly tolerateResumeErrors: boolean; +public readonly terminationProtectionEnabled: boolean; ``` - *Type:* boolean -If `true`, when this Trigger's resume token cannot be found in the cluster's oplog, the Trigger automatically resumes processing events at the next relevant change stream event. - -All change stream events from when the Trigger was suspended until the Trigger -resumes execution do not have the Trigger fire for them. - --- -##### `unordered`Optional +##### `versionReleaseSystem`Optional ```typescript -public readonly unordered: boolean; +public readonly versionReleaseSystem: string; ``` -- *Type:* boolean - -If `true`, event ordering is disabled and this Trigger can process events in parallel. - -If `false`, event -ordering is enabled and the Trigger executes events -serially. +- *Type:* string --- -### DatabaseUserProps +### Collection -#### Initializer +Array of collections and data sources that map to a stores data store. + +#### Initializer ```typescript -import { DatabaseUserProps } from 'awscdk-resources-mongodbatlas' +import { Collection } from 'awscdk-resources-mongodbatlas' -const databaseUserProps: DatabaseUserProps = { ... } +const collection: Collection = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| awsiamType | CfnDatabaseUserPropsAwsiamType | *No description.* | -| databaseName | string | *No description.* | -| deleteAfterDate | string | *No description.* | -| labels | LabelDefinition[] | *No description.* | -| ldapAuthType | CfnDatabaseUserPropsLdapAuthType | *No description.* | -| password | string | *No description.* | -| projectId | string | *No description.* | -| roles | RoleDefinition[] | *No description.* | -| scopes | ScopeDefinition[] | *No description.* | -| username | string | *No description.* | -| x509Type | CfnDatabaseUserPropsX509Type | *No description.* | +| dataSources | DataSource[] | Array that contains the data stores that map to a collection for this data lake. | +| name | string | *No description.* | --- -##### `awsiamType`Optional +##### `dataSources`Optional ```typescript -public readonly awsiamType: CfnDatabaseUserPropsAwsiamType; +public readonly dataSources: DataSource[]; ``` -- *Type:* CfnDatabaseUserPropsAwsiamType +- *Type:* DataSource[] + +Array that contains the data stores that map to a collection for this data lake. --- -##### `databaseName`Optional +##### `name`Optional ```typescript -public readonly databaseName: string; +public readonly name: string; ``` - *Type:* string --- -##### `deleteAfterDate`Optional - -```typescript -public readonly deleteAfterDate: string; -``` - -- *Type:* string +### Compute ---- +Automatic Compute Scaling. -##### `labels`Optional +#### Initializer ```typescript -public readonly labels: LabelDefinition[]; +import { Compute } from 'awscdk-resources-mongodbatlas' + +const compute: Compute = { ... } ``` -- *Type:* LabelDefinition[] -- *Default:* admin +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| enabled | boolean | Flag that indicates whether someone enabled instance size auto-scaling. | +| maxInstanceSize | string | Maximum instance size to which your cluster can automatically scale. | +| minInstanceSize | string | Minimum instance size to which your cluster can automatically scale. | +| scaleDownEnabled | boolean | Flag that indicates whether the instance size may scale down. | --- -##### `ldapAuthType`Optional +##### `enabled`Optional ```typescript -public readonly ldapAuthType: CfnDatabaseUserPropsLdapAuthType; +public readonly enabled: boolean; ``` -- *Type:* CfnDatabaseUserPropsLdapAuthType +- *Type:* boolean + +Flag that indicates whether someone enabled instance size auto-scaling. + +Set to true to enable instance size auto-scaling. If enabled, you must specify a value for replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize. +Set to false to disable instance size automatic scaling. --- -##### `password`Optional +##### `maxInstanceSize`Optional ```typescript -public readonly password: string; +public readonly maxInstanceSize: string; ``` - *Type:* string +Maximum instance size to which your cluster can automatically scale. + +MongoDB Cloud requires this parameter if "replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled" : true. + --- -##### `projectId`Optional +##### `minInstanceSize`Optional ```typescript -public readonly projectId: string; +public readonly minInstanceSize: string; ``` - *Type:* string -- *Default:* cdk-pwd + +Minimum instance size to which your cluster can automatically scale. + +MongoDB Cloud requires this parameter if "replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled" : true. --- -##### `roles`Optional +##### `scaleDownEnabled`Optional ```typescript -public readonly roles: RoleDefinition[]; +public readonly scaleDownEnabled: boolean; ``` -- *Type:* RoleDefinition[] +- *Type:* boolean + +Flag that indicates whether the instance size may scale down. + +MongoDB Cloud requires this parameter if "replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled" : true. If you enable this option, specify a value for replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize. --- -##### `scopes`Optional +### ConnectionStrings + +Collection of Uniform Resource Locators that point to the MongoDB database. + +#### Initializer ```typescript -public readonly scopes: ScopeDefinition[]; +import { ConnectionStrings } from 'awscdk-resources-mongodbatlas' + +const connectionStrings: ConnectionStrings = { ... } ``` -- *Type:* ScopeDefinition[] +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| standard | string | Public connection string that you can use to connect to this cluster. | +| standardSrv | string | Public connection string that you can use to connect to this flex cluster. | --- -##### `username`Optional +##### `standard`Optional ```typescript -public readonly username: string; +public readonly standard: string; ``` - *Type:* string -- *Default:* cdk-user + +Public connection string that you can use to connect to this cluster. + +This connection string uses the mongodb:// protocol. --- -##### `x509Type`Optional +##### `standardSrv`Optional ```typescript -public readonly x509Type: CfnDatabaseUserPropsX509Type; +public readonly standardSrv: string; ``` -- *Type:* CfnDatabaseUserPropsX509Type +- *Type:* string + +Public connection string that you can use to connect to this flex cluster. + +This connection string uses the mongodb+srv:// protocol. --- -### DatadogIntegrationProps +### CriteriaView -#### Initializer +#### Initializer ```typescript -import { DatadogIntegrationProps } from 'awscdk-resources-mongodbatlas' +import { CriteriaView } from 'awscdk-resources-mongodbatlas' -const datadogIntegrationProps: DatadogIntegrationProps = { ... } +const criteriaView: CriteriaView = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| projectId | string | Unique 24-hexadecimal digit string that identifies your project. | -| profile | string | Atlas API keys. | -| apiKey | string | Key that allows MongoDB Cloud to access your Datadog account. | -| region | DatadogRegion | Two-letter code that indicates which regional URL MongoDB uses to access the Datadog API. | +| dateField | string | Indexed database parameter that stores the date that determines when data moves to the online archive. | +| dateFormat | CriteriaViewDateFormat | Syntax used to write the date after which data moves to the online archive. | +| expireAfterDays | number | Number of days after the value in the criteria.dateField when MongoDB Cloud archives data in the specified cluster. Set this parameter when you set "criteria.type" : "DATE". | +| query | string | MongoDB find query that selects documents to archive. | +| type | CriteriaViewType | Means by which MongoDB Cloud selects data to archive. | --- -##### `projectId`Required +##### `dateField`Optional ```typescript -public readonly projectId: string; +public readonly dateField: string; ``` - *Type:* string -Unique 24-hexadecimal digit string that identifies your project. +Indexed database parameter that stores the date that determines when data moves to the online archive. + +MongoDB Cloud archives the data when the current date exceeds the date in this database parameter plus the number of days specified through the expireAfterDays parameter. Set this parameter when you set "criteria.type" : "DATE". --- -##### `profile`Optional +##### `dateFormat`Optional ```typescript -public readonly profile: string; +public readonly dateFormat: CriteriaViewDateFormat; ``` -- *Type:* string +- *Type:* CriteriaViewDateFormat -Atlas API keys. +Syntax used to write the date after which data moves to the online archive. + +Date can be expressed as ISO 8601 or Epoch timestamps. The Epoch timestamp can be expressed as nanoseconds, milliseconds, or seconds. Set this parameter when "criteria.type" : "DATE". You must set "criteria.type" : "DATE" if "collectionType": "TIMESERIES". --- -##### `apiKey`Required +##### `expireAfterDays`Optional ```typescript -public readonly apiKey: string; +public readonly expireAfterDays: number; ``` -- *Type:* string +- *Type:* number -Key that allows MongoDB Cloud to access your Datadog account. +Number of days after the value in the criteria.dateField when MongoDB Cloud archives data in the specified cluster. Set this parameter when you set "criteria.type" : "DATE". --- -##### `region`Required +##### `query`Optional ```typescript -public readonly region: DatadogRegion; +public readonly query: string; ``` -- *Type:* DatadogRegion +- *Type:* string -Two-letter code that indicates which regional URL MongoDB uses to access the Datadog API. +MongoDB find query that selects documents to archive. ---- +The specified query follows the syntax of the db.collection.find(query) command. This query can't use the empty document ({}) to return all documents. Set this parameter when "criteria.type" : "CUSTOM". -### DataLakeAwsCloudProviderConfigView +--- -#### Initializer +##### `type`Optional ```typescript -import { DataLakeAwsCloudProviderConfigView } from 'awscdk-resources-mongodbatlas' - -const dataLakeAwsCloudProviderConfigView: DataLakeAwsCloudProviderConfigView = { ... } +public readonly type: CriteriaViewType; ``` -#### Properties +- *Type:* CriteriaViewType -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| externalId | string | Unique identifier associated with the Identity and Access Management (IAM) role that the data lake assumes when accessing the data stores. | -| 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. | -| testS3Bucket | string | Name of the S3 data bucket that the provided role ID is authorized to access.Required if specifying cloudProviderConfig. | +Means by which MongoDB Cloud selects data to archive. + +Data can be chosen using the age of the data or a MongoDB query. **DATE** selects documents to archive based on a date. (if DATE is selected, the PartitionFields.FieldName must be completed with the Criteria.DateField value)**CUSTOM** selects documents to archive based on a custom JSON query (When selecting this option, the Query property must be inputted). MongoDB Cloud doesn't support **CUSTOM** when `collectionType: TIMESERIES`. --- -##### `externalId`Optional +### CustomerX509 + +#### Initializer ```typescript -public readonly externalId: string; +import { CustomerX509 } from 'awscdk-resources-mongodbatlas' + +const customerX509: CustomerX509 = { ... } ``` -- *Type:* string +#### Properties -Unique identifier associated with the Identity and Access Management (IAM) role that the data lake assumes when accessing the data stores. +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| cas | string | PEM string containing one or more customer CAs for database user authentication. | --- -##### `iamAssumedRoleArn`Optional +##### `cas`Optional ```typescript -public readonly iamAssumedRoleArn: string; +public readonly cas: string; ``` - *Type:* string -Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the data lake assumes when accessing data stores. +PEM string containing one or more customer CAs for database user authentication. --- -##### `iamUserArn`Optional +### Database + +#### Initializer ```typescript -public readonly iamUserArn: string; +import { Database } from 'awscdk-resources-mongodbatlas' + +const database: Database = { ... } ``` -- *Type:* string +#### Properties -Amazon Resource Name (ARN) of the user that the data lake assumes when accessing data stores. +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| 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. | +| views | View[] | Array of aggregation pipelines that apply to the collection. | --- -##### `roleId`Optional +##### `collections`Optional ```typescript -public readonly roleId: string; +public readonly collections: Collection[]; ``` -- *Type:* string +- *Type:* Collection[] -Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig. +Array of collections and data sources that map to a stores data store. --- -##### `testS3Bucket`Optional +##### `maxWildcardCollections`Optional ```typescript -public readonly testS3Bucket: string; +public readonly maxWildcardCollections: string; ``` - *Type:* string -Name of the S3 data bucket that the provided role ID is authorized to access.Required if specifying cloudProviderConfig. +Maximum number of wildcard collections in the database. ---- +This only applies to S3 data sources. -### DataLakeCloudProviderConfigView +--- -#### Initializer +##### `name`Optional ```typescript -import { DataLakeCloudProviderConfigView } from 'awscdk-resources-mongodbatlas' - -const dataLakeCloudProviderConfigView: DataLakeCloudProviderConfigView = { ... } +public readonly name: string; ``` -#### Properties +- *Type:* string -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| aws | DataLakeAwsCloudProviderConfigView | Name of the cloud service that hosts the data lake's data stores. | +Human-readable label that identifies the database to which the data lake maps data. --- -##### `aws`Optional +##### `views`Optional ```typescript -public readonly aws: DataLakeAwsCloudProviderConfigView; +public readonly views: View[]; ``` -- *Type:* DataLakeAwsCloudProviderConfigView +- *Type:* View[] -Name of the cloud service that hosts the data lake's data stores. +Array of aggregation pipelines that apply to the collection. + +This only applies to S3 data sources. --- -### DataLakeDatabaseCollectionView +### DatabaseConfig -#### Initializer +#### Initializer ```typescript -import { DataLakeDatabaseCollectionView } from 'awscdk-resources-mongodbatlas' +import { DatabaseConfig } from 'awscdk-resources-mongodbatlas' -const dataLakeDatabaseCollectionView: DataLakeDatabaseCollectionView = { ... } +const databaseConfig: DatabaseConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| dataSources | DataLakeDatabaseDataSourceView[] | Array that contains the data stores that map to a collection for this data lake. | -| name | string | Human-readable label that identifies the collection to which MongoDB Cloud maps the data in the data stores. | +| collection | string | The name of a collection in the specified database. | +| database | string | The name of a database in the linked data source. | +| fullDocument | boolean | If `true`, indicates that `UPDATE` change events should include the most current [majority-committed](https://www.mongodb.com/docs/manual/reference/read-concern-majority/) version of the modified document in the `fullDocument` field. | +| fullDocumentBeforeChange | boolean | If true, indicates that `UPDATE` change events should include a snapshot of the modified document from immediately before the update was applied. | +| match | string | stringify version of a [$match](https://www.mongodb.com/docs/manual/reference/operator/aggregation/match) expression filters change events. The trigger will only fire if the expression evaluates to true for a given change event. | +| maximumThroughput | boolean | If `true`, the trigger will use the maximize throughput option (https://www.mongodb.com/docs/atlas/app-services/triggers/database-triggers/#std-label-triggers-maximum-throughput). | +| operationTypes | DatabaseConfigOperationTypes[] | The type(s) of MongoDB change event that the trigger listens for. | +| project | string | stringify version of a [$project](https://www.mongodb.com/docs/manual/reference/operator/aggregation/project/) expressions to limit the data included in each event. | +| serviceId | string | The _id value of a linked MongoDB data source. | +| skipCatchupEvents | boolean | If `true`, enabling the Trigger after it was disabled will not invoke events that occurred while the Trigger was disabled. | +| tolerateResumeErrors | boolean | If `true`, when this Trigger's resume token cannot be found in the cluster's oplog, the Trigger automatically resumes processing events at the next relevant change stream event. | +| unordered | boolean | If `true`, event ordering is disabled and this Trigger can process events in parallel. | --- -##### `dataSources`Optional +##### `collection`Optional ```typescript -public readonly dataSources: DataLakeDatabaseDataSourceView[]; +public readonly collection: string; ``` -- *Type:* DataLakeDatabaseDataSourceView[] +- *Type:* string + +The name of a collection in the specified database. -Array that contains the data stores that map to a collection for this data lake. +The +trigger listens to events from this collection. --- -##### `name`Optional +##### `database`Optional ```typescript -public readonly name: string; +public readonly database: string; ``` - *Type:* string -Human-readable label that identifies the collection to which MongoDB Cloud maps the data in the data stores. +The name of a database in the linked data source. --- -### DataLakeDatabaseDataSourceView - -#### Initializer +##### `fullDocument`Optional ```typescript -import { DataLakeDatabaseDataSourceView } from 'awscdk-resources-mongodbatlas' - -const dataLakeDatabaseDataSourceView: DataLakeDatabaseDataSourceView = { ... } +public readonly fullDocument: boolean; ``` -#### Properties +- *Type:* boolean -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| allowInsecure | boolean | Flag that validates the scheme in the specified URLs. | -| collection | string | Human-readable label that identifies the collection in the database. | -| collectionRegex | string | Regex pattern to use for creating the wildcard (*) collection. | -| database | string | Human-readable label that identifies the database, which contains the collection in the cluster. | -| defaultFormat | DataLakeDatabaseDataSourceViewDefaultFormat | File format that MongoDB Cloud uses if it encounters a file without a file extension while searching **storeName**. | -| path | string | File path that controls how MongoDB Cloud searches for and parses files in the **storeName** before mapping them to a collection.Specify ``/`` to capture all files and folders from the ``prefix`` path. | -| storeName | string | Human-readable label that identifies the data store that MongoDB Cloud maps to the collection. | -| urls | string[] | URLs of the publicly accessible data files. | +If `true`, indicates that `UPDATE` change events should include the most current [majority-committed](https://www.mongodb.com/docs/manual/reference/read-concern-majority/) version of the modified document in the `fullDocument` field. --- -##### `allowInsecure`Optional +##### `fullDocumentBeforeChange`Optional ```typescript -public readonly allowInsecure: boolean; +public readonly fullDocumentBeforeChange: boolean; ``` - *Type:* boolean -Flag that validates the scheme in the specified URLs. +If true, indicates that `UPDATE` change events should include a snapshot of the modified document from immediately before the update was applied. -If `true`, allows insecure `HTTP` scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If `false`, allows secure `HTTPS` scheme only. +You must enable [document +preimages](https://www.mongodb.com/docs/atlas/app-services/mongodb/preimages/) +for your cluster to include these snapshots. --- -##### `collection`Optional +##### `match`Optional ```typescript -public readonly collection: string; +public readonly match: string; ``` - *Type:* string -Human-readable label that identifies the collection in the database. - -For creating a wildcard (`*`) collection, you must omit this parameter. +stringify version of a [$match](https://www.mongodb.com/docs/manual/reference/operator/aggregation/match) expression filters change events. The trigger will only fire if the expression evaluates to true for a given change event. --- -##### `collectionRegex`Optional +##### `maximumThroughput`Optional ```typescript -public readonly collectionRegex: string; +public readonly maximumThroughput: boolean; ``` -- *Type:* string +- *Type:* boolean -Regex pattern to use for creating the wildcard (*) collection. +If `true`, the trigger will use the maximize throughput option (https://www.mongodb.com/docs/atlas/app-services/triggers/database-triggers/#std-label-triggers-maximum-throughput). + +--- + +##### `operationTypes`Optional + +```typescript +public readonly operationTypes: DatabaseConfigOperationTypes[]; +``` + +- *Type:* DatabaseConfigOperationTypes[] -To learn more about the regex syntax, see [Go programming language](https://pkg.go.dev/regexp). +The type(s) of MongoDB change event that the trigger listens for. --- -##### `database`Optional +##### `project`Optional ```typescript -public readonly database: string; +public readonly project: string; ``` - *Type:* string -Human-readable label that identifies the database, which contains the collection in the cluster. - -You must omit this parameter to generate wildcard (`*`) collections for dynamically generated databases. +stringify version of a [$project](https://www.mongodb.com/docs/manual/reference/operator/aggregation/project/) expressions to limit the data included in each event. --- -##### `defaultFormat`Optional +##### `serviceId`Optional ```typescript -public readonly defaultFormat: DataLakeDatabaseDataSourceViewDefaultFormat; +public readonly serviceId: string; ``` -- *Type:* DataLakeDatabaseDataSourceViewDefaultFormat +- *Type:* string + +The _id value of a linked MongoDB data source. -File format that MongoDB Cloud uses if it encounters a file without a file extension while searching **storeName**. +See [Get a Data Source](#operation/adminGetService). --- -##### `path`Optional +##### `skipCatchupEvents`Optional ```typescript -public readonly path: string; +public readonly skipCatchupEvents: boolean; ``` -- *Type:* string +- *Type:* boolean -File path that controls how MongoDB Cloud searches for and parses files in the **storeName** before mapping them to a collection.Specify ``/`` to capture all files and folders from the ``prefix`` path. +If `true`, enabling the Trigger after it was disabled will not invoke events that occurred while the Trigger was disabled. --- -##### `storeName`Optional +##### `tolerateResumeErrors`Optional ```typescript -public readonly storeName: string; +public readonly tolerateResumeErrors: boolean; ``` -- *Type:* string +- *Type:* boolean -Human-readable label that identifies the data store that MongoDB Cloud maps to the collection. +If `true`, when this Trigger's resume token cannot be found in the cluster's oplog, the Trigger automatically resumes processing events at the next relevant change stream event. + +All change stream events from when the Trigger was suspended until the Trigger +resumes execution do not have the Trigger fire for them. --- -##### `urls`Optional +##### `unordered`Optional ```typescript -public readonly urls: string[]; +public readonly unordered: boolean; ``` -- *Type:* string[] +- *Type:* boolean -URLs of the publicly accessible data files. +If `true`, event ordering is disabled and this Trigger can process events in parallel. -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. +If `false`, event +ordering is enabled and the Trigger executes events +serially. --- -### DataLakeDatabaseView +### DatabaseUserProps -#### Initializer +#### Initializer ```typescript -import { DataLakeDatabaseView } from 'awscdk-resources-mongodbatlas' +import { DatabaseUserProps } from 'awscdk-resources-mongodbatlas' -const dataLakeDatabaseView: DataLakeDatabaseView = { ... } +const databaseUserProps: DatabaseUserProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| collections | DataLakeDatabaseCollectionView[] | Array of collections and data sources that map to a ``stores`` data store. | -| maxWildcardCollections | number | Maximum number of wildcard collections in the database. | -| name | string | Human-readable label that identifies the database to which the data lake maps data. | -| views | DataLakeViewView[] | Array of aggregation pipelines that apply to the collection. | +| awsiamType | CfnDatabaseUserPropsAwsiamType | *No description.* | +| databaseName | string | *No description.* | +| deleteAfterDate | string | *No description.* | +| labels | LabelDefinition[] | *No description.* | +| ldapAuthType | CfnDatabaseUserPropsLdapAuthType | *No description.* | +| password | string | *No description.* | +| projectId | string | *No description.* | +| roles | RoleDefinition[] | *No description.* | +| scopes | ScopeDefinition[] | *No description.* | +| username | string | *No description.* | +| x509Type | CfnDatabaseUserPropsX509Type | *No description.* | --- -##### `collections`Optional +##### `awsiamType`Optional ```typescript -public readonly collections: DataLakeDatabaseCollectionView[]; +public readonly awsiamType: CfnDatabaseUserPropsAwsiamType; ``` -- *Type:* DataLakeDatabaseCollectionView[] - -Array of collections and data sources that map to a ``stores`` data store. +- *Type:* CfnDatabaseUserPropsAwsiamType --- -##### `maxWildcardCollections`Optional +##### `databaseName`Optional ```typescript -public readonly maxWildcardCollections: number; +public readonly databaseName: string; ``` -- *Type:* number - -Maximum number of wildcard collections in the database. - -This only applies to S3 data sources. +- *Type:* string --- -##### `name`Optional +##### `deleteAfterDate`Optional ```typescript -public readonly name: string; +public readonly deleteAfterDate: string; ``` - *Type:* string -Human-readable label that identifies the database to which the data lake maps data. - --- -##### `views`Optional +##### `labels`Optional ```typescript -public readonly views: DataLakeViewView[]; +public readonly labels: LabelDefinition[]; ``` -- *Type:* DataLakeViewView[] +- *Type:* LabelDefinition[] +- *Default:* admin -Array of aggregation pipelines that apply to the collection. +--- -This only applies to S3 data sources. +##### `ldapAuthType`Optional ---- +```typescript +public readonly ldapAuthType: CfnDatabaseUserPropsLdapAuthType; +``` -### DataLakeDataProcessRegionView +- *Type:* CfnDatabaseUserPropsLdapAuthType -#### Initializer +--- -```typescript -import { DataLakeDataProcessRegionView } from 'awscdk-resources-mongodbatlas' +##### `password`Optional -const dataLakeDataProcessRegionView: DataLakeDataProcessRegionView = { ... } +```typescript +public readonly password: string; ``` -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| cloudProvider | DataLakeDataProcessRegionViewCloudProvider | Name of the cloud service that hosts the data lake's data stores. | -| region | DataLakeDataProcessRegionViewRegion | Name of the region to which the data lake routes client connections. | +- *Type:* string --- -##### `cloudProvider`Optional +##### `projectId`Optional ```typescript -public readonly cloudProvider: DataLakeDataProcessRegionViewCloudProvider; +public readonly projectId: string; ``` -- *Type:* DataLakeDataProcessRegionViewCloudProvider - -Name of the cloud service that hosts the data lake's data stores. +- *Type:* string +- *Default:* cdk-pwd --- -##### `region`Optional +##### `roles`Optional ```typescript -public readonly region: DataLakeDataProcessRegionViewRegion; +public readonly roles: RoleDefinition[]; ``` -- *Type:* DataLakeDataProcessRegionViewRegion - -Name of the region to which the data lake routes client connections. +- *Type:* RoleDefinition[] --- -### DataLakeStorageView - -#### Initializer +##### `scopes`Optional ```typescript -import { DataLakeStorageView } from 'awscdk-resources-mongodbatlas' - -const dataLakeStorageView: DataLakeStorageView = { ... } +public readonly scopes: ScopeDefinition[]; ``` -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| databases | DataLakeDatabaseView[] | Array that contains the queryable databases and collections for this data lake. | -| stores | StoreDetail[] | Array that contains the data stores for the data lake. | +- *Type:* ScopeDefinition[] --- -##### `databases`Optional +##### `username`Optional ```typescript -public readonly databases: DataLakeDatabaseView[]; +public readonly username: string; ``` -- *Type:* DataLakeDatabaseView[] - -Array that contains the queryable databases and collections for this data lake. +- *Type:* string +- *Default:* cdk-user --- -##### `stores`Optional +##### `x509Type`Optional ```typescript -public readonly stores: StoreDetail[]; +public readonly x509Type: CfnDatabaseUserPropsX509Type; ``` -- *Type:* StoreDetail[] - -Array that contains the data stores for the data lake. +- *Type:* CfnDatabaseUserPropsX509Type --- -### DataLakeViewView +### DatadogIntegrationProps -#### Initializer +#### Initializer ```typescript -import { DataLakeViewView } from 'awscdk-resources-mongodbatlas' +import { DatadogIntegrationProps } from 'awscdk-resources-mongodbatlas' -const dataLakeViewView: DataLakeViewView = { ... } +const datadogIntegrationProps: DatadogIntegrationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| name | string | Human-readable label that identifies the view, which corresponds to an aggregation pipeline on a collection. | -| pipeline | string | Aggregation pipeline stages to apply to the source collection. | -| source | string | Human-readable label that identifies the source collection for the view. | +| projectId | string | Unique 24-hexadecimal digit string that identifies your project. | +| profile | string | Atlas API keys. | +| apiKey | string | Key that allows MongoDB Cloud to access your Datadog account. | +| region | DatadogRegion | Two-letter code that indicates which regional URL MongoDB uses to access the Datadog API. | --- -##### `name`Optional +##### `projectId`Required ```typescript -public readonly name: string; +public readonly projectId: string; ``` - *Type:* string -Human-readable label that identifies the view, which corresponds to an aggregation pipeline on a collection. +Unique 24-hexadecimal digit string that identifies your project. --- -##### `pipeline`Optional +##### `profile`Optional ```typescript -public readonly pipeline: string; +public readonly profile: string; ``` - *Type:* string -Aggregation pipeline stages to apply to the source collection. +Atlas API keys. --- -##### `source`Optional +##### `apiKey`Required ```typescript -public readonly source: string; +public readonly apiKey: string; ``` - *Type:* string -Human-readable label that identifies the source collection for the view. +Key that allows MongoDB Cloud to access your Datadog account. + +--- + +##### `region`Required + +```typescript +public readonly region: DatadogRegion; +``` + +- *Type:* DatadogRegion + +Two-letter code that indicates which regional URL MongoDB uses to access the Datadog API. --- @@ -45597,53 +43529,6 @@ Service key associated with your PagerDuty account. --- -### PartitionFields - -Ordered fields used to physically organize data in the destination. - -#### Initializer - -```typescript -import { PartitionFields } from 'awscdk-resources-mongodbatlas' - -const partitionFields: PartitionFields = { ... } -``` - -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| fieldName | string | Human-readable label that identifies the field name used to partition data. | -| order | number | Sequence in which MongoDB Cloud slices the collection data to create partitions. | - ---- - -##### `fieldName`Optional - -```typescript -public readonly fieldName: string; -``` - -- *Type:* string - -Human-readable label that identifies the field name used to partition data. - ---- - -##### `order`Optional - -```typescript -public readonly order: number; -``` - -- *Type:* number - -Sequence in which MongoDB Cloud slices the collection data to create partitions. - -The resource expresses this sequence starting with zero. - ---- - ### PartitionFieldView #### Initializer @@ -47051,161 +44936,6 @@ The region you choose can affect network latency for clients accessing your data --- -### Sink - -Ingestion destination of a Data Lake Pipeline. - -#### Initializer - -```typescript -import { Sink } from 'awscdk-resources-mongodbatlas' - -const sink: Sink = { ... } -``` - -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| metadataProvider | string | Target cloud provider for this Data Lake Pipeline. | -| metadataRegion | string | Target cloud provider region for this Data Lake Pipeline. | -| partitionFields | PartitionFields[] | Ordered fields used to physically organize data in the destination. | -| type | SinkType | Type of ingestion destination of this Data Lake Pipeline. | - ---- - -##### `metadataProvider`Optional - -```typescript -public readonly metadataProvider: string; -``` - -- *Type:* string - -Target cloud provider for this Data Lake Pipeline. - ---- - -##### `metadataRegion`Optional - -```typescript -public readonly metadataRegion: string; -``` - -- *Type:* string - -Target cloud provider region for this Data Lake Pipeline. - ---- - -##### `partitionFields`Optional - -```typescript -public readonly partitionFields: PartitionFields[]; -``` - -- *Type:* PartitionFields[] - -Ordered fields used to physically organize data in the destination. - ---- - -##### `type`Optional - -```typescript -public readonly type: SinkType; -``` - -- *Type:* SinkType - -Type of ingestion destination of this Data Lake Pipeline. - ---- - -### Source - -Ingestion destination of a Data Lake Pipeline. - -#### Initializer - -```typescript -import { Source } from 'awscdk-resources-mongodbatlas' - -const source: Source = { ... } -``` - -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| clusterName | string | Human-readable name that identifies the cluster. | -| collectionName | string | Human-readable name that identifies the collection. | -| databaseName | string | Human-readable name that identifies the database. | -| groupId | string | Unique 24-hexadecimal character string that identifies the project. | -| type | SourceType | Type of ingestion source of this Data Lake Pipeline. | - ---- - -##### `clusterName`Optional - -```typescript -public readonly clusterName: string; -``` - -- *Type:* string - -Human-readable name that identifies the cluster. - ---- - -##### `collectionName`Optional - -```typescript -public readonly collectionName: string; -``` - -- *Type:* string - -Human-readable name that identifies the collection. - ---- - -##### `databaseName`Optional - -```typescript -public readonly databaseName: string; -``` - -- *Type:* string - -Human-readable name that identifies the database. - ---- - -##### `groupId`Optional - -```typescript -public readonly groupId: string; -``` - -- *Type:* string - -Unique 24-hexadecimal character string that identifies the project. - ---- - -##### `type`Optional - -```typescript -public readonly type: SourceType; -``` - -- *Type:* SourceType - -Type of ingestion source of this Data Lake Pipeline. - ---- - ### Specs #### Initializer @@ -47421,129 +45151,6 @@ MongoDB Cloud cluster read preference, which describes how to route read request --- -### StoreDetail - -Configuration information for each data store and its mapping to MongoDB Cloud databases. - -#### Initializer - -```typescript -import { StoreDetail } from 'awscdk-resources-mongodbatlas' - -const storeDetail: StoreDetail = { ... } -``` - -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| additionalStorageClasses | string[] | Human-readable label that identifies the Federated Database to update. | -| bucket | string | Human-readable label that identifies the Federated Database to update. | -| delimiter | string | Human-readable label that identifies the Federated Database to update. | -| includeTags | boolean | Human-readable label that identifies the Federated Database to update. | -| name | string | Human-readable label that identifies the data store. | -| prefix | string | Human-readable label that identifies the Federated Database to update. | -| provider | string | Human-readable label that identifies the Federated Database to update. | -| region | string | Human-readable label that identifies the Federated Database to update. | - ---- - -##### `additionalStorageClasses`Optional - -```typescript -public readonly additionalStorageClasses: string[]; -``` - -- *Type:* string[] - -Human-readable label that identifies the Federated Database to update. - ---- - -##### `bucket`Optional - -```typescript -public readonly bucket: string; -``` - -- *Type:* string - -Human-readable label that identifies the Federated Database to update. - ---- - -##### `delimiter`Optional - -```typescript -public readonly delimiter: string; -``` - -- *Type:* string - -Human-readable label that identifies the Federated Database to update. - ---- - -##### `includeTags`Optional - -```typescript -public readonly includeTags: boolean; -``` - -- *Type:* boolean - -Human-readable label that identifies the Federated Database to update. - ---- - -##### `name`Optional - -```typescript -public readonly name: string; -``` - -- *Type:* string - -Human-readable label that identifies the data store. - ---- - -##### `prefix`Optional - -```typescript -public readonly prefix: string; -``` - -- *Type:* string - -Human-readable label that identifies the Federated Database to update. - ---- - -##### `provider`Optional - -```typescript -public readonly provider: string; -``` - -- *Type:* string - -Human-readable label that identifies the Federated Database to update. - ---- - -##### `region`Optional - -```typescript -public readonly region: string; -``` - -- *Type:* string - -Human-readable label that identifies the Federated Database to update. - ---- - ### StreamConfig Configuration options for an Atlas Stream Processing Instance. @@ -48067,51 +45674,6 @@ Atlas API keys. --- -### Transformations - -Ordered fields used to physically organize data in the destination. - -#### Initializer - -```typescript -import { Transformations } from 'awscdk-resources-mongodbatlas' - -const transformations: Transformations = { ... } -``` - -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| field | string | Key in the document. | -| type | string | Type of transformation applied during the export of the namespace in a Data Lake Pipeline. | - ---- - -##### `field`Optional - -```typescript -public readonly field: string; -``` - -- *Type:* string - -Key in the document. - ---- - -##### `type`Optional - -```typescript -public readonly type: string; -``` - -- *Type:* string - -Type of transformation applied during the export of the namespace in a Data Lake Pipeline. - ---- - ### Validation #### Initializer @@ -49742,215 +47304,6 @@ DELETE. --- -### DataLakeDatabaseDataSourceViewDefaultFormat - -File format that MongoDB Cloud uses if it encounters a file without a file extension while searching **storeName**. - -#### Members - -| **Name** | **Description** | -| --- | --- | -| AVRO | .avro. | -| AVRO_GZ | .avro.gz. | -| BSON | .bson. | -| BSON_GZ | .bson.gz. | -| CSV | .csv. | -| JSON | .json. | -| JSON_GZ | .json.gz. | -| ORC | .orc. | -| TSV | .tsv. | -| TSV_GZ | .tsv.gz. | - ---- - -##### `AVRO` - -.avro. - ---- - - -##### `AVRO_GZ` - -.avro.gz. - ---- - - -##### `BSON` - -.bson. - ---- - - -##### `BSON_GZ` - -.bson.gz. - ---- - - -##### `CSV` - -.csv. - ---- - - -##### `JSON` - -.json. - ---- - - -##### `JSON_GZ` - -.json.gz. - ---- - - -##### `ORC` - -.orc. - ---- - - -##### `TSV` - -.tsv. - ---- - - -##### `TSV_GZ` - -.tsv.gz. - ---- - - -### DataLakeDataProcessRegionViewCloudProvider - -Name of the cloud service that hosts the data lake's data stores. - -#### Members - -| **Name** | **Description** | -| --- | --- | -| AWS | AWS. | -| GCP | GCP. | -| AZURE | AZURE. | -| TENANT | TENANT. | -| SERVERLESS | SERVERLESS. | - ---- - -##### `AWS` - -AWS. - ---- - - -##### `GCP` - -GCP. - ---- - - -##### `AZURE` - -AZURE. - ---- - - -##### `TENANT` - -TENANT. - ---- - - -##### `SERVERLESS` - -SERVERLESS. - ---- - - -### DataLakeDataProcessRegionViewRegion - -Name of the region to which the data lake routes client connections. - -#### Members - -| **Name** | **Description** | -| --- | --- | -| DUBLIN_IRL | DUBLIN_IRL. | -| FRANKFURT_DEU | FRANKFURT_DEU. | -| LONDON_GBR | LONDON_GBR. | -| MUMBAI_IND | MUMBAI_IND. | -| OREGON_USA | OREGON_USA. | -| SYDNEY_AUS | SYDNEY_AUS. | -| VIRGINIA_USA | VIRGINIA_USA. | - ---- - -##### `DUBLIN_IRL` - -DUBLIN_IRL. - ---- - - -##### `FRANKFURT_DEU` - -FRANKFURT_DEU. - ---- - - -##### `LONDON_GBR` - -LONDON_GBR. - ---- - - -##### `MUMBAI_IND` - -MUMBAI_IND. - ---- - - -##### `OREGON_USA` - -OREGON_USA. - ---- - - -##### `SYDNEY_AUS` - -SYDNEY_AUS. - ---- - - -##### `VIRGINIA_USA` - -VIRGINIA_USA. - ---- - - ### DbRoleToExecuteType Type of the DB role. @@ -50690,52 +48043,6 @@ SERVERLESS. --- -### SinkType - -Type of ingestion destination of this Data Lake Pipeline. - -#### Members - -| **Name** | **Description** | -| --- | --- | -| DLS | DLS. | - ---- - -##### `DLS` - -DLS. - ---- - - -### SourceType - -Type of ingestion source of this Data Lake Pipeline. - -#### Members - -| **Name** | **Description** | -| --- | --- | -| ON_DEMAND_CPS | ON_DEMAND_CPS. | -| PERIODIC_CPS | PERIODIC_CPS. | - ---- - -##### `ON_DEMAND_CPS` - -ON_DEMAND_CPS. - ---- - - -##### `PERIODIC_CPS` - -PERIODIC_CPS. - ---- - - ### StreamsConnectionType Type of the connection. diff --git a/examples/l1-resources/data-lake-pipeline.ts b/examples/l1-resources/data-lake-pipeline.ts deleted file mode 100644 index 486eb6c4..00000000 --- a/examples/l1-resources/data-lake-pipeline.ts +++ /dev/null @@ -1,69 +0,0 @@ -// This example creates a project and a cluster in Atlas using the L1 resources. -import * as cdk from 'aws-cdk-lib'; -import { Construct } from 'constructs'; -import { CfnDataLakePipeline} from 'awscdk-resources-mongodbatlas'; - -interface AtlasStackProps { - readonly projId: string; - readonly profile: string; - readonly name: string; - readonly clusterName: string; - readonly collectionName: string; - readonly dbName: string; -} - -export class CdkTestingStack extends cdk.Stack { - constructor(scope: Construct, id: string, props?: cdk.StackProps) { - super(scope, id, props); - - const atlasProps = this.getContextProps(); - const sink = {"partitionFields" :[{ - "fieldName": "testpartition2", - "order": 0 - }]}; - - const source = { - "clusterName": atlasProps.clusterName, - "collectionName": atlasProps.collectionName, - "databaseName": atlasProps.dbName - }; - const transform = [ - { - "field" :"testtransformFeild", - "type": "EXCLUDE" - } - ]; - - const datalakePipeline = new CfnDataLakePipeline(this, 'datalakePipeline', { - projectId: atlasProps.projId, - profile: atlasProps.profile, - name: atlasProps.name, - sink:sink, - source: source, - transformations: transform - }); - - } - - getContextProps(): AtlasStackProps { - const projId = this.node.tryGetContext('projId'); - if (!projId){ - throw "No context value specified for projId. Please specify via the cdk context." - } - const name = this.node.tryGetContext('name'); - const clusterName = this.node.tryGetContext('clusterName'); - const profile = this.node.tryGetContext('profile') ?? 'default'; - const dbName = this.node.tryGetContext('dbName'); - const collectionName = this.node.tryGetContext('collectionName'); - - - return { - projId, - profile, - name, - dbName, - collectionName, - clusterName - } - } -} diff --git a/examples/l1-resources/datalake.ts b/examples/l1-resources/datalake.ts deleted file mode 100644 index 163b6e8d..00000000 --- a/examples/l1-resources/datalake.ts +++ /dev/null @@ -1,64 +0,0 @@ -// This example creates a database user in Atlas using the L1 resources. -import * as cdk from 'aws-cdk-lib'; -import { Construct } from 'constructs'; -import { CfnDataLakes, DataLakeDataProcessRegionViewCloudProvider, DataLakeDataProcessRegionViewRegion } from 'awscdk-resources-mongodbatlas'; - -interface AtlasStackProps { - readonly projId: string; - readonly profile: string; - readonly roleId: string; - readonly tenantName: string; - readonly externalId: string; - readonly iamUserArn: string; - readonly testS3Bucket: string; -} - -export class CdkTestingStack extends cdk.Stack { - constructor(scope: Construct, id: string, props?: cdk.StackProps) { - super(scope, id, props); - - const atlasProps = this.getContextProps(); - const dataLake = new CfnDataLakes(this, 'DataLake', { - projectId: atlasProps.projId, - profile: atlasProps.profile, - tenantName : atlasProps.tenantName, - cloudProviderConfig: { - aws: { - roleId: atlasProps.roleId, - externalId: atlasProps.externalId, - iamUserArn: atlasProps.iamUserArn, - testS3Bucket: atlasProps.testS3Bucket, - } - }, - dataProcessRegion: { - cloudProvider: DataLakeDataProcessRegionViewCloudProvider.AWS, - region: DataLakeDataProcessRegionViewRegion.DUBLIN_IRL - } - }); - } - - getContextProps(): AtlasStackProps { - const projId = this.node.tryGetContext('projId'); - if (!projId){ - throw "No context value specified for projId. Please specify via the cdk context." - } - - const profile = this.node.tryGetContext('profile') ?? 'default'; - const tenantName = this.node.tryGetContext('tenantName'); - const roleId = this.node.tryGetContext('roleId'); - const externalId = this.node.tryGetContext('externalId'); - const iamUserArn = this.node.tryGetContext('iamUserArn'); - const testS3Bucket = this.node.tryGetContext('testS3Bucket'); - - - return { - projId, - profile, - roleId, - tenantName, - externalId, - iamUserArn, - testS3Bucket - } - } -} diff --git a/src/README.md b/src/README.md index 447e07cc..4919e952 100644 --- a/src/README.md +++ b/src/README.md @@ -21,7 +21,6 @@ L1 constructs are called Cfn (short for CloudFormation) resources. These resourc | custom-db-role | Returns, adds, edits, and removes custom database user privilege roles. | [README.md](l1-resources/custom-db-role/README.md) | | custom-dns-configuration-cluster-aws | An example resource schema demonstrating some basic constructs and validation rules. | [README.md](l1-resources/custom-dns-configuration-cluster-aws/README.md) | | database-user | Returns, adds, edits, and removes database users. | [README.md](l1-resources/database-user/README.md) | -| datalakes | Returns, adds, edits, and removes Federated Database Instances. | [README.md](l1-resources/datalakes/README.md) | | encryption-at-rest | Returns and edits the Encryption at Rest using Customer Key Management configuration. | [README.md](l1-resources/encryption-at-rest/README.md) | | federated-settings-org-role-mapping | Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations. | [README.md](l1-resources/federated-settings-org-role-mapping/README.md) | | global-cluster-config | Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. | [README.md](l1-resources/global-cluster-config/README.md) | diff --git a/src/index.ts b/src/index.ts index 043734c8..81cd03bf 100644 --- a/src/index.ts +++ b/src/index.ts @@ -124,17 +124,6 @@ export { CfnCustomDnsConfigurationClusterAwsProps, } from "./l1-resources/custom-dns-configuration-cluster-aws"; -export { - CfnDataLakePipeline, - CfnDataLakePipelineProps, - Sink, - SinkType, - Source, - SourceType, - Transformations, - PartitionFields, -} from "./l1-resources/data-lake-pipeline"; - export { CfnDatabaseUser, CfnDatabaseUserProps, @@ -147,23 +136,6 @@ export { ScopeDefinitionType, } from "./l1-resources/database-user"; -export { - CfnDataLakes, - CfnDataLakesProps, - DataLakeAwsCloudProviderConfigView, - DataLakeCloudProviderConfigView, - DataLakeDataProcessRegionView, - DataLakeDataProcessRegionViewCloudProvider, - DataLakeDataProcessRegionViewRegion, - DataLakeDatabaseCollectionView, - DataLakeDatabaseDataSourceView, - DataLakeDatabaseDataSourceViewDefaultFormat, - DataLakeDatabaseView, - DataLakeStorageView, - DataLakeViewView, - StoreDetail, -} from "./l1-resources/datalakes"; - export { AwsKmsConfig, CfnEncryptionAtRest, diff --git a/src/l1-resources/data-lake-pipeline/README.md b/src/l1-resources/data-lake-pipeline/README.md deleted file mode 100644 index ee9ffcf2..00000000 --- a/src/l1-resources/data-lake-pipeline/README.md +++ /dev/null @@ -1,99 +0,0 @@ -# cluster - -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::Cluster` 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 - -Atlas Data Lake takes snapshots of your Atlas cluster, so you can easily analyze data over time. As data is ingested, Atlas Data Lake reformats, creates partition indexes, and partitions data, creating an isolated workload ready to support large and complex queries without impacting your production application. - -## 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/operation/operation-createpipeline) - -## 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::DataLakePipeline \ - --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-Cluster \ - --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: [cluster.ts](../../../examples/l1-resources/dataLakePipeline.ts) -```ts -import { CfnDataLakePipeline } from 'awscdk-resources-mongodbatlas'; - -const clusterRes = new CfnDataLakePipeline(this, 'ClusterResource', { - name: atlasProps.clusterName, - projectId: projectRes.attrId, - profile: atlasProps.profile, - clusterType: atlasProps.clusterType, - backupEnabled: true, - pitEnabled: false, - replicationSpecs: [{ - numShards: 1, - advancedRegionConfigs: [{ - autoScaling: { - diskGb: { - enabled: true, - }, - compute: { - enabled: false, - scaleDownEnabled: false, - }, - }, - analyticsSpecs: { - ebsVolumeType: "STANDARD", - instanceSize: atlasProps.instanceSize, - nodeCount: 3, - }, - electableSpecs: { - ebsVolumeType: "STANDARD", - instanceSize: atlasProps.instanceSize, - nodeCount: 3, - }, - readOnlySpecs: { - ebsVolumeType: "STANDARD", - instanceSize: atlasProps.instanceSize, - nodeCount: 3, - }, - priority: 7, - regionName: atlasProps.region, - }] - }] - }); - -``` - -## 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::Cluster`. - -* 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-cluster+v1.0.0). -* Issues related to `MongoDB::Atlas::Cluster` should be reported to the [publisher](https://github.com/mongodb/mongodbatlas-cloudformation-resources/issues). -* Feature requests should be [reported here](https://feedback.mongodb.com/forums/924145-atlas?category_id=392596) - -[cdklabs/cdk-cloudformation]: https://github.com/cdklabs/cdk-cloudformation - -## License - -Distributed under the Apache-2.0 License. \ No newline at end of file diff --git a/src/l1-resources/data-lake-pipeline/index.ts b/src/l1-resources/data-lake-pipeline/index.ts deleted file mode 100644 index 6eac13ff..00000000 --- a/src/l1-resources/data-lake-pipeline/index.ts +++ /dev/null @@ -1,374 +0,0 @@ -// Generated by cdk-import -import * as cdk from "aws-cdk-lib"; -import * as constructs from "constructs"; - -/** - * Data Lake is deprecated. As of September 2024, Data Lake is deprecated. If you use Data Lake, you should migrate to alternative solutions before the service is removed. To learn more, see . This resource returns, adds, edits, and removes data lake pipelines. - * - * @schema CfnDataLakePipelineProps - */ -export interface CfnDataLakePipelineProps { - /** - * Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used - * - * @schema CfnDataLakePipelineProps#Profile - */ - readonly profile?: string; - - /** - * Unique 24-hexadecimal digit string that identifies your project. - * - * @schema CfnDataLakePipelineProps#ProjectId - */ - readonly projectId: string; - - /** - * State of the Data Lake Pipeline. - * - * @schema CfnDataLakePipelineProps#State - */ - readonly state?: string; - - /** - * Name of this Data Lake Pipeline. - * - * @schema CfnDataLakePipelineProps#Name - */ - readonly name: string; - - /** - * @schema CfnDataLakePipelineProps#Sink - */ - readonly sink: Sink; - - /** - * @schema CfnDataLakePipelineProps#Source - */ - readonly source?: Source; - - /** - * Ingestion destination of a Data Lake Pipeline. - * - * @schema CfnDataLakePipelineProps#Transformations - */ - readonly transformations: Transformations[]; -} - -/** - * Converts an object of type 'CfnDataLakePipelineProps' to JSON representation. - */ -/* eslint-disable max-len, quote-props */ -export function toJson_CfnDataLakePipelineProps( - obj: CfnDataLakePipelineProps | undefined -): Record | undefined { - if (obj === undefined) { - return undefined; - } - const result = { - Profile: obj.profile, - ProjectId: obj.projectId, - State: obj.state, - Name: obj.name, - Sink: toJson_Sink(obj.sink), - Source: toJson_Source(obj.source), - Transformations: obj.transformations?.map((y) => toJson_Transformations(y)), - }; - // 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 */ - -/** - * Ingestion destination of a Data Lake Pipeline. - * - * @schema sink - */ -export interface Sink { - /** - * Type of ingestion destination of this Data Lake Pipeline. - * - * @schema sink#Type - */ - readonly type?: SinkType; - - /** - * Target cloud provider for this Data Lake Pipeline. - * - * @schema sink#MetadataProvider - */ - readonly metadataProvider?: string; - - /** - * Target cloud provider region for this Data Lake Pipeline. - * - * @schema sink#MetadataRegion - */ - readonly metadataRegion?: string; - - /** - * Ordered fields used to physically organize data in the destination. - * - * @schema sink#PartitionFields - */ - readonly partitionFields?: PartitionFields[]; -} - -/** - * Converts an object of type 'Sink' to JSON representation. - */ -/* eslint-disable max-len, quote-props */ -export function toJson_Sink( - obj: Sink | undefined -): Record | undefined { - if (obj === undefined) { - return undefined; - } - const result = { - Type: obj.type, - MetadataProvider: obj.metadataProvider, - MetadataRegion: obj.metadataRegion, - PartitionFields: obj.partitionFields?.map((y) => toJson_PartitionFields(y)), - }; - // 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 */ - -/** - * Ingestion destination of a Data Lake Pipeline. - * - * @schema source - */ -export interface Source { - /** - * Type of ingestion source of this Data Lake Pipeline. - * - * @schema source#Type - */ - readonly type?: SourceType; - - /** - * Human-readable name that identifies the cluster. - * - * @schema source#ClusterName - */ - readonly clusterName?: string; - - /** - * Human-readable name that identifies the collection. - * - * @schema source#CollectionName - */ - readonly collectionName?: string; - - /** - * Human-readable name that identifies the database. - * - * @schema source#DatabaseName - */ - readonly databaseName?: string; - - /** - * Unique 24-hexadecimal character string that identifies the project. - * - * @schema source#GroupId - */ - readonly groupId?: string; -} - -/** - * Converts an object of type 'Source' to JSON representation. - */ -/* eslint-disable max-len, quote-props */ -export function toJson_Source( - obj: Source | undefined -): Record | undefined { - if (obj === undefined) { - return undefined; - } - const result = { - Type: obj.type, - ClusterName: obj.clusterName, - CollectionName: obj.collectionName, - DatabaseName: obj.databaseName, - GroupId: obj.groupId, - }; - // 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 */ - -/** - * Ordered fields used to physically organize data in the destination. - * - * @schema transformations - */ -export interface Transformations { - /** - * Key in the document. - * - * @schema transformations#Field - */ - readonly field?: string; - - /** - * Type of transformation applied during the export of the namespace in a Data Lake Pipeline. - * - * @schema transformations#Type - */ - readonly type?: string; -} - -/** - * Converts an object of type 'Transformations' to JSON representation. - */ -/* eslint-disable max-len, quote-props */ -export function toJson_Transformations( - obj: Transformations | undefined -): Record | undefined { - if (obj === undefined) { - return undefined; - } - const result = { - Field: obj.field, - 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 */ - -/** - * Type of ingestion destination of this Data Lake Pipeline. - * - * @schema SinkType - */ -export enum SinkType { - /** DLS */ - DLS = "DLS", -} - -/** - * Ordered fields used to physically organize data in the destination. - * - * @schema partitionFields - */ -export interface PartitionFields { - /** - * Human-readable label that identifies the field name used to partition data. - * - * @schema partitionFields#FieldName - */ - readonly fieldName?: string; - - /** - * Sequence in which MongoDB Cloud slices the collection data to create partitions. The resource expresses this sequence starting with zero. - * - * @schema partitionFields#Order - */ - readonly order?: number; -} - -/** - * Converts an object of type 'PartitionFields' to JSON representation. - */ -/* eslint-disable max-len, quote-props */ -export function toJson_PartitionFields( - obj: PartitionFields | undefined -): Record | undefined { - if (obj === undefined) { - return undefined; - } - const result = { - FieldName: obj.fieldName, - Order: obj.order, - }; - // 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 */ - -/** - * Type of ingestion source of this Data Lake Pipeline. - * - * @schema SourceType - */ -export enum SourceType { - /** ON_DEMAND_CPS */ - ON_DEMAND_CPS = "ON_DEMAND_CPS", - /** PERIODIC_CPS */ - PERIODIC_CPS = "PERIODIC_CPS", -} - -/** - * A CloudFormation `MongoDB::Atlas::DataLakePipeline` - * - * @cloudformationResource MongoDB::Atlas::DataLakePipeline - * @stability external - */ -export class CfnDataLakePipeline extends cdk.CfnResource { - /** - * The CloudFormation resource type name for this resource class. - */ - public static readonly CFN_RESOURCE_TYPE_NAME = - "MongoDB::Atlas::DataLakePipeline"; - - /** - * Resource props. - */ - public readonly props: CfnDataLakePipelineProps; - - /** - * Attribute `MongoDB::Atlas::DataLakePipeline.CreatedDate` - */ - public readonly attrCreatedDate: string; - /** - * Attribute `MongoDB::Atlas::DataLakePipeline.Id` - */ - public readonly attrId: string; - /** - * Attribute `MongoDB::Atlas::DataLakePipeline.LastUpdatedDate` - */ - public readonly attrLastUpdatedDate: string; - - /** - * Create a new `MongoDB::Atlas::DataLakePipeline`. - * - * @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: CfnDataLakePipelineProps - ) { - super(scope, id, { - type: CfnDataLakePipeline.CFN_RESOURCE_TYPE_NAME, - properties: toJson_CfnDataLakePipelineProps(props)!, - }); - - this.props = props; - - this.attrCreatedDate = cdk.Token.asString(this.getAtt("CreatedDate")); - this.attrId = cdk.Token.asString(this.getAtt("Id")); - this.attrLastUpdatedDate = cdk.Token.asString( - this.getAtt("LastUpdatedDate") - ); - } -} diff --git a/src/l1-resources/data-lake-pipeline/integ.default.ts b/src/l1-resources/data-lake-pipeline/integ.default.ts deleted file mode 100644 index 1115aebb..00000000 --- a/src/l1-resources/data-lake-pipeline/integ.default.ts +++ /dev/null @@ -1,45 +0,0 @@ -import * as cdk from "aws-cdk-lib"; -import { - CfnDataLakePipeline, - CfnDataLakePipelineProps, - Sink, - Source, -} from "./index"; - -const app = new cdk.App(); -const stack = new cdk.Stack(app, "data-lake-pipeline", { - env: { - region: process.env.CDK_DEFAULT_REGION, - account: process.env.CDK_DEFAULT_ACCOUNT, - }, -}); - -const sink: Sink = { - partitionFields: [ - { - fieldName: "testpartition2", - order: 0, - }, - ], -}; -const source: Source = { - clusterName: "testclusterdatalakepipeline", - collectionName: "testcollection3", - databaseName: "testdatabase4", -}; -const transform = [ - { - field: "testtransformFeild", - type: "EXCLUDE", - }, -]; -const datalakepipelineProps: CfnDataLakePipelineProps = { - profile: "default", - name: "testdatalakepipeline1", - projectId: "64f65e99e0fe146ac753361f", - sink: sink, - source: source, - transformations: transform, -}; - -new CfnDataLakePipeline(stack, "data-lake-pipeline", datalakepipelineProps); diff --git a/src/l1-resources/datalakes/README.md b/src/l1-resources/datalakes/README.md deleted file mode 100644 index 179496c9..00000000 --- a/src/l1-resources/datalakes/README.md +++ /dev/null @@ -1,79 +0,0 @@ -# datalakes - -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::DataLakes` 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 - -Returns, adds, edits, and removes Federated Database Instances. - -## 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-lake-pipelines) - -## 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::DataLakes \ - --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-DataLakes \ - --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: [datalake.ts](../../../examples/l1-resources/datalake.ts) -```ts -import { CfnDataLakes, DataLakeDataProcessRegionViewCloudProvider, DataLakeDataProcessRegionViewRegion } from 'awscdk-resources-mongodbatlas'; - - -const dataLake = new CfnDataLakes(this, 'DataLake', { - projectId: atlasProps.projId, - profile: atlasProps.profile, - tenantName : atlasProps.tenantName, - cloudProviderConfig: { - aws: { - roleId: atlasProps.roleId, - externalId: atlasProps.externalId, - iamUserArn: atlasProps.iamUserArn, - testS3Bucket: atlasProps.testS3Bucket, - } - }, - dataProcessRegion: { - cloudProvider: DataLakeDataProcessRegionViewCloudProvider.AWS, - region: DataLakeDataProcessRegionViewRegion.DUBLIN_IRL - } - }); - - -``` - - -## 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::DataLakes`. - -* 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-datalakes+v1.0.0). -* Issues related to `MongoDB::Atlas::DataLakes` should be reported to the [publisher](https://github.com/mongodb/mongodbatlas-cloudformation-resources/issues). -* Feature requests should be [reported here](https://feedback.mongodb.com/forums/924145-atlas?category_id=392596) - -[cdklabs/cdk-cloudformation]: https://github.com/cdklabs/cdk-cloudformation - -## License - -Distributed under the Apache-2.0 License. \ No newline at end of file diff --git a/src/l1-resources/datalakes/index.ts b/src/l1-resources/datalakes/index.ts deleted file mode 100644 index 18b24502..00000000 --- a/src/l1-resources/datalakes/index.ts +++ /dev/null @@ -1,732 +0,0 @@ -// Generated by cdk-import -import * as cdk from "aws-cdk-lib"; -import * as constructs from "constructs"; - -/** - * Returns, adds, edits, and removes Federated Database Instances. - * - * @schema CfnDataLakesProps - */ -export interface CfnDataLakesProps { - /** - * Cloud provider linked to this data lake. - * - * @schema CfnDataLakesProps#CloudProviderConfig - */ - readonly cloudProviderConfig?: DataLakeCloudProviderConfigView; - - /** - * Information about the cloud provider region to which the data lake routes client connections. MongoDB Cloud supports AWS only. - * - * @schema CfnDataLakesProps#DataProcessRegion - */ - readonly dataProcessRegion?: DataLakeDataProcessRegionView; - - /** - * Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. - * - * @schema CfnDataLakesProps#EndDate - */ - readonly endDate?: number; - - /** - * Unique 24-hexadecimal digit string that identifies your project. - * - * @schema CfnDataLakesProps#ProjectId - */ - readonly projectId?: string; - - /** - * The profile is defined in AWS Secret manager. See [Secret Manager Profile setup](../../../examples/profile-secret.yaml). - * - * @schema CfnDataLakesProps#Profile - */ - readonly profile?: string; - - /** - * Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check. - * - * @schema CfnDataLakesProps#SkipRoleValidation - */ - readonly skipRoleValidation?: boolean; - - /** - * Configuration information for each data store and its mapping to MongoDB Cloud databases. - * - * @schema CfnDataLakesProps#Storage - */ - readonly storage?: DataLakeStorageView; - - /** - * Human-readable label that identifies the Federated Database to remove. - * - * @schema CfnDataLakesProps#TenantName - */ - readonly tenantName?: string; -} - -/** - * Converts an object of type 'CfnDataLakesProps' to JSON representation. - */ -/* eslint-disable max-len, quote-props */ -export function toJson_CfnDataLakesProps( - obj: CfnDataLakesProps | undefined -): Record | undefined { - if (obj === undefined) { - return undefined; - } - const result = { - CloudProviderConfig: toJson_DataLakeCloudProviderConfigView( - obj.cloudProviderConfig - ), - DataProcessRegion: toJson_DataLakeDataProcessRegionView( - obj.dataProcessRegion - ), - EndDate: obj.endDate, - ProjectId: obj.projectId, - Profile: obj.profile, - SkipRoleValidation: obj.skipRoleValidation, - Storage: toJson_DataLakeStorageView(obj.storage), - TenantName: obj.tenantName, - }; - // 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 */ - -/** - * @schema DataLakeCloudProviderConfigView - */ -export interface DataLakeCloudProviderConfigView { - /** - * Name of the cloud service that hosts the data lake's data stores. - * - * @schema DataLakeCloudProviderConfigView#Aws - */ - readonly aws?: DataLakeAwsCloudProviderConfigView; -} - -/** - * Converts an object of type 'DataLakeCloudProviderConfigView' to JSON representation. - */ -/* eslint-disable max-len, quote-props */ -export function toJson_DataLakeCloudProviderConfigView( - obj: DataLakeCloudProviderConfigView | undefined -): Record | undefined { - if (obj === undefined) { - return undefined; - } - const result = { - Aws: toJson_DataLakeAwsCloudProviderConfigView(obj.aws), - }; - // 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 */ - -/** - * @schema DataLakeDataProcessRegionView - */ -export interface DataLakeDataProcessRegionView { - /** - * Name of the cloud service that hosts the data lake's data stores. - * - * @schema DataLakeDataProcessRegionView#CloudProvider - */ - readonly cloudProvider?: DataLakeDataProcessRegionViewCloudProvider; - - /** - * Name of the region to which the data lake routes client connections. - * - * @schema DataLakeDataProcessRegionView#Region - */ - readonly region?: DataLakeDataProcessRegionViewRegion; -} - -/** - * Converts an object of type 'DataLakeDataProcessRegionView' to JSON representation. - */ -/* eslint-disable max-len, quote-props */ -export function toJson_DataLakeDataProcessRegionView( - obj: DataLakeDataProcessRegionView | undefined -): Record | undefined { - if (obj === undefined) { - return undefined; - } - const result = { - CloudProvider: obj.cloudProvider, - Region: obj.region, - }; - // 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 */ - -/** - * @schema DataLakeStorageView - */ -export interface DataLakeStorageView { - /** - * Array that contains the queryable databases and collections for this data lake. - * - * @schema DataLakeStorageView#Databases - */ - readonly databases?: DataLakeDatabaseView[]; - - /** - * Array that contains the data stores for the data lake. - * - * @schema DataLakeStorageView#Stores - */ - readonly stores?: StoreDetail[]; -} - -/** - * Converts an object of type 'DataLakeStorageView' to JSON representation. - */ -/* eslint-disable max-len, quote-props */ -export function toJson_DataLakeStorageView( - obj: DataLakeStorageView | undefined -): Record | undefined { - if (obj === undefined) { - return undefined; - } - const result = { - Databases: obj.databases?.map((y) => toJson_DataLakeDatabaseView(y)), - Stores: obj.stores?.map((y) => toJson_StoreDetail(y)), - }; - // 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 */ - -/** - * @schema DataLakeAWSCloudProviderConfigView - */ -export interface DataLakeAwsCloudProviderConfigView { - /** - * Unique identifier associated with the Identity and Access Management (IAM) role that the data lake assumes when accessing the data stores. - * - * @schema DataLakeAWSCloudProviderConfigView#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. - * - * @schema DataLakeAWSCloudProviderConfigView#IamAssumedRoleARN - */ - readonly iamAssumedRoleArn?: string; - - /** - * Amazon Resource Name (ARN) of the user that the data lake assumes when accessing data stores. - * - * @schema DataLakeAWSCloudProviderConfigView#IamUserARN - */ - readonly iamUserArn?: string; - - /** - * Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig. - * - * @schema DataLakeAWSCloudProviderConfigView#RoleId - */ - readonly roleId?: string; - - /** - * Name of the S3 data bucket that the provided role ID is authorized to access.Required if specifying cloudProviderConfig. - * - * @schema DataLakeAWSCloudProviderConfigView#TestS3Bucket - */ - readonly testS3Bucket?: string; -} - -/** - * Converts an object of type 'DataLakeAwsCloudProviderConfigView' to JSON representation. - */ -/* eslint-disable max-len, quote-props */ -export function toJson_DataLakeAwsCloudProviderConfigView( - obj: DataLakeAwsCloudProviderConfigView | undefined -): Record | undefined { - if (obj === undefined) { - return undefined; - } - const result = { - ExternalId: obj.externalId, - IamAssumedRoleARN: obj.iamAssumedRoleArn, - IamUserARN: obj.iamUserArn, - RoleId: obj.roleId, - TestS3Bucket: obj.testS3Bucket, - }; - // 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 */ - -/** - * Name of the cloud service that hosts the data lake's data stores. - * - * @schema DataLakeDataProcessRegionViewCloudProvider - */ -export enum DataLakeDataProcessRegionViewCloudProvider { - /** AWS */ - AWS = "AWS", - /** GCP */ - GCP = "GCP", - /** AZURE */ - AZURE = "AZURE", - /** TENANT */ - TENANT = "TENANT", - /** SERVERLESS */ - SERVERLESS = "SERVERLESS", -} - -/** - * Name of the region to which the data lake routes client connections. - * - * @schema DataLakeDataProcessRegionViewRegion - */ -export enum DataLakeDataProcessRegionViewRegion { - /** DUBLIN_IRL */ - DUBLIN_IRL = "DUBLIN_IRL", - /** FRANKFURT_DEU */ - FRANKFURT_DEU = "FRANKFURT_DEU", - /** LONDON_GBR */ - LONDON_GBR = "LONDON_GBR", - /** MUMBAI_IND */ - MUMBAI_IND = "MUMBAI_IND", - /** OREGON_USA */ - OREGON_USA = "OREGON_USA", - /** SYDNEY_AUS */ - SYDNEY_AUS = "SYDNEY_AUS", - /** VIRGINIA_USA */ - VIRGINIA_USA = "VIRGINIA_USA", -} - -/** - * @schema DataLakeDatabaseView - */ -export interface DataLakeDatabaseView { - /** - * Array of collections and data sources that map to a ``stores`` data store. - * - * @schema DataLakeDatabaseView#Collections - */ - readonly collections?: DataLakeDatabaseCollectionView[]; - - /** - * Maximum number of wildcard collections in the database. This only applies to S3 data sources. - * - * @schema DataLakeDatabaseView#MaxWildcardCollections - */ - readonly maxWildcardCollections?: number; - - /** - * Human-readable label that identifies the database to which the data lake maps data. - * - * @schema DataLakeDatabaseView#Name - */ - readonly name?: string; - - /** - * Array of aggregation pipelines that apply to the collection. This only applies to S3 data sources. - * - * @schema DataLakeDatabaseView#Views - */ - readonly views?: DataLakeViewView[]; -} - -/** - * Converts an object of type 'DataLakeDatabaseView' to JSON representation. - */ -/* eslint-disable max-len, quote-props */ -export function toJson_DataLakeDatabaseView( - obj: DataLakeDatabaseView | undefined -): Record | undefined { - if (obj === undefined) { - return undefined; - } - const result = { - Collections: obj.collections?.map((y) => - toJson_DataLakeDatabaseCollectionView(y) - ), - MaxWildcardCollections: obj.maxWildcardCollections, - Name: obj.name, - Views: obj.views?.map((y) => toJson_DataLakeViewView(y)), - }; - // 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 */ - -/** - * Configuration information for each data store and its mapping to MongoDB Cloud databases. - * - * @schema StoreDetail - */ -export interface StoreDetail { - /** - * Human-readable label that identifies the data store. - * - * @schema StoreDetail#Name - */ - readonly name?: string; - - /** - * Human-readable label that identifies the Federated Database to update. - * - * @schema StoreDetail#Provider - */ - readonly provider?: string; - - /** - * Human-readable label that identifies the Federated Database to update. - * - * @schema StoreDetail#Region - */ - readonly region?: string; - - /** - * Human-readable label that identifies the Federated Database to update. - * - * @schema StoreDetail#Bucket - */ - readonly bucket?: string; - - /** - * Human-readable label that identifies the Federated Database to update. - * - * @schema StoreDetail#Prefix - */ - readonly prefix?: string; - - /** - * Human-readable label that identifies the Federated Database to update. - * - * @schema StoreDetail#Delimiter - */ - readonly delimiter?: string; - - /** - * Human-readable label that identifies the Federated Database to update. - * - * @schema StoreDetail#IncludeTags - */ - readonly includeTags?: boolean; - - /** - * Human-readable label that identifies the Federated Database to update. - * - * @schema StoreDetail#AdditionalStorageClasses - */ - readonly additionalStorageClasses?: string[]; -} - -/** - * Converts an object of type 'StoreDetail' to JSON representation. - */ -/* eslint-disable max-len, quote-props */ -export function toJson_StoreDetail( - obj: StoreDetail | undefined -): Record | undefined { - if (obj === undefined) { - return undefined; - } - const result = { - Name: obj.name, - Provider: obj.provider, - Region: obj.region, - Bucket: obj.bucket, - Prefix: obj.prefix, - Delimiter: obj.delimiter, - IncludeTags: obj.includeTags, - AdditionalStorageClasses: obj.additionalStorageClasses?.map((y) => y), - }; - // 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 */ - -/** - * @schema DataLakeDatabaseCollectionView - */ -export interface DataLakeDatabaseCollectionView { - /** - * Array that contains the data stores that map to a collection for this data lake. - * - * @schema DataLakeDatabaseCollectionView#DataSources - */ - readonly dataSources?: DataLakeDatabaseDataSourceView[]; - - /** - * Human-readable label that identifies the collection to which MongoDB Cloud maps the data in the data stores. - * - * @schema DataLakeDatabaseCollectionView#Name - */ - readonly name?: string; -} - -/** - * Converts an object of type 'DataLakeDatabaseCollectionView' to JSON representation. - */ -/* eslint-disable max-len, quote-props */ -export function toJson_DataLakeDatabaseCollectionView( - obj: DataLakeDatabaseCollectionView | undefined -): Record | undefined { - if (obj === undefined) { - return undefined; - } - const result = { - DataSources: obj.dataSources?.map((y) => - toJson_DataLakeDatabaseDataSourceView(y) - ), - Name: obj.name, - }; - // 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 */ - -/** - * @schema DataLakeViewView - */ -export interface DataLakeViewView { - /** - * Human-readable label that identifies the view, which corresponds to an aggregation pipeline on a collection. - * - * @schema DataLakeViewView#Name - */ - readonly name?: string; - - /** - * Aggregation pipeline stages to apply to the source collection. - * - * @schema DataLakeViewView#Pipeline - */ - readonly pipeline?: string; - - /** - * Human-readable label that identifies the source collection for the view. - * - * @schema DataLakeViewView#Source - */ - readonly source?: string; -} - -/** - * Converts an object of type 'DataLakeViewView' to JSON representation. - */ -/* eslint-disable max-len, quote-props */ -export function toJson_DataLakeViewView( - obj: DataLakeViewView | undefined -): Record | undefined { - if (obj === undefined) { - return undefined; - } - const result = { - Name: obj.name, - Pipeline: obj.pipeline, - Source: obj.source, - }; - // 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 */ - -/** - * @schema DataLakeDatabaseDataSourceView - */ -export interface DataLakeDatabaseDataSourceView { - /** - * Flag that validates the scheme in the specified URLs. If `true`, allows insecure `HTTP` scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If `false`, allows secure `HTTPS` scheme only. - * - * @schema DataLakeDatabaseDataSourceView#AllowInsecure - */ - readonly allowInsecure?: boolean; - - /** - * Human-readable label that identifies the collection in the database. For creating a wildcard (`*`) collection, you must omit this parameter. - * - * @schema DataLakeDatabaseDataSourceView#Collection - */ - readonly collection?: string; - - /** - * Regex pattern to use for creating the wildcard (*) collection. To learn more about the regex syntax, see [Go programming language](https://pkg.go.dev/regexp). - * - * @schema DataLakeDatabaseDataSourceView#CollectionRegex - */ - readonly collectionRegex?: string; - - /** - * Human-readable label that identifies the database, which contains the collection in the cluster. You must omit this parameter to generate wildcard (`*`) collections for dynamically generated databases. - * - * @schema DataLakeDatabaseDataSourceView#Database - */ - readonly database?: string; - - /** - * File format that MongoDB Cloud uses if it encounters a file without a file extension while searching **storeName**. - * - * @schema DataLakeDatabaseDataSourceView#DefaultFormat - */ - readonly defaultFormat?: DataLakeDatabaseDataSourceViewDefaultFormat; - - /** - * File path that controls how MongoDB Cloud searches for and parses files in the **storeName** before mapping them to a collection.Specify ``/`` to capture all files and folders from the ``prefix`` path. - * - * @schema DataLakeDatabaseDataSourceView#Path - */ - readonly path?: string; - - /** - * Human-readable label that identifies the data store that MongoDB Cloud maps to the collection. - * - * @schema DataLakeDatabaseDataSourceView#StoreName - */ - 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. - * - * @schema DataLakeDatabaseDataSourceView#Urls - */ - readonly urls?: string[]; -} - -/** - * Converts an object of type 'DataLakeDatabaseDataSourceView' to JSON representation. - */ -/* eslint-disable max-len, quote-props */ -export function toJson_DataLakeDatabaseDataSourceView( - obj: DataLakeDatabaseDataSourceView | undefined -): Record | undefined { - if (obj === undefined) { - return undefined; - } - const result = { - AllowInsecure: obj.allowInsecure, - Collection: obj.collection, - CollectionRegex: obj.collectionRegex, - Database: obj.database, - DefaultFormat: obj.defaultFormat, - Path: obj.path, - StoreName: obj.storeName, - Urls: obj.urls?.map((y) => y), - }; - // 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 */ - -/** - * File format that MongoDB Cloud uses if it encounters a file without a file extension while searching **storeName**. - * - * @schema DataLakeDatabaseDataSourceViewDefaultFormat - */ -export enum DataLakeDatabaseDataSourceViewDefaultFormat { - /** .avro */ - AVRO = ".avro", - /** .avro.gz */ - AVRO_GZ = ".avro.gz", - /** .bson */ - BSON = ".bson", - /** .bson.gz */ - BSON_GZ = ".bson.gz", - /** .csv */ - CSV = ".csv", - /** .json */ - JSON = ".json", - /** .json.gz */ - JSON_GZ = ".json.gz", - /** .orc */ - ORC = ".orc", - /** .tsv */ - TSV = ".tsv", - /** .tsv.gz */ - TSV_GZ = ".tsv.gz", -} - -/** - * A CloudFormation `MongoDB::Atlas::DataLakes` - * - * @cloudformationResource MongoDB::Atlas::DataLakes - * @stability external - */ -export class CfnDataLakes extends cdk.CfnResource { - /** - * The CloudFormation resource type name for this resource class. - */ - public static readonly CFN_RESOURCE_TYPE_NAME = "MongoDB::Atlas::DataLakes"; - - /** - * Resource props. - */ - public readonly props: CfnDataLakesProps; - - /** - * Attribute `MongoDB::Atlas::DataLakes.StartDate` - */ - public readonly attrStartDate: number; - /** - * Attribute `MongoDB::Atlas::DataLakes.Hostnames` - */ - public readonly attrHostnames: string[]; - /** - * Attribute `MongoDB::Atlas::DataLakes.State` - */ - public readonly attrState: string; - - /** - * Create a new `MongoDB::Atlas::DataLakes`. - * - * @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: CfnDataLakesProps - ) { - super(scope, id, { - type: CfnDataLakes.CFN_RESOURCE_TYPE_NAME, - properties: toJson_CfnDataLakesProps(props)!, - }); - - this.props = props; - - this.attrStartDate = cdk.Token.asNumber(this.getAtt("StartDate")); - this.attrHostnames = cdk.Token.asList(this.getAtt("Hostnames")); - this.attrState = cdk.Token.asString(this.getAtt("State")); - } -} diff --git a/test/l1-resources/data-lake-pipeline/README.md b/test/l1-resources/data-lake-pipeline/README.md deleted file mode 100644 index 6b065d21..00000000 --- a/test/l1-resources/data-lake-pipeline/README.md +++ /dev/null @@ -1,26 +0,0 @@ -Datalake Pipeline - -## Impact -The following components use this resource and are potentially impacted by any changes. They should also be validated to ensure the changes do not cause a regression. - -## CFN resource type used -- MongoDB::Atlas::DataLakePipeline - -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 [Datalake Pipeline CFN resource](https://github.com/mongodb/mongodbatlas-cloudformation-resources/blob/master/cfn-resources/data-lake-pipeline/README.md). -- Set any additional required configuration options/parameters as per your needs. -- Please, follows the steps in [TESTING.md](../../../TESTING.md). - - -### Success criteria when testing the resource -- Once Datalake pipeline is created - Open Project in the mongodAtlas : Select DataLake on the left panel -> Datalake Pipeline we created will get displayed. - - -## Important Links -- [API Documentation](https://docs-atlas-staging.mongodb.com/cloud-docs/docsworker-xlarge/openapi-docs-test/reference/api-resources-spec/#operation/createPipeline) -- [Resource Usage Documentation](https://www.mongodb.com/docs/datalake/tutorial/add-dataset-pipeline/) \ No newline at end of file diff --git a/test/l1-resources/data-lake-pipeline/index.test.ts b/test/l1-resources/data-lake-pipeline/index.test.ts deleted file mode 100644 index ee940792..00000000 --- a/test/l1-resources/data-lake-pipeline/index.test.ts +++ /dev/null @@ -1,86 +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 { CfnDataLakePipeline } from "../../../src"; - -const RESOURCE_NAME = "MongoDB::Atlas::DataLakePipeline"; -const PROJECT_ID = "testProjectId"; -const CLUSTER_NAME = "testclusterdatalakepipeline"; -const PROFILE = "default"; -const DBNAME = "testdatabase4"; -const COLLECTIONNAME = "testcollection3"; -const NAME = "testdatalakepipeline1"; - -const sink = { - partitionFields: [ - { - fieldName: "testpartition2", - order: 0, - }, - ], -}; - -const transform = [ - { - field: "testtransformFeild", - type: "EXCLUDE", - }, -]; - -test("Datalake pipeline construct should contain default properties", () => { - const mockApp = new App(); - const stack = new Stack(mockApp); - - new CfnDataLakePipeline(stack, "Data-lake-pipeline-stack", { - projectId: PROJECT_ID, - name: NAME, - profile: PROFILE, - sink: sink, - source: { - clusterName: CLUSTER_NAME, - collectionName: COLLECTIONNAME, - databaseName: DBNAME, - }, - transformations: transform, - }); - - const template = Template.fromStack(stack); - - template.hasResourceProperties(RESOURCE_NAME, { - ProjectId: PROJECT_ID, - Name: NAME, - Profile: PROFILE, - Sink: { - PartitionFields: [ - { - FieldName: "testpartition2", - Order: 0, - }, - ], - }, - Source: { - ClusterName: CLUSTER_NAME, - CollectionName: COLLECTIONNAME, - DatabaseName: DBNAME, - }, - Transformations: [ - { - Field: "testtransformFeild", - Type: "EXCLUDE", - }, - ], - }); -}); diff --git a/test/l1-resources/datalakes/README.md b/test/l1-resources/datalakes/README.md deleted file mode 100644 index cec617be..00000000 --- a/test/l1-resources/datalakes/README.md +++ /dev/null @@ -1,24 +0,0 @@ -# Datalakes - - -## CFN resource type used -- MongoDB::Atlas::DataLakes - -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 [DataLakes CFN resource](https://github.com/mongodb/mongodbatlas-cloudformation-resources/blob/master/cfn-resources/datalakes/test/README.md). -- Set any additional required configuration options/parameters as per your needs. -- Please, follows the steps in [TESTING.md](../../../TESTING.md). - - -### Success criteria when testing the resource -- You should see your data federation in the "Data Federation" page: -![image](https://user-images.githubusercontent.com/5663078/227923171-b9aa0067-d8a0-41b3-94c5-9e5ce5ea222c.png) - - -## Important Links -- [API Documentation](https://docs-atlas-staging.mongodb.com/cloud-docs/docsworker-xlarge/openapi-docs-test/reference/api-resources-spec/#tag/Data-Federationt) -- [Resource Usage Documentation](https://www.mongodb.com/docs/atlas/data-federation/config/config-adl-datasets/) \ No newline at end of file