harness.platform.Overrides
Explore with Pulumi AI
Create Overrides Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Overrides(name: string, args: OverridesArgs, opts?: CustomResourceOptions);@overload
def Overrides(resource_name: str,
              args: OverridesArgs,
              opts: Optional[ResourceOptions] = None)
@overload
def Overrides(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              env_id: Optional[str] = None,
              type: Optional[str] = None,
              cluster_id: Optional[str] = None,
              git_details: Optional[OverridesGitDetailsArgs] = None,
              identifier: Optional[str] = None,
              import_from_git: Optional[bool] = None,
              infra_id: Optional[str] = None,
              is_force_import: Optional[bool] = None,
              org_id: Optional[str] = None,
              project_id: Optional[str] = None,
              service_id: Optional[str] = None,
              yaml: Optional[str] = None)func NewOverrides(ctx *Context, name string, args OverridesArgs, opts ...ResourceOption) (*Overrides, error)public Overrides(string name, OverridesArgs args, CustomResourceOptions? opts = null)
public Overrides(String name, OverridesArgs args)
public Overrides(String name, OverridesArgs args, CustomResourceOptions options)
type: harness:platform:Overrides
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 OverridesArgs
- 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 OverridesArgs
- 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 OverridesArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args OverridesArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args OverridesArgs
- 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 overridesResource = new Harness.Platform.Overrides("overridesResource", new()
{
    EnvId = "string",
    Type = "string",
    ClusterId = "string",
    GitDetails = new Harness.Platform.Inputs.OverridesGitDetailsArgs
    {
        BaseBranch = "string",
        Branch = "string",
        CommitMessage = "string",
        ConnectorRef = "string",
        FilePath = "string",
        IsHarnessCodeRepo = false,
        IsNewBranch = false,
        LastCommitId = "string",
        LastObjectId = "string",
        LoadFromCache = false,
        LoadFromFallbackBranch = false,
        RepoName = "string",
        StoreType = "string",
    },
    Identifier = "string",
    ImportFromGit = false,
    InfraId = "string",
    IsForceImport = false,
    OrgId = "string",
    ProjectId = "string",
    ServiceId = "string",
    Yaml = "string",
});
example, err := platform.NewOverrides(ctx, "overridesResource", &platform.OverridesArgs{
	EnvId:     pulumi.String("string"),
	Type:      pulumi.String("string"),
	ClusterId: pulumi.String("string"),
	GitDetails: &platform.OverridesGitDetailsArgs{
		BaseBranch:             pulumi.String("string"),
		Branch:                 pulumi.String("string"),
		CommitMessage:          pulumi.String("string"),
		ConnectorRef:           pulumi.String("string"),
		FilePath:               pulumi.String("string"),
		IsHarnessCodeRepo:      pulumi.Bool(false),
		IsNewBranch:            pulumi.Bool(false),
		LastCommitId:           pulumi.String("string"),
		LastObjectId:           pulumi.String("string"),
		LoadFromCache:          pulumi.Bool(false),
		LoadFromFallbackBranch: pulumi.Bool(false),
		RepoName:               pulumi.String("string"),
		StoreType:              pulumi.String("string"),
	},
	Identifier:    pulumi.String("string"),
	ImportFromGit: pulumi.Bool(false),
	InfraId:       pulumi.String("string"),
	IsForceImport: pulumi.Bool(false),
	OrgId:         pulumi.String("string"),
	ProjectId:     pulumi.String("string"),
	ServiceId:     pulumi.String("string"),
	Yaml:          pulumi.String("string"),
})
var overridesResource = new Overrides("overridesResource", OverridesArgs.builder()
    .envId("string")
    .type("string")
    .clusterId("string")
    .gitDetails(OverridesGitDetailsArgs.builder()
        .baseBranch("string")
        .branch("string")
        .commitMessage("string")
        .connectorRef("string")
        .filePath("string")
        .isHarnessCodeRepo(false)
        .isNewBranch(false)
        .lastCommitId("string")
        .lastObjectId("string")
        .loadFromCache(false)
        .loadFromFallbackBranch(false)
        .repoName("string")
        .storeType("string")
        .build())
    .identifier("string")
    .importFromGit(false)
    .infraId("string")
    .isForceImport(false)
    .orgId("string")
    .projectId("string")
    .serviceId("string")
    .yaml("string")
    .build());
