MongoDB Atlas v3.7.2, Mar 31 23

mongodbatlas.getProjectIpAccessList

Explore with Pulumi AI

mongodbatlas.ProjectIpAccessList describes an IP Access List entry resource. The access list 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 access list, 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 getProjectIpAccessList

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getProjectIpAccessList(args: GetProjectIpAccessListArgs, opts?: InvokeOptions): Promise<GetProjectIpAccessListResult>
function getProjectIpAccessListOutput(args: GetProjectIpAccessListOutputArgs, opts?: InvokeOptions): Output<GetProjectIpAccessListResult>

def get_project_ip_access_list(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) -> GetProjectIpAccessListResult
def get_project_ip_access_list_output(aws_security_group: Optional[pulumi.Input[str]] = None,
                               cidr_block: Optional[pulumi.Input[str]] = None,
                               ip_address: Optional[pulumi.Input[str]] = None,
                               project_id: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetProjectIpAccessListResult]

func LookupProjectIpAccessList(ctx *Context, args *LookupProjectIpAccessListArgs, opts ...InvokeOption) (*LookupProjectIpAccessListResult, error)
func LookupProjectIpAccessListOutput(ctx *Context, args *LookupProjectIpAccessListOutputArgs, opts ...InvokeOption) LookupProjectIpAccessListResultOutput

> Note: This function is named LookupProjectIpAccessList in the Go SDK.

public static class GetProjectIpAccessList 
{
    public static Task<GetProjectIpAccessListResult> InvokeAsync(GetProjectIpAccessListArgs args, InvokeOptions? opts = null)
    public static Output<GetProjectIpAccessListResult> Invoke(GetProjectIpAccessListInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetProjectIpAccessListResult> getProjectIpAccessList(GetProjectIpAccessListArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: mongodbatlas:index/getProjectIpAccessList:getProjectIpAccessList
  arguments:
    # arguments dictionary

The following arguments are supported:

ProjectId string: Unique identifier for the project to which you want to add one or more access list entries.
AwsSecurityGroup string: Unique identifier of the AWS security group to add to the access list.
CidrBlock string: Range of IP addresses in CIDR notation to be added to the access list.
IpAddress string: Single IP address to be added to the access list.

ProjectId string: Unique identifier for the project to which you want to add one or more access list entries.
AwsSecurityGroup string: Unique identifier of the AWS security group to add to the access list.
CidrBlock string: Range of IP addresses in CIDR notation to be added to the access list.
IpAddress string: Single IP address to be added to the access list.

projectId String: Unique identifier for the project to which you want to add one or more access list entries.
awsSecurityGroup String: Unique identifier of the AWS security group to add to the access list.
cidrBlock String: Range of IP addresses in CIDR notation to be added to the access list.
ipAddress String: Single IP address to be added to the access list.

projectId string: Unique identifier for the project to which you want to add one or more access list entries.
awsSecurityGroup string: Unique identifier of the AWS security group to add to the access list.
cidrBlock string: Range of IP addresses in CIDR notation to be added to the access list.
ipAddress string: Single IP address to be added to the access list.

project_id str: Unique identifier for the project to which you want to add one or more access list entries.
aws_security_group str: Unique identifier of the AWS security group to add to the access list.
cidr_block str: Range of IP addresses in CIDR notation to be added to the access list.
ip_address str: Single IP address to be added to the access list.

projectId String: Unique identifier for the project to which you want to add one or more access list entries.
awsSecurityGroup String: Unique identifier of the AWS security group to add to the access list.
cidrBlock String: Range of IP addresses in CIDR notation to be added to the access list.
ipAddress String: Single IP address to be added to the access list.

getProjectIpAccessList Result

The following output properties are available:

AwsSecurityGroup string
CidrBlock string
Comment string: Comment to add to the access list 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 access list 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 access list 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 access list 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 access list entry.
id str: The provider-assigned unique ID for this managed resource.
ip_address str
project_id str

awsSecurityGroup String
cidrBlock String
comment String: Comment to add to the access list entry.
id String: The provider-assigned unique ID for this managed resource.
ipAddress String
projectId String

Package Details

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

mongodbatlas.getProjectIpAccessList

Using getProjectIpAccessList

getProjectIpAccessList Result

Package Details

On this page

On this page