Docs Packages
  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.77.0 published on Wednesday, Sep 20, 2023 by Pulumi
pulumi/pulumi-aws-native

aws-native.apigateway.getApiKey

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.77.0 published on Wednesday, Sep 20, 2023 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::ApiGateway::ApiKey

    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

    A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs

    ApiKeyId string

    A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs

    apiKeyId String

    A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs

    apiKeyId string

    A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs

    api_key_id str

    A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs

    apiKeyId String

    A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs

    getApiKey Result

    The following output properties are available:

    ApiKeyId string

    A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs

    CustomerId string

    An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.

    Description string

    A description of the purpose of the API key.

    Enabled bool

    Indicates whether the API key can be used by clients.

    StageKeys List<Pulumi.AwsNative.ApiGateway.Outputs.ApiKeyStageKey>

    A list of stages to associate with this API key.

    Tags List<Pulumi.AwsNative.ApiGateway.Outputs.ApiKeyTag>

    An array of arbitrary tags (key-value pairs) to associate with the API key.

    ApiKeyId string

    A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs

    CustomerId string

    An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.

    Description string

    A description of the purpose of the API key.

    Enabled bool

    Indicates whether the API key can be used by clients.

    StageKeys []ApiKeyStageKey

    A list of stages to associate with this API key.

    Tags []ApiKeyTag

    An array of arbitrary tags (key-value pairs) to associate with the API key.

    apiKeyId String

    A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs

    customerId String

    An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.

    description String

    A description of the purpose of the API key.

    enabled Boolean

    Indicates whether the API key can be used by clients.

    stageKeys List<ApiKeyStageKey>

    A list of stages to associate with this API key.

    tags List<ApiKeyTag>

    An array of arbitrary tags (key-value pairs) to associate with the API key.

    apiKeyId string

    A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs

    customerId string

    An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.

    description string

    A description of the purpose of the API key.

    enabled boolean

    Indicates whether the API key can be used by clients.

    stageKeys ApiKeyStageKey[]

    A list of stages to associate with this API key.

    tags ApiKeyTag[]

    An array of arbitrary tags (key-value pairs) to associate with the API key.

    api_key_id str

    A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs

    customer_id str

    An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.

    description str

    A description of the purpose of the API key.

    enabled bool

    Indicates whether the API key can be used by clients.

    stage_keys Sequence[ApiKeyStageKey]

    A list of stages to associate with this API key.

    tags Sequence[ApiKeyTag]

    An array of arbitrary tags (key-value pairs) to associate with the API key.

    apiKeyId String

    A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs

    customerId String

    An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.

    description String

    A description of the purpose of the API key.

    enabled Boolean

    Indicates whether the API key can be used by clients.

    stageKeys List<Property Map>

    A list of stages to associate with this API key.

    tags List<Property Map>

    An array of arbitrary tags (key-value pairs) to associate with the API key.

    Supporting Types

    ApiKeyStageKey

    RestApiId string

    The ID of a RestApi resource that includes the stage with which you want to associate the API key.

    StageName string

    The name of the stage with which to associate the API key. The stage must be included in the RestApi resource that you specified in the RestApiId property.

    RestApiId string

    The ID of a RestApi resource that includes the stage with which you want to associate the API key.

    StageName string

    The name of the stage with which to associate the API key. The stage must be included in the RestApi resource that you specified in the RestApiId property.

    restApiId String

    The ID of a RestApi resource that includes the stage with which you want to associate the API key.

    stageName String

    The name of the stage with which to associate the API key. The stage must be included in the RestApi resource that you specified in the RestApiId property.

    restApiId string

    The ID of a RestApi resource that includes the stage with which you want to associate the API key.

    stageName string

    The name of the stage with which to associate the API key. The stage must be included in the RestApi resource that you specified in the RestApiId property.

    rest_api_id str

    The ID of a RestApi resource that includes the stage with which you want to associate the API key.

    stage_name str

    The name of the stage with which to associate the API key. The stage must be included in the RestApi resource that you specified in the RestApiId property.

    restApiId String

    The ID of a RestApi resource that includes the stage with which you want to associate the API key.

    stageName String

    The name of the stage with which to associate the API key. The stage must be included in the RestApi resource that you specified in the RestApiId property.

    ApiKeyTag

    Key string

    The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

    Value string

    The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

    Key string

    The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

    Value string

    The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

    key String

    The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

    value String

    The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

    key string

    The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

    value string

    The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

    key str

    The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

    value str

    The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

    key String

    The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

    value String

    The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

    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.77.0 published on Wednesday, Sep 20, 2023 by Pulumi
    pulumi/pulumi-aws-native