com.pulumi.googlenative.iam.v1.kotlin.outputs.GetProviderResult.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-google-native-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
The newest version!
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.googlenative.iam.v1.kotlin.outputs

import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.collections.Map

/**
 *
 * @property attributeCondition [A Common Expression Language](https://opensource.google/projects/cel) expression, in plain text, to restrict what otherwise valid authentication credentials issued by the provider should not be accepted. The expression must output a boolean representing whether to allow the federation. The following keywords may be referenced in the expressions: * `assertion`: JSON representing the authentication credential issued by the provider. * `google`: The Google attributes mapped from the assertion in the `attribute_mappings`. * `attribute`: The custom attributes mapped from the assertion in the `attribute_mappings`. The maximum length of the attribute condition expression is 4096 characters. If unspecified, all valid authentication credential are accepted. The following example shows how to only allow credentials with a mapped `google.groups` value of `admins`: ``` "'admins' in google.groups" ```
 * @property attributeMapping Maps attributes from authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. Cannot exceed 127 bytes. * `google.groups`: Groups the external identity belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where `{custom_attribute}` is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workload to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 8KB. For AWS providers, if no attribute mapping is defined, the following default mapping applies: ``` { "google.subject":"assertion.arn", "attribute.aws_role": "assertion.arn.contains('assumed-role')" " ? assertion.arn.extract('{account_arn}assumed-role/')" " + 'assumed-role/'" " + assertion.arn.extract('assumed-role/{role_name}/')" " : assertion.arn", } ``` If any custom attribute mappings are defined, they must include a mapping to the `google.subject` attribute. For OIDC providers, you must supply a custom mapping, which must include the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {"google.subject": "assertion.sub"} ```
 * @property aws An Amazon Web Services identity provider.
 * @property description A description for the provider. Cannot exceed 256 characters.
 * @property disabled Whether the provider is disabled. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access.
 * @property displayName A display name for the provider. Cannot exceed 32 characters.
 * @property name The resource name of the provider.
 * @property oidc An OpenId Connect 1.0 identity provider.
 * @property saml An SAML 2.0 identity provider.
 * @property state The state of the provider.
 */
public data class GetProviderResult(
    public val attributeCondition: String,
    public val attributeMapping: Map,
    public val aws: AwsResponse,
    public val description: String,
    public val disabled: Boolean,
    public val displayName: String,
    public val name: String,
    public val oidc: OidcResponse,
    public val saml: SamlResponse,
    public val state: String,
) {
    public companion object {
        public fun toKotlin(javaType: com.pulumi.googlenative.iam.v1.outputs.GetProviderResult): GetProviderResult = GetProviderResult(
            attributeCondition = javaType.attributeCondition(),
            attributeMapping = javaType.attributeMapping().map({ args0 -> args0.key.to(args0.value) }).toMap(),
            aws = javaType.aws().let({ args0 ->
                com.pulumi.googlenative.iam.v1.kotlin.outputs.AwsResponse.Companion.toKotlin(args0)
            }),
            description = javaType.description(),
            disabled = javaType.disabled(),
            displayName = javaType.displayName(),
            name = javaType.name(),
            oidc = javaType.oidc().let({ args0 ->
                com.pulumi.googlenative.iam.v1.kotlin.outputs.OidcResponse.Companion.toKotlin(args0)
            }),
            saml = javaType.saml().let({ args0 ->
                com.pulumi.googlenative.iam.v1.kotlin.outputs.SamlResponse.Companion.toKotlin(args0)
            }),
            state = javaType.state(),
        )
    }
}