software.amazon.awscdk.services.appsync

Class CfnApiKey

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.appsync.CfnApiKey

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:51.438Z")
public class CfnApiKey
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AppSync::ApiKey`.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnApiKey.Builder A fluent builder for CfnApiKey.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnApiKey(Construct scope, java.lang.String id, CfnApiKeyProps props) Create a new `AWS::AppSync::ApiKey`.
protected	CfnApiKey(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnApiKey(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApiId() Unique AWS AppSync GraphQL API ID for this API key.
java.lang.String	getApiKeyId() The API key ID.
java.lang.String	getAttrApiKey() The API key.
java.lang.String	getAttrArn() The Amazon Resource Name (ARN) of the API key, such as `arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/apikey/apikeya1bzhi` .
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() Unique description of your API key.
java.lang.Number	getExpires() The time after which the API key expires.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setApiId(java.lang.String value) Unique AWS AppSync GraphQL API ID for this API key.
void	setApiKeyId(java.lang.String value) The API key ID.
void	setDescription(java.lang.String value) Unique description of your API key.
void	setExpires(java.lang.Number value) The time after which the API key expires.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnApiKey

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

CfnApiKey

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

CfnApiKey

public CfnApiKey(Construct scope,
                 java.lang.String id,
                 CfnApiKeyProps props)

Create a new `AWS::AppSync::ApiKey`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrApiKey

public java.lang.String getAttrApiKey()

The API key.

getAttrArn

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

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getApiId

public java.lang.String getApiId()

Unique AWS AppSync GraphQL API ID for this API key.

setApiId

public void setApiId(java.lang.String value)

Unique AWS AppSync GraphQL API ID for this API key.

getApiKeyId

public java.lang.String getApiKeyId()

The API key ID.

setApiKeyId

public void setApiKeyId(java.lang.String value)

The API key ID.

getDescription

public java.lang.String getDescription()

Unique description of your API key.

setDescription

public void setDescription(java.lang.String value)

Unique description of your API key.

getExpires

public 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.

setExpires

public void setExpires(java.lang.Number value)

The time after which the API key expires.

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