CfnSourceApiAssociationPropsMixin

class aws_cdk.mixins_preview.aws_appsync.mixins.CfnSourceApiAssociationPropsMixin(props, *, strategy=None)

Bases: Mixin

Describes the configuration of a source API.

A source API is a GraphQL API that is linked to a merged API. There can be multiple source APIs attached to each merged API. When linked to a merged API, the source API’s schema, data sources, and resolvers will be combined with other linked source API data to form a new, singular API. Source APIs can originate from your account or from other accounts via Resource Access Manager.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-sourceapiassociation.html
CloudformationResource:: AWS::AppSync::SourceApiAssociation
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

cfn_source_api_association_props_mixin = appsync_mixins.CfnSourceApiAssociationPropsMixin(appsync_mixins.CfnSourceApiAssociationMixinProps(
    description="description",
    merged_api_identifier="mergedApiIdentifier",
    source_api_association_config=appsync_mixins.CfnSourceApiAssociationPropsMixin.SourceApiAssociationConfigProperty(
        merge_type="mergeType"
    ),
    source_api_identifier="sourceApiIdentifier"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::AppSync::SourceApiAssociation.

Parameters:

props (Union[CfnSourceApiAssociationMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['description', 'mergedApiIdentifier', 'sourceApiAssociationConfig', 'sourceApiIdentifier']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

SourceApiAssociationConfigProperty

class CfnSourceApiAssociationPropsMixin.SourceApiAssociationConfigProperty(*, merge_type=None)

Bases: object

Describes properties used to specify configurations related to a source API.

This is a property of the AWS:AppSync:SourceApiAssociation type.

Parameters:: merge_type (Optional[str]) – The property that indicates which merging option is enabled in the source API association. Valid merge types are MANUAL_MERGE (default) and AUTO_MERGE . Manual merges are the default behavior and require the user to trigger any changes from the source APIs to the merged API manually. Auto merges subscribe the merged API to the changes performed on the source APIs so that any change in the source APIs are also made to the merged API. Auto merges use MergedApiExecutionRoleArn to perform merge operations. The following values are valid: MANUAL_MERGE | AUTO_MERGE
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-sourceapiassociation-sourceapiassociationconfig.html
ExampleMetadata:: fixture=_generated

Example:

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

source_api_association_config_property = appsync_mixins.CfnSourceApiAssociationPropsMixin.SourceApiAssociationConfigProperty(
    merge_type="mergeType"
)

Attributes

merge_type

The property that indicates which merging option is enabled in the source API association.

Valid merge types are MANUAL_MERGE (default) and AUTO_MERGE . Manual merges are the default behavior and require the user to trigger any changes from the source APIs to the merged API manually. Auto merges subscribe the merged API to the changes performed on the source APIs so that any change in the source APIs are also made to the merged API. Auto merges use MergedApiExecutionRoleArn to perform merge operations.

The following values are valid:

MANUAL_MERGE | AUTO_MERGE

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