Docs
PackagesAWS Native is in preview. AWS Classic is fully supported.
aws-native.apigatewayv2.Model
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
The AWS::ApiGatewayV2::Model resource updates data model for a WebSocket API. For more information, see Model Selection Expressions in the API Gateway Developer Guide.
Create Model Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Model(name: string, args: ModelArgs, opts?: CustomResourceOptions);@overload
def Model(resource_name: str,
args: ModelArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Model(resource_name: str,
opts: Optional[ResourceOptions] = None,
api_id: Optional[str] = None,
schema: Optional[Any] = None,
content_type: Optional[str] = None,
description: Optional[str] = None,
name: Optional[str] = None)func NewModel(ctx *Context, name string, args ModelArgs, opts ...ResourceOption) (*Model, error)public Model(string name, ModelArgs args, CustomResourceOptions? opts = null)type: aws-native:apigatewayv2:Model
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 ModelArgs
- 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 ModelArgs
- 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 ModelArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ModelArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ModelArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Example
The following reference example uses placeholder values for all input properties.
Coming soon!
Coming soon!
Coming soon!
Coming soon!
const aws_nativeModelResource = new aws_native.apigatewayv2.Model("aws-nativeModelResource", {
apiId: "string",
schema: "any",
contentType: "string",
description: "string",
name: "string",
});
Coming soon!
Model Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Model resource accepts the following input properties:
- Api
Id string - The API identifier.
- Schema object
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
Search the CloudFormation User Guide for
AWS::ApiGatewayV2::Modelfor more information about the expected schema for this property.- Content
Type string - The content-type for the model, for example, "application/json".
- Description string
- The description of the model.
- Name string
- The name of the model.
- Api
Id string - The API identifier.
- Schema interface{}
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
Search the CloudFormation User Guide for
AWS::ApiGatewayV2::Modelfor more information about the expected schema for this property.- Content
Type string - The content-type for the model, for example, "application/json".
- Description string
- The description of the model.
- Name string
- The name of the model.
- api
Id String - The API identifier.
- schema Object
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
Search the CloudFormation User Guide for
AWS::ApiGatewayV2::Modelfor more information about the expected schema for this property.- content
Type String - The content-type for the model, for example, "application/json".
- description String
- The description of the model.
- name String
- The name of the model.
- api
Id string - The API identifier.
- schema any
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
Search the CloudFormation User Guide for
AWS::ApiGatewayV2::Modelfor more information about the expected schema for this property.- content
Type string - The content-type for the model, for example, "application/json".
- description string
- The description of the model.
- name string
- The name of the model.
- api_
id str - The API identifier.
- schema Any
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
Search the CloudFormation User Guide for
AWS::ApiGatewayV2::Modelfor more information about the expected schema for this property.- content_
type str - The content-type for the model, for example, "application/json".
- description str
- The description of the model.
- name str
- The name of the model.
- api
Id String - The API identifier.
- schema Any
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
Search the CloudFormation User Guide for
AWS::ApiGatewayV2::Modelfor more information about the expected schema for this property.- content
Type String - The content-type for the model, for example, "application/json".
- description String
- The description of the model.
- name String
- The name of the model.
Outputs
All input properties are implicitly available as output properties. Additionally, the Model resource produces the following output properties:
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.