Package com.pulumi.aws.appsync

Class ApiKey

  • public class ApiKey
extends com.pulumi.resources.CustomResource
    Provides an AppSync API Key. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.appsync.GraphQLApi;
 import com.pulumi.aws.appsync.GraphQLApiArgs;
 import com.pulumi.aws.appsync.ApiKey;
 import com.pulumi.aws.appsync.ApiKeyArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 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 GraphQLApi("example", GraphQLApiArgs.builder()
             .authenticationType("API_KEY")
             .name("example")
             .build());
 
         var exampleApiKey = new ApiKey("exampleApiKey", ApiKeyArgs.builder()
             .apiId(example.id())
             .expires("2018-05-03T04:00:00Z")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import `aws.appsync.ApiKey` using the AppSync API ID and key separated by `:`. For example: ```sh $ pulumi import aws:appsync/apiKey:ApiKey example xxxxx:yyyyy ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      ApiKey​(java.lang.String name)  
      ApiKey​(java.lang.String name, ApiKeyArgs args)  
      ApiKey​(java.lang.String name, ApiKeyArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> apiId()  
      com.pulumi.core.Output<java.lang.String> apiKeyId()  
      com.pulumi.core.Output<java.lang.String> description()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> expires()  
      static ApiKey get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ApiKeyState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> key()  
      com.pulumi.core.Output<java.lang.String> region()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ApiKey

        public ApiKey​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • ApiKey

        public ApiKey​(java.lang.String name,
              ApiKeyArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • ApiKey

        public ApiKey​(java.lang.String name,
              ApiKeyArgs args,
              @Nullable
              com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • apiId

        public com.pulumi.core.Output<java.lang.String> apiId()
        Returns:
        ID of the associated AppSync API

      • apiKeyId

        public com.pulumi.core.Output<java.lang.String> apiKeyId()
        Returns:
        ID of the API key.

      • description

        public com.pulumi.core.Output<java.lang.String> description()
        Returns:
        API key description. Defaults to "Managed by Pulumi".

      • expires

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> expires()
        Returns:
        RFC3339 string representation of the expiry date. Rounded down to nearest hour. By default, it is 7 days from the date of creation.

      • key

        public com.pulumi.core.Output<java.lang.String> key()
        Returns:
        API key

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • get

        public static ApiKey get​(java.lang.String name,
                         com.pulumi.core.Output<java.lang.String> id,
                         @Nullable
                         ApiKeyState state,
                         @Nullable
                         com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.