Package software.amazon.awscdk.services.appsync

Interface AwsIamConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AwsIamConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:49.364Z")
@Stability(Experimental)
public interface AwsIamConfig
extends software.amazon.jsii.JsiiSerializable

(experimental) The authorization config in case the HTTP endpoint requires authorization.

Example:

 GraphqlApi api = GraphqlApi.Builder.create(this, "api")
         .name("api")
         .schema(Schema.fromAsset(join(__dirname, "schema.graphql")))
         .build();
 HttpDataSource httpDs = api.addHttpDataSource("ds", "https://states.amazonaws.com", HttpDataSourceOptions.builder()
         .name("httpDsWithStepF")
         .description("from appsync to StepFunctions Workflow")
         .authorizationConfig(AwsIamConfig.builder()
                 .signingRegion("us-east-1")
                 .signingServiceName("states")
                 .build())
         .build());
 httpDs.createResolver(BaseResolverProps.builder()
         .typeName("Mutation")
         .fieldName("callStepFunction")
         .requestMappingTemplate(MappingTemplate.fromFile("request.vtl"))
         .responseMappingTemplate(MappingTemplate.fromFile("response.vtl"))
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static AwsIamConfig.Builder	builder()
String	getSigningRegion()	(experimental) The signing region for AWS IAM authorization.
String	getSigningServiceName()	(experimental) The signing service name for AWS IAM authorization.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSigningRegion

@Stability(Experimental)
@NotNull
String getSigningRegion()

(experimental) The signing region for AWS IAM authorization.

getSigningServiceName

@Stability(Experimental)
@NotNull
String getSigningServiceName()

(experimental) The signing service name for AWS IAM authorization.

builder

@Stability(Experimental)
static AwsIamConfig.Builder builder()

Returns:

a AwsIamConfig.Builder of AwsIamConfig