RestApiState constructor
- Input<
String?> ? apiKeySource, - Input<
String?> ? arn, - Input<
List< ? binaryMediaTypes,String> ?> - Input<
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,String, String> ?> - Input<
String?> ? policy, - Input<
String?> ? putRestApiMode, - Input<
String?> ? region, - Input<
String?> ? rootResourceId, - Input<
String?> ? securityPolicy, - Input<
Map< ? tags,String, String> ?> - Input<
Map< ? tagsAll,String, String> ?>
Creates a new RestApiState.
apiKeySource Source of the API key for requests. Valid values are HEADER (default) and AUTHORIZER. If importing an OpenAPI specification via the body argument, this corresponds to the x-amazon-apigateway-api-key-source extension. If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.
arn ARN
binaryMediaTypes 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 body argument, this corresponds to the x-amazon-apigateway-binary-media-types extension. If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.
body 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.Deployment creation. More information about REST API OpenAPI support can be found in the API Gateway Developer Guide.
createdDate Creation date of the REST API
description Description of the REST API. If importing an OpenAPI specification via the body argument, this corresponds to the info.description field. If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.
disableExecuteApiEndpoint 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 the body argument, this corresponds to the x-amazon-apigateway-endpoint-configuration extension disableExecuteApiEndpoint property. If the argument value is true and is different than the OpenAPI value, the argument value will override the OpenAPI value.
endpointAccessMode Endpoint access mode for the REST API. Valid values are BASIC and STRICT. Only available for REST APIs that use a securityPolicy value beginning with SecurityPolicy_ and is required when one of those values is configured.
endpointConfiguration Configuration block defining API endpoint configuration including endpoint type. Defined below.
executionArn Execution ARN part to be used in lambdaPermission's sourceArn 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.
failOnWarnings Whether to return an error for warnings while API Gateway is creating or updating the resource. Defaults to false.
minimumCompressionSize Minimum response size to compress for the REST API. String containing an integer value between -1 and 10485760 (10MB). -1 will 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 the body argument, this corresponds to the x-amazon-apigateway-minimum-compression-size extension. If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.
name Name of the REST API. If importing an OpenAPI specification via the body argument, this corresponds to the info.title field. If the argument value is different than the OpenAPI value, the argument value will override the OpenAPI value.
parameters Map of customizations for importing the specification in the body argument. For example, to exclude DocumentationParts from an imported API, set ignore equal to documentation. Additional documentation, including other parameters such as basepath, can be found in the API Gateway Developer Guide.
policy 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.RestApiPolicy resource instead. If importing an OpenAPI specification via the body argument, this corresponds to the x-amazon-apigateway-policy extension. If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.
putRestApiMode Mode of the PutRestApi operation when importing an OpenAPI specification via the body argument (create or update operation). Valid values are merge and overwrite. If not configured, defaults to overwrite (for backwards compatibility). This corresponds to the x-amazon-apigateway-put-integration-method extension. If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.
region Region where this resource will be managed. Defaults to the Region set in the provider configuration.
rootResourceId Resource ID of the REST API's root
securityPolicy 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_, endpointAccessMode must also be configured. For a list of valid security policies, see CreateRestApi in the Amazon API Gateway API Reference.
tags Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
Implementation
const RestApiState({
this.apiKeySource,
this.arn,
this.binaryMediaTypes,
this.body,
this.createdDate,
this.description,
this.disableExecuteApiEndpoint,
this.endpointAccessMode,
this.endpointConfiguration,
this.executionArn,
this.failOnWarnings,
this.minimumCompressionSize,
this.name,
this.parameters,
this.policy,
this.putRestApiMode,
this.region,
this.rootResourceId,
this.securityPolicy,
this.tags,
this.tagsAll,
});