com.pulumi.aws.apigateway.inputs.RestApiState Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws Show documentation
Show all versions of aws Show documentation
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
The newest version!
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.aws.apigateway.inputs;
import com.pulumi.aws.apigateway.inputs.RestApiEndpointConfigurationArgs;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import java.lang.Boolean;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class RestApiState extends com.pulumi.resources.ResourceArgs {
public static final RestApiState Empty = new RestApiState();
/**
* 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-api-key-source.html). If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.
*
*/
@Import(name="apiKeySource")
private @Nullable Output apiKeySource;
/**
* @return 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-api-key-source.html). If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.
*
*/
public Optional> apiKeySource() {
return Optional.ofNullable(this.apiKeySource);
}
/**
* ARN
*
*/
@Import(name="arn")
private @Nullable Output arn;
/**
* @return ARN
*
*/
public Optional> arn() {
return Optional.ofNullable(this.arn);
}
/**
* 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-binary-media-types.html). If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.
*
*/
@Import(name="binaryMediaTypes")
private @Nullable Output> binaryMediaTypes;
/**
* @return 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-binary-media-types.html). If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.
*
*/
public Optional>> binaryMediaTypes() {
return Optional.ofNullable(this.binaryMediaTypes);
}
/**
* 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api.html).
*
*/
@Import(name="body")
private @Nullable Output body;
/**
* @return 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api.html).
*
*/
public Optional> body() {
return Optional.ofNullable(this.body);
}
/**
* Creation date of the REST API
*
*/
@Import(name="createdDate")
private @Nullable Output createdDate;
/**
* @return Creation date of the REST API
*
*/
public Optional> createdDate() {
return Optional.ofNullable(this.createdDate);
}
/**
* 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.
*
*/
@Import(name="description")
private @Nullable Output description;
/**
* @return 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.
*
*/
public Optional> description() {
return Optional.ofNullable(this.description);
}
/**
* 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-endpoint-configuration.html). If the argument value is `true` and is different than the OpenAPI value, the argument value will override the OpenAPI value.
*
*/
@Import(name="disableExecuteApiEndpoint")
private @Nullable Output disableExecuteApiEndpoint;
/**
* @return 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-endpoint-configuration.html). If the argument value is `true` and is different than the OpenAPI value, the argument value will override the OpenAPI value.
*
*/
public Optional> disableExecuteApiEndpoint() {
return Optional.ofNullable(this.disableExecuteApiEndpoint);
}
/**
* Configuration block defining API endpoint configuration including endpoint type. Defined below.
*
*/
@Import(name="endpointConfiguration")
private @Nullable Output endpointConfiguration;
/**
* @return Configuration block defining API endpoint configuration including endpoint type. Defined below.
*
*/
public Optional> endpointConfiguration() {
return Optional.ofNullable(this.endpointConfiguration);
}
/**
* 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.
*
*/
@Import(name="executionArn")
private @Nullable Output executionArn;
/**
* @return 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.
*
*/
public Optional> executionArn() {
return Optional.ofNullable(this.executionArn);
}
/**
* Whether warnings while API Gateway is creating or updating the resource should return an error or not. Defaults to `false`
*
*/
@Import(name="failOnWarnings")
private @Nullable Output failOnWarnings;
/**
* @return Whether warnings while API Gateway is creating or updating the resource should return an error or not. Defaults to `false`
*
*/
public Optional> failOnWarnings() {
return Optional.ofNullable(this.failOnWarnings);
}
/**
* 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-openapi-minimum-compression-size.html). If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.
*
*/
@Import(name="minimumCompressionSize")
private @Nullable Output minimumCompressionSize;
/**
* @return 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-openapi-minimum-compression-size.html). If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.
*
*/
public Optional> minimumCompressionSize() {
return Optional.ofNullable(this.minimumCompressionSize);
}
/**
* 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.
*
*/
@Import(name="name")
private @Nullable Output name;
/**
* @return 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.
*
*/
public Optional> name() {
return Optional.ofNullable(this.name);
}
/**
* 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api.html).
*
*/
@Import(name="parameters")
private @Nullable Output> parameters;
/**
* @return 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api.html).
*
*/
public Optional>> parameters() {
return Optional.ofNullable(this.parameters);
}
/**
* 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/openapi-extensions-policy.html). If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.
*
*/
@Import(name="policy")
private @Nullable Output policy;
/**
* @return 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/openapi-extensions-policy.html). If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.
*
*/
public Optional> policy() {
return Optional.ofNullable(this.policy);
}
/**
* 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 unspecificed, defaults to `overwrite` (for backwards compatibility). This corresponds to the [`x-amazon-apigateway-put-integration-method` extension](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-put-integration-method.html). If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.
*
*/
@Import(name="putRestApiMode")
private @Nullable Output putRestApiMode;
/**
* @return 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 unspecificed, defaults to `overwrite` (for backwards compatibility). This corresponds to the [`x-amazon-apigateway-put-integration-method` extension](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-put-integration-method.html). If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.
*
*/
public Optional> putRestApiMode() {
return Optional.ofNullable(this.putRestApiMode);
}
/**
* Resource ID of the REST API's root
*
*/
@Import(name="rootResourceId")
private @Nullable Output rootResourceId;
/**
* @return Resource ID of the REST API's root
*
*/
public Optional> rootResourceId() {
return Optional.ofNullable(this.rootResourceId);
}
/**
* Key-value map of resource tags. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
*/
@Import(name="tags")
private @Nullable Output> tags;
/**
* @return Key-value map of resource tags. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
*/
public Optional>> tags() {
return Optional.ofNullable(this.tags);
}
/**
* Map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
* @deprecated
* Please use `tags` instead.
*
*/
@Deprecated /* Please use `tags` instead. */
@Import(name="tagsAll")
private @Nullable Output> tagsAll;
/**
* @return Map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
* @deprecated
* Please use `tags` instead.
*
*/
@Deprecated /* Please use `tags` instead. */
public Optional>> tagsAll() {
return Optional.ofNullable(this.tagsAll);
}
private RestApiState() {}
private RestApiState(RestApiState $) {
this.apiKeySource = $.apiKeySource;
this.arn = $.arn;
this.binaryMediaTypes = $.binaryMediaTypes;
this.body = $.body;
this.createdDate = $.createdDate;
this.description = $.description;
this.disableExecuteApiEndpoint = $.disableExecuteApiEndpoint;
this.endpointConfiguration = $.endpointConfiguration;
this.executionArn = $.executionArn;
this.failOnWarnings = $.failOnWarnings;
this.minimumCompressionSize = $.minimumCompressionSize;
this.name = $.name;
this.parameters = $.parameters;
this.policy = $.policy;
this.putRestApiMode = $.putRestApiMode;
this.rootResourceId = $.rootResourceId;
this.tags = $.tags;
this.tagsAll = $.tagsAll;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(RestApiState defaults) {
return new Builder(defaults);
}
public static final class Builder {
private RestApiState $;
public Builder() {
$ = new RestApiState();
}
public Builder(RestApiState defaults) {
$ = new RestApiState(Objects.requireNonNull(defaults));
}
/**
* @param 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-api-key-source.html). If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.
*
* @return builder
*
*/
public Builder apiKeySource(@Nullable Output apiKeySource) {
$.apiKeySource = apiKeySource;
return this;
}
/**
* @param 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-api-key-source.html). If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.
*
* @return builder
*
*/
public Builder apiKeySource(String apiKeySource) {
return apiKeySource(Output.of(apiKeySource));
}
/**
* @param arn ARN
*
* @return builder
*
*/
public Builder arn(@Nullable Output arn) {
$.arn = arn;
return this;
}
/**
* @param arn ARN
*
* @return builder
*
*/
public Builder arn(String arn) {
return arn(Output.of(arn));
}
/**
* @param 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-binary-media-types.html). If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.
*
* @return builder
*
*/
public Builder binaryMediaTypes(@Nullable Output> binaryMediaTypes) {
$.binaryMediaTypes = binaryMediaTypes;
return this;
}
/**
* @param 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-binary-media-types.html). If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.
*
* @return builder
*
*/
public Builder binaryMediaTypes(List binaryMediaTypes) {
return binaryMediaTypes(Output.of(binaryMediaTypes));
}
/**
* @param 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-binary-media-types.html). If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.
*
* @return builder
*
*/
public Builder binaryMediaTypes(String... binaryMediaTypes) {
return binaryMediaTypes(List.of(binaryMediaTypes));
}
/**
* @param 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api.html).
*
* @return builder
*
*/
public Builder body(@Nullable Output body) {
$.body = body;
return this;
}
/**
* @param 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api.html).
*
* @return builder
*
*/
public Builder body(String body) {
return body(Output.of(body));
}
/**
* @param createdDate Creation date of the REST API
*
* @return builder
*
*/
public Builder createdDate(@Nullable Output createdDate) {
$.createdDate = createdDate;
return this;
}
/**
* @param createdDate Creation date of the REST API
*
* @return builder
*
*/
public Builder createdDate(String createdDate) {
return createdDate(Output.of(createdDate));
}
/**
* @param 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.
*
* @return builder
*
*/
public Builder description(@Nullable Output description) {
$.description = description;
return this;
}
/**
* @param 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.
*
* @return builder
*
*/
public Builder description(String description) {
return description(Output.of(description));
}
/**
* @param 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-endpoint-configuration.html). If the argument value is `true` and is different than the OpenAPI value, the argument value will override the OpenAPI value.
*
* @return builder
*
*/
public Builder disableExecuteApiEndpoint(@Nullable Output disableExecuteApiEndpoint) {
$.disableExecuteApiEndpoint = disableExecuteApiEndpoint;
return this;
}
/**
* @param 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-endpoint-configuration.html). If the argument value is `true` and is different than the OpenAPI value, the argument value will override the OpenAPI value.
*
* @return builder
*
*/
public Builder disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint) {
return disableExecuteApiEndpoint(Output.of(disableExecuteApiEndpoint));
}
/**
* @param endpointConfiguration Configuration block defining API endpoint configuration including endpoint type. Defined below.
*
* @return builder
*
*/
public Builder endpointConfiguration(@Nullable Output endpointConfiguration) {
$.endpointConfiguration = endpointConfiguration;
return this;
}
/**
* @param endpointConfiguration Configuration block defining API endpoint configuration including endpoint type. Defined below.
*
* @return builder
*
*/
public Builder endpointConfiguration(RestApiEndpointConfigurationArgs endpointConfiguration) {
return endpointConfiguration(Output.of(endpointConfiguration));
}
/**
* @param executionArn 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.
*
* @return builder
*
*/
public Builder executionArn(@Nullable Output executionArn) {
$.executionArn = executionArn;
return this;
}
/**
* @param executionArn 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.
*
* @return builder
*
*/
public Builder executionArn(String executionArn) {
return executionArn(Output.of(executionArn));
}
/**
* @param failOnWarnings Whether warnings while API Gateway is creating or updating the resource should return an error or not. Defaults to `false`
*
* @return builder
*
*/
public Builder failOnWarnings(@Nullable Output failOnWarnings) {
$.failOnWarnings = failOnWarnings;
return this;
}
/**
* @param failOnWarnings Whether warnings while API Gateway is creating or updating the resource should return an error or not. Defaults to `false`
*
* @return builder
*
*/
public Builder failOnWarnings(Boolean failOnWarnings) {
return failOnWarnings(Output.of(failOnWarnings));
}
/**
* @param 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-openapi-minimum-compression-size.html). If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.
*
* @return builder
*
*/
public Builder minimumCompressionSize(@Nullable Output minimumCompressionSize) {
$.minimumCompressionSize = minimumCompressionSize;
return this;
}
/**
* @param 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-openapi-minimum-compression-size.html). If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.
*
* @return builder
*
*/
public Builder minimumCompressionSize(String minimumCompressionSize) {
return minimumCompressionSize(Output.of(minimumCompressionSize));
}
/**
* @param 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.
*
* @return builder
*
*/
public Builder name(@Nullable Output name) {
$.name = name;
return this;
}
/**
* @param 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.
*
* @return builder
*
*/
public Builder name(String name) {
return name(Output.of(name));
}
/**
* @param 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api.html).
*
* @return builder
*
*/
public Builder parameters(@Nullable Output> parameters) {
$.parameters = parameters;
return this;
}
/**
* @param 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api.html).
*
* @return builder
*
*/
public Builder parameters(Map parameters) {
return parameters(Output.of(parameters));
}
/**
* @param 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/openapi-extensions-policy.html). If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.
*
* @return builder
*
*/
public Builder policy(@Nullable Output policy) {
$.policy = policy;
return this;
}
/**
* @param 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/openapi-extensions-policy.html). If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.
*
* @return builder
*
*/
public Builder policy(String policy) {
return policy(Output.of(policy));
}
/**
* @param 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 unspecificed, defaults to `overwrite` (for backwards compatibility). This corresponds to the [`x-amazon-apigateway-put-integration-method` extension](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-put-integration-method.html). If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.
*
* @return builder
*
*/
public Builder putRestApiMode(@Nullable Output putRestApiMode) {
$.putRestApiMode = putRestApiMode;
return this;
}
/**
* @param 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 unspecificed, defaults to `overwrite` (for backwards compatibility). This corresponds to the [`x-amazon-apigateway-put-integration-method` extension](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-put-integration-method.html). If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.
*
* @return builder
*
*/
public Builder putRestApiMode(String putRestApiMode) {
return putRestApiMode(Output.of(putRestApiMode));
}
/**
* @param rootResourceId Resource ID of the REST API's root
*
* @return builder
*
*/
public Builder rootResourceId(@Nullable Output rootResourceId) {
$.rootResourceId = rootResourceId;
return this;
}
/**
* @param rootResourceId Resource ID of the REST API's root
*
* @return builder
*
*/
public Builder rootResourceId(String rootResourceId) {
return rootResourceId(Output.of(rootResourceId));
}
/**
* @param tags Key-value map of resource tags. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
* @return builder
*
*/
public Builder tags(@Nullable Output> tags) {
$.tags = tags;
return this;
}
/**
* @param tags Key-value map of resource tags. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
* @return builder
*
*/
public Builder tags(Map tags) {
return tags(Output.of(tags));
}
/**
* @param tagsAll Map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
* @return builder
*
* @deprecated
* Please use `tags` instead.
*
*/
@Deprecated /* Please use `tags` instead. */
public Builder tagsAll(@Nullable Output> tagsAll) {
$.tagsAll = tagsAll;
return this;
}
/**
* @param tagsAll Map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
* @return builder
*
* @deprecated
* Please use `tags` instead.
*
*/
@Deprecated /* Please use `tags` instead. */
public Builder tagsAll(Map tagsAll) {
return tagsAll(Output.of(tagsAll));
}
public RestApiState build() {
return $;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy