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

com.pulumi.azure.apimanagement.kotlin.PolicyFragment.kt Maven / Gradle / Ivy

@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.azure.apimanagement.kotlin

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.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit

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

    public var args: PolicyFragmentArgs = PolicyFragmentArgs()

    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 PolicyFragmentArgsBuilder.() -> Unit) {
        val builder = PolicyFragmentArgsBuilder()
        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(): PolicyFragment {
        val builtJavaResource = com.pulumi.azure.apimanagement.PolicyFragment(
            this.name,
            this.args.toJava(),
            this.opts.toJava(),
        )
        return PolicyFragment(builtJavaResource)
    }
}

/**
 * Manages an Api Management Policy Fragment.
 * ## Example Usage
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azure from "@pulumi/azure";
 * import * as std from "@pulumi/std";
 * const example = new azure.core.ResourceGroup("example", {
 *     name: "example-resources",
 *     location: "West Europe",
 * });
 * const exampleService = new azure.apimanagement.Service("example", {
 *     name: "example-apim",
 *     location: example.location,
 *     resourceGroupName: example.name,
 *     publisherName: "pub1",
 *     publisherEmail: "[email protected]",
 *     skuName: "Developer_1",
 * });
 * const examplePolicyFragment = new azure.apimanagement.PolicyFragment("example", {
 *     apiManagementId: exampleService.id,
 *     name: "example-policy-fragment",
 *     format: "xml",
 *     value: std.file({
 *         input: "policy-fragment-1.xml",
 *     }).then(invoke => invoke.result),
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_azure as azure
 * import pulumi_std as std
 * example = azure.core.ResourceGroup("example",
 *     name="example-resources",
 *     location="West Europe")
 * example_service = azure.apimanagement.Service("example",
 *     name="example-apim",
 *     location=example.location,
 *     resource_group_name=example.name,
 *     publisher_name="pub1",
 *     publisher_email="[email protected]",
 *     sku_name="Developer_1")
 * example_policy_fragment = azure.apimanagement.PolicyFragment("example",
 *     api_management_id=example_service.id,
 *     name="example-policy-fragment",
 *     format="xml",
 *     value=std.file(input="policy-fragment-1.xml").result)
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Azure = Pulumi.Azure;
 * using Std = Pulumi.Std;
 * return await Deployment.RunAsync(() =>
 * {
 *     var example = new Azure.Core.ResourceGroup("example", new()
 *     {
 *         Name = "example-resources",
 *         Location = "West Europe",
 *     });
 *     var exampleService = new Azure.ApiManagement.Service("example", new()
 *     {
 *         Name = "example-apim",
 *         Location = example.Location,
 *         ResourceGroupName = example.Name,
 *         PublisherName = "pub1",
 *         PublisherEmail = "[email protected]",
 *         SkuName = "Developer_1",
 *     });
 *     var examplePolicyFragment = new Azure.ApiManagement.PolicyFragment("example", new()
 *     {
 *         ApiManagementId = exampleService.Id,
 *         Name = "example-policy-fragment",
 *         Format = "xml",
 *         Value = Std.File.Invoke(new()
 *         {
 *             Input = "policy-fragment-1.xml",
 *         }).Apply(invoke => invoke.Result),
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/apimanagement"
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
 * 	"github.com/pulumi/pulumi-std/sdk/go/std"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
 * 			Name:     pulumi.String("example-resources"),
 * 			Location: pulumi.String("West Europe"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		exampleService, err := apimanagement.NewService(ctx, "example", &apimanagement.ServiceArgs{
 * 			Name:              pulumi.String("example-apim"),
 * 			Location:          example.Location,
 * 			ResourceGroupName: example.Name,
 * 			PublisherName:     pulumi.String("pub1"),
 * 			PublisherEmail:    pulumi.String("[email protected]"),
 * 			SkuName:           pulumi.String("Developer_1"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		invokeFile, err := std.File(ctx, &std.FileArgs{
 * 			Input: "policy-fragment-1.xml",
 * 		}, nil)
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = apimanagement.NewPolicyFragment(ctx, "example", &apimanagement.PolicyFragmentArgs{
 * 			ApiManagementId: exampleService.ID(),
 * 			Name:            pulumi.String("example-policy-fragment"),
 * 			Format:          pulumi.String("xml"),
 * 			Value:           pulumi.String(invokeFile.Result),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		return nil
 * 	})
 * }
 * ```
 * ```java
 * package generated_program;
 * import com.pulumi.Context;
 * import com.pulumi.Pulumi;
 * import com.pulumi.core.Output;
 * import com.pulumi.azure.core.ResourceGroup;
 * import com.pulumi.azure.core.ResourceGroupArgs;
 * import com.pulumi.azure.apimanagement.Service;
 * import com.pulumi.azure.apimanagement.ServiceArgs;
 * import com.pulumi.azure.apimanagement.PolicyFragment;
 * import com.pulumi.azure.apimanagement.PolicyFragmentArgs;
 * import java.util.List;
 * import java.util.ArrayList;
 * import java.util.Map;
 * import java.io.File;
 * import java.nio.file.Files;
 * import java.nio.file.Paths;
 * public class App {
 *     public static void main(String[] args) {
 *         Pulumi.run(App::stack);
 *     }
 *     public static void stack(Context ctx) {
 *         var example = new ResourceGroup("example", ResourceGroupArgs.builder()
 *             .name("example-resources")
 *             .location("West Europe")
 *             .build());
 *         var exampleService = new Service("exampleService", ServiceArgs.builder()
 *             .name("example-apim")
 *             .location(example.location())
 *             .resourceGroupName(example.name())
 *             .publisherName("pub1")
 *             .publisherEmail("[email protected]")
 *             .skuName("Developer_1")
 *             .build());
 *         var examplePolicyFragment = new PolicyFragment("examplePolicyFragment", PolicyFragmentArgs.builder()
 *             .apiManagementId(exampleService.id())
 *             .name("example-policy-fragment")
 *             .format("xml")
 *             .value(StdFunctions.file(FileArgs.builder()
 *                 .input("policy-fragment-1.xml")
 *                 .build()).result())
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   example:
 *     type: azure:core:ResourceGroup
 *     properties:
 *       name: example-resources
 *       location: West Europe
 *   exampleService:
 *     type: azure:apimanagement:Service
 *     name: example
 *     properties:
 *       name: example-apim
 *       location: ${example.location}
 *       resourceGroupName: ${example.name}
 *       publisherName: pub1
 *       publisherEmail: [email protected]
 *       skuName: Developer_1
 *   examplePolicyFragment:
 *     type: azure:apimanagement:PolicyFragment
 *     name: example
 *     properties:
 *       apiManagementId: ${exampleService.id}
 *       name: example-policy-fragment
 *       format: xml
 *       value:
 *         fn::invoke:
 *           Function: std:file
 *           Arguments:
 *             input: policy-fragment-1.xml
 *           Return: result
 * ```
 * 
 * ## Import
 * Api Management Policy Fragments can be imported using the `resource id`, e.g.
 * ```sh
 * $ pulumi import azure:apimanagement/policyFragment:PolicyFragment example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ApiManagement/service/instance1/policyFragments/policyFragment1
 * ```
 */
