cyral 4.16.3 published on Monday, Apr 14, 2025 by cyralinc
cyral.getPolicyV2
Explore with Pulumi AI
This data source provides information about a policy.
Using getPolicyV2
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 getPolicyV2(args: GetPolicyV2Args, opts?: InvokeOptions): Promise<GetPolicyV2Result>
function getPolicyV2Output(args: GetPolicyV2OutputArgs, opts?: InvokeOptions): Output<GetPolicyV2Result>def get_policy_v2(id: Optional[str] = None,
                  type: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetPolicyV2Result
def get_policy_v2_output(id: Optional[pulumi.Input[str]] = None,
                  type: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetPolicyV2Result]func LookupPolicyV2(ctx *Context, args *LookupPolicyV2Args, opts ...InvokeOption) (*LookupPolicyV2Result, error)
func LookupPolicyV2Output(ctx *Context, args *LookupPolicyV2OutputArgs, opts ...InvokeOption) LookupPolicyV2ResultOutput> Note: This function is named LookupPolicyV2 in the Go SDK.
public static class GetPolicyV2 
{
    public static Task<GetPolicyV2Result> InvokeAsync(GetPolicyV2Args args, InvokeOptions? opts = null)
    public static Output<GetPolicyV2Result> Invoke(GetPolicyV2InvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetPolicyV2Result> getPolicyV2(GetPolicyV2Args args, InvokeOptions options)
public static Output<GetPolicyV2Result> getPolicyV2(GetPolicyV2Args args, InvokeOptions options)
fn::invoke:
  function: cyral:index/getPolicyV2:getPolicyV2
  arguments:
    # arguments dictionaryThe following arguments are supported:
getPolicyV2 Result
The following output properties are available:
- Created Dictionary<string, string>
- Information about when and by whom the policy was created.
- Description string
- Description of the policy.
- Document string
- The actual policy document in JSON format. It must conform to the schema for the policy type.
- Enabled bool
- Indicates if the policy is enabled.
- Enforced bool
- Indicates if the policy is enforced. If not enforced, no action is taken based on the policy, but alerts are triggered for violations.
- Id string
- Identifier for the policy, unique within the policy type.
- LastUpdated Dictionary<string, string>
- Information about when and by whom the policy was last updated.
- Name string
- Name of the policy.
- Scopes
List<GetPolicy V2Scope> 
- Scope of the policy. If empty or omitted, all repositories are in scope.
- List<string>
- Tags associated with the policy for categorization.
- Type string
- Type of the policy, one of [local,global]
- ValidFrom string
- Time when the policy comes into effect. If omitted, the policy is in effect immediately.
- ValidUntil string
- Time after which the policy is no longer in effect. If omitted, the policy is in effect indefinitely.
- Created map[string]string
- Information about when and by whom the policy was created.
- Description string
- Description of the policy.
- Document string
- The actual policy document in JSON format. It must conform to the schema for the policy type.
- Enabled bool
- Indicates if the policy is enabled.
- Enforced bool
- Indicates if the policy is enforced. If not enforced, no action is taken based on the policy, but alerts are triggered for violations.
- Id string
- Identifier for the policy, unique within the policy type.
- LastUpdated map[string]string
- Information about when and by whom the policy was last updated.
- Name string
- Name of the policy.
- Scopes
[]GetPolicy V2Scope 
- Scope of the policy. If empty or omitted, all repositories are in scope.
- []string
- Tags associated with the policy for categorization.
- Type string
- Type of the policy, one of [local,global]
- ValidFrom string
- Time when the policy comes into effect. If omitted, the policy is in effect immediately.
- ValidUntil string
- Time after which the policy is no longer in effect. If omitted, the policy is in effect indefinitely.
- created Map<String,String>
- Information about when and by whom the policy was created.
- description String
- Description of the policy.
- document String
- The actual policy document in JSON format. It must conform to the schema for the policy type.
- enabled Boolean
- Indicates if the policy is enabled.
- enforced Boolean
- Indicates if the policy is enforced. If not enforced, no action is taken based on the policy, but alerts are triggered for violations.
- id String
- Identifier for the policy, unique within the policy type.
- lastUpdated Map<String,String>
- Information about when and by whom the policy was last updated.
- name String
- Name of the policy.
- scopes
List<GetPolicy V2Scope> 
- Scope of the policy. If empty or omitted, all repositories are in scope.
- List<String>
- Tags associated with the policy for categorization.
- type String
- Type of the policy, one of [local,global]
- validFrom String
- Time when the policy comes into effect. If omitted, the policy is in effect immediately.
- validUntil String
- Time after which the policy is no longer in effect. If omitted, the policy is in effect indefinitely.
- created {[key: string]: string}
- Information about when and by whom the policy was created.
- description string
- Description of the policy.
- document string
- The actual policy document in JSON format. It must conform to the schema for the policy type.
- enabled boolean
- Indicates if the policy is enabled.
- enforced boolean
- Indicates if the policy is enforced. If not enforced, no action is taken based on the policy, but alerts are triggered for violations.
- id string
- Identifier for the policy, unique within the policy type.
- lastUpdated {[key: string]: string}
- Information about when and by whom the policy was last updated.
- name string
- Name of the policy.
- scopes
GetPolicy V2Scope[] 
- Scope of the policy. If empty or omitted, all repositories are in scope.
- string[]
- Tags associated with the policy for categorization.
- type string
- Type of the policy, one of [local,global]
- validFrom string
- Time when the policy comes into effect. If omitted, the policy is in effect immediately.
- validUntil string
- Time after which the policy is no longer in effect. If omitted, the policy is in effect indefinitely.
- created Mapping[str, str]
- Information about when and by whom the policy was created.
- description str
- Description of the policy.
- document str
- The actual policy document in JSON format. It must conform to the schema for the policy type.
- enabled bool
- Indicates if the policy is enabled.
- enforced bool
- Indicates if the policy is enforced. If not enforced, no action is taken based on the policy, but alerts are triggered for violations.
- id str
- Identifier for the policy, unique within the policy type.
- last_updated Mapping[str, str]
- Information about when and by whom the policy was last updated.
- name str
- Name of the policy.
- scopes
Sequence[GetPolicy V2Scope] 
- Scope of the policy. If empty or omitted, all repositories are in scope.
- Sequence[str]
- Tags associated with the policy for categorization.
- type str
- Type of the policy, one of [local,global]
- valid_from str
- Time when the policy comes into effect. If omitted, the policy is in effect immediately.
- valid_until str
- Time after which the policy is no longer in effect. If omitted, the policy is in effect indefinitely.
- created Map<String>
- Information about when and by whom the policy was created.
- description String
- Description of the policy.
- document String
- The actual policy document in JSON format. It must conform to the schema for the policy type.
- enabled Boolean
- Indicates if the policy is enabled.
- enforced Boolean
- Indicates if the policy is enforced. If not enforced, no action is taken based on the policy, but alerts are triggered for violations.
- id String
- Identifier for the policy, unique within the policy type.
- lastUpdated Map<String>
- Information about when and by whom the policy was last updated.
- name String
- Name of the policy.
- scopes List<Property Map>
- Scope of the policy. If empty or omitted, all repositories are in scope.
- List<String>
- Tags associated with the policy for categorization.
- type String
- Type of the policy, one of [local,global]
- validFrom String
- Time when the policy comes into effect. If omitted, the policy is in effect immediately.
- validUntil String
- Time after which the policy is no longer in effect. If omitted, the policy is in effect indefinitely.
Supporting Types
GetPolicyV2Scope  
- RepoIds List<string>
- RepoIds []string
- repoIds List<String>
- repoIds string[]
- repo_ids Sequence[str]
- repoIds List<String>
Package Details
- Repository
- cyral cyralinc/terraform-provider-cyral
- License
- Notes
- This Pulumi package is based on the cyralTerraform Provider.