Package software.amazon.awscdk.services.events.targets

Class AppSyncGraphQLApiProps.Builder

java.lang.Object

software.amazon.awscdk.services.events.targets.AppSyncGraphQLApiProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AppSyncGraphQLApiProps>

Enclosing interface:

AppSyncGraphQLApiProps

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

A builder for AppSyncGraphQLApiProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AppSyncGraphQLApiProps	build()	Builds the configured instance.
AppSyncGraphQLApiProps.Builder	deadLetterQueue(IQueue deadLetterQueue)	Sets the value of TargetBaseProps.getDeadLetterQueue()
AppSyncGraphQLApiProps.Builder	eventRole(IRole eventRole)	Sets the value of AppSyncGraphQLApiProps.getEventRole()
AppSyncGraphQLApiProps.Builder	graphQlOperation(String graphQlOperation)	Sets the value of invalid @link AppSyncGraphQLApiProps#getGraphQlOperation
AppSyncGraphQLApiProps.Builder	maxEventAge(Duration maxEventAge)	Sets the value of TargetBaseProps.getMaxEventAge()
AppSyncGraphQLApiProps.Builder	retryAttempts(Number retryAttempts)	Sets the value of TargetBaseProps.getRetryAttempts()
AppSyncGraphQLApiProps.Builder	variables(RuleTargetInput variables)	Sets the value of AppSyncGraphQLApiProps.getVariables()

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

graphQlOperation

@Stability(Stable)
public AppSyncGraphQLApiProps.Builder graphQlOperation(String graphQlOperation)

Sets the value of

invalid @link

AppSyncGraphQLApiProps#getGraphQlOperation

Parameters:

graphQlOperation - The GraphQL operation;. This parameter is required. that is, the query, mutation, or subscription to be parsed and executed by the GraphQL service.

Returns:

this

eventRole

@Stability(Stable)
public AppSyncGraphQLApiProps.Builder eventRole(IRole eventRole)

Sets the value of AppSyncGraphQLApiProps.getEventRole()

Parameters:

eventRole - The role to assume before invoking the target (i.e., the pipeline) when the given rule is triggered.

Returns:

this

variables

@Stability(Stable)
public AppSyncGraphQLApiProps.Builder variables(RuleTargetInput variables)

Sets the value of AppSyncGraphQLApiProps.getVariables()

Parameters:

variables - The variables that are include in the GraphQL operation.

Returns:

this

deadLetterQueue

@Stability(Stable)
public AppSyncGraphQLApiProps.Builder deadLetterQueue(IQueue deadLetterQueue)

Sets the value of TargetBaseProps.getDeadLetterQueue()

Parameters:

deadLetterQueue - The SQS queue to be used as deadLetterQueue. Check out the considerations for using a dead-letter queue. The events not successfully delivered are automatically retried for a specified period of time, depending on the retry policy of the target. If an event is not delivered before all retry attempts are exhausted, it will be sent to the dead letter queue.

Returns:

this

maxEventAge

@Stability(Stable)
public AppSyncGraphQLApiProps.Builder maxEventAge(Duration maxEventAge)

Sets the value of TargetBaseProps.getMaxEventAge()

Parameters:

maxEventAge - The maximum age of a request that Lambda sends to a function for processing. Minimum value of 60. Maximum value of 86400.

Returns:

this

retryAttempts

@Stability(Stable)
public AppSyncGraphQLApiProps.Builder retryAttempts(Number retryAttempts)

Sets the value of TargetBaseProps.getRetryAttempts()

Parameters:

retryAttempts - The maximum number of times to retry when the function returns an error. Minimum value of 0. Maximum value of 185.

Returns:

this

build

@Stability(Stable)
public AppSyncGraphQLApiProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of AppSyncGraphQLApiProps

Throws:

NullPointerException - if any required attribute was not provided