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.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.appsync.Api

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 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 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 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 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 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 String
    The unique name of the resource.
    args 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

    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 List<Pulumi.AwsNative.AppSync.Inputs.ApiAuthProvider>
    A list of authorization providers.
    ConnectionAuthModes List<Pulumi.AwsNative.AppSync.Inputs.ApiAuthMode>
    A list of valid authorization modes for the Event API connections.
    DefaultPublishAuthModes List<Pulumi.AwsNative.AppSync.Inputs.ApiAuthMode>
    A list of valid authorization modes for the Event API publishing.
    DefaultSubscribeAuthModes 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 []ApiAuthProvider
    A list of authorization providers.
    ConnectionAuthModes []ApiAuthMode
    A list of valid authorization modes for the Event API connections.
    DefaultPublishAuthModes []ApiAuthMode
    A list of valid authorization modes for the Event API publishing.
    DefaultSubscribeAuthModes []ApiAuthMode
    A list of valid authorization modes for the Event API subscriptions.
    LogConfig ApiEventLogConfig
    The CloudWatch Logs configuration for the Event API.
    authProviders List<ApiAuthProvider>
    A list of authorization providers.
    connectionAuthModes List<ApiAuthMode>
    A list of valid authorization modes for the Event API connections.
    defaultPublishAuthModes List<ApiAuthMode>
    A list of valid authorization modes for the Event API publishing.
    defaultSubscribeAuthModes List<ApiAuthMode>
    A list of valid authorization modes for the Event API subscriptions.
    logConfig ApiEventLogConfig
    The CloudWatch Logs configuration for the Event API.
    authProviders ApiAuthProvider[]
    A list of authorization providers.
    connectionAuthModes ApiAuthMode[]
    A list of valid authorization modes for the Event API connections.
    defaultPublishAuthModes ApiAuthMode[]
    A list of valid authorization modes for the Event API publishing.
    defaultSubscribeAuthModes ApiAuthMode[]
    A list of valid authorization modes for the Event API subscriptions.
    logConfig ApiEventLogConfig
    The CloudWatch Logs configuration for the Event API.
    auth_providers Sequence[ApiAuthProvider]
    A list of authorization providers.
    connection_auth_modes Sequence[ApiAuthMode]
    A list of valid authorization modes for the Event API connections.
    default_publish_auth_modes Sequence[ApiAuthMode]
    A list of valid authorization modes for the Event API publishing.
    default_subscribe_auth_modes 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 List<Property Map>
    A list of authorization providers.
    connectionAuthModes List<Property Map>
    A list of valid authorization modes for the Event API connections.
    defaultPublishAuthModes List<Property Map>
    A list of valid authorization modes for the Event API publishing.
    defaultSubscribeAuthModes 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 string
    The IAM service role that AWS AppSync assumes to publish CloudWatch Logs in your account.
    LogLevel Pulumi.AwsNative.AppSync.ApiEventLogLevel
    The type of information to log for the Event API.
    CloudWatchLogsRoleArn string
    The IAM service role that AWS AppSync assumes to publish CloudWatch Logs in your account.
    LogLevel ApiEventLogLevel
    The type of information to log for the Event API.
    cloudWatchLogsRoleArn String
    The IAM service role that AWS AppSync assumes to publish CloudWatch Logs in your account.
    logLevel ApiEventLogLevel
    The type of information to log for the Event API.
    cloudWatchLogsRoleArn string
    The IAM service role that AWS AppSync assumes to publish CloudWatch Logs in your account.
    logLevel ApiEventLogLevel
    The type of information to log for the Event API.
    cloud_watch_logs_role_arn str
    The IAM service role that AWS AppSync assumes to publish CloudWatch Logs in your account.
    log_level ApiEventLogLevel
    The type of information to log for the Event API.
    cloudWatchLogsRoleArn String
    The IAM service role that AWS AppSync assumes to publish CloudWatch Logs in your account.
    logLevel "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

    ApiOpenIdConnectConfig, ApiOpenIdConnectConfigArgs

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

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

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

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native