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

com.pulumi.gcp.accesscontextmanager.kotlin.AuthorizedOrgsDesc.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.accesscontextmanager.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
import kotlin.collections.List

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

    public var args: AuthorizedOrgsDescArgs = AuthorizedOrgsDescArgs()

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

/**
 * An authorized organizations description describes a list of organizations
 * (1) that have been authorized to use certain asset (for example, device) data
 * owned by different organizations at the enforcement points, or (2) with certain
 * asset (for example, device) have been authorized to access the resources in
 * another organization at the enforcement points.
 * To get more information about AuthorizedOrgsDesc, see:
 * * [API documentation](https://cloud.google.com/access-context-manager/docs/reference/rest/v1/accessPolicies.authorizedOrgsDescs)
 * * How-to Guides
 *     * [gcloud docs](https://cloud.google.com/beyondcorp-enterprise/docs/cross-org-authorization)
 * > **Warning:** If you are using User ADCs (Application Default Credentials) with this resource,
 * you must specify a `billing_project` and set `user_project_override` to true
 * in the provider configuration. Otherwise the ACM API will return a 403 error.
 * Your account must have the `serviceusage.services.use` permission on the
 * `billing_project` you defined.
 * ## Example Usage
 * ### Access Context Manager Authorized Orgs Desc Basic
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 * const test_access = new gcp.accesscontextmanager.AccessPolicy("test-access", {
 *     parent: "organizations/",
 *     title: "my policy",
 * });
 * const authorized_orgs_desc = new gcp.accesscontextmanager.AuthorizedOrgsDesc("authorized-orgs-desc", {
 *     parent: pulumi.interpolate`accessPolicies/${test_access.name}`,
 *     name: pulumi.interpolate`accessPolicies/${test_access.name}/authorizedOrgsDescs/fakeDescName`,
 *     authorizationType: "AUTHORIZATION_TYPE_TRUST",
 *     assetType: "ASSET_TYPE_CREDENTIAL_STRENGTH",
 *     authorizationDirection: "AUTHORIZATION_DIRECTION_TO",
 *     orgs: [
 *         "organizations/12345",
 *         "organizations/98765",
 *     ],
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_gcp as gcp
 * test_access = gcp.accesscontextmanager.AccessPolicy("test-access",
 *     parent="organizations/",
 *     title="my policy")
 * authorized_orgs_desc = gcp.accesscontextmanager.AuthorizedOrgsDesc("authorized-orgs-desc",
 *     parent=test_access.name.apply(lambda name: f"accessPolicies/{name}"),
 *     name=test_access.name.apply(lambda name: f"accessPolicies/{name}/authorizedOrgsDescs/fakeDescName"),
 *     authorization_type="AUTHORIZATION_TYPE_TRUST",
 *     asset_type="ASSET_TYPE_CREDENTIAL_STRENGTH",
 *     authorization_direction="AUTHORIZATION_DIRECTION_TO",
 *     orgs=[
 *         "organizations/12345",
 *         "organizations/98765",
 *     ])
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Gcp = Pulumi.Gcp;
 * return await Deployment.RunAsync(() =>
 * {
 *     var test_access = new Gcp.AccessContextManager.AccessPolicy("test-access", new()
 *     {
 *         Parent = "organizations/",
 *         Title = "my policy",
 *     });
 *     var authorized_orgs_desc = new Gcp.AccessContextManager.AuthorizedOrgsDesc("authorized-orgs-desc", new()
 *     {
 *         Parent = test_access.Name.Apply(name => $"accessPolicies/{name}"),
 *         Name = test_access.Name.Apply(name => $"accessPolicies/{name}/authorizedOrgsDescs/fakeDescName"),
 *         AuthorizationType = "AUTHORIZATION_TYPE_TRUST",
 *         AssetType = "ASSET_TYPE_CREDENTIAL_STRENGTH",
 *         AuthorizationDirection = "AUTHORIZATION_DIRECTION_TO",
 *         Orgs = new[]
 *         {
 *             "organizations/12345",
 *             "organizations/98765",
 *         },
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"fmt"
 * 	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/accesscontextmanager"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		_, err := accesscontextmanager.NewAccessPolicy(ctx, "test-access", &accesscontextmanager.AccessPolicyArgs{
 * 			Parent: pulumi.String("organizations/"),
 * 			Title:  pulumi.String("my policy"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = accesscontextmanager.NewAuthorizedOrgsDesc(ctx, "authorized-orgs-desc", &accesscontextmanager.AuthorizedOrgsDescArgs{
 * 			Parent: test_access.Name.ApplyT(func(name string) (string, error) {
 * 				return fmt.Sprintf("accessPolicies/%v", name), nil
 * 			}).(pulumi.StringOutput),
 * 			Name: test_access.Name.ApplyT(func(name string) (string, error) {
 * 				return fmt.Sprintf("accessPolicies/%v/authorizedOrgsDescs/fakeDescName", name), nil
 * 			}).(pulumi.StringOutput),
 * 			AuthorizationType:      pulumi.String("AUTHORIZATION_TYPE_TRUST"),
 * 			AssetType:              pulumi.String("ASSET_TYPE_CREDENTIAL_STRENGTH"),
 * 			AuthorizationDirection: pulumi.String("AUTHORIZATION_DIRECTION_TO"),
 * 			Orgs: pulumi.StringArray{
 * 				pulumi.String("organizations/12345"),
 * 				pulumi.String("organizations/98765"),
 * 			},
 * 		})
 * 		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.gcp.accesscontextmanager.AccessPolicy;
 * import com.pulumi.gcp.accesscontextmanager.AccessPolicyArgs;
 * import com.pulumi.gcp.accesscontextmanager.AuthorizedOrgsDesc;
 * import com.pulumi.gcp.accesscontextmanager.AuthorizedOrgsDescArgs;
 * 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 test_access = new AccessPolicy("test-access", AccessPolicyArgs.builder()
 *             .parent("organizations/")
 *             .title("my policy")
 *             .build());
 *         var authorized_orgs_desc = new AuthorizedOrgsDesc("authorized-orgs-desc", AuthorizedOrgsDescArgs.builder()
 *             .parent(test_access.name().applyValue(name -> String.format("accessPolicies/%s", name)))
 *             .name(test_access.name().applyValue(name -> String.format("accessPolicies/%s/authorizedOrgsDescs/fakeDescName", name)))
 *             .authorizationType("AUTHORIZATION_TYPE_TRUST")
 *             .assetType("ASSET_TYPE_CREDENTIAL_STRENGTH")
 *             .authorizationDirection("AUTHORIZATION_DIRECTION_TO")
 *             .orgs(
 *                 "organizations/12345",
 *                 "organizations/98765")
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   authorized-orgs-desc:
 *     type: gcp:accesscontextmanager:AuthorizedOrgsDesc
 *     properties:
 *       parent: accessPolicies/${["test-access"].name}
 *       name: accessPolicies/${["test-access"].name}/authorizedOrgsDescs/fakeDescName
 *       authorizationType: AUTHORIZATION_TYPE_TRUST
 *       assetType: ASSET_TYPE_CREDENTIAL_STRENGTH
 *       authorizationDirection: AUTHORIZATION_DIRECTION_TO
 *       orgs:
 *         - organizations/12345
 *         - organizations/98765
 *   test-access:
 *     type: gcp:accesscontextmanager:AccessPolicy
 *     properties:
 *       parent: organizations/
 *       title: my policy
 * ```
 * 
 * ## Import
 * AuthorizedOrgsDesc can be imported using any of these accepted formats:
 * * `{{name}}`
 * When using the `pulumi import` command, AuthorizedOrgsDesc can be imported using one of the formats above. For example:
 * ```sh
 * $ pulumi import gcp:accesscontextmanager/authorizedOrgsDesc:AuthorizedOrgsDesc default {{name}}
 * ```
 */
