Class ApiState

Inheritance
System.Object
InputArgs
ResourceArgs
ApiState
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.Aws.ApiGatewayV2
Assembly: Pulumi.Aws.dll
Syntax
public sealed class ApiState : ResourceArgs

Constructors

View Source

ApiState()

Declaration
public ApiState()

Properties

View Source

ApiEndpoint

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com.

Declaration
public Input<string> ApiEndpoint { get; set; }
Property Value
Type Description
Input<System.String>
View Source

ApiKeySelectionExpression

An API key selection expression. Valid values: $context.authorizer.usageIdentifierKey, $request.header.x-api-key. Defaults to $request.header.x-api-key. Applicable for WebSocket APIs.

Declaration
public Input<string> ApiKeySelectionExpression { get; set; }
Property Value
Type Description
Input<System.String>
View Source

Arn

The ARN of the API.

Declaration
public Input<string> Arn { get; set; }
Property Value
Type Description
Input<System.String>
View Source

CorsConfiguration

The cross-origin resource sharing (CORS) configuration. Applicable for HTTP APIs.

Declaration
public Input<ApiCorsConfigurationGetArgs> CorsConfiguration { get; set; }
Property Value
Type Description
Input<ApiCorsConfigurationGetArgs>
View Source

CredentialsArn

Part of quick create. Specifies any credentials required for the integration. Applicable for HTTP APIs.

Declaration
public Input<string> CredentialsArn { get; set; }
Property Value
Type Description
Input<System.String>
View Source

Description

The description of the API.

Declaration
public Input<string> Description { get; set; }
Property Value
Type Description
Input<System.String>
View Source

ExecutionArn

The ARN prefix to be used in an aws.lambda.Permission's source_arn attribute or in an aws.iam.Policy to authorize access to the @connections API. See the Amazon API Gateway Developer Guide for details.

Declaration
public Input<string> ExecutionArn { get; set; }
Property Value
Type Description
Input<System.String>
View Source

Name

The name of the API.

Declaration
public Input<string> Name { get; set; }
Property Value
Type Description
Input<System.String>
View Source

ProtocolType

The API protocol. Valid values: HTTP, WEBSOCKET.

Declaration
public Input<string> ProtocolType { get; set; }
Property Value
Type Description
Input<System.String>
View Source

RouteKey

Part of quick create. Specifies any route key. Applicable for HTTP APIs.

Declaration
public Input<string> RouteKey { get; set; }
Property Value
Type Description
Input<System.String>
View Source

RouteSelectionExpression

The route selection expression for the API. Defaults to $request.method $request.path.

Declaration
public Input<string> RouteSelectionExpression { get; set; }
Property Value
Type Description
Input<System.String>
View Source

Tags

A map of tags to assign to the API.

Declaration
public InputMap<object> Tags { get; set; }
Property Value
Type Description
InputMap<System.Object>
View Source

Target

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. Applicable for HTTP APIs.

Declaration
public Input<string> Target { get; set; }
Property Value
Type Description
Input<System.String>
View Source

Version

A version identifier for the API.

Declaration
public Input<string> Version { get; set; }
Property Value
Type Description
Input<System.String>