Package software.amazon.awscdk.services.appsync

Class CfnGraphQLApiProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.appsync.CfnGraphQLApiProps.Jsii$Proxy

All Implemented Interfaces:

CfnGraphQLApiProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnGraphQLApiProps

@Stability(Stable)
@Internal
public static final class CfnGraphQLApiProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnGraphQLApiProps

An implementation for CfnGraphQLApiProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.appsync.CfnGraphQLApiProps

CfnGraphQLApiProps.Builder, CfnGraphQLApiProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnGraphQLApiProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnGraphQLApiProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getAdditionalAuthenticationProviders()	A list of additional authentication providers for the GraphqlApi API.
final String	getApiType()	The value that indicates whether the GraphQL API is a standard API ( GRAPHQL ) or merged API ( MERGED ).
final String	getAuthenticationType()	Security configuration for your GraphQL API.
final Object	getEnhancedMetricsConfig()	Enables and controls the enhanced metrics feature.
final Object	getEnvironmentVariables()	A map containing the list of resources with their properties and environment variables.
final String	getIntrospectionConfig()	Sets the value of the GraphQL API to enable ( ENABLED ) or disable ( DISABLED ) introspection.
final Object	getLambdaAuthorizerConfig()	A LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode.
final Object	getLogConfig()	The Amazon CloudWatch Logs configuration.
final String	getMergedApiExecutionRoleArn()	The AWS Identity and Access Management service role ARN for a merged API.
final String	getName()	The API name.
final Object	getOpenIdConnectConfig()	The OpenID Connect configuration.
final String	getOwnerContact()	The owner contact information for an API resource.
final Number	getQueryDepthLimit()	The maximum depth a query can have in a single request.
final Number	getResolverCountLimit()	The maximum number of resolvers that can be invoked in a single request.
final List<CfnTag>	getTags()	An arbitrary set of tags (key-value pairs) for this GraphQL API.
final Object	getUserPoolConfig()	Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.
final String	getVisibility()	Sets the scope of the GraphQL API to public ( GLOBAL ) or private ( PRIVATE ).
final Object	getXrayEnabled()	A flag indicating whether to use AWS X-Ray tracing for this GraphqlApi .
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnGraphQLApiProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnGraphQLApiProps.Builder.

Method Details

getAuthenticationType

public final String getAuthenticationType()

Description copied from interface: CfnGraphQLApiProps

Security configuration for your GraphQL API.

For allowed values (such as API_KEY , AWS_IAM , AMAZON_COGNITO_USER_POOLS , OPENID_CONNECT , or AWS_LAMBDA ), see Security in the AWS AppSync Developer Guide .

Specified by:

getAuthenticationType in interface CfnGraphQLApiProps

See Also:

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

getName

public final String getName()

Description copied from interface: CfnGraphQLApiProps

The API name.

Specified by:

getName in interface CfnGraphQLApiProps

See Also:

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

getAdditionalAuthenticationProviders

public final Object getAdditionalAuthenticationProviders()

Description copied from interface: CfnGraphQLApiProps

A list of additional authentication providers for the GraphqlApi API.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnGraphQLApi.AdditionalAuthenticationProviderProperty>

Specified by:

getAdditionalAuthenticationProviders in interface CfnGraphQLApiProps

See Also:

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

getApiType

public final String getApiType()

Description copied from interface: CfnGraphQLApiProps

The value that indicates whether the GraphQL API is a standard API ( GRAPHQL ) or merged API ( MERGED ).

WARNING : If the ApiType has not been defined, explicitly setting it to GRAPHQL in a template/stack update will result in an API replacement and new DNS values.

The following values are valid:

GRAPHQL | MERGED

Specified by:

getApiType in interface CfnGraphQLApiProps

See Also:

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

getEnhancedMetricsConfig

public final Object getEnhancedMetricsConfig()

Description copied from interface: CfnGraphQLApiProps

Enables and controls the enhanced metrics feature.

Enhanced metrics emit granular data on API usage and performance such as AppSync request and error counts, latency, and cache hits/misses. All enhanced metric data is sent to your CloudWatch account, and you can configure the types of data that will be sent.

Enhanced metrics can be configured at the resolver, data source, and operation levels. For more information, see Monitoring and logging in the AWS AppSync User Guide .

Returns union: either IResolvable or CfnGraphQLApi.EnhancedMetricsConfigProperty

Specified by:

getEnhancedMetricsConfig in interface CfnGraphQLApiProps

See Also:

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

getEnvironmentVariables

public final Object getEnvironmentVariables()

Description copied from interface: CfnGraphQLApiProps