overrides_resource = harness.platform.Overrides("overridesResource",
    env_id="string",
    type="string",
    cluster_id="string",
    git_details={
        "base_branch": "string",
        "branch": "string",
        "commit_message": "string",
        "connector_ref": "string",
        "file_path": "string",
        "is_harness_code_repo": False,
        "is_new_branch": False,
        "last_commit_id": "string",
        "last_object_id": "string",
        "load_from_cache": False,
        "load_from_fallback_branch": False,
        "repo_name": "string",
        "store_type": "string",
    },
    identifier="string",
    import_from_git=False,
    infra_id="string",
    is_force_import=False,
    org_id="string",
    project_id="string",
    service_id="string",
    yaml="string")
const overridesResource = new harness.platform.Overrides("overridesResource", {
    envId: "string",
    type: "string",
    clusterId: "string",
    gitDetails: {
        baseBranch: "string",
        branch: "string",
        commitMessage: "string",
        connectorRef: "string",
        filePath: "string",
        isHarnessCodeRepo: false,
        isNewBranch: false,
        lastCommitId: "string",
        lastObjectId: "string",
        loadFromCache: false,
        loadFromFallbackBranch: false,
        repoName: "string",
        storeType: "string",
    },
    identifier: "string",
    importFromGit: false,
    infraId: "string",
    isForceImport: false,
    orgId: "string",
    projectId: "string",
    serviceId: "string",
    yaml: "string",
});
type: harness:platform:Overrides
properties:
    clusterId: string
    envId: string
    gitDetails:
        baseBranch: string
        branch: string
        commitMessage: string
        connectorRef: string
        filePath: string
        isHarnessCodeRepo: false
        isNewBranch: false
        lastCommitId: string
        lastObjectId: string
        loadFromCache: false
        loadFromFallbackBranch: false
        repoName: string
        storeType: string
    identifier: string
    importFromGit: false
    infraId: string
    isForceImport: false
    orgId: string
    projectId: string
    serviceId: string
    type: string
    yaml: string
