Want to learn about running containers in Lambda? Join our free hands-on workshop. Register Now

GetProjectIpWhitelist

mongodbatlas.ProjectIpWhitelist describes an IP Whitelist entry resource. The whitelist grants access from IPs, CIDRs or AWS Security Groups (if VPC Peering is enabled) to clusters within the Project.

NOTE: Groups and projects are synonymous terms. You may find groupId in the official documentation.

IMPORTANT: When you remove an entry from the whitelist, existing connections from the removed address(es) may remain open for a variable amount of time. How much time passes before Atlas closes the connection depends on several factors, including how the connection was established, the particular behavior of the application or driver using the address, and the connection protocol (e.g., TCP or UDP). This is particularly important to consider when changing an existing IP address or CIDR block as they cannot be updated via the Provider (comments can however), hence a change will force the destruction and recreation of entries.

Using GetProjectIpWhitelist

function getProjectIpWhitelist(args: GetProjectIpWhitelistArgs, opts?: InvokeOptions): Promise<GetProjectIpWhitelistResult>
def get_project_ip_whitelist(aws_security_group: Optional[str] = None, cidr_block: Optional[str] = None, ip_address: Optional[str] = None, project_id: Optional[str] = None, opts: Optional[InvokeOptions] = None) -> GetProjectIpWhitelistResult
func LookupProjectIpWhitelist(ctx *Context, args *LookupProjectIpWhitelistArgs, opts ...InvokeOption) (*LookupProjectIpWhitelistResult, error)

Note: This function is named LookupProjectIpWhitelist in the Go SDK.

public static class GetProjectIpWhitelist {
    public static Task<GetProjectIpWhitelistResult> InvokeAsync(GetProjectIpWhitelistArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

ProjectId string

The ID of the project in which to add the whitelist entry.

AwsSecurityGroup string

ID of the whitelisted AWS security group. Mutually exclusive with cidr_block and ip_address.

CidrBlock string

Whitelist entry in Classless Inter-Domain Routing (CIDR) notation. Mutually exclusive with aws_security_group and ip_address.

IpAddress string

Whitelisted IP address. Mutually exclusive with aws_security_group and cidr_block.

ProjectId string

The ID of the project in which to add the whitelist entry.

AwsSecurityGroup string

ID of the whitelisted AWS security group. Mutually exclusive with cidr_block and ip_address.

CidrBlock string

Whitelist entry in Classless Inter-Domain Routing (CIDR) notation. Mutually exclusive with aws_security_group and ip_address.

IpAddress string

Whitelisted IP address. Mutually exclusive with aws_security_group and cidr_block.

projectId string

The ID of the project in which to add the whitelist entry.

awsSecurityGroup string

ID of the whitelisted AWS security group. Mutually exclusive with cidr_block and ip_address.

cidrBlock string

Whitelist entry in Classless Inter-Domain Routing (CIDR) notation. Mutually exclusive with aws_security_group and ip_address.

ipAddress string

Whitelisted IP address. Mutually exclusive with aws_security_group and cidr_block.

project_id str

The ID of the project in which to add the whitelist entry.

aws_security_group str

ID of the whitelisted AWS security group. Mutually exclusive with cidr_block and ip_address.

cidr_block str

Whitelist entry in Classless Inter-Domain Routing (CIDR) notation. Mutually exclusive with aws_security_group and ip_address.

ip_address str

Whitelisted IP address. Mutually exclusive with aws_security_group and cidr_block.

GetProjectIpWhitelist Result

The following output properties are available:

AwsSecurityGroup string
CidrBlock string
Comment string

Comment to add to the whitelist entry.

Id string

The provider-assigned unique ID for this managed resource.

IpAddress string
ProjectId string
AwsSecurityGroup string
CidrBlock string
Comment string

Comment to add to the whitelist entry.

Id string

The provider-assigned unique ID for this managed resource.

IpAddress string
ProjectId string
awsSecurityGroup string
cidrBlock string
comment string

Comment to add to the whitelist entry.

id string

The provider-assigned unique ID for this managed resource.

ipAddress string
projectId string
aws_security_group str
cidr_block str
comment str

Comment to add to the whitelist entry.

id str

The provider-assigned unique ID for this managed resource.

ip_address str
project_id str

Package Details

Repository
https://github.com/pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes
This Pulumi package is based on the mongodbatlas Terraform Provider.