Package software.amazon.awscdk.services.appsync

Class CfnApiKey.Builder

java.lang.Object

software.amazon.awscdk.services.appsync.CfnApiKey.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnApiKey>

Enclosing class:

CfnApiKey

@Stability(Stable)
public static final class CfnApiKey.Builder
extends Object
implements software.amazon.jsii.Builder<CfnApiKey>

A fluent builder for CfnApiKey.

Method Summary

Modifier and Type	Method	Description
CfnApiKey.Builder	apiId(String apiId)	Unique AWS AppSync GraphQL API ID for this API key.
CfnApiKey	build()
static CfnApiKey.Builder	create(software.constructs.Construct scope, String id)
CfnApiKey.Builder	description(String description)	Unique description of your API key.
CfnApiKey.Builder	expires(Number expires)	The time after which the API key expires.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnApiKey.Builder create(software.constructs.Construct scope,
 String id)

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.

Returns:

a new instance of CfnApiKey.Builder.

apiId

@Stability(Stable)
public CfnApiKey.Builder apiId(String apiId)

Unique AWS AppSync GraphQL API ID for this API key.

Parameters:

apiId - Unique AWS AppSync GraphQL API ID for this API key. This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnApiKey.Builder description(String description)

Unique description of your API key.

Parameters:

description - Unique description of your API key. This parameter is required.

Returns:

this

See Also:

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

expires

@Stability(Stable)
public CfnApiKey.Builder expires(Number expires)

The time after which the API key expires.

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

Parameters:

expires - The time after which the API key expires. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnApiKey build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnApiKey>

Returns:

a newly built instance of CfnApiKey.