Package com.oracle.bmc.delegateaccesscontrol.model

Class CreateDelegationControlDetails

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20230801")
public final class CreateDelegationControlDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    While creating the Delegation Control, specify how Service Provider Actions are approved and the users who have the privilege of approving the Service Provider Actions associated with the Delegation Control.

    You must specify which Service Provider Actions must be pre-approved. The rest of the Service Provider Actions associated with the Delegation Control will require an explicit approval from the users selected either through the approver groups or individually.

    You must name your Delegation Control appropriately so it reflects the resources that will be governed by the Delegation Control. Neither the Delegation Controls nor their assignments to resources are visible to the support operators.
    Note: Objects should always be created or deserialized using the CreateDelegationControlDetails.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the CreateDelegationControlDetails.Builder, which maintain a set of all explicitly set fields called CreateDelegationControlDetails.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment that contains this Delegation Control.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        Name of the Delegation Control.

        The name does not need to be unique.

        Returns:
        the value

      • getDescription

        public String getDescription()
        Description of the Delegation Control.
        Returns:
        the value

      • getNumApprovalsRequired

        public Integer getNumApprovalsRequired()
        number of approvals required.
        Returns:
        the value

      • getPreApprovedServiceProviderActionNames

        public List<String> getPreApprovedServiceProviderActionNames()
        List of pre-approved Service Provider Action names.

        The list of pre-defined Service Provider Actions can be obtained from the ListServiceProviderActions API. Delegated Resource Access Requests associated with a resource governed by this Delegation Control will be automatically approved if the Delegated Resource Access Request only contain Service Provider Actions in the pre-approved list.

        Returns:
        the value

      • getDelegationSubscriptionIds

        public List<String> getDelegationSubscriptionIds()
        List of Delegation Subscription OCID that are allowed for this Delegation Control.

        The allowed subscriptions will determine the available Service Provider Actions. Only support operators for the allowed subscriptions are allowed to create Delegated Resource Access Request.

        Returns:
        the value

      • getIsAutoApproveDuringMaintenance

        public Boolean getIsAutoApproveDuringMaintenance()
        Set to true to allow all Delegated Resource Access Request to be approved automatically during maintenance.
        Returns:
        the value

      • getResourceIds

        public List<String> getResourceIds()
        The OCID of the selected resources that this Delegation Control is applicable to.
        Returns:
        the value

      • getResourceType

        public DelegationControlResourceType getResourceType()
        Resource type for which the Delegation Control is applicable to.
        Returns:
        the value

      • getNotificationTopicId

        public String getNotificationTopicId()
        The OCID of the OCI Notification topic to publish messages related to this Delegation Control.
        Returns:
        the value

      • getVaultId

        public String getVaultId()
        The OCID of the OCI Vault that will store the secrets containing the SSH keys to access the resource governed by this Delegation Control by Delegate Access Control Service.

        This property is required when resourceType is CLOUDVMCLUSTER. Delegate Access Control Service will generate the SSH keys and store them as secrets in the OCI Vault.

        Returns:
        the value

      • getVaultKeyId

        public String getVaultKeyId()
        The OCID of the Master Encryption Key in the OCI Vault specified by vaultId.

        This key will be used to encrypt the SSH keys to access the resource governed by this Delegation Control by Delegate Access Control Service. This property is required when resourceType is CLOUDVMCLUSTER.

        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        Free-form tags for this resource.

        Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

        Example: {"Department": "Finance"}

        Returns:
        the value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

        Example: {"Operations": {"CostCenter": "42"}}

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel