CfnGraphQLSchemaPropsMixin
- class aws_cdk.mixins_preview.aws_appsync.mixins.CfnGraphQLSchemaPropsMixin(props, *, strategy=None)
Bases:
MixinThe
AWS::AppSync::GraphQLSchemaresource is used for your AWS AppSync GraphQL schema that controls the data model for your API.Schema files are text written in Schema Definition Language (SDL) format. For more information about schema authoring, see Designing a GraphQL API in the AWS AppSync Developer Guide . .. epigraph:
When you submit an update, AWS CloudFormation updates resources based on differences between what you submit and the stack's current template. To cause this resource to be updated you must change a property value for this resource in the CloudFormation template. Changing the Amazon S3 file content without changing a property value will not result in an update operation. See `Update Behaviors of Stack Resources <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html>`_ in the *AWS CloudFormation User Guide* .
- See:
- CloudformationResource:
AWS::AppSync::GraphQLSchema
- 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_graph_qLSchema_props_mixin = appsync_mixins.CfnGraphQLSchemaPropsMixin(appsync_mixins.CfnGraphQLSchemaMixinProps( api_id="apiId", definition="definition", definition_s3_location="definitionS3Location" ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::AppSync::GraphQLSchema.- Parameters:
props (
Union[CfnGraphQLSchemaMixinProps,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:
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['apiId', 'definition', 'definitionS3Location']
Static Methods
- classmethod is_mixin(x)
(experimental) Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental