Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. appsync
  5. Api

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.appsync.Api

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource schema for AppSync Api

Create Api Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Api(name: string, args?: ApiArgs, opts?: CustomResourceOptions);
@overload
def Api(resource_name: str,
        args: Optional[ApiArgs] = None,
        opts: Optional[ResourceOptions] = None)

@overload
def Api(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        event_config: Optional[ApiEventConfigArgs] = None,
        name: Optional[str] = None,
        owner_contact: Optional[str] = None,
        tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewApi(ctx *Context, name string, args *ApiArgs, opts ...ResourceOption) (*Api, error)
public Api(string name, ApiArgs? args = null, CustomResourceOptions? opts = null)
public Api(String name, ApiArgs args)
public Api(String name, ApiArgs args, CustomResourceOptions options)

type: aws-native:appsync:Api
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args ApiArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args ApiArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args ApiArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args ApiArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ApiArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Api Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Api resource accepts the following input properties:

EventConfig Pulumi.AwsNative.AppSync.Inputs.ApiEventConfig
Describes the authorization configuration for connections, message publishing, message subscriptions, and logging for an Event API.
Name string
The name of the Api .
OwnerContact string

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

Tags List<Pulumi.AwsNative.Inputs.Tag>
A set of tags (key-value pairs) for this API.
EventConfig ApiEventConfigArgs
Describes the authorization configuration for connections, message publishing, message subscriptions, and logging for an Event API.
Name string
The name of the Api .
OwnerContact string

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

Tags TagArgs
A set of tags (key-value pairs) for this API.
eventConfig ApiEventConfig
Describes the authorization configuration for connections, message publishing, message subscriptions, and logging for an Event API.
name String
The name of the Api .
ownerContact String

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

tags List<Tag>
A set of tags (key-value pairs) for this API.
eventConfig ApiEventConfig
Describes the authorization configuration for connections, message publishing, message subscriptions, and logging for an Event API.
name string
The name of the Api .
ownerContact string

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

tags Tag[]
A set of tags (key-value pairs) for this API.
event_config ApiEventConfigArgs
Describes the authorization configuration for connections, message publishing, message subscriptions, and logging for an Event API.
name str
The name of the Api .
owner_contact str

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

tags Sequence[TagArgs]
A set of tags (key-value pairs) for this API.
eventConfig Property Map
Describes the authorization configuration for connections, message publishing, message subscriptions, and logging for an Event API.
name String
The name of the Api .
ownerContact String

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

tags List<Property Map>
A set of tags (key-value pairs) for this API.

Outputs

All input properties are implicitly available as output properties. Additionally, the Api resource produces the following output properties:

ApiArn string
The Amazon Resource Name (ARN) of the AppSync Api
ApiId string
The unique identifier for the AppSync Api generated by the service
Dns Pulumi.AwsNative.AppSync.Outputs.ApiDnsMap
Id string
The provider-assigned unique ID for this managed resource.
ApiArn string
The Amazon Resource Name (ARN) of the AppSync Api
ApiId string
The unique identifier for the AppSync Api generated by the service
Dns ApiDnsMap
Id string
The provider-assigned unique ID for this managed resource.
apiArn String
The Amazon Resource Name (ARN) of the AppSync Api
apiId String
The unique identifier for the AppSync Api generated by the service
dns ApiDnsMap
id String
The provider-assigned unique ID for this managed resource.
apiArn string
The Amazon Resource Name (ARN) of the AppSync Api
apiId string
The unique identifier for the AppSync Api generated by the service
dns ApiDnsMap
id string
The provider-assigned unique ID for this managed resource.
api_arn str
The Amazon Resource Name (ARN) of the AppSync Api
api_id str
The unique identifier for the AppSync Api generated by the service
dns ApiDnsMap
id str
The provider-assigned unique ID for this managed resource.
apiArn String
The Amazon Resource Name (ARN) of the AppSync Api
apiId String
The unique identifier for the AppSync Api generated by the service
dns Property Map
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

ApiAuthMode
, ApiAuthModeArgs

ApiAuthProvider
, ApiAuthProviderArgs

ApiAuthenticationType
, ApiAuthenticationTypeArgs

AmazonCognitoUserPools
AMAZON_COGNITO_USER_POOLS
AwsIam
AWS_IAM
ApiKey
API_KEY
OpenidConnect
OPENID_CONNECT
AwsLambda
AWS_LAMBDA
ApiAuthenticationTypeAmazonCognitoUserPools
AMAZON_COGNITO_USER_POOLS
ApiAuthenticationTypeAwsIam
AWS_IAM
ApiAuthenticationTypeApiKey
API_KEY
ApiAuthenticationTypeOpenidConnect
OPENID_CONNECT
ApiAuthenticationTypeAwsLambda
AWS_LAMBDA
AmazonCognitoUserPools
AMAZON_COGNITO_USER_POOLS
AwsIam
AWS_IAM
ApiKey
API_KEY
OpenidConnect
OPENID_CONNECT
AwsLambda
AWS_LAMBDA
AmazonCognitoUserPools
AMAZON_COGNITO_USER_POOLS
AwsIam
AWS_IAM
ApiKey
API_KEY
OpenidConnect
OPENID_CONNECT
AwsLambda
AWS_LAMBDA
AMAZON_COGNITO_USER_POOLS
AMAZON_COGNITO_USER_POOLS
AWS_IAM
AWS_IAM
API_KEY
API_KEY
OPENID_CONNECT
OPENID_CONNECT
AWS_LAMBDA
AWS_LAMBDA
"AMAZON_COGNITO_USER_POOLS"
AMAZON_COGNITO_USER_POOLS
"AWS_IAM"
AWS_IAM
"API_KEY"
API_KEY
"OPENID_CONNECT"
OPENID_CONNECT
"AWS_LAMBDA"
AWS_LAMBDA

ApiCognitoConfig
, ApiCognitoConfigArgs

AwsRegion This property is required. string
UserPoolId This property is required. string
AppIdClientRegex string
AwsRegion This property is required. string
UserPoolId This property is required. string
AppIdClientRegex string
awsRegion This property is required. String
userPoolId This property is required. String
appIdClientRegex String
awsRegion This property is required. string
userPoolId This property is required. string
appIdClientRegex string
aws_region This property is required. str
user_pool_id This property is required. str
app_id_client_regex str
awsRegion This property is required. String
userPoolId This property is required. String
appIdClientRegex String

ApiDnsMap
, ApiDnsMapArgs

Http string
The domain name of the Api's HTTP endpoint.
Realtime string
The domain name of the Api's real-time endpoint.
Http string
The domain name of the Api's HTTP endpoint.
Realtime string
The domain name of the Api's real-time endpoint.
http String
The domain name of the Api's HTTP endpoint.
realtime String
The domain name of the Api's real-time endpoint.
http string
The domain name of the Api's HTTP endpoint.
realtime string
The domain name of the Api's real-time endpoint.
http str
The domain name of the Api's HTTP endpoint.
realtime str
The domain name of the Api's real-time endpoint.
http String
The domain name of the Api's HTTP endpoint.
realtime String
The domain name of the Api's real-time endpoint.

ApiEventConfig
, ApiEventConfigArgs

AuthProviders This property is required. List<Pulumi.AwsNative.AppSync.Inputs.ApiAuthProvider>
A list of authorization providers.
ConnectionAuthModes This property is required. List<Pulumi.AwsNative.AppSync.Inputs.ApiAuthMode>
A list of valid authorization modes for the Event API connections.
DefaultPublishAuthModes This property is required. List<Pulumi.AwsNative.AppSync.Inputs.ApiAuthMode>
A list of valid authorization modes for the Event API publishing.
DefaultSubscribeAuthModes This property is required. List<Pulumi.AwsNative.AppSync.Inputs.ApiAuthMode>
A list of valid authorization modes for the Event API subscriptions.
LogConfig Pulumi.AwsNative.AppSync.Inputs.ApiEventLogConfig
The CloudWatch Logs configuration for the Event API.
AuthProviders This property is required. []ApiAuthProvider
A list of authorization providers.
ConnectionAuthModes This property is required. []ApiAuthMode
A list of valid authorization modes for the Event API connections.
DefaultPublishAuthModes This property is required. []ApiAuthMode
A list of valid authorization modes for the Event API publishing.
DefaultSubscribeAuthModes This property is required. []ApiAuthMode
A list of valid authorization modes for the Event API subscriptions.
LogConfig ApiEventLogConfig
The CloudWatch Logs configuration for the Event API.
authProviders This property is required. List<ApiAuthProvider>
A list of authorization providers.
connectionAuthModes This property is required. List<ApiAuthMode>
A list of valid authorization modes for the Event API connections.
defaultPublishAuthModes This property is required. List<ApiAuthMode>
A list of valid authorization modes for the Event API publishing.
defaultSubscribeAuthModes This property is required. List<ApiAuthMode>
A list of valid authorization modes for the Event API subscriptions.
logConfig ApiEventLogConfig
The CloudWatch Logs configuration for the Event API.
authProviders This property is required. ApiAuthProvider[]
A list of authorization providers.
connectionAuthModes This property is required. ApiAuthMode[]
A list of valid authorization modes for the Event API connections.
defaultPublishAuthModes This property is required. ApiAuthMode[]
A list of valid authorization modes for the Event API publishing.
defaultSubscribeAuthModes This property is required. ApiAuthMode[]
A list of valid authorization modes for the Event API subscriptions.
logConfig ApiEventLogConfig
The CloudWatch Logs configuration for the Event API.
auth_providers This property is required. Sequence[ApiAuthProvider]
A list of authorization providers.
connection_auth_modes This property is required. Sequence[ApiAuthMode]
A list of valid authorization modes for the Event API connections.
default_publish_auth_modes This property is required. Sequence[ApiAuthMode]
A list of valid authorization modes for the Event API publishing.
default_subscribe_auth_modes This property is required. Sequence[ApiAuthMode]
A list of valid authorization modes for the Event API subscriptions.
log_config ApiEventLogConfig
The CloudWatch Logs configuration for the Event API.
authProviders This property is required. List<Property Map>
A list of authorization providers.
connectionAuthModes This property is required. List<Property Map>
A list of valid authorization modes for the Event API connections.
defaultPublishAuthModes This property is required. List<Property Map>
A list of valid authorization modes for the Event API publishing.
defaultSubscribeAuthModes This property is required. List<Property Map>
A list of valid authorization modes for the Event API subscriptions.
logConfig Property Map
The CloudWatch Logs configuration for the Event API.

ApiEventLogConfig
, ApiEventLogConfigArgs

CloudWatchLogsRoleArn This property is required. string
The IAM service role that AWS AppSync assumes to publish CloudWatch Logs in your account.
LogLevel This property is required. Pulumi.AwsNative.AppSync.ApiEventLogLevel
The type of information to log for the Event API.
CloudWatchLogsRoleArn This property is required. string
The IAM service role that AWS AppSync assumes to publish CloudWatch Logs in your account.
LogLevel This property is required. ApiEventLogLevel
The type of information to log for the Event API.
cloudWatchLogsRoleArn This property is required. String
The IAM service role that AWS AppSync assumes to publish CloudWatch Logs in your account.
logLevel This property is required. ApiEventLogLevel
The type of information to log for the Event API.
cloudWatchLogsRoleArn This property is required. string
The IAM service role that AWS AppSync assumes to publish CloudWatch Logs in your account.
logLevel This property is required. ApiEventLogLevel
The type of information to log for the Event API.
cloud_watch_logs_role_arn This property is required. str
The IAM service role that AWS AppSync assumes to publish CloudWatch Logs in your account.
log_level This property is required. ApiEventLogLevel
The type of information to log for the Event API.
cloudWatchLogsRoleArn This property is required. String
The IAM service role that AWS AppSync assumes to publish CloudWatch Logs in your account.
logLevel This property is required. "NONE" | "ERROR" | "ALL" | "INFO" | "DEBUG"
The type of information to log for the Event API.

ApiEventLogLevel
, ApiEventLogLevelArgs

None
NONE
Error
ERROR
All
ALL
Info
INFO
Debug
DEBUG
ApiEventLogLevelNone
NONE
ApiEventLogLevelError
ERROR
ApiEventLogLevelAll
ALL
ApiEventLogLevelInfo
INFO
ApiEventLogLevelDebug
DEBUG
None
NONE
Error
ERROR
All
ALL
Info
INFO
Debug
DEBUG
None
NONE
Error
ERROR
All
ALL
Info
INFO
Debug
DEBUG
NONE
NONE
ERROR
ERROR
ALL
ALL
INFO
INFO
DEBUG
DEBUG
"NONE"
NONE
"ERROR"
ERROR
"ALL"
ALL
"INFO"
INFO
"DEBUG"
DEBUG

ApiLambdaAuthorizerConfig
, ApiLambdaAuthorizerConfigArgs

authorizerUri This property is required. String
authorizerResultTtlInSeconds Integer
identityValidationExpression String
authorizerUri This property is required. string
authorizerResultTtlInSeconds number
identityValidationExpression string
authorizerUri This property is required. String
authorizerResultTtlInSeconds Number
identityValidationExpression String

ApiOpenIdConnectConfig
, ApiOpenIdConnectConfigArgs

Issuer This property is required. string
AuthTtl double
ClientId string
IatTtl double
Issuer This property is required. string
AuthTtl float64
ClientId string
IatTtl float64
issuer This property is required. String
authTtl Double
clientId String
iatTtl Double
issuer This property is required. string
authTtl number
clientId string
iatTtl number
issuer This property is required. str
auth_ttl float
client_id str
iat_ttl float
issuer This property is required. String
authTtl Number
clientId String
iatTtl Number

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native