mongodbatlas.getAccessListApiKeys
Explore with Pulumi AI
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:
- Api
Key stringId 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
orip_address
not both.- Org
Id string Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
- Items
Per intPage 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
.
- Api
Key stringId 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
orip_address
not both.- Org
Id string Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
- Items
Per intPage 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
.
- api
Key StringId 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
orip_address
not both.- org
Id String Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
- items
Per IntegerPage Number of items to return per page, up to a maximum of 500. Defaults to
100
.- page
Num Integer The page to return. Defaults to
1
.
- api
Key stringId 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
orip_address
not both.- org
Id string Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
- items
Per numberPage Number of items to return per page, up to a maximum of 500. Defaults to
100
.- page
Num number The page to return. Defaults to
1
.
- api_
key_ strid 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
orip_address
not both.- org_
id str Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
- items_
per_ intpage 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
.
- api
Key StringId 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
orip_address
not both.- org
Id String Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
- items
Per NumberPage Number of items to return per page, up to a maximum of 500. Defaults to
100
.- page
Num Number The page to return. Defaults to
1
.
getAccessListApiKeys Result
The following output properties are available:
- Api
Key stringId - Id string
The provider-assigned unique ID for this managed resource.
- Org
Id string - Results
List<Get
Access List Api Keys Result> - Items
Per intPage - Page
Num int
- Api
Key stringId - Id string
The provider-assigned unique ID for this managed resource.
- Org
Id string - Results
[]Get
Access List Api Keys Result - Items
Per intPage - Page
Num int
- api
Key StringId - id String
The provider-assigned unique ID for this managed resource.
- org
Id String - results
List<Get
Access List Api Keys Result> - items
Per IntegerPage - page
Num Integer
- api
Key stringId - id string
The provider-assigned unique ID for this managed resource.
- org
Id string - results
Get
Access List Api Keys Result[] - items
Per numberPage - page
Num number
- api_
key_ strid - id str
The provider-assigned unique ID for this managed resource.
- org_
id str - results
Sequence[Get
Access List Api Keys Result] - items_
per_ intpage - page_
num int
- api
Key StringId - id String
The provider-assigned unique ID for this managed resource.
- org
Id String - results List<Property Map>
- items
Per NumberPage - page
Num Number
Supporting Types
GetAccessListApiKeysResult
- Access
Count int - Cidr
Block string Range of IP addresses in CIDR notation to be added to the access list.
- Created string
- Ip
Address string Single IP address to be added to the access list.
- Last
Used string - Last
Used stringAddress
- Access
Count int - Cidr
Block string Range of IP addresses in CIDR notation to be added to the access list.
- Created string
- Ip
Address string Single IP address to be added to the access list.
- Last
Used string - Last
Used stringAddress
- access
Count Integer - cidr
Block String Range of IP addresses in CIDR notation to be added to the access list.
- created String
- ip
Address String Single IP address to be added to the access list.
- last
Used String - last
Used StringAddress
- access
Count number - cidr
Block string Range of IP addresses in CIDR notation to be added to the access list.
- created string
- ip
Address string Single IP address to be added to the access list.
- last
Used string - last
Used stringAddress
- 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_ straddress
- access
Count Number - cidr
Block String Range of IP addresses in CIDR notation to be added to the access list.
- created String
- ip
Address String Single IP address to be added to the access list.
- last
Used String - last
Used StringAddress
Package Details
- Repository
- MongoDB Atlas pulumi/pulumi-mongodbatlas
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
mongodbatlas
Terraform Provider.