Package software.amazon.awscdk.cfnpropertymixins.services.appsync

Interface CfnApiMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApiMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:55.959Z")
@Stability(Stable)
public interface CfnApiMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnApiPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.appsync.*;
 CfnApiMixinProps cfnApiMixinProps = CfnApiMixinProps.builder()
         .eventConfig(EventConfigProperty.builder()
                 .authProviders(List.of(AuthProviderProperty.builder()
                         .authType("authType")
                         .cognitoConfig(CognitoConfigProperty.builder()
                                 .appIdClientRegex("appIdClientRegex")
                                 .awsRegion("awsRegion")
                                 .userPoolId("userPoolId")
                                 .build())
                         .lambdaAuthorizerConfig(LambdaAuthorizerConfigProperty.builder()
                                 .authorizerResultTtlInSeconds(123)
                                 .authorizerUri("authorizerUri")
                                 .identityValidationExpression("identityValidationExpression")
                                 .build())
                         .openIdConnectConfig(OpenIDConnectConfigProperty.builder()
                                 .authTtl(123)
                                 .clientId("clientId")
                                 .iatTtl(123)
                                 .issuer("issuer")
                                 .build())
                         .build()))
                 .connectionAuthModes(List.of(AuthModeProperty.builder()
                         .authType("authType")
                         .build()))
                 .defaultPublishAuthModes(List.of(AuthModeProperty.builder()
                         .authType("authType")
                         .build()))
                 .defaultSubscribeAuthModes(List.of(AuthModeProperty.builder()
                         .authType("authType")
                         .build()))
                 .logConfig(EventLogConfigProperty.builder()
                         .cloudWatchLogsRoleArn("cloudWatchLogsRoleArn")
                         .logLevel("logLevel")
                         .build())
                 .build())
         .name("name")
         .ownerContact("ownerContact")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnApiMixinProps.Builder	A builder for CfnApiMixinProps
static final class	CfnApiMixinProps.Jsii$Proxy	An implementation for CfnApiMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnApiMixinProps.Builder	builder()
default Object	getEventConfig()	Describes the authorization configuration for connections, message publishing, message subscriptions, and logging for an Event API.
default String	getName()	The name of the Api .
default String	getOwnerContact()	The owner contact information for an API resource.
default List<CfnTag>	getTags()	A set of tags (key-value pairs) for this API.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEventConfig

@Stability(Stable)
@Nullable
default Object getEventConfig()

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

Returns union: either IResolvable or CfnApiPropsMixin.EventConfigProperty

See Also:

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

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the Api .

See Also:

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

getOwnerContact

@Stability(Stable)
@Nullable
default String getOwnerContact()

The owner contact information for an API resource.

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

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

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

builder

@Stability(Stable)
static CfnApiMixinProps.Builder builder()

Returns:

a CfnApiMixinProps.Builder of CfnApiMixinProps