We recommend new projects start with resources from the AWS provider.
We recommend new projects start with resources from the AWS provider.
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.
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The SourceApiAssociation resource accepts the following input properties:
- Description string
- Description of the SourceApiAssociation.
- Merged
Api stringIdentifier - Identifier of the Merged GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
- Source
Api Pulumi.Association Config Aws Native. App Sync. Inputs. Source Api Association Config - Customized configuration for SourceApiAssociation.
- Source
Api stringIdentifier - Identifier of the Source GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
- Description string
- Description of the SourceApiAssociation.
- Merged
Api stringIdentifier - Identifier of the Merged GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
- Source
Api SourceAssociation Config Api Association Config Args - Customized configuration for SourceApiAssociation.
- Source
Api stringIdentifier - Identifier of the Source GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
- description String
- Description of the SourceApiAssociation.
- merged
Api StringIdentifier - Identifier of the Merged GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
- source
Api SourceAssociation Config Api Association Config - Customized configuration for SourceApiAssociation.
- source
Api StringIdentifier - Identifier of the Source GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
- description string
- Description of the SourceApiAssociation.
- merged
Api stringIdentifier - Identifier of the Merged GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
- source
Api SourceAssociation Config Api Association Config - Customized configuration for SourceApiAssociation.
- source
Api stringIdentifier - Identifier of the Source GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
- description str
- Description of the SourceApiAssociation.
- merged_
api_ stridentifier - Identifier of the Merged GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
- source_
api_ Sourceassociation_ config Api Association Config Args - Customized configuration for SourceApiAssociation.
- source_
api_ stridentifier - Identifier of the Source GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
- description String
- Description of the SourceApiAssociation.
- merged
Api StringIdentifier - Identifier of the Merged GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
- source
Api Property MapAssociation Config - Customized configuration for SourceApiAssociation.
- source
Api StringIdentifier - 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:
- Association
Arn string - ARN of the SourceApiAssociation.
- Association
Id string - Id of the SourceApiAssociation.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Successful stringMerge Date - Date of last schema successful merge.
- Merged
Api stringArn - ARN of the Merged API in the association.
- Merged
Api stringId - GraphQLApiId of the Merged API in the association.
- Source
Api stringArn - ARN of the source API in the association.
- Source
Api Pulumi.Association Status Aws Native. App Sync. Source Api Association Status - Current status of SourceApiAssociation.
- Source
Api stringAssociation Status Detail - Current SourceApiAssociation status details.
- Source
Api stringId - GraphQLApiId of the source API in the association.
- Association
Arn string - ARN of the SourceApiAssociation.
- Association
Id string - Id of the SourceApiAssociation.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Successful stringMerge Date - Date of last schema successful merge.
- Merged
Api stringArn - ARN of the Merged API in the association.
- Merged
Api stringId - GraphQLApiId of the Merged API in the association.
- Source
Api stringArn - ARN of the source API in the association.
- Source
Api SourceAssociation Status Api Association Status - Current status of SourceApiAssociation.
- Source
Api stringAssociation Status Detail - Current SourceApiAssociation status details.
- Source
Api stringId - GraphQLApiId of the source API in the association.
- association
Arn String - ARN of the SourceApiAssociation.
- association
Id String - Id of the SourceApiAssociation.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Successful StringMerge Date - Date of last schema successful merge.
- merged
Api StringArn - ARN of the Merged API in the association.
- merged
Api StringId - GraphQLApiId of the Merged API in the association.
- source
Api StringArn - ARN of the source API in the association.
- source
Api SourceAssociation Status Api Association Status - Current status of SourceApiAssociation.
- source
Api StringAssociation Status Detail - Current SourceApiAssociation status details.
- source
Api StringId - GraphQLApiId of the source API in the association.
- association
Arn string - ARN of the SourceApiAssociation.
- association
Id string - Id of the SourceApiAssociation.
- id string
- The provider-assigned unique ID for this managed resource.
- last
Successful stringMerge Date - Date of last schema successful merge.
- merged
Api stringArn - ARN of the Merged API in the association.
- merged
Api stringId - GraphQLApiId of the Merged API in the association.
- source
Api stringArn - ARN of the source API in the association.
- source
Api SourceAssociation Status Api Association Status - Current status of SourceApiAssociation.
- source
Api stringAssociation Status Detail - Current SourceApiAssociation status details.
- source
Api stringId - 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_ strmerge_ date - Date of last schema successful merge.
- merged_
api_ strarn - ARN of the Merged API in the association.
- merged_
api_ strid - GraphQLApiId of the Merged API in the association.
- source_
api_ strarn - ARN of the source API in the association.
- source_
api_ Sourceassociation_ status Api Association Status - Current status of SourceApiAssociation.
- source_
api_ strassociation_ status_ detail - Current SourceApiAssociation status details.
- source_
api_ strid - GraphQLApiId of the source API in the association.
- association
Arn String - ARN of the SourceApiAssociation.
- association
Id String - Id of the SourceApiAssociation.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Successful StringMerge Date - Date of last schema successful merge.
- merged
Api StringArn - ARN of the Merged API in the association.
- merged
Api StringId - GraphQLApiId of the Merged API in the association.
- source
Api StringArn - ARN of the source API in the association.
- source
Api "MERGE_SCHEDULED" | "MERGE_FAILED" | "MERGE_SUCCESS" | "MERGE_IN_PROGRESS" | "AUTO_MERGE_SCHEDULE_FAILED" | "DELETION_SCHEDULED" | "DELETION_IN_PROGRESS" | "DELETION_FAILED"Association Status - Current status of SourceApiAssociation.
- source
Api StringAssociation Status Detail - Current SourceApiAssociation status details.
- source
Api StringId - GraphQLApiId of the source API in the association.
Supporting Types
SourceApiAssociationConfig, SourceApiAssociationConfigArgs
- Merge
Type Pulumi.Aws Native. App Sync. Source Api Association Config Merge Type - Configuration of the merged behavior for the association. For example when it could be auto or has to be manual.
- Merge
Type SourceApi Association Config Merge Type - Configuration of the merged behavior for the association. For example when it could be auto or has to be manual.
- merge
Type SourceApi Association Config Merge Type - Configuration of the merged behavior for the association. For example when it could be auto or has to be manual.
- merge
Type SourceApi Association Config Merge Type - Configuration of the merged behavior for the association. For example when it could be auto or has to be manual.
- merge_
type SourceApi Association Config Merge Type - Configuration of the merged behavior for the association. For example when it could be auto or has to be manual.
- merge
Type "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
- Auto
Merge AUTO_MERGE- Manual
Merge MANUAL_MERGE
- Source
Api Association Config Merge Type Auto Merge AUTO_MERGE- Source
Api Association Config Merge Type Manual Merge MANUAL_MERGE
- Auto
Merge AUTO_MERGE- Manual
Merge MANUAL_MERGE
- Auto
Merge AUTO_MERGE- Manual
Merge MANUAL_MERGE
- AUTO_MERGE
AUTO_MERGE- MANUAL_MERGE
MANUAL_MERGE
- "AUTO_MERGE"
AUTO_MERGE- "MANUAL_MERGE"
MANUAL_MERGE
SourceApiAssociationStatus, SourceApiAssociationStatusArgs
- 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
- Source
Api Association Status Merge Scheduled MERGE_SCHEDULED- Source
Api Association Status Merge Failed MERGE_FAILED- Source
Api Association Status Merge Success MERGE_SUCCESS- Source
Api Association Status Merge In Progress MERGE_IN_PROGRESS- Source
Api Association Status Auto Merge Schedule Failed AUTO_MERGE_SCHEDULE_FAILED- Source
Api Association Status Deletion Scheduled DELETION_SCHEDULED- Source
Api Association Status Deletion In Progress DELETION_IN_PROGRESS- Source
Api Association Status 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
- 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
- "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
We recommend new projects start with resources from the AWS provider.
