Package software.amazon.awscdk.services.appsync

Class CfnApiKey

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.appsync.CfnApiKey
All Implemented Interfaces:
IInspectable, IApiKeyRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:05.084Z") @Stability(Stable) public class CfnApiKey extends CfnResource implements IInspectable, IApiKeyRef
The AWS::AppSync::ApiKey resource creates a unique key that you can distribute to clients who are executing GraphQL operations with AWS AppSync that require an API key.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appsync.*;
 CfnApiKey cfnApiKey = CfnApiKey.Builder.create(this, "MyCfnApiKey")
         .apiId("apiId")
         // the properties below are optional
         .description("description")
         .expires(123)
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnApiKey

      protected CfnApiKey(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnApiKey

      protected CfnApiKey(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnApiKey

      @Stability(Stable) public CfnApiKey(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnApiKeyProps props)
      Create a new AWS::AppSync::ApiKey.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForApiKey

      @Stability(Stable) @NotNull public static String arnForApiKey(@NotNull IApiKeyRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnApiKey

      @Stability(Stable) @NotNull public static Boolean isCfnApiKey(@NotNull Object x)
      Checks whether the given object is a CfnApiKey.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getApiKeyRef

      @Stability(Stable) @NotNull public ApiKeyReference getApiKeyRef()
      A reference to a ApiKey resource.
      Specified by:
      getApiKeyRef in interface IApiKeyRef

    • getAttrApiKey

      @Stability(Stable) @NotNull public String getAttrApiKey()
      The API key.

    • getAttrApiKeyId

      @Stability(Stable) @NotNull public String getAttrApiKeyId()
      The API key ID.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the API key, such as arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/apikey/apikeya1bzhi .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getApiId

      @Stability(Stable) @NotNull public String getApiId()
      Unique AWS AppSync GraphQL API ID for this API key.

    • setApiId

      @Stability(Stable) public void setApiId(@NotNull String value)
      Unique AWS AppSync GraphQL API ID for this API key.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      Unique description of your API key.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      Unique description of your API key.

    • getExpires

      @Stability(Stable) @Nullable public Number getExpires()
      The time after which the API key expires.

    • setExpires

      @Stability(Stable) public void setExpires(@Nullable Number value)
      The time after which the API key expires.