Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Okta Provider
  3. API Docs
  4. LinkDefinition
Okta v4.16.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-okta

okta.LinkDefinition

Explore with Pulumi AI

Okta v4.16.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-okta

Manages the creation and removal of the link definitions.

Link definition operations allow you to manage the creation and removal of the link definitions. If you remove a link definition, links based on that definition are unavailable. Note that this resource is immutable, thus can not be modified.

NOTE: Links reappear if you recreate the definition. However, Okta is likely to change this behavior so that links don’t reappear. Don’t rely on this behavior in production environments.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";

const example = new okta.LinkDefinition("example", {
    primaryName: "emperor",
    primaryTitle: "Emperor",
    primaryDescription: "Hereditary ruler of the Imperium and the Known Universe",
    associatedName: "sardaukar",
    associatedTitle: "Sardaukar",
    associatedDescription: "Elite military force member",
});
Copy
import pulumi
import pulumi_okta as okta

example = okta.LinkDefinition("example",
    primary_name="emperor",
    primary_title="Emperor",
    primary_description="Hereditary ruler of the Imperium and the Known Universe",
    associated_name="sardaukar",
    associated_title="Sardaukar",
    associated_description="Elite military force member")
Copy
package main

import (
	"github.com/pulumi/pulumi-okta/sdk/v4/go/okta"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := okta.NewLinkDefinition(ctx, "example", &okta.LinkDefinitionArgs{
			PrimaryName:           pulumi.String("emperor"),
			PrimaryTitle:          pulumi.String("Emperor"),
			PrimaryDescription:    pulumi.String("Hereditary ruler of the Imperium and the Known Universe"),
			AssociatedName:        pulumi.String("sardaukar"),
			AssociatedTitle:       pulumi.String("Sardaukar"),
			AssociatedDescription: pulumi.String("Elite military force member"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Okta = Pulumi.Okta;

return await Deployment.RunAsync(() => 
{
    var example = new Okta.LinkDefinition("example", new()
    {
        PrimaryName = "emperor",
        PrimaryTitle = "Emperor",
        PrimaryDescription = "Hereditary ruler of the Imperium and the Known Universe",
        AssociatedName = "sardaukar",
        AssociatedTitle = "Sardaukar",
        AssociatedDescription = "Elite military force member",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.LinkDefinition;
import com.pulumi.okta.LinkDefinitionArgs;
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 example = new LinkDefinition("example", LinkDefinitionArgs.builder()
            .primaryName("emperor")
            .primaryTitle("Emperor")
            .primaryDescription("Hereditary ruler of the Imperium and the Known Universe")
            .associatedName("sardaukar")
            .associatedTitle("Sardaukar")
            .associatedDescription("Elite military force member")
            .build());

    }
}
Copy
resources:
  example:
    type: okta:LinkDefinition
    properties:
      primaryName: emperor
      primaryTitle: Emperor
      primaryDescription: Hereditary ruler of the Imperium and the Known Universe
      associatedName: sardaukar
      associatedTitle: Sardaukar
      associatedDescription: Elite military force member
Copy

Create LinkDefinition Resource

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

Constructor syntax

new LinkDefinition(name: string, args: LinkDefinitionArgs, opts?: CustomResourceOptions);
@overload
def LinkDefinition(resource_name: str,
                   args: LinkDefinitionArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def LinkDefinition(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   associated_description: Optional[str] = None,
                   associated_name: Optional[str] = None,
                   associated_title: Optional[str] = None,
                   primary_description: Optional[str] = None,
                   primary_name: Optional[str] = None,
                   primary_title: Optional[str] = None)
func NewLinkDefinition(ctx *Context, name string, args LinkDefinitionArgs, opts ...ResourceOption) (*LinkDefinition, error)
public LinkDefinition(string name, LinkDefinitionArgs args, CustomResourceOptions? opts = null)
public LinkDefinition(String name, LinkDefinitionArgs args)
public LinkDefinition(String name, LinkDefinitionArgs args, CustomResourceOptions options)

type: okta:LinkDefinition
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. LinkDefinitionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. LinkDefinitionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. LinkDefinitionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. LinkDefinitionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. LinkDefinitionArgs
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 linkDefinitionResource = new Okta.LinkDefinition("linkDefinitionResource", new()
{
    AssociatedDescription = "string",
    AssociatedName = "string",
    AssociatedTitle = "string",
    PrimaryDescription = "string",
    PrimaryName = "string",
    PrimaryTitle = "string",
});
Copy
example, err := okta.NewLinkDefinition(ctx, "linkDefinitionResource", &okta.LinkDefinitionArgs{
	AssociatedDescription: pulumi.String("string"),
	AssociatedName:        pulumi.String("string"),
	AssociatedTitle:       pulumi.String("string"),
	PrimaryDescription:    pulumi.String("string"),
	PrimaryName:           pulumi.String("string"),
	PrimaryTitle:          pulumi.String("string"),
})
Copy
var linkDefinitionResource = new LinkDefinition("linkDefinitionResource", LinkDefinitionArgs.builder()
    .associatedDescription("string")
    .associatedName("string")
    .associatedTitle("string")
    .primaryDescription("string")
    .primaryName("string")
    .primaryTitle("string")
    .build());
Copy
link_definition_resource = okta.LinkDefinition("linkDefinitionResource",
    associated_description="string",
    associated_name="string",
    associated_title="string",
    primary_description="string",
    primary_name="string",
    primary_title="string")
Copy
const linkDefinitionResource = new okta.LinkDefinition("linkDefinitionResource", {
    associatedDescription: "string",
    associatedName: "string",
    associatedTitle: "string",
    primaryDescription: "string",
    primaryName: "string",
    primaryTitle: "string",
});
Copy
type: okta:LinkDefinition
properties:
    associatedDescription: string
    associatedName: string
    associatedTitle: string
    primaryDescription: string
    primaryName: string
    primaryTitle: string
Copy

LinkDefinition 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 LinkDefinition resource accepts the following input properties:

AssociatedDescription
This property is required.
Changes to this property will trigger replacement.
string
Description of the associated relationship.
AssociatedName
This property is required.
Changes to this property will trigger replacement.
string
API name of the associated link.
AssociatedTitle
This property is required.
Changes to this property will trigger replacement.
string
Display name of the associated link.
PrimaryDescription
This property is required.
Changes to this property will trigger replacement.
string
Description of the primary relationship.
PrimaryName
This property is required.
Changes to this property will trigger replacement.
string
API name of the primary link.
PrimaryTitle
This property is required.
Changes to this property will trigger replacement.
string
Display name of the primary link.
AssociatedDescription
This property is required.
Changes to this property will trigger replacement.
string
Description of the associated relationship.
AssociatedName
This property is required.
Changes to this property will trigger replacement.
string
API name of the associated link.
AssociatedTitle
This property is required.
Changes to this property will trigger replacement.
string
Display name of the associated link.
PrimaryDescription
This property is required.
Changes to this property will trigger replacement.
string
Description of the primary relationship.
PrimaryName
This property is required.
Changes to this property will trigger replacement.
string
API name of the primary link.
PrimaryTitle
This property is required.
Changes to this property will trigger replacement.
string
Display name of the primary link.
associatedDescription
This property is required.
Changes to this property will trigger replacement.
String
Description of the associated relationship.
associatedName
This property is required.
Changes to this property will trigger replacement.
String
API name of the associated link.
associatedTitle
This property is required.
Changes to this property will trigger replacement.
String
Display name of the associated link.
primaryDescription
This property is required.
Changes to this property will trigger replacement.
String
Description of the primary relationship.
primaryName
This property is required.
Changes to this property will trigger replacement.
String
API name of the primary link.
primaryTitle
This property is required.
Changes to this property will trigger replacement.
String
Display name of the primary link.
associatedDescription
This property is required.
Changes to this property will trigger replacement.
string
Description of the associated relationship.
associatedName
This property is required.
Changes to this property will trigger replacement.
string
API name of the associated link.
associatedTitle
This property is required.
Changes to this property will trigger replacement.
string
Display name of the associated link.
primaryDescription
This property is required.
Changes to this property will trigger replacement.
string
Description of the primary relationship.
primaryName
This property is required.
Changes to this property will trigger replacement.
string
API name of the primary link.
primaryTitle
This property is required.
Changes to this property will trigger replacement.
string
Display name of the primary link.
associated_description
This property is required.
Changes to this property will trigger replacement.
str
Description of the associated relationship.
associated_name
This property is required.
Changes to this property will trigger replacement.
str
API name of the associated link.
associated_title
This property is required.
Changes to this property will trigger replacement.
str
Display name of the associated link.
primary_description
This property is required.
Changes to this property will trigger replacement.
str
Description of the primary relationship.
primary_name
This property is required.
Changes to this property will trigger replacement.
str
API name of the primary link.
primary_title
This property is required.
Changes to this property will trigger replacement.
str
Display name of the primary link.
associatedDescription
This property is required.
Changes to this property will trigger replacement.
String
Description of the associated relationship.
associatedName
This property is required.
Changes to this property will trigger replacement.
String
API name of the associated link.
associatedTitle
This property is required.
Changes to this property will trigger replacement.
String
Display name of the associated link.
primaryDescription
This property is required.
Changes to this property will trigger replacement.
String
Description of the primary relationship.
primaryName
This property is required.
Changes to this property will trigger replacement.
String
API name of the primary link.
primaryTitle
This property is required.
Changes to this property will trigger replacement.
String
Display name of the primary link.

Outputs

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

Get an existing LinkDefinition 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?: LinkDefinitionState, opts?: CustomResourceOptions): LinkDefinition
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        associated_description: Optional[str] = None,
        associated_name: Optional[str] = None,
        associated_title: Optional[str] = None,
        primary_description: Optional[str] = None,
        primary_name: Optional[str] = None,
        primary_title: Optional[str] = None) -> LinkDefinition
func GetLinkDefinition(ctx *Context, name string, id IDInput, state *LinkDefinitionState, opts ...ResourceOption) (*LinkDefinition, error)
public static LinkDefinition Get(string name, Input<string> id, LinkDefinitionState? state, CustomResourceOptions? opts = null)
public static LinkDefinition get(String name, Output<String> id, LinkDefinitionState state, CustomResourceOptions options)
resources:  _:    type: okta:LinkDefinition    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AssociatedDescription Changes to this property will trigger replacement. string
Description of the associated relationship.
AssociatedName Changes to this property will trigger replacement. string
API name of the associated link.
AssociatedTitle Changes to this property will trigger replacement. string
Display name of the associated link.
PrimaryDescription Changes to this property will trigger replacement. string
Description of the primary relationship.
PrimaryName Changes to this property will trigger replacement. string
API name of the primary link.
PrimaryTitle Changes to this property will trigger replacement. string
Display name of the primary link.
AssociatedDescription Changes to this property will trigger replacement. string
Description of the associated relationship.
AssociatedName Changes to this property will trigger replacement. string
API name of the associated link.
AssociatedTitle Changes to this property will trigger replacement. string
Display name of the associated link.
PrimaryDescription Changes to this property will trigger replacement. string
Description of the primary relationship.
PrimaryName Changes to this property will trigger replacement. string
API name of the primary link.
PrimaryTitle Changes to this property will trigger replacement. string
Display name of the primary link.
associatedDescription Changes to this property will trigger replacement. String
Description of the associated relationship.
associatedName Changes to this property will trigger replacement. String
API name of the associated link.
associatedTitle Changes to this property will trigger replacement. String
Display name of the associated link.
primaryDescription Changes to this property will trigger replacement. String
Description of the primary relationship.
primaryName Changes to this property will trigger replacement. String
API name of the primary link.
primaryTitle Changes to this property will trigger replacement. String
Display name of the primary link.
associatedDescription Changes to this property will trigger replacement. string
Description of the associated relationship.
associatedName Changes to this property will trigger replacement. string
API name of the associated link.
associatedTitle Changes to this property will trigger replacement. string
Display name of the associated link.
primaryDescription Changes to this property will trigger replacement. string
Description of the primary relationship.
primaryName Changes to this property will trigger replacement. string
API name of the primary link.
primaryTitle Changes to this property will trigger replacement. string
Display name of the primary link.
associated_description Changes to this property will trigger replacement. str
Description of the associated relationship.
associated_name Changes to this property will trigger replacement. str
API name of the associated link.
associated_title Changes to this property will trigger replacement. str
Display name of the associated link.
primary_description Changes to this property will trigger replacement. str
Description of the primary relationship.
primary_name Changes to this property will trigger replacement. str
API name of the primary link.
primary_title Changes to this property will trigger replacement. str
Display name of the primary link.
associatedDescription Changes to this property will trigger replacement. String
Description of the associated relationship.
associatedName Changes to this property will trigger replacement. String
API name of the associated link.
associatedTitle Changes to this property will trigger replacement. String
Display name of the associated link.
primaryDescription Changes to this property will trigger replacement. String
Description of the primary relationship.
primaryName Changes to this property will trigger replacement. String
API name of the primary link.
primaryTitle Changes to this property will trigger replacement. String
Display name of the primary link.

Import

$ pulumi import okta:index/linkDefinition:LinkDefinition example <primary_name>
Copy

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

Package Details

Repository
Okta pulumi/pulumi-okta
License
Apache-2.0
Notes
This Pulumi package is based on the okta Terraform Provider.
Okta v4.16.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-okta