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

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.getApi

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

    Using getApi

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getApi(args: GetApiArgs, opts?: InvokeOptions): Promise<GetApiResult>
function getApiOutput(args: GetApiOutputArgs, opts?: InvokeOptions): Output<GetApiResult>
    def get_api(api_arn: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetApiResult
def get_api_output(api_arn: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetApiResult]
    func LookupApi(ctx *Context, args *LookupApiArgs, opts ...InvokeOption) (*LookupApiResult, error)
func LookupApiOutput(ctx *Context, args *LookupApiOutputArgs, opts ...InvokeOption) LookupApiResultOutput

    > Note: This function is named LookupApi in the Go SDK.

    public static class GetApi 
{
    public static Task<GetApiResult> InvokeAsync(GetApiArgs args, InvokeOptions? opts = null)
    public static Output<GetApiResult> Invoke(GetApiInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetApiResult> getApi(GetApiArgs args, InvokeOptions options)
public static Output<GetApiResult> getApi(GetApiArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:appsync:getApi
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ApiArn string
    The Amazon Resource Name (ARN) of the AppSync Api
    ApiArn string
    The Amazon Resource Name (ARN) of the AppSync Api
    apiArn String
    The Amazon Resource Name (ARN) of the AppSync Api
    apiArn string
    The Amazon Resource Name (ARN) of the AppSync Api
    api_arn str
    The Amazon Resource Name (ARN) of the AppSync Api
    apiArn String
    The Amazon Resource Name (ARN) of the AppSync Api

    getApi Result

    The following output properties are available:

    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
    EventConfig Pulumi.AwsNative.AppSync.Outputs.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.Outputs.Tag>
    A set of tags (key-value pairs) for this API.
    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
    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.
    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
    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.
    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
    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.
    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
    event_config ApiEventConfig
    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[root_Tag]
    A set of tags (key-value pairs) for this API.
    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
    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.

    Supporting Types

    ApiAuthMode

    ApiAuthProvider

    ApiAuthenticationType

    ApiCognitoConfig

    ApiDnsMap

    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

    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

    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

    ApiLambdaAuthorizerConfig

    ApiOpenIdConnectConfig

    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

    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