Package software.amazon.awscdk.services.appsync

Class CfnApi.Builder

java.lang.Object

software.amazon.awscdk.services.appsync.CfnApi.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnApi>

Enclosing class:

CfnApi

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

A fluent builder for CfnApi.

Method Summary

Modifier and Type	Method	Description
CfnApi	build()
static CfnApi.Builder	create(software.constructs.Construct scope, String id)
CfnApi.Builder	eventConfig(IResolvable eventConfig)	Describes the authorization configuration for connections, message publishing, message subscriptions, and logging for an Event API.
CfnApi.Builder	eventConfig(CfnApi.EventConfigProperty eventConfig)	Describes the authorization configuration for connections, message publishing, message subscriptions, and logging for an Event API.
CfnApi.Builder	name(String name)	The name of the Api .
CfnApi.Builder	ownerContact(String ownerContact)	The owner contact information for an API resource.
CfnApi.Builder	tags(List<? extends CfnTag> tags)	A set of tags (key-value pairs) for this API.

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 CfnApi.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 CfnApi.Builder.

name

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

The name of the Api .

Parameters:

name - The name of the Api . This parameter is required.

Returns:

this

See Also:

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

eventConfig

@Stability(Stable)
public CfnApi.Builder eventConfig(IResolvable eventConfig)

Describes the authorization configuration for connections, message publishing, message subscriptions, and logging for an Event API.

Parameters:

eventConfig - Describes the authorization configuration for connections, message publishing, message subscriptions, and logging for an Event API. This parameter is required.

Returns:

this

See Also:

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

eventConfig

@Stability(Stable)
public CfnApi.Builder eventConfig(CfnApi.EventConfigProperty eventConfig)

Describes the authorization configuration for connections, message publishing, message subscriptions, and logging for an Event API.

Parameters:

eventConfig - Describes the authorization configuration for connections, message publishing, message subscriptions, and logging for an Event API. This parameter is required.

Returns:

this

See Also:

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

ownerContact

@Stability(Stable)
public CfnApi.Builder ownerContact(String ownerContact)

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

Parameters:

ownerContact - The owner contact information for an API resource. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnApi.Builder tags(List<? extends CfnTag> tags)

A set of tags (key-value pairs) for this API.

Parameters:

tags - A set of tags (key-value pairs) for this API. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnApi build()

Specified by:

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

Returns:

a newly built instance of CfnApi.