pulumi-oci 2.25.0a1740032973__py3-none-any.whl → 2.26.0__py3-none-any.whl

pulumi_oci/tenantmanagercontrolplane/get_sender_invitation.py

@@ -0,0 +1,295 @@
+# coding=utf-8
+# *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import copy
+import warnings
+import sys
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
+from .. import _utilities
+
+__all__ = [
+    'GetSenderInvitationResult',
+    'AwaitableGetSenderInvitationResult',
+    'get_sender_invitation',
+    'get_sender_invitation_output',
+]
+
+@pulumi.output_type
+class GetSenderInvitationResult:
+    """
+    A collection of values returned by getSenderInvitation.
+    """
+    def __init__(__self__, compartment_id=None, defined_tags=None, display_name=None, freeform_tags=None, id=None, recipient_email_address=None, recipient_invitation_id=None, recipient_tenancy_id=None, sender_invitation_id=None, state=None, status=None, subjects=None, system_tags=None, time_created=None, time_updated=None):
+        if compartment_id and not isinstance(compartment_id, str):
+            raise TypeError("Expected argument 'compartment_id' to be a str")
+        pulumi.set(__self__, "compartment_id", compartment_id)
+        if defined_tags and not isinstance(defined_tags, dict):
+            raise TypeError("Expected argument 'defined_tags' to be a dict")
+        pulumi.set(__self__, "defined_tags", defined_tags)
+        if display_name and not isinstance(display_name, str):
+            raise TypeError("Expected argument 'display_name' to be a str")
+        pulumi.set(__self__, "display_name", display_name)
+        if freeform_tags and not isinstance(freeform_tags, dict):
+            raise TypeError("Expected argument 'freeform_tags' to be a dict")
+        pulumi.set(__self__, "freeform_tags", freeform_tags)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if recipient_email_address and not isinstance(recipient_email_address, str):
+            raise TypeError("Expected argument 'recipient_email_address' to be a str")
+        pulumi.set(__self__, "recipient_email_address", recipient_email_address)
+        if recipient_invitation_id and not isinstance(recipient_invitation_id, str):
+            raise TypeError("Expected argument 'recipient_invitation_id' to be a str")
+        pulumi.set(__self__, "recipient_invitation_id", recipient_invitation_id)
+        if recipient_tenancy_id and not isinstance(recipient_tenancy_id, str):
+            raise TypeError("Expected argument 'recipient_tenancy_id' to be a str")
+        pulumi.set(__self__, "recipient_tenancy_id", recipient_tenancy_id)
+        if sender_invitation_id and not isinstance(sender_invitation_id, str):
+            raise TypeError("Expected argument 'sender_invitation_id' to be a str")
+        pulumi.set(__self__, "sender_invitation_id", sender_invitation_id)
+        if state and not isinstance(state, str):
+            raise TypeError("Expected argument 'state' to be a str")
+        pulumi.set(__self__, "state", state)
+        if status and not isinstance(status, str):
+            raise TypeError("Expected argument 'status' to be a str")
+        pulumi.set(__self__, "status", status)
+        if subjects and not isinstance(subjects, list):
+            raise TypeError("Expected argument 'subjects' to be a list")
+        pulumi.set(__self__, "subjects", subjects)
+        if system_tags and not isinstance(system_tags, dict):
+            raise TypeError("Expected argument 'system_tags' to be a dict")
+        pulumi.set(__self__, "system_tags", system_tags)
+        if time_created and not isinstance(time_created, str):
+            raise TypeError("Expected argument 'time_created' to be a str")
+        pulumi.set(__self__, "time_created", time_created)
+        if time_updated and not isinstance(time_updated, str):
+            raise TypeError("Expected argument 'time_updated' to be a str")
+        pulumi.set(__self__, "time_updated", time_updated)
+
+    @property
+    @pulumi.getter(name="compartmentId")
+    def compartment_id(self) -> str:
+        """
+        OCID of the sender tenancy.
+        """
+        return pulumi.get(self, "compartment_id")
+
+    @property
+    @pulumi.getter(name="definedTags")
+    def defined_tags(self) -> Mapping[str, str]:
+        """
+        Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`
+        """
+        return pulumi.get(self, "defined_tags")
+
+    @property
+    @pulumi.getter(name="displayName")
+    def display_name(self) -> str:
+        """
+        A user-created name to describe the invitation. Avoid entering confidential information.
+        """
+        return pulumi.get(self, "display_name")
+
+    @property
+    @pulumi.getter(name="freeformTags")
+    def freeform_tags(self) -> Mapping[str, str]:
+        """
+        Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
+        """
+        return pulumi.get(self, "freeform_tags")
+
+    @property
+    @pulumi.getter
+    def id(self) -> str:
+        """
+        The provider-assigned unique ID for this managed resource.
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter(name="recipientEmailAddress")
+    def recipient_email_address(self) -> str:
+        """
+        Email address of the recipient.
+        """
+        return pulumi.get(self, "recipient_email_address")
+
+    @property
+    @pulumi.getter(name="recipientInvitationId")
+    def recipient_invitation_id(self) -> str:
+        """
+        OCID of the corresponding recipient invitation.
+        """
+        return pulumi.get(self, "recipient_invitation_id")
+
+    @property
+    @pulumi.getter(name="recipientTenancyId")
+    def recipient_tenancy_id(self) -> str:
+        """
+        OCID of the recipient tenancy.
+        """
+        return pulumi.get(self, "recipient_tenancy_id")
+
+    @property
+    @pulumi.getter(name="senderInvitationId")
+    def sender_invitation_id(self) -> str:
+        return pulumi.get(self, "sender_invitation_id")
+
+    @property
+    @pulumi.getter
+    def state(self) -> str:
+        """
+        Lifecycle state of the sender invitation.
+        """
+        return pulumi.get(self, "state")
+
+    @property
+    @pulumi.getter
+    def status(self) -> str:
+        """
+        Status of the sender invitation.
+        """
+        return pulumi.get(self, "status")
+
+    @property
+    @pulumi.getter
+    def subjects(self) -> Sequence[str]:
+        """
+        The list of subjects the invitation contains.
+        """
+        return pulumi.get(self, "subjects")
+
+    @property
+    @pulumi.getter(name="systemTags")
+    def system_tags(self) -> Mapping[str, str]:
+        """
+        Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}`
+        """
+        return pulumi.get(self, "system_tags")
+
+    @property
+    @pulumi.getter(name="timeCreated")
+    def time_created(self) -> str:
+        """
+        Date and time when the sender invitation was created.
+        """
+        return pulumi.get(self, "time_created")
+
+    @property
+    @pulumi.getter(name="timeUpdated")
+    def time_updated(self) -> str:
+        """
+        Date and time when the sender invitation was last updated.
+        """
+        return pulumi.get(self, "time_updated")
+
+
+class AwaitableGetSenderInvitationResult(GetSenderInvitationResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetSenderInvitationResult(
+            compartment_id=self.compartment_id,
+            defined_tags=self.defined_tags,
+            display_name=self.display_name,
+            freeform_tags=self.freeform_tags,
+            id=self.id,
+            recipient_email_address=self.recipient_email_address,
+            recipient_invitation_id=self.recipient_invitation_id,
+            recipient_tenancy_id=self.recipient_tenancy_id,
+            sender_invitation_id=self.sender_invitation_id,
+            state=self.state,
+            status=self.status,
+            subjects=self.subjects,
+            system_tags=self.system_tags,
+            time_created=self.time_created,
+            time_updated=self.time_updated)
+
+
+def get_sender_invitation(sender_invitation_id: Optional[str] = None,
+                          opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetSenderInvitationResult:
+    """
+    This data source provides details about a specific Sender Invitation resource in Oracle Cloud Infrastructure Tenantmanagercontrolplane service.
+
+    Gets information about the sender invitation.
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_oci as oci
+
+    test_sender_invitation = oci.Tenantmanagercontrolplane.get_sender_invitation(sender_invitation_id=test_sender_invitation_oci_tenantmanagercontrolplane_sender_invitation["id"])
+    ```
+
+
+    :param str sender_invitation_id: OCID of the sender invitation to retrieve.
+    """
+    __args__ = dict()
+    __args__['senderInvitationId'] = sender_invitation_id
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('oci:Tenantmanagercontrolplane/getSenderInvitation:getSenderInvitation', __args__, opts=opts, typ=GetSenderInvitationResult).value
+
+    return AwaitableGetSenderInvitationResult(
+        compartment_id=pulumi.get(__ret__, 'compartment_id'),
+        defined_tags=pulumi.get(__ret__, 'defined_tags'),
+        display_name=pulumi.get(__ret__, 'display_name'),
+        freeform_tags=pulumi.get(__ret__, 'freeform_tags'),
+        id=pulumi.get(__ret__, 'id'),
+        recipient_email_address=pulumi.get(__ret__, 'recipient_email_address'),
+        recipient_invitation_id=pulumi.get(__ret__, 'recipient_invitation_id'),
+        recipient_tenancy_id=pulumi.get(__ret__, 'recipient_tenancy_id'),
+        sender_invitation_id=pulumi.get(__ret__, 'sender_invitation_id'),
+        state=pulumi.get(__ret__, 'state'),
+        status=pulumi.get(__ret__, 'status'),
+        subjects=pulumi.get(__ret__, 'subjects'),
+        system_tags=pulumi.get(__ret__, 'system_tags'),
+        time_created=pulumi.get(__ret__, 'time_created'),
+        time_updated=pulumi.get(__ret__, 'time_updated'))
+def get_sender_invitation_output(sender_invitation_id: Optional[pulumi.Input[str]] = None,
+                                 opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetSenderInvitationResult]:
+    """
+    This data source provides details about a specific Sender Invitation resource in Oracle Cloud Infrastructure Tenantmanagercontrolplane service.
+
+    Gets information about the sender invitation.
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_oci as oci
+
+    test_sender_invitation = oci.Tenantmanagercontrolplane.get_sender_invitation(sender_invitation_id=test_sender_invitation_oci_tenantmanagercontrolplane_sender_invitation["id"])
+    ```
+
+
+    :param str sender_invitation_id: OCID of the sender invitation to retrieve.
+    """
+    __args__ = dict()
+    __args__['senderInvitationId'] = sender_invitation_id
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('oci:Tenantmanagercontrolplane/getSenderInvitation:getSenderInvitation', __args__, opts=opts, typ=GetSenderInvitationResult)
+    return __ret__.apply(lambda __response__: GetSenderInvitationResult(
+        compartment_id=pulumi.get(__response__, 'compartment_id'),
+        defined_tags=pulumi.get(__response__, 'defined_tags'),
+        display_name=pulumi.get(__response__, 'display_name'),
+        freeform_tags=pulumi.get(__response__, 'freeform_tags'),
+        id=pulumi.get(__response__, 'id'),
+        recipient_email_address=pulumi.get(__response__, 'recipient_email_address'),
+        recipient_invitation_id=pulumi.get(__response__, 'recipient_invitation_id'),
+        recipient_tenancy_id=pulumi.get(__response__, 'recipient_tenancy_id'),
+        sender_invitation_id=pulumi.get(__response__, 'sender_invitation_id'),
+        state=pulumi.get(__response__, 'state'),
+        status=pulumi.get(__response__, 'status'),
+        subjects=pulumi.get(__response__, 'subjects'),
+        system_tags=pulumi.get(__response__, 'system_tags'),
+        time_created=pulumi.get(__response__, 'time_created'),
+        time_updated=pulumi.get(__response__, 'time_updated')))

pulumi_oci/tenantmanagercontrolplane/get_sender_invitations.py

@@ -0,0 +1,235 @@
+# coding=utf-8
+# *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import copy
+import warnings
+import sys
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
+from .. import _utilities
+from . import outputs
+from ._inputs import *
+
+__all__ = [
+    'GetSenderInvitationsResult',
+    'AwaitableGetSenderInvitationsResult',
+    'get_sender_invitations',
+    'get_sender_invitations_output',
+]
+
+@pulumi.output_type
+class GetSenderInvitationsResult:
+    """
+    A collection of values returned by getSenderInvitations.
+    """
+    def __init__(__self__, compartment_id=None, display_name=None, filters=None, id=None, recipient_tenancy_id=None, sender_invitation_collections=None, state=None, status=None):
+        if compartment_id and not isinstance(compartment_id, str):
+            raise TypeError("Expected argument 'compartment_id' to be a str")
+        pulumi.set(__self__, "compartment_id", compartment_id)
+        if display_name and not isinstance(display_name, str):
+            raise TypeError("Expected argument 'display_name' to be a str")
+        pulumi.set(__self__, "display_name", display_name)
+        if filters and not isinstance(filters, list):
+            raise TypeError("Expected argument 'filters' to be a list")
+        pulumi.set(__self__, "filters", filters)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if recipient_tenancy_id and not isinstance(recipient_tenancy_id, str):
+            raise TypeError("Expected argument 'recipient_tenancy_id' to be a str")
+        pulumi.set(__self__, "recipient_tenancy_id", recipient_tenancy_id)
+        if sender_invitation_collections and not isinstance(sender_invitation_collections, list):
+            raise TypeError("Expected argument 'sender_invitation_collections' to be a list")
+        pulumi.set(__self__, "sender_invitation_collections", sender_invitation_collections)
+        if state and not isinstance(state, str):
+            raise TypeError("Expected argument 'state' to be a str")
+        pulumi.set(__self__, "state", state)
+        if status and not isinstance(status, str):
+            raise TypeError("Expected argument 'status' to be a str")
+        pulumi.set(__self__, "status", status)
+
+    @property
+    @pulumi.getter(name="compartmentId")
+    def compartment_id(self) -> str:
+        """
+        OCID of the sender tenancy.
+        """
+        return pulumi.get(self, "compartment_id")
+
+    @property
+    @pulumi.getter(name="displayName")
+    def display_name(self) -> Optional[str]:
+        """
+        A user-created name to describe the invitation. Avoid entering confidential information.
+        """
+        return pulumi.get(self, "display_name")
+
+    @property
+    @pulumi.getter
+    def filters(self) -> Optional[Sequence['outputs.GetSenderInvitationsFilterResult']]:
+        return pulumi.get(self, "filters")
+
+    @property
+    @pulumi.getter
+    def id(self) -> str:
+        """
+        The provider-assigned unique ID for this managed resource.
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter(name="recipientTenancyId")
+    def recipient_tenancy_id(self) -> Optional[str]:
+        """
+        OCID of the recipient tenancy.
+        """
+        return pulumi.get(self, "recipient_tenancy_id")
+
+    @property
+    @pulumi.getter(name="senderInvitationCollections")
+    def sender_invitation_collections(self) -> Sequence['outputs.GetSenderInvitationsSenderInvitationCollectionResult']:
+        """
+        The list of sender_invitation_collection.
+        """
+        return pulumi.get(self, "sender_invitation_collections")
+
+    @property
+    @pulumi.getter
+    def state(self) -> Optional[str]:
+        """
+        Lifecycle state of the sender invitation.
+        """
+        return pulumi.get(self, "state")
+
+    @property
+    @pulumi.getter
+    def status(self) -> Optional[str]:
+        """
+        Status of the sender invitation.
+        """
+        return pulumi.get(self, "status")
+
+
+class AwaitableGetSenderInvitationsResult(GetSenderInvitationsResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetSenderInvitationsResult(
+            compartment_id=self.compartment_id,
+            display_name=self.display_name,
+            filters=self.filters,
+            id=self.id,
+            recipient_tenancy_id=self.recipient_tenancy_id,
+            sender_invitation_collections=self.sender_invitation_collections,
+            state=self.state,
+            status=self.status)
+
+
+def get_sender_invitations(compartment_id: Optional[str] = None,
+                           display_name: Optional[str] = None,
+                           filters: Optional[Sequence[Union['GetSenderInvitationsFilterArgs', 'GetSenderInvitationsFilterArgsDict']]] = None,
+                           recipient_tenancy_id: Optional[str] = None,
+                           state: Optional[str] = None,
+                           status: Optional[str] = None,
+                           opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetSenderInvitationsResult:
+    """
+    This data source provides the list of Sender Invitations in Oracle Cloud Infrastructure Tenantmanagercontrolplane service.
+
+    Return a (paginated) list of sender invitations.
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_oci as oci
+
+    test_sender_invitations = oci.Tenantmanagercontrolplane.get_sender_invitations(compartment_id=compartment_id,
+        display_name=sender_invitation_display_name,
+        recipient_tenancy_id=test_tenancy["id"],
+        state=sender_invitation_state,
+        status=sender_invitation_status)
+    ```
+
+
+    :param str compartment_id: The ID of the compartment in which to list resources.
+    :param str display_name: A filter to return only resources that match the entire display name given.
+    :param str recipient_tenancy_id: The tenancy that the invitation is addressed to.
+    :param str state: The lifecycle state of the resource.
+    :param str status: The status of the sender invitation.
+    """
+    __args__ = dict()
+    __args__['compartmentId'] = compartment_id
+    __args__['displayName'] = display_name
+    __args__['filters'] = filters
+    __args__['recipientTenancyId'] = recipient_tenancy_id
+    __args__['state'] = state
+    __args__['status'] = status
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('oci:Tenantmanagercontrolplane/getSenderInvitations:getSenderInvitations', __args__, opts=opts, typ=GetSenderInvitationsResult).value
+
+    return AwaitableGetSenderInvitationsResult(
+        compartment_id=pulumi.get(__ret__, 'compartment_id'),
+        display_name=pulumi.get(__ret__, 'display_name'),
+        filters=pulumi.get(__ret__, 'filters'),
+        id=pulumi.get(__ret__, 'id'),
+        recipient_tenancy_id=pulumi.get(__ret__, 'recipient_tenancy_id'),
+        sender_invitation_collections=pulumi.get(__ret__, 'sender_invitation_collections'),
+        state=pulumi.get(__ret__, 'state'),
+        status=pulumi.get(__ret__, 'status'))
+def get_sender_invitations_output(compartment_id: Optional[pulumi.Input[str]] = None,
+                                  display_name: Optional[pulumi.Input[Optional[str]]] = None,
+                                  filters: Optional[pulumi.Input[Optional[Sequence[Union['GetSenderInvitationsFilterArgs', 'GetSenderInvitationsFilterArgsDict']]]]] = None,
+                                  recipient_tenancy_id: Optional[pulumi.Input[Optional[str]]] = None,
+                                  state: Optional[pulumi.Input[Optional[str]]] = None,
+                                  status: Optional[pulumi.Input[Optional[str]]] = None,
+                                  opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetSenderInvitationsResult]:
+    """
+    This data source provides the list of Sender Invitations in Oracle Cloud Infrastructure Tenantmanagercontrolplane service.
+
+    Return a (paginated) list of sender invitations.
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_oci as oci
+
+    test_sender_invitations = oci.Tenantmanagercontrolplane.get_sender_invitations(compartment_id=compartment_id,
+        display_name=sender_invitation_display_name,
+        recipient_tenancy_id=test_tenancy["id"],
+        state=sender_invitation_state,
+        status=sender_invitation_status)
+    ```
+
+
+    :param str compartment_id: The ID of the compartment in which to list resources.
+    :param str display_name: A filter to return only resources that match the entire display name given.
+    :param str recipient_tenancy_id: The tenancy that the invitation is addressed to.
+    :param str state: The lifecycle state of the resource.
+    :param str status: The status of the sender invitation.
+    """
+    __args__ = dict()
+    __args__['compartmentId'] = compartment_id
+    __args__['displayName'] = display_name
+    __args__['filters'] = filters
+    __args__['recipientTenancyId'] = recipient_tenancy_id
+    __args__['state'] = state
+    __args__['status'] = status
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('oci:Tenantmanagercontrolplane/getSenderInvitations:getSenderInvitations', __args__, opts=opts, typ=GetSenderInvitationsResult)
+    return __ret__.apply(lambda __response__: GetSenderInvitationsResult(
+        compartment_id=pulumi.get(__response__, 'compartment_id'),
+        display_name=pulumi.get(__response__, 'display_name'),
+        filters=pulumi.get(__response__, 'filters'),
+        id=pulumi.get(__response__, 'id'),
+        recipient_tenancy_id=pulumi.get(__response__, 'recipient_tenancy_id'),
+        sender_invitation_collections=pulumi.get(__response__, 'sender_invitation_collections'),
+        state=pulumi.get(__response__, 'state'),
+        status=pulumi.get(__response__, 'status')))