public class PolicyFragment internal constructor(
    override val javaResource: com.pulumi.azure.apimanagement.PolicyFragment,
) : KotlinCustomResource(javaResource, PolicyFragmentMapper) {
    /**
     * The id of the API Management Service. Changing this forces a new Api Management Policy Fragment to be created.
     */
    public val apiManagementId: Output
        get() = javaResource.apiManagementId().applyValue({ args0 -> args0 })

    /**
     * The description for the Policy Fragment.
     */
    public val description: Output?
        get() = javaResource.description().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * The format of the Policy Fragment. Possible values are `xml` or `rawxml`. Default is `xml`.
     * > **NOTE:** The `value` property will be updated to reflect the corresponding format when `format` is updated.
     */
    public val format: Output?
        get() = javaResource.format().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })

    /**
     * The name which should be used for this Api Management Policy Fragment. Changing this forces a new Api Management Policy Fragment to be created.
     */
    public val name: Output
        get() = javaResource.name().applyValue({ args0 -> args0 })

    /**
     * The value of the Policy Fragment.
     * > **NOTE:** Be aware of the two format possibilities. If the `value` is not applied and continues to cause a diff the format could be wrong.
     */
    public val `value`: Output
        get() = javaResource.`value`().applyValue({ args0 -> args0 })
}

public object PolicyFragmentMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.azure.apimanagement.PolicyFragment::class == javaResource::class

    override fun map(javaResource: Resource): PolicyFragment = PolicyFragment(
        javaResource as
            com.pulumi.azure.apimanagement.PolicyFragment,
    )
}

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

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




© 2015 - 2024 Weber Informatics LLC | Privacy Policy