AWS Native is in preview. AWS Classic is fully supported.
aws-native.apigateway.getApiKey
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
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:
- Api
Key stringId A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs
- Api
Key stringId A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs
- api
Key StringId A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs
- api
Key stringId A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs
- api_
key_ strid A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs
- api
Key StringId 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:
- Api
Key stringId A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs
- Customer
Id 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.
- Stage
Keys List<Pulumi.Aws Native. Api Gateway. Outputs. Api Key Stage Key> A list of stages to associate with this API key.
- List<Pulumi.
Aws Native. Api Gateway. Outputs. Api Key Tag> An array of arbitrary tags (key-value pairs) to associate with the API key.
- Api
Key stringId A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs
- Customer
Id 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.
- Stage
Keys []ApiKey Stage Key A list of stages to associate with this API key.
- []Api
Key Tag An array of arbitrary tags (key-value pairs) to associate with the API key.
- api
Key StringId A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs
- customer
Id 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.
- stage
Keys List<ApiKey Stage Key> A list of stages to associate with this API key.
- List<Api
Key Tag> An array of arbitrary tags (key-value pairs) to associate with the API key.
- api
Key stringId A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs
- customer
Id 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.
- stage
Keys ApiKey Stage Key[] A list of stages to associate with this API key.
- Api
Key Tag[] An array of arbitrary tags (key-value pairs) to associate with the API key.
- api_
key_ strid 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[ApiKey Stage Key] A list of stages to associate with this API key.
- Sequence[Api
Key Tag] An array of arbitrary tags (key-value pairs) to associate with the API key.
- api
Key StringId A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs
- customer
Id 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.
- stage
Keys List<Property Map> A list of stages to associate with this API key.
- List<Property Map>
An array of arbitrary tags (key-value pairs) to associate with the API key.
Supporting Types
ApiKeyStageKey
- rest_
api_ strid 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.
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 is in preview. AWS Classic is fully supported.