Class: Aws::ApiGatewayV2::Types::CreateApiInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::ApiGatewayV2::Types::CreateApiInput
- Defined in:
- gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb
Overview
Represents the input parameters for a CreateApi request.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#api_key_selection_expression ⇒ String
An API key selection expression.
-
#cors_configuration ⇒ Types::Cors
A CORS configuration.
-
#credentials_arn ⇒ String
This property is part of quick create.
-
#description ⇒ String
The description of the API.
-
#disable_execute_api_endpoint ⇒ Boolean
-
#disable_schema_validation ⇒ Boolean
Avoid validating models when creating a deployment.
-
#name ⇒ String
The name of the API.
-
#protocol_type ⇒ String
The API protocol.
-
#route_key ⇒ String
This property is part of quick create.
-
#route_selection_expression ⇒ String
The route selection expression for the API.
-
#tags ⇒ Hash<String,String>
The collection of tags.
-
#target ⇒ String
This property is part of quick create.
-
#version ⇒ String
A version identifier for the API.
Instance Attribute Details
#api_key_selection_expression ⇒ String
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 519 class CreateApiInput < Struct.new( :api_key_selection_expression, :cors_configuration, :credentials_arn, :description, :disable_schema_validation, :disable_execute_api_endpoint, :name, :protocol_type, :route_key, :route_selection_expression, :tags, :target, :version) SENSITIVE = [] include Aws::Structure end |
#cors_configuration ⇒ Types::Cors
A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 519 class CreateApiInput < Struct.new( :api_key_selection_expression, :cors_configuration, :credentials_arn, :description, :disable_schema_validation, :disable_execute_api_endpoint, :name, :protocol_type, :route_key, :route_selection_expression, :tags, :target, :version) SENSITIVE = [] include Aws::Structure end |
#credentials_arn ⇒ String
This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam:::user/. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 519 class CreateApiInput < Struct.new( :api_key_selection_expression, :cors_configuration, :credentials_arn, :description, :disable_schema_validation, :disable_execute_api_endpoint, :name, :protocol_type, :route_key, :route_selection_expression, :tags, :target, :version) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
The description of the API.
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 519 class CreateApiInput < Struct.new( :api_key_selection_expression, :cors_configuration, :credentials_arn, :description, :disable_schema_validation, :disable_execute_api_endpoint, :name, :protocol_type, :route_key, :route_selection_expression, :tags, :target, :version) SENSITIVE = [] include Aws::Structure end |
#disable_execute_api_endpoint ⇒ Boolean
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 519 class CreateApiInput < Struct.new( :api_key_selection_expression, :cors_configuration, :credentials_arn, :description, :disable_schema_validation, :disable_execute_api_endpoint, :name, :protocol_type, :route_key, :route_selection_expression, :tags, :target, :version) SENSITIVE = [] include Aws::Structure end |
#disable_schema_validation ⇒ Boolean
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 519 class CreateApiInput < Struct.new( :api_key_selection_expression, :cors_configuration, :credentials_arn, :description, :disable_schema_validation, :disable_execute_api_endpoint, :name, :protocol_type, :route_key, :route_selection_expression, :tags, :target, :version) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name of the API.
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 519 class CreateApiInput < Struct.new( :api_key_selection_expression, :cors_configuration, :credentials_arn, :description, :disable_schema_validation, :disable_execute_api_endpoint, :name, :protocol_type, :route_key, :route_selection_expression, :tags, :target, :version) SENSITIVE = [] include Aws::Structure end |
#protocol_type ⇒ String
The API protocol.
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 519 class CreateApiInput < Struct.new( :api_key_selection_expression, :cors_configuration, :credentials_arn, :description, :disable_schema_validation, :disable_execute_api_endpoint, :name, :protocol_type, :route_key, :route_selection_expression, :tags, :target, :version) SENSITIVE = [] include Aws::Structure end |
#route_key ⇒ String
This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 519 class CreateApiInput < Struct.new( :api_key_selection_expression, :cors_configuration, :credentials_arn, :description, :disable_schema_validation, :disable_execute_api_endpoint, :name, :protocol_type, :route_key, :route_selection_expression, :tags, :target, :version) SENSITIVE = [] include Aws::Structure end |
#route_selection_expression ⇒ String
The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method\} ${request.path\}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 519 class CreateApiInput < Struct.new( :api_key_selection_expression, :cors_configuration, :credentials_arn, :description, :disable_schema_validation, :disable_execute_api_endpoint, :name, :protocol_type, :route_key, :route_selection_expression, :tags, :target, :version) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Hash<String,String>
The collection of tags. Each tag element is associated with a given resource.
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 519 class CreateApiInput < Struct.new( :api_key_selection_expression, :cors_configuration, :credentials_arn, :description, :disable_schema_validation, :disable_execute_api_endpoint, :name, :protocol_type, :route_key, :route_selection_expression, :tags, :target, :version) SENSITIVE = [] include Aws::Structure end |
#target ⇒ String
This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 519 class CreateApiInput < Struct.new( :api_key_selection_expression, :cors_configuration, :credentials_arn, :description, :disable_schema_validation, :disable_execute_api_endpoint, :name, :protocol_type, :route_key, :route_selection_expression, :tags, :target, :version) SENSITIVE = [] include Aws::Structure end |
#version ⇒ String
A version identifier for the API.
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 |
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 519 class CreateApiInput < Struct.new( :api_key_selection_expression, :cors_configuration, :credentials_arn, :description, :disable_schema_validation, :disable_execute_api_endpoint, :name, :protocol_type, :route_key, :route_selection_expression, :tags, :target, :version) SENSITIVE = [] include Aws::Structure end |