transform

package
v3.0.0 Latest Latest
Warning

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

 Go to latest Published: Oct 26, 2020 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Alphabet 

type Alphabet struct {
	pulumi.CustomResourceState

	// A string of characters that contains the alphabet set.
	Alphabet pulumi.StringPtrOutput `pulumi:"alphabet"`
	// The name of the alphabet.
	Name pulumi.StringOutput `pulumi:"name"`
	// Path to where the back-end is mounted within Vault.
	Path pulumi.StringOutput `pulumi:"path"`
}

This resource supports the "/transform/alphabet/{name}" Vault endpoint.

It queries an existing alphabet by the given name.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-vault/sdk/v3/go/vault"
"github.com/pulumi/pulumi-vault/sdk/v3/go/vault/transform"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		mountTransform, err := vault.NewMount(ctx, "mountTransform", &vault.MountArgs{
			Path: pulumi.String("transform"),
			Type: pulumi.String("transform"),
		})
		if err != nil {
			return err
		}
		_, err = transform.NewAlphabet(ctx, "test", &transform.AlphabetArgs{
			Path:     mountTransform.Path,
			Alphabet: pulumi.String("0123456789"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetAlphabet 

func GetAlphabet(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AlphabetState, opts ...pulumi.ResourceOption) (*Alphabet, error)

GetAlphabet gets an existing Alphabet 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 NewAlphabet 

func NewAlphabet(ctx *pulumi.Context,
	name string, args *AlphabetArgs, opts ...pulumi.ResourceOption) (*Alphabet, error)

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

type AlphabetArgs 

type AlphabetArgs struct {
	// A string of characters that contains the alphabet set.
	Alphabet pulumi.StringPtrInput
	// The name of the alphabet.
	Name pulumi.StringPtrInput
	// Path to where the back-end is mounted within Vault.
	Path pulumi.StringInput
}

The set of arguments for constructing a Alphabet resource.

func (AlphabetArgs) ElementType 

func (AlphabetArgs) ElementType() reflect.Type

type AlphabetState 

type AlphabetState struct {
	// A string of characters that contains the alphabet set.
	Alphabet pulumi.StringPtrInput
	// The name of the alphabet.
	Name pulumi.StringPtrInput
	// Path to where the back-end is mounted within Vault.
	Path pulumi.StringPtrInput
}

func (AlphabetState) ElementType 

func (AlphabetState) ElementType() reflect.Type

type GetDecodeArgs 

type GetDecodeArgs struct {
	// Specifies a list of items to be decoded in a single batch. If this parameter is set, the top-level parameters 'value', 'transformation' and 'tweak' will be ignored. Each batch item within the list can specify these parameters instead.
	BatchInputs []map[string]interface{} `pulumi:"batchInputs"`
	// The result of decoding a batch.
	BatchResults []map[string]interface{} `pulumi:"batchResults"`
	// The result of decoding a value.
	DecodedValue *string `pulumi:"decodedValue"`
	// Path to where the back-end is mounted within Vault.
	Path string `pulumi:"path"`
	// The name of the role.
	RoleName string `pulumi:"roleName"`
	// The transformation to perform. If no value is provided and the role contains a single transformation, this value will be inferred from the role.
	Transformation *string `pulumi:"transformation"`
	// The tweak value to use. Only applicable for FPE transformations
	Tweak *string `pulumi:"tweak"`
	// The value in which to decode.
	Value *string `pulumi:"value"`
}

A collection of arguments for invoking getDecode.

type GetDecodeResult 

type GetDecodeResult struct {
	BatchInputs  []map[string]interface{} `pulumi:"batchInputs"`
	BatchResults []map[string]interface{} `pulumi:"batchResults"`
	DecodedValue string                   `pulumi:"decodedValue"`
	// The provider-assigned unique ID for this managed resource.
	Id             string  `pulumi:"id"`
	Path           string  `pulumi:"path"`
	RoleName       string  `pulumi:"roleName"`
	Transformation *string `pulumi:"transformation"`
	Tweak          *string `pulumi:"tweak"`
	Value          *string `pulumi:"value"`
}

A collection of values returned by getDecode.

func GetDecode 

func GetDecode(ctx *pulumi.Context, args *GetDecodeArgs, opts ...pulumi.InvokeOption) (*GetDecodeResult, error)

This data source supports the "/transform/decode/{role_name}" Vault endpoint.

It decodes the provided value using a named role.

type GetEncodeArgs 

type GetEncodeArgs struct {
	// Specifies a list of items to be encoded in a single batch. If this parameter is set, the parameters 'value', 'transformation' and 'tweak' will be ignored. Each batch item within the list can specify these parameters instead.
	BatchInputs []map[string]interface{} `pulumi:"batchInputs"`
	// The result of encoding a batch.
	BatchResults []map[string]interface{} `pulumi:"batchResults"`
	// The result of encoding a value.
	EncodedValue *string `pulumi:"encodedValue"`
	// Path to where the back-end is mounted within Vault.
	Path string `pulumi:"path"`
	// The name of the role.
	RoleName string `pulumi:"roleName"`
	// The transformation to perform. If no value is provided and the role contains a single transformation, this value will be inferred from the role.
	Transformation *string `pulumi:"transformation"`
	// The tweak value to use. Only applicable for FPE transformations
	Tweak *string `pulumi:"tweak"`
	// The value in which to encode.
	Value *string `pulumi:"value"`
}

A collection of arguments for invoking getEncode.

type GetEncodeResult 

type GetEncodeResult struct {
	BatchInputs  []map[string]interface{} `pulumi:"batchInputs"`
	BatchResults []map[string]interface{} `pulumi:"batchResults"`
	EncodedValue string                   `pulumi:"encodedValue"`
	// The provider-assigned unique ID for this managed resource.
	Id             string  `pulumi:"id"`
	Path           string  `pulumi:"path"`
	RoleName       string  `pulumi:"roleName"`
	Transformation *string `pulumi:"transformation"`
	Tweak          *string `pulumi:"tweak"`
	Value          *string `pulumi:"value"`
}

A collection of values returned by getEncode.

func GetEncode 

func GetEncode(ctx *pulumi.Context, args *GetEncodeArgs, opts ...pulumi.InvokeOption) (*GetEncodeResult, error)

This data source supports the "/transform/encode/{role_name}" Vault endpoint.

It encodes the provided value using a named role.

type Role 

type Role struct {
	pulumi.CustomResourceState

	// The name of the role.
	Name pulumi.StringOutput `pulumi:"name"`
	// Path to where the back-end is mounted within Vault.
	Path pulumi.StringOutput `pulumi:"path"`
	// A comma separated string or slice of transformations to use.
	Transformations pulumi.StringArrayOutput `pulumi:"transformations"`
}

This resource supports the "/transform/role/{name}" Vault endpoint.

It creates or updates the role with the given name. If a role with the name does not exist, it will be created. If the role exists, it will be updated with the new attributes.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-vault/sdk/v3/go/vault"
"github.com/pulumi/pulumi-vault/sdk/v3/go/vault/transform"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		mountTransform, err := vault.NewMount(ctx, "mountTransform", &vault.MountArgs{
			Path: pulumi.String("transform"),
			Type: pulumi.String("transform"),
		})
		if err != nil {
			return err
		}
		_, err = transform.NewRole(ctx, "test", &transform.RoleArgs{
			Path: mountTransform.Path,
			Transformations: pulumi.StringArray{
				pulumi.String("ccn-fpe"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetRole 

func GetRole(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *RoleState, opts ...pulumi.ResourceOption) (*Role, error)

GetRole gets an existing Role 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 NewRole 

func NewRole(ctx *pulumi.Context,
	name string, args *RoleArgs, opts ...pulumi.ResourceOption) (*Role, error)

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

type RoleArgs 

type RoleArgs struct {
	// The name of the role.
	Name pulumi.StringPtrInput
	// Path to where the back-end is mounted within Vault.
	Path pulumi.StringInput
	// A comma separated string or slice of transformations to use.
	Transformations pulumi.StringArrayInput
}

The set of arguments for constructing a Role resource.

func (RoleArgs) ElementType 

func (RoleArgs) ElementType() reflect.Type

type RoleState 

type RoleState struct {
	// The name of the role.
	Name pulumi.StringPtrInput
	// Path to where the back-end is mounted within Vault.
	Path pulumi.StringPtrInput
	// A comma separated string or slice of transformations to use.
	Transformations pulumi.StringArrayInput
}

func (RoleState) ElementType 

func (RoleState) ElementType() reflect.Type

type Template 

type Template struct {
	pulumi.CustomResourceState

	// The alphabet to use for this template. This is only used during FPE transformations.
	Alphabet pulumi.StringPtrOutput `pulumi:"alphabet"`
	// The name of the template.
	Name pulumi.StringOutput `pulumi:"name"`
	// Path to where the back-end is mounted within Vault.
	Path pulumi.StringOutput `pulumi:"path"`
	// The pattern used for matching. Currently, only regular expression pattern is supported.
	Pattern pulumi.StringPtrOutput `pulumi:"pattern"`
	// The pattern type to use for match detection. Currently, only regex is supported.
	Type pulumi.StringPtrOutput `pulumi:"type"`
}

func GetTemplate 

func GetTemplate(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *TemplateState, opts ...pulumi.ResourceOption) (*Template, error)

GetTemplate gets an existing Template 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 NewTemplate 

func NewTemplate(ctx *pulumi.Context,
	name string, args *TemplateArgs, opts ...pulumi.ResourceOption) (*Template, error)

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

type TemplateArgs 

type TemplateArgs struct {
	// The alphabet to use for this template. This is only used during FPE transformations.
	Alphabet pulumi.StringPtrInput
	// The name of the template.
	Name pulumi.StringPtrInput
	// Path to where the back-end is mounted within Vault.
	Path pulumi.StringInput
	// The pattern used for matching. Currently, only regular expression pattern is supported.
	Pattern pulumi.StringPtrInput
	// The pattern type to use for match detection. Currently, only regex is supported.
	Type pulumi.StringPtrInput
}

The set of arguments for constructing a Template resource.

func (TemplateArgs) ElementType 

func (TemplateArgs) ElementType() reflect.Type

type TemplateState 

type TemplateState struct {
	// The alphabet to use for this template. This is only used during FPE transformations.
	Alphabet pulumi.StringPtrInput
	// The name of the template.
	Name pulumi.StringPtrInput
	// Path to where the back-end is mounted within Vault.
	Path pulumi.StringPtrInput
	// The pattern used for matching. Currently, only regular expression pattern is supported.
	Pattern pulumi.StringPtrInput
	// The pattern type to use for match detection. Currently, only regex is supported.
	Type pulumi.StringPtrInput
}

func (TemplateState) ElementType 

func (TemplateState) ElementType() reflect.Type

type Transformation 

type Transformation struct {
	pulumi.CustomResourceState

	// The set of roles allowed to perform this transformation.
	AllowedRoles pulumi.StringArrayOutput `pulumi:"allowedRoles"`
	// The character used to replace data when in masking mode
	MaskingCharacter pulumi.StringPtrOutput `pulumi:"maskingCharacter"`
	// The name of the transformation.
	Name pulumi.StringOutput `pulumi:"name"`
	// Path to where the back-end is mounted within Vault.
	Path pulumi.StringOutput `pulumi:"path"`
	// The name of the template to use.
	Template pulumi.StringPtrOutput `pulumi:"template"`
	// Templates configured for transformation.
	Templates pulumi.StringArrayOutput `pulumi:"templates"`
	// The source of where the tweak value comes from. Only valid when in FPE mode.
	TweakSource pulumi.StringPtrOutput `pulumi:"tweakSource"`
	// The type of transformation to perform.
	Type pulumi.StringPtrOutput `pulumi:"type"`
}

This resource supports the "/transform/transformation/{name}" Vault endpoint.

It creates or updates a transformation with the given name. If a transformation with the name does not exist, it will be created. If the transformation exists, it will be updated with the new attributes.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-vault/sdk/v3/go/vault"
"github.com/pulumi/pulumi-vault/sdk/v3/go/vault/transform"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		mountTransform, err := vault.NewMount(ctx, "mountTransform", &vault.MountArgs{
			Path: pulumi.String("transform"),
			Type: pulumi.String("transform"),
		})
		if err != nil {
			return err
		}
		_, err = transform.NewTransformation(ctx, "test", &transform.TransformationArgs{
			Path:        mountTransform.Path,
			Type:        pulumi.String("fpe"),
			Template:    pulumi.String("ccn"),
			TweakSource: pulumi.String("internal"),
			AllowedRoles: pulumi.StringArray{
				pulumi.String("payments"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetTransformation 

func GetTransformation(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *TransformationState, opts ...pulumi.ResourceOption) (*Transformation, error)

GetTransformation gets an existing Transformation 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 NewTransformation 

func NewTransformation(ctx *pulumi.Context,
	name string, args *TransformationArgs, opts ...pulumi.ResourceOption) (*Transformation, error)

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

type TransformationArgs 

type TransformationArgs struct {
	// The set of roles allowed to perform this transformation.
	AllowedRoles pulumi.StringArrayInput
	// The character used to replace data when in masking mode
	MaskingCharacter pulumi.StringPtrInput
	// The name of the transformation.
	Name pulumi.StringPtrInput
	// Path to where the back-end is mounted within Vault.
	Path pulumi.StringInput
	// The name of the template to use.
	Template pulumi.StringPtrInput
	// Templates configured for transformation.
	Templates pulumi.StringArrayInput
	// The source of where the tweak value comes from. Only valid when in FPE mode.
	TweakSource pulumi.StringPtrInput
	// The type of transformation to perform.
	Type pulumi.StringPtrInput
}

The set of arguments for constructing a Transformation resource.

func (TransformationArgs) ElementType 

func (TransformationArgs) ElementType() reflect.Type

type TransformationState 

type TransformationState struct {
	// The set of roles allowed to perform this transformation.
	AllowedRoles pulumi.StringArrayInput
	// The character used to replace data when in masking mode
	MaskingCharacter pulumi.StringPtrInput
	// The name of the transformation.
	Name pulumi.StringPtrInput
	// Path to where the back-end is mounted within Vault.
	Path pulumi.StringPtrInput
	// The name of the template to use.
	Template pulumi.StringPtrInput
	// Templates configured for transformation.
	Templates pulumi.StringArrayInput
	// The source of where the tweak value comes from. Only valid when in FPE mode.
	TweakSource pulumi.StringPtrInput
	// The type of transformation to perform.
	Type pulumi.StringPtrInput
}

func (TransformationState) ElementType 

func (TransformationState) 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.