pulumi-harness 0.8.0a1755712204__py3-none-any.whl → 0.8.1__py3-none-any.whl

pulumi_harness/platform/get_har_registry.py

@@ -66,26 +66,41 @@ class GetHarRegistryResult:
     @_builtins.property
     @pulumi.getter(name="allowedPatterns")
     def allowed_patterns(self) -> Optional[Sequence[_builtins.str]]:
+        """
+        Allowed artifact patterns
+        """
         return pulumi.get(self, "allowed_patterns")
 
     @_builtins.property
     @pulumi.getter(name="blockedPatterns")
     def blocked_patterns(self) -> Optional[Sequence[_builtins.str]]:
+        """
+        Blocked artifact patterns
+        """
         return pulumi.get(self, "blocked_patterns")
 
     @_builtins.property
     @pulumi.getter
     def configs(self) -> Optional[Sequence['outputs.GetHarRegistryConfigResult']]:
+        """
+        Configuration for the registry
+        """
         return pulumi.get(self, "configs")
 
     @_builtins.property
     @pulumi.getter(name="createdAt")
     def created_at(self) -> _builtins.str:
+        """
+        Creation timestamp
+        """
         return pulumi.get(self, "created_at")
 
     @_builtins.property
     @pulumi.getter
     def description(self) -> Optional[_builtins.str]:
+        """
+        Description of the registry
+        """
         return pulumi.get(self, "description")
 
     @_builtins.property
@@ -100,31 +115,40 @@ class GetHarRegistryResult:
     @pulumi.getter
     def identifier(self) -> _builtins.str:
         """
-        Unique identifier of the resource.
+        Unique identifier of the registry
         """
         return pulumi.get(self, "identifier")
 
     @_builtins.property
     @pulumi.getter(name="packageType")
     def package_type(self) -> Optional[_builtins.str]:
+        """
+        Type of package (DOCKER, HELM, MAVEN, etc.)
+        """
         return pulumi.get(self, "package_type")
 
     @_builtins.property
     @pulumi.getter(name="parentRef")
     def parent_ref(self) -> Optional[_builtins.str]:
+        """
+        Parent reference for the registry
+        """
         return pulumi.get(self, "parent_ref")
 
     @_builtins.property
     @pulumi.getter(name="spaceRef")
-    def space_ref(self) -> _builtins.str:
+    def space_ref(self) -> Optional[_builtins.str]:
         """
-        Reference of the space.
+        Space reference for the registry
         """
         return pulumi.get(self, "space_ref")
 
     @_builtins.property
     @pulumi.getter
     def url(self) -> _builtins.str:
+        """
+        URL of the registry
+        """
         return pulumi.get(self, "url")
 
 
