1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. OperatorAccessControl
  5. getControls
Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi

oci.OperatorAccessControl.getControls

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi

    This data source provides the list of Operator Controls in Oracle Cloud Infrastructure Operator Access Control service.

    Lists the operator controls in the compartment.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testOperatorControls = oci.OperatorAccessControl.getControls({
        compartmentId: compartmentId,
        displayName: operatorControlDisplayName,
        resourceType: operatorControlResourceType,
        state: operatorControlState,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_operator_controls = oci.OperatorAccessControl.get_controls(compartment_id=compartment_id,
        display_name=operator_control_display_name,
        resource_type=operator_control_resource_type,
        state=operator_control_state)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/OperatorAccessControl"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := OperatorAccessControl.GetControls(ctx, &operatoraccesscontrol.GetControlsArgs{
    			CompartmentId: compartmentId,
    			DisplayName:   pulumi.StringRef(operatorControlDisplayName),
    			ResourceType:  pulumi.StringRef(operatorControlResourceType),
    			State:         pulumi.StringRef(operatorControlState),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testOperatorControls = Oci.OperatorAccessControl.GetControls.Invoke(new()
        {
            CompartmentId = compartmentId,
            DisplayName = operatorControlDisplayName,
            ResourceType = operatorControlResourceType,
            State = operatorControlState,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.OperatorAccessControl.OperatorAccessControlFunctions;
    import com.pulumi.oci.OperatorAccessControl.inputs.GetControlsArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var testOperatorControls = OperatorAccessControlFunctions.getControls(GetControlsArgs.builder()
                .compartmentId(compartmentId)
                .displayName(operatorControlDisplayName)
                .resourceType(operatorControlResourceType)
                .state(operatorControlState)
                .build());
    
        }
    }
    
    variables:
      testOperatorControls:
        fn::invoke:
          Function: oci:OperatorAccessControl:getControls
          Arguments:
            compartmentId: ${compartmentId}
            displayName: ${operatorControlDisplayName}
            resourceType: ${operatorControlResourceType}
            state: ${operatorControlState}
    

    Using getControls

    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 getControls(args: GetControlsArgs, opts?: InvokeOptions): Promise<GetControlsResult>
    function getControlsOutput(args: GetControlsOutputArgs, opts?: InvokeOptions): Output<GetControlsResult>
    def get_controls(compartment_id: Optional[str] = None,
                     display_name: Optional[str] = None,
                     filters: Optional[Sequence[_operatoraccesscontrol.GetControlsFilter]] = None,
                     resource_type: Optional[str] = None,
                     state: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetControlsResult
    def get_controls_output(compartment_id: Optional[pulumi.Input[str]] = None,
                     display_name: Optional[pulumi.Input[str]] = None,
                     filters: Optional[pulumi.Input[Sequence[pulumi.Input[_operatoraccesscontrol.GetControlsFilterArgs]]]] = None,
                     resource_type: Optional[pulumi.Input[str]] = None,
                     state: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetControlsResult]
    func GetControls(ctx *Context, args *GetControlsArgs, opts ...InvokeOption) (*GetControlsResult, error)
    func GetControlsOutput(ctx *Context, args *GetControlsOutputArgs, opts ...InvokeOption) GetControlsResultOutput

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

    public static class GetControls 
    {
        public static Task<GetControlsResult> InvokeAsync(GetControlsArgs args, InvokeOptions? opts = null)
        public static Output<GetControlsResult> Invoke(GetControlsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetControlsResult> getControls(GetControlsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:OperatorAccessControl/getControls:getControls
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The ID of the compartment in which to list resources.
    DisplayName string
    A filter to return OperatorControl that match the entire display name given.
    Filters List<GetControlsFilter>
    ResourceType string
    A filter to return only lists of resources that match the entire given service type.
    State string
    A filter to return only resources whose lifecycleState matches the given OperatorControl lifecycleState.
    CompartmentId string
    The ID of the compartment in which to list resources.
    DisplayName string
    A filter to return OperatorControl that match the entire display name given.
    Filters []GetControlsFilter
    ResourceType string
    A filter to return only lists of resources that match the entire given service type.
    State string
    A filter to return only resources whose lifecycleState matches the given OperatorControl lifecycleState.
    compartmentId String
    The ID of the compartment in which to list resources.
    displayName String
    A filter to return OperatorControl that match the entire display name given.
    filters List<GetControlsFilter>
    resourceType String
    A filter to return only lists of resources that match the entire given service type.
    state String
    A filter to return only resources whose lifecycleState matches the given OperatorControl lifecycleState.
    compartmentId string
    The ID of the compartment in which to list resources.
    displayName string
    A filter to return OperatorControl that match the entire display name given.
    filters GetControlsFilter[]
    resourceType string
    A filter to return only lists of resources that match the entire given service type.
    state string
    A filter to return only resources whose lifecycleState matches the given OperatorControl lifecycleState.
    compartment_id str
    The ID of the compartment in which to list resources.
    display_name str
    A filter to return OperatorControl that match the entire display name given.
    filters Sequence[operatoraccesscontrol.GetControlsFilter]
    resource_type str
    A filter to return only lists of resources that match the entire given service type.
    state str
    A filter to return only resources whose lifecycleState matches the given OperatorControl lifecycleState.
    compartmentId String
    The ID of the compartment in which to list resources.
    displayName String
    A filter to return OperatorControl that match the entire display name given.
    filters List<Property Map>
    resourceType String
    A filter to return only lists of resources that match the entire given service type.
    state String
    A filter to return only resources whose lifecycleState matches the given OperatorControl lifecycleState.

    getControls Result

    The following output properties are available:

    CompartmentId string
    The OCID of the compartment that contains the operator control.
    Id string
    The provider-assigned unique ID for this managed resource.
    OperatorControlCollections List<GetControlsOperatorControlCollection>
    The list of operator_control_collection.
    DisplayName string
    Filters List<GetControlsFilter>
    ResourceType string
    resourceType for which the OperatorControl is applicable
    State string
    The current lifecycle state of the operator control.
    CompartmentId string
    The OCID of the compartment that contains the operator control.
    Id string
    The provider-assigned unique ID for this managed resource.
    OperatorControlCollections []GetControlsOperatorControlCollection
    The list of operator_control_collection.
    DisplayName string
    Filters []GetControlsFilter
    ResourceType string
    resourceType for which the OperatorControl is applicable
    State string
    The current lifecycle state of the operator control.
    compartmentId String
    The OCID of the compartment that contains the operator control.
    id String
    The provider-assigned unique ID for this managed resource.
    operatorControlCollections List<GetControlsOperatorControlCollection>
    The list of operator_control_collection.
    displayName String
    filters List<GetControlsFilter>
    resourceType String
    resourceType for which the OperatorControl is applicable
    state String
    The current lifecycle state of the operator control.
    compartmentId string
    The OCID of the compartment that contains the operator control.
    id string
    The provider-assigned unique ID for this managed resource.
    operatorControlCollections GetControlsOperatorControlCollection[]
    The list of operator_control_collection.
    displayName string
    filters GetControlsFilter[]
    resourceType string
    resourceType for which the OperatorControl is applicable
    state string
    The current lifecycle state of the operator control.
    compartment_id str
    The OCID of the compartment that contains the operator control.
    id str
    The provider-assigned unique ID for this managed resource.
    operator_control_collections Sequence[operatoraccesscontrol.GetControlsOperatorControlCollection]
    The list of operator_control_collection.
    display_name str
    filters Sequence[operatoraccesscontrol.GetControlsFilter]
    resource_type str
    resourceType for which the OperatorControl is applicable
    state str
    The current lifecycle state of the operator control.
    compartmentId String
    The OCID of the compartment that contains the operator control.
    id String
    The provider-assigned unique ID for this managed resource.
    operatorControlCollections List<Property Map>
    The list of operator_control_collection.
    displayName String
    filters List<Property Map>
    resourceType String
    resourceType for which the OperatorControl is applicable
    state String
    The current lifecycle state of the operator control.

    Supporting Types

    GetControlsFilter

    Name string
    Values List<string>
    Regex bool
    Name string
    Values []string
    Regex bool
    name String
    values List<String>
    regex Boolean
    name string
    values string[]
    regex boolean
    name str
    values Sequence[str]
    regex bool
    name String
    values List<String>
    regex Boolean

    GetControlsOperatorControlCollection

    GetControlsOperatorControlCollectionItem

    ApprovalRequiredOpActionLists List<string>
    List of operator actions that need explicit approval. Any operator action not in the pre-approved list will require explicit approval. Access requests associated with a resource governed by this operator control will be require explicit approval if the access request contains any operator action in this list.
    ApproverGroupsLists List<string>
    List of user groups who can approve an access request associated with a target resource under the governance of this operator control.
    ApproversLists List<string>
    List of users who can approve an access request associated with a target resource under the governance of this operator control.
    CompartmentId string
    The ID of the compartment in which to list resources.
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace.
    Description string
    Description of operator control.
    EmailIdLists List<string>
    List of emailId.
    FreeformTags Dictionary<string, string>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
    Id string
    The OCID of the operator control.
    IsDefaultOperatorControl bool
    Whether the operator control is a default Operator Control.
    IsFullyPreApproved bool
    Whether all the operator actions have been pre-approved. If yes, all access requests associated with a resource governed by this operator control will be auto-approved.
    LastModifiedInfo string
    Description associated with the latest modification of the operator control.
    NumberOfApprovers int
    Number of approvers required to approve an access request.
    OperatorControlName string
    Name of the operator control. The name must be unique.
    PreApprovedOpActionLists List<string>
    List of pre-approved operator actions. Access requests associated with a resource governed by this operator control will be automatically approved if the access request only contain operator actions in the pre-approved list.
    ResourceType string
    A filter to return only lists of resources that match the entire given service type.
    State string
    A filter to return only resources whose lifecycleState matches the given OperatorControl lifecycleState.
    SystemMessage string
    System message that would be displayed to the operator users on accessing the target resource under the governance of this operator control.
    TimeOfCreation string
    Time when the operator control was created expressed in RFC 3339 timestamp format. Example: '2020-05-22T21:10:29.600Z'
    TimeOfDeletion string
    Time when deleted expressed in RFC 3339timestamp format. Example: '2020-05-22T21:10:29.600Z'. Note a deleted operator control still stays in the system, so that you can still audit operator actions associated with access requests raised on target resources governed by the deleted operator control.
    TimeOfModification string
    Time when the operator control was last modified expressed in RFC 3339 timestamp format. Example: '2020-05-22T21:10:29.600Z'
    ApprovalRequiredOpActionLists []string
    List of operator actions that need explicit approval. Any operator action not in the pre-approved list will require explicit approval. Access requests associated with a resource governed by this operator control will be require explicit approval if the access request contains any operator action in this list.
    ApproverGroupsLists []string
    List of user groups who can approve an access request associated with a target resource under the governance of this operator control.
    ApproversLists []string
    List of users who can approve an access request associated with a target resource under the governance of this operator control.
    CompartmentId string
    The ID of the compartment in which to list resources.
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace.
    Description string
    Description of operator control.
    EmailIdLists []string
    List of emailId.
    FreeformTags map[string]string
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
    Id string
    The OCID of the operator control.
    IsDefaultOperatorControl bool
    Whether the operator control is a default Operator Control.
    IsFullyPreApproved bool
    Whether all the operator actions have been pre-approved. If yes, all access requests associated with a resource governed by this operator control will be auto-approved.
    LastModifiedInfo string
    Description associated with the latest modification of the operator control.
    NumberOfApprovers int
    Number of approvers required to approve an access request.
    OperatorControlName string
    Name of the operator control. The name must be unique.
    PreApprovedOpActionLists []string
    List of pre-approved operator actions. Access requests associated with a resource governed by this operator control will be automatically approved if the access request only contain operator actions in the pre-approved list.
    ResourceType string
    A filter to return only lists of resources that match the entire given service type.
    State string
    A filter to return only resources whose lifecycleState matches the given OperatorControl lifecycleState.
    SystemMessage string
    System message that would be displayed to the operator users on accessing the target resource under the governance of this operator control.
    TimeOfCreation string
    Time when the operator control was created expressed in RFC 3339 timestamp format. Example: '2020-05-22T21:10:29.600Z'
    TimeOfDeletion string
    Time when deleted expressed in RFC 3339timestamp format. Example: '2020-05-22T21:10:29.600Z'. Note a deleted operator control still stays in the system, so that you can still audit operator actions associated with access requests raised on target resources governed by the deleted operator control.
    TimeOfModification string
    Time when the operator control was last modified expressed in RFC 3339 timestamp format. Example: '2020-05-22T21:10:29.600Z'
    approvalRequiredOpActionLists List<String>
    List of operator actions that need explicit approval. Any operator action not in the pre-approved list will require explicit approval. Access requests associated with a resource governed by this operator control will be require explicit approval if the access request contains any operator action in this list.
    approverGroupsLists List<String>
    List of user groups who can approve an access request associated with a target resource under the governance of this operator control.
    approversLists List<String>
    List of users who can approve an access request associated with a target resource under the governance of this operator control.
    compartmentId String
    The ID of the compartment in which to list resources.
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace.
    description String
    Description of operator control.
    emailIdLists List<String>
    List of emailId.
    freeformTags Map<String,String>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
    id String
    The OCID of the operator control.
    isDefaultOperatorControl Boolean
    Whether the operator control is a default Operator Control.
    isFullyPreApproved Boolean
    Whether all the operator actions have been pre-approved. If yes, all access requests associated with a resource governed by this operator control will be auto-approved.
    lastModifiedInfo String
    Description associated with the latest modification of the operator control.
    numberOfApprovers Integer
    Number of approvers required to approve an access request.
    operatorControlName String
    Name of the operator control. The name must be unique.
    preApprovedOpActionLists List<String>
    List of pre-approved operator actions. Access requests associated with a resource governed by this operator control will be automatically approved if the access request only contain operator actions in the pre-approved list.
    resourceType String
    A filter to return only lists of resources that match the entire given service type.
    state String
    A filter to return only resources whose lifecycleState matches the given OperatorControl lifecycleState.
    systemMessage String
    System message that would be displayed to the operator users on accessing the target resource under the governance of this operator control.
    timeOfCreation String
    Time when the operator control was created expressed in RFC 3339 timestamp format. Example: '2020-05-22T21:10:29.600Z'
    timeOfDeletion String
    Time when deleted expressed in RFC 3339timestamp format. Example: '2020-05-22T21:10:29.600Z'. Note a deleted operator control still stays in the system, so that you can still audit operator actions associated with access requests raised on target resources governed by the deleted operator control.
    timeOfModification String
    Time when the operator control was last modified expressed in RFC 3339 timestamp format. Example: '2020-05-22T21:10:29.600Z'
    approvalRequiredOpActionLists string[]
    List of operator actions that need explicit approval. Any operator action not in the pre-approved list will require explicit approval. Access requests associated with a resource governed by this operator control will be require explicit approval if the access request contains any operator action in this list.
    approverGroupsLists string[]
    List of user groups who can approve an access request associated with a target resource under the governance of this operator control.
    approversLists string[]
    List of users who can approve an access request associated with a target resource under the governance of this operator control.
    compartmentId string
    The ID of the compartment in which to list resources.
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace.
    description string
    Description of operator control.
    emailIdLists string[]
    List of emailId.
    freeformTags {[key: string]: string}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
    id string
    The OCID of the operator control.
    isDefaultOperatorControl boolean
    Whether the operator control is a default Operator Control.
    isFullyPreApproved boolean
    Whether all the operator actions have been pre-approved. If yes, all access requests associated with a resource governed by this operator control will be auto-approved.
    lastModifiedInfo string
    Description associated with the latest modification of the operator control.
    numberOfApprovers number
    Number of approvers required to approve an access request.
    operatorControlName string
    Name of the operator control. The name must be unique.
    preApprovedOpActionLists string[]
    List of pre-approved operator actions. Access requests associated with a resource governed by this operator control will be automatically approved if the access request only contain operator actions in the pre-approved list.
    resourceType string
    A filter to return only lists of resources that match the entire given service type.
    state string
    A filter to return only resources whose lifecycleState matches the given OperatorControl lifecycleState.
    systemMessage string
    System message that would be displayed to the operator users on accessing the target resource under the governance of this operator control.
    timeOfCreation string
    Time when the operator control was created expressed in RFC 3339 timestamp format. Example: '2020-05-22T21:10:29.600Z'
    timeOfDeletion string
    Time when deleted expressed in RFC 3339timestamp format. Example: '2020-05-22T21:10:29.600Z'. Note a deleted operator control still stays in the system, so that you can still audit operator actions associated with access requests raised on target resources governed by the deleted operator control.
    timeOfModification string
    Time when the operator control was last modified expressed in RFC 3339 timestamp format. Example: '2020-05-22T21:10:29.600Z'
    approval_required_op_action_lists Sequence[str]
    List of operator actions that need explicit approval. Any operator action not in the pre-approved list will require explicit approval. Access requests associated with a resource governed by this operator control will be require explicit approval if the access request contains any operator action in this list.
    approver_groups_lists Sequence[str]
    List of user groups who can approve an access request associated with a target resource under the governance of this operator control.
    approvers_lists Sequence[str]
    List of users who can approve an access request associated with a target resource under the governance of this operator control.
    compartment_id str
    The ID of the compartment in which to list resources.
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace.
    description str
    Description of operator control.
    email_id_lists Sequence[str]
    List of emailId.
    freeform_tags Mapping[str, str]
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
    id str
    The OCID of the operator control.
    is_default_operator_control bool
    Whether the operator control is a default Operator Control.
    is_fully_pre_approved bool
    Whether all the operator actions have been pre-approved. If yes, all access requests associated with a resource governed by this operator control will be auto-approved.
    last_modified_info str
    Description associated with the latest modification of the operator control.
    number_of_approvers int
    Number of approvers required to approve an access request.
    operator_control_name str
    Name of the operator control. The name must be unique.
    pre_approved_op_action_lists Sequence[str]
    List of pre-approved operator actions. Access requests associated with a resource governed by this operator control will be automatically approved if the access request only contain operator actions in the pre-approved list.
    resource_type str
    A filter to return only lists of resources that match the entire given service type.
    state str
    A filter to return only resources whose lifecycleState matches the given OperatorControl lifecycleState.
    system_message str
    System message that would be displayed to the operator users on accessing the target resource under the governance of this operator control.
    time_of_creation str
    Time when the operator control was created expressed in RFC 3339 timestamp format. Example: '2020-05-22T21:10:29.600Z'
    time_of_deletion str
    Time when deleted expressed in RFC 3339timestamp format. Example: '2020-05-22T21:10:29.600Z'. Note a deleted operator control still stays in the system, so that you can still audit operator actions associated with access requests raised on target resources governed by the deleted operator control.
    time_of_modification str
    Time when the operator control was last modified expressed in RFC 3339 timestamp format. Example: '2020-05-22T21:10:29.600Z'
    approvalRequiredOpActionLists List<String>
    List of operator actions that need explicit approval. Any operator action not in the pre-approved list will require explicit approval. Access requests associated with a resource governed by this operator control will be require explicit approval if the access request contains any operator action in this list.
    approverGroupsLists List<String>
    List of user groups who can approve an access request associated with a target resource under the governance of this operator control.
    approversLists List<String>
    List of users who can approve an access request associated with a target resource under the governance of this operator control.
    compartmentId String
    The ID of the compartment in which to list resources.
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace.
    description String
    Description of operator control.
    emailIdLists List<String>
    List of emailId.
    freeformTags Map<String>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
    id String
    The OCID of the operator control.
    isDefaultOperatorControl Boolean
    Whether the operator control is a default Operator Control.
    isFullyPreApproved Boolean
    Whether all the operator actions have been pre-approved. If yes, all access requests associated with a resource governed by this operator control will be auto-approved.
    lastModifiedInfo String
    Description associated with the latest modification of the operator control.
    numberOfApprovers Number
    Number of approvers required to approve an access request.
    operatorControlName String
    Name of the operator control. The name must be unique.
    preApprovedOpActionLists List<String>
    List of pre-approved operator actions. Access requests associated with a resource governed by this operator control will be automatically approved if the access request only contain operator actions in the pre-approved list.
    resourceType String
    A filter to return only lists of resources that match the entire given service type.
    state String
    A filter to return only resources whose lifecycleState matches the given OperatorControl lifecycleState.
    systemMessage String
    System message that would be displayed to the operator users on accessing the target resource under the governance of this operator control.
    timeOfCreation String
    Time when the operator control was created expressed in RFC 3339 timestamp format. Example: '2020-05-22T21:10:29.600Z'
    timeOfDeletion String
    Time when deleted expressed in RFC 3339timestamp format. Example: '2020-05-22T21:10:29.600Z'. Note a deleted operator control still stays in the system, so that you can still audit operator actions associated with access requests raised on target resources governed by the deleted operator control.
    timeOfModification String
    Time when the operator control was last modified expressed in RFC 3339 timestamp format. Example: '2020-05-22T21:10:29.600Z'

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi