com.pulumi.awsnative.apigateway.kotlin.RestApi.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-native-kotlin Show documentation
Show all versions of pulumi-aws-native-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.awsnative.apigateway.kotlin
import com.pulumi.awsnative.apigateway.kotlin.outputs.RestApiEndpointConfiguration
import com.pulumi.awsnative.apigateway.kotlin.outputs.RestApiS3Location
import com.pulumi.awsnative.kotlin.outputs.Tag
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Any
import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
import com.pulumi.awsnative.apigateway.kotlin.outputs.RestApiEndpointConfiguration.Companion.toKotlin as restApiEndpointConfigurationToKotlin
import com.pulumi.awsnative.apigateway.kotlin.outputs.RestApiS3Location.Companion.toKotlin as restApiS3LocationToKotlin
import com.pulumi.awsnative.kotlin.outputs.Tag.Companion.toKotlin as tagToKotlin
/**
* Builder for [RestApi].
*/
@PulumiTagMarker
public class RestApiResourceBuilder internal constructor() {
public var name: String? = null
public var args: RestApiArgs = RestApiArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend RestApiArgsBuilder.() -> Unit) {
val builder = RestApiArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): RestApi {
val builtJavaResource = com.pulumi.awsnative.apigateway.RestApi(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return RestApi(builtJavaResource)
}
}
/**
* The ``AWS::ApiGateway::RestApi`` resource creates a REST API. For more information, see [restapi:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateRestApi.html) in the *Amazon API Gateway REST API Reference*.
* On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/), becoming the foundation of the OpenAPI Specification.
* ## Example Usage
* ### Example
* No Java example available.
* ### Example
* No Java example available.
* ### Example
* No Java example available.
* ### Example
* No Java example available.
* ### Example
* No Java example available.
* ### Example
* No Java example available.
* ### Example
* No Java example available.
* ### Example
* No Java example available.
* ### Example
* No Java example available.
* ### Example
* No Java example available.
* ### Example
* No Java example available.
* ### Example
* No Java example available.
* ### Example
* No Java example available.
* ### Example
* No Java example available.
* ### Example
* No Java example available.
* ### Example
* No Java example available.
*/
public class RestApi internal constructor(
override val javaResource: com.pulumi.awsnative.apigateway.RestApi,
) : KotlinCustomResource(javaResource, RestApiMapper) {
/**
* The source of the API key for metering requests according to a usage plan. Valid values are: ``HEADER`` to read the API key from the ``X-API-Key`` header of a request. ``AUTHORIZER`` to read the API key from the ``UsageIdentifierKey`` from a custom authorizer.
*/
public val apiKeySourceType: Output?
get() = javaResource.apiKeySourceType().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
*/
public val binaryMediaTypes: Output>?
get() = javaResource.binaryMediaTypes().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 -> args0 })
}).orElse(null)
})
/**
* An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::RestApi` for more information about the expected schema for this property.
*/
public val body: Output?
get() = javaResource.body().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format.
*/
public val bodyS3Location: Output?
get() = javaResource.bodyS3Location().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> restApiS3LocationToKotlin(args0) })
}).orElse(null)
})
/**
* The ID of the RestApi that you want to clone from.
*/
public val cloneFrom: Output?
get() = javaResource.cloneFrom().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* The description of the RestApi.
*/
public val description: Output?
get() = javaResource.description().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Specifies 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
*/
public val disableExecuteApiEndpoint: Output?
get() = javaResource.disableExecuteApiEndpoint().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the ``Parameters`` property.
*/
public val endpointConfiguration: Output?
get() = javaResource.endpointConfiguration().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> restApiEndpointConfigurationToKotlin(args0) })
}).orElse(null)
})
/**
* A query parameter to indicate whether to rollback the API update (``true``) or not (``false``) when a warning is encountered. The default value is ``false``.
*/
public val failOnWarnings: Output?
get() = javaResource.failOnWarnings().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
*/
public val minimumCompressionSize: Output?
get() = javaResource.minimumCompressionSize().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* This property applies only when you use OpenAPI to define your REST API. The ``Mode`` determines how API Gateway handles resource updates.
* Valid values are ``overwrite`` or ``merge``.
* For ``overwrite``, the new API definition replaces the existing one. The existing API identifier remains unchanged.
* For ``merge``, the new API definition is merged with the existing API.
* If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is ``overwrite``. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API.
* Use the default mode to define top-level ``RestApi`` properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
*/
public val mode: Output?
get() = javaResource.mode().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
*/
public val name: Output?
get() = javaResource.name().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ``ignore=documentation`` as a ``parameters`` value, as in the AWS CLI command of ``aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'``.
*/
public val parameters: Output>?
get() = javaResource.parameters().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
/**
* A policy document that contains the permissions for the ``RestApi`` resource. To set the ARN for the policy, use the ``!Join`` intrinsic function with ``""`` as delimiter and values of ``"execute-api:/"`` and ``"*"``.
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::RestApi` for more information about the expected schema for this property.
*/
public val policy: Output?
get() = javaResource.policy().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* The string identifier of the associated RestApi.
*/
public val restApiId: Output
get() = javaResource.restApiId().applyValue({ args0 -> args0 })
/**
* The root resource ID for a `RestApi` resource, such as `a0bc123d4e` .
*/
public val rootResourceId: Output
get() = javaResource.rootResourceId().applyValue({ args0 -> args0 })
/**
* The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ``aws:``. The tag value can be up to 256 characters.
*/
public val tags: Output>?
get() = javaResource.tags().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> tagToKotlin(args0) })
})
}).orElse(null)
})
}
public object RestApiMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.awsnative.apigateway.RestApi::class == javaResource::class
override fun map(javaResource: Resource): RestApi = RestApi(
javaResource as
com.pulumi.awsnative.apigateway.RestApi,
)
}
/**
* @see [RestApi].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [RestApi].
*/
public suspend fun restApi(name: String, block: suspend RestApiResourceBuilder.() -> Unit): RestApi {
val builder = RestApiResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [RestApi].
* @param name The _unique_ name of the resulting resource.
*/
public fun restApi(name: String): RestApi {
val builder = RestApiResourceBuilder()
builder.name(name)
return builder.build()
}