Package-level declarations

Types

Link copied to clipboard
data class ApiAuthMode(val authType: ApiAuthenticationType? = null)

An auth mode.

Link copied to clipboard
data class ApiAuthProvider(val authType: ApiAuthenticationType, val cognitoConfig: ApiCognitoConfig? = null, val lambdaAuthorizerConfig: ApiLambdaAuthorizerConfig? = null, val openIdConnectConfig: ApiOpenIdConnectConfig? = null)

An auth provider for the AppSync API.

Link copied to clipboard
data class ApiCognitoConfig(val appIdClientRegex: String? = null, val awsRegion: String, val userPoolId: String)

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

Link copied to clipboard
data class ApiDnsMap(val http: String? = null, val realtime: String? = null)

A map of DNS names for the AppSync API.

Link copied to clipboard
data class ApiEventConfig(val authProviders: List<ApiAuthProvider>, val connectionAuthModes: List<ApiAuthMode>, val defaultPublishAuthModes: List<ApiAuthMode>, val defaultSubscribeAuthModes: List<ApiAuthMode>, val logConfig: ApiEventLogConfig? = null)

The configuration for an Event Api

Link copied to clipboard
data class ApiEventLogConfig(val cloudWatchLogsRoleArn: String, val logLevel: ApiEventLogLevel)

The log config for the AppSync API.

Link copied to clipboard
data class ApiLambdaAuthorizerConfig(val authorizerResultTtlInSeconds: Int? = null, val authorizerUri: String, val identityValidationExpression: String? = null)

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.

Link copied to clipboard
data class ApiOpenIdConnectConfig(val authTtl: Double? = null, val clientId: String? = null, val iatTtl: Double? = null, val issuer: String)

The OpenID Connect configuration.

Link copied to clipboard

An auth mode.

Link copied to clipboard
data class ChannelNamespaceHandlerConfigs(val onPublish: ChannelNamespaceHandlerConfig? = null, val onSubscribe: ChannelNamespaceHandlerConfig? = null)
Link copied to clipboard
data class ChannelNamespaceIntegration(val dataSourceName: String, val lambdaConfig: ChannelNamespaceLambdaConfig? = null)
Link copied to clipboard
Link copied to clipboard
data class DataSourceAuthorizationConfig(val authorizationType: String, val awsIamConfig: DataSourceAwsIamConfig? = null)
Link copied to clipboard
data class DataSourceAwsIamConfig(val signingRegion: String? = null, val signingServiceName: String? = null)
Link copied to clipboard
data class DataSourceDeltaSyncConfig(val baseTableTtl: String, val deltaSyncTableName: String, val deltaSyncTableTtl: String)
Link copied to clipboard
data class DataSourceDynamoDbConfig(val awsRegion: String, val deltaSyncConfig: DataSourceDeltaSyncConfig? = null, val tableName: String, val useCallerCredentials: Boolean? = null, val versioned: Boolean? = null)
Link copied to clipboard
data class DataSourceElasticsearchConfig(val awsRegion: String, val endpoint: String)
Link copied to clipboard
data class DataSourceEventBridgeConfig(val eventBusArn: String)
Link copied to clipboard
data class DataSourceHttpConfig(val authorizationConfig: DataSourceAuthorizationConfig? = null, val endpoint: String)
Link copied to clipboard
data class DataSourceLambdaConfig(val lambdaFunctionArn: String)
Link copied to clipboard
data class DataSourceOpenSearchServiceConfig(val awsRegion: String, val endpoint: String)
Link copied to clipboard
data class DataSourceRdsHttpEndpointConfig(val awsRegion: String, val awsSecretStoreArn: String, val databaseName: String? = null, val dbClusterIdentifier: String, val schema: String? = null)
Link copied to clipboard
data class DataSourceRelationalDatabaseConfig(val rdsHttpEndpointConfig: DataSourceRdsHttpEndpointConfig? = null, val relationalDatabaseSourceType: String)
Link copied to clipboard
data class FunctionConfigurationAppSyncRuntime(val name: String, val runtimeVersion: String)

Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.

data class FunctionConfigurationLambdaConflictHandlerConfig(val lambdaConflictHandlerArn: String? = null)

The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.

Link copied to clipboard
data class FunctionConfigurationSyncConfig(val conflictDetection: String, val conflictHandler: String? = null, val lambdaConflictHandlerConfig: FunctionConfigurationLambdaConflictHandlerConfig? = null)

Describes a Sync configuration for a resolver. Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.

