com.pulumi.awsnative.apigatewayv2.kotlin.Api.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.apigatewayv2.kotlin
import com.pulumi.awsnative.apigatewayv2.kotlin.outputs.ApiBodyS3Location
import com.pulumi.awsnative.apigatewayv2.kotlin.outputs.ApiCors
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.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.Map
import com.pulumi.awsnative.apigatewayv2.kotlin.outputs.ApiBodyS3Location.Companion.toKotlin as apiBodyS3LocationToKotlin
import com.pulumi.awsnative.apigatewayv2.kotlin.outputs.ApiCors.Companion.toKotlin as apiCorsToKotlin
/**
* Builder for [Api].
*/
@PulumiTagMarker
public class ApiResourceBuilder internal constructor() {
public var name: String? = null
public var args: ApiArgs = ApiArgs()
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 ApiArgsBuilder.() -> Unit) {
val builder = ApiArgsBuilder()
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(): Api {
val builtJavaResource = com.pulumi.awsnative.apigatewayv2.Api(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return Api(builtJavaResource)
}
}
/**
* The ``AWS::ApiGatewayV2::Api`` resource creates an API. WebSocket APIs and HTTP APIs are supported. For more information about WebSocket APIs, see [About WebSocket APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-overview.html) in the *API Gateway Developer Guide*. For more information about HTTP APIs, see [HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html) in the *API Gateway Developer Guide.*
*/
public class Api internal constructor(
override val javaResource: com.pulumi.awsnative.apigatewayv2.Api,
) : KotlinCustomResource(javaResource, ApiMapper) {
/**
* The default endpoint for an API. For example: `https://abcdef.execute-api.us-west-2.amazonaws.com` .
*/
public val apiEndpoint: Output
get() = javaResource.apiEndpoint().applyValue({ args0 -> args0 })
/**
* The API identifier.
*/
public val apiId: Output
get() = javaResource.apiId().applyValue({ args0 -> args0 })
/**
* An API key selection expression. Supported only for WebSocket APIs. See [API Key Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions).
*/
public val apiKeySelectionExpression: Output?
get() = javaResource.apiKeySelectionExpression().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Specifies how to interpret the base path of the API during import. Valid values are ``ignore``, ``prepend``, and ``split``. The default value is ``ignore``. To learn more, see [Set the OpenAPI basePath Property](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html). Supported only for HTTP APIs.
*/
public val basePath: Output?
get() = javaResource.basePath().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* The OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a ``Body`` or ``BodyS3Location``. If you specify a ``Body`` or ``BodyS3Location``, don't specify CloudFormation resources such as ``AWS::ApiGatewayV2::Authorizer`` or ``AWS::ApiGatewayV2::Route``. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::Api` 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 S3 location of an OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a ``Body`` or ``BodyS3Location``. If you specify a ``Body`` or ``BodyS3Location``, don't specify CloudFormation resources such as ``AWS::ApiGatewayV2::Authorizer`` or ``AWS::ApiGatewayV2::Route``. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.
*/
public val bodyS3Location: Output?
get() = javaResource.bodyS3Location().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> apiBodyS3LocationToKotlin(args0) })
}).orElse(null)
})
/**
* A CORS configuration. Supported only for HTTP APIs. See [Configuring CORS](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) for more information.
*/
public val corsConfiguration: Output?
get() = javaResource.corsConfiguration().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> apiCorsToKotlin(args0) })
}).orElse(null)
})
/**
* This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify ``arn:aws:iam::*:user/*``. To use resource-based permissions on supported AWS services, specify ``null``. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.
* */
*/
public val credentialsArn: Output?
get() = javaResource.credentialsArn().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The description of the API.
*/
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)
})
/**
* Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
*/
public val disableSchemaValidation: Output?
get() = javaResource.disableSchemaValidation().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.
*/
public val failOnWarnings: Output?
get() = javaResource.failOnWarnings().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The name of the API. Required unless you specify an OpenAPI definition for ``Body`` or ``S3BodyLocation``.
*/
public val name: Output?
get() = javaResource.name().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* The API protocol. Valid values are ``WEBSOCKET`` or ``HTTP``. Required unless you specify an OpenAPI definition for ``Body`` or ``S3BodyLocation``.
*/
public val protocolType: Output?
get() = javaResource.protocolType().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* This property is part of quick create. If you don't specify a ``routeKey``, a default route of ``$default`` is created. The ``$default`` route acts as a catch-all for any request made to your API, for a particular stage. The ``$default`` route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.
*/
public val routeKey: Output?
get() = javaResource.routeKey().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* The route selection expression for the API. For HTTP APIs, the ``routeSelectionExpression`` must be ``${request.method} ${request.path}``. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
*/
public val routeSelectionExpression: Output?
get() = javaResource.routeSelectionExpression().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The collection of tags. Each tag element is associated with a given resource.
*/
public val tags: Output>?
get() = javaResource.tags().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
/**
* This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.
*/
public val target: Output?
get() = javaResource.target().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* A version identifier for the API.
*/
public val version: Output?
get() = javaResource.version().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
}
public object ApiMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.awsnative.apigatewayv2.Api::class == javaResource::class
override fun map(javaResource: Resource): Api = Api(
javaResource as
com.pulumi.awsnative.apigatewayv2.Api,
)
}
/**
* @see [Api].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [Api].
*/
public suspend fun api(name: String, block: suspend ApiResourceBuilder.() -> Unit): Api {
val builder = ApiResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [Api].
* @param name The _unique_ name of the resulting resource.
*/
public fun api(name: String): Api {
val builder = ApiResourceBuilder()
builder.name(name)
return builder.build()
}