Resource for creating IDP catalog entities.
Create IdpCatalogEntity Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new IdpCatalogEntity(name: string, args: IdpCatalogEntityArgs, opts?: CustomResourceOptions);@overload
def IdpCatalogEntity(resource_name: str,
args: IdpCatalogEntityArgs,
opts: Optional[ResourceOptions] = None)
@overload
def IdpCatalogEntity(resource_name: str,
opts: Optional[ResourceOptions] = None,
identifier: Optional[str] = None,
git_details: Optional[IdpCatalogEntityGitDetailsArgs] = None,
import_from_git: Optional[bool] = None,
kind: Optional[str] = None,
org_id: Optional[str] = None,
project_id: Optional[str] = None,
yaml: Optional[str] = None)func NewIdpCatalogEntity(ctx *Context, name string, args IdpCatalogEntityArgs, opts ...ResourceOption) (*IdpCatalogEntity, error)public IdpCatalogEntity(string name, IdpCatalogEntityArgs args, CustomResourceOptions? opts = null)
public IdpCatalogEntity(String name, IdpCatalogEntityArgs args)
public IdpCatalogEntity(String name, IdpCatalogEntityArgs args, CustomResourceOptions options)
type: harness:platform:IdpCatalogEntity
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 IdpCatalogEntityArgs
- 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 IdpCatalogEntityArgs
- 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 IdpCatalogEntityArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IdpCatalogEntityArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args IdpCatalogEntityArgs
- 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 idpCatalogEntityResource = new Harness.Platform.IdpCatalogEntity("idpCatalogEntityResource", new()
{
Identifier = "string",
GitDetails = new Harness.Platform.Inputs.IdpCatalogEntityGitDetailsArgs
{
BaseBranch = "string",
BranchName = "string",
CommitMessage = "string",
ConnectorRef = "string",
FilePath = "string",
IsHarnessCodeRepo = false,
LastCommitId = "string",
LastObjectId = "string",
RepoName = "string",
StoreType = "string",
},
ImportFromGit = false,
Kind = "string",
OrgId = "string",
ProjectId = "string",
Yaml = "string",
});
example, err := platform.NewIdpCatalogEntity(ctx, "idpCatalogEntityResource", &platform.IdpCatalogEntityArgs{
Identifier: pulumi.String("string"),
GitDetails: &platform.IdpCatalogEntityGitDetailsArgs{
BaseBranch: pulumi.String("string"),
BranchName: pulumi.String("string"),
CommitMessage: pulumi.String("string"),
ConnectorRef: pulumi.String("string"),
FilePath: pulumi.String("string"),
IsHarnessCodeRepo: pulumi.Bool(false),
LastCommitId: pulumi.String("string"),
LastObjectId: pulumi.String("string"),
RepoName: pulumi.String("string"),
StoreType: pulumi.String("string"),
},
ImportFromGit: pulumi.Bool(false),
Kind: pulumi.String("string"),
OrgId: pulumi.String("string"),
ProjectId: pulumi.String("string"),
Yaml: pulumi.String("string"),
})
var idpCatalogEntityResource = new IdpCatalogEntity("idpCatalogEntityResource", IdpCatalogEntityArgs.builder()
.identifier("string")
.gitDetails(IdpCatalogEntityGitDetailsArgs.builder()
.baseBranch("string")
.branchName("string")
.commitMessage("string")
.connectorRef("string")
.filePath("string")
.isHarnessCodeRepo(false)
.lastCommitId("string")
.lastObjectId("string")
.repoName("string")
.storeType("string")
.build())
.importFromGit(false)
.kind("string")
.orgId("string")
.projectId("string")
.yaml("string")
.build());
idp_catalog_entity_resource = harness.platform.IdpCatalogEntity("idpCatalogEntityResource",
identifier="string",
git_details={
"base_branch": "string",
"branch_name": "string",
"commit_message": "string",
"connector_ref": "string",
"file_path": "string",
"is_harness_code_repo": False,
"last_commit_id": "string",
"last_object_id": "string",
"repo_name": "string",
"store_type": "string",
},
import_from_git=False,
kind="string",
org_id="string",
project_id="string",
yaml="string")
const idpCatalogEntityResource = new harness.platform.IdpCatalogEntity("idpCatalogEntityResource", {
identifier: "string",
gitDetails: {
baseBranch: "string",
branchName: "string",
commitMessage: "string",
connectorRef: "string",
filePath: "string",
isHarnessCodeRepo: false,
lastCommitId: "string",
lastObjectId: "string",
repoName: "string",
storeType: "string",
},
importFromGit: false,
kind: "string",
orgId: "string",
projectId: "string",
yaml: "string",
});
type: harness:platform:IdpCatalogEntity
properties:
gitDetails:
baseBranch: string
branchName: string
commitMessage: string
connectorRef: string
filePath: string
isHarnessCodeRepo: false
lastCommitId: string
lastObjectId: string
repoName: string
storeType: string
identifier: string
importFromGit: false
kind: string
orgId: string
projectId: string
yaml: string
IdpCatalogEntity 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 IdpCatalogEntity resource accepts the following input properties:
- Identifier string
- Unique identifier of the resource.
- Git
Details IdpCatalog Entity Git Details - Contains Git Information for importing entities from Git
- Import
From boolGit - Flag to set if importing from Git
- Kind string
- Kind of the catalog entity
- Org
Id string - Unique identifier of the organization.
- Project
Id string - Unique identifier of the project.
- Yaml string
- YAML definition of the catalog entity
- Identifier string
- Unique identifier of the resource.
- Git
Details IdpCatalog Entity Git Details Args - Contains Git Information for importing entities from Git
- Import
From boolGit - Flag to set if importing from Git
- Kind string
- Kind of the catalog entity
- Org
Id string - Unique identifier of the organization.
- Project
Id string - Unique identifier of the project.
- Yaml string
- YAML definition of the catalog entity
- identifier String
- Unique identifier of the resource.
- git
Details IdpCatalog Entity Git Details - Contains Git Information for importing entities from Git
- import
From BooleanGit - Flag to set if importing from Git
- kind String
- Kind of the catalog entity
- org
Id String - Unique identifier of the organization.
- project
Id String - Unique identifier of the project.
- yaml String
- YAML definition of the catalog entity
- identifier string
- Unique identifier of the resource.
- git
Details IdpCatalog Entity Git Details - Contains Git Information for importing entities from Git
- import
From booleanGit - Flag to set if importing from Git
- kind string
- Kind of the catalog entity
- org
Id string - Unique identifier of the organization.
- project
Id string - Unique identifier of the project.
- yaml string
- YAML definition of the catalog entity
- identifier str
- Unique identifier of the resource.
- git_
details IdpCatalog Entity Git Details Args - Contains Git Information for importing entities from Git
- import_
from_ boolgit - Flag to set if importing from Git
- kind str
- Kind of the catalog entity
- org_
id str - Unique identifier of the organization.
- project_
id str - Unique identifier of the project.
- yaml str
- YAML definition of the catalog entity
- identifier String
- Unique identifier of the resource.
- git
Details Property Map - Contains Git Information for importing entities from Git
- import
From BooleanGit - Flag to set if importing from Git
- kind String
- Kind of the catalog entity
- org
Id String - Unique identifier of the organization.
- project
Id String - Unique identifier of the project.
- yaml String
- YAML definition of the catalog entity
Outputs
All input properties are implicitly available as output properties. Additionally, the IdpCatalogEntity 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 IdpCatalogEntity Resource
Get an existing IdpCatalogEntity 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?: IdpCatalogEntityState, opts?: CustomResourceOptions): IdpCatalogEntity@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
git_details: Optional[IdpCatalogEntityGitDetailsArgs] = None,
identifier: Optional[str] = None,
import_from_git: Optional[bool] = None,
kind: Optional[str] = None,
org_id: Optional[str] = None,
project_id: Optional[str] = None,
yaml: Optional[str] = None) -> IdpCatalogEntityfunc GetIdpCatalogEntity(ctx *Context, name string, id IDInput, state *IdpCatalogEntityState, opts ...ResourceOption) (*IdpCatalogEntity, error)public static IdpCatalogEntity Get(string name, Input<string> id, IdpCatalogEntityState? state, CustomResourceOptions? opts = null)public static IdpCatalogEntity get(String name, Output<String> id, IdpCatalogEntityState state, CustomResourceOptions options)resources: _: type: harness:platform:IdpCatalogEntity 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.
- Git
Details IdpCatalog Entity Git Details - Contains Git Information for importing entities from Git
- Identifier string
- Unique identifier of the resource.
- Import
From boolGit - Flag to set if importing from Git
- Kind string
- Kind of the catalog entity
- Org
Id string - Unique identifier of the organization.
- Project
Id string - Unique identifier of the project.
- Yaml string
- YAML definition of the catalog entity
- Git
Details IdpCatalog Entity Git Details Args - Contains Git Information for importing entities from Git
- Identifier string
- Unique identifier of the resource.
- Import
From boolGit - Flag to set if importing from Git
- Kind string
- Kind of the catalog entity
- Org
Id string - Unique identifier of the organization.
- Project
Id string - Unique identifier of the project.
- Yaml string
- YAML definition of the catalog entity
- git
Details IdpCatalog Entity Git Details - Contains Git Information for importing entities from Git
- identifier String
- Unique identifier of the resource.
- import
From BooleanGit - Flag to set if importing from Git
- kind String
- Kind of the catalog entity
- org
Id String - Unique identifier of the organization.
- project
Id String - Unique identifier of the project.
- yaml String
- YAML definition of the catalog entity
- git
Details IdpCatalog Entity Git Details - Contains Git Information for importing entities from Git
- identifier string
- Unique identifier of the resource.
- import
From booleanGit - Flag to set if importing from Git
- kind string
- Kind of the catalog entity
- org
Id string - Unique identifier of the organization.
- project
Id string - Unique identifier of the project.
- yaml string
- YAML definition of the catalog entity
- git_
details IdpCatalog Entity Git Details Args - Contains Git Information for importing entities from Git
- identifier str
- Unique identifier of the resource.
- import_
from_ boolgit - Flag to set if importing from Git
- kind str
- Kind of the catalog entity
- org_
id str - Unique identifier of the organization.
- project_
id str - Unique identifier of the project.
- yaml str
- YAML definition of the catalog entity
- git
Details Property Map - Contains Git Information for importing entities from Git
- identifier String
- Unique identifier of the resource.
- import
From BooleanGit - Flag to set if importing from Git
- kind String
- Kind of the catalog entity
- org
Id String - Unique identifier of the organization.
- project
Id String - Unique identifier of the project.
- yaml String
- YAML definition of the catalog entity
Supporting Types
IdpCatalogEntityGitDetails, IdpCatalogEntityGitDetailsArgs
- Base
Branch string - Name of the default branch (this checks out a new branch titled by branch_name).
- Branch
Name string - Name of the branch.
- Commit
Message string - Commit message used for the merge commit.
- Connector
Ref string - Identifier of the Harness Connector used for importing entity from Git To reference a connector at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a connector at the account scope, prefix 'account` to the expression: account.{identifier}.
- File
Path string - File path of the Entity in the repository.
- Is
Harness boolCode Repo - If the repo is a Harness Code repo
- Last
Commit stringId - Last commit identifier (for Git Repositories other than Github). To be provided only when updating Pipeline.
- Last
Object stringId - Last object identifier (for Github). To be provided only when updating Pipeline.
- Repo
Name string - Name of the repository.
- Store
Type string - Specifies whether the Entity is to be stored in Git or not. Possible values: INLINE, REMOTE.
- Base
Branch string - Name of the default branch (this checks out a new branch titled by branch_name).
- Branch
Name string - Name of the branch.
- Commit
Message string - Commit message used for the merge commit.
- Connector
Ref string - Identifier of the Harness Connector used for importing entity from Git To reference a connector at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a connector at the account scope, prefix 'account` to the expression: account.{identifier}.
- File
Path string - File path of the Entity in the repository.
- Is
Harness boolCode Repo - If the repo is a Harness Code repo
- Last
Commit stringId - Last commit identifier (for Git Repositories other than Github). To be provided only when updating Pipeline.
- Last
Object stringId - Last object identifier (for Github). To be provided only when updating Pipeline.
- Repo
Name string - Name of the repository.
- Store
Type string - Specifies whether the Entity is to be stored in Git or not. Possible values: INLINE, REMOTE.
- base
Branch String - Name of the default branch (this checks out a new branch titled by branch_name).
- branch
Name String - Name of the branch.
- commit
Message String - Commit message used for the merge commit.
- connector
Ref String - Identifier of the Harness Connector used for importing entity from Git To reference a connector at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a connector at the account scope, prefix 'account` to the expression: account.{identifier}.
- file
Path String - File path of the Entity in the repository.
- is
Harness BooleanCode Repo - If the repo is a Harness Code repo
- last
Commit StringId - Last commit identifier (for Git Repositories other than Github). To be provided only when updating Pipeline.
- last
Object StringId - Last object identifier (for Github). To be provided only when updating Pipeline.
- repo
Name String - Name of the repository.
- store
Type String - Specifies whether the Entity is to be stored in Git or not. Possible values: INLINE, REMOTE.
- base
Branch string - Name of the default branch (this checks out a new branch titled by branch_name).
- branch
Name string - Name of the branch.
- commit
Message string - Commit message used for the merge commit.
- connector
Ref string - Identifier of the Harness Connector used for importing entity from Git To reference a connector at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a connector at the account scope, prefix 'account` to the expression: account.{identifier}.
- file
Path string - File path of the Entity in the repository.
- is
Harness booleanCode Repo - If the repo is a Harness Code repo
- last
Commit stringId - Last commit identifier (for Git Repositories other than Github). To be provided only when updating Pipeline.
- last
Object stringId - Last object identifier (for Github). To be provided only when updating Pipeline.
- repo
Name string - Name of the repository.
- store
Type string - Specifies whether the Entity is to be stored in Git or not. Possible values: INLINE, REMOTE.
- base_
branch str - Name of the default branch (this checks out a new branch titled by branch_name).
- branch_
name str - Name of the branch.
- commit_
message str - Commit message used for the merge commit.
- connector_
ref str - Identifier of the Harness Connector used for importing entity from Git To reference a connector at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a connector at the account scope, prefix 'account` to the expression: account.{identifier}.
- file_
path str - File path of the Entity in the repository.
- is_
harness_ boolcode_ repo - If the repo is a Harness Code repo
- last_
commit_ strid - Last commit identifier (for Git Repositories other than Github). To be provided only when updating Pipeline.
- last_
object_ strid - Last object identifier (for Github). To be provided only when updating Pipeline.
- repo_
name str - Name of the repository.
- store_
type str - Specifies whether the Entity is to be stored in Git or not. Possible values: INLINE, REMOTE.
- base
Branch String - Name of the default branch (this checks out a new branch titled by branch_name).
- branch
Name String - Name of the branch.
- commit
Message String - Commit message used for the merge commit.
- connector
Ref String - Identifier of the Harness Connector used for importing entity from Git To reference a connector at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a connector at the account scope, prefix 'account` to the expression: account.{identifier}.
- file
Path String - File path of the Entity in the repository.
- is
Harness BooleanCode Repo - If the repo is a Harness Code repo
- last
Commit StringId - Last commit identifier (for Git Repositories other than Github). To be provided only when updating Pipeline.
- last
Object StringId - Last object identifier (for Github). To be provided only when updating Pipeline.
- repo
Name String - Name of the repository.
- store
Type String - Specifies whether the Entity is to be stored in Git or not. Possible values: INLINE, REMOTE.
Import
The pulumi import command can be used, for example:
Import account level entity
$ pulumi import harness:platform/idpCatalogEntity:IdpCatalogEntity example <entity_id>
Import org level entity
$ pulumi import harness:platform/idpCatalogEntity:IdpCatalogEntity example <org_id>/<entity_id>
Import project level entity
$ pulumi import harness:platform/idpCatalogEntity:IdpCatalogEntity example <org_id>/<project_id>/<entity_id>
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.
