SourceApiAssociation class

Resource for managing an AWS AppSync Source API Association.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.appsync.SourceApiAssociation("test", {
    description: "My source API Merged",
    mergedApiId: "gzos6bteufdunffzzifiowisoe",
    sourceApiId: "fzzifiowisoegzos6bteufdunf",
});
import pulumi
import pulumi_aws as aws

test = aws.appsync.SourceApiAssociation("test",
    description="My source API Merged",
    merged_api_id="gzos6bteufdunffzzifiowisoe",
    source_api_id="fzzifiowisoegzos6bteufdunf")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var test = new Aws.AppSync.SourceApiAssociation("test", new()
    {
        Description = "My source API Merged",
        MergedApiId = "gzos6bteufdunffzzifiowisoe",
        SourceApiId = "fzzifiowisoegzos6bteufdunf",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/appsync"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := appsync.NewSourceApiAssociation(ctx, "test", &appsync.SourceApiAssociationArgs{
			Description: pulumi.String("My source API Merged"),
			MergedApiId: pulumi.String("gzos6bteufdunffzzifiowisoe"),
			SourceApiId: pulumi.String("fzzifiowisoegzos6bteufdunf"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_appsync_sourceapiassociation" "test" {
  description   = "My source API Merged"
  merged_api_id = "gzos6bteufdunffzzifiowisoe"
  source_api_id = "fzzifiowisoegzos6bteufdunf"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.appsync.SourceApiAssociation;
import com.pulumi.aws.appsync.SourceApiAssociationArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new SourceApiAssociation("test", SourceApiAssociationArgs.builder()
            .description("My source API Merged")
            .mergedApiId("gzos6bteufdunffzzifiowisoe")
            .sourceApiId("fzzifiowisoegzos6bteufdunf")
            .build());

    }
}
resources:
  test:
    type: aws:appsync:SourceApiAssociation
    properties:
      description: My source API Merged
      mergedApiId: gzos6bteufdunffzzifiowisoe
      sourceApiId: fzzifiowisoegzos6bteufdunf

Import

Using pulumi import, import AppSync Source API Association using the associationId and mergedApiId separated by ,. For example:

$ pulumi import aws:appsync/sourceApiAssociation:SourceApiAssociation example gzos6bteufdunffzzifiowisoe,243685a0-9347-4a1a-89c1-9b57dea01e31

Constructors

SourceApiAssociation(String name, {SourceApiAssociationArgs? args, CustomResourceOptions? options})
Creates a new SourceApiAssociation. name The Pulumi resource name. args Arguments used to configure this SourceApiAssociation. The set of arguments for SourceApiAssociation. options Resource options controlling this resource's behavior.
SourceApiAssociation.reference(String urn)
Creates a typed reference to an existing SourceApiAssociation resource.

Properties

arn ↔ Output<String>
ARN of the Source API Association.
latefinal
associationId ↔ Output<String>
ID of the Source API Association.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
description ↔ Output<String?>
Description of the source API being merged.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
mergedApiArn ↔ Output<String>
ARN of the merged API. One of mergedApiArn or mergedApiId must be specified.
latefinal
mergedApiId ↔ Output<String>
ID of the merged API. One of mergedApiArn or mergedApiId must be specified.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sourceApiArn ↔ Output<String>
ARN of the source API. One of sourceApiArn or sourceApiId must be specified.
latefinal
sourceApiAssociationConfigs ↔ Output<List<SourceApiAssociationSourceApiAssociationConfig>>
Source API Association configuration. See sourceApiAssociationConfig Block for details.
latefinal
sourceApiId ↔ Output<String>
ID of the source API. One of sourceApiArn or sourceApiId must be specified.
latefinal
timeouts ↔ Output<SourceApiAssociationTimeouts?>
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {SourceApiAssociationState? state, CustomResourceOptions? options}) → SourceApiAssociation
Gets an existing SourceApiAssociation resource's state with the given name and id.