com.pulumi.awsnative.apigateway.kotlin.outputs.GetRestApiResult.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
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
There is a newer version: 1.24.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.awsnative.apigateway.kotlin.outputs

import com.pulumi.awsnative.kotlin.outputs.Tag
import kotlin.Any
import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.collections.List

/**
 *
 * @property apiKeySourceType 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.
 * @property binaryMediaTypes The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
 * @property description The description of the RestApi.
 * @property disableExecuteApiEndpoint 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
 * @property endpointConfiguration 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.
 * @property minimumCompressionSize 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.
 * @property name The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
 * @property policy 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.
 * @property restApiId The string identifier of the associated RestApi.
 * @property rootResourceId The root resource ID for a `RestApi` resource, such as `a0bc123d4e` .
 * @property tags 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 data class GetRestApiResult(
    public val apiKeySourceType: String? = null,
    public val binaryMediaTypes: List? = null,
    public val description: String? = null,
    public val disableExecuteApiEndpoint: Boolean? = null,
    public val endpointConfiguration: RestApiEndpointConfiguration? = null,
    public val minimumCompressionSize: Int? = null,
    public val name: String? = null,
    public val policy: Any? = null,
    public val restApiId: String? = null,
    public val rootResourceId: String? = null,
    public val tags: List? = null,
) {
    public companion object {
        public fun toKotlin(javaType: com.pulumi.awsnative.apigateway.outputs.GetRestApiResult): GetRestApiResult = GetRestApiResult(
            apiKeySourceType = javaType.apiKeySourceType().map({ args0 -> args0 }).orElse(null),
            binaryMediaTypes = javaType.binaryMediaTypes().map({ args0 -> args0 }),
            description = javaType.description().map({ args0 -> args0 }).orElse(null),
            disableExecuteApiEndpoint = javaType.disableExecuteApiEndpoint().map({ args0 ->
                args0
            }).orElse(null),
            endpointConfiguration = javaType.endpointConfiguration().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.apigateway.kotlin.outputs.RestApiEndpointConfiguration.Companion.toKotlin(args0)
                })
            }).orElse(null),
            minimumCompressionSize = javaType.minimumCompressionSize().map({ args0 -> args0 }).orElse(null),
            name = javaType.name().map({ args0 -> args0 }).orElse(null),
            policy = javaType.policy().map({ args0 -> args0 }).orElse(null),
            restApiId = javaType.restApiId().map({ args0 -> args0 }).orElse(null),
            rootResourceId = javaType.rootResourceId().map({ args0 -> args0 }).orElse(null),
            tags = javaType.tags().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.kotlin.outputs.Tag.Companion.toKotlin(args0)
                })
            }),
        )
    }
}