pulumi-aws-kotlin/com.pulumi.aws.apigateway.kotlin/ApiKey

ApiKey

class ApiKey : KotlinCustomResource

Provides an API Gateway API Key.

NOTE: Since the API Gateway usage plans feature was launched on August 11, 2016, usage plans are now required to associate an API key with an API stage.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigateway.ApiKey;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var example = new ApiKey("example");
    }
}

Import

terraform import { to = aws_api_gateway_api_key.example id = "8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk" } Using pulumi import, import API Gateway Keys using the id. For exampleconsole % TODO import aws_api_gateway_api_key.example 8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk

Properties

val arn: Output<String>

ARN

val createdDate: Output<String>

Creation date of the API key

val customerId: Output<String>?

An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.

val description: Output<String>

API key description. Defaults to "Managed by Pulumi".

val enabled: Output<Boolean>?

Whether the API key can be used by callers. Defaults to true.

val id: Output<String>

lastUpdatedDate

val lastUpdatedDate: Output<String>

Last update date of the API key

val name: Output<String>

Name of the API key.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

val tags: Output<Map<String, String>>?

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

val ~~tagsAll~~: Output<Map<String, String>>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

val urn: Output<String>

val value: Output<String>

Value of the API key. If specified, the value must be an alphanumeric string between 20 and 128 characters. If not specified, it will be automatically generated by AWS on creation.