Package software.amazon.awscdk.cfnpropertymixins.services.appsync

Interface CfnApiKeyMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApiKeyMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:55.957Z")
@Stability(Stable)
public interface CfnApiKeyMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnApiKeyPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.appsync.*;
 CfnApiKeyMixinProps cfnApiKeyMixinProps = CfnApiKeyMixinProps.builder()
         .apiId("apiId")
         .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	CfnApiKeyMixinProps.Builder	A builder for CfnApiKeyMixinProps
static final class	CfnApiKeyMixinProps.Jsii$Proxy	An implementation for CfnApiKeyMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnApiKeyMixinProps.Builder	builder()
default 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)
@Nullable
default 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 CfnApiKeyMixinProps.Builder builder()

Returns:

a CfnApiKeyMixinProps.Builder of CfnApiKeyMixinProps