software.amazon.awscdk.services.appsync

Interface CfnApiKeyProps

All Known Implementing Classes:

CfnApiKeyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:29.201Z")
public interface CfnApiKeyProps

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
         .apiKeyId("apiKeyId")
         .description("description")
         .expires(123)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

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

Method Detail

getApiId

java.lang.String getApiId()

Unique AWS AppSync GraphQL API ID for this API key.

getApiKeyId

default java.lang.String getApiKeyId()

The API key ID.

getDescription

default java.lang.String getDescription()

Unique description of your API key.

getExpires

default java.lang.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.

builder

static CfnApiKeyProps.Builder builder()

Returns:

a CfnApiKeyProps.Builder of CfnApiKeyProps