public class AuthorizedOrgsDesc internal constructor(
    override val javaResource: com.pulumi.gcp.accesscontextmanager.AuthorizedOrgsDesc,
) : KotlinCustomResource(javaResource, AuthorizedOrgsDescMapper) {
    /**
     * The type of entities that need to use the authorization relationship during
     * evaluation, such as a device. Valid values are "ASSET_TYPE_DEVICE" and
     * "ASSET_TYPE_CREDENTIAL_STRENGTH".
     * Possible values are: `ASSET_TYPE_DEVICE`, `ASSET_TYPE_CREDENTIAL_STRENGTH`.
     */
    public val assetType: Output?
        get() = javaResource.assetType().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })

    /**
     * The direction of the authorization relationship between this organization
     * and the organizations listed in the "orgs" field. The valid values for this
     * field include the following:
     * AUTHORIZATION_DIRECTION_FROM: Allows this organization to evaluate traffic
     * in the organizations listed in the `orgs` field.
     * AUTHORIZATION_DIRECTION_TO: Allows the organizations listed in the `orgs`
     * field to evaluate the traffic in this organization.
     * For the authorization relationship to take effect, all of the organizations
     * must authorize and specify the appropriate relationship direction. For
     * example, if organization A authorized organization B and C to evaluate its
     * traffic, by specifying "AUTHORIZATION_DIRECTION_TO" as the authorization
     * direction, organizations B and C must specify
     * "AUTHORIZATION_DIRECTION_FROM" as the authorization direction in their
     * "AuthorizedOrgsDesc" resource.
     * Possible values are: `AUTHORIZATION_DIRECTION_TO`, `AUTHORIZATION_DIRECTION_FROM`.
     */
    public val authorizationDirection: Output?
        get() = javaResource.authorizationDirection().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * A granular control type for authorization levels. Valid value is "AUTHORIZATION_TYPE_TRUST".
     * Possible values are: `AUTHORIZATION_TYPE_TRUST`.
     */
    public val authorizationType: Output?
        get() = javaResource.authorizationType().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * Time the AuthorizedOrgsDesc was created in UTC.
     */
    public val createTime: Output
        get() = javaResource.createTime().applyValue({ args0 -> args0 })

    /**
     * Resource name for the `AuthorizedOrgsDesc`. Format:
     * `accessPolicies/{access_policy}/authorizedOrgsDescs/{authorized_orgs_desc}`.
     * The `authorized_orgs_desc` component must begin with a letter, followed by
     * alphanumeric characters or `_`.
     * After you create an `AuthorizedOrgsDesc`, you cannot change its `name`.
     * - - -
     */
    public val name: Output
        get() = javaResource.name().applyValue({ args0 -> args0 })

    /**
     * The list of organization ids in this AuthorizedOrgsDesc.
     * Format: `organizations/`
     * Example: `organizations/123456`
     */
    public val orgs: Output>?
        get() = javaResource.orgs().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0
                })
            }).orElse(null)
        })

    /**
     * Required. Resource name for the access policy which owns this `AuthorizedOrgsDesc`.
     */
    public val parent: Output
        get() = javaResource.parent().applyValue({ args0 -> args0 })

    /**
     * Time the AuthorizedOrgsDesc was updated in UTC.
     */
    public val updateTime: Output
        get() = javaResource.updateTime().applyValue({ args0 -> args0 })
}

public object AuthorizedOrgsDescMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.gcp.accesscontextmanager.AuthorizedOrgsDesc::class == javaResource::class

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

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

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




© 2015 - 2024 Weber Informatics LLC | Privacy Policy