com.pulumi.gcp.endpoints.kotlin.ConsumersIamMember.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.endpoints.kotlin
import com.pulumi.core.Output
import com.pulumi.gcp.endpoints.kotlin.outputs.ConsumersIamMemberCondition
import com.pulumi.gcp.endpoints.kotlin.outputs.ConsumersIamMemberCondition.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 [ConsumersIamMember].
*/
@PulumiTagMarker
public class ConsumersIamMemberResourceBuilder internal constructor() {
public var name: String? = null
public var args: ConsumersIamMemberArgs = ConsumersIamMemberArgs()
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 ConsumersIamMemberArgsBuilder.() -> Unit) {
val builder = ConsumersIamMemberArgsBuilder()
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(): ConsumersIamMember {
val builtJavaResource = com.pulumi.gcp.endpoints.ConsumersIamMember(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return ConsumersIamMember(builtJavaResource)
}
}
/**
* Three different resources help you manage your IAM policy for Cloud Endpoints ServiceConsumers. Each of these resources serves a different use case:
* * `gcp.endpoints.ConsumersIamPolicy`: Authoritative. Sets the IAM policy for the serviceconsumers and replaces any existing policy already attached.
* * `gcp.endpoints.ConsumersIamBinding`: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the serviceconsumers are preserved.
* * `gcp.endpoints.ConsumersIamMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the serviceconsumers are preserved.
* A data source can be used to retrieve policy data in advent you do not need creation
* * `gcp.endpoints.ConsumersIamPolicy`: Retrieves the IAM policy for the serviceconsumers
* > **Note:** `gcp.endpoints.ConsumersIamPolicy` **cannot** be used in conjunction with `gcp.endpoints.ConsumersIamBinding` and `gcp.endpoints.ConsumersIamMember` or they will fight over what your policy should be.
* > **Note:** `gcp.endpoints.ConsumersIamBinding` resources **can be** used in conjunction with `gcp.endpoints.ConsumersIamMember` resources **only if** they do not grant privilege to the same role.
* ## Import
* For all import syntaxes, the "resource in question" can take any of the following forms:
* * services/{{service_name}}/consumers/{{consumer_project}}
* * {{service_name}}/{{consumer_project}}
* * {{consumer_project}}
* Any variables not passed in the import command will be taken from the provider configuration.
* Cloud Endpoints serviceconsumers IAM resources can be imported using the resource identifiers, role, and member.
* IAM member imports use space-delimited identifiers: the resource in question, the role, and the member identity, e.g.
* ```sh
* $ pulumi import gcp:endpoints/consumersIamMember:ConsumersIamMember editor "services/{{service_name}}/consumers/{{consumer_project}} roles/servicemanagement.serviceController user:[email protected]"
* ```
* IAM binding imports use space-delimited identifiers: the resource in question and the role, e.g.
* ```sh
* $ pulumi import gcp:endpoints/consumersIamMember:ConsumersIamMember editor "services/{{service_name}}/consumers/{{consumer_project}} roles/servicemanagement.serviceController"
* ```
* IAM policy imports use the identifier of the resource in question, e.g.
* ```sh
* $ pulumi import gcp:endpoints/consumersIamMember:ConsumersIamMember editor services/{{service_name}}/consumers/{{consumer_project}}
* ```
* -> **Custom Roles**: If you're importing a IAM resource with a custom role, make sure to use the
* full name of the custom role, e.g. `[projects/my-project|organizations/my-org]/roles/my-custom-role`.
*/
public class ConsumersIamMember internal constructor(
override val javaResource: com.pulumi.gcp.endpoints.ConsumersIamMember,
) : KotlinCustomResource(javaResource, ConsumersIamMemberMapper) {
public val condition: Output?
get() = javaResource.condition().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
toKotlin(args0)
})
}).orElse(null)
})
public val consumerProject: Output
get() = javaResource.consumerProject().applyValue({ args0 -> args0 })
/**
* (Computed) The etag of the IAM policy.
*/
public val etag: Output
get() = javaResource.etag().applyValue({ args0 -> args0 })
/**
* Identities that will be granted the privilege in `role`.
* Each entry can have one of the following values:
* * **allUsers**: A special identifier that represents anyone who is on the internet; with or without a Google account.
* * **allAuthenticatedUsers**: A special identifier that represents anyone who is authenticated with a Google account or a service account.
* * **user:{emailid}**: An email address that represents a specific Google account. For example, [email protected] or [email protected].
* * **serviceAccount:{emailid}**: An email address that represents a service account. For example, [email protected].
* * **group:{emailid}**: An email address that represents a Google group. For example, [email protected].
* * **domain:{domain}**: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
* * **projectOwner:projectid**: Owners of the given project. For example, "projectOwner:my-example-project"
* * **projectEditor:projectid**: Editors of the given project. For example, "projectEditor:my-example-project"
* * **projectViewer:projectid**: Viewers of the given project. For example, "projectViewer:my-example-project"
*/
public val member: Output
get() = javaResource.member().applyValue({ args0 -> args0 })
/**
* The role that should be applied. Only one
* `gcp.endpoints.ConsumersIamBinding` can be used per role. Note that custom roles must be of the format
* `[projects|organizations]/{parent-name}/roles/{role-name}`.
*/
public val role: Output
get() = javaResource.role().applyValue({ args0 -> args0 })
public val serviceName: Output
get() = javaResource.serviceName().applyValue({ args0 -> args0 })
}
public object ConsumersIamMemberMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.gcp.endpoints.ConsumersIamMember::class == javaResource::class
override fun map(javaResource: Resource): ConsumersIamMember = ConsumersIamMember(
javaResource as
com.pulumi.gcp.endpoints.ConsumersIamMember,
)
}
/**
* @see [ConsumersIamMember].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [ConsumersIamMember].
*/
public suspend fun consumersIamMember(
name: String,
block: suspend ConsumersIamMemberResourceBuilder.() -> Unit,
): ConsumersIamMember {
val builder = ConsumersIamMemberResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [ConsumersIamMember].
* @param name The _unique_ name of the resulting resource.
*/
public fun consumersIamMember(name: String): ConsumersIamMember {
val builder = ConsumersIamMemberResourceBuilder()
builder.name(name)
return builder.build()
}