Class RestApiState

Inheritance
System.Object
InputArgs
ResourceArgs
RestApiState
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.ApiGateway
Assembly: Pulumi.Aws.dll
Syntax
public sealed class RestApiState : ResourceArgs

Constructors

View Source

RestApiState()

Declaration
public RestApiState()

Properties

View Source

ApiKeySource

The source of the API key for requests. Valid values are HEADER (default) and AUTHORIZER.

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

Arn

Amazon Resource Name (ARN)

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

BinaryMediaTypes

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

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

Body

An OpenAPI specification that defines the set of routes and integrations to create as part of the REST API.

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

CreatedDate

The creation date of the REST API

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

Description

The description of the REST API

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

EndpointConfiguration

Nested argument defining API endpoint configuration including endpoint type. Defined below.

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

ExecutionArn

The execution ARN part to be used in lambda_permission's source_arn when allowing API Gateway to invoke a Lambda function, e.g. arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j, which can be concatenated with allowed stage, method and resource path.

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

MinimumCompressionSize

Minimum response size to compress for the REST API. Integer between -1 and 10485760 (10MB). Setting a value greater than -1 will enable compression, -1 disables compression (default).

Declaration
public Input<int> MinimumCompressionSize { get; set; }
Property Value
Type Description
Input<System.Int32>
View Source

Name

The name of the REST API

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

Policy

JSON formatted policy document that controls access to the API Gateway.

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

RootResourceId

The resource ID of the REST API's root

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

Tags

Key-value map of resource tags

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