Package software.amazon.awscdk.services.appsync

Interface CfnApiKeyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApiKeyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:09:58.899Z")
@Stability(Stable)
public interface CfnApiKeyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnApiKey.

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.*;
 CfnApiKeyProps cfnApiKeyProps = CfnApiKeyProps.builder()
         .apiId("apiId")
         // the properties below are optional
         .description("description")
         .expires(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnApiKeyProps.Builder	A builder for CfnApiKeyProps
static final class	CfnApiKeyProps.Jsii$Proxy	An implementation for CfnApiKeyProps

Method Summary

Modifier and Type	Method	Description
static CfnApiKeyProps.Builder	builder()
String	getApiId()	Unique AWS AppSync GraphQL API ID for this API key.
default String	getDescription()	Unique description of your API key.
default Number	getExpires()	The time after which the API key expires.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiId

@Stability(Stable)
@NotNull
String getApiId()

Unique AWS AppSync GraphQL API ID for this API key.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-apiid

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

Unique description of your API key.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-description

getExpires

@Stability(Stable)
@Nullable
default Number getExpires()

The time after which the API key expires.

The date is represented as seconds since the epoch, rounded down to the nearest hour.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-expires

builder

@Stability(Stable)
static CfnApiKeyProps.Builder builder()

Returns:

a CfnApiKeyProps.Builder of CfnApiKeyProps