com.pulumi.awsnative.iam.kotlin.outputs.GetRoleResult.kt Maven / Gradle / Ivy

Go to download
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.awsnative.iam.kotlin.outputs

import com.pulumi.awsnative.kotlin.outputs.Tag
import kotlin.Any
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.collections.List

/**
 *
 * @property arn Returns the Amazon Resource Name (ARN) for the role. For example:
 * `{"Fn::GetAtt" : ["MyRole", "Arn"] }`
 * This will return a value such as `arn:aws:iam::1234567890:role/MyRole-AJJHDSKSDF` .
 * @property assumeRolePolicyDocument The trust policy that is associated with this role. Trust policies define which entities can assume the role. You can associate only one trust policy with a role. For an example of a policy that can be used to assume a role, see [Template Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#aws-resource-iam-role--examples). For more information about the elements that you can use in an IAM policy, see [Policy Elements Reference](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html) in the *User Guide*.
 * Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::IAM::Role` for more information about the expected schema for this property.
 * @property description A description of the role that you provide.
 * @property managedPolicyArns A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role.
 *  For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.
 * @property maxSessionDuration The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.
 *  Anyone who assumes the role from the CLI or API can use the ``DurationSeconds`` API parameter or the ``duration-seconds`` CLI parameter to request a longer session. The ``MaxSessionDuration`` setting determines the maximum duration that can be requested using the ``DurationSeconds`` parameter. If users don't specify a value for the ``DurationSeconds`` parameter, their security credentials are valid for one hour by default. This applies when you use the ``AssumeRole*`` API operations or the ``assume-role*`` CLI operations but does not apply when you use those operations to create a console URL. For more information, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*.
 * @property permissionsBoundary The ARN of the policy used to set the permissions boundary for the role.
 *  For more information about permissions boundaries, see [Permissions boundaries for IAM identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*.
 * @property policies Adds or updates an inline policy document that is embedded in the specified IAM role.
 * When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role. You can update a role's trust policy later. For more information about IAM roles, go to [Using Roles to Delegate Permissions and Federate Identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html) .
 * A role can also have an attached managed policy. For information about policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide* .
 * For information about limits on the number of inline policies that you can embed with a role, see [Limitations on IAM Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *IAM User Guide* .
 * > If an external policy (such as `AWS::IAM::Policy` or `AWS::IAM::ManagedPolicy` ) has a `Ref` to a role and if a resource (such as `AWS::ECS::Service` ) also has a `Ref` to the same role, add a `DependsOn` attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an `AWS::ECS::Service` resource, the `DependsOn` attribute ensures that AWS CloudFormation deletes the `AWS::ECS::Service` resource before deleting its role's policy.
 * @property roleId Returns the stable and unique string identifying the role. For example, `AIDAJQABLZS4A3QDU576Q` .
 * For more information about IDs, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) in the *IAM User Guide* .
 * @property tags A list of tags that are attached to the role. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*.
 */
public data class GetRoleResult(
    public val arn: String? = null,
    public val assumeRolePolicyDocument: Any? = null,
    public val description: String? = null,
    public val managedPolicyArns: List? = null,
    public val maxSessionDuration: Int? = null,
    public val permissionsBoundary: String? = null,
    public val policies: List? = null,
    public val roleId: String? = null,
    public val tags: List? = null,
) {
    public companion object {
        public fun toKotlin(javaType: com.pulumi.awsnative.iam.outputs.GetRoleResult): GetRoleResult =
            GetRoleResult(
                arn = javaType.arn().map({ args0 -> args0 }).orElse(null),
                assumeRolePolicyDocument = javaType.assumeRolePolicyDocument().map({ args0 -> args0 }).orElse(null),
                description = javaType.description().map({ args0 -> args0 }).orElse(null),
                managedPolicyArns = javaType.managedPolicyArns().map({ args0 -> args0 }),
                maxSessionDuration = javaType.maxSessionDuration().map({ args0 -> args0 }).orElse(null),
                permissionsBoundary = javaType.permissionsBoundary().map({ args0 -> args0 }).orElse(null),
                policies = javaType.policies().map({ args0 ->
                    args0.let({ args0 ->
                        com.pulumi.awsnative.iam.kotlin.outputs.RolePolicy.Companion.toKotlin(args0)
                    })
                }),
                roleId = javaType.roleId().map({ args0 -> args0 }).orElse(null),
                tags = javaType.tags().map({ args0 ->
                    args0.let({ args0 ->
                        com.pulumi.awsnative.kotlin.outputs.Tag.Companion.toKotlin(args0)
                    })
                }),
            )
    }
}