Link copied to clipboard
data class GetApiResult(val apiArn: String? = null, val apiId: String? = null, val dns: ApiDnsMap? = null, val eventConfig: ApiEventConfig? = null, val name: String? = null, val ownerContact: String? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetChannelNamespaceResult(val channelNamespaceArn: String? = null, val codeHandlers: String? = null, val handlerConfigs: ChannelNamespaceHandlerConfigs? = null, val publishAuthModes: List<ChannelNamespaceAuthMode>? = null, val subscribeAuthModes: List<ChannelNamespaceAuthMode>? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetDataSourceResult(val dataSourceArn: String? = null, val description: String? = null, val dynamoDbConfig: DataSourceDynamoDbConfig? = null, val elasticsearchConfig: DataSourceElasticsearchConfig? = null, val eventBridgeConfig: DataSourceEventBridgeConfig? = null, val httpConfig: DataSourceHttpConfig? = null, val lambdaConfig: DataSourceLambdaConfig? = null, val metricsConfig: DataSourceMetricsConfig? = null, val openSearchServiceConfig: DataSourceOpenSearchServiceConfig? = null, val relationalDatabaseConfig: DataSourceRelationalDatabaseConfig? = null, val serviceRoleArn: String? = null, val type: String? = null)
Link copied to clipboard
data class GetDomainNameApiAssociationResult(val apiAssociationIdentifier: String? = null, val apiId: String? = null)
Link copied to clipboard
data class GetDomainNameResult(val appSyncDomainName: String? = null, val description: String? = null, val domainNameArn: String? = null, val hostedZoneId: String? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetFunctionConfigurationResult(val code: String? = null, val dataSourceName: String? = null, val description: String? = null, val functionArn: String? = null, val functionId: String? = null, val functionVersion: String? = null, val maxBatchSize: Int? = null, val name: String? = null, val requestMappingTemplate: String? = null, val responseMappingTemplate: String? = null, val runtime: FunctionConfigurationAppSyncRuntime? = null, val syncConfig: FunctionConfigurationSyncConfig? = null)
Link copied to clipboard
data class GetGraphQlApiResult(val additionalAuthenticationProviders: List<GraphQlApiAdditionalAuthenticationProvider>? = null, val apiId: String? = null, val apiType: String? = null, val arn: String? = null, val authenticationType: String? = null, val enhancedMetricsConfig: GraphQlApiEnhancedMetricsConfig? = null, val environmentVariables: Map<String, String>? = null, val graphQlDns: String? = null, val graphQlEndpointArn: String? = null, val graphQlUrl: String? = null, val introspectionConfig: String? = null, val lambdaAuthorizerConfig: GraphQlApiLambdaAuthorizerConfig? = null, val logConfig: GraphQlApiLogConfig? = null, val mergedApiExecutionRoleArn: String? = null, val name: String? = null, val openIdConnectConfig: GraphQlApiOpenIdConnectConfig? = null, val ownerContact: String? = null, val queryDepthLimit: Int? = null, val realtimeDns: String? = null, val realtimeUrl: String? = null, val resolverCountLimit: Int? = null, val tags: List<Tag>? = null, val userPoolConfig: GraphQlApiUserPoolConfig? = null, val visibility: String? = null, val xrayEnabled: Boolean? = null)
Link copied to clipboard
data class GetResolverResult(val cachingConfig: ResolverCachingConfig? = null, val code: String? = null, val dataSourceName: String? = null, val kind: String? = null, val maxBatchSize: Int? = null, val metricsConfig: ResolverMetricsConfig? = null, val pipelineConfig: ResolverPipelineConfig? = null, val requestMappingTemplate: String? = null, val resolverArn: String? = null, val responseMappingTemplate: String? = null, val runtime: ResolverAppSyncRuntime? = null, val syncConfig: ResolverSyncConfig? = null)
Link copied to clipboard
data class GetSourceApiAssociationResult(val associationArn: String? = null, val associationId: String? = null, val description: String? = null, val lastSuccessfulMergeDate: String? = null, val mergedApiArn: String? = null, val mergedApiId: String? = null, val sourceApiArn: String? = null, val sourceApiAssociationConfig: SourceApiAssociationConfig? = null, val sourceApiAssociationStatus: SourceApiAssociationStatus? = null, val sourceApiAssociationStatusDetail: String? = null, val sourceApiId: String? = null)
data class GraphQlApiAdditionalAuthenticationProvider(val authenticationType: String, val lambdaAuthorizerConfig: GraphQlApiLambdaAuthorizerConfig? = null, val openIdConnectConfig: GraphQlApiOpenIdConnectConfig? = null, val userPoolConfig: GraphQlApiCognitoUserPoolConfig? = null)
Link copied to clipboard
data class GraphQlApiCognitoUserPoolConfig(val appIdClientRegex: String? = null, val awsRegion: String? = null, val userPoolId: String? = null)
Link copied to clipboard
data class GraphQlApiEnhancedMetricsConfig(val dataSourceLevelMetricsBehavior: String, val operationLevelMetricsConfig: String, val resolverLevelMetricsBehavior: String)
Link copied to clipboard
data class GraphQlApiLambdaAuthorizerConfig(val authorizerResultTtlInSeconds: Int? = null, val authorizerUri: String? = null, val identityValidationExpression: String? = null)
Link copied to clipboard
data class GraphQlApiLogConfig(val cloudWatchLogsRoleArn: String? = null, val excludeVerboseContent: Boolean? = null, val fieldLogLevel: String? = null)
Link copied to clipboard
data class GraphQlApiOpenIdConnectConfig(val authTtl: Double? = null, val clientId: String? = null, val iatTtl: Double? = null, val issuer: String? = null)
Link copied to clipboard
data class GraphQlApiUserPoolConfig(val appIdClientRegex: String? = null, val awsRegion: String? = null, val defaultAction: String? = null, val userPoolId: String? = null)
Link copied to clipboard
data class ResolverAppSyncRuntime(val name: String, val runtimeVersion: String)

Describes a runtime used by an APSYlong resolver or APSYlong function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.

Link copied to clipboard
data class ResolverCachingConfig(val cachingKeys: List<String>? = null, val ttl: Double)

The caching configuration for a resolver that has caching activated.

Link copied to clipboard
data class ResolverLambdaConflictHandlerConfig(val lambdaConflictHandlerArn: String? = null)

The `LambdaConflictHandlerConfig` when configuring LAMBDA as the Conflict Handler.

Link copied to clipboard
data class ResolverPipelineConfig(val functions: List<String>? = null)

Use the `PipelineConfig` property type to specify `PipelineConfig` for an APSYlong resolver. `PipelineConfig` is a property of the AWS::AppSync::Resolver resource.

Link copied to clipboard
data class ResolverSyncConfig(val conflictDetection: String, val conflictHandler: String? = null, val lambdaConflictHandlerConfig: ResolverLambdaConflictHandlerConfig? = null)

Describes a Sync configuration for a resolver. Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.

Link copied to clipboard