Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Harness
  3. API Docs
  4. platform
  5. Overrides
Harness v0.3.2 published on Monday, Sep 16, 2024 by Pulumi
pulumi/pulumi-harness

harness.platform.Overrides

Explore with Pulumi AI

harness logo
Harness v0.3.2 published on Monday, Sep 16, 2024 by Pulumi
pulumi/pulumi-harness

    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=harness.platform.OverridesGitDetailsArgs(
        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

    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 OverridesGitDetails
    Contains parameters related to creating an Entity for Git Experience.
    Identifier string
    The identifier of the override entity.
    ImportFromGit bool
    import override from git
    InfraId string
    The infrastructure ID to which the overrides are associated.
    IsForceImport bool
    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 OverridesGitDetailsArgs
    Contains parameters related to creating an Entity for Git Experience.
    Identifier string
    The identifier of the override entity.
    ImportFromGit bool
    import override from git
    InfraId string
    The infrastructure ID to which the overrides are associated.
    IsForceImport bool
    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 OverridesGitDetails
    Contains parameters related to creating an Entity for Git Experience.
    identifier String
    The identifier of the override entity.
    importFromGit Boolean
    import override from git
    infraId String
    The infrastructure ID to which the overrides are associated.
    isForceImport Boolean
    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 OverridesGitDetails
    Contains parameters related to creating an Entity for Git Experience.
    identifier string
    The identifier of the override entity.
    importFromGit boolean
    import override from git
    infraId string
    The infrastructure ID to which the overrides are associated.
    isForceImport boolean
    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 OverridesGitDetailsArgs
    Contains parameters related to creating an Entity for Git Experience.
    identifier str
    The identifier of the override entity.
    import_from_git bool
    import override from git
    infra_id str
    The infrastructure ID to which the overrides are associated.
    is_force_import bool
    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.
    importFromGit Boolean
    import override from git
    infraId String
    The infrastructure ID to which the overrides are associated.
    isForceImport Boolean
    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) -> Overrides
    func 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)
    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:
    ClusterId string
    The cluster ID to which the overrides are associated.
    EnvId string
    The environment ID to which the overrides are associated.
    GitDetails OverridesGitDetails
    Contains parameters related to creating an Entity for Git Experience.
    Identifier string
    The identifier of the override entity.
    ImportFromGit bool
    import override from git
    InfraId string
    The infrastructure ID to which the overrides are associated.
    IsForceImport bool
    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 OverridesGitDetailsArgs
    Contains parameters related to creating an Entity for Git Experience.
    Identifier string
    The identifier of the override entity.
    ImportFromGit bool
    import override from git
    InfraId string
    The infrastructure ID to which the overrides are associated.
    IsForceImport bool
    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 OverridesGitDetails
    Contains parameters related to creating an Entity for Git Experience.
    identifier String
    The identifier of the override entity.
    importFromGit Boolean
    import override from git
    infraId String
    The infrastructure ID to which the overrides are associated.
    isForceImport Boolean
    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 OverridesGitDetails
    Contains parameters related to creating an Entity for Git Experience.
    identifier string
    The identifier of the override entity.
    importFromGit boolean
    import override from git
    infraId string
    The infrastructure ID to which the overrides are associated.
    isForceImport boolean
    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 OverridesGitDetailsArgs
    Contains parameters related to creating an Entity for Git Experience.
    identifier str
    The identifier of the override entity.
    import_from_git bool
    import override from git
    infra_id str
    The infrastructure ID to which the overrides are associated.
    is_force_import bool
    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.
    importFromGit Boolean
    import override from git
    infraId String
    The infrastructure ID to which the overrides are associated.
    isForceImport Boolean
    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.
    IsHarnessCodeRepo bool
    If the repo is in harness code
    IsNewBranch bool
    If the branch being created is new
    LastCommitId string
    Last commit identifier (for Git Repositories other than Github). To be provided only when updating override.
    LastObjectId string
    Last object identifier (for Github). To be provided only when updating override.
    LoadFromCache bool
    Load service yaml from catch
    LoadFromFallbackBranch bool
    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.
    IsHarnessCodeRepo bool
    If the repo is in harness code
    IsNewBranch bool
    If the branch being created is new
    LastCommitId string
    Last commit identifier (for Git Repositories other than Github). To be provided only when updating override.
    LastObjectId string
    Last object identifier (for Github). To be provided only when updating override.
    LoadFromCache bool
    Load service yaml from catch
    LoadFromFallbackBranch bool
    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.
    isHarnessCodeRepo Boolean
    If the repo is in harness code
    isNewBranch Boolean
    If the branch being created is new
    lastCommitId String
    Last commit identifier (for Git Repositories other than Github). To be provided only when updating override.
    lastObjectId String
    Last object identifier (for Github). To be provided only when updating override.
    loadFromCache Boolean
    Load service yaml from catch
    loadFromFallbackBranch Boolean
    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.
    isHarnessCodeRepo boolean
    If the repo is in harness code
    isNewBranch boolean
    If the branch being created is new
    lastCommitId string
    Last commit identifier (for Git Repositories other than Github). To be provided only when updating override.
    lastObjectId string
    Last object identifier (for Github). To be provided only when updating override.
    loadFromCache boolean
    Load service yaml from catch
    loadFromFallbackBranch boolean
    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_code_repo bool
    If the repo is in harness code
    is_new_branch bool
    If the branch being created is new
    last_commit_id str
    Last commit identifier (for Git Repositories other than Github). To be provided only when updating override.
    last_object_id str
    Last object identifier (for Github). To be provided only when updating override.
    load_from_cache bool
    Load service yaml from catch
    load_from_fallback_branch bool
    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.
    isHarnessCodeRepo Boolean
    If the repo is in harness code
    isNewBranch Boolean
    If the branch being created is new
    lastCommitId String
    Last commit identifier (for Git Repositories other than Github). To be provided only when updating override.
    lastObjectId String
    Last object identifier (for Github). To be provided only when updating override.
    loadFromCache Boolean
    Load service yaml from catch
    loadFromFallbackBranch Boolean
    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 harness Terraform Provider.
    harness logo
    Harness v0.3.2 published on Monday, Sep 16, 2024 by Pulumi
    pulumi/pulumi-harness