CfnGraphQLSchemaProps

class aws_cdk.aws_appsync.CfnGraphQLSchemaProps(*, api_id, definition=None, definition_s3_location=None)

Bases: object

Properties for defining a CfnGraphQLSchema.

Parameters
  • api_id (str) – The AWS AppSync GraphQL API identifier to which you want to apply this schema.

  • definition (Optional[str]) – The text representation of a GraphQL schema in SDL format. For more information about using the Ref function, see Ref .

  • definition_s3_location (Optional[str]) – The location of a GraphQL schema file in an Amazon S3 bucket. Use this if you want to provision with the schema living in Amazon S3 rather than embedding it in your CloudFormation template.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlschema.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_graph_qLSchema_props = appsync.CfnGraphQLSchemaProps(
    api_id="apiId",

    # the properties below are optional
    definition="definition",
    definition_s3_location="definitionS3Location"
)

Attributes

api_id

The AWS AppSync GraphQL API identifier to which you want to apply this schema.

Link

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

Return type

str

definition

The text representation of a GraphQL schema in SDL format.

For more information about using the Ref function, see Ref .

Link

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

Return type

Optional[str]

definition_s3_location

The location of a GraphQL schema file in an Amazon S3 bucket.

Use this if you want to provision with the schema living in Amazon S3 rather than embedding it in your CloudFormation template.

Link

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

Return type

Optional[str]