Docs
Packagesmongodbatlas.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
groupIdin 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.
Example Usage
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 dictionaryThe following arguments are supported:
- Project
Id string - Unique identifier for the project to which you want to add one or more access list entries.
- Aws
Security stringGroup - Unique identifier of the AWS security group to add to the access list.
- Cidr
Block string - Range of IP addresses in CIDR notation to be added to the access list.
- Ip
Address string Single IP address to be added to the access list.
NOTE: One of the following attributes must set:
aws_security_group,cidr_blockorip_address.
- Project
Id string - Unique identifier for the project to which you want to add one or more access list entries.
- Aws
Security stringGroup - Unique identifier of the AWS security group to add to the access list.
- Cidr
Block string - Range of IP addresses in CIDR notation to be added to the access list.
- Ip
Address string Single IP address to be added to the access list.
NOTE: One of the following attributes must set:
aws_security_group,cidr_blockorip_address.
- project
Id String - Unique identifier for the project to which you want to add one or more access list entries.
- aws
Security StringGroup - Unique identifier of the AWS security group to add to the access list.
- cidr
Block String - Range of IP addresses in CIDR notation to be added to the access list.
- ip
Address String Single IP address to be added to the access list.
NOTE: One of the following attributes must set:
aws_security_group,cidr_blockorip_address.
- project
Id string - Unique identifier for the project to which you want to add one or more access list entries.
- aws
Security stringGroup - Unique identifier of the AWS security group to add to the access list.
- cidr
Block string - Range of IP addresses in CIDR notation to be added to the access list.
- ip
Address string Single IP address to be added to the access list.
NOTE: One of the following attributes must set:
aws_security_group,cidr_blockorip_address.
- project_
id str - Unique identifier for the project to which you want to add one or more access list entries.
- aws_
security_ strgroup - 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.
NOTE: One of the following attributes must set:
aws_security_group,cidr_blockorip_address.
- project
Id String - Unique identifier for the project to which you want to add one or more access list entries.
- aws
Security StringGroup - Unique identifier of the AWS security group to add to the access list.
- cidr
Block String - Range of IP addresses in CIDR notation to be added to the access list.
- ip
Address String Single IP address to be added to the access list.
NOTE: One of the following attributes must set:
aws_security_group,cidr_blockorip_address.
getProjectIpAccessList Result
The following output properties are available:
- aws_
security_ strgroup - cidr_
block str - comment str
- Comment to add to the access list entry.
- id str
- ip_
address str - project_
id str
Package Details
- Repository
- MongoDB Atlas pulumi/pulumi-mongodbatlas
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
mongodbatlasTerraform Provider.