Class: Aws::ApiGatewayV2::Types::CreateApiInput

Inherits:
Struct
  • Object
show all
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

Instance Attribute Details

#api_key_selection_expressionString

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

Returns:

  • (String)


485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 485

class CreateApiInput < Struct.new(
  :api_key_selection_expression,
  :cors_configuration,
  :credentials_arn,
  :description,
  :disable_schema_validation,
  :name,
  :protocol_type,
  :route_key,
  :route_selection_expression,
  :tags,
  :target,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#cors_configurationTypes::Cors

A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.

Returns:



485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 485

class CreateApiInput < Struct.new(
  :api_key_selection_expression,
  :cors_configuration,
  :credentials_arn,
  :description,
  :disable_schema_validation,
  :name,
  :protocol_type,
  :route_key,
  :route_selection_expression,
  :tags,
  :target,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#credentials_arnString

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.

Returns:

  • (String)


485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 485

class CreateApiInput < Struct.new(
  :api_key_selection_expression,
  :cors_configuration,
  :credentials_arn,
  :description,
  :disable_schema_validation,
  :name,
  :protocol_type,
  :route_key,
  :route_selection_expression,
  :tags,
  :target,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description of the API.

Returns:

  • (String)


485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 485

class CreateApiInput < Struct.new(
  :api_key_selection_expression,
  :cors_configuration,
  :credentials_arn,
  :description,
  :disable_schema_validation,
  :name,
  :protocol_type,
  :route_key,
  :route_selection_expression,
  :tags,
  :target,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#disable_schema_validationBoolean

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

Returns:

  • (Boolean)


485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 485

class CreateApiInput < Struct.new(
  :api_key_selection_expression,
  :cors_configuration,
  :credentials_arn,
  :description,
  :disable_schema_validation,
  :name,
  :protocol_type,
  :route_key,
  :route_selection_expression,
  :tags,
  :target,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the API.

Returns:

  • (String)


485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 485

class CreateApiInput < Struct.new(
  :api_key_selection_expression,
  :cors_configuration,
  :credentials_arn,
  :description,
  :disable_schema_validation,
  :name,
  :protocol_type,
  :route_key,
  :route_selection_expression,
  :tags,
  :target,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#protocol_typeString

The API protocol.

Returns:

  • (String)


485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 485

class CreateApiInput < Struct.new(
  :api_key_selection_expression,
  :cors_configuration,
  :credentials_arn,
  :description,
  :disable_schema_validation,
  :name,
  :protocol_type,
  :route_key,
  :route_selection_expression,
  :tags,
  :target,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#route_keyString

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.

Returns:

  • (String)


485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 485

class CreateApiInput < Struct.new(
  :api_key_selection_expression,
  :cors_configuration,
  :credentials_arn,
  :description,
  :disable_schema_validation,
  :name,
  :protocol_type,
  :route_key,
  :route_selection_expression,
  :tags,
  :target,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#route_selection_expressionString

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.

Returns:

  • (String)


485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 485

class CreateApiInput < Struct.new(
  :api_key_selection_expression,
  :cors_configuration,
  :credentials_arn,
  :description,
  :disable_schema_validation,
  :name,
  :protocol_type,
  :route_key,
  :route_selection_expression,
  :tags,
  :target,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

The collection of tags. Each tag element is associated with a given resource.

Returns:

  • (Hash<String,String>)


485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 485

class CreateApiInput < Struct.new(
  :api_key_selection_expression,
  :cors_configuration,
  :credentials_arn,
  :description,
  :disable_schema_validation,
  :name,
  :protocol_type,
  :route_key,
  :route_selection_expression,
  :tags,
  :target,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#targetString

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.

Returns:

  • (String)


485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 485

class CreateApiInput < Struct.new(
  :api_key_selection_expression,
  :cors_configuration,
  :credentials_arn,
  :description,
  :disable_schema_validation,
  :name,
  :protocol_type,
  :route_key,
  :route_selection_expression,
  :tags,
  :target,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#versionString

A version identifier for the API.

Returns:

  • (String)


485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 485

class CreateApiInput < Struct.new(
  :api_key_selection_expression,
  :cors_configuration,
  :credentials_arn,
  :description,
  :disable_schema_validation,
  :name,
  :protocol_type,
  :route_key,
  :route_selection_expression,
  :tags,
  :target,
  :version)
  SENSITIVE = []
  include Aws::Structure
end