Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

getProjectIpAccessList

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

function getProjectIpAccessList(args: GetProjectIpAccessListArgs, opts?: InvokeOptions): Promise<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
func LookupProjectIpAccessList(ctx *Context, args *LookupProjectIpAccessListArgs, opts ...InvokeOption) (*LookupProjectIpAccessListResult, error)

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

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

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.

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.

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
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

Package Details

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