Package software.amazon.awscdk.services.appsync

Interface HttpDataSourceProps

All Superinterfaces:

BaseDataSourceProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HttpDataSourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:02.926Z")
@Stability(Stable)
public interface HttpDataSourceProps
extends software.amazon.jsii.JsiiSerializable, BaseDataSourceProps

Properties for an AppSync http datasource.

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.*;
 GraphqlApi graphqlApi;
 HttpDataSourceProps httpDataSourceProps = HttpDataSourceProps.builder()
         .api(graphqlApi)
         .endpoint("endpoint")
         // the properties below are optional
         .authorizationConfig(AwsIamConfig.builder()
                 .signingRegion("signingRegion")
                 .signingServiceName("signingServiceName")
                 .build())
         .description("description")
         .name("name")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static HttpDataSourceProps.Builder	builder()
default AwsIamConfig	getAuthorizationConfig()	The authorization config in case the HTTP endpoint requires authorization.
String	getEndpoint()	The http endpoint.

Methods inherited from interface software.amazon.awscdk.services.appsync.BaseDataSourceProps

getApi, getDescription, getName

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEndpoint

@Stability(Stable)
@NotNull
String getEndpoint()

The http endpoint.

getAuthorizationConfig

@Stability(Stable)
@Nullable
default AwsIamConfig getAuthorizationConfig()

The authorization config in case the HTTP endpoint requires authorization.

Default: - none

builder

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

Returns:

a HttpDataSourceProps.Builder of HttpDataSourceProps