All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.gcp.appengine.kotlin.EngineSplitTraffic.kt Maven / Gradle / Ivy

Go to download

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: 8.10.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.gcp.appengine.kotlin

import com.pulumi.core.Output
import com.pulumi.gcp.appengine.kotlin.outputs.EngineSplitTrafficSplit
import com.pulumi.gcp.appengine.kotlin.outputs.EngineSplitTrafficSplit.Companion.toKotlin
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.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit

/**
 * Builder for [EngineSplitTraffic].
 */
@PulumiTagMarker
public class EngineSplitTrafficResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: EngineSplitTrafficArgs = EngineSplitTrafficArgs()

    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 EngineSplitTrafficArgsBuilder.() -> Unit) {
        val builder = EngineSplitTrafficArgsBuilder()
        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(): EngineSplitTraffic {
        val builtJavaResource = com.pulumi.gcp.appengine.EngineSplitTraffic(
            this.name,
            this.args.toJava(),
            this.opts.toJava(),
        )
        return EngineSplitTraffic(builtJavaResource)
    }
}

/**
 * Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.
 * To get more information about ServiceSplitTraffic, see:
 * * [API documentation](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services)
 * ## Example Usage
 * ### App Engine Service Split Traffic
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 * const bucket = new gcp.storage.Bucket("bucket", {
 *     name: "appengine-static-content",
 *     location: "US",
 * });
 * const object = new gcp.storage.BucketObject("object", {
 *     name: "hello-world.zip",
 *     bucket: bucket.name,
 *     source: new pulumi.asset.FileAsset("./test-fixtures/hello-world.zip"),
 * });
 * const liveappV1 = new gcp.appengine.StandardAppVersion("liveapp_v1", {
 *     versionId: "v1",
 *     service: "liveapp",
 *     deleteServiceOnDestroy: true,
 *     runtime: "nodejs20",
 *     entrypoint: {
 *         shell: "node ./app.js",
 *     },
 *     deployment: {
 *         zip: {
 *             sourceUrl: pulumi.interpolate`https://storage.googleapis.com/${bucket.name}/${object.name}`,
 *         },
 *     },
 *     envVariables: {
 *         port: "8080",
 *     },
 * });
 * const liveappV2 = new gcp.appengine.StandardAppVersion("liveapp_v2", {
 *     versionId: "v2",
 *     service: "liveapp",
 *     noopOnDestroy: true,
 *     runtime: "nodejs20",
 *     entrypoint: {
 *         shell: "node ./app.js",
 *     },
 *     deployment: {
 *         zip: {
 *             sourceUrl: pulumi.interpolate`https://storage.googleapis.com/${bucket.name}/${object.name}`,
 *         },
 *     },
 *     envVariables: {
 *         port: "8080",
 *     },
 * });
 * const liveapp = new gcp.appengine.EngineSplitTraffic("liveapp", {
 *     service: liveappV2.service,
 *     migrateTraffic: false,
 *     split: {
 *         shardBy: "IP",
 *         allocations: pulumi.all([liveappV1.versionId, liveappV2.versionId]).apply(([liveappV1VersionId, liveappV2VersionId]) => {
 *             [liveappV1VersionId]: 0.75,
 *             [liveappV2VersionId]: 0.25,
 *         }),
 *     },
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_gcp as gcp
 * bucket = gcp.storage.Bucket("bucket",
 *     name="appengine-static-content",
 *     location="US")
 * object = gcp.storage.BucketObject("object",
 *     name="hello-world.zip",
 *     bucket=bucket.name,
 *     source=pulumi.FileAsset("./test-fixtures/hello-world.zip"))
 * liveapp_v1 = gcp.appengine.StandardAppVersion("liveapp_v1",
 *     version_id="v1",
 *     service="liveapp",
 *     delete_service_on_destroy=True,
 *     runtime="nodejs20",
 *     entrypoint=gcp.appengine.StandardAppVersionEntrypointArgs(
 *         shell="node ./app.js",
 *     ),
 *     deployment=gcp.appengine.StandardAppVersionDeploymentArgs(
 *         zip=gcp.appengine.StandardAppVersionDeploymentZipArgs(
 *             source_url=pulumi.Output.all(bucket.name, object.name).apply(lambda bucketName, objectName: f"https://storage.googleapis.com/{bucket_name}/{object_name}"),
 *         ),
 *     ),
 *     env_variables={
 *         "port": "8080",
 *     })
 * liveapp_v2 = gcp.appengine.StandardAppVersion("liveapp_v2",
 *     version_id="v2",
 *     service="liveapp",
 *     noop_on_destroy=True,
 *     runtime="nodejs20",
 *     entrypoint=gcp.appengine.StandardAppVersionEntrypointArgs(
 *         shell="node ./app.js",
 *     ),
 *     deployment=gcp.appengine.StandardAppVersionDeploymentArgs(
 *         zip=gcp.appengine.StandardAppVersionDeploymentZipArgs(
 *             source_url=pulumi.Output.all(bucket.name, object.name).apply(lambda bucketName, objectName: f"https://storage.googleapis.com/{bucket_name}/{object_name}"),
 *         ),
 *     ),
 *     env_variables={
 *         "port": "8080",
 *     })
 * liveapp = gcp.appengine.EngineSplitTraffic("liveapp",
 *     service=liveapp_v2.service,
 *     migrate_traffic=False,
 *     split=gcp.appengine.EngineSplitTrafficSplitArgs(
 *         shard_by="IP",
 *         allocations=pulumi.Output.all(liveapp_v1.version_id, liveapp_v2.version_id).apply(lambda liveappV1Version_id, liveappV2Version_id: {
 *             liveapp_v1_version_id: 0.75,
 *             liveapp_v2_version_id: 0.25,
 *         }),
 *     ))
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Gcp = Pulumi.Gcp;
 * return await Deployment.RunAsync(() =>
 * {
 *     var bucket = new Gcp.Storage.Bucket("bucket", new()
 *     {
 *         Name = "appengine-static-content",
 *         Location = "US",
 *     });
 *     var @object = new Gcp.Storage.BucketObject("object", new()
 *     {
 *         Name = "hello-world.zip",
 *         Bucket = bucket.Name,
 *         Source = new FileAsset("./test-fixtures/hello-world.zip"),
 *     });
 *     var liveappV1 = new Gcp.AppEngine.StandardAppVersion("liveapp_v1", new()
 *     {
 *         VersionId = "v1",
 *         Service = "liveapp",
 *         DeleteServiceOnDestroy = true,
 *         Runtime = "nodejs20",
 *         Entrypoint = new Gcp.AppEngine.Inputs.StandardAppVersionEntrypointArgs
 *         {
 *             Shell = "node ./app.js",
 *         },
 *         Deployment = new Gcp.AppEngine.Inputs.StandardAppVersionDeploymentArgs
 *         {
 *             Zip = new Gcp.AppEngine.Inputs.StandardAppVersionDeploymentZipArgs
 *             {
 *                 SourceUrl = Output.Tuple(bucket.Name, @object.Name).Apply(values =>
 *                 {
 *                     var bucketName = values.Item1;
 *                     var objectName = values.Item2;
 *                     return $"https://storage.googleapis.com/{bucketName}/{objectName}";
 *                 }),
 *             },
 *         },
 *         EnvVariables =
 *         {
 *             { "port", "8080" },
 *         },
 *     });
 *     var liveappV2 = new Gcp.AppEngine.StandardAppVersion("liveapp_v2", new()
 *     {
 *         VersionId = "v2",
 *         Service = "liveapp",
 *         NoopOnDestroy = true,
 *         Runtime = "nodejs20",
 *         Entrypoint = new Gcp.AppEngine.Inputs.StandardAppVersionEntrypointArgs
 *         {
 *             Shell = "node ./app.js",
 *         },
 *         Deployment = new Gcp.AppEngine.Inputs.StandardAppVersionDeploymentArgs
 *         {
 *             Zip = new Gcp.AppEngine.Inputs.StandardAppVersionDeploymentZipArgs
 *             {
 *                 SourceUrl = Output.Tuple(bucket.Name, @object.Name).Apply(values =>
 *                 {
 *                     var bucketName = values.Item1;
 *                     var objectName = values.Item2;
 *                     return $"https://storage.googleapis.com/{bucketName}/{objectName}";
 *                 }),
 *             },
 *         },
 *         EnvVariables =
 *         {
 *             { "port", "8080" },
 *         },
 *     });
 *     var liveapp = new Gcp.AppEngine.EngineSplitTraffic("liveapp", new()
 *     {
 *         Service = liveappV2.Service,
 *         MigrateTraffic = false,
 *         Split = new Gcp.AppEngine.Inputs.EngineSplitTrafficSplitArgs
 *         {
 *             ShardBy = "IP",
 *             Allocations = Output.Tuple(liveappV1.VersionId, liveappV2.VersionId).Apply(values =>
 *             {
 *                 var liveappV1VersionId = values.Item1;
 *                 var liveappV2VersionId = values.Item2;
 *                 return
 *                 {
 *                     { liveappV1VersionId, 0.75 },
 *                     { liveappV2VersionId, 0.25 },
 *                 };
 *             }),
 *         },
 *     });
 * });
 * ```
 * ```yaml
 * resources:
 *   bucket:
 *     type: gcp:storage:Bucket
 *     properties:
 *       name: appengine-static-content
 *       location: US
 *   object:
 *     type: gcp:storage:BucketObject
 *     properties:
 *       name: hello-world.zip
 *       bucket: ${bucket.name}
 *       source:
 *         fn::FileAsset: ./test-fixtures/hello-world.zip
 *   liveappV1:
 *     type: gcp:appengine:StandardAppVersion
 *     name: liveapp_v1
 *     properties:
 *       versionId: v1
 *       service: liveapp
 *       deleteServiceOnDestroy: true
 *       runtime: nodejs20
 *       entrypoint:
 *         shell: node ./app.js
 *       deployment:
 *         zip:
 *           sourceUrl: https://storage.googleapis.com/${bucket.name}/${object.name}
 *       envVariables:
 *         port: '8080'
 *   liveappV2:
 *     type: gcp:appengine:StandardAppVersion
 *     name: liveapp_v2
 *     properties:
 *       versionId: v2
 *       service: liveapp
 *       noopOnDestroy: true
 *       runtime: nodejs20
 *       entrypoint:
 *         shell: node ./app.js
 *       deployment:
 *         zip:
 *           sourceUrl: https://storage.googleapis.com/${bucket.name}/${object.name}
 *       envVariables:
 *         port: '8080'
 *   liveapp:
 *     type: gcp:appengine:EngineSplitTraffic
 *     properties:
 *       service: ${liveappV2.service}
 *       migrateTraffic: false
 *       split:
 *         shardBy: IP
 *         allocations:
 *           ${liveappV1.versionId}: 0.75
 *           ${liveappV2.versionId}: 0.25
 * ```
 * 
 * ## Import
 * ServiceSplitTraffic can be imported using any of these accepted formats:
 * * `apps/{{project}}/services/{{service}}`
 * * `{{project}}/{{service}}`
 * * `{{service}}`
 * When using the `pulumi import` command, ServiceSplitTraffic can be imported using one of the formats above. For example:
 * ```sh
 * $ pulumi import gcp:appengine/engineSplitTraffic:EngineSplitTraffic default apps/{{project}}/services/{{service}}
 * ```
 * ```sh
 * $ pulumi import gcp:appengine/engineSplitTraffic:EngineSplitTraffic default {{project}}/{{service}}
 * ```
 * ```sh
 * $ pulumi import gcp:appengine/engineSplitTraffic:EngineSplitTraffic default {{service}}
 * ```
 */
