Package software.amazon.awscdk.services.appsync

Interface CfnApiProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApiProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:04.388Z")
@Stability(Stable)
public interface CfnApiProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnApi.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appsync.*;
 CfnApiProps cfnApiProps = CfnApiProps.builder()
         .name("name")
         // the properties below are optional
         .eventConfig(EventConfigProperty.builder()
                 .authProviders(List.of(AuthProviderProperty.builder()
                         .authType("authType")
                         // the properties below are optional
                         .cognitoConfig(CognitoConfigProperty.builder()
                                 .awsRegion("awsRegion")
                                 .userPoolId("userPoolId")
                                 // the properties below are optional
                                 .appIdClientRegex("appIdClientRegex")
                                 .build())
                         .lambdaAuthorizerConfig(LambdaAuthorizerConfigProperty.builder()
                                 .authorizerUri("authorizerUri")
                                 // the properties below are optional
                                 .authorizerResultTtlInSeconds(123)
                                 .identityValidationExpression("identityValidationExpression")
                                 .build())
                         .openIdConnectConfig(OpenIDConnectConfigProperty.builder()
                                 .issuer("issuer")
                                 // the properties below are optional
                                 .authTtl(123)
                                 .clientId("clientId")
                                 .iatTtl(123)
                                 .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()))
                 // the properties below are optional
                 .logConfig(EventLogConfigProperty.builder()
                         .cloudWatchLogsRoleArn("cloudWatchLogsRoleArn")
                         .logLevel("logLevel")
                         .build())
                 .build())
         .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	CfnApiProps.Builder	A builder for CfnApiProps
static final class	CfnApiProps.Jsii$Proxy	An implementation for CfnApiProps

Method Summary

Modifier and Type	Method	Description
static CfnApiProps.Builder	builder()
default Object	getEventConfig()	The configuration for an Event Api.
String	getName()	The API name.
default String	getOwnerContact()	The owner contact information for an API resource.
default List<CfnTag>	getTags()	The tags.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The API name.

See Also:

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

getEventConfig

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

The configuration for an Event Api.

See Also:

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

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()

The tags.

See Also:

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

builder

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

Returns:

a CfnApiProps.Builder of CfnApiProps