Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--mongodb-atlas-projectipaccesslist.json
Parent schema serverless-framework-configuration
Type: object

Returns, adds, edits, and removes network access limits to database deployments in Atlas.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git

Properties

AccessList accessListDefinition[] required
ProjectId string | Aws_CF_FunctionString required

Unique 24-hexadecimal digit string that identifies your project.

Profile string | Aws_CF_FunctionString

Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used

ListOptions object
3 nested properties
PageNum integer

Number of the page that displays the current set of the total objects that the response returns.

ItemsPerPage integer

Number of items that the response returns per page.

IncludeCount boolean

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

Definitions

accessListDefinition object
DeleteAfterDate string | Aws_CF_FunctionString

Date and time after which MongoDB Cloud deletes the temporary access list entry. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. The date must be later than the current date but no later than one week after you submit this request. The resource returns this parameter if you specified an expiration date when creating this IP access list entry.

AwsSecurityGroup string | Aws_CF_FunctionString

Unique string of the Amazon Web Services (AWS) security group that you want to add to the project's IP access list. Your IP access list entry can be one awsSecurityGroup, one cidrBlock, or one ipAddress. You must configure Virtual Private Connection (VPC) peering for your project before you can add an AWS security group to an IP access list. You cannot set AWS security groups as temporary access list entries. Don't set this parameter if you set cidrBlock or ipAddress.

CIDRBlock string | Aws_CF_FunctionString

Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that you want to add to the project's IP access list. Your IP access list entry can be one awsSecurityGroup, one cidrBlock, or one ipAddress. Don't set this parameter if you set awsSecurityGroup or ipAddress

Comment string | Aws_CF_FunctionString

Remark that explains the purpose or scope of this IP access list entry.

IPAddress string | Aws_CF_FunctionString

IP address that you want to add to the project's IP access list. Your IP access list entry can be one awsSecurityGroup, one cidrBlock, or one ipAddress. Don't set this parameter if you set awsSecurityGroup or cidrBlock.

ProjectId string | Aws_CF_FunctionString

Unique 24-hexadecimal digit string that identifies your project.

listOptions object
PageNum integer

Number of the page that displays the current set of the total objects that the response returns.

ItemsPerPage integer

Number of items that the response returns per page.

IncludeCount boolean

Flag that indicates whether the response returns the total number of items (totalCount) in the response.