Overrides 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 Overrides resource accepts the following input properties:
- EnvId string
- The environment ID to which the overrides are associated.
- Type string
- The type of the overrides.
- ClusterId string
- The cluster ID to which the overrides are associated.
- GitDetails OverridesGit Details 
- Contains parameters related to creating an Entity for Git Experience.
- Identifier string
- The identifier of the override entity.
- ImportFrom boolGit 
- import override from git
- InfraId string
- The infrastructure ID to which the overrides are associated.
- IsForce boolImport 
- force import override from remote even if same file path already exist
- OrgId string
- Unique identifier of the organization.
- ProjectId string
- Unique identifier of the project.
- ServiceId string
- The service ID to which the overrides applies.
- Yaml string
- The yaml of the override entity
- EnvId string
- The environment ID to which the overrides are associated.
- Type string
- The type of the overrides.
- ClusterId string
- The cluster ID to which the overrides are associated.
- GitDetails OverridesGit Details Args 
- Contains parameters related to creating an Entity for Git Experience.
- Identifier string
- The identifier of the override entity.
- ImportFrom boolGit 
- import override from git
- InfraId string
- The infrastructure ID to which the overrides are associated.
- IsForce boolImport 
- force import override from remote even if same file path already exist
- OrgId string
- Unique identifier of the organization.
- ProjectId string
- Unique identifier of the project.
- ServiceId string
- The service ID to which the overrides applies.
- Yaml string
- The yaml of the override entity
- envId String
- The environment ID to which the overrides are associated.
- type String
- The type of the overrides.
- clusterId String
- The cluster ID to which the overrides are associated.
- gitDetails OverridesGit Details 
- Contains parameters related to creating an Entity for Git Experience.
- identifier String
- The identifier of the override entity.
- importFrom BooleanGit 
- import override from git
- infraId String
- The infrastructure ID to which the overrides are associated.
- isForce BooleanImport 
- force import override from remote even if same file path already exist
- orgId String
- Unique identifier of the organization.
- projectId String
- Unique identifier of the project.
- serviceId String
- The service ID to which the overrides applies.
- yaml String
- The yaml of the override entity
- envId string
- The environment ID to which the overrides are associated.
- type string
- The type of the overrides.
- clusterId string
- The cluster ID to which the overrides are associated.
- gitDetails OverridesGit Details 
- Contains parameters related to creating an Entity for Git Experience.
- identifier string
- The identifier of the override entity.
- importFrom booleanGit 
- import override from git
- infraId string
- The infrastructure ID to which the overrides are associated.
- isForce booleanImport 
- force import override from remote even if same file path already exist
- orgId string
- Unique identifier of the organization.
- projectId string
- Unique identifier of the project.
- serviceId string
- The service ID to which the overrides applies.
- yaml string
- The yaml of the override entity
- env_id str
- The environment ID to which the overrides are associated.
- type str
- The type of the overrides.
- cluster_id str
- The cluster ID to which the overrides are associated.
- git_details OverridesGit Details Args 
- Contains parameters related to creating an Entity for Git Experience.
- identifier str
- The identifier of the override entity.
- import_from_ boolgit 
- import override from git
- infra_id str
- The infrastructure ID to which the overrides are associated.
- is_force_ boolimport 
- force import override from remote even if same file path already exist
- org_id str
- Unique identifier of the organization.
- project_id str
- Unique identifier of the project.
- service_id str
- The service ID to which the overrides applies.
- yaml str
- The yaml of the override entity
- envId String
- The environment ID to which the overrides are associated.
- type String
- The type of the overrides.
- clusterId String
- The cluster ID to which the overrides are associated.
- gitDetails Property Map
- Contains parameters related to creating an Entity for Git Experience.
- identifier String
- The identifier of the override entity.
- importFrom BooleanGit 
- import override from git
- infraId String
- The infrastructure ID to which the overrides are associated.
- isForce BooleanImport 
- force import override from remote even if same file path already exist
- orgId String
- Unique identifier of the organization.
- projectId String
- Unique identifier of the project.
- serviceId String
- The service ID to which the overrides applies.
- yaml String
- The yaml of the override entity
Outputs
All input properties are implicitly available as output properties. Additionally, the Overrides 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 Overrides Resource
Get an existing Overrides 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?: OverridesState, opts?: CustomResourceOptions): Overrides@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_id: Optional[str] = None,
        env_id: Optional[str] = None,
        git_details: Optional[OverridesGitDetailsArgs] = None,
        identifier: Optional[str] = None,
        import_from_git: Optional[bool] = None,
        infra_id: Optional[str] = None,
        is_force_import: Optional[bool] = None,
        org_id: Optional[str] = None,
        project_id: Optional[str] = None,
        service_id: Optional[str] = None,
        type: Optional[str] = None,
        yaml: Optional[str] = None) -> Overridesfunc GetOverrides(ctx *Context, name string, id IDInput, state *OverridesState, opts ...ResourceOption) (*Overrides, error)public static Overrides Get(string name, Input<string> id, OverridesState? state, CustomResourceOptions? opts = null)public static Overrides get(String name, Output<String> id, OverridesState state, CustomResourceOptions options)resources:  _:    type: harness:platform:Overrides    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.
