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.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.appsync.getApi

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

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>
Copy
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]
Copy
func LookupApi(ctx *Context, args *LookupApiArgs, opts ...InvokeOption) (*LookupApiResult, error)
func LookupApiOutput(ctx *Context, args *LookupApiOutputArgs, opts ...InvokeOption) LookupApiResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetApiResult> getApi(GetApiArgs args, InvokeOptions options)
public static Output<GetApiResult> getApi(GetApiArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:appsync:getApi
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ApiArn This property is required. string
The Amazon Resource Name (ARN) of the AppSync Api
ApiArn This property is required. string
The Amazon Resource Name (ARN) of the AppSync Api
apiArn This property is required. String
The Amazon Resource Name (ARN) of the AppSync Api
apiArn This property is required. string
The Amazon Resource Name (ARN) of the AppSync Api
api_arn This property is required. str
The Amazon Resource Name (ARN) of the AppSync Api
apiArn This property is required. 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

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

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

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

ApiLambdaAuthorizerConfig

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

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

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