Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Okta Provider
  3. API Docs
  4. LinkDefinition
Okta v4.11.3 published on Monday, Oct 21, 2024 by Pulumi
pulumi/pulumi-okta

okta.LinkDefinition

Explore with Pulumi AI

okta logo
Okta v4.11.3 published on Monday, Oct 21, 2024 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",
});

    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")

    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
	})
}

    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",
    });

});

    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());

    }
}

    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

    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 string
    The unique name of the resource.
    args LinkDefinitionArgs
    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 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 string
    The unique name of the resource.
    args LinkDefinitionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LinkDefinitionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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",
});

    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"),
})

    var linkDefinitionResource = new LinkDefinition("linkDefinitionResource", LinkDefinitionArgs.builder()
    .associatedDescription("string")
    .associatedName("string")
    .associatedTitle("string")
    .primaryDescription("string")
    .primaryName("string")
    .primaryTitle("string")
    .build());

    link_definition_resource = okta.LinkDefinition("linkDefinitionResource",
    associated_description="string",
    associated_name="string",
    associated_title="string",
    primary_description="string",
    primary_name="string",
    primary_title="string")

    const linkDefinitionResource = new okta.LinkDefinition("linkDefinitionResource", {
    associatedDescription: "string",
    associatedName: "string",
    associatedTitle: "string",
    primaryDescription: "string",
    primaryName: "string",
    primaryTitle: "string",
});

    type: okta:LinkDefinition
properties:
    associatedDescription: string
    associatedName: string
    associatedTitle: string
    primaryDescription: string
    primaryName: string
    primaryTitle: string

    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 string
    Description of the associated relationship.
    AssociatedName string
    API name of the associated link.
    AssociatedTitle string
    Display name of the associated link.
    PrimaryDescription string
    Description of the primary relationship.
    PrimaryName string
    API name of the primary link.
    PrimaryTitle string
    Display name of the primary link.
    AssociatedDescription string
    Description of the associated relationship.
    AssociatedName string
    API name of the associated link.
    AssociatedTitle string
    Display name of the associated link.
    PrimaryDescription string
    Description of the primary relationship.
    PrimaryName string
    API name of the primary link.
    PrimaryTitle string
    Display name of the primary link.
    associatedDescription String
    Description of the associated relationship.
    associatedName String
    API name of the associated link.
    associatedTitle String
    Display name of the associated link.
    primaryDescription String
    Description of the primary relationship.
    primaryName String
    API name of the primary link.
    primaryTitle String
    Display name of the primary link.
    associatedDescription string
    Description of the associated relationship.
    associatedName string
    API name of the associated link.
    associatedTitle string
    Display name of the associated link.
    primaryDescription string
    Description of the primary relationship.
    primaryName string
    API name of the primary link.
    primaryTitle string
    Display name of the primary link.
    associated_description str
    Description of the associated relationship.
    associated_name str
    API name of the associated link.
    associated_title str
    Display name of the associated link.
    primary_description str
    Description of the primary relationship.
    primary_name str
    API name of the primary link.
    primary_title str
    Display name of the primary link.
    associatedDescription String
    Description of the associated relationship.
    associatedName String
    API name of the associated link.
    associatedTitle String
    Display name of the associated link.
    primaryDescription String
    Description of the primary relationship.
    primaryName String
    API name of the primary link.
    primaryTitle 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)
    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:
    AssociatedDescription string
    Description of the associated relationship.
    AssociatedName string
    API name of the associated link.
    AssociatedTitle string
    Display name of the associated link.
    PrimaryDescription string
    Description of the primary relationship.
    PrimaryName string
    API name of the primary link.
    PrimaryTitle string
    Display name of the primary link.
    AssociatedDescription string
    Description of the associated relationship.
    AssociatedName string
    API name of the associated link.
    AssociatedTitle string
    Display name of the associated link.
    PrimaryDescription string
    Description of the primary relationship.
    PrimaryName string
    API name of the primary link.
    PrimaryTitle string
    Display name of the primary link.
    associatedDescription String
    Description of the associated relationship.
    associatedName String
    API name of the associated link.
    associatedTitle String
    Display name of the associated link.
    primaryDescription String
    Description of the primary relationship.
    primaryName String
    API name of the primary link.
    primaryTitle String
    Display name of the primary link.
    associatedDescription string
    Description of the associated relationship.
    associatedName string
    API name of the associated link.
    associatedTitle string
    Display name of the associated link.
    primaryDescription string
    Description of the primary relationship.
    primaryName string
    API name of the primary link.
    primaryTitle string
    Display name of the primary link.
    associated_description str
    Description of the associated relationship.
    associated_name str
    API name of the associated link.
    associated_title str
    Display name of the associated link.
    primary_description str
    Description of the primary relationship.
    primary_name str
    API name of the primary link.
    primary_title str
    Display name of the primary link.
    associatedDescription String
    Description of the associated relationship.
    associatedName String
    API name of the associated link.
    associatedTitle String
    Display name of the associated link.
    primaryDescription String
    Description of the primary relationship.
    primaryName String
    API name of the primary link.
    primaryTitle String
    Display name of the primary link.

    Import

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

    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 logo
    Okta v4.11.3 published on Monday, Oct 21, 2024 by Pulumi
    pulumi/pulumi-okta