inline

package
v4.0.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 26, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Hook 

type Hook struct {
	pulumi.CustomResourceState

	// Authentication required for inline hook request.
	Auth pulumi.StringMapOutput `pulumi:"auth"`
	// Details of the endpoint the inline hook will hit.
	Channel pulumi.StringMapOutput `pulumi:"channel"`
	// Map of headers to send along in inline hook request.
	Headers HookHeaderArrayOutput `pulumi:"headers"`
	// The inline hook display name.
	Name   pulumi.StringOutput    `pulumi:"name"`
	Status pulumi.StringPtrOutput `pulumi:"status"`
	// The type of hook to trigger. Currently, the only supported type is `"HTTP"`.
	Type pulumi.StringOutput `pulumi:"type"`
	// Version of the channel. The currently-supported version is `"1.0.0"`.
	Version pulumi.StringOutput `pulumi:"version"`
}

Creates an inline hook.

This resource allows you to create and configure an inline hook.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-okta/sdk/v4/go/okta/inline"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := inline.NewHook(ctx, "example", &inline.HookArgs{
			Auth: pulumi.StringMap{
				"key":   pulumi.String("Authorization"),
				"type":  pulumi.String("HEADER"),
				"value": pulumi.String("secret"),
			},
			Channel: pulumi.StringMap{
				"method":  pulumi.String("POST"),
				"uri":     pulumi.String("https://example.com/test"),
				"version": pulumi.String("1.0.0"),
			},
			Type:    pulumi.String("com.okta.oauth2.tokens.transform"),
			Version: pulumi.String("1.0.0"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

An inline hook can be imported via the Okta ID.

```sh 

$ pulumi import okta:inline/hook:Hook example <hook id>

```

func GetHook 

func GetHook(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *HookState, opts ...pulumi.ResourceOption) (*Hook, error)

GetHook gets an existing Hook resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewHook 

func NewHook(ctx *pulumi.Context,
	name string, args *HookArgs, opts ...pulumi.ResourceOption) (*Hook, error)

NewHook registers a new resource with the given unique name, arguments, and options.

func (*Hook) ElementType 

func (*Hook) ElementType() reflect.Type

func (*Hook) ToHookOutput 

func (i *Hook) ToHookOutput() HookOutput

func (*Hook) ToHookOutputWithContext 

func (i *Hook) ToHookOutputWithContext(ctx context.Context) HookOutput

type HookArgs 

type HookArgs struct {
	// Authentication required for inline hook request.
	Auth pulumi.StringMapInput
	// Details of the endpoint the inline hook will hit.
	Channel pulumi.StringMapInput
	// Map of headers to send along in inline hook request.
	Headers HookHeaderArrayInput
	// The inline hook display name.
	Name   pulumi.StringPtrInput
	Status pulumi.StringPtrInput
	// The type of hook to trigger. Currently, the only supported type is `"HTTP"`.
	Type pulumi.StringInput
	// Version of the channel. The currently-supported version is `"1.0.0"`.
	Version pulumi.StringInput
}

The set of arguments for constructing a Hook resource.

func (HookArgs) ElementType 

func (HookArgs) ElementType() reflect.Type

type HookArray 

type HookArray []HookInput

func (HookArray) ElementType 

func (HookArray) ElementType() reflect.Type

func (HookArray) ToHookArrayOutput 

func (i HookArray) ToHookArrayOutput() HookArrayOutput

func (HookArray) ToHookArrayOutputWithContext 

func (i HookArray) ToHookArrayOutputWithContext(ctx context.Context) HookArrayOutput

type HookArrayInput 

type HookArrayInput interface {
	pulumi.Input

	ToHookArrayOutput() HookArrayOutput
	ToHookArrayOutputWithContext(context.Context) HookArrayOutput
}

HookArrayInput is an input type that accepts HookArray and HookArrayOutput values. You can construct a concrete instance of `HookArrayInput` via: 

HookArray{ HookArgs{...} }

type HookArrayOutput 

type HookArrayOutput struct{ *pulumi.OutputState }

func (HookArrayOutput) ElementType 

func (HookArrayOutput) ElementType() reflect.Type

func (HookArrayOutput) Index 

func (o HookArrayOutput) Index(i pulumi.IntInput) HookOutput

func (HookArrayOutput) ToHookArrayOutput 

func (o HookArrayOutput) ToHookArrayOutput() HookArrayOutput

func (HookArrayOutput) ToHookArrayOutputWithContext 

func (o HookArrayOutput) ToHookArrayOutputWithContext(ctx context.Context) HookArrayOutput

type HookHeader 

type HookHeader struct {
	// Key to use for authentication, usually the header name, for example `"Authorization"`.
	Key *string `pulumi:"key"`
	// Authentication secret.
	Value *string `pulumi:"value"`
}

type HookHeaderArgs 

type HookHeaderArgs struct {
	// Key to use for authentication, usually the header name, for example `"Authorization"`.
	Key pulumi.StringPtrInput `pulumi:"key"`
	// Authentication secret.
	Value pulumi.StringPtrInput `pulumi:"value"`
}

func (HookHeaderArgs) ElementType 

func (HookHeaderArgs) ElementType() reflect.Type

func (HookHeaderArgs) ToHookHeaderOutput 

func (i HookHeaderArgs) ToHookHeaderOutput() HookHeaderOutput

func (HookHeaderArgs) ToHookHeaderOutputWithContext 

func (i HookHeaderArgs) ToHookHeaderOutputWithContext(ctx context.Context) HookHeaderOutput

type HookHeaderArray 

type HookHeaderArray []HookHeaderInput

func (HookHeaderArray) ElementType 

func (HookHeaderArray) ElementType() reflect.Type

func (HookHeaderArray) ToHookHeaderArrayOutput 

func (i HookHeaderArray) ToHookHeaderArrayOutput() HookHeaderArrayOutput

func (HookHeaderArray) ToHookHeaderArrayOutputWithContext 

func (i HookHeaderArray) ToHookHeaderArrayOutputWithContext(ctx context.Context) HookHeaderArrayOutput

type HookHeaderArrayInput 

type HookHeaderArrayInput interface {
	pulumi.Input

	ToHookHeaderArrayOutput() HookHeaderArrayOutput
	ToHookHeaderArrayOutputWithContext(context.Context) HookHeaderArrayOutput
}

HookHeaderArrayInput is an input type that accepts HookHeaderArray and HookHeaderArrayOutput values. You can construct a concrete instance of `HookHeaderArrayInput` via: 

HookHeaderArray{ HookHeaderArgs{...} }

type HookHeaderArrayOutput 

type HookHeaderArrayOutput struct{ *pulumi.OutputState }

func (HookHeaderArrayOutput) ElementType 

func (HookHeaderArrayOutput) ElementType() reflect.Type

func (HookHeaderArrayOutput) Index 

func (o HookHeaderArrayOutput) Index(i pulumi.IntInput) HookHeaderOutput

func (HookHeaderArrayOutput) ToHookHeaderArrayOutput 

func (o HookHeaderArrayOutput) ToHookHeaderArrayOutput() HookHeaderArrayOutput

func (HookHeaderArrayOutput) ToHookHeaderArrayOutputWithContext 

func (o HookHeaderArrayOutput) ToHookHeaderArrayOutputWithContext(ctx context.Context) HookHeaderArrayOutput

type HookHeaderInput 

type HookHeaderInput interface {
	pulumi.Input

	ToHookHeaderOutput() HookHeaderOutput
	ToHookHeaderOutputWithContext(context.Context) HookHeaderOutput
}

HookHeaderInput is an input type that accepts HookHeaderArgs and HookHeaderOutput values. You can construct a concrete instance of `HookHeaderInput` via: 

HookHeaderArgs{...}

type HookHeaderOutput 

type HookHeaderOutput struct{ *pulumi.OutputState }

func (HookHeaderOutput) ElementType 

func (HookHeaderOutput) ElementType() reflect.Type

func (HookHeaderOutput) Key 

func (o HookHeaderOutput) Key() pulumi.StringPtrOutput

Key to use for authentication, usually the header name, for example `"Authorization"`.

func (HookHeaderOutput) ToHookHeaderOutput 

func (o HookHeaderOutput) ToHookHeaderOutput() HookHeaderOutput

func (HookHeaderOutput) ToHookHeaderOutputWithContext 

func (o HookHeaderOutput) ToHookHeaderOutputWithContext(ctx context.Context) HookHeaderOutput

func (HookHeaderOutput) Value 

func (o HookHeaderOutput) Value() pulumi.StringPtrOutput

Authentication secret.

type HookInput 

type HookInput interface {
	pulumi.Input

	ToHookOutput() HookOutput
	ToHookOutputWithContext(ctx context.Context) HookOutput
}

type HookMap 

type HookMap map[string]HookInput

func (HookMap) ElementType 

func (HookMap) ElementType() reflect.Type

func (HookMap) ToHookMapOutput 

func (i HookMap) ToHookMapOutput() HookMapOutput

func (HookMap) ToHookMapOutputWithContext 

func (i HookMap) ToHookMapOutputWithContext(ctx context.Context) HookMapOutput

type HookMapInput 

type HookMapInput interface {
	pulumi.Input

	ToHookMapOutput() HookMapOutput
	ToHookMapOutputWithContext(context.Context) HookMapOutput
}

HookMapInput is an input type that accepts HookMap and HookMapOutput values. You can construct a concrete instance of `HookMapInput` via: 

HookMap{ "key": HookArgs{...} }

type HookMapOutput 

type HookMapOutput struct{ *pulumi.OutputState }

func (HookMapOutput) ElementType 

func (HookMapOutput) ElementType() reflect.Type

func (HookMapOutput) MapIndex 

func (o HookMapOutput) MapIndex(k pulumi.StringInput) HookOutput

func (HookMapOutput) ToHookMapOutput 

func (o HookMapOutput) ToHookMapOutput() HookMapOutput

func (HookMapOutput) ToHookMapOutputWithContext 

func (o HookMapOutput) ToHookMapOutputWithContext(ctx context.Context) HookMapOutput

type HookOutput 

type HookOutput struct{ *pulumi.OutputState }

func (HookOutput) Auth 

func (o HookOutput) Auth() pulumi.StringMapOutput

Authentication required for inline hook request.

func (HookOutput) Channel 

func (o HookOutput) Channel() pulumi.StringMapOutput

Details of the endpoint the inline hook will hit.

func (HookOutput) ElementType 

func (HookOutput) ElementType() reflect.Type

func (HookOutput) Headers 

func (o HookOutput) Headers() HookHeaderArrayOutput

Map of headers to send along in inline hook request.

func (HookOutput) Name 

func (o HookOutput) Name() pulumi.StringOutput

The inline hook display name.

func (HookOutput) Status 

func (o HookOutput) Status() pulumi.StringPtrOutput

func (HookOutput) ToHookOutput 

func (o HookOutput) ToHookOutput() HookOutput

func (HookOutput) ToHookOutputWithContext 

func (o HookOutput) ToHookOutputWithContext(ctx context.Context) HookOutput

func (HookOutput) Type 

func (o HookOutput) Type() pulumi.StringOutput

The type of hook to trigger. Currently, the only supported type is `"HTTP"`.

func (HookOutput) Version 

func (o HookOutput) Version() pulumi.StringOutput

Version of the channel. The currently-supported version is `"1.0.0"`.

type HookState 

type HookState struct {
	// Authentication required for inline hook request.
	Auth pulumi.StringMapInput
	// Details of the endpoint the inline hook will hit.
	Channel pulumi.StringMapInput
	// Map of headers to send along in inline hook request.
	Headers HookHeaderArrayInput
	// The inline hook display name.
	Name   pulumi.StringPtrInput
	Status pulumi.StringPtrInput
	// The type of hook to trigger. Currently, the only supported type is `"HTTP"`.
	Type pulumi.StringPtrInput
	// Version of the channel. The currently-supported version is `"1.0.0"`.
	Version pulumi.StringPtrInput
}

func (HookState) ElementType 

func (HookState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.