public class EngineSplitTraffic internal constructor(
    override val javaResource: com.pulumi.gcp.appengine.EngineSplitTraffic,
) : KotlinCustomResource(javaResource, EngineSplitTrafficMapper) {
    /**
     * If set to true traffic will be migrated to this version.
     */
    public val migrateTraffic: Output?
        get() = javaResource.migrateTraffic().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    public val project: Output
        get() = javaResource.project().applyValue({ args0 -> args0 })

    /**
     * The name of the service these settings apply to.
     */
    public val service: Output
        get() = javaResource.service().applyValue({ args0 -> args0 })

    /**
     * Mapping that defines fractional HTTP traffic diversion to different versions within the service.
     * Structure is documented below.
     */
    public val split: Output
        get() = javaResource.split().applyValue({ args0 -> args0.let({ args0 -> toKotlin(args0) }) })
}

public object EngineSplitTrafficMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.gcp.appengine.EngineSplitTraffic::class == javaResource::class

    override fun map(javaResource: Resource): EngineSplitTraffic = EngineSplitTraffic(
        javaResource as
            com.pulumi.gcp.appengine.EngineSplitTraffic,
    )
}

/**
 * @see [EngineSplitTraffic].
 * @param name The _unique_ name of the resulting resource.
 * @param block Builder for [EngineSplitTraffic].
 */
public suspend fun engineSplitTraffic(
    name: String,
    block: suspend EngineSplitTrafficResourceBuilder.() -> Unit,
): EngineSplitTraffic {
    val builder = EngineSplitTrafficResourceBuilder()
    builder.name(name)
    block(builder)
    return builder.build()
}

/**
 * @see [EngineSplitTraffic].
 * @param name The _unique_ name of the resulting resource.
 */
public fun engineSplitTraffic(name: String): EngineSplitTraffic {
    val builder = EngineSplitTrafficResourceBuilder()
    builder.name(name)
    return builder.build()
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy