Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. apigatewayv2
  5. Model

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.apigatewayv2.Model

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    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)
    public Model(String name, ModelArgs args)
public Model(String name, ModelArgs args, CustomResourceOptions options)

    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.

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Model resource accepts the following input properties:

    ApiId 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::Model for more information about the expected schema for this property.

    ContentType 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.
    ApiId 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::Model for more information about the expected schema for this property.

    ContentType 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.
    apiId 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::Model for more information about the expected schema for this property.

    contentType 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.
    apiId 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::Model for more information about the expected schema for this property.

    contentType 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::Model for 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.
    apiId 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::Model for more information about the expected schema for this property.

    contentType 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:

    Id string
    The provider-assigned unique ID for this managed resource.
    ModelId string
    The model ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    ModelId string
    The model ID.
    id String
    The provider-assigned unique ID for this managed resource.
    modelId String
    The model ID.
    id string
    The provider-assigned unique ID for this managed resource.
    modelId string
    The model ID.
    id str
    The provider-assigned unique ID for this managed resource.
    model_id str
    The model ID.
    id String
    The provider-assigned unique ID for this managed resource.
    modelId String
    The model ID.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native