1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. iam
  6. getPolicy
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

    Data Source schema for Volcengine::IAM::Policy

    Using getPolicy

    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 getPolicy(args: GetPolicyArgs, opts?: InvokeOptions): Promise<GetPolicyResult>
    function getPolicyOutput(args: GetPolicyOutputArgs, opts?: InvokeOptions): Output<GetPolicyResult>
    def get_policy(id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetPolicyResult
    def get_policy_output(id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetPolicyResult]
    func LookupPolicy(ctx *Context, args *LookupPolicyArgs, opts ...InvokeOption) (*LookupPolicyResult, error)
    func LookupPolicyOutput(ctx *Context, args *LookupPolicyOutputArgs, opts ...InvokeOption) LookupPolicyResultOutput

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

    public static class GetPolicy 
    {
        public static Task<GetPolicyResult> InvokeAsync(GetPolicyArgs args, InvokeOptions? opts = null)
        public static Output<GetPolicyResult> Invoke(GetPolicyInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPolicyResult> getPolicy(GetPolicyArgs args, InvokeOptions options)
    public static Output<GetPolicyResult> getPolicy(GetPolicyArgs args, InvokeOptions options)
    
    fn::invoke:
      function: volcenginecc:iam/getPolicy:getPolicy
      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.

    getPolicy Result

    The following output properties are available:

    AttachmentCount int
    Number of identities bound to the policy.
    Category string
    Category of the system preset policy, usually the service code. This field is not returned for custom policies.
    CreatedTime string
    Policy creation time.
    Description string
    Policy description, no more than 128 characters.
    Id string
    Uniquely identifies the resource.
    IsServiceRolePolicy int
    Indicates whether the policy is for a service-linked role. 0 means no; 1 means yes.
    PolicyDocument string
    Policy syntax content, for example: {"Statement":[{"Effect":"Allow","Action":["iam:","tag:"],"Resource":["*"]}]}
    PolicyName string
    Policy name, 1–64 characters. Supports English letters, numbers, and +=,.@-_ symbols.
    PolicyRoles List<Volcengine.GetPolicyPolicyRole>
    List of roles bound to the policy.
    PolicyTrn string
    Policy TRN.
    PolicyType string
    Policy type. System indicates a system preset policy; Custom indicates a custom policy.
    PolicyUserGroups List<Volcengine.GetPolicyPolicyUserGroup>
    List of user groups bound to the policy.
    PolicyUsers List<Volcengine.GetPolicyPolicyUser>
    List of users bound to the policy.
    UpdatedTime string
    Policy update time.
    AttachmentCount int
    Number of identities bound to the policy.
    Category string
    Category of the system preset policy, usually the service code. This field is not returned for custom policies.
    CreatedTime string
    Policy creation time.
    Description string
    Policy description, no more than 128 characters.
    Id string
    Uniquely identifies the resource.
    IsServiceRolePolicy int
    Indicates whether the policy is for a service-linked role. 0 means no; 1 means yes.
    PolicyDocument string
    Policy syntax content, for example: {"Statement":[{"Effect":"Allow","Action":["iam:","tag:"],"Resource":["*"]}]}
    PolicyName string
    Policy name, 1–64 characters. Supports English letters, numbers, and +=,.@-_ symbols.
    PolicyRoles []GetPolicyPolicyRole
    List of roles bound to the policy.
    PolicyTrn string
    Policy TRN.
    PolicyType string
    Policy type. System indicates a system preset policy; Custom indicates a custom policy.
    PolicyUserGroups []GetPolicyPolicyUserGroup
    List of user groups bound to the policy.
    PolicyUsers []GetPolicyPolicyUser
    List of users bound to the policy.
    UpdatedTime string
    Policy update time.
    attachmentCount Integer
    Number of identities bound to the policy.
    category String
    Category of the system preset policy, usually the service code. This field is not returned for custom policies.
    createdTime String
    Policy creation time.
    description String
    Policy description, no more than 128 characters.
    id String
    Uniquely identifies the resource.
    isServiceRolePolicy Integer
    Indicates whether the policy is for a service-linked role. 0 means no; 1 means yes.
    policyDocument String
    Policy syntax content, for example: {"Statement":[{"Effect":"Allow","Action":["iam:","tag:"],"Resource":["*"]}]}
    policyName String
    Policy name, 1–64 characters. Supports English letters, numbers, and +=,.@-_ symbols.
    policyRoles List<GetPolicyPolicyRole>
    List of roles bound to the policy.
    policyTrn String
    Policy TRN.
    policyType String
    Policy type. System indicates a system preset policy; Custom indicates a custom policy.
    policyUserGroups List<GetPolicyPolicyUserGroup>
    List of user groups bound to the policy.
    policyUsers List<GetPolicyPolicyUser>
    List of users bound to the policy.
    updatedTime String
    Policy update time.
    attachmentCount number
    Number of identities bound to the policy.
    category string
    Category of the system preset policy, usually the service code. This field is not returned for custom policies.
    createdTime string
    Policy creation time.
    description string
    Policy description, no more than 128 characters.
    id string
    Uniquely identifies the resource.
    isServiceRolePolicy number
    Indicates whether the policy is for a service-linked role. 0 means no; 1 means yes.
    policyDocument string
    Policy syntax content, for example: {"Statement":[{"Effect":"Allow","Action":["iam:","tag:"],"Resource":["*"]}]}
    policyName string
    Policy name, 1–64 characters. Supports English letters, numbers, and +=,.@-_ symbols.
    policyRoles GetPolicyPolicyRole[]
    List of roles bound to the policy.
    policyTrn string
    Policy TRN.
    policyType string
    Policy type. System indicates a system preset policy; Custom indicates a custom policy.
    policyUserGroups GetPolicyPolicyUserGroup[]
    List of user groups bound to the policy.
    policyUsers GetPolicyPolicyUser[]
    List of users bound to the policy.
    updatedTime string
    Policy update time.
    attachment_count int
    Number of identities bound to the policy.
    category str
    Category of the system preset policy, usually the service code. This field is not returned for custom policies.
    created_time str
    Policy creation time.
    description str
    Policy description, no more than 128 characters.
    id str
    Uniquely identifies the resource.
    is_service_role_policy int
    Indicates whether the policy is for a service-linked role. 0 means no; 1 means yes.
    policy_document str
    Policy syntax content, for example: {"Statement":[{"Effect":"Allow","Action":["iam:","tag:"],"Resource":["*"]}]}
    policy_name str
    Policy name, 1–64 characters. Supports English letters, numbers, and +=,.@-_ symbols.
    policy_roles Sequence[GetPolicyPolicyRole]
    List of roles bound to the policy.
    policy_trn str
    Policy TRN.
    policy_type str
    Policy type. System indicates a system preset policy; Custom indicates a custom policy.
    policy_user_groups Sequence[GetPolicyPolicyUserGroup]
    List of user groups bound to the policy.
    policy_users Sequence[GetPolicyPolicyUser]
    List of users bound to the policy.
    updated_time str
    Policy update time.
    attachmentCount Number
    Number of identities bound to the policy.
    category String
    Category of the system preset policy, usually the service code. This field is not returned for custom policies.
    createdTime String
    Policy creation time.
    description String
    Policy description, no more than 128 characters.
    id String
    Uniquely identifies the resource.
    isServiceRolePolicy Number
    Indicates whether the policy is for a service-linked role. 0 means no; 1 means yes.
    policyDocument String
    Policy syntax content, for example: {"Statement":[{"Effect":"Allow","Action":["iam:","tag:"],"Resource":["*"]}]}
    policyName String
    Policy name, 1–64 characters. Supports English letters, numbers, and +=,.@-_ symbols.
    policyRoles List<Property Map>
    List of roles bound to the policy.
    policyTrn String
    Policy TRN.
    policyType String
    Policy type. System indicates a system preset policy; Custom indicates a custom policy.
    policyUserGroups List<Property Map>
    List of user groups bound to the policy.
    policyUsers List<Property Map>
    List of users bound to the policy.
    updatedTime String
    Policy update time.

    Supporting Types

    GetPolicyPolicyRole

    CreatedTime string
    Policy binding time.
    Description string
    Policy description.
    DisplayName string
    Display name.
    EntitiesId int
    Unique identifier.
    Name string
    Name of the corresponding user, role, or user group.
    PolicyScopes List<Volcengine.GetPolicyPolicyRolePolicyScope>
    List of projects bound to the policy.
    CreatedTime string
    Policy binding time.
    Description string
    Policy description.
    DisplayName string
    Display name.
    EntitiesId int
    Unique identifier.
    Name string
    Name of the corresponding user, role, or user group.
    PolicyScopes []GetPolicyPolicyRolePolicyScope
    List of projects bound to the policy.
    createdTime String
    Policy binding time.
    description String
    Policy description.
    displayName String
    Display name.
    entitiesId Integer
    Unique identifier.
    name String
    Name of the corresponding user, role, or user group.
    policyScopes List<GetPolicyPolicyRolePolicyScope>
    List of projects bound to the policy.
    createdTime string
    Policy binding time.
    description string
    Policy description.
    displayName string
    Display name.
    entitiesId number
    Unique identifier.
    name string
    Name of the corresponding user, role, or user group.
    policyScopes GetPolicyPolicyRolePolicyScope[]
    List of projects bound to the policy.
    created_time str
    Policy binding time.
    description str
    Policy description.
    display_name str
    Display name.
    entities_id int
    Unique identifier.
    name str
    Name of the corresponding user, role, or user group.
    policy_scopes Sequence[GetPolicyPolicyRolePolicyScope]
    List of projects bound to the policy.
    createdTime String
    Policy binding time.
    description String
    Policy description.
    displayName String
    Display name.
    entitiesId Number
    Unique identifier.
    name String
    Name of the corresponding user, role, or user group.
    policyScopes List<Property Map>
    List of projects bound to the policy.

    GetPolicyPolicyRolePolicyScope

    CreatedTime string
    Project authorization time.
    PolicyScopeType string
    Authorization type. Global indicates global authorization; Project indicates project-based authorization.
    ProjectDisplayName string
    Project display name.
    ProjectName string
    Project name.
    CreatedTime string
    Project authorization time.
    PolicyScopeType string
    Authorization type. Global indicates global authorization; Project indicates project-based authorization.
    ProjectDisplayName string
    Project display name.
    ProjectName string
    Project name.
    createdTime String
    Project authorization time.
    policyScopeType String
    Authorization type. Global indicates global authorization; Project indicates project-based authorization.
    projectDisplayName String
    Project display name.
    projectName String
    Project name.
    createdTime string
    Project authorization time.
    policyScopeType string
    Authorization type. Global indicates global authorization; Project indicates project-based authorization.
    projectDisplayName string
    Project display name.
    projectName string
    Project name.
    created_time str
    Project authorization time.
    policy_scope_type str
    Authorization type. Global indicates global authorization; Project indicates project-based authorization.
    project_display_name str
    Project display name.
    project_name str
    Project name.
    createdTime String
    Project authorization time.
    policyScopeType String
    Authorization type. Global indicates global authorization; Project indicates project-based authorization.
    projectDisplayName String
    Project display name.
    projectName String
    Project name.

    GetPolicyPolicyUser

    CreatedTime string
    Policy binding time.
    Description string
    Policy description.
    DisplayName string
    Display name.
    EntitiesId int
    Unique identifier.
    Name string
    Name of the corresponding user, role, or user group.
    PolicyScopes List<Volcengine.GetPolicyPolicyUserPolicyScope>
    List of projects bound to the policy.
    CreatedTime string
    Policy binding time.
    Description string
    Policy description.
    DisplayName string
    Display name.
    EntitiesId int
    Unique identifier.
    Name string
    Name of the corresponding user, role, or user group.
    PolicyScopes []GetPolicyPolicyUserPolicyScope
    List of projects bound to the policy.
    createdTime String
    Policy binding time.
    description String
    Policy description.
    displayName String
    Display name.
    entitiesId Integer
    Unique identifier.
    name String
    Name of the corresponding user, role, or user group.
    policyScopes List<GetPolicyPolicyUserPolicyScope>
    List of projects bound to the policy.
    createdTime string
    Policy binding time.
    description string
    Policy description.
    displayName string
    Display name.
    entitiesId number
    Unique identifier.
    name string
    Name of the corresponding user, role, or user group.
    policyScopes GetPolicyPolicyUserPolicyScope[]
    List of projects bound to the policy.
    created_time str
    Policy binding time.
    description str
    Policy description.
    display_name str
    Display name.
    entities_id int
    Unique identifier.
    name str
    Name of the corresponding user, role, or user group.
    policy_scopes Sequence[GetPolicyPolicyUserPolicyScope]
    List of projects bound to the policy.
    createdTime String
    Policy binding time.
    description String
    Policy description.
    displayName String
    Display name.
    entitiesId Number
    Unique identifier.
    name String
    Name of the corresponding user, role, or user group.
    policyScopes List<Property Map>
    List of projects bound to the policy.

    GetPolicyPolicyUserGroup

    CreatedTime string
    Policy binding time.
    Description string
    Policy description.
    DisplayName string
    Display name.
    EntitiesId int
    Unique identifier.
    Name string
    Name of the corresponding user, role, or user group.
    PolicyScopes List<Volcengine.GetPolicyPolicyUserGroupPolicyScope>
    List of projects bound to the policy.
    CreatedTime string
    Policy binding time.
    Description string
    Policy description.
    DisplayName string
    Display name.
    EntitiesId int
    Unique identifier.
    Name string
    Name of the corresponding user, role, or user group.
    PolicyScopes []GetPolicyPolicyUserGroupPolicyScope
    List of projects bound to the policy.
    createdTime String
    Policy binding time.
    description String
    Policy description.
    displayName String
    Display name.
    entitiesId Integer
    Unique identifier.
    name String
    Name of the corresponding user, role, or user group.
    policyScopes List<GetPolicyPolicyUserGroupPolicyScope>
    List of projects bound to the policy.
    createdTime string
    Policy binding time.
    description string
    Policy description.
    displayName string
    Display name.
    entitiesId number
    Unique identifier.
    name string
    Name of the corresponding user, role, or user group.
    policyScopes GetPolicyPolicyUserGroupPolicyScope[]
    List of projects bound to the policy.
    created_time str
    Policy binding time.
    description str
    Policy description.
    display_name str
    Display name.
    entities_id int
    Unique identifier.
    name str
    Name of the corresponding user, role, or user group.
    policy_scopes Sequence[GetPolicyPolicyUserGroupPolicyScope]
    List of projects bound to the policy.
    createdTime String
    Policy binding time.
    description String
    Policy description.
    displayName String
    Display name.
    entitiesId Number
    Unique identifier.
    name String
    Name of the corresponding user, role, or user group.
    policyScopes List<Property Map>
    List of projects bound to the policy.

    GetPolicyPolicyUserGroupPolicyScope

    CreatedTime string
    Project authorization time.
    PolicyScopeType string
    Authorization type. Global indicates global authorization; Project indicates project-based authorization.
    ProjectDisplayName string
    Project display name.
    ProjectName string
    Project name.
    CreatedTime string
    Project authorization time.
    PolicyScopeType string
    Authorization type. Global indicates global authorization; Project indicates project-based authorization.
    ProjectDisplayName string
    Project display name.
    ProjectName string
    Project name.
    createdTime String
    Project authorization time.
    policyScopeType String
    Authorization type. Global indicates global authorization; Project indicates project-based authorization.
    projectDisplayName String
    Project display name.
    projectName String
    Project name.
    createdTime string
    Project authorization time.
    policyScopeType string
    Authorization type. Global indicates global authorization; Project indicates project-based authorization.
    projectDisplayName string
    Project display name.
    projectName string
    Project name.
    created_time str
    Project authorization time.
    policy_scope_type str
    Authorization type. Global indicates global authorization; Project indicates project-based authorization.
    project_display_name str
    Project display name.
    project_name str
    Project name.
    createdTime String
    Project authorization time.
    policyScopeType String
    Authorization type. Global indicates global authorization; Project indicates project-based authorization.
    projectDisplayName String
    Project display name.
    projectName String
    Project name.

    GetPolicyPolicyUserPolicyScope

    CreatedTime string
    Project authorization time.
    PolicyScopeType string
    Authorization type. Global indicates global authorization; Project indicates project-based authorization.
    ProjectDisplayName string
    Project display name.
    ProjectName string
    Project name.
    CreatedTime string
    Project authorization time.
    PolicyScopeType string
    Authorization type. Global indicates global authorization; Project indicates project-based authorization.
    ProjectDisplayName string
    Project display name.
    ProjectName string
    Project name.
    createdTime String
    Project authorization time.
    policyScopeType String
    Authorization type. Global indicates global authorization; Project indicates project-based authorization.
    projectDisplayName String
    Project display name.
    projectName String
    Project name.
    createdTime string
    Project authorization time.
    policyScopeType string
    Authorization type. Global indicates global authorization; Project indicates project-based authorization.
    projectDisplayName string
    Project display name.
    projectName string
    Project name.
    created_time str
    Project authorization time.
    policy_scope_type str
    Authorization type. Global indicates global authorization; Project indicates project-based authorization.
    project_display_name str
    Project display name.
    project_name str
    Project name.
    createdTime String
    Project authorization time.
    policyScopeType String
    Authorization type. Global indicates global authorization; Project indicates project-based authorization.
    projectDisplayName String
    Project display name.
    projectName String
    Project name.

    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
      Try Pulumi Cloud free. Your team will thank you.