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

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

AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi

aws-native.apigateway.getApiKey

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi

    The AWS::ApiGateway::ApiKey resource creates a unique key that you can distribute to clients who are executing API Gateway Method resources that require an API key. To specify which API key clients must use, map the API key with the RestApi and Stage resources that include the methods that require a key.

    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(api_key_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetApiKeyResult
    def get_api_key_output(api_key_id: 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:apigateway:getApiKey
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ApiKeyId string
    The ID for the API key. For example: abc123 .
    ApiKeyId string
    The ID for the API key. For example: abc123 .
    apiKeyId String
    The ID for the API key. For example: abc123 .
    apiKeyId string
    The ID for the API key. For example: abc123 .
    api_key_id str
    The ID for the API key. For example: abc123 .
    apiKeyId String
    The ID for the API key. For example: abc123 .

    getApiKey Result

    The following output properties are available:

    ApiKeyId string
    The ID for the API key. For example: abc123 .
    CustomerId string
    An MKT customer identifier, when integrating with the AWS SaaS Marketplace.
    Description string
    The description of the ApiKey.
    Enabled bool
    Specifies whether the ApiKey can be used by callers.
    StageKeys List<Pulumi.AwsNative.ApiGateway.Outputs.ApiKeyStageKey>
    DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
    ApiKeyId string
    The ID for the API key. For example: abc123 .
    CustomerId string
    An MKT customer identifier, when integrating with the AWS SaaS Marketplace.
    Description string
    The description of the ApiKey.
    Enabled bool
    Specifies whether the ApiKey can be used by callers.
    StageKeys []ApiKeyStageKey
    DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
    Tags Tag
    The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
    apiKeyId String
    The ID for the API key. For example: abc123 .
    customerId String
    An MKT customer identifier, when integrating with the AWS SaaS Marketplace.
    description String
    The description of the ApiKey.
    enabled Boolean
    Specifies whether the ApiKey can be used by callers.
    stageKeys List<ApiKeyStageKey>
    DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
    tags List<Tag>
    The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
    apiKeyId string
    The ID for the API key. For example: abc123 .
    customerId string
    An MKT customer identifier, when integrating with the AWS SaaS Marketplace.
    description string
    The description of the ApiKey.
    enabled boolean
    Specifies whether the ApiKey can be used by callers.
    stageKeys ApiKeyStageKey[]
    DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
    tags Tag[]
    The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
    api_key_id str
    The ID for the API key. For example: abc123 .
    customer_id str
    An MKT customer identifier, when integrating with the AWS SaaS Marketplace.
    description str
    The description of the ApiKey.
    enabled bool
    Specifies whether the ApiKey can be used by callers.
    stage_keys Sequence[ApiKeyStageKey]
    DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
    tags Sequence[root_Tag]
    The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
    apiKeyId String
    The ID for the API key. For example: abc123 .
    customerId String
    An MKT customer identifier, when integrating with the AWS SaaS Marketplace.
    description String
    The description of the ApiKey.
    enabled Boolean
    Specifies whether the ApiKey can be used by callers.
    stageKeys List<Property Map>
    DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
    tags List<Property Map>
    The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

    Supporting Types

    ApiKeyStageKey

    RestApiId string
    The string identifier of the associated RestApi.
    StageName string
    The stage name associated with the stage key.
    RestApiId string
    The string identifier of the associated RestApi.
    StageName string
    The stage name associated with the stage key.
    restApiId String
    The string identifier of the associated RestApi.
    stageName String
    The stage name associated with the stage key.
    restApiId string
    The string identifier of the associated RestApi.
    stageName string
    The stage name associated with the stage key.
    rest_api_id str
    The string identifier of the associated RestApi.
    stage_name str
    The stage name associated with the stage key.
    restApiId String
    The string identifier of the associated RestApi.
    stageName String
    The stage name associated with the stage key.

    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.111.0 published on Tuesday, Jul 9, 2024 by Pulumi