- ClusterId string
- The cluster ID to which the overrides are associated.
- EnvId string
- The environment ID to which the overrides are associated.
- GitDetails OverridesGit Details 
- Contains parameters related to creating an Entity for Git Experience.
- Identifier string
- The identifier of the override entity.
- ImportFrom boolGit 
- import override from git
- InfraId string
- The infrastructure ID to which the overrides are associated.
- IsForce boolImport 
- force import override from remote even if same file path already exist
- OrgId string
- Unique identifier of the organization.
- ProjectId string
- Unique identifier of the project.
- ServiceId string
- The service ID to which the overrides applies.
- Type string
- The type of the overrides.
- Yaml string
- The yaml of the override entity
- ClusterId string
- The cluster ID to which the overrides are associated.
- EnvId string
- The environment ID to which the overrides are associated.
- GitDetails OverridesGit Details Args 
- Contains parameters related to creating an Entity for Git Experience.
- Identifier string
- The identifier of the override entity.
- ImportFrom boolGit 
- import override from git
- InfraId string
- The infrastructure ID to which the overrides are associated.
- IsForce boolImport 
- force import override from remote even if same file path already exist
- OrgId string
- Unique identifier of the organization.
- ProjectId string
- Unique identifier of the project.
- ServiceId string
- The service ID to which the overrides applies.
- Type string
- The type of the overrides.
- Yaml string
- The yaml of the override entity
- clusterId String
- The cluster ID to which the overrides are associated.
- envId String
- The environment ID to which the overrides are associated.
- gitDetails OverridesGit Details 
- Contains parameters related to creating an Entity for Git Experience.
- identifier String
- The identifier of the override entity.
- importFrom BooleanGit 
- import override from git
- infraId String
- The infrastructure ID to which the overrides are associated.
- isForce BooleanImport 
- force import override from remote even if same file path already exist
- orgId String
- Unique identifier of the organization.
- projectId String
- Unique identifier of the project.
- serviceId String
- The service ID to which the overrides applies.
- type String
- The type of the overrides.
- yaml String
- The yaml of the override entity
- clusterId string
- The cluster ID to which the overrides are associated.
- envId string
- The environment ID to which the overrides are associated.
- gitDetails OverridesGit Details 
- Contains parameters related to creating an Entity for Git Experience.
- identifier string
- The identifier of the override entity.
- importFrom booleanGit 
- import override from git
- infraId string
- The infrastructure ID to which the overrides are associated.
- isForce booleanImport 
- force import override from remote even if same file path already exist
- orgId string
- Unique identifier of the organization.
- projectId string
- Unique identifier of the project.
- serviceId string
- The service ID to which the overrides applies.
- type string
- The type of the overrides.
- yaml string
- The yaml of the override entity
- cluster_id str
- The cluster ID to which the overrides are associated.
- env_id str
- The environment ID to which the overrides are associated.
- git_details OverridesGit Details Args 
- Contains parameters related to creating an Entity for Git Experience.
- identifier str
- The identifier of the override entity.
- import_from_ boolgit 
- import override from git
- infra_id str
- The infrastructure ID to which the overrides are associated.
- is_force_ boolimport 
- force import override from remote even if same file path already exist
- org_id str
- Unique identifier of the organization.
- project_id str
- Unique identifier of the project.
- service_id str
- The service ID to which the overrides applies.
- type str
- The type of the overrides.
- yaml str
- The yaml of the override entity
- clusterId String
- The cluster ID to which the overrides are associated.
- envId String
- The environment ID to which the overrides are associated.
- gitDetails Property Map
- Contains parameters related to creating an Entity for Git Experience.
- identifier String
- The identifier of the override entity.
- importFrom BooleanGit 
- import override from git
- infraId String
- The infrastructure ID to which the overrides are associated.
- isForce BooleanImport 
- force import override from remote even if same file path already exist
- orgId String
- Unique identifier of the organization.
- projectId String
- Unique identifier of the project.
- serviceId String
- The service ID to which the overrides applies.
- type String
- The type of the overrides.
- yaml String
- The yaml of the override entity
Supporting Types
OverridesGitDetails, OverridesGitDetailsArgs      
- BaseBranch string
- Name of the default branch (this checks out a new branch titled by branch_name).
- Branch string
- Name of the branch.
- CommitMessage string
- Commit message used for the merge commit.
- ConnectorRef string
- Identifier of the Harness Connector used for CRUD operations on the Entity. 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}.
- FilePath string
- File path of the Entity in the repository.
- IsHarness boolCode Repo 
- If the repo is in harness code
- IsNew boolBranch 
- If the branch being created is new
- LastCommit stringId 
- Last commit identifier (for Git Repositories other than Github). To be provided only when updating override.
- LastObject stringId 
- Last object identifier (for Github). To be provided only when updating override.
- LoadFrom boolCache 
- Load service yaml from catch
- LoadFrom boolFallback Branch 
- Load service yaml from fallback branch
- RepoName string
- Name of the repository.
- StoreType string
- Specifies whether the Entity is to be stored in Git or not. Possible values: INLINE, REMOTE.
- BaseBranch string
- Name of the default branch (this checks out a new branch titled by branch_name).
- Branch string
- Name of the branch.
- CommitMessage string
- Commit message used for the merge commit.
- ConnectorRef string
- Identifier of the Harness Connector used for CRUD operations on the Entity. 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}.
- FilePath string
- File path of the Entity in the repository.
- IsHarness boolCode Repo 
- If the repo is in harness code
- IsNew boolBranch 
- If the branch being created is new
- LastCommit stringId 
- Last commit identifier (for Git Repositories other than Github). To be provided only when updating override.
- LastObject stringId 
- Last object identifier (for Github). To be provided only when updating override.
- LoadFrom boolCache 
- Load service yaml from catch
- LoadFrom boolFallback Branch 
- Load service yaml from fallback branch
- RepoName string
- Name of the repository.
- StoreType string
- Specifies whether the Entity is to be stored in Git or not. Possible values: INLINE, REMOTE.
- baseBranch String
- Name of the default branch (this checks out a new branch titled by branch_name).
- branch String
- Name of the branch.
- commitMessage String
- Commit message used for the merge commit.
- connectorRef String
- Identifier of the Harness Connector used for CRUD operations on the Entity. 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}.
- filePath String
- File path of the Entity in the repository.
- isHarness BooleanCode Repo 
- If the repo is in harness code
- isNew BooleanBranch 
- If the branch being created is new
- lastCommit StringId 
- Last commit identifier (for Git Repositories other than Github). To be provided only when updating override.
- lastObject StringId 
- Last object identifier (for Github). To be provided only when updating override.
- loadFrom BooleanCache 
- Load service yaml from catch
- loadFrom BooleanFallback Branch 
- Load service yaml from fallback branch
- repoName String
- Name of the repository.
- storeType String
- Specifies whether the Entity is to be stored in Git or not. Possible values: INLINE, REMOTE.
- baseBranch string
- Name of the default branch (this checks out a new branch titled by branch_name).
- branch string
- Name of the branch.
- commitMessage string
- Commit message used for the merge commit.
- connectorRef string
- Identifier of the Harness Connector used for CRUD operations on the Entity. 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}.
- filePath string
- File path of the Entity in the repository.
- isHarness booleanCode Repo 
- If the repo is in harness code
- isNew booleanBranch 
- If the branch being created is new
- lastCommit stringId 
- Last commit identifier (for Git Repositories other than Github). To be provided only when updating override.
- lastObject stringId 
- Last object identifier (for Github). To be provided only when updating override.
- loadFrom booleanCache 
- Load service yaml from catch
- loadFrom booleanFallback Branch 
- Load service yaml from fallback branch
- repoName string
- Name of the repository.
- storeType 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 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 CRUD operations on the Entity. 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 in harness code
- is_new_ boolbranch 
- If the branch being created is new
- last_commit_ strid 
- Last commit identifier (for Git Repositories other than Github). To be provided only when updating override.
- last_object_ strid 
- Last object identifier (for Github). To be provided only when updating override.
- load_from_ boolcache 
- Load service yaml from catch
- load_from_ boolfallback_ branch 
- Load service yaml from fallback branch
- 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.
- baseBranch String
- Name of the default branch (this checks out a new branch titled by branch_name).
- branch String
- Name of the branch.
- commitMessage String
- Commit message used for the merge commit.
- connectorRef String
- Identifier of the Harness Connector used for CRUD operations on the Entity. 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}.
- filePath String
- File path of the Entity in the repository.
- isHarness BooleanCode Repo 
- If the repo is in harness code
- isNew BooleanBranch 
- If the branch being created is new
- lastCommit StringId 
- Last commit identifier (for Git Repositories other than Github). To be provided only when updating override.
- lastObject StringId 
- Last object identifier (for Github). To be provided only when updating override.
- loadFrom BooleanCache 
- Load service yaml from catch
- loadFrom BooleanFallback Branch 
- Load service yaml from fallback branch
- repoName String
- Name of the repository.
- storeType String
- Specifies whether the Entity is to be stored in Git or not. Possible values: INLINE, REMOTE.
Package Details
- Repository
- harness pulumi/pulumi-harness
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the harnessTerraform Provider.
