CfnSourceApiAssociationProps

class aws_cdk.aws_appsync.CfnSourceApiAssociationProps(*, description=None, merged_api_identifier=None, source_api_association_config=None, source_api_identifier=None)

Bases: object

Properties for defining a CfnSourceApiAssociation.

Parameters:

  • description (Optional[str]) – The description field of the association configuration.

  • merged_api_identifier (Optional[str]) – The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs from other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.

  • source_api_association_config (Union[IResolvable, SourceApiAssociationConfigProperty, Dict[str, Any], None]) – The SourceApiAssociationConfig object data.

  • source_api_identifier (Optional[str]) – The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-sourceapiassociation.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_appsync as appsync

cfn_source_api_association_props = appsync.CfnSourceApiAssociationProps(
    description="description",
    merged_api_identifier="mergedApiIdentifier",
    source_api_association_config=appsync.CfnSourceApiAssociation.SourceApiAssociationConfigProperty(
        merge_type="mergeType"
    ),
    source_api_identifier="sourceApiIdentifier"
)

Attributes

description

The description field of the association configuration.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-sourceapiassociation.html#cfn-appsync-sourceapiassociation-description

merged_api_identifier

The identifier of the AppSync Merged API.

This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs from other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-sourceapiassociation.html#cfn-appsync-sourceapiassociation-mergedapiidentifier

source_api_association_config

The SourceApiAssociationConfig object data.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-sourceapiassociation.html#cfn-appsync-sourceapiassociation-sourceapiassociationconfig

source_api_identifier

The identifier of the AppSync Source API.

This is generated by the AppSync service. In most cases, source APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-sourceapiassociation.html#cfn-appsync-sourceapiassociation-sourceapiidentifier