@@ -157,7 +181,7 @@ def get_har_registry(allowed_patterns: Optional[Sequence[_builtins.str]] = None,
                      space_ref: Optional[_builtins.str] = None,
                      opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetHarRegistryResult:
     """
-    Data Source for retrieving a Harness Artifact registry
+    Resource for creating and managing Harness Registries.
 
     ## Example Usage
 
@@ -170,8 +194,14 @@ def get_har_registry(allowed_patterns: Optional[Sequence[_builtins.str]] = None,
     ```
 
 
-    :param _builtins.str identifier: Unique identifier of the resource.
-    :param _builtins.str space_ref: Reference of the space.
+    :param Sequence[_builtins.str] allowed_patterns: Allowed artifact patterns
+    :param Sequence[_builtins.str] blocked_patterns: Blocked artifact patterns
+    :param Sequence[Union['GetHarRegistryConfigArgs', 'GetHarRegistryConfigArgsDict']] configs: Configuration for the registry
+    :param _builtins.str description: Description of the registry
+    :param _builtins.str identifier: Unique identifier of the registry
+    :param _builtins.str package_type: Type of package (DOCKER, HELM, MAVEN, etc.)
+    :param _builtins.str parent_ref: Parent reference for the registry
+    :param _builtins.str space_ref: Space reference for the registry
     """
     __args__ = dict()
     __args__['allowedPatterns'] = allowed_patterns
@@ -204,10 +234,10 @@ def get_har_registry_output(allowed_patterns: Optional[pulumi.Input[Optional[Seq
                             identifier: Optional[pulumi.Input[_builtins.str]] = None,
                             package_type: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
                             parent_ref: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
-                            space_ref: Optional[pulumi.Input[_builtins.str]] = None,
+                            space_ref: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
                             opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetHarRegistryResult]:
     """
-    Data Source for retrieving a Harness Artifact registry
+    Resource for creating and managing Harness Registries.
 
     ## Example Usage
 
@@ -220,8 +250,14 @@ def get_har_registry_output(allowed_patterns: Optional[pulumi.Input[Optional[Seq
     ```
 
 
-    :param _builtins.str identifier: Unique identifier of the resource.
-    :param _builtins.str space_ref: Reference of the space.
+    :param Sequence[_builtins.str] allowed_patterns: Allowed artifact patterns
+    :param Sequence[_builtins.str] blocked_patterns: Blocked artifact patterns
+    :param Sequence[Union['GetHarRegistryConfigArgs', 'GetHarRegistryConfigArgsDict']] configs: Configuration for the registry
+    :param _builtins.str description: Description of the registry
+    :param _builtins.str identifier: Unique identifier of the registry
+    :param _builtins.str package_type: Type of package (DOCKER, HELM, MAVEN, etc.)
+    :param _builtins.str parent_ref: Parent reference for the registry
+    :param _builtins.str space_ref: Space reference for the registry
     """
     __args__ = dict()
     __args__['allowedPatterns'] = allowed_patterns

pulumi_harness/platform/get_iacm_default_pipeline.py

@@ -117,6 +117,18 @@ def get_iacm_default_pipeline(operation: Optional[_builtins.str] = None,
     """
     Data source for retrieving IACM default pipelines.
 
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_harness as harness
+
+    example = harness.platform.get_iacm_default_pipeline(org_id=test["id"],
+        project_id=test_harness_platform_project["id"],
+        provisioner_type="terraform",
+        operation="plan")
+    ```
+
 
     :param _builtins.str operation: The operation associated with this default.
     :param _builtins.str org_id: Organization identifier of the organization the default pipelines resides in.
@@ -146,6 +158,18 @@ def get_iacm_default_pipeline_output(operation: Optional[pulumi.Input[_builtins.
     """
     Data source for retrieving IACM default pipelines.
 
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_harness as harness
+
+    example = harness.platform.get_iacm_default_pipeline(org_id=test["id"],
+        project_id=test_harness_platform_project["id"],
+        provisioner_type="terraform",
+        operation="plan")
+    ```
+
 
     :param _builtins.str operation: The operation associated with this default.
     :param _builtins.str org_id: Organization identifier of the organization the default pipelines resides in.

pulumi_harness/platform/get_infra_variable_set.py

@@ -67,7 +67,7 @@ class GetInfraVariableSetResult:
     @pulumi.getter
     def connectors(self) -> Sequence['outputs.GetInfraVariableSetConnectorResult']:
         """
-        Provider connector configured on the variable set
+        Provider connectors configured on the Variable Set. Only one connector of a type is supported
         """
         return pulumi.get(self, "connectors")
 
@@ -75,7 +75,7 @@ class GetInfraVariableSetResult:
     @pulumi.getter
     def description(self) -> _builtins.str:
         """
-        Description of the Variable Set
+        Description of the resource.
         """
         return pulumi.get(self, "description")
 
@@ -83,7 +83,7 @@ class GetInfraVariableSetResult:
     @pulumi.getter(name="environmentVariables")
     def environment_variables(self) -> Sequence['outputs.GetInfraVariableSetEnvironmentVariableResult']:
         """
-        Environment variables configured on the variable set
+        Environment variables configured on the Variable Set
         """
         return pulumi.get(self, "environment_variables")
 
@@ -99,7 +99,7 @@ class GetInfraVariableSetResult:
     @pulumi.getter
     def identifier(self) -> _builtins.str:
         """
-        Identifier of the Variable Set
+        Unique identifier of the resource.
         """
         return pulumi.get(self, "identifier")
 
@@ -107,7 +107,7 @@ class GetInfraVariableSetResult:
     @pulumi.getter
     def name(self) -> Optional[_builtins.str]:
         """
-        Name of the Variable Set
+        Name of the resource.
         """
         return pulumi.get(self, "name")
 
@@ -115,7 +115,7 @@ class GetInfraVariableSetResult:
     @pulumi.getter(name="orgId")
     def org_id(self) -> Optional[_builtins.str]:
         """
-        Organization Identifier
+        Unique identifier of the organization.
         """
         return pulumi.get(self, "org_id")
 
@@ -123,13 +123,16 @@ class GetInfraVariableSetResult:
     @pulumi.getter(name="projectId")
     def project_id(self) -> Optional[_builtins.str]:
         """
-        Project Identifier
+        Unique identifier of the project.
         """
         return pulumi.get(self, "project_id")
 
     @_builtins.property
     @pulumi.getter
     def tags(self) -> Sequence[_builtins.str]:
+        """
+        Tags to associate with the resource.
+        """
         return pulumi.get(self, "tags")
 
     @_builtins.property
@@ -180,18 +183,21 @@ def get_infra_variable_set(connectors: Optional[Sequence[Union['GetInfraVariable
     import pulumi
     import pulumi_harness as harness
 
-    test = harness.platform.get_infra_variable_set(identifier="identifier",
-        org_id="org_id",
-        project_id="project_id")
+    test = harness.platform.get_infra_variable_set(identifier="identifier")
+    testorg = harness.platform.get_infra_variable_set(identifier="identifier",
+        org_id="someorg")
+    testproj = harness.platform.get_infra_variable_set(identifier="identifier",
+        org_id="someorg",
+        project_id="someproj")
     ```
 
 
-    :param Sequence[Union['GetInfraVariableSetConnectorArgs', 'GetInfraVariableSetConnectorArgsDict']] connectors: Provider connector configured on the variable set
-    :param Sequence[Union['GetInfraVariableSetEnvironmentVariableArgs', 'GetInfraVariableSetEnvironmentVariableArgsDict']] environment_variables: Environment variables configured on the variable set
-    :param _builtins.str identifier: Identifier of the Variable Set
-    :param _builtins.str name: Name of the Variable Set
-    :param _builtins.str org_id: Organization Identifier
-    :param _builtins.str project_id: Project Identifier
+    :param Sequence[Union['GetInfraVariableSetConnectorArgs', 'GetInfraVariableSetConnectorArgsDict']] connectors: Provider connectors configured on the Variable Set. Only one connector of a type is supported
+    :param Sequence[Union['GetInfraVariableSetEnvironmentVariableArgs', 'GetInfraVariableSetEnvironmentVariableArgsDict']] environment_variables: Environment variables configured on the Variable Set
+    :param _builtins.str identifier: Unique identifier of the resource.
+    :param _builtins.str name: Name of the resource.
+    :param _builtins.str org_id: Unique identifier of the organization.
+    :param _builtins.str project_id: Unique identifier of the project.
     """
     __args__ = dict()
     __args__['connectors'] = connectors
@@ -235,18 +241,21 @@ def get_infra_variable_set_output(connectors: Optional[pulumi.Input[Optional[Seq
     import pulumi
     import pulumi_harness as harness
 
-    test = harness.platform.get_infra_variable_set(identifier="identifier",
-        org_id="org_id",
-        project_id="project_id")
+    test = harness.platform.get_infra_variable_set(identifier="identifier")
+    testorg = harness.platform.get_infra_variable_set(identifier="identifier",
+        org_id="someorg")
+    testproj = harness.platform.get_infra_variable_set(identifier="identifier",
+        org_id="someorg",
+        project_id="someproj")
     ```
 
 
-    :param Sequence[Union['GetInfraVariableSetConnectorArgs', 'GetInfraVariableSetConnectorArgsDict']] connectors: Provider connector configured on the variable set
-    :param Sequence[Union['GetInfraVariableSetEnvironmentVariableArgs', 'GetInfraVariableSetEnvironmentVariableArgsDict']] environment_variables: Environment variables configured on the variable set
-    :param _builtins.str identifier: Identifier of the Variable Set
-    :param _builtins.str name: Name of the Variable Set
-    :param _builtins.str org_id: Organization Identifier
-    :param _builtins.str project_id: Project Identifier
+    :param Sequence[Union['GetInfraVariableSetConnectorArgs', 'GetInfraVariableSetConnectorArgsDict']] connectors: Provider connectors configured on the Variable Set. Only one connector of a type is supported
+    :param Sequence[Union['GetInfraVariableSetEnvironmentVariableArgs', 'GetInfraVariableSetEnvironmentVariableArgsDict']] environment_variables: Environment variables configured on the Variable Set
+    :param _builtins.str identifier: Unique identifier of the resource.
+    :param _builtins.str name: Name of the resource.
+    :param _builtins.str org_id: Unique identifier of the organization.
+    :param _builtins.str project_id: Unique identifier of the project.
     """
     __args__ = dict()
     __args__['connectors'] = connectors

pulumi_harness/platform/get_infrastructure.py

@@ -93,6 +93,9 @@ class GetInfrastructureResult:
     @_builtins.property
     @pulumi.getter(name="gitDetails")
     def git_details(self) -> 'outputs.GetInfrastructureGitDetailsResult':
+        """
+        Contains parameters related to Git Experience for remote entities
+        """
         return pulumi.get(self, "git_details")
 
     @_builtins.property
@@ -205,6 +208,7 @@ def get_infrastructure(env_id: Optional[_builtins.str] = None,
 
 
     :param _builtins.str env_id: environment identifier.
+    :param Union['GetInfrastructureGitDetailsArgs', 'GetInfrastructureGitDetailsArgsDict'] git_details: Contains parameters related to Git Experience for remote entities
     :param _builtins.str identifier: Unique identifier of the resource.
     :param _builtins.str name: Name of the resource.
     :param _builtins.str org_id: Unique identifier of the organization.
@@ -258,6 +262,7 @@ def get_infrastructure_output(env_id: Optional[pulumi.Input[_builtins.str]] = No
 
 
     :param _builtins.str env_id: environment identifier.
+    :param Union['GetInfrastructureGitDetailsArgs', 'GetInfrastructureGitDetailsArgsDict'] git_details: Contains parameters related to Git Experience for remote entities
     :param _builtins.str identifier: Unique identifier of the resource.
     :param _builtins.str name: Name of the resource.
     :param _builtins.str org_id: Unique identifier of the organization.

pulumi_harness/platform/get_manual_freeze.py

@@ -214,18 +214,6 @@ def get_manual_freeze(account_id: Optional[_builtins.str] = None,
     """
     DataSource for deployment freeze in harness.
 
-    ## Example Usage
-
-    ```python
-    import pulumi
-    import pulumi_harness as harness
-
-    example = harness.platform.get_manual_freeze(identifier="identifier",
-        org_id="org_id",
-        project_id="project_id",
-        account_id="account_id")
-    ```
-
 
     :param _builtins.str account_id: Account Identifier of the freeze
     :param _builtins.str identifier: Identifier of the freeze
@@ -263,18 +251,6 @@ def get_manual_freeze_output(account_id: Optional[pulumi.Input[_builtins.str]] =
     """
     DataSource for deployment freeze in harness.
 
-    ## Example Usage
-
-    ```python
-    import pulumi
-    import pulumi_harness as harness
-
-    example = harness.platform.get_manual_freeze(identifier="identifier",
-        org_id="org_id",
-        project_id="project_id",
-        account_id="account_id")
-    ```
-
 
     :param _builtins.str account_id: Account Identifier of the freeze
     :param _builtins.str identifier: Identifier of the freeze

pulumi_harness/platform/get_monitored_service.py

@@ -92,6 +92,17 @@ def get_monitored_service(identifier: Optional[_builtins.str] = None,
     """
     Data source for retrieving a monitored service.
 
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_harness as harness
+
+    example = harness.platform.get_monitored_service(identifier="identifier",
+        org_id="org_id",
+        project_id="project_id")
+    ```
+
 
     :param _builtins.str identifier: Identifier of the monitored service.
     :param _builtins.str org_id: Identifier of the organization in which the monitored service is configured.
@@ -116,6 +127,17 @@ def get_monitored_service_output(identifier: Optional[pulumi.Input[_builtins.str
     """
     Data source for retrieving a monitored service.
 
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_harness as harness
+
+    example = harness.platform.get_monitored_service(identifier="identifier",
+        org_id="org_id",
+        project_id="project_id")
+    ```
+
 
     :param _builtins.str identifier: Identifier of the monitored service.
     :param _builtins.str org_id: Identifier of the organization in which the monitored service is configured.

pulumi_harness/platform/get_organization.py

@@ -101,6 +101,8 @@ def get_organization(identifier: Optional[_builtins.str] = None,
                      name: Optional[_builtins.str] = None,
                      opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetOrganizationResult:
     """
+    Data source for retrieving a Harness organization
+
     ## Example Usage
 
     ```python
@@ -130,6 +132,8 @@ def get_organization_output(identifier: Optional[pulumi.Input[Optional[_builtins
                             name: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
                             opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetOrganizationResult]:
     """
+    Data source for retrieving a Harness organization
+
     ## Example Usage
 
     ```python

pulumi_harness/platform/get_overrides.py

@@ -66,16 +66,25 @@ class GetOverridesResult:
     @_builtins.property
     @pulumi.getter(name="clusterId")
     def cluster_id(self) -> _builtins.str:
+        """
+        The cluster ID to which the override entity is associated.
+        """
         return pulumi.get(self, "cluster_id")
 
     @_builtins.property
     @pulumi.getter(name="envId")
     def env_id(self) -> _builtins.str:
+        """
+        The environment ID to which the override entity is associated.
+        """
         return pulumi.get(self, "env_id")
 
     @_builtins.property
     @pulumi.getter(name="gitDetails")
     def git_details(self) -> 'outputs.GetOverridesGitDetailsResult':
+        """
+        Contains parameters related to Git Experience for remote overrides
+        """
         return pulumi.get(self, "git_details")
 
     @_builtins.property
@@ -89,36 +98,57 @@ class GetOverridesResult:
     @_builtins.property
     @pulumi.getter
     def identifier(self) -> _builtins.str:
+        """
+        The identifier of the override entity.
+        """
         return pulumi.get(self, "identifier")
 
     @_builtins.property
     @pulumi.getter(name="infraId")
     def infra_id(self) -> _builtins.str:
+        """
+        The infrastructure ID to which the override entity is associated.
+        """
         return pulumi.get(self, "infra_id")
 
     @_builtins.property
     @pulumi.getter(name="orgId")
     def org_id(self) -> Optional[_builtins.str]:
+        """
+        Unique identifier of the organization.
+        """
         return pulumi.get(self, "org_id")
 
     @_builtins.property
     @pulumi.getter(name="projectId")
     def project_id(self) -> Optional[_builtins.str]:
+        """
+        Unique identifier of the project.
+        """
         return pulumi.get(self, "project_id")
 
     @_builtins.property
     @pulumi.getter(name="serviceId")
     def service_id(self) -> _builtins.str:
+        """
+        The service ID to which the override entity is associated.
+        """
         return pulumi.get(self, "service_id")
 
     @_builtins.property
     @pulumi.getter
     def type(self) -> _builtins.str:
+        """
+        The type of the override entity.
+        """
         return pulumi.get(self, "type")
 
     @_builtins.property
     @pulumi.getter
     def yaml(self) -> _builtins.str:
+        """
+        The yaml of the override entity.
+        """
         return pulumi.get(self, "yaml")
 
 
@@ -147,7 +177,24 @@ def get_overrides(git_details: Optional[Union['GetOverridesGitDetailsArgs', 'Get
                   project_id: Optional[_builtins.str] = None,
                   opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetOverridesResult:
     """
-    Use this data source to access information about an existing resource.
+    Data source for Harness Overrides V2.
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_harness as harness
+
+    test = harness.platform.get_overrides(identifier="identifier",
+        org_id="orgIdentifier",
+        project_id="projectIdentifier")
+    ```
+
+
+    :param Union['GetOverridesGitDetailsArgs', 'GetOverridesGitDetailsArgsDict'] git_details: Contains parameters related to Git Experience for remote overrides
+    :param _builtins.str identifier: The identifier of the override entity.
+    :param _builtins.str org_id: Unique identifier of the organization.
+    :param _builtins.str project_id: Unique identifier of the project.
     """
     __args__ = dict()
     __args__['gitDetails'] = git_details
@@ -175,7 +222,24 @@ def get_overrides_output(git_details: Optional[pulumi.Input[Optional[Union['GetO
                          project_id: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
                          opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetOverridesResult]:
     """
-    Use this data source to access information about an existing resource.
+    Data source for Harness Overrides V2.
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_harness as harness
+
+    test = harness.platform.get_overrides(identifier="identifier",
+        org_id="orgIdentifier",
+        project_id="projectIdentifier")
+    ```
+
+
+    :param Union['GetOverridesGitDetailsArgs', 'GetOverridesGitDetailsArgsDict'] git_details: Contains parameters related to Git Experience for remote overrides
+    :param _builtins.str identifier: The identifier of the override entity.
+    :param _builtins.str org_id: Unique identifier of the organization.
+    :param _builtins.str project_id: Unique identifier of the project.
     """
     __args__ = dict()
     __args__['gitDetails'] = git_details

pulumi_harness/platform/get_pagerduty_connector.py

@@ -151,6 +151,8 @@ def get_pagerduty_connector(identifier: Optional[_builtins.str] = None,
                             project_id: Optional[_builtins.str] = None,
                             opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetPagerdutyConnectorResult:
     """
+    Datasource for looking up a PagerDuty connector.
+
     ## Example Usage
 
     ```python
@@ -190,6 +192,8 @@ def get_pagerduty_connector_output(identifier: Optional[pulumi.Input[_builtins.s
                                    project_id: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
                                    opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetPagerdutyConnectorResult]:
     """
+    Datasource for looking up a PagerDuty connector.
+
     ## Example Usage
 
     ```python