1. Packages
  2. AWS Native
  3. API Docs
  4. location
  5. getApiKey

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

aws-native.location.getApiKey

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

    Definition of AWS::Location::APIKey Resource Type

    Using getApiKey

    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 getApiKey(args: GetApiKeyArgs, opts?: InvokeOptions): Promise<GetApiKeyResult>
    function getApiKeyOutput(args: GetApiKeyOutputArgs, opts?: InvokeOptions): Output<GetApiKeyResult>
    def get_api_key(key_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetApiKeyResult
    def get_api_key_output(key_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetApiKeyResult]
    func LookupApiKey(ctx *Context, args *LookupApiKeyArgs, opts ...InvokeOption) (*LookupApiKeyResult, error)
    func LookupApiKeyOutput(ctx *Context, args *LookupApiKeyOutputArgs, opts ...InvokeOption) LookupApiKeyResultOutput

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

    public static class GetApiKey 
    {
        public static Task<GetApiKeyResult> InvokeAsync(GetApiKeyArgs args, InvokeOptions? opts = null)
        public static Output<GetApiKeyResult> Invoke(GetApiKeyInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetApiKeyResult> getApiKey(GetApiKeyArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:location:getApiKey
      arguments:
        # arguments dictionary

    The following arguments are supported:

    KeyName string
    KeyName string
    keyName String
    keyName string
    keyName String

    getApiKey Result

    The following output properties are available:

    Arn string
    CreateTime string
    Description string
    ExpireTime string
    KeyArn string
    Restrictions ApiKeyRestrictions
    Tags Tag
    An array of key-value pairs to apply to this resource.
    UpdateTime string
    arn String
    createTime String
    description String
    expireTime String
    keyArn String
    restrictions ApiKeyRestrictions
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    updateTime String
    arn string
    createTime string
    description string
    expireTime string
    keyArn string
    restrictions ApiKeyRestrictions
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    updateTime string
    arn str
    create_time str
    description str
    expire_time str
    key_arn str
    restrictions ApiKeyRestrictions
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    update_time str
    arn String
    createTime String
    description String
    expireTime String
    keyArn String
    restrictions Property Map
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.
    updateTime String

    Supporting Types

    ApiKeyRestrictions

    AllowActions List<string>
    AllowResources List<string>
    AllowReferers List<string>
    AllowActions []string
    AllowResources []string
    AllowReferers []string
    allowActions List<String>
    allowResources List<String>
    allowReferers List<String>
    allowActions string[]
    allowResources string[]
    allowReferers string[]
    allow_actions Sequence[str]
    allow_resources Sequence[str]
    allow_referers Sequence[str]
    allowActions List<String>
    allowResources List<String>
    allowReferers List<String>

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi