Interface CfnApiProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnApiProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
date="2025-07-16T11:43:09.717Z")
@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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnApiProps
static final class
An implementation forCfnApiProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnApiProps.Builder
builder()
default Object
Describes the authorization configuration for connections, message publishing, message subscriptions, and logging for an Event API.getName()
The name of theApi
.default String
The owner contact information for an API resource.getTags()
A set of tags (key-value pairs) for this API.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getName
The name of theApi
.- See Also:
-
getEventConfig
Describes the authorization configuration for connections, message publishing, message subscriptions, and logging for an Event API.- See Also:
-
getOwnerContact
The owner contact information for an API resource.This field accepts any string input with a length of 0 - 256 characters.
- See Also:
-
getTags
A set of tags (key-value pairs) for this API.- See Also:
-
builder
- Returns:
- a
CfnApiProps.Builder
ofCfnApiProps
-