1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. getAccessListApiKey
MongoDB Atlas v3.16.0 published on Wednesday, Jun 12, 2024 by Pulumi

mongodbatlas.getAccessListApiKey

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.16.0 published on Wednesday, Jun 12, 2024 by Pulumi

    Example Usage

    Using CIDR Block

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    resources:
      testAccessListApiKey:
        type: mongodbatlas:AccessListApiKey
        name: test
        properties:
          orgId: <ORG-ID>
          cidrBlock: 1.2.3.4/32
          apiKey: a29120e123cd
    variables:
      test:
        fn::invoke:
          Function: mongodbatlas:getAccessListApiKey
          Arguments:
            orgId: ${testAccessListApiKey.orgId}
            cidrBlock: ${testAccessListApiKey.cidrBlock}
            apiKeyId: ${testAccessListApiKey.apiKeyId}
    

    Using IP Address

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    resources:
      testAccessListApiKey:
        type: mongodbatlas:AccessListApiKey
        name: test
        properties:
          orgId: <ORG-ID>
          ipAddress: 2.3.4.5
          apiKey: a29120e123cd
    variables:
      test:
        fn::invoke:
          Function: mongodbatlas:getAccessListApiKey
          Arguments:
            orgId: ${testAccessListApiKey.orgId}
            ipAddress: ${testAccessListApiKey.ipAddress}
            apiKeyId: ${testAccessListApiKey.apiKeyId}
    

    Using getAccessListApiKey

    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 getAccessListApiKey(args: GetAccessListApiKeyArgs, opts?: InvokeOptions): Promise<GetAccessListApiKeyResult>
    function getAccessListApiKeyOutput(args: GetAccessListApiKeyOutputArgs, opts?: InvokeOptions): Output<GetAccessListApiKeyResult>
    def get_access_list_api_key(api_key_id: Optional[str] = None,
                                ip_address: Optional[str] = None,
                                org_id: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetAccessListApiKeyResult
    def get_access_list_api_key_output(api_key_id: Optional[pulumi.Input[str]] = None,
                                ip_address: Optional[pulumi.Input[str]] = None,
                                org_id: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetAccessListApiKeyResult]
    func LookupAccessListApiKey(ctx *Context, args *LookupAccessListApiKeyArgs, opts ...InvokeOption) (*LookupAccessListApiKeyResult, error)
    func LookupAccessListApiKeyOutput(ctx *Context, args *LookupAccessListApiKeyOutputArgs, opts ...InvokeOption) LookupAccessListApiKeyResultOutput

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

    public static class GetAccessListApiKey 
    {
        public static Task<GetAccessListApiKeyResult> InvokeAsync(GetAccessListApiKeyArgs args, InvokeOptions? opts = null)
        public static Output<GetAccessListApiKeyResult> Invoke(GetAccessListApiKeyInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAccessListApiKeyResult> getAccessListApiKey(GetAccessListApiKeyArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: mongodbatlas:index/getAccessListApiKey:getAccessListApiKey
      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: You must set either the cidr_block attribute or the ip_address attribute. Don't set both.
    IpAddress string
    Single IP address to be added to the access list.
    OrgId string
    Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
    ApiKeyId string
    Unique identifier for the Organization API Key for which you want to retrieve an access list entry. * ->NOTE: You must set either the cidr_block attribute or the ip_address attribute. Don't set both.
    IpAddress string
    Single IP address to be added to the access list.
    OrgId string
    Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
    apiKeyId String
    Unique identifier for the Organization API Key for which you want to retrieve an access list entry. * ->NOTE: You must set either the cidr_block attribute or the ip_address attribute. Don't set both.
    ipAddress String
    Single IP address to be added to the access list.
    orgId String
    Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
    apiKeyId string
    Unique identifier for the Organization API Key for which you want to retrieve an access list entry. * ->NOTE: You must set either the cidr_block attribute or the ip_address attribute. Don't set both.
    ipAddress string
    Single IP address to be added to the access list.
    orgId string
    Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
    api_key_id str
    Unique identifier for the Organization API Key for which you want to retrieve an access list entry. * ->NOTE: You must set either the cidr_block attribute or the ip_address attribute. Don't set both.
    ip_address str
    Single IP address to be added to the access list.
    org_id str
    Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
    apiKeyId String
    Unique identifier for the Organization API Key for which you want to retrieve an access list entry. * ->NOTE: You must set either the cidr_block attribute or the ip_address attribute. Don't set both.
    ipAddress String
    Single IP address to be added to the access list.
    orgId String
    Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

    getAccessListApiKey Result

    The following output properties are available:

    AccessCount int
    ApiKeyId string
    CidrBlock string
    Created string
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddress string
    LastUsed string
    LastUsedAddress string
    OrgId string
    AccessCount int
    ApiKeyId string
    CidrBlock string
    Created string
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddress string
    LastUsed string
    LastUsedAddress string
    OrgId string
    accessCount Integer
    apiKeyId String
    cidrBlock String
    created String
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddress String
    lastUsed String
    lastUsedAddress String
    orgId String
    accessCount number
    apiKeyId string
    cidrBlock string
    created string
    id string
    The provider-assigned unique ID for this managed resource.
    ipAddress string
    lastUsed string
    lastUsedAddress string
    orgId string
    access_count int
    api_key_id str
    cidr_block str
    created str
    id str
    The provider-assigned unique ID for this managed resource.
    ip_address str
    last_used str
    last_used_address str
    org_id str
    accessCount Number
    apiKeyId String
    cidrBlock String
    created String
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddress String
    lastUsed String
    lastUsedAddress String
    orgId 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 logo
    MongoDB Atlas v3.16.0 published on Wednesday, Jun 12, 2024 by Pulumi