getRole

bytepluscc v0.0.31, Jun 1 26

Viewing docs for bytepluscc v0.0.31
published on Monday, Jun 1, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Viewing docs for bytepluscc v0.0.31
published on Monday, Jun 1, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

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: pulumi.Input[Optional[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: bytepluscc:iam/getRole:getRole
  arguments:
    # arguments dictionary

data "bytepluscc_iam_getrole" "name" {
    # arguments
}

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 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<Byteplus.GetRolePolicy>: Role Strategy
RoleId int: Role ID
RoleName string: Role name, length 1–64, supports English letters, numbers, and .-_ characters
ServiceName string: Service associated with the service-linked role to be created.
Tags List<Byteplus.GetRoleTag>: Tag
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: Role Strategy
RoleId int: Role ID
RoleName string: Role name, length 1–64, supports English letters, numbers, and .-_ characters
ServiceName string: Service associated with the service-linked role to be created.
Tags []GetRoleTag: Tag
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 string: Role creation time
description string: Role description, maximum length 128
display_name string: Role display name, maximum length 64
id string: Uniquely identifies the resource.
is_service_linked_role number: Service-linked role or not: 0 for No, 1 for Yes
max_session_duration 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(object): Role Strategy
role_id number: Role ID
role_name string: Role name, length 1–64, supports English letters, numbers, and .-_ characters
service_name string: Service associated with the service-linked role to be created.
tags list(object): Tag
trn string: Role TRN
trust_policy_document string: Role trust policy. The trust policy follows resource-based policy rules in IAM policy syntax.
update_date 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>: Role Strategy
roleId Integer: Role ID
roleName String: Role name, length 1–64, supports English letters, numbers, and .-_ characters
serviceName String: Service associated with the service-linked role to be created.
tags List<GetRoleTag>: Tag
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[]: Role Strategy
roleId number: Role ID
roleName string: Role name, length 1–64, supports English letters, numbers, and .-_ characters
serviceName string: Service associated with the service-linked role to be created.
tags GetRoleTag[]: Tag
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 Strategy
role_id int: Role ID
role_name str: Role name, length 1–64, supports English letters, numbers, and .-_ characters
service_name str: Service associated with the service-linked role to be created.
tags Sequence[GetRoleTag]: Tag
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>: Role Strategy
roleId Number: Role ID
roleName String: Role name, length 1–64, supports English letters, numbers, and .-_ characters
serviceName String: Service associated with the service-linked role to be created.
tags List<Property Map>: Tag
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

AttachDate string: Policy binding time.
Description string: Policy description.
PolicyName string: Policy name
PolicyScopes List<Byteplus.GetRolePolicyPolicyScope>: Policy authorization scope, specifically refers to the project scope.
PolicyTrn string: Policy TRN.
PolicyType string: Policy type. Policy type. System indicates a system preset policy; Custom indicates a custom policy.

AttachDate string: Policy binding time.
Description string: Policy description.
PolicyName string: Policy name
PolicyScopes []GetRolePolicyPolicyScope: Policy authorization scope, specifically refers to the project scope.
PolicyTrn string: Policy TRN.
PolicyType string: Policy type. Policy type. System indicates a system preset policy; Custom indicates a custom policy.

attach_date string: Policy binding time.
description string: Policy description.
policy_name string: Policy name
policy_scopes list(object): Policy authorization scope, specifically refers to the project scope.
policy_trn string: Policy TRN.
policy_type string: Policy type. Policy type. System indicates a system preset policy; Custom indicates a custom policy.

attachDate String: Policy binding time.
description String: Policy description.
policyName String: Policy name
policyScopes List<GetRolePolicyPolicyScope>: Policy authorization scope, specifically refers to the project scope.
policyTrn String: Policy TRN.
policyType String: Policy type. Policy type. System indicates a system preset policy; Custom indicates a custom policy.

attachDate string: Policy binding time.
description string: Policy description.
policyName string: Policy name
policyScopes GetRolePolicyPolicyScope[]: Policy authorization scope, specifically refers to the project scope.
policyTrn string: Policy TRN.
policyType string: Policy type. Policy type. System indicates a system preset policy; Custom indicates a custom policy.

attach_date str: Policy binding time.
description str: Policy description.
policy_name str: Policy name
policy_scopes Sequence[GetRolePolicyPolicyScope]: Policy authorization scope, specifically refers to the project scope.
policy_trn str: Policy TRN.
policy_type str: Policy type. Policy type. System indicates a system preset policy; Custom indicates a custom policy.

attachDate String: Policy binding time.
description String: Policy description.
policyName String: Policy name
policyScopes List<Property Map>: Policy authorization scope, specifically refers to the project scope.
policyTrn String: Policy TRN.
policyType String: Policy type. Policy type. System indicates a system preset policy; Custom indicates a custom policy.

GetRolePolicyPolicyScope

AttachDate string: Project authorization time.
PolicyScopeType string: Authorization type. Global means global authorization (not limited to any project), Project means project-based authorization.
ProjectDisplayName string: Project display name for project-based authorization.
ProjectName string: Project name for project-based authorization.

AttachDate string: Project authorization time.
PolicyScopeType string: Authorization type. Global means global authorization (not limited to any project), Project means project-based authorization.
ProjectDisplayName string: Project display name for project-based authorization.
ProjectName string: Project name for project-based authorization.

attach_date string: Project authorization time.
policy_scope_type string: Authorization type. Global means global authorization (not limited to any project), Project means project-based authorization.
project_display_name string: Project display name for project-based authorization.
project_name string: Project name for project-based authorization.

attachDate String: Project authorization time.
policyScopeType String: Authorization type. Global means global authorization (not limited to any project), Project means project-based authorization.
projectDisplayName String: Project display name for project-based authorization.
projectName String: Project name for project-based authorization.

attachDate string: Project authorization time.
policyScopeType string: Authorization type. Global means global authorization (not limited to any project), Project means project-based authorization.
projectDisplayName string: Project display name for project-based authorization.
projectName string: Project name for project-based authorization.

attach_date str: Project authorization time.
policy_scope_type str: Authorization type. Global means global authorization (not limited to any project), Project means project-based authorization.
project_display_name str: Project display name for project-based authorization.
project_name str: Project name for project-based authorization.

attachDate String: Project authorization time.
policyScopeType String: Authorization type. Global means global authorization (not limited to any project), Project means project-based authorization.
projectDisplayName String: Project display name for project-based authorization.
projectName String: Project name for project-based authorization.

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 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: bytepluscc byteplus-sdk/pulumi-bytepluscc
License: MPL-2.0
Notes: This Pulumi package is based on the bytepluscc Terraform Provider.

Viewing docs for bytepluscc v0.0.31
published on Monday, Jun 1, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

bytepluscc.iam.getRole

On this page

On this page

Using getRole

getRole Result

Supporting Types

GetRolePolicy

GetRolePolicyPolicyScope

GetRoleTag

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

bytepluscc.iam.getRole

On this page

On this page

Using getRole

getRole Result

Supporting Types

GetRolePolicy

GetRolePolicyPolicyScope

GetRoleTag

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.