pulumi-cloudamqp 3.18.0a1709359306__py3-none-any.whl → 3.21.0a1736832130__py3-none-any.whl

pulumi_cloudamqp/integration_log.py

@@ -4,9 +4,14 @@
 
 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__ = ['IntegrationLogArgs', 'IntegrationLog']
@@ -67,7 +72,9 @@ class IntegrationLogArgs:
         :param pulumi.Input[str] sourcetype: Assign source type to the data exported, eg. generic_single_line. (Splunk)
         :param pulumi.Input[str] subsystem: The subsystem name for Coralogix.
         :param pulumi.Input[str] table: The table name for Azure monitor.
-        :param pulumi.Input[str] tags: Tag the integration, e.g. env=prod,region=europe.
+        :param pulumi.Input[str] tags: Tags. e.g. `env=prod,region=europe`.
+               
+               ***Note: If tags are used with Datadog. The value part (prod, europe, ...) must start with a letter, read more about tags format in the [Datadog documentation](https://docs.datadoghq.com/getting_started/tagging/#define-tags)***
         :param pulumi.Input[str] tenant_id: The tenant identifier for Azure monitor.
         :param pulumi.Input[str] token: Token used for authentication.
         :param pulumi.Input[str] url: Endpoint to log integration.
@@ -395,7 +402,9 @@ class IntegrationLogArgs:
     @pulumi.getter
     def tags(self) -> Optional[pulumi.Input[str]]:
         """
-        Tag the integration, e.g. env=prod,region=europe.
+        Tags. e.g. `env=prod,region=europe`.
+
+        ***Note: If tags are used with Datadog. The value part (prod, europe, ...) must start with a letter, read more about tags format in the [Datadog documentation](https://docs.datadoghq.com/getting_started/tagging/#define-tags)***
         """
         return pulumi.get(self, "tags")
 
@@ -496,7 +505,9 @@ class _IntegrationLogState:
         :param pulumi.Input[str] sourcetype: Assign source type to the data exported, eg. generic_single_line. (Splunk)
         :param pulumi.Input[str] subsystem: The subsystem name for Coralogix.
         :param pulumi.Input[str] table: The table name for Azure monitor.
-        :param pulumi.Input[str] tags: Tag the integration, e.g. env=prod,region=europe.
+        :param pulumi.Input[str] tags: Tags. e.g. `env=prod,region=europe`.
+               
+               ***Note: If tags are used with Datadog. The value part (prod, europe, ...) must start with a letter, read more about tags format in the [Datadog documentation](https://docs.datadoghq.com/getting_started/tagging/#define-tags)***
         :param pulumi.Input[str] tenant_id: The tenant identifier for Azure monitor.
         :param pulumi.Input[str] token: Token used for authentication.
         :param pulumi.Input[str] url: Endpoint to log integration.
@@ -825,7 +836,9 @@ class _IntegrationLogState:
     @pulumi.getter
     def tags(self) -> Optional[pulumi.Input[str]]:
         """
-        Tag the integration, e.g. env=prod,region=europe.
+        Tags. e.g. `env=prod,region=europe`.
+
+        ***Note: If tags are used with Datadog. The value part (prod, europe, ...) must start with a letter, read more about tags format in the [Datadog documentation](https://docs.datadoghq.com/getting_started/tagging/#define-tags)***
         """
         return pulumi.get(self, "tags")
 
@@ -908,30 +921,215 @@ class IntegrationLog(pulumi.CustomResource):
 
         Only available for dedicated subscription plans.
 
-        ## Integration Type reference
+        ## Example Usage
+
+        <details>
+          <summary>
+            <b>
+              <i>Azure monitor log integration</i>
+            </b>
+          </summary>
+
+        ```python
+        import pulumi
+        import pulumi_cloudamqp as cloudamqp
+
+        azure_monitor = cloudamqp.IntegrationLog("azure_monitor",
+            instance_id=instance["id"],
+            name="azure_monitor",
+            tenant_id=azm_tentant_id,
+            application_id=azm_application_id,
+            application_secret=azm_application_secret,
+            dce_uri=azm_dce_uri,
+            table=azm_table,
+            dcr_id=azm_dcr_id)
+        ```
+
+        </details>
+
+        <details>
+          <summary>
+            <b>
+              <i>Cloudwatch log integration</i>
+            </b>
+          </summary>
+
+        ```python
+        import pulumi
+        import pulumi_cloudamqp as cloudamqp
+
+        cloudwatch = cloudamqp.IntegrationLog("cloudwatch",
+            instance_id=instance["id"],
+            name="cloudwatchlog",
+            access_key_id=aws_access_key_id,
+            secret_access_key=aws_secret_access_key,
+            region=aws_region)
+        ```
+
+        </details>
+
+        <details>
+          <summary>
+            <b>
+              <i>Coralogix log integration</i>
+            </b>
+          </summary>
+
+        ```python
+        import pulumi
+        import pulumi_cloudamqp as cloudamqp
+
+        coralogix = cloudamqp.IntegrationLog("coralogix",
+            instance_id=instance["id"],
+            name="coralogix",
+            private_key=coralogix_send_data_key,
+            endpoint=coralogix_endpoint,
+            application=coralogix_application,
+            subsystem=instance["host"])
+        ```
+
+        </details>
+
+        <details>
+          <summary>
+            <b>
+              <i>Datadog log integration</i>
+            </b>
+          </summary>
+
+        ```python
+        import pulumi
+        import pulumi_cloudamqp as cloudamqp
+
+        datadog = cloudamqp.IntegrationLog("datadog",
+            instance_id=instance["id"],
+            name="datadog",
+            region=datadog_region,
+            api_key=datadog_api_key,
+            tags="env=prod,region=us1,version=v1.0")
+        ```
+
+        </details>
 
-        Valid arguments for third party log integrations. See more information at [docs.cloudamqp.com](https://docs.cloudamqp.com/cloudamqp_api.html#add-log-integration)
+        <details>
+          <summary>
+            <b>
+              <i>Logentries log integration</i>
+            </b>
+          </summary>
 
-        Required arguments for all integrations: name
+        ```python
+        import pulumi
+        import pulumi_cloudamqp as cloudamqp
 
-        | Integration | name | Required arguments |
-        | ---- | ---- | ---- |
-        | Azure monitor | azure_monitor | tenant_id, application_id, application_secret, dce_uri, table, dcr_id |
-        | CloudWatch | cloudwatchlog | access_key_id, secret_access_key, region |
-        | Coralogix | coralogix | private_key, endpoint, application, subsystem |
-        | Data Dog | datadog | region, api_keys, tags |
-        | Log Entries | logentries | token |
-        | Loggly | loggly | token |
-        | Papertrail | papertrail | url |
-        | Scalyr | scalyr | token, host |
-        | Splunk | splunk | token, host_port, sourcetype |
-        | Stackdriver | stackdriver | credentials |
+        logentries = cloudamqp.IntegrationLog("logentries",
+            instance_id=instance["id"],
+            name="logentries",
+            token=logentries_token)
+        ```
+
+        </details>
 
-        ***Note:*** Stackdriver (v1.20.2 or earlier versions) required arguments  : project_id, private_key, client_email
+        <details>
+          <summary>
+            <b>
+              <i>Loggly log integration</i>
+            </b>
+          </summary>
 
-        ## Dependency
+        ```python
+        import pulumi
+        import pulumi_cloudamqp as cloudamqp
+
+        loggly = cloudamqp.IntegrationLog("loggly",
+            instance_id=instance["id"],
+            name="loggly",
+            token=loggly_token)
+        ```
+        </details>
+
+        <details>
+          <summary>
+            <b>
+              <i>Papertrail log integration</i>
+            </b>
+          </summary>
+
+        ```python
+        import pulumi
+        import pulumi_cloudamqp as cloudamqp
+
+        papertrail = cloudamqp.IntegrationLog("papertrail",
+            instance_id=instance["id"],
+            name="papertrail",
+            url=papertrail_url)
+        ```
+
+        </details>
+
+        <details>
+          <summary>
+            <b>
+              <i>Scalyr log integration</i>
+            </b>
+          </summary>
+
+        ```python
+        import pulumi
+        import pulumi_cloudamqp as cloudamqp
+
+        scalyr = cloudamqp.IntegrationLog("scalyr",
+            instance_id=instance["id"],
+            name="scalyr",
+            token=scalyr_token,
+            host=scalyr_host)
+        ```
+
+        <details>
+          <summary>
+            <b>
+              <i>Splunk log integration</i>
+            </b>
+          </summary>
+
+        ```python
+        import pulumi
+        import pulumi_cloudamqp as cloudamqp
+
+        splunk = cloudamqp.IntegrationLog("splunk",
+            instance_id=instance["id"],
+            name="splunk",
+            token=splunk_token,
+            host_port=splunk_host_port,
+            source_type="generic_single_line")
+        ```
+
+        </details>
+
+        </details>
+
+        <details>
+          <summary>
+            <b>
+              <i>Stackdriver log integration (v1.20.2 or older versions)</i>
+            </b>
+          </summary>
+
+        Use variable file populated with project_id, private_key and client_email
+
+        ```python
+        import pulumi
+        import pulumi_cloudamqp as cloudamqp
+
+        stackdriver = cloudamqp.IntegrationLog("stackdriver",
+            instance_id=instance["id"],
+            name="stackdriver",
+            project_id=stackdriver_project_id,
+            private_key=stackdriver_private_key,
+            client_email=stackdriver_client_email)
+        ```
 
-        This resource depends on CloudAMQP instance identifier, `cloudamqp_instance.instance.id`.
+        or by using google_service_account_key resource from Google provider
 
         ## Import
 
@@ -968,7 +1166,9 @@ class IntegrationLog(pulumi.CustomResource):
         :param pulumi.Input[str] sourcetype: Assign source type to the data exported, eg. generic_single_line. (Splunk)
         :param pulumi.Input[str] subsystem: The subsystem name for Coralogix.
         :param pulumi.Input[str] table: The table name for Azure monitor.
-        :param pulumi.Input[str] tags: Tag the integration, e.g. env=prod,region=europe.
+        :param pulumi.Input[str] tags: Tags. e.g. `env=prod,region=europe`.
+               
+               ***Note: If tags are used with Datadog. The value part (prod, europe, ...) must start with a letter, read more about tags format in the [Datadog documentation](https://docs.datadoghq.com/getting_started/tagging/#define-tags)***
         :param pulumi.Input[str] tenant_id: The tenant identifier for Azure monitor.
         :param pulumi.Input[str] token: Token used for authentication.
         :param pulumi.Input[str] url: Endpoint to log integration.
@@ -985,30 +1185,215 @@ class IntegrationLog(pulumi.CustomResource):
 
         Only available for dedicated subscription plans.
 
-        ## Integration Type reference
+        ## Example Usage
+
+        <details>
+          <summary>
+            <b>
+              <i>Azure monitor log integration</i>
+            </b>
+          </summary>
+
+        ```python
+        import pulumi
+        import pulumi_cloudamqp as cloudamqp
+
+        azure_monitor = cloudamqp.IntegrationLog("azure_monitor",
+            instance_id=instance["id"],
+            name="azure_monitor",
+            tenant_id=azm_tentant_id,
+            application_id=azm_application_id,
+            application_secret=azm_application_secret,
+            dce_uri=azm_dce_uri,
+            table=azm_table,
+            dcr_id=azm_dcr_id)
+        ```
+
+        </details>
+
+        <details>
+          <summary>
+            <b>
+              <i>Cloudwatch log integration</i>
+            </b>
+          </summary>
+
+        ```python
+        import pulumi
+        import pulumi_cloudamqp as cloudamqp
+
+        cloudwatch = cloudamqp.IntegrationLog("cloudwatch",
+            instance_id=instance["id"],
+            name="cloudwatchlog",
+            access_key_id=aws_access_key_id,
+            secret_access_key=aws_secret_access_key,
+            region=aws_region)
+        ```
+
+        </details>
+
+        <details>
+          <summary>
+            <b>
+              <i>Coralogix log integration</i>
+            </b>
+          </summary>
+
+        ```python
+        import pulumi
+        import pulumi_cloudamqp as cloudamqp
+
+        coralogix = cloudamqp.IntegrationLog("coralogix",
+            instance_id=instance["id"],
+            name="coralogix",
+            private_key=coralogix_send_data_key,
+            endpoint=coralogix_endpoint,
+            application=coralogix_application,
+            subsystem=instance["host"])
+        ```
+
+        </details>
+
+        <details>
+          <summary>
+            <b>
+              <i>Datadog log integration</i>
+            </b>
+          </summary>
+
+        ```python
+        import pulumi
+        import pulumi_cloudamqp as cloudamqp
+
+        datadog = cloudamqp.IntegrationLog("datadog",
+            instance_id=instance["id"],
+            name="datadog",
+            region=datadog_region,
+            api_key=datadog_api_key,
+            tags="env=prod,region=us1,version=v1.0")
+        ```
+
+        </details>
+
+        <details>
+          <summary>
+            <b>
+              <i>Logentries log integration</i>
+            </b>
+          </summary>
+
+        ```python
+        import pulumi
+        import pulumi_cloudamqp as cloudamqp
+
+        logentries = cloudamqp.IntegrationLog("logentries",
+            instance_id=instance["id"],
+            name="logentries",
+            token=logentries_token)
+        ```
+
+        </details>
+
+        <details>
+          <summary>
+            <b>
+              <i>Loggly log integration</i>
+            </b>
+          </summary>
 
-        Valid arguments for third party log integrations. See more information at [docs.cloudamqp.com](https://docs.cloudamqp.com/cloudamqp_api.html#add-log-integration)
+        ```python
+        import pulumi
+        import pulumi_cloudamqp as cloudamqp
 
-        Required arguments for all integrations: name
+        loggly = cloudamqp.IntegrationLog("loggly",
+            instance_id=instance["id"],
+            name="loggly",
+            token=loggly_token)
+        ```
+        </details>
+
+        <details>
+          <summary>
+            <b>
+              <i>Papertrail log integration</i>
+            </b>
+          </summary>
+
+        ```python
+        import pulumi
+        import pulumi_cloudamqp as cloudamqp
+
+        papertrail = cloudamqp.IntegrationLog("papertrail",
+            instance_id=instance["id"],
+            name="papertrail",
+            url=papertrail_url)
+        ```
+
+        </details>
+
+        <details>
+          <summary>
+            <b>
+              <i>Scalyr log integration</i>
+            </b>
+          </summary>
 
-        | Integration | name | Required arguments |
-        | ---- | ---- | ---- |
-        | Azure monitor | azure_monitor | tenant_id, application_id, application_secret, dce_uri, table, dcr_id |
-        | CloudWatch | cloudwatchlog | access_key_id, secret_access_key, region |
-        | Coralogix | coralogix | private_key, endpoint, application, subsystem |
-        | Data Dog | datadog | region, api_keys, tags |
-        | Log Entries | logentries | token |
-        | Loggly | loggly | token |
-        | Papertrail | papertrail | url |
-        | Scalyr | scalyr | token, host |
-        | Splunk | splunk | token, host_port, sourcetype |
-        | Stackdriver | stackdriver | credentials |
+        ```python
+        import pulumi
+        import pulumi_cloudamqp as cloudamqp
+
+        scalyr = cloudamqp.IntegrationLog("scalyr",
+            instance_id=instance["id"],
+            name="scalyr",
+            token=scalyr_token,
+            host=scalyr_host)
+        ```
+
+        <details>
+          <summary>
+            <b>
+              <i>Splunk log integration</i>
+            </b>
+          </summary>
+
+        ```python
+        import pulumi
+        import pulumi_cloudamqp as cloudamqp
+
+        splunk = cloudamqp.IntegrationLog("splunk",
+            instance_id=instance["id"],
+            name="splunk",
+            token=splunk_token,
+            host_port=splunk_host_port,
+            source_type="generic_single_line")
+        ```
 
-        ***Note:*** Stackdriver (v1.20.2 or earlier versions) required arguments  : project_id, private_key, client_email
+        </details>
 
-        ## Dependency
+        </details>
 
-        This resource depends on CloudAMQP instance identifier, `cloudamqp_instance.instance.id`.
+        <details>
+          <summary>
+            <b>
+              <i>Stackdriver log integration (v1.20.2 or older versions)</i>
+            </b>
+          </summary>
+
+        Use variable file populated with project_id, private_key and client_email
+
+        ```python
+        import pulumi
+        import pulumi_cloudamqp as cloudamqp
+
+        stackdriver = cloudamqp.IntegrationLog("stackdriver",
+            instance_id=instance["id"],
+            name="stackdriver",
+            project_id=stackdriver_project_id,
+            private_key=stackdriver_private_key,
+            client_email=stackdriver_client_email)
+        ```
+
+        or by using google_service_account_key resource from Google provider
 
         ## Import
 
@@ -1166,7 +1551,9 @@ class IntegrationLog(pulumi.CustomResource):
         :param pulumi.Input[str] sourcetype: Assign source type to the data exported, eg. generic_single_line. (Splunk)
         :param pulumi.Input[str] subsystem: The subsystem name for Coralogix.
         :param pulumi.Input[str] table: The table name for Azure monitor.
-        :param pulumi.Input[str] tags: Tag the integration, e.g. env=prod,region=europe.
+        :param pulumi.Input[str] tags: Tags. e.g. `env=prod,region=europe`.
+               
+               ***Note: If tags are used with Datadog. The value part (prod, europe, ...) must start with a letter, read more about tags format in the [Datadog documentation](https://docs.datadoghq.com/getting_started/tagging/#define-tags)***
         :param pulumi.Input[str] tenant_id: The tenant identifier for Azure monitor.
         :param pulumi.Input[str] token: Token used for authentication.
         :param pulumi.Input[str] url: Endpoint to log integration.
@@ -1386,7 +1773,9 @@ class IntegrationLog(pulumi.CustomResource):
     @pulumi.getter
     def tags(self) -> pulumi.Output[Optional[str]]:
         """
-        Tag the integration, e.g. env=prod,region=europe.
+        Tags. e.g. `env=prod,region=europe`.
+
+        ***Note: If tags are used with Datadog. The value part (prod, europe, ...) must start with a letter, read more about tags format in the [Datadog documentation](https://docs.datadoghq.com/getting_started/tagging/#define-tags)***
         """
         return pulumi.get(self, "tags")