A map containing the list of resources with their properties and environment variables.

For more information, see Environmental variables .

Pattern : ^[A-Za-z]+\\w*$\\

Minimum : 2

Maximum : 64

Returns union: either Mapinvalid input: '<'String, String> or IResolvable

Specified by:

getEnvironmentVariables in interface CfnGraphQLApiProps

See Also:

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

getIntrospectionConfig

public final String getIntrospectionConfig()

Description copied from interface: CfnGraphQLApiProps

Sets the value of the GraphQL API to enable ( ENABLED ) or disable ( DISABLED ) introspection.

If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.

For more information about introspection, see GraphQL introspection .

Specified by:

getIntrospectionConfig in interface CfnGraphQLApiProps

See Also:

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

getLambdaAuthorizerConfig

public final Object getLambdaAuthorizerConfig()

Description copied from interface: CfnGraphQLApiProps

A LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode.

Be aware that an AWS AppSync API may have only one Lambda authorizer configured at a time.

Returns union: either IResolvable or CfnGraphQLApi.LambdaAuthorizerConfigProperty

Specified by:

getLambdaAuthorizerConfig in interface CfnGraphQLApiProps

See Also:

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

getLogConfig

public final Object getLogConfig()

Description copied from interface: CfnGraphQLApiProps

The Amazon CloudWatch Logs configuration.

Returns union: either IResolvable or CfnGraphQLApi.LogConfigProperty

Specified by:

getLogConfig in interface CfnGraphQLApiProps

See Also:

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

getMergedApiExecutionRoleArn

public final String getMergedApiExecutionRoleArn()

Description copied from interface: CfnGraphQLApiProps

The AWS Identity and Access Management service role ARN for a merged API.

The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the AUTO_MERGE to update the merged API endpoint with the source API changes automatically.

Specified by:

getMergedApiExecutionRoleArn in interface CfnGraphQLApiProps

See Also:

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

getOpenIdConnectConfig

public final Object getOpenIdConnectConfig()

Description copied from interface: CfnGraphQLApiProps

The OpenID Connect configuration.

Returns union: either IResolvable or CfnGraphQLApi.OpenIDConnectConfigProperty

Specified by:

getOpenIdConnectConfig in interface CfnGraphQLApiProps

See Also:

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

getOwnerContact

public final String getOwnerContact()

Description copied from interface: CfnGraphQLApiProps

The owner contact information for an API resource.

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

Specified by:

getOwnerContact in interface CfnGraphQLApiProps

See Also:

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

getQueryDepthLimit

public final Number getQueryDepthLimit()

Description copied from interface: CfnGraphQLApiProps

The maximum depth a query can have in a single request.

Depth refers to the amount of nested levels allowed in the body of query. The default value is 0 (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between 1 and 75 nested levels. This field will produce a limit error if the operation falls out of bounds. Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.

Specified by:

getQueryDepthLimit in interface CfnGraphQLApiProps

See Also:

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

getResolverCountLimit

public final Number getResolverCountLimit()

Description copied from interface: CfnGraphQLApiProps

The maximum number of resolvers that can be invoked in a single request.

The default value is 0 (or unspecified), which will set the limit to 10000 . When specified, the limit value can be between 1 and 10000 . This field will produce a limit error if the operation falls out of bounds.

Specified by:

getResolverCountLimit in interface CfnGraphQLApiProps

See Also:

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

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnGraphQLApiProps

An arbitrary set of tags (key-value pairs) for this GraphQL API.

Specified by:

getTags in interface CfnGraphQLApiProps

See Also:

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

getUserPoolConfig

public final Object getUserPoolConfig()

Description copied from interface: CfnGraphQLApiProps

Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.

Returns union: either IResolvable or CfnGraphQLApi.UserPoolConfigProperty

Specified by:

getUserPoolConfig in interface CfnGraphQLApiProps

See Also:

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

getVisibility

public final String getVisibility()

Description copied from interface: CfnGraphQLApiProps

Sets the scope of the GraphQL API to public ( GLOBAL ) or private ( PRIVATE ).

By default, the scope is set to Global if no value is provided.

WARNING : If Visibility has not been defined, explicitly setting it to GLOBAL in a template/stack update will result in an API replacement and new DNS values.

Specified by:

getVisibility in interface CfnGraphQLApiProps

See Also:

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

getXrayEnabled

public final Object getXrayEnabled()

Description copied from interface: CfnGraphQLApiProps

A flag indicating whether to use AWS X-Ray tracing for this GraphqlApi .

Returns union: either Boolean or IResolvable

Specified by:

getXrayEnabled in interface CfnGraphQLApiProps

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object