Harness v0.0.6, Jul 1 23

Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs

harness.platform.Policy

Explore with Pulumi AI

Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs

Create Policy Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Policy(name: string, args: PolicyArgs, opts?: CustomResourceOptions);

@overload
def Policy(resource_name: str,
           args: PolicyArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Policy(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           identifier: Optional[str] = None,
           rego: Optional[str] = None,
           description: Optional[str] = None,
           name: Optional[str] = None,
           org_id: Optional[str] = None,
           project_id: Optional[str] = None,
           tags: Optional[Sequence[str]] = None)

func NewPolicy(ctx *Context, name string, args PolicyArgs, opts ...ResourceOption) (*Policy, error)

public Policy(string name, PolicyArgs args, CustomResourceOptions? opts = null)

public Policy(String name, PolicyArgs args)
public Policy(String name, PolicyArgs args, CustomResourceOptions options)

type: harness:platform:Policy
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 PolicyArgs: 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 PolicyArgs: 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 PolicyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args PolicyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args PolicyArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Example

The following reference example uses placeholder values for all input properties.

var policyResource = new Harness.Platform.Policy("policyResource", new()
{
    Identifier = "string",
    Rego = "string",
    Description = "string",
    Name = "string",
    OrgId = "string",
    ProjectId = "string",
    Tags = new[]
    {
        "string",
    },
});

example, err := platform.NewPolicy(ctx, "policyResource", &platform.PolicyArgs{
	Identifier:  pulumi.String("string"),
	Rego:        pulumi.String("string"),
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	OrgId:       pulumi.String("string"),
	ProjectId:   pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})

var policyResource = new Policy("policyResource", PolicyArgs.builder()        
    .identifier("string")
    .rego("string")
    .description("string")
    .name("string")
    .orgId("string")
    .projectId("string")
    .tags("string")
    .build());

policy_resource = harness.platform.Policy("policyResource",
    identifier="string",
    rego="string",
    description="string",
    name="string",
    org_id="string",
    project_id="string",
    tags=["string"])

const policyResource = new harness.platform.Policy("policyResource", {
    identifier: "string",
    rego: "string",
    description: "string",
    name: "string",
    orgId: "string",
    projectId: "string",
    tags: ["string"],
});

type: harness:platform:Policy
properties:
    description: string
    identifier: string
    name: string
    orgId: string
    projectId: string
    rego: string
    tags:
        - string

Policy Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Policy resource accepts the following input properties:

Identifier string: Unique identifier of the resource.
Rego string: Rego code for the policy.
Description string: Description of the resource.
Name string: Name of the resource.
OrgId string: Unique identifier of the organization.
ProjectId string: Unique identifier of the project.
Tags List<string>: Tags to associate with the resource.

Identifier string: Unique identifier of the resource.
Rego string: Rego code for the policy.
Description string: Description of the resource.
Name string: Name of the resource.
OrgId string: Unique identifier of the organization.
ProjectId string: Unique identifier of the project.
Tags []string: Tags to associate with the resource.

identifier String: Unique identifier of the resource.
rego String: Rego code for the policy.
description String: Description of the resource.
name String: Name of the resource.
orgId String: Unique identifier of the organization.
projectId String: Unique identifier of the project.
tags List<String>: Tags to associate with the resource.

identifier string: Unique identifier of the resource.
rego string: Rego code for the policy.
description string: Description of the resource.
name string: Name of the resource.
orgId string: Unique identifier of the organization.
projectId string: Unique identifier of the project.
tags string[]: Tags to associate with the resource.

identifier str: Unique identifier of the resource.
rego str: Rego code for the policy.
description str: Description of the resource.
name str: Name of the resource.
org_id str: Unique identifier of the organization.
project_id str: Unique identifier of the project.
tags Sequence[str]: Tags to associate with the resource.

identifier String: Unique identifier of the resource.
rego String: Rego code for the policy.
description String: Description of the resource.
name String: Name of the resource.
orgId String: Unique identifier of the organization.
projectId String: Unique identifier of the project.
tags List<String>: Tags to associate with the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the Policy 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 Policy Resource

Get an existing Policy 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?: PolicyState, opts?: CustomResourceOptions): Policy

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        identifier: Optional[str] = None,
        name: Optional[str] = None,
        org_id: Optional[str] = None,
        project_id: Optional[str] = None,
        rego: Optional[str] = None,
        tags: Optional[Sequence[str]] = None) -> Policy

func GetPolicy(ctx *Context, name string, id IDInput, state *PolicyState, opts ...ResourceOption) (*Policy, error)

public static Policy Get(string name, Input<string> id, PolicyState? state, CustomResourceOptions? opts = null)

public static Policy get(String name, Output<String> id, PolicyState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

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.

The following state arguments are supported:

Description string: Description of the resource.
Identifier string: Unique identifier of the resource.
Name string: Name of the resource.
OrgId string: Unique identifier of the organization.
ProjectId string: Unique identifier of the project.
Rego string: Rego code for the policy.
Tags List<string>: Tags to associate with the resource.

Description string: Description of the resource.
Identifier string: Unique identifier of the resource.
Name string: Name of the resource.
OrgId string: Unique identifier of the organization.
ProjectId string: Unique identifier of the project.
Rego string: Rego code for the policy.
Tags []string: Tags to associate with the resource.

description String: Description of the resource.
identifier String: Unique identifier of the resource.
name String: Name of the resource.
orgId String: Unique identifier of the organization.
projectId String: Unique identifier of the project.
rego String: Rego code for the policy.
tags List<String>: Tags to associate with the resource.

description string: Description of the resource.
identifier string: Unique identifier of the resource.
name string: Name of the resource.
orgId string: Unique identifier of the organization.
projectId string: Unique identifier of the project.
rego string: Rego code for the policy.
tags string[]: Tags to associate with the resource.

description str: Description of the resource.
identifier str: Unique identifier of the resource.
name str: Name of the resource.
org_id str: Unique identifier of the organization.
project_id str: Unique identifier of the project.
rego str: Rego code for the policy.
tags Sequence[str]: Tags to associate with the resource.

description String: Description of the resource.
identifier String: Unique identifier of the resource.
name String: Name of the resource.
orgId String: Unique identifier of the organization.
projectId String: Unique identifier of the project.
rego String: Rego code for the policy.
tags List<String>: Tags to associate with the resource.

Import

Import using the organization id

 $ pulumi import harness:platform/policy:Policy example <organization_id>

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: harness lbrlabs/pulumi-harness
License: Apache-2.0
Notes: This Pulumi package is based on the harness Terraform Provider.

Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs

lbrlabs/pulumi-harness

harness.platform.Policy

On this page

On this page

Create Policy Resource

Constructor syntax

Parameters

Example

Policy Resource Properties

Inputs

Outputs

Look up Existing Policy Resource

Import

Package Details

On this page

On this page