AWS Native
Model
Resource Type definition for AWS::ApiGateway::Model
Create a Model Resource
new Model(name: string, args: ModelArgs, opts?: CustomResourceOptions);
@overload
def Model(resource_name: str,
opts: Optional[ResourceOptions] = None,
content_type: Optional[str] = None,
description: Optional[str] = None,
name: Optional[str] = None,
rest_api_id: Optional[str] = None,
schema: Optional[Any] = None)
@overload
def Model(resource_name: str,
args: ModelArgs,
opts: Optional[ResourceOptions] = 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:apigateway:Model
properties: # The arguments to resource properties.
options: # 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.
- 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
The Model resource accepts the following input properties:
- Rest
Api stringId The ID of a REST API with which to associate this model.
- Content
Type string The content type for the model.
- Description string
A description that identifies this model.
- Name string
A name for the model. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the model name.
- Schema object
The schema to use to transform data to one or more output formats. Specify null ({}) if you don't want to specify a schema.
- Rest
Api stringId The ID of a REST API with which to associate this model.
- Content
Type string The content type for the model.
- Description string
A description that identifies this model.
- Name string
A name for the model. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the model name.
- Schema interface{}
The schema to use to transform data to one or more output formats. Specify null ({}) if you don't want to specify a schema.
- rest
Api StringId The ID of a REST API with which to associate this model.
- content
Type String The content type for the model.
- description String
A description that identifies this model.
- name String
A name for the model. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the model name.
- schema Object
The schema to use to transform data to one or more output formats. Specify null ({}) if you don't want to specify a schema.
- rest
Api stringId The ID of a REST API with which to associate this model.
- content
Type string The content type for the model.
- description string
A description that identifies this model.
- name string
A name for the model. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the model name.
- schema any
The schema to use to transform data to one or more output formats. Specify null ({}) if you don't want to specify a schema.
- rest_
api_ strid The ID of a REST API with which to associate this model.
- content_
type str The content type for the model.
- description str
A description that identifies this model.
- name str
A name for the model. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the model name.
- schema Any
The schema to use to transform data to one or more output formats. Specify null ({}) if you don't want to specify a schema.
- rest
Api StringId The ID of a REST API with which to associate this model.
- content
Type String The content type for the model.
- description String
A description that identifies this model.
- name String
A name for the model. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the model name.
- schema Any
The schema to use to transform data to one or more output formats. Specify null ({}) if you don't want to specify a schema.
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.
- Id string
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
- id string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Package Details
- Repository
- https://github.com/pulumi/pulumi-aws-native
- License
- Apache-2.0