Package software.amazon.awscdk.services.appsync

Class ApiKeyConfig.Builder

java.lang.Object

software.amazon.awscdk.services.appsync.ApiKeyConfig.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ApiKeyConfig>

Enclosing interface:

ApiKeyConfig

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

A builder for ApiKeyConfig

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ApiKeyConfig	build()	Builds the configured instance.
ApiKeyConfig.Builder	description(String description)	Sets the value of ApiKeyConfig.getDescription()
ApiKeyConfig.Builder	expires(Expiration expires)	Sets the value of ApiKeyConfig.getExpires()
ApiKeyConfig.Builder	name(String name)	Sets the value of ApiKeyConfig.getName()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

description

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

Sets the value of ApiKeyConfig.getDescription()

Parameters:

description - Description of API key.

Returns:

this

expires

@Stability(Stable)
public ApiKeyConfig.Builder expires(Expiration expires)

Sets the value of ApiKeyConfig.getExpires()

Parameters:

expires - The time from creation time after which the API key expires. It must be a minimum of 1 day and a maximum of 365 days from date of creation. Rounded down to the nearest hour.

Returns:

this

name

@Stability(Stable)
public ApiKeyConfig.Builder name(String name)

Sets the value of ApiKeyConfig.getName()

Parameters:

name - Unique name of the API Key.

Returns:

this

build

@Stability(Stable)
public ApiKeyConfig build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ApiKeyConfig

Throws:

NullPointerException - if any required attribute was not provided