mongodbatlas.getAccessListApiKeys

Explore with Pulumi AI

MongoDB Atlas v3.14.3 published on Monday, Apr 1, 2024 by Pulumi

pulumi/pulumi-mongodbatlas

Example Usage

Using getAccessListApiKeys

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 getAccessListApiKeys(args: GetAccessListApiKeysArgs, opts?: InvokeOptions): Promise<GetAccessListApiKeysResult>
function getAccessListApiKeysOutput(args: GetAccessListApiKeysOutputArgs, opts?: InvokeOptions): Output<GetAccessListApiKeysResult>

def get_access_list_api_keys(api_key_id: Optional[str] = None,
                             items_per_page: Optional[int] = None,
                             org_id: Optional[str] = None,
                             page_num: Optional[int] = None,
                             opts: Optional[InvokeOptions] = None) -> GetAccessListApiKeysResult
def get_access_list_api_keys_output(api_key_id: Optional[pulumi.Input[str]] = None,
                             items_per_page: Optional[pulumi.Input[int]] = None,
                             org_id: Optional[pulumi.Input[str]] = None,
                             page_num: Optional[pulumi.Input[int]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetAccessListApiKeysResult]

func LookupAccessListApiKeys(ctx *Context, args *LookupAccessListApiKeysArgs, opts ...InvokeOption) (*LookupAccessListApiKeysResult, error)
func LookupAccessListApiKeysOutput(ctx *Context, args *LookupAccessListApiKeysOutputArgs, opts ...InvokeOption) LookupAccessListApiKeysResultOutput

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

public static class GetAccessListApiKeys 
{
    public static Task<GetAccessListApiKeysResult> InvokeAsync(GetAccessListApiKeysArgs args, InvokeOptions? opts = null)
    public static Output<GetAccessListApiKeysResult> Invoke(GetAccessListApiKeysInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAccessListApiKeysResult> getAccessListApiKeys(GetAccessListApiKeysArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

ApiKeyId string: Unique identifier for the Organization API Key for which you want to retrieve an access list entry. *
NOTE: One of the following attributes must set: cidr_block or ip_address not both.
OrgId string: Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
ItemsPerPage int: Number of items to return per page, up to a maximum of 500. Defaults to 100.
PageNum int: The page to return. Defaults to 1.

ApiKeyId string: Unique identifier for the Organization API Key for which you want to retrieve an access list entry. *
NOTE: One of the following attributes must set: cidr_block or ip_address not both.
OrgId string: Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
ItemsPerPage int: Number of items to return per page, up to a maximum of 500. Defaults to 100.
PageNum int: The page to return. Defaults to 1.

apiKeyId String: Unique identifier for the Organization API Key for which you want to retrieve an access list entry. *
NOTE: One of the following attributes must set: cidr_block or ip_address not both.
orgId String: Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
itemsPerPage Integer: Number of items to return per page, up to a maximum of 500. Defaults to 100.
pageNum Integer: The page to return. Defaults to 1.

apiKeyId string: Unique identifier for the Organization API Key for which you want to retrieve an access list entry. *
NOTE: One of the following attributes must set: cidr_block or ip_address not both.
orgId string: Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
itemsPerPage number: Number of items to return per page, up to a maximum of 500. Defaults to 100.
pageNum number: The page to return. Defaults to 1.

api_key_id str: Unique identifier for the Organization API Key for which you want to retrieve an access list entry. *
NOTE: One of the following attributes must set: cidr_block or ip_address not both.
org_id str: Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
items_per_page int: Number of items to return per page, up to a maximum of 500. Defaults to 100.
page_num int: The page to return. Defaults to 1.

apiKeyId String: Unique identifier for the Organization API Key for which you want to retrieve an access list entry. *
NOTE: One of the following attributes must set: cidr_block or ip_address not both.
orgId String: Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
itemsPerPage Number: Number of items to return per page, up to a maximum of 500. Defaults to 100.
pageNum Number: The page to return. Defaults to 1.

getAccessListApiKeys Result

The following output properties are available:

ApiKeyId string
Id string: The provider-assigned unique ID for this managed resource.
OrgId string
Results List<GetAccessListApiKeysResult>
ItemsPerPage int
PageNum int

ApiKeyId string
Id string: The provider-assigned unique ID for this managed resource.
OrgId string
Results []GetAccessListApiKeysResult
ItemsPerPage int
PageNum int

apiKeyId String
id String: The provider-assigned unique ID for this managed resource.
orgId String
results List<GetAccessListApiKeysResult>
itemsPerPage Integer
pageNum Integer

apiKeyId string
id string: The provider-assigned unique ID for this managed resource.
orgId string
results GetAccessListApiKeysResult[]
itemsPerPage number
pageNum number

api_key_id str
id str: The provider-assigned unique ID for this managed resource.
org_id str
results Sequence[GetAccessListApiKeysResult]
items_per_page int
page_num int

apiKeyId String
id String: The provider-assigned unique ID for this managed resource.
orgId String
results List<Property Map>
itemsPerPage Number
pageNum Number

Supporting Types

GetAccessListApiKeysResult

AccessCount int
CidrBlock string: Range of IP addresses in CIDR notation to be added to the access list.
Created string
IpAddress string: Single IP address to be added to the access list.
LastUsed string
LastUsedAddress string

AccessCount int
CidrBlock string: Range of IP addresses in CIDR notation to be added to the access list.
Created string
IpAddress string: Single IP address to be added to the access list.
LastUsed string
LastUsedAddress string

accessCount Integer
cidrBlock String: Range of IP addresses in CIDR notation to be added to the access list.
created String
ipAddress String: Single IP address to be added to the access list.
lastUsed String
lastUsedAddress String

accessCount number
cidrBlock string: Range of IP addresses in CIDR notation to be added to the access list.
created string
ipAddress string: Single IP address to be added to the access list.
lastUsed string
lastUsedAddress string

access_count int
cidr_block str: Range of IP addresses in CIDR notation to be added to the access list.
created str
ip_address str: Single IP address to be added to the access list.
last_used str
last_used_address str

accessCount Number
cidrBlock String: Range of IP addresses in CIDR notation to be added to the access list.
created String
ipAddress String: Single IP address to be added to the access list.
lastUsed String
lastUsedAddress String

Package Details

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

MongoDB Atlas v3.14.3 published on Monday, Apr 1, 2024 by Pulumi

pulumi/pulumi-mongodbatlas

mongodbatlas.getAccessListApiKeys

On this page

On this page

Example Usage

Using getAccessListApiKeys

getAccessListApiKeys Result

Supporting Types

GetAccessListApiKeysResult

Package Details

On this page

On this page