1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. iam
  6. getRole
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.iam.getRole

volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Data Source schema for Volcengine::IAM::Role

    Using getRole

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRole(args: GetRoleArgs, opts?: InvokeOptions): Promise<GetRoleResult>
function getRoleOutput(args: GetRoleOutputArgs, opts?: InvokeOptions): Output<GetRoleResult>
    def get_role(id: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetRoleResult
def get_role_output(id: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetRoleResult]
    func LookupRole(ctx *Context, args *LookupRoleArgs, opts ...InvokeOption) (*LookupRoleResult, error)
func LookupRoleOutput(ctx *Context, args *LookupRoleOutputArgs, opts ...InvokeOption) LookupRoleResultOutput

    > Note: This function is named LookupRole in the Go SDK.

    public static class GetRole 
{
    public static Task<GetRoleResult> InvokeAsync(GetRoleArgs args, InvokeOptions? opts = null)
    public static Output<GetRoleResult> Invoke(GetRoleInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRoleResult> getRole(GetRoleArgs args, InvokeOptions options)
public static Output<GetRoleResult> getRole(GetRoleArgs args, InvokeOptions options)

    fn::invoke:
  function: volcenginecc:iam/getRole:getRole
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getRole Result

    The following output properties are available:

    CreateDate string
    Role creation time
    Description string
    Role description, maximum length 128
    DisplayName string
    Role display name, maximum length 64
    Id string
    Uniquely identifies the resource.
    IsServiceLinkedRole int
    Service-linked role or not: 0 for No, 1 for Yes
    MaxSessionDuration int
    Maximum session duration for the role. Maximum session duration for the role. Limits the maximum validity period of temporary security credentials generated by role assumption. Value range: 3600–43200, unit: seconds, default is 43200
    Policies List<Volcengine.GetRolePolicy>
    RoleId int
    Role ID
    RoleName string
    Role name, length 1–64, supports English letters, numbers, and .-_ characters
    Tags List<Volcengine.GetRoleTag>
    Trn string
    Role TRN
    TrustPolicyDocument string
    Role trust policy. The trust policy follows resource-based policy rules in IAM policy syntax.
    UpdateDate string
    Role update time
    CreateDate string
    Role creation time
    Description string
    Role description, maximum length 128
    DisplayName string
    Role display name, maximum length 64
    Id string
    Uniquely identifies the resource.
    IsServiceLinkedRole int
    Service-linked role or not: 0 for No, 1 for Yes
    MaxSessionDuration int
    Maximum session duration for the role. Maximum session duration for the role. Limits the maximum validity period of temporary security credentials generated by role assumption. Value range: 3600–43200, unit: seconds, default is 43200
    Policies []GetRolePolicy
    RoleId int
    Role ID
    RoleName string
    Role name, length 1–64, supports English letters, numbers, and .-_ characters
    Tags []GetRoleTag
    Trn string
    Role TRN
    TrustPolicyDocument string
    Role trust policy. The trust policy follows resource-based policy rules in IAM policy syntax.
    UpdateDate string
    Role update time
    createDate String
    Role creation time
    description String
    Role description, maximum length 128
    displayName String
    Role display name, maximum length 64
    id String
    Uniquely identifies the resource.
    isServiceLinkedRole Integer
    Service-linked role or not: 0 for No, 1 for Yes
    maxSessionDuration Integer
    Maximum session duration for the role. Maximum session duration for the role. Limits the maximum validity period of temporary security credentials generated by role assumption. Value range: 3600–43200, unit: seconds, default is 43200
    policies List<GetRolePolicy>
    roleId Integer
    Role ID
    roleName String
    Role name, length 1–64, supports English letters, numbers, and .-_ characters
    tags List<GetRoleTag>
    trn String
    Role TRN
    trustPolicyDocument String
    Role trust policy. The trust policy follows resource-based policy rules in IAM policy syntax.
    updateDate String
    Role update time
    createDate string
    Role creation time
    description string
    Role description, maximum length 128
    displayName string
    Role display name, maximum length 64
    id string
    Uniquely identifies the resource.
    isServiceLinkedRole number
    Service-linked role or not: 0 for No, 1 for Yes
    maxSessionDuration number
    Maximum session duration for the role. Maximum session duration for the role. Limits the maximum validity period of temporary security credentials generated by role assumption. Value range: 3600–43200, unit: seconds, default is 43200
    policies GetRolePolicy[]
    roleId number
    Role ID
    roleName string
    Role name, length 1–64, supports English letters, numbers, and .-_ characters
    tags GetRoleTag[]
    trn string
    Role TRN
    trustPolicyDocument string
    Role trust policy. The trust policy follows resource-based policy rules in IAM policy syntax.
    updateDate string
    Role update time
    create_date str
    Role creation time
    description str
    Role description, maximum length 128
    display_name str
    Role display name, maximum length 64
    id str
    Uniquely identifies the resource.
    is_service_linked_role int
    Service-linked role or not: 0 for No, 1 for Yes
    max_session_duration int
    Maximum session duration for the role. Maximum session duration for the role. Limits the maximum validity period of temporary security credentials generated by role assumption. Value range: 3600–43200, unit: seconds, default is 43200
    policies Sequence[GetRolePolicy]
    role_id int
    Role ID
    role_name str
    Role name, length 1–64, supports English letters, numbers, and .-_ characters
    tags Sequence[GetRoleTag]
    trn str
    Role TRN
    trust_policy_document str
    Role trust policy. The trust policy follows resource-based policy rules in IAM policy syntax.
    update_date str
    Role update time
    createDate String
    Role creation time
    description String
    Role description, maximum length 128
    displayName String
    Role display name, maximum length 64
    id String
    Uniquely identifies the resource.
    isServiceLinkedRole Number
    Service-linked role or not: 0 for No, 1 for Yes
    maxSessionDuration Number
    Maximum session duration for the role. Maximum session duration for the role. Limits the maximum validity period of temporary security credentials generated by role assumption. Value range: 3600–43200, unit: seconds, default is 43200
    policies List<Property Map>
    roleId Number
    Role ID
    roleName String
    Role name, length 1–64, supports English letters, numbers, and .-_ characters
    tags List<Property Map>
    trn String
    Role TRN
    trustPolicyDocument String
    Role trust policy. The trust policy follows resource-based policy rules in IAM policy syntax.
    updateDate String
    Role update time

    Supporting Types

    GetRolePolicy

    PolicyName string
    Policy name
    PolicyType string
    Policy type. Policy type. System indicates a system preset policy; Custom indicates a custom policy.
    PolicyName string
    Policy name
    PolicyType string
    Policy type. Policy type. System indicates a system preset policy; Custom indicates a custom policy.
    policyName String
    Policy name
    policyType String
    Policy type. Policy type. System indicates a system preset policy; Custom indicates a custom policy.
    policyName string
    Policy name
    policyType string
    Policy type. Policy type. System indicates a system preset policy; Custom indicates a custom policy.
    policy_name str
    Policy name
    policy_type str
    Policy type. Policy type. System indicates a system preset policy; Custom indicates a custom policy.
    policyName String
    Policy name
    policyType String
    Policy type. Policy type. System indicates a system preset policy; Custom indicates a custom policy.

    GetRoleTag

    Key string
    Tag key
    Value string
    Tag value
    Key string
    Tag key
    Value string
    Tag value
    key String
    Tag key
    value String
    Tag value
    key string
    Tag key
    value string
    Tag value
    key str
    Tag key
    value str
    Tag value
    key String
    Tag key
    value String
    Tag value

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.