Resource for creating IDP environment blueprints.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as harness from "@pulumi/harness";
const test = new harness.platform.IdpEnvironmentBlueprint("test", {
identifier: "identifier",
version: "v1.0.0",
stable: true,
deprecated: false,
description: "description",
yaml: `apiVersion: harness.io/v1
kind: EnvironmentBlueprint
type: long-lived
identifier: identifier
name: name
owner: group:account/_account_all_users
metadata:
description: description
spec:
entities:
- identifier: git
backend:
type: HarnessCD
steps:
apply:
pipeline: gittest
branch: main
destroy:
pipeline: gittest
branch: not-main
ownedBy:
- group:account/_account_all_users
`,
});
import pulumi
import pulumi_harness as harness
test = harness.platform.IdpEnvironmentBlueprint("test",
identifier="identifier",
version="v1.0.0",
stable=True,
deprecated=False,
description="description",
yaml="""apiVersion: harness.io/v1
kind: EnvironmentBlueprint
type: long-lived
identifier: identifier
name: name
owner: group:account/_account_all_users
metadata:
description: description
spec:
entities:
- identifier: git
backend:
type: HarnessCD
steps:
apply:
pipeline: gittest
branch: main
destroy:
pipeline: gittest
branch: not-main
ownedBy:
- group:account/_account_all_users
""")
package main
import (
"github.com/pulumi/pulumi-harness/sdk/go/harness/platform"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := platform.NewIdpEnvironmentBlueprint(ctx, "test", &platform.IdpEnvironmentBlueprintArgs{
Identifier: pulumi.String("identifier"),
Version: pulumi.String("v1.0.0"),
Stable: pulumi.Bool(true),
Deprecated: pulumi.Bool(false),
Description: pulumi.String("description"),
Yaml: pulumi.String(`apiVersion: harness.io/v1
kind: EnvironmentBlueprint
type: long-lived
identifier: identifier
name: name
owner: group:account/_account_all_users
metadata:
description: description
spec:
entities:
- identifier: git
backend:
type: HarnessCD
steps:
apply:
pipeline: gittest
branch: main
destroy:
pipeline: gittest
branch: not-main
ownedBy:
- group:account/_account_all_users
`),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Harness = Pulumi.Harness;
return await Deployment.RunAsync(() =>
{
var test = new Harness.Platform.IdpEnvironmentBlueprint("test", new()
{
Identifier = "identifier",
Version = "v1.0.0",
Stable = true,
Deprecated = false,
Description = "description",
Yaml = @"apiVersion: harness.io/v1
kind: EnvironmentBlueprint
type: long-lived
identifier: identifier
name: name
owner: group:account/_account_all_users
metadata:
description: description
spec:
entities:
- identifier: git
backend:
type: HarnessCD
steps:
apply:
pipeline: gittest
branch: main
destroy:
pipeline: gittest
branch: not-main
ownedBy:
- group:account/_account_all_users
",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.harness.platform.IdpEnvironmentBlueprint;
import com.pulumi.harness.platform.IdpEnvironmentBlueprintArgs;
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) {
var test = new IdpEnvironmentBlueprint("test", IdpEnvironmentBlueprintArgs.builder()
.identifier("identifier")
.version("v1.0.0")
.stable(true)
.deprecated(false)
.description("description")
.yaml("""
apiVersion: harness.io/v1
kind: EnvironmentBlueprint
type: long-lived
identifier: identifier
name: name
owner: group:account/_account_all_users
metadata:
description: description
spec:
entities:
- identifier: git
backend:
type: HarnessCD
steps:
apply:
pipeline: gittest
branch: main
destroy:
pipeline: gittest
branch: not-main
ownedBy:
- group:account/_account_all_users
""")
.build());
}
}
resources:
test:
type: harness:platform:IdpEnvironmentBlueprint
properties:
identifier: identifier
version: v1.0.0
stable: true
deprecated: false
description: description
yaml: |
apiVersion: harness.io/v1
kind: EnvironmentBlueprint
type: long-lived
identifier: identifier
name: name
owner: group:account/_account_all_users
metadata:
description: description
spec:
entities:
- identifier: git
backend:
type: HarnessCD
steps:
apply:
pipeline: gittest
branch: main
destroy:
pipeline: gittest
branch: not-main
ownedBy:
- group:account/_account_all_users
Create IdpEnvironmentBlueprint Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new IdpEnvironmentBlueprint(name: string, args: IdpEnvironmentBlueprintArgs, opts?: CustomResourceOptions);@overload
def IdpEnvironmentBlueprint(resource_name: str,
args: IdpEnvironmentBlueprintArgs,
opts: Optional[ResourceOptions] = None)
@overload
def IdpEnvironmentBlueprint(resource_name: str,
opts: Optional[ResourceOptions] = None,
identifier: Optional[str] = None,
version: Optional[str] = None,
yaml: Optional[str] = None,
deprecated: Optional[bool] = None,
description: Optional[str] = None,
stable: Optional[bool] = None)func NewIdpEnvironmentBlueprint(ctx *Context, name string, args IdpEnvironmentBlueprintArgs, opts ...ResourceOption) (*IdpEnvironmentBlueprint, error)public IdpEnvironmentBlueprint(string name, IdpEnvironmentBlueprintArgs args, CustomResourceOptions? opts = null)
public IdpEnvironmentBlueprint(String name, IdpEnvironmentBlueprintArgs args)
public IdpEnvironmentBlueprint(String name, IdpEnvironmentBlueprintArgs args, CustomResourceOptions options)
type: harness:platform:IdpEnvironmentBlueprint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args IdpEnvironmentBlueprintArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args IdpEnvironmentBlueprintArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args IdpEnvironmentBlueprintArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IdpEnvironmentBlueprintArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args IdpEnvironmentBlueprintArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var idpEnvironmentBlueprintResource = new Harness.Platform.IdpEnvironmentBlueprint("idpEnvironmentBlueprintResource", new()
{
Identifier = "string",
Version = "string",
Yaml = "string",
Deprecated = false,
Description = "string",
Stable = false,
});
example, err := platform.NewIdpEnvironmentBlueprint(ctx, "idpEnvironmentBlueprintResource", &platform.IdpEnvironmentBlueprintArgs{
Identifier: pulumi.String("string"),
Version: pulumi.String("string"),
Yaml: pulumi.String("string"),
Deprecated: pulumi.Bool(false),
Description: pulumi.String("string"),
Stable: pulumi.Bool(false),
})
var idpEnvironmentBlueprintResource = new IdpEnvironmentBlueprint("idpEnvironmentBlueprintResource", IdpEnvironmentBlueprintArgs.builder()
.identifier("string")
.version("string")
.yaml("string")
.deprecated(false)
.description("string")
.stable(false)
.build());
idp_environment_blueprint_resource = harness.platform.IdpEnvironmentBlueprint("idpEnvironmentBlueprintResource",
identifier="string",
version="string",
yaml="string",
deprecated=False,
description="string",
stable=False)
const idpEnvironmentBlueprintResource = new harness.platform.IdpEnvironmentBlueprint("idpEnvironmentBlueprintResource", {
identifier: "string",
version: "string",
yaml: "string",
deprecated: false,
description: "string",
stable: false,
});
type: harness:platform:IdpEnvironmentBlueprint
properties:
deprecated: false
description: string
identifier: string
stable: false
version: string
yaml: string
IdpEnvironmentBlueprint Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The IdpEnvironmentBlueprint resource accepts the following input properties:
- Identifier string
- Unique identifier of the resource.
- Version string
- Version of the catalog entity
- Yaml string
- YAML definition of the catalog entity
- Deprecated bool
- Whether the catalog entity is deprecated
- Description string
- Description of the catalog entity
- Stable bool
- Whether the catalog entity is stable
- Identifier string
- Unique identifier of the resource.
- Version string
- Version of the catalog entity
- Yaml string
- YAML definition of the catalog entity
- Deprecated bool
- Whether the catalog entity is deprecated
- Description string
- Description of the catalog entity
- Stable bool
- Whether the catalog entity is stable
- identifier String
- Unique identifier of the resource.
- version String
- Version of the catalog entity
- yaml String
- YAML definition of the catalog entity
- deprecated Boolean
- Whether the catalog entity is deprecated
- description String
- Description of the catalog entity
- stable Boolean
- Whether the catalog entity is stable
- identifier string
- Unique identifier of the resource.
- version string
- Version of the catalog entity
- yaml string
- YAML definition of the catalog entity
- deprecated boolean
- Whether the catalog entity is deprecated
- description string
- Description of the catalog entity
- stable boolean
- Whether the catalog entity is stable
- identifier str
- Unique identifier of the resource.
- version str
- Version of the catalog entity
- yaml str
- YAML definition of the catalog entity
- deprecated bool
- Whether the catalog entity is deprecated
- description str
- Description of the catalog entity
- stable bool
- Whether the catalog entity is stable
- identifier String
- Unique identifier of the resource.
- version String
- Version of the catalog entity
- yaml String
- YAML definition of the catalog entity
- deprecated Boolean
- Whether the catalog entity is deprecated
- description String
- Description of the catalog entity
- stable Boolean
- Whether the catalog entity is stable
Outputs
All input properties are implicitly available as output properties. Additionally, the IdpEnvironmentBlueprint resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing IdpEnvironmentBlueprint Resource
Get an existing IdpEnvironmentBlueprint resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: IdpEnvironmentBlueprintState, opts?: CustomResourceOptions): IdpEnvironmentBlueprint@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
deprecated: Optional[bool] = None,
description: Optional[str] = None,
identifier: Optional[str] = None,
stable: Optional[bool] = None,
version: Optional[str] = None,
yaml: Optional[str] = None) -> IdpEnvironmentBlueprintfunc GetIdpEnvironmentBlueprint(ctx *Context, name string, id IDInput, state *IdpEnvironmentBlueprintState, opts ...ResourceOption) (*IdpEnvironmentBlueprint, error)public static IdpEnvironmentBlueprint Get(string name, Input<string> id, IdpEnvironmentBlueprintState? state, CustomResourceOptions? opts = null)public static IdpEnvironmentBlueprint get(String name, Output<String> id, IdpEnvironmentBlueprintState state, CustomResourceOptions options)resources: _: type: harness:platform:IdpEnvironmentBlueprint get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Deprecated bool
- Whether the catalog entity is deprecated
- Description string
- Description of the catalog entity
- Identifier string
- Unique identifier of the resource.
- Stable bool
- Whether the catalog entity is stable
- Version string
- Version of the catalog entity
- Yaml string
- YAML definition of the catalog entity
- Deprecated bool
- Whether the catalog entity is deprecated
- Description string
- Description of the catalog entity
- Identifier string
- Unique identifier of the resource.
- Stable bool
- Whether the catalog entity is stable
- Version string
- Version of the catalog entity
- Yaml string
- YAML definition of the catalog entity
- deprecated Boolean
- Whether the catalog entity is deprecated
- description String
- Description of the catalog entity
- identifier String
- Unique identifier of the resource.
- stable Boolean
- Whether the catalog entity is stable
- version String
- Version of the catalog entity
- yaml String
- YAML definition of the catalog entity
- deprecated boolean
- Whether the catalog entity is deprecated
- description string
- Description of the catalog entity
- identifier string
- Unique identifier of the resource.
- stable boolean
- Whether the catalog entity is stable
- version string
- Version of the catalog entity
- yaml string
- YAML definition of the catalog entity
- deprecated bool
- Whether the catalog entity is deprecated
- description str
- Description of the catalog entity
- identifier str
- Unique identifier of the resource.
- stable bool
- Whether the catalog entity is stable
- version str
- Version of the catalog entity
- yaml str
- YAML definition of the catalog entity
- deprecated Boolean
- Whether the catalog entity is deprecated
- description String
- Description of the catalog entity
- identifier String
- Unique identifier of the resource.
- stable Boolean
- Whether the catalog entity is stable
- version String
- Version of the catalog entity
- yaml String
- YAML definition of the catalog entity
Import
The pulumi import command can be used, for example:
Import environment blueprint
$ pulumi import harness:platform/idpEnvironmentBlueprint:IdpEnvironmentBlueprint example <blueprint_id>/<version>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- harness pulumi/pulumi-harness
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
harnessTerraform Provider.
