RestApiState class
Input properties used for looking up and filtering RestApi resources.
Constructors
-
RestApiState({Input<
String?> ? apiKeySource, Input<String?> ? arn, Input<List< ? binaryMediaTypes, Input<String> ?>String?> ? body, Input<String?> ? createdDate, Input<String?> ? description, Input<bool?> ? disableExecuteApiEndpoint, Input<String?> ? endpointAccessMode, Input<RestApiEndpointConfiguration?> ? endpointConfiguration, Input<String?> ? executionArn, Input<bool?> ? failOnWarnings, Input<String?> ? minimumCompressionSize, Input<String?> ? name, Input<Map< ? parameters, Input<String, String> ?>String?> ? policy, Input<String?> ? putRestApiMode, Input<String?> ? region, Input<String?> ? rootResourceId, Input<String?> ? securityPolicy, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll})String, String> ?> -
Creates a new RestApiState.
apiKeySourceSource of the API key for requests. Valid values areHEADER(default) andAUTHORIZER. If importing an OpenAPI specification via thebodyargument, this corresponds to thex-amazon-apigateway-api-key-sourceextension. If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.arnARNbinaryMediaTypesList of binary media types supported by the REST API. By default, the REST API supports only UTF-8-encoded text payloads. If importing an OpenAPI specification via thebodyargument, this corresponds to thex-amazon-apigateway-binary-media-typesextension. If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.bodyOpenAPI specification that defines the set of routes and integrations to create as part of the REST API. This configuration, and any updates to it, will replace all REST API configuration except values overridden in this resource configuration and other resource updates applied after this resource but before anyaws.apigateway.Deploymentcreation. More information about REST API OpenAPI support can be found in the API Gateway Developer Guide.createdDateCreation date of the REST APIdescriptionDescription of the REST API. If importing an OpenAPI specification via thebodyargument, this corresponds to theinfo.descriptionfield. If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.disableExecuteApiEndpointWhether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint. Defaults tofalse. If importing an OpenAPI specification via thebodyargument, this corresponds to thex-amazon-apigateway-endpoint-configurationextensiondisableExecuteApiEndpointproperty. If the argument value istrueand is different than the OpenAPI value, the argument value will override the OpenAPI value.endpointAccessModeEndpoint access mode for the REST API. Valid values areBASICandSTRICT. Only available for REST APIs that use asecurityPolicyvalue beginning withSecurityPolicy_and is required when one of those values is configured.endpointConfigurationConfiguration block defining API endpoint configuration including endpoint type. Defined below.executionArnExecution ARN part to be used inlambdaPermission'ssourceArnwhen 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.failOnWarningsWhether to return an error for warnings while API Gateway is creating or updating the resource. Defaults tofalse.minimumCompressionSizeMinimum response size to compress for the REST API. String containing an integer value between-1and10485760(10MB).-1will disable an existing compression configuration, and all other values will enable compression with the configured size. New resources can simply omit this argument to disable compression, rather than setting the value to-1. If importing an OpenAPI specification via thebodyargument, this corresponds to thex-amazon-apigateway-minimum-compression-sizeextension. If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.nameName of the REST API. If importing an OpenAPI specification via thebodyargument, this corresponds to theinfo.titlefield. If the argument value is different than the OpenAPI value, the argument value will override the OpenAPI value.parametersMap of customizations for importing the specification in thebodyargument. For example, to exclude DocumentationParts from an imported API, setignoreequal todocumentation. Additional documentation, including other parameters such asbasepath, can be found in the API Gateway Developer Guide.policyJSON formatted policy document that controls access to the API Gateway. For more information about building AWS IAM policy documents with Pulumi, see the AWS IAM Policy Document Guide. The provider will only perform drift detection of its value when present in a configuration. We recommend using theaws.apigateway.RestApiPolicyresource instead. If importing an OpenAPI specification via thebodyargument, this corresponds to thex-amazon-apigateway-policyextension. If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.putRestApiModeMode of the PutRestApi operation when importing an OpenAPI specification via thebodyargument (create or update operation). Valid values aremergeandoverwrite. If not configured, defaults tooverwrite(for backwards compatibility). This corresponds to thex-amazon-apigateway-put-integration-methodextension. If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.rootResourceIdResource ID of the REST API's rootsecurityPolicyTLS version + cipher suite for the REST API's default execute-api endpoint. Must be configured for drift detection. When set to a value beginning withSecurityPolicy_,endpointAccessModemust also be configured. For a list of valid security policies, see CreateRestApi in the Amazon API Gateway API Reference.tagsKey-value map of resource tags. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllMap of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.const -
RestApiState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
apiKeySource
→ Input<
String?> ? -
Source of the API key for requests. Valid values are
HEADER(default) andAUTHORIZER. If importing an OpenAPI specification via thebodyargument, this corresponds to thex-amazon-apigateway-api-key-sourceextension. If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.final -
arn
→ Input<
String?> ? -
ARN
final
-
binaryMediaTypes
→ Input<
List< ?String> ?> -
List of binary media types supported by the REST API. By default, the REST API supports only UTF-8-encoded text payloads. If importing an OpenAPI specification via the
bodyargument, this corresponds to thex-amazon-apigateway-binary-media-typesextension. If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.final -
body
→ Input<
String?> ? -
OpenAPI specification that defines the set of routes and integrations to create as part of the REST API. This configuration, and any updates to it, will replace all REST API configuration except values overridden in this resource configuration and other resource updates applied after this resource but before any
aws.apigateway.Deploymentcreation. More information about REST API OpenAPI support can be found in the API Gateway Developer Guide.final -
createdDate
→ Input<
String?> ? -
Creation date of the REST API
final
-
description
→ Input<
String?> ? -
Description of the REST API. If importing an OpenAPI specification via the
bodyargument, this corresponds to theinfo.descriptionfield. If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.final -
disableExecuteApiEndpoint
→ Input<
bool?> ? -
Whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint. Defaults to
false. If importing an OpenAPI specification via thebodyargument, this corresponds to thex-amazon-apigateway-endpoint-configurationextensiondisableExecuteApiEndpointproperty. If the argument value istrueand is different than the OpenAPI value, the argument value will override the OpenAPI value.final -
endpointAccessMode
→ Input<
String?> ? -
Endpoint access mode for the REST API. Valid values are
BASICandSTRICT. Only available for REST APIs that use asecurityPolicyvalue beginning withSecurityPolicy_and is required when one of those values is configured.final -
endpointConfiguration
→ Input<
RestApiEndpointConfiguration?> ? -
Configuration block defining API endpoint configuration including endpoint type. Defined below.
final
-
executionArn
→ Input<
String?> ? -
Execution ARN part to be used in
lambdaPermission'ssourceArnwhen 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.final -
failOnWarnings
→ Input<
bool?> ? -
Whether to return an error for warnings while API Gateway is creating or updating the resource. Defaults to
false.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
minimumCompressionSize
→ Input<
String?> ? -
Minimum response size to compress for the REST API. String containing an integer value between
-1and10485760(10MB).-1will disable an existing compression configuration, and all other values will enable compression with the configured size. New resources can simply omit this argument to disable compression, rather than setting the value to-1. If importing an OpenAPI specification via thebodyargument, this corresponds to thex-amazon-apigateway-minimum-compression-sizeextension. If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.final -
name
→ Input<
String?> ? -
Name of the REST API. If importing an OpenAPI specification via the
bodyargument, this corresponds to theinfo.titlefield. If the argument value is different than the OpenAPI value, the argument value will override the OpenAPI value.final -
parameters
→ Input<
Map< ?String, String> ?> -
Map of customizations for importing the specification in the
bodyargument. For example, to exclude DocumentationParts from an imported API, setignoreequal todocumentation. Additional documentation, including other parameters such asbasepath, can be found in the API Gateway Developer Guide.final -
policy
→ Input<
String?> ? -
JSON formatted policy document that controls access to the API Gateway. For more information about building AWS IAM policy documents with Pulumi, see the AWS IAM Policy Document Guide. The provider will only perform drift detection of its value when present in a configuration. We recommend using the
aws.apigateway.RestApiPolicyresource instead. If importing an OpenAPI specification via thebodyargument, this corresponds to thex-amazon-apigateway-policyextension. If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.final -
putRestApiMode
→ Input<
String?> ? -
Mode of the PutRestApi operation when importing an OpenAPI specification via the
bodyargument (create or update operation). Valid values aremergeandoverwrite. If not configured, defaults tooverwrite(for backwards compatibility). This corresponds to thex-amazon-apigateway-put-integration-methodextension. If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.final -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
-
rootResourceId
→ Input<
String?> ? -
Resource ID of the REST API's root
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
securityPolicy
→ Input<
String?> ? -
TLS version + cipher suite for the REST API's default execute-api endpoint. Must be configured for drift detection. When set to a value beginning with
SecurityPolicy_,endpointAccessModemust also be configured. For a list of valid security policies, see CreateRestApi in the Amazon API Gateway API Reference.final -
Key-value map of resource tags. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited