Class GetRestApiResult

Inheritance
System.Object
GetRestApiResult
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 GetRestApiResult

Fields

View Source

ApiKeySource

The source of the API key for requests.

Declaration
public readonly string ApiKeySource
Field Value
Type Description
System.String
View Source

Arn

The ARN of the REST API.

Declaration
public readonly string Arn
Field Value
Type Description
System.String
View Source

BinaryMediaTypes

The list of binary media types supported by the REST API.

Declaration
public readonly ImmutableArray<string> BinaryMediaTypes
Field Value
Type Description
System.Collections.Immutable.ImmutableArray<System.String>
View Source

Description

The description of the REST API.

Declaration
public readonly string Description
Field Value
Type Description
System.String
View Source

EndpointConfigurations

The endpoint configuration of this RestApi showing the endpoint types of the API.

Declaration
public readonly ImmutableArray<GetRestApiEndpointConfigurationResult> EndpointConfigurations
Field Value
Type Description
System.Collections.Immutable.ImmutableArray<GetRestApiEndpointConfigurationResult>
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 readonly string ExecutionArn
Field Value
Type Description
System.String
View Source

Id

The provider-assigned unique ID for this managed resource.

Declaration
public readonly string Id
Field Value
Type Description
System.String
View Source

MinimumCompressionSize

Minimum response size to compress for the REST API.

Declaration
public readonly int MinimumCompressionSize
Field Value
Type Description
System.Int32
View Source

Name

Declaration
public readonly string Name
Field Value
Type Description
System.String
View Source

Policy

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

Declaration
public readonly string Policy
Field Value
Type Description
System.String
View Source

RootResourceId

Set to the ID of the API Gateway Resource on the found REST API where the route matches '/'.

Declaration
public readonly string RootResourceId
Field Value
Type Description
System.String
View Source

Tags

Key-value map of resource tags.

Declaration
public readonly ImmutableDictionary<string, object> Tags
Field Value
Type Description
System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>