com.pulumi.gcp.iam.kotlin.PrincipalAccessBoundaryPolicy.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.iam.kotlin
import com.pulumi.core.Output
import com.pulumi.gcp.iam.kotlin.outputs.PrincipalAccessBoundaryPolicyDetails
import com.pulumi.gcp.iam.kotlin.outputs.PrincipalAccessBoundaryPolicyDetails.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
import kotlin.collections.Map
/**
* Builder for [PrincipalAccessBoundaryPolicy].
*/
@PulumiTagMarker
public class PrincipalAccessBoundaryPolicyResourceBuilder internal constructor() {
public var name: String? = null
public var args: PrincipalAccessBoundaryPolicyArgs = PrincipalAccessBoundaryPolicyArgs()
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 PrincipalAccessBoundaryPolicyArgsBuilder.() -> Unit) {
val builder = PrincipalAccessBoundaryPolicyArgsBuilder()
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(): PrincipalAccessBoundaryPolicy {
val builtJavaResource =
com.pulumi.gcp.iam.PrincipalAccessBoundaryPolicy(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return PrincipalAccessBoundaryPolicy(builtJavaResource)
}
}
/**
* An IAM Principal Access Boundary Policy resource
* To get more information about PrincipalAccessBoundaryPolicy, see:
* * [API documentation](https://cloud.google.com/iam/docs/reference/rest/v3/organizations.locations.principalAccessBoundaryPolicies)
* * How-to Guides
* * [Create and apply Principal Access Boundaries](https://cloud.google.com/iam/docs/principal-access-boundary-policies-create)
* ## Example Usage
* ### Iam Principal Access Boundary Policy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const my_pab_policy = new gcp.iam.PrincipalAccessBoundaryPolicy("my-pab-policy", {
* organization: "123456789",
* location: "global",
* displayName: "test pab policy",
* principalAccessBoundaryPolicyId: "test-pab-policy",
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* my_pab_policy = gcp.iam.PrincipalAccessBoundaryPolicy("my-pab-policy",
* organization="123456789",
* location="global",
* display_name="test pab policy",
* principal_access_boundary_policy_id="test-pab-policy")
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var my_pab_policy = new Gcp.Iam.PrincipalAccessBoundaryPolicy("my-pab-policy", new()
* {
* Organization = "123456789",
* Location = "global",
* DisplayName = "test pab policy",
* PrincipalAccessBoundaryPolicyId = "test-pab-policy",
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/iam"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := iam.NewPrincipalAccessBoundaryPolicy(ctx, "my-pab-policy", &iam.PrincipalAccessBoundaryPolicyArgs{
* Organization: pulumi.String("123456789"),
* Location: pulumi.String("global"),
* DisplayName: pulumi.String("test pab policy"),
* PrincipalAccessBoundaryPolicyId: pulumi.String("test-pab-policy"),
* })
* 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.iam.PrincipalAccessBoundaryPolicy;
* import com.pulumi.gcp.iam.PrincipalAccessBoundaryPolicyArgs;
* 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 my_pab_policy = new PrincipalAccessBoundaryPolicy("my-pab-policy", PrincipalAccessBoundaryPolicyArgs.builder()
* .organization("123456789")
* .location("global")
* .displayName("test pab policy")
* .principalAccessBoundaryPolicyId("test-pab-policy")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* my-pab-policy:
* type: gcp:iam:PrincipalAccessBoundaryPolicy
* properties:
* organization: '123456789'
* location: global
* displayName: test pab policy
* principalAccessBoundaryPolicyId: test-pab-policy
* ```
*
* ## Import
* PrincipalAccessBoundaryPolicy can be imported using any of these accepted formats:
* * `organizations/{{organization}}/locations/{{location}}/principalAccessBoundaryPolicies/{{principal_access_boundary_policy_id}}`
* * `{{organization}}/{{location}}/{{principal_access_boundary_policy_id}}`
* When using the `pulumi import` command, PrincipalAccessBoundaryPolicy can be imported using one of the formats above. For example:
* ```sh
* $ pulumi import gcp:iam/principalAccessBoundaryPolicy:PrincipalAccessBoundaryPolicy default organizations/{{organization}}/locations/{{location}}/principalAccessBoundaryPolicies/{{principal_access_boundary_policy_id}}
* ```
* ```sh
* $ pulumi import gcp:iam/principalAccessBoundaryPolicy:PrincipalAccessBoundaryPolicy default {{organization}}/{{location}}/{{principal_access_boundary_policy_id}}
* ```
*/
public class PrincipalAccessBoundaryPolicy internal constructor(
override val javaResource: com.pulumi.gcp.iam.PrincipalAccessBoundaryPolicy,
) : KotlinCustomResource(javaResource, PrincipalAccessBoundaryPolicyMapper) {
/**
* User defined annotations. See https://google.aip.dev/148#annotations
* for more details such as format and size limitations
* **Note**: This field is non-authoritative, and will only manage the annotations present in your configuration.
* Please refer to the field `effective_annotations` for all of the annotations present on the resource.
*/
public val annotations: Output>?
get() = javaResource.annotations().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
/**
* Output only. The time when the principal access boundary policy was created.
*/
public val createTime: Output
get() = javaResource.createTime().applyValue({ args0 -> args0 })
/**
* Principal access boundary policy details
* Structure is documented below.
*/
public val details: Output
get() = javaResource.details().applyValue({ args0 -> args0.let({ args0 -> toKotlin(args0) }) })
/**
* The description of the principal access boundary policy. Must be less than or equal to 63 characters.
*/
public val displayName: Output?
get() = javaResource.displayName().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
public val effectiveAnnotations: Output>
get() = javaResource.effectiveAnnotations().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
/**
* The etag for the principal access boundary. If this is provided on update, it must match the server's etag.
*/
public val etag: Output
get() = javaResource.etag().applyValue({ args0 -> args0 })
/**
* The location the principal access boundary policy is in.
*/
public val location: Output
get() = javaResource.location().applyValue({ args0 -> args0 })
/**
* Identifier. The resource name of the principal access boundary policy. The following format is supported:
* `organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{policy_id}`
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* The parent organization of the principal access boundary policy.
*/
public val organization: Output
get() = javaResource.organization().applyValue({ args0 -> args0 })
/**
* The ID to use to create the principal access boundary policy.
* This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /a-z{2,62}/.
* - - -
*/
public val principalAccessBoundaryPolicyId: Output
get() = javaResource.principalAccessBoundaryPolicyId().applyValue({ args0 -> args0 })
/**
* Output only. The globally unique ID of the principal access boundary policy.
*/
public val uid: Output
get() = javaResource.uid().applyValue({ args0 -> args0 })
/**
* Output only. The time when the principal access boundary policy was most recently updated.
*/
public val updateTime: Output
get() = javaResource.updateTime().applyValue({ args0 -> args0 })
}
public object PrincipalAccessBoundaryPolicyMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.gcp.iam.PrincipalAccessBoundaryPolicy::class == javaResource::class
override fun map(javaResource: Resource): PrincipalAccessBoundaryPolicy =
PrincipalAccessBoundaryPolicy(
javaResource as
com.pulumi.gcp.iam.PrincipalAccessBoundaryPolicy,
)
}
/**
* @see [PrincipalAccessBoundaryPolicy].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [PrincipalAccessBoundaryPolicy].
*/
public suspend fun principalAccessBoundaryPolicy(
name: String,
block: suspend PrincipalAccessBoundaryPolicyResourceBuilder.() -> Unit,
): PrincipalAccessBoundaryPolicy {
val builder = PrincipalAccessBoundaryPolicyResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [PrincipalAccessBoundaryPolicy].
* @param name The _unique_ name of the resulting resource.
*/
public fun principalAccessBoundaryPolicy(name: String): PrincipalAccessBoundaryPolicy {
val builder = PrincipalAccessBoundaryPolicyResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy