Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. appsync
  5. SourceApiAssociation

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.appsync.SourceApiAssociation

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::AppSync::SourceApiAssociation

    Create SourceApiAssociation Resource

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

    Constructor syntax

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

@overload
def SourceApiAssociation(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         description: Optional[str] = None,
                         merged_api_identifier: Optional[str] = None,
                         source_api_association_config: Optional[SourceApiAssociationConfigArgs] = None,
                         source_api_identifier: Optional[str] = None)
    func NewSourceApiAssociation(ctx *Context, name string, args *SourceApiAssociationArgs, opts ...ResourceOption) (*SourceApiAssociation, error)
    public SourceApiAssociation(string name, SourceApiAssociationArgs? args = null, CustomResourceOptions? opts = null)
    public SourceApiAssociation(String name, SourceApiAssociationArgs args)
public SourceApiAssociation(String name, SourceApiAssociationArgs args, CustomResourceOptions options)

    type: aws-native:appsync:SourceApiAssociation
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 SourceApiAssociationArgs
    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 SourceApiAssociationArgs
    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 SourceApiAssociationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SourceApiAssociationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SourceApiAssociationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    const sourceApiAssociationResource = new aws_native.appsync.SourceApiAssociation("sourceApiAssociationResource", {
    description: "string",
    mergedApiIdentifier: "string",
    sourceApiAssociationConfig: {
        mergeType: aws_native.appsync.SourceApiAssociationConfigMergeType.AutoMerge,
    },
    sourceApiIdentifier: "string",
});

    Coming soon!

    SourceApiAssociation Resource Properties

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

    Inputs

    The SourceApiAssociation resource accepts the following input properties:

    Description string
    Description of the SourceApiAssociation.
    MergedApiIdentifier string
    Identifier of the Merged GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
    SourceApiAssociationConfig Pulumi.AwsNative.AppSync.Inputs.SourceApiAssociationConfig
    Customized configuration for SourceApiAssociation.
    SourceApiIdentifier string
    Identifier of the Source GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
    Description string
    Description of the SourceApiAssociation.
    MergedApiIdentifier string
    Identifier of the Merged GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
    SourceApiAssociationConfig SourceApiAssociationConfigArgs
    Customized configuration for SourceApiAssociation.
    SourceApiIdentifier string
    Identifier of the Source GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
    description String
    Description of the SourceApiAssociation.
    mergedApiIdentifier String
    Identifier of the Merged GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
    sourceApiAssociationConfig SourceApiAssociationConfig
    Customized configuration for SourceApiAssociation.
    sourceApiIdentifier String
    Identifier of the Source GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
    description string
    Description of the SourceApiAssociation.
    mergedApiIdentifier string
    Identifier of the Merged GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
    sourceApiAssociationConfig SourceApiAssociationConfig
    Customized configuration for SourceApiAssociation.
    sourceApiIdentifier string
    Identifier of the Source GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
    description str
    Description of the SourceApiAssociation.
    merged_api_identifier str
    Identifier of the Merged GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
    source_api_association_config SourceApiAssociationConfigArgs
    Customized configuration for SourceApiAssociation.
    source_api_identifier str
    Identifier of the Source GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
    description String
    Description of the SourceApiAssociation.
    mergedApiIdentifier String
    Identifier of the Merged GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
    sourceApiAssociationConfig Property Map
    Customized configuration for SourceApiAssociation.
    sourceApiIdentifier String
    Identifier of the Source GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN

    Outputs

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

    AssociationArn string
    ARN of the SourceApiAssociation.
    AssociationId string
    Id of the SourceApiAssociation.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastSuccessfulMergeDate string
    Date of last schema successful merge.
    MergedApiArn string
    ARN of the Merged API in the association.
    MergedApiId string
    GraphQLApiId of the Merged API in the association.
    SourceApiArn string
    ARN of the source API in the association.
    SourceApiAssociationStatus Pulumi.AwsNative.AppSync.SourceApiAssociationStatus
    Current status of SourceApiAssociation.
    SourceApiAssociationStatusDetail string
    Current SourceApiAssociation status details.
    SourceApiId string
    GraphQLApiId of the source API in the association.
    AssociationArn string
    ARN of the SourceApiAssociation.
    AssociationId string
    Id of the SourceApiAssociation.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastSuccessfulMergeDate string
    Date of last schema successful merge.
    MergedApiArn string
    ARN of the Merged API in the association.
    MergedApiId string
    GraphQLApiId of the Merged API in the association.
    SourceApiArn string
    ARN of the source API in the association.
    SourceApiAssociationStatus SourceApiAssociationStatus
    Current status of SourceApiAssociation.
    SourceApiAssociationStatusDetail string
    Current SourceApiAssociation status details.
    SourceApiId string
    GraphQLApiId of the source API in the association.
    associationArn String
    ARN of the SourceApiAssociation.
    associationId String
    Id of the SourceApiAssociation.
    id String
    The provider-assigned unique ID for this managed resource.
    lastSuccessfulMergeDate String
    Date of last schema successful merge.
    mergedApiArn String
    ARN of the Merged API in the association.
    mergedApiId String
    GraphQLApiId of the Merged API in the association.
    sourceApiArn String
    ARN of the source API in the association.
    sourceApiAssociationStatus SourceApiAssociationStatus
    Current status of SourceApiAssociation.
    sourceApiAssociationStatusDetail String
    Current SourceApiAssociation status details.
    sourceApiId String
    GraphQLApiId of the source API in the association.
    associationArn string
    ARN of the SourceApiAssociation.
    associationId string
    Id of the SourceApiAssociation.
    id string
    The provider-assigned unique ID for this managed resource.
    lastSuccessfulMergeDate string
    Date of last schema successful merge.
    mergedApiArn string
    ARN of the Merged API in the association.
    mergedApiId string
    GraphQLApiId of the Merged API in the association.
    sourceApiArn string
    ARN of the source API in the association.
    sourceApiAssociationStatus SourceApiAssociationStatus
    Current status of SourceApiAssociation.
    sourceApiAssociationStatusDetail string
    Current SourceApiAssociation status details.
    sourceApiId string
    GraphQLApiId of the source API in the association.
    association_arn str
    ARN of the SourceApiAssociation.
    association_id str
    Id of the SourceApiAssociation.
    id str
    The provider-assigned unique ID for this managed resource.
    last_successful_merge_date str
    Date of last schema successful merge.
    merged_api_arn str
    ARN of the Merged API in the association.
    merged_api_id str
    GraphQLApiId of the Merged API in the association.
    source_api_arn str
    ARN of the source API in the association.
    source_api_association_status SourceApiAssociationStatus
    Current status of SourceApiAssociation.
    source_api_association_status_detail str
    Current SourceApiAssociation status details.
    source_api_id str
    GraphQLApiId of the source API in the association.
    associationArn String
    ARN of the SourceApiAssociation.
    associationId String
    Id of the SourceApiAssociation.
    id String
    The provider-assigned unique ID for this managed resource.
    lastSuccessfulMergeDate String
    Date of last schema successful merge.
    mergedApiArn String
    ARN of the Merged API in the association.
    mergedApiId String
    GraphQLApiId of the Merged API in the association.
    sourceApiArn String
    ARN of the source API in the association.
    sourceApiAssociationStatus "MERGE_SCHEDULED" | "MERGE_FAILED" | "MERGE_SUCCESS" | "MERGE_IN_PROGRESS" | "AUTO_MERGE_SCHEDULE_FAILED" | "DELETION_SCHEDULED" | "DELETION_IN_PROGRESS" | "DELETION_FAILED"
    Current status of SourceApiAssociation.
    sourceApiAssociationStatusDetail String
    Current SourceApiAssociation status details.
    sourceApiId String
    GraphQLApiId of the source API in the association.

    Supporting Types

    SourceApiAssociationConfig, SourceApiAssociationConfigArgs

    MergeType Pulumi.AwsNative.AppSync.SourceApiAssociationConfigMergeType
    Configuration of the merged behavior for the association. For example when it could be auto or has to be manual.
    MergeType SourceApiAssociationConfigMergeType
    Configuration of the merged behavior for the association. For example when it could be auto or has to be manual.
    mergeType SourceApiAssociationConfigMergeType
    Configuration of the merged behavior for the association. For example when it could be auto or has to be manual.
    mergeType SourceApiAssociationConfigMergeType
    Configuration of the merged behavior for the association. For example when it could be auto or has to be manual.
    merge_type SourceApiAssociationConfigMergeType
    Configuration of the merged behavior for the association. For example when it could be auto or has to be manual.
    mergeType "AUTO_MERGE" | "MANUAL_MERGE"
    Configuration of the merged behavior for the association. For example when it could be auto or has to be manual.

    SourceApiAssociationConfigMergeType, SourceApiAssociationConfigMergeTypeArgs

    AutoMerge
    AUTO_MERGE
    ManualMerge
    MANUAL_MERGE
    SourceApiAssociationConfigMergeTypeAutoMerge
    AUTO_MERGE
    SourceApiAssociationConfigMergeTypeManualMerge
    MANUAL_MERGE
    AutoMerge
    AUTO_MERGE
    ManualMerge
    MANUAL_MERGE
    AutoMerge
    AUTO_MERGE
    ManualMerge
    MANUAL_MERGE
    AUTO_MERGE
    AUTO_MERGE
    MANUAL_MERGE
    MANUAL_MERGE
    "AUTO_MERGE"
    AUTO_MERGE
    "MANUAL_MERGE"
    MANUAL_MERGE

    SourceApiAssociationStatus, SourceApiAssociationStatusArgs

    MergeScheduled
    MERGE_SCHEDULED
    MergeFailed
    MERGE_FAILED
    MergeSuccess
    MERGE_SUCCESS
    MergeInProgress
    MERGE_IN_PROGRESS
    AutoMergeScheduleFailed
    AUTO_MERGE_SCHEDULE_FAILED
    DeletionScheduled
    DELETION_SCHEDULED
    DeletionInProgress
    DELETION_IN_PROGRESS
    DeletionFailed
    DELETION_FAILED
    SourceApiAssociationStatusMergeScheduled
    MERGE_SCHEDULED
    SourceApiAssociationStatusMergeFailed
    MERGE_FAILED
    SourceApiAssociationStatusMergeSuccess
    MERGE_SUCCESS
    SourceApiAssociationStatusMergeInProgress
    MERGE_IN_PROGRESS
    SourceApiAssociationStatusAutoMergeScheduleFailed
    AUTO_MERGE_SCHEDULE_FAILED
    SourceApiAssociationStatusDeletionScheduled
    DELETION_SCHEDULED
    SourceApiAssociationStatusDeletionInProgress
    DELETION_IN_PROGRESS
    SourceApiAssociationStatusDeletionFailed
    DELETION_FAILED
    MergeScheduled
    MERGE_SCHEDULED
    MergeFailed
    MERGE_FAILED
    MergeSuccess
    MERGE_SUCCESS
    MergeInProgress
    MERGE_IN_PROGRESS
    AutoMergeScheduleFailed
    AUTO_MERGE_SCHEDULE_FAILED
    DeletionScheduled
    DELETION_SCHEDULED
    DeletionInProgress
    DELETION_IN_PROGRESS
    DeletionFailed
    DELETION_FAILED
    MergeScheduled
    MERGE_SCHEDULED
    MergeFailed
    MERGE_FAILED
    MergeSuccess
    MERGE_SUCCESS
    MergeInProgress
    MERGE_IN_PROGRESS
    AutoMergeScheduleFailed
    AUTO_MERGE_SCHEDULE_FAILED
    DeletionScheduled
    DELETION_SCHEDULED
    DeletionInProgress
    DELETION_IN_PROGRESS
    DeletionFailed
    DELETION_FAILED
    MERGE_SCHEDULED
    MERGE_SCHEDULED
    MERGE_FAILED
    MERGE_FAILED
    MERGE_SUCCESS
    MERGE_SUCCESS
    MERGE_IN_PROGRESS
    MERGE_IN_PROGRESS
    AUTO_MERGE_SCHEDULE_FAILED
    AUTO_MERGE_SCHEDULE_FAILED
    DELETION_SCHEDULED
    DELETION_SCHEDULED
    DELETION_IN_PROGRESS
    DELETION_IN_PROGRESS
    DELETION_FAILED
    DELETION_FAILED
    "MERGE_SCHEDULED"
    MERGE_SCHEDULED
    "MERGE_FAILED"
    MERGE_FAILED
    "MERGE_SUCCESS"
    MERGE_SUCCESS
    "MERGE_IN_PROGRESS"
    MERGE_IN_PROGRESS
    "AUTO_MERGE_SCHEDULE_FAILED"
    AUTO_MERGE_SCHEDULE_FAILED
    "DELETION_SCHEDULED"
    DELETION_SCHEDULED
    "DELETION_IN_PROGRESS"
    DELETION_IN_PROGRESS
    "DELETION_FAILED"
    DELETION_FAILED

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
    pulumi/pulumi-aws-native