random

package
v3.2.0 Latest Latest
Warning

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

 Go to latest Published: Apr 12, 2021 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

A Pulumi package to safely use randomness in Pulumi programs.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PkgVersion added in v3.0.2 

func PkgVersion() (semver.Version, error)

PkgVersion uses reflection to determine the version of the current package.

Types

type Provider 

type Provider struct {
	pulumi.ProviderResourceState
}

The provider type for the random package. By default, resources use package-wide configuration settings, however an explicit `Provider` instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the [documentation](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.

func NewProvider 

func NewProvider(ctx *pulumi.Context,
	name string, args *ProviderArgs, opts ...pulumi.ResourceOption) (*Provider, error)

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

func (*Provider) ElementType 

func (*Provider) ElementType() reflect.Type

func (*Provider) ToProviderOutput 

func (i *Provider) ToProviderOutput() ProviderOutput

func (*Provider) ToProviderOutputWithContext 

func (i *Provider) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

func (*Provider) ToProviderPtrOutput added in v3.0.3 

func (i *Provider) ToProviderPtrOutput() ProviderPtrOutput

func (*Provider) ToProviderPtrOutputWithContext added in v3.0.3 

func (i *Provider) ToProviderPtrOutputWithContext(ctx context.Context) ProviderPtrOutput

type ProviderArgs 

type ProviderArgs struct {
}

The set of arguments for constructing a Provider resource.

func (ProviderArgs) ElementType 

func (ProviderArgs) ElementType() reflect.Type

type ProviderInput 

type ProviderInput interface {
	pulumi.Input

	ToProviderOutput() ProviderOutput
	ToProviderOutputWithContext(ctx context.Context) ProviderOutput
}

type ProviderOutput 

type ProviderOutput struct {
	*pulumi.OutputState
}

func (ProviderOutput) ElementType 

func (ProviderOutput) ElementType() reflect.Type

func (ProviderOutput) ToProviderOutput 

func (o ProviderOutput) ToProviderOutput() ProviderOutput

func (ProviderOutput) ToProviderOutputWithContext 

func (o ProviderOutput) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

func (ProviderOutput) ToProviderPtrOutput added in v3.0.3 

func (o ProviderOutput) ToProviderPtrOutput() ProviderPtrOutput

func (ProviderOutput) ToProviderPtrOutputWithContext added in v3.0.3 

func (o ProviderOutput) ToProviderPtrOutputWithContext(ctx context.Context) ProviderPtrOutput

type ProviderPtrInput added in v3.0.3 

type ProviderPtrInput interface {
	pulumi.Input

	ToProviderPtrOutput() ProviderPtrOutput
	ToProviderPtrOutputWithContext(ctx context.Context) ProviderPtrOutput
}

type ProviderPtrOutput added in v3.0.3 

type ProviderPtrOutput struct {
	*pulumi.OutputState
}

func (ProviderPtrOutput) ElementType added in v3.0.3 

func (ProviderPtrOutput) ElementType() reflect.Type

func (ProviderPtrOutput) ToProviderPtrOutput added in v3.0.3 

func (o ProviderPtrOutput) ToProviderPtrOutput() ProviderPtrOutput

func (ProviderPtrOutput) ToProviderPtrOutputWithContext added in v3.0.3 

func (o ProviderPtrOutput) ToProviderPtrOutputWithContext(ctx context.Context) ProviderPtrOutput

type RandomId 

type RandomId struct {
	pulumi.CustomResourceState

	// The generated id presented in base64 without additional transformations.
	B64Std pulumi.StringOutput `pulumi:"b64Std"`
	// The generated id presented in base64, using the URL-friendly character set: case-sensitive letters, digits and the characters `_` and `-`.
	B64Url pulumi.StringOutput `pulumi:"b64Url"`
	// The number of random bytes to produce. The
	// minimum value is 1, which produces eight bits of randomness.
	ByteLength pulumi.IntOutput `pulumi:"byteLength"`
	// The generated id presented in non-padded decimal digits.
	Dec pulumi.StringOutput `pulumi:"dec"`
	// The generated id presented in padded hexadecimal digits. This result will always be twice as long as the requested byte length.
	Hex pulumi.StringOutput `pulumi:"hex"`
	// Arbitrary map of values that, when changed, will
	// trigger a new id to be generated. See
	// the main provider documentation for more information.
	Keepers pulumi.MapOutput `pulumi:"keepers"`
	// Arbitrary string to prefix the output value with. This
	// string is supplied as-is, meaning it is not guaranteed to be URL-safe or
	// base64 encoded.
	Prefix pulumi.StringPtrOutput `pulumi:"prefix"`
}

The resource `RandomId` generates random numbers that are intended to be used as unique identifiers for other resources.

This resource *does* use a cryptographic random number generator in order to minimize the chance of collisions, making the results of this resource when a 16-byte identifier is requested of equivalent uniqueness to a type-4 UUID.

This resource can be used in conjunction with resources that have the `createBeforeDestroy` lifecycle flag set to avoid conflicts with unique names during the brief period where both the old and new resources exist concurrently.

## Import

Random Ids can be imported using the `b64_url` with an optional `prefix`. This can be used to replace a config value with a value interpolated from the random provider without experiencing diffs. Example with no prefix

```sh 

$ pulumi import random:index/randomId:RandomId server p-9hUg

``` 

Example with prefix (prefix is separated by a `,`)

```sh 

$ pulumi import random:index/randomId:RandomId server my-prefix-,p-9hUg

```

func GetRandomId 

func GetRandomId(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *RandomIdState, opts ...pulumi.ResourceOption) (*RandomId, error)

GetRandomId gets an existing RandomId 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 NewRandomId 

func NewRandomId(ctx *pulumi.Context,
	name string, args *RandomIdArgs, opts ...pulumi.ResourceOption) (*RandomId, error)

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

func (*RandomId) ElementType 

func (*RandomId) ElementType() reflect.Type

func (*RandomId) ToRandomIdOutput 

func (i *RandomId) ToRandomIdOutput() RandomIdOutput

func (*RandomId) ToRandomIdOutputWithContext 

func (i *RandomId) ToRandomIdOutputWithContext(ctx context.Context) RandomIdOutput

func (*RandomId) ToRandomIdPtrOutput added in v3.0.3 

func (i *RandomId) ToRandomIdPtrOutput() RandomIdPtrOutput

func (*RandomId) ToRandomIdPtrOutputWithContext added in v3.0.3 

func (i *RandomId) ToRandomIdPtrOutputWithContext(ctx context.Context) RandomIdPtrOutput

type RandomIdArgs 

type RandomIdArgs struct {
	// The number of random bytes to produce. The
	// minimum value is 1, which produces eight bits of randomness.
	ByteLength pulumi.IntInput
	// Arbitrary map of values that, when changed, will
	// trigger a new id to be generated. See
	// the main provider documentation for more information.
	Keepers pulumi.MapInput
	// Arbitrary string to prefix the output value with. This
	// string is supplied as-is, meaning it is not guaranteed to be URL-safe or
	// base64 encoded.
	Prefix pulumi.StringPtrInput
}

The set of arguments for constructing a RandomId resource.

func (RandomIdArgs) ElementType 

func (RandomIdArgs) ElementType() reflect.Type

type RandomIdArray added in v3.0.3 

type RandomIdArray []RandomIdInput

func (RandomIdArray) ElementType added in v3.0.3 

func (RandomIdArray) ElementType() reflect.Type

func (RandomIdArray) ToRandomIdArrayOutput added in v3.0.3 

func (i RandomIdArray) ToRandomIdArrayOutput() RandomIdArrayOutput

func (RandomIdArray) ToRandomIdArrayOutputWithContext added in v3.0.3 

func (i RandomIdArray) ToRandomIdArrayOutputWithContext(ctx context.Context) RandomIdArrayOutput

type RandomIdArrayInput added in v3.0.3 

type RandomIdArrayInput interface {
	pulumi.Input

	ToRandomIdArrayOutput() RandomIdArrayOutput
	ToRandomIdArrayOutputWithContext(context.Context) RandomIdArrayOutput
}

RandomIdArrayInput is an input type that accepts RandomIdArray and RandomIdArrayOutput values. You can construct a concrete instance of `RandomIdArrayInput` via: 

RandomIdArray{ RandomIdArgs{...} }

type RandomIdArrayOutput added in v3.0.3 

type RandomIdArrayOutput struct{ *pulumi.OutputState }

func (RandomIdArrayOutput) ElementType added in v3.0.3 

func (RandomIdArrayOutput) ElementType() reflect.Type

func (RandomIdArrayOutput) Index added in v3.0.3 

func (o RandomIdArrayOutput) Index(i pulumi.IntInput) RandomIdOutput

func (RandomIdArrayOutput) ToRandomIdArrayOutput added in v3.0.3 

func (o RandomIdArrayOutput) ToRandomIdArrayOutput() RandomIdArrayOutput

func (RandomIdArrayOutput) ToRandomIdArrayOutputWithContext added in v3.0.3 

func (o RandomIdArrayOutput) ToRandomIdArrayOutputWithContext(ctx context.Context) RandomIdArrayOutput

type RandomIdInput 

type RandomIdInput interface {
	pulumi.Input

	ToRandomIdOutput() RandomIdOutput
	ToRandomIdOutputWithContext(ctx context.Context) RandomIdOutput
}

type RandomIdMap added in v3.0.3 

type RandomIdMap map[string]RandomIdInput

func (RandomIdMap) ElementType added in v3.0.3 

func (RandomIdMap) ElementType() reflect.Type

func (RandomIdMap) ToRandomIdMapOutput added in v3.0.3 

func (i RandomIdMap) ToRandomIdMapOutput() RandomIdMapOutput

func (RandomIdMap) ToRandomIdMapOutputWithContext added in v3.0.3 

func (i RandomIdMap) ToRandomIdMapOutputWithContext(ctx context.Context) RandomIdMapOutput

type RandomIdMapInput added in v3.0.3 

type RandomIdMapInput interface {
	pulumi.Input

	ToRandomIdMapOutput() RandomIdMapOutput
	ToRandomIdMapOutputWithContext(context.Context) RandomIdMapOutput
}

RandomIdMapInput is an input type that accepts RandomIdMap and RandomIdMapOutput values. You can construct a concrete instance of `RandomIdMapInput` via: 

RandomIdMap{ "key": RandomIdArgs{...} }

type RandomIdMapOutput added in v3.0.3 

type RandomIdMapOutput struct{ *pulumi.OutputState }

func (RandomIdMapOutput) ElementType added in v3.0.3 

func (RandomIdMapOutput) ElementType() reflect.Type

func (RandomIdMapOutput) MapIndex added in v3.0.3 

func (o RandomIdMapOutput) MapIndex(k pulumi.StringInput) RandomIdOutput

func (RandomIdMapOutput) ToRandomIdMapOutput added in v3.0.3 

func (o RandomIdMapOutput) ToRandomIdMapOutput() RandomIdMapOutput

func (RandomIdMapOutput) ToRandomIdMapOutputWithContext added in v3.0.3 

func (o RandomIdMapOutput) ToRandomIdMapOutputWithContext(ctx context.Context) RandomIdMapOutput

type RandomIdOutput 

type RandomIdOutput struct {
	*pulumi.OutputState
}

func (RandomIdOutput) ElementType 

func (RandomIdOutput) ElementType() reflect.Type

func (RandomIdOutput) ToRandomIdOutput 

func (o RandomIdOutput) ToRandomIdOutput() RandomIdOutput

func (RandomIdOutput) ToRandomIdOutputWithContext 

func (o RandomIdOutput) ToRandomIdOutputWithContext(ctx context.Context) RandomIdOutput

func (RandomIdOutput) ToRandomIdPtrOutput added in v3.0.3 

func (o RandomIdOutput) ToRandomIdPtrOutput() RandomIdPtrOutput

func (RandomIdOutput) ToRandomIdPtrOutputWithContext added in v3.0.3 

func (o RandomIdOutput) ToRandomIdPtrOutputWithContext(ctx context.Context) RandomIdPtrOutput

type RandomIdPtrInput added in v3.0.3 

type RandomIdPtrInput interface {
	pulumi.Input

	ToRandomIdPtrOutput() RandomIdPtrOutput
	ToRandomIdPtrOutputWithContext(ctx context.Context) RandomIdPtrOutput
}

type RandomIdPtrOutput added in v3.0.3 

type RandomIdPtrOutput struct {
	*pulumi.OutputState
}

func (RandomIdPtrOutput) ElementType added in v3.0.3 

func (RandomIdPtrOutput) ElementType() reflect.Type

func (RandomIdPtrOutput) ToRandomIdPtrOutput added in v3.0.3 

func (o RandomIdPtrOutput) ToRandomIdPtrOutput() RandomIdPtrOutput

func (RandomIdPtrOutput) ToRandomIdPtrOutputWithContext added in v3.0.3 

func (o RandomIdPtrOutput) ToRandomIdPtrOutputWithContext(ctx context.Context) RandomIdPtrOutput

type RandomIdState 

type RandomIdState struct {
	// The generated id presented in base64 without additional transformations.
	B64Std pulumi.StringPtrInput
	// The generated id presented in base64, using the URL-friendly character set: case-sensitive letters, digits and the characters `_` and `-`.
	B64Url pulumi.StringPtrInput
	// The number of random bytes to produce. The
	// minimum value is 1, which produces eight bits of randomness.
	ByteLength pulumi.IntPtrInput
	// The generated id presented in non-padded decimal digits.
	Dec pulumi.StringPtrInput
	// The generated id presented in padded hexadecimal digits. This result will always be twice as long as the requested byte length.
	Hex pulumi.StringPtrInput
	// Arbitrary map of values that, when changed, will
	// trigger a new id to be generated. See
	// the main provider documentation for more information.
	Keepers pulumi.MapInput
	// Arbitrary string to prefix the output value with. This
	// string is supplied as-is, meaning it is not guaranteed to be URL-safe or
	// base64 encoded.
	Prefix pulumi.StringPtrInput
}

func (RandomIdState) ElementType 

func (RandomIdState) ElementType() reflect.Type

type RandomInteger 

type RandomInteger struct {
	pulumi.CustomResourceState

	// Arbitrary map of values that, when changed, will
	// trigger a new id to be generated. See
	// the main provider documentation for more information.
	Keepers pulumi.MapOutput `pulumi:"keepers"`
	// The maximum inclusive value of the range.
	Max pulumi.IntOutput `pulumi:"max"`
	// The minimum inclusive value of the range.
	Min pulumi.IntOutput `pulumi:"min"`
	// (int) The random Integer result.
	Result pulumi.IntOutput `pulumi:"result"`
	// A custom seed to always produce the same value.
	Seed pulumi.StringPtrOutput `pulumi:"seed"`
}

The resource `RandomInteger` generates random values from a given range, described by the `min` and `max` attributes of a given resource.

This resource can be used in conjunction with resources that have the `createBeforeDestroy` lifecycle flag set, to avoid conflicts with unique names during the brief period where both the old and new resources exist concurrently.

## Example Usage

The following example shows how to generate a random priority between 1 and 50000 for a `awsAlbListenerRule` resource:

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/alb"
"github.com/pulumi/pulumi-random/sdk/v3/go/random"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		priority, err := random.NewRandomInteger(ctx, "priority", &random.RandomIntegerArgs{
			Keepers: pulumi.AnyMap{
				"listener_arn": pulumi.Any(_var.Listener_arn),
			},
			Max: pulumi.Int(50000),
			Min: pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		_, err = alb.NewListenerRule(ctx, "main", &alb.ListenerRuleArgs{
			Actions: alb.ListenerRuleActionArray{
				&alb.ListenerRuleActionArgs{
					TargetGroupArn: pulumi.Any(_var.Target_group_arn),
					Type:           pulumi.String("forward"),
				},
			},
			ListenerArn: pulumi.Any(_var.Listener_arn),
			Priority:    priority.Result,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

The result of the above will set a random priority.

## Import

Random integers can be imported using the `result`, `min`, and `max`, with an optional `seed`. This can be used to replace a config value with a value interpolated from the random provider without experiencing diffs. Example (values are separated by a `,`)

```sh 

$ pulumi import random:index/randomInteger:RandomInteger priority 15390,1,50000

```

func GetRandomInteger 

func GetRandomInteger(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *RandomIntegerState, opts ...pulumi.ResourceOption) (*RandomInteger, error)

GetRandomInteger gets an existing RandomInteger 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 NewRandomInteger 

func NewRandomInteger(ctx *pulumi.Context,
	name string, args *RandomIntegerArgs, opts ...pulumi.ResourceOption) (*RandomInteger, error)

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

func (*RandomInteger) ElementType 

func (*RandomInteger) ElementType() reflect.Type

func (*RandomInteger) ToRandomIntegerOutput 

func (i *RandomInteger) ToRandomIntegerOutput() RandomIntegerOutput

func (*RandomInteger) ToRandomIntegerOutputWithContext 

func (i *RandomInteger) ToRandomIntegerOutputWithContext(ctx context.Context) RandomIntegerOutput

func (*RandomInteger) ToRandomIntegerPtrOutput added in v3.0.3 

func (i *RandomInteger) ToRandomIntegerPtrOutput() RandomIntegerPtrOutput

func (*RandomInteger) ToRandomIntegerPtrOutputWithContext added in v3.0.3 

func (i *RandomInteger) ToRandomIntegerPtrOutputWithContext(ctx context.Context) RandomIntegerPtrOutput

type RandomIntegerArgs 

type RandomIntegerArgs struct {
	// Arbitrary map of values that, when changed, will
	// trigger a new id to be generated. See
	// the main provider documentation for more information.
	Keepers pulumi.MapInput
	// The maximum inclusive value of the range.
	Max pulumi.IntInput
	// The minimum inclusive value of the range.
	Min pulumi.IntInput
	// A custom seed to always produce the same value.
	Seed pulumi.StringPtrInput
}

The set of arguments for constructing a RandomInteger resource.

func (RandomIntegerArgs) ElementType 

func (RandomIntegerArgs) ElementType() reflect.Type

type RandomIntegerArray added in v3.0.3 

type RandomIntegerArray []RandomIntegerInput

func (RandomIntegerArray) ElementType added in v3.0.3 

func (RandomIntegerArray) ElementType() reflect.Type

func (RandomIntegerArray) ToRandomIntegerArrayOutput added in v3.0.3 

func (i RandomIntegerArray) ToRandomIntegerArrayOutput() RandomIntegerArrayOutput

func (RandomIntegerArray) ToRandomIntegerArrayOutputWithContext added in v3.0.3 

func (i RandomIntegerArray) ToRandomIntegerArrayOutputWithContext(ctx context.Context) RandomIntegerArrayOutput

type RandomIntegerArrayInput added in v3.0.3 

type RandomIntegerArrayInput interface {
	pulumi.Input

	ToRandomIntegerArrayOutput() RandomIntegerArrayOutput
	ToRandomIntegerArrayOutputWithContext(context.Context) RandomIntegerArrayOutput
}

RandomIntegerArrayInput is an input type that accepts RandomIntegerArray and RandomIntegerArrayOutput values. You can construct a concrete instance of `RandomIntegerArrayInput` via: 

RandomIntegerArray{ RandomIntegerArgs{...} }

type RandomIntegerArrayOutput added in v3.0.3 

type RandomIntegerArrayOutput struct{ *pulumi.OutputState }

func (RandomIntegerArrayOutput) ElementType added in v3.0.3 

func (RandomIntegerArrayOutput) ElementType() reflect.Type

func (RandomIntegerArrayOutput) Index added in v3.0.3 

func (o RandomIntegerArrayOutput) Index(i pulumi.IntInput) RandomIntegerOutput

func (RandomIntegerArrayOutput) ToRandomIntegerArrayOutput added in v3.0.3 

func (o RandomIntegerArrayOutput) ToRandomIntegerArrayOutput() RandomIntegerArrayOutput

func (RandomIntegerArrayOutput) ToRandomIntegerArrayOutputWithContext added in v3.0.3 

func (o RandomIntegerArrayOutput) ToRandomIntegerArrayOutputWithContext(ctx context.Context) RandomIntegerArrayOutput

type RandomIntegerInput 

type RandomIntegerInput interface {
	pulumi.Input

	ToRandomIntegerOutput() RandomIntegerOutput
	ToRandomIntegerOutputWithContext(ctx context.Context) RandomIntegerOutput
}

type RandomIntegerMap added in v3.0.3 

type RandomIntegerMap map[string]RandomIntegerInput

func (RandomIntegerMap) ElementType added in v3.0.3 

func (RandomIntegerMap) ElementType() reflect.Type

func (RandomIntegerMap) ToRandomIntegerMapOutput added in v3.0.3 

func (i RandomIntegerMap) ToRandomIntegerMapOutput() RandomIntegerMapOutput

func (RandomIntegerMap) ToRandomIntegerMapOutputWithContext added in v3.0.3 

func (i RandomIntegerMap) ToRandomIntegerMapOutputWithContext(ctx context.Context) RandomIntegerMapOutput

type RandomIntegerMapInput added in v3.0.3 

type RandomIntegerMapInput interface {
	pulumi.Input

	ToRandomIntegerMapOutput() RandomIntegerMapOutput
	ToRandomIntegerMapOutputWithContext(context.Context) RandomIntegerMapOutput
}

RandomIntegerMapInput is an input type that accepts RandomIntegerMap and RandomIntegerMapOutput values. You can construct a concrete instance of `RandomIntegerMapInput` via: 

RandomIntegerMap{ "key": RandomIntegerArgs{...} }

type RandomIntegerMapOutput added in v3.0.3 

type RandomIntegerMapOutput struct{ *pulumi.OutputState }

func (RandomIntegerMapOutput) ElementType added in v3.0.3 

func (RandomIntegerMapOutput) ElementType() reflect.Type

func (RandomIntegerMapOutput) MapIndex added in v3.0.3 

func (o RandomIntegerMapOutput) MapIndex(k pulumi.StringInput) RandomIntegerOutput

func (RandomIntegerMapOutput) ToRandomIntegerMapOutput added in v3.0.3 

func (o RandomIntegerMapOutput) ToRandomIntegerMapOutput() RandomIntegerMapOutput

func (RandomIntegerMapOutput) ToRandomIntegerMapOutputWithContext added in v3.0.3 

func (o RandomIntegerMapOutput) ToRandomIntegerMapOutputWithContext(ctx context.Context) RandomIntegerMapOutput

type RandomIntegerOutput 

type RandomIntegerOutput struct {
	*pulumi.OutputState
}

func (RandomIntegerOutput) ElementType 

func (RandomIntegerOutput) ElementType() reflect.Type

func (RandomIntegerOutput) ToRandomIntegerOutput 

func (o RandomIntegerOutput) ToRandomIntegerOutput() RandomIntegerOutput

func (RandomIntegerOutput) ToRandomIntegerOutputWithContext 

func (o RandomIntegerOutput) ToRandomIntegerOutputWithContext(ctx context.Context) RandomIntegerOutput

func (RandomIntegerOutput) ToRandomIntegerPtrOutput added in v3.0.3 

func (o RandomIntegerOutput) ToRandomIntegerPtrOutput() RandomIntegerPtrOutput

func (RandomIntegerOutput) ToRandomIntegerPtrOutputWithContext added in v3.0.3 

func (o RandomIntegerOutput) ToRandomIntegerPtrOutputWithContext(ctx context.Context) RandomIntegerPtrOutput

type RandomIntegerPtrInput added in v3.0.3 

type RandomIntegerPtrInput interface {
	pulumi.Input

	ToRandomIntegerPtrOutput() RandomIntegerPtrOutput
	ToRandomIntegerPtrOutputWithContext(ctx context.Context) RandomIntegerPtrOutput
}

type RandomIntegerPtrOutput added in v3.0.3 

type RandomIntegerPtrOutput struct {
	*pulumi.OutputState
}

func (RandomIntegerPtrOutput) ElementType added in v3.0.3 

func (RandomIntegerPtrOutput) ElementType() reflect.Type

func (RandomIntegerPtrOutput) ToRandomIntegerPtrOutput added in v3.0.3 

func (o RandomIntegerPtrOutput) ToRandomIntegerPtrOutput() RandomIntegerPtrOutput

func (RandomIntegerPtrOutput) ToRandomIntegerPtrOutputWithContext added in v3.0.3 

func (o RandomIntegerPtrOutput) ToRandomIntegerPtrOutputWithContext(ctx context.Context) RandomIntegerPtrOutput

type RandomIntegerState 

type RandomIntegerState struct {
	// Arbitrary map of values that, when changed, will
	// trigger a new id to be generated. See
	// the main provider documentation for more information.
	Keepers pulumi.MapInput
	// The maximum inclusive value of the range.
	Max pulumi.IntPtrInput
	// The minimum inclusive value of the range.
	Min pulumi.IntPtrInput
	// (int) The random Integer result.
	Result pulumi.IntPtrInput
	// A custom seed to always produce the same value.
	Seed pulumi.StringPtrInput
}

func (RandomIntegerState) ElementType 

func (RandomIntegerState) ElementType() reflect.Type

type RandomPassword 

type RandomPassword struct {
	pulumi.CustomResourceState

	// Arbitrary map of values that, when changed, will trigger recreation of resource. See [the main provider
	// documentation](../index.html) for more information.
	Keepers pulumi.MapOutput `pulumi:"keepers"`
	// The length of the string desired.
	Length pulumi.IntOutput `pulumi:"length"`
	// Include lowercase alphabet characters in the result.
	Lower pulumi.BoolPtrOutput `pulumi:"lower"`
	// Minimum number of lowercase alphabet characters in the result.
	MinLower pulumi.IntPtrOutput `pulumi:"minLower"`
	// Minimum number of numeric characters in the result.
	MinNumeric pulumi.IntPtrOutput `pulumi:"minNumeric"`
	// Minimum number of special characters in the result.
	MinSpecial pulumi.IntPtrOutput `pulumi:"minSpecial"`
	// Minimum number of uppercase alphabet characters in the result.
	MinUpper pulumi.IntPtrOutput `pulumi:"minUpper"`
	// Include numeric characters in the result.
	Number pulumi.BoolPtrOutput `pulumi:"number"`
	// Supply your own list of special characters to use for string generation. This overrides the default character list in
	// the special argument. The `special` argument must still be set to true for any overwritten characters to be used in
	// generation.
	OverrideSpecial pulumi.StringPtrOutput `pulumi:"overrideSpecial"`
	// The generated random string.
	Result pulumi.StringOutput `pulumi:"result"`
	// Include special characters in the result. These are `!@#$%&*()-_=+[]{}<>:?`
	Special pulumi.BoolPtrOutput `pulumi:"special"`
	// Include uppercase alphabet characters in the result.
	Upper pulumi.BoolPtrOutput `pulumi:"upper"`
}

> **Note:** Requires random provider version >= 2.2.0

Identical to RandomString with the exception that the result is treated as sensitive and, thus, _not_ displayed in console output.

> **Note:** All attributes including the generated password will be stored in the raw state as plain-text. [Read more about sensitive data in state](https://www.terraform.io/docs/state/sensitive-data.html).

This resource *does* use a cryptographic random number generator.

## Example Usage

```go package main

import ( 

"fmt"

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/rds"
"github.com/pulumi/pulumi-random/sdk/v3/go/random"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		password, err := random.NewRandomPassword(ctx, "password", &random.RandomPasswordArgs{
			Length:          pulumi.Int(16),
			Special:         pulumi.Bool(true),
			OverrideSpecial: pulumi.String(fmt.Sprintf("%v%v%v", "_", "%", "@")),
		})
		if err != nil {
			return err
		}
		_, err = rds.NewInstance(ctx, "example", &rds.InstanceArgs{
			InstanceClass:    pulumi.String("db.t3.micro"),
			AllocatedStorage: pulumi.Int(64),
			Engine:           pulumi.String("mysql"),
			Username:         pulumi.String("someone"),
			Password:         password.Result,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Random Password can be imported by specifying the value of the string

```sh 

$ pulumi import random:index/randomPassword:RandomPassword password securepassword

```

func GetRandomPassword 

func GetRandomPassword(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *RandomPasswordState, opts ...pulumi.ResourceOption) (*RandomPassword, error)

GetRandomPassword gets an existing RandomPassword 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 NewRandomPassword 

func NewRandomPassword(ctx *pulumi.Context,
	name string, args *RandomPasswordArgs, opts ...pulumi.ResourceOption) (*RandomPassword, error)

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

func (*RandomPassword) ElementType 

func (*RandomPassword) ElementType() reflect.Type

func (*RandomPassword) ToRandomPasswordOutput 

func (i *RandomPassword) ToRandomPasswordOutput() RandomPasswordOutput

func (*RandomPassword) ToRandomPasswordOutputWithContext 

func (i *RandomPassword) ToRandomPasswordOutputWithContext(ctx context.Context) RandomPasswordOutput

func (*RandomPassword) ToRandomPasswordPtrOutput added in v3.0.3 

func (i *RandomPassword) ToRandomPasswordPtrOutput() RandomPasswordPtrOutput

func (*RandomPassword) ToRandomPasswordPtrOutputWithContext added in v3.0.3 

func (i *RandomPassword) ToRandomPasswordPtrOutputWithContext(ctx context.Context) RandomPasswordPtrOutput

type RandomPasswordArgs 

type RandomPasswordArgs struct {
	// Arbitrary map of values that, when changed, will trigger recreation of resource. See [the main provider
	// documentation](../index.html) for more information.
	Keepers pulumi.MapInput
	// The length of the string desired.
	Length pulumi.IntInput
	// Include lowercase alphabet characters in the result.
	Lower pulumi.BoolPtrInput
	// Minimum number of lowercase alphabet characters in the result.
	MinLower pulumi.IntPtrInput
	// Minimum number of numeric characters in the result.
	MinNumeric pulumi.IntPtrInput
	// Minimum number of special characters in the result.
	MinSpecial pulumi.IntPtrInput
	// Minimum number of uppercase alphabet characters in the result.
	MinUpper pulumi.IntPtrInput
	// Include numeric characters in the result.
	Number pulumi.BoolPtrInput
	// Supply your own list of special characters to use for string generation. This overrides the default character list in
	// the special argument. The `special` argument must still be set to true for any overwritten characters to be used in
	// generation.
	OverrideSpecial pulumi.StringPtrInput
	// Include special characters in the result. These are `!@#$%&*()-_=+[]{}<>:?`
	Special pulumi.BoolPtrInput
	// Include uppercase alphabet characters in the result.
	Upper pulumi.BoolPtrInput
}

The set of arguments for constructing a RandomPassword resource.

func (RandomPasswordArgs) ElementType 

func (RandomPasswordArgs) ElementType() reflect.Type

type RandomPasswordArray added in v3.0.3 

type RandomPasswordArray []RandomPasswordInput

func (RandomPasswordArray) ElementType added in v3.0.3 

func (RandomPasswordArray) ElementType() reflect.Type

func (RandomPasswordArray) ToRandomPasswordArrayOutput added in v3.0.3 

func (i RandomPasswordArray) ToRandomPasswordArrayOutput() RandomPasswordArrayOutput

func (RandomPasswordArray) ToRandomPasswordArrayOutputWithContext added in v3.0.3 

func (i RandomPasswordArray) ToRandomPasswordArrayOutputWithContext(ctx context.Context) RandomPasswordArrayOutput

type RandomPasswordArrayInput added in v3.0.3 

type RandomPasswordArrayInput interface {
	pulumi.Input

	ToRandomPasswordArrayOutput() RandomPasswordArrayOutput
	ToRandomPasswordArrayOutputWithContext(context.Context) RandomPasswordArrayOutput
}

RandomPasswordArrayInput is an input type that accepts RandomPasswordArray and RandomPasswordArrayOutput values. You can construct a concrete instance of `RandomPasswordArrayInput` via: 

RandomPasswordArray{ RandomPasswordArgs{...} }

type RandomPasswordArrayOutput added in v3.0.3 

type RandomPasswordArrayOutput struct{ *pulumi.OutputState }

func (RandomPasswordArrayOutput) ElementType added in v3.0.3 

func (RandomPasswordArrayOutput) ElementType() reflect.Type

func (RandomPasswordArrayOutput) Index added in v3.0.3 

func (o RandomPasswordArrayOutput) Index(i pulumi.IntInput) RandomPasswordOutput

func (RandomPasswordArrayOutput) ToRandomPasswordArrayOutput added in v3.0.3 

func (o RandomPasswordArrayOutput) ToRandomPasswordArrayOutput() RandomPasswordArrayOutput

func (RandomPasswordArrayOutput) ToRandomPasswordArrayOutputWithContext added in v3.0.3 

func (o RandomPasswordArrayOutput) ToRandomPasswordArrayOutputWithContext(ctx context.Context) RandomPasswordArrayOutput

type RandomPasswordInput 

type RandomPasswordInput interface {
	pulumi.Input

	ToRandomPasswordOutput() RandomPasswordOutput
	ToRandomPasswordOutputWithContext(ctx context.Context) RandomPasswordOutput
}

type RandomPasswordMap added in v3.0.3 

type RandomPasswordMap map[string]RandomPasswordInput

func (RandomPasswordMap) ElementType added in v3.0.3 

func (RandomPasswordMap) ElementType() reflect.Type

func (RandomPasswordMap) ToRandomPasswordMapOutput added in v3.0.3 

func (i RandomPasswordMap) ToRandomPasswordMapOutput() RandomPasswordMapOutput

func (RandomPasswordMap) ToRandomPasswordMapOutputWithContext added in v3.0.3 

func (i RandomPasswordMap) ToRandomPasswordMapOutputWithContext(ctx context.Context) RandomPasswordMapOutput

type RandomPasswordMapInput added in v3.0.3 

type RandomPasswordMapInput interface {
	pulumi.Input

	ToRandomPasswordMapOutput() RandomPasswordMapOutput
	ToRandomPasswordMapOutputWithContext(context.Context) RandomPasswordMapOutput
}

RandomPasswordMapInput is an input type that accepts RandomPasswordMap and RandomPasswordMapOutput values. You can construct a concrete instance of `RandomPasswordMapInput` via: 

RandomPasswordMap{ "key": RandomPasswordArgs{...} }

type RandomPasswordMapOutput added in v3.0.3 

type RandomPasswordMapOutput struct{ *pulumi.OutputState }

func (RandomPasswordMapOutput) ElementType added in v3.0.3 

func (RandomPasswordMapOutput) ElementType() reflect.Type

func (RandomPasswordMapOutput) MapIndex added in v3.0.3 

func (o RandomPasswordMapOutput) MapIndex(k pulumi.StringInput) RandomPasswordOutput

func (RandomPasswordMapOutput) ToRandomPasswordMapOutput added in v3.0.3 

func (o RandomPasswordMapOutput) ToRandomPasswordMapOutput() RandomPasswordMapOutput

func (RandomPasswordMapOutput) ToRandomPasswordMapOutputWithContext added in v3.0.3 

func (o RandomPasswordMapOutput) ToRandomPasswordMapOutputWithContext(ctx context.Context) RandomPasswordMapOutput

type RandomPasswordOutput 

type RandomPasswordOutput struct {
	*pulumi.OutputState
}

func (RandomPasswordOutput) ElementType 

func (RandomPasswordOutput) ElementType() reflect.Type

func (RandomPasswordOutput) ToRandomPasswordOutput 

func (o RandomPasswordOutput) ToRandomPasswordOutput() RandomPasswordOutput

func (RandomPasswordOutput) ToRandomPasswordOutputWithContext 

func (o RandomPasswordOutput) ToRandomPasswordOutputWithContext(ctx context.Context) RandomPasswordOutput

func (RandomPasswordOutput) ToRandomPasswordPtrOutput added in v3.0.3 

func (o RandomPasswordOutput) ToRandomPasswordPtrOutput() RandomPasswordPtrOutput

func (RandomPasswordOutput) ToRandomPasswordPtrOutputWithContext added in v3.0.3 

func (o RandomPasswordOutput) ToRandomPasswordPtrOutputWithContext(ctx context.Context) RandomPasswordPtrOutput

type RandomPasswordPtrInput added in v3.0.3 

type RandomPasswordPtrInput interface {
	pulumi.Input

	ToRandomPasswordPtrOutput() RandomPasswordPtrOutput
	ToRandomPasswordPtrOutputWithContext(ctx context.Context) RandomPasswordPtrOutput
}

type RandomPasswordPtrOutput added in v3.0.3 

type RandomPasswordPtrOutput struct {
	*pulumi.OutputState
}

func (RandomPasswordPtrOutput) ElementType added in v3.0.3 

func (RandomPasswordPtrOutput) ElementType() reflect.Type

func (RandomPasswordPtrOutput) ToRandomPasswordPtrOutput added in v3.0.3 

func (o RandomPasswordPtrOutput) ToRandomPasswordPtrOutput() RandomPasswordPtrOutput

func (RandomPasswordPtrOutput) ToRandomPasswordPtrOutputWithContext added in v3.0.3 

func (o RandomPasswordPtrOutput) ToRandomPasswordPtrOutputWithContext(ctx context.Context) RandomPasswordPtrOutput

type RandomPasswordState 

type RandomPasswordState struct {
	// Arbitrary map of values that, when changed, will trigger recreation of resource. See [the main provider
	// documentation](../index.html) for more information.
	Keepers pulumi.MapInput
	// The length of the string desired.
	Length pulumi.IntPtrInput
	// Include lowercase alphabet characters in the result.
	Lower pulumi.BoolPtrInput
	// Minimum number of lowercase alphabet characters in the result.
	MinLower pulumi.IntPtrInput
	// Minimum number of numeric characters in the result.
	MinNumeric pulumi.IntPtrInput
	// Minimum number of special characters in the result.
	MinSpecial pulumi.IntPtrInput
	// Minimum number of uppercase alphabet characters in the result.
	MinUpper pulumi.IntPtrInput
	// Include numeric characters in the result.
	Number pulumi.BoolPtrInput
	// Supply your own list of special characters to use for string generation. This overrides the default character list in
	// the special argument. The `special` argument must still be set to true for any overwritten characters to be used in
	// generation.
	OverrideSpecial pulumi.StringPtrInput
	// The generated random string.
	Result pulumi.StringPtrInput
	// Include special characters in the result. These are `!@#$%&*()-_=+[]{}<>:?`
	Special pulumi.BoolPtrInput
	// Include uppercase alphabet characters in the result.
	Upper pulumi.BoolPtrInput
}

func (RandomPasswordState) ElementType 

func (RandomPasswordState) ElementType() reflect.Type

type RandomPet 

type RandomPet struct {
	pulumi.CustomResourceState

	// Arbitrary map of values that, when changed, will
	// trigger a new id to be generated. See
	// the main provider documentation for more information.
	Keepers pulumi.MapOutput `pulumi:"keepers"`
	// The length (in words) of the pet name.
	Length pulumi.IntPtrOutput `pulumi:"length"`
	// A string to prefix the name with.
	Prefix pulumi.StringPtrOutput `pulumi:"prefix"`
	// The character to separate words in the pet name.
	Separator pulumi.StringPtrOutput `pulumi:"separator"`
}

The resource `RandomPet` generates random pet names that are intended to be used as unique identifiers for other resources.

This resource can be used in conjunction with resources that have the `createBeforeDestroy` lifecycle flag set, to avoid conflicts with unique names during the brief period where both the old and new resources exist concurrently.

func GetRandomPet 

func GetRandomPet(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *RandomPetState, opts ...pulumi.ResourceOption) (*RandomPet, error)

GetRandomPet gets an existing RandomPet 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 NewRandomPet 

func NewRandomPet(ctx *pulumi.Context,
	name string, args *RandomPetArgs, opts ...pulumi.ResourceOption) (*RandomPet, error)

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

func (*RandomPet) ElementType 

func (*RandomPet) ElementType() reflect.Type

func (*RandomPet) ToRandomPetOutput 

func (i *RandomPet) ToRandomPetOutput() RandomPetOutput

func (*RandomPet) ToRandomPetOutputWithContext 

func (i *RandomPet) ToRandomPetOutputWithContext(ctx context.Context) RandomPetOutput

func (*RandomPet) ToRandomPetPtrOutput added in v3.0.3 

func (i *RandomPet) ToRandomPetPtrOutput() RandomPetPtrOutput

func (*RandomPet) ToRandomPetPtrOutputWithContext added in v3.0.3 

func (i *RandomPet) ToRandomPetPtrOutputWithContext(ctx context.Context) RandomPetPtrOutput

type RandomPetArgs 

type RandomPetArgs struct {
	// Arbitrary map of values that, when changed, will
	// trigger a new id to be generated. See
	// the main provider documentation for more information.
	Keepers pulumi.MapInput
	// The length (in words) of the pet name.
	Length pulumi.IntPtrInput
	// A string to prefix the name with.
	Prefix pulumi.StringPtrInput
	// The character to separate words in the pet name.
	Separator pulumi.StringPtrInput
}

The set of arguments for constructing a RandomPet resource.

func (RandomPetArgs) ElementType 

func (RandomPetArgs) ElementType() reflect.Type

type RandomPetArray added in v3.0.3 

type RandomPetArray []RandomPetInput

func (RandomPetArray) ElementType added in v3.0.3 

func (RandomPetArray) ElementType() reflect.Type

func (RandomPetArray) ToRandomPetArrayOutput added in v3.0.3 

func (i RandomPetArray) ToRandomPetArrayOutput() RandomPetArrayOutput

func (RandomPetArray) ToRandomPetArrayOutputWithContext added in v3.0.3 

func (i RandomPetArray) ToRandomPetArrayOutputWithContext(ctx context.Context) RandomPetArrayOutput

type RandomPetArrayInput added in v3.0.3 

type RandomPetArrayInput interface {
	pulumi.Input

	ToRandomPetArrayOutput() RandomPetArrayOutput
	ToRandomPetArrayOutputWithContext(context.Context) RandomPetArrayOutput
}

RandomPetArrayInput is an input type that accepts RandomPetArray and RandomPetArrayOutput values. You can construct a concrete instance of `RandomPetArrayInput` via: 

RandomPetArray{ RandomPetArgs{...} }

type RandomPetArrayOutput added in v3.0.3 

type RandomPetArrayOutput struct{ *pulumi.OutputState }

func (RandomPetArrayOutput) ElementType added in v3.0.3 

func (RandomPetArrayOutput) ElementType() reflect.Type

func (RandomPetArrayOutput) Index added in v3.0.3 

func (o RandomPetArrayOutput) Index(i pulumi.IntInput) RandomPetOutput

func (RandomPetArrayOutput) ToRandomPetArrayOutput added in v3.0.3 

func (o RandomPetArrayOutput) ToRandomPetArrayOutput() RandomPetArrayOutput

func (RandomPetArrayOutput) ToRandomPetArrayOutputWithContext added in v3.0.3 

func (o RandomPetArrayOutput) ToRandomPetArrayOutputWithContext(ctx context.Context) RandomPetArrayOutput

type RandomPetInput 

type RandomPetInput interface {
	pulumi.Input

	ToRandomPetOutput() RandomPetOutput
	ToRandomPetOutputWithContext(ctx context.Context) RandomPetOutput
}

type RandomPetMap added in v3.0.3 

type RandomPetMap map[string]RandomPetInput

func (RandomPetMap) ElementType added in v3.0.3 

func (RandomPetMap) ElementType() reflect.Type

func (RandomPetMap) ToRandomPetMapOutput added in v3.0.3 

func (i RandomPetMap) ToRandomPetMapOutput() RandomPetMapOutput

func (RandomPetMap) ToRandomPetMapOutputWithContext added in v3.0.3 

func (i RandomPetMap) ToRandomPetMapOutputWithContext(ctx context.Context) RandomPetMapOutput

type RandomPetMapInput added in v3.0.3 

type RandomPetMapInput interface {
	pulumi.Input

	ToRandomPetMapOutput() RandomPetMapOutput
	ToRandomPetMapOutputWithContext(context.Context) RandomPetMapOutput
}

RandomPetMapInput is an input type that accepts RandomPetMap and RandomPetMapOutput values. You can construct a concrete instance of `RandomPetMapInput` via: 

RandomPetMap{ "key": RandomPetArgs{...} }

type RandomPetMapOutput added in v3.0.3 

type RandomPetMapOutput struct{ *pulumi.OutputState }

func (RandomPetMapOutput) ElementType added in v3.0.3 

func (RandomPetMapOutput) ElementType() reflect.Type

func (RandomPetMapOutput) MapIndex added in v3.0.3 

func (o RandomPetMapOutput) MapIndex(k pulumi.StringInput) RandomPetOutput

func (RandomPetMapOutput) ToRandomPetMapOutput added in v3.0.3 

func (o RandomPetMapOutput) ToRandomPetMapOutput() RandomPetMapOutput

func (RandomPetMapOutput) ToRandomPetMapOutputWithContext added in v3.0.3 

func (o RandomPetMapOutput) ToRandomPetMapOutputWithContext(ctx context.Context) RandomPetMapOutput

type RandomPetOutput 

type RandomPetOutput struct {
	*pulumi.OutputState
}

func (RandomPetOutput) ElementType 

func (RandomPetOutput) ElementType() reflect.Type

func (RandomPetOutput) ToRandomPetOutput 

func (o RandomPetOutput) ToRandomPetOutput() RandomPetOutput

func (RandomPetOutput) ToRandomPetOutputWithContext 

func (o RandomPetOutput) ToRandomPetOutputWithContext(ctx context.Context) RandomPetOutput

func (RandomPetOutput) ToRandomPetPtrOutput added in v3.0.3 

func (o RandomPetOutput) ToRandomPetPtrOutput() RandomPetPtrOutput

func (RandomPetOutput) ToRandomPetPtrOutputWithContext added in v3.0.3 

func (o RandomPetOutput) ToRandomPetPtrOutputWithContext(ctx context.Context) RandomPetPtrOutput

type RandomPetPtrInput added in v3.0.3 

type RandomPetPtrInput interface {
	pulumi.Input

	ToRandomPetPtrOutput() RandomPetPtrOutput
	ToRandomPetPtrOutputWithContext(ctx context.Context) RandomPetPtrOutput
}

type RandomPetPtrOutput added in v3.0.3 

type RandomPetPtrOutput struct {
	*pulumi.OutputState
}

func (RandomPetPtrOutput) ElementType added in v3.0.3 

func (RandomPetPtrOutput) ElementType() reflect.Type

func (RandomPetPtrOutput) ToRandomPetPtrOutput added in v3.0.3 

func (o RandomPetPtrOutput) ToRandomPetPtrOutput() RandomPetPtrOutput

func (RandomPetPtrOutput) ToRandomPetPtrOutputWithContext added in v3.0.3 

func (o RandomPetPtrOutput) ToRandomPetPtrOutputWithContext(ctx context.Context) RandomPetPtrOutput

type RandomPetState 

type RandomPetState struct {
	// Arbitrary map of values that, when changed, will
	// trigger a new id to be generated. See
	// the main provider documentation for more information.
	Keepers pulumi.MapInput
	// The length (in words) of the pet name.
	Length pulumi.IntPtrInput
	// A string to prefix the name with.
	Prefix pulumi.StringPtrInput
	// The character to separate words in the pet name.
	Separator pulumi.StringPtrInput
}

func (RandomPetState) ElementType 

func (RandomPetState) ElementType() reflect.Type

type RandomShuffle 

type RandomShuffle struct {
	pulumi.CustomResourceState

	// The list of strings to shuffle.
	Inputs pulumi.StringArrayOutput `pulumi:"inputs"`
	// Arbitrary map of values that, when changed, will
	// trigger a new id to be generated. See
	// the main provider documentation for more information.
	Keepers pulumi.MapOutput `pulumi:"keepers"`
	// The number of results to return. Defaults to
	// the number of items in the `input` list. If fewer items are requested,
	// some elements will be excluded from the result. If more items are requested,
	// items will be repeated in the result but not more frequently than the number
	// of items in the input list.
	ResultCount pulumi.IntPtrOutput `pulumi:"resultCount"`
	// Random permutation of the list of strings given in `input`.
	Results pulumi.StringArrayOutput `pulumi:"results"`
	// Arbitrary string with which to seed the random number generator, in order to produce less-volatile permutations of the
	// list. **Important:** Even with an identical seed, it is not guaranteed that the same permutation will be produced across
	// different versions of Terraform. This argument causes the result to be *less volatile*, but not fixed for all time.
	Seed pulumi.StringPtrOutput `pulumi:"seed"`
}

The resource `RandomShuffle` generates a random permutation of a list of strings given as an argument.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/elb"
"github.com/pulumi/pulumi-random/sdk/v3/go/random"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		az, err := random.NewRandomShuffle(ctx, "az", &random.RandomShuffleArgs{
			Inputs: pulumi.StringArray{
				pulumi.String("us-west-1a"),
				pulumi.String("us-west-1c"),
				pulumi.String("us-west-1d"),
				pulumi.String("us-west-1e"),
			},
			ResultCount: pulumi.Int(2),
		})
		if err != nil {
			return err
		}
		_, err = elb.NewLoadBalancer(ctx, "example", &elb.LoadBalancerArgs{
			AvailabilityZones: az.Results,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetRandomShuffle 

func GetRandomShuffle(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *RandomShuffleState, opts ...pulumi.ResourceOption) (*RandomShuffle, error)

GetRandomShuffle gets an existing RandomShuffle 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 NewRandomShuffle 

func NewRandomShuffle(ctx *pulumi.Context,
	name string, args *RandomShuffleArgs, opts ...pulumi.ResourceOption) (*RandomShuffle, error)

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

func (*RandomShuffle) ElementType 

func (*RandomShuffle) ElementType() reflect.Type

func (*RandomShuffle) ToRandomShuffleOutput 

func (i *RandomShuffle) ToRandomShuffleOutput() RandomShuffleOutput

func (*RandomShuffle) ToRandomShuffleOutputWithContext 

func (i *RandomShuffle) ToRandomShuffleOutputWithContext(ctx context.Context) RandomShuffleOutput

func (*RandomShuffle) ToRandomShufflePtrOutput added in v3.0.3 

func (i *RandomShuffle) ToRandomShufflePtrOutput() RandomShufflePtrOutput

func (*RandomShuffle) ToRandomShufflePtrOutputWithContext added in v3.0.3 

func (i *RandomShuffle) ToRandomShufflePtrOutputWithContext(ctx context.Context) RandomShufflePtrOutput

type RandomShuffleArgs 

type RandomShuffleArgs struct {
	// The list of strings to shuffle.
	Inputs pulumi.StringArrayInput
	// Arbitrary map of values that, when changed, will
	// trigger a new id to be generated. See
	// the main provider documentation for more information.
	Keepers pulumi.MapInput
	// The number of results to return. Defaults to
	// the number of items in the `input` list. If fewer items are requested,
	// some elements will be excluded from the result. If more items are requested,
	// items will be repeated in the result but not more frequently than the number
	// of items in the input list.
	ResultCount pulumi.IntPtrInput
	// Arbitrary string with which to seed the random number generator, in order to produce less-volatile permutations of the
	// list. **Important:** Even with an identical seed, it is not guaranteed that the same permutation will be produced across
	// different versions of Terraform. This argument causes the result to be *less volatile*, but not fixed for all time.
	Seed pulumi.StringPtrInput
}

The set of arguments for constructing a RandomShuffle resource.

func (RandomShuffleArgs) ElementType 

func (RandomShuffleArgs) ElementType() reflect.Type

type RandomShuffleArray added in v3.0.3 

type RandomShuffleArray []RandomShuffleInput

func (RandomShuffleArray) ElementType added in v3.0.3 

func (RandomShuffleArray) ElementType() reflect.Type

func (RandomShuffleArray) ToRandomShuffleArrayOutput added in v3.0.3 

func (i RandomShuffleArray) ToRandomShuffleArrayOutput() RandomShuffleArrayOutput

func (RandomShuffleArray) ToRandomShuffleArrayOutputWithContext added in v3.0.3 

func (i RandomShuffleArray) ToRandomShuffleArrayOutputWithContext(ctx context.Context) RandomShuffleArrayOutput

type RandomShuffleArrayInput added in v3.0.3 

type RandomShuffleArrayInput interface {
	pulumi.Input

	ToRandomShuffleArrayOutput() RandomShuffleArrayOutput
	ToRandomShuffleArrayOutputWithContext(context.Context) RandomShuffleArrayOutput
}

RandomShuffleArrayInput is an input type that accepts RandomShuffleArray and RandomShuffleArrayOutput values. You can construct a concrete instance of `RandomShuffleArrayInput` via: 

RandomShuffleArray{ RandomShuffleArgs{...} }

type RandomShuffleArrayOutput added in v3.0.3 

type RandomShuffleArrayOutput struct{ *pulumi.OutputState }

func (RandomShuffleArrayOutput) ElementType added in v3.0.3 

func (RandomShuffleArrayOutput) ElementType() reflect.Type

func (RandomShuffleArrayOutput) Index added in v3.0.3 

func (o RandomShuffleArrayOutput) Index(i pulumi.IntInput) RandomShuffleOutput

func (RandomShuffleArrayOutput) ToRandomShuffleArrayOutput added in v3.0.3 

func (o RandomShuffleArrayOutput) ToRandomShuffleArrayOutput() RandomShuffleArrayOutput

func (RandomShuffleArrayOutput) ToRandomShuffleArrayOutputWithContext added in v3.0.3 

func (o RandomShuffleArrayOutput) ToRandomShuffleArrayOutputWithContext(ctx context.Context) RandomShuffleArrayOutput

type RandomShuffleInput 

type RandomShuffleInput interface {
	pulumi.Input

	ToRandomShuffleOutput() RandomShuffleOutput
	ToRandomShuffleOutputWithContext(ctx context.Context) RandomShuffleOutput
}

type RandomShuffleMap added in v3.0.3 

type RandomShuffleMap map[string]RandomShuffleInput

func (RandomShuffleMap) ElementType added in v3.0.3 

func (RandomShuffleMap) ElementType() reflect.Type

func (RandomShuffleMap) ToRandomShuffleMapOutput added in v3.0.3 

func (i RandomShuffleMap) ToRandomShuffleMapOutput() RandomShuffleMapOutput

func (RandomShuffleMap) ToRandomShuffleMapOutputWithContext added in v3.0.3 

func (i RandomShuffleMap) ToRandomShuffleMapOutputWithContext(ctx context.Context) RandomShuffleMapOutput

type RandomShuffleMapInput added in v3.0.3 

type RandomShuffleMapInput interface {
	pulumi.Input

	ToRandomShuffleMapOutput() RandomShuffleMapOutput
	ToRandomShuffleMapOutputWithContext(context.Context) RandomShuffleMapOutput
}

RandomShuffleMapInput is an input type that accepts RandomShuffleMap and RandomShuffleMapOutput values. You can construct a concrete instance of `RandomShuffleMapInput` via: 

RandomShuffleMap{ "key": RandomShuffleArgs{...} }

type RandomShuffleMapOutput added in v3.0.3 

type RandomShuffleMapOutput struct{ *pulumi.OutputState }

func (RandomShuffleMapOutput) ElementType added in v3.0.3 

func (RandomShuffleMapOutput) ElementType() reflect.Type

func (RandomShuffleMapOutput) MapIndex added in v3.0.3 

func (o RandomShuffleMapOutput) MapIndex(k pulumi.StringInput) RandomShuffleOutput

func (RandomShuffleMapOutput) ToRandomShuffleMapOutput added in v3.0.3 

func (o RandomShuffleMapOutput) ToRandomShuffleMapOutput() RandomShuffleMapOutput

func (RandomShuffleMapOutput) ToRandomShuffleMapOutputWithContext added in v3.0.3 

func (o RandomShuffleMapOutput) ToRandomShuffleMapOutputWithContext(ctx context.Context) RandomShuffleMapOutput

type RandomShuffleOutput 

type RandomShuffleOutput struct {
	*pulumi.OutputState
}

func (RandomShuffleOutput) ElementType 

func (RandomShuffleOutput) ElementType() reflect.Type

func (RandomShuffleOutput) ToRandomShuffleOutput 

func (o RandomShuffleOutput) ToRandomShuffleOutput() RandomShuffleOutput

func (RandomShuffleOutput) ToRandomShuffleOutputWithContext 

func (o RandomShuffleOutput) ToRandomShuffleOutputWithContext(ctx context.Context) RandomShuffleOutput

func (RandomShuffleOutput) ToRandomShufflePtrOutput added in v3.0.3 

func (o RandomShuffleOutput) ToRandomShufflePtrOutput() RandomShufflePtrOutput

func (RandomShuffleOutput) ToRandomShufflePtrOutputWithContext added in v3.0.3 

func (o RandomShuffleOutput) ToRandomShufflePtrOutputWithContext(ctx context.Context) RandomShufflePtrOutput

type RandomShufflePtrInput added in v3.0.3 

type RandomShufflePtrInput interface {
	pulumi.Input

	ToRandomShufflePtrOutput() RandomShufflePtrOutput
	ToRandomShufflePtrOutputWithContext(ctx context.Context) RandomShufflePtrOutput
}

type RandomShufflePtrOutput added in v3.0.3 

type RandomShufflePtrOutput struct {
	*pulumi.OutputState
}

func (RandomShufflePtrOutput) ElementType added in v3.0.3 

func (RandomShufflePtrOutput) ElementType() reflect.Type

func (RandomShufflePtrOutput) ToRandomShufflePtrOutput added in v3.0.3 

func (o RandomShufflePtrOutput) ToRandomShufflePtrOutput() RandomShufflePtrOutput

func (RandomShufflePtrOutput) ToRandomShufflePtrOutputWithContext added in v3.0.3 

func (o RandomShufflePtrOutput) ToRandomShufflePtrOutputWithContext(ctx context.Context) RandomShufflePtrOutput

type RandomShuffleState 

type RandomShuffleState struct {
	// The list of strings to shuffle.
	Inputs pulumi.StringArrayInput
	// Arbitrary map of values that, when changed, will
	// trigger a new id to be generated. See
	// the main provider documentation for more information.
	Keepers pulumi.MapInput
	// The number of results to return. Defaults to
	// the number of items in the `input` list. If fewer items are requested,
	// some elements will be excluded from the result. If more items are requested,
	// items will be repeated in the result but not more frequently than the number
	// of items in the input list.
	ResultCount pulumi.IntPtrInput
	// Random permutation of the list of strings given in `input`.
	Results pulumi.StringArrayInput
	// Arbitrary string with which to seed the random number generator, in order to produce less-volatile permutations of the
	// list. **Important:** Even with an identical seed, it is not guaranteed that the same permutation will be produced across
	// different versions of Terraform. This argument causes the result to be *less volatile*, but not fixed for all time.
	Seed pulumi.StringPtrInput
}

func (RandomShuffleState) ElementType 

func (RandomShuffleState) ElementType() reflect.Type

type RandomString 

type RandomString struct {
	pulumi.CustomResourceState

	// Arbitrary map of values that, when changed, will
	// trigger a new id to be generated. See
	// the main provider documentation for more information.
	Keepers pulumi.MapOutput `pulumi:"keepers"`
	// The length of the string desired
	Length pulumi.IntOutput `pulumi:"length"`
	// (default true) Include lowercase alphabet characters
	// in random string.
	Lower pulumi.BoolPtrOutput `pulumi:"lower"`
	// (default 0) Minimum number of lowercase alphabet
	// characters in random string.
	MinLower pulumi.IntPtrOutput `pulumi:"minLower"`
	// (default 0) Minimum number of numeric characters
	// in random string.
	MinNumeric pulumi.IntPtrOutput `pulumi:"minNumeric"`
	// (default 0) Minimum number of special characters
	// in random string.
	MinSpecial pulumi.IntPtrOutput `pulumi:"minSpecial"`
	// (default 0) Minimum number of uppercase alphabet
	// characters in random string.
	MinUpper pulumi.IntPtrOutput `pulumi:"minUpper"`
	// (default true) Include numeric characters in random
	// string.
	Number pulumi.BoolPtrOutput `pulumi:"number"`
	// Supply your own list of special characters to
	// use for string generation.  This overrides the default character list in the special
	// argument.  The special argument must still be set to true for any overwritten
	// characters to be used in generation.
	OverrideSpecial pulumi.StringPtrOutput `pulumi:"overrideSpecial"`
	// Random string generated.
	Result pulumi.StringOutput `pulumi:"result"`
	// (default true) Include special characters in random
	// string. These are `!@#$%&*()-_=+[]{}<>:?`
	Special pulumi.BoolPtrOutput `pulumi:"special"`
	// (default true) Include uppercase alphabet characters
	// in random string.
	Upper pulumi.BoolPtrOutput `pulumi:"upper"`
}

The resource `RandomString` generates a random permutation of alphanumeric characters and optionally special characters.

This resource *does* use a cryptographic random number generator.

Historically this resource's intended usage has been ambiguous as the original example used it in a password. For backwards compatibility it will continue to exist. For unique ids please use random_id, for sensitive random values please use random_password.

## Example Usage

```go package main

import ( 

"fmt"

"github.com/pulumi/pulumi-random/sdk/v3/go/random"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := random.NewRandomString(ctx, "random", &random.RandomStringArgs{
			Length:          pulumi.Int(16),
			OverrideSpecial: pulumi.String(fmt.Sprintf("%v%v", "/@£", "$")),
			Special:         pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Strings can be imported by just specifying the value of the string

```sh 

$ pulumi import random:index/randomString:RandomString test test

```

func GetRandomString 

func GetRandomString(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *RandomStringState, opts ...pulumi.ResourceOption) (*RandomString, error)

GetRandomString gets an existing RandomString 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 NewRandomString 

func NewRandomString(ctx *pulumi.Context,
	name string, args *RandomStringArgs, opts ...pulumi.ResourceOption) (*RandomString, error)

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

func (*RandomString) ElementType 

func (*RandomString) ElementType() reflect.Type

func (*RandomString) ToRandomStringOutput 

func (i *RandomString) ToRandomStringOutput() RandomStringOutput

func (*RandomString) ToRandomStringOutputWithContext 

func (i *RandomString) ToRandomStringOutputWithContext(ctx context.Context) RandomStringOutput

func (*RandomString) ToRandomStringPtrOutput added in v3.0.3 

func (i *RandomString) ToRandomStringPtrOutput() RandomStringPtrOutput

func (*RandomString) ToRandomStringPtrOutputWithContext added in v3.0.3 

func (i *RandomString) ToRandomStringPtrOutputWithContext(ctx context.Context) RandomStringPtrOutput

type RandomStringArgs 

type RandomStringArgs struct {
	// Arbitrary map of values that, when changed, will
	// trigger a new id to be generated. See
	// the main provider documentation for more information.
	Keepers pulumi.MapInput
	// The length of the string desired
	Length pulumi.IntInput
	// (default true) Include lowercase alphabet characters
	// in random string.
	Lower pulumi.BoolPtrInput
	// (default 0) Minimum number of lowercase alphabet
	// characters in random string.
	MinLower pulumi.IntPtrInput
	// (default 0) Minimum number of numeric characters
	// in random string.
	MinNumeric pulumi.IntPtrInput
	// (default 0) Minimum number of special characters
	// in random string.
	MinSpecial pulumi.IntPtrInput
	// (default 0) Minimum number of uppercase alphabet
	// characters in random string.
	MinUpper pulumi.IntPtrInput
	// (default true) Include numeric characters in random
	// string.
	Number pulumi.BoolPtrInput
	// Supply your own list of special characters to
	// use for string generation.  This overrides the default character list in the special
	// argument.  The special argument must still be set to true for any overwritten
	// characters to be used in generation.
	OverrideSpecial pulumi.StringPtrInput
	// (default true) Include special characters in random
	// string. These are `!@#$%&*()-_=+[]{}<>:?`
	Special pulumi.BoolPtrInput
	// (default true) Include uppercase alphabet characters
	// in random string.
	Upper pulumi.BoolPtrInput
}

The set of arguments for constructing a RandomString resource.

func (RandomStringArgs) ElementType 

func (RandomStringArgs) ElementType() reflect.Type

type RandomStringArray added in v3.0.3 

type RandomStringArray []RandomStringInput

func (RandomStringArray) ElementType added in v3.0.3 

func (RandomStringArray) ElementType() reflect.Type

func (RandomStringArray) ToRandomStringArrayOutput added in v3.0.3 

func (i RandomStringArray) ToRandomStringArrayOutput() RandomStringArrayOutput

func (RandomStringArray) ToRandomStringArrayOutputWithContext added in v3.0.3 

func (i RandomStringArray) ToRandomStringArrayOutputWithContext(ctx context.Context) RandomStringArrayOutput

type RandomStringArrayInput added in v3.0.3 

type RandomStringArrayInput interface {
	pulumi.Input

	ToRandomStringArrayOutput() RandomStringArrayOutput
	ToRandomStringArrayOutputWithContext(context.Context) RandomStringArrayOutput
}

RandomStringArrayInput is an input type that accepts RandomStringArray and RandomStringArrayOutput values. You can construct a concrete instance of `RandomStringArrayInput` via: 

RandomStringArray{ RandomStringArgs{...} }

type RandomStringArrayOutput added in v3.0.3 

type RandomStringArrayOutput struct{ *pulumi.OutputState }

func (RandomStringArrayOutput) ElementType added in v3.0.3 

func (RandomStringArrayOutput) ElementType() reflect.Type

func (RandomStringArrayOutput) Index added in v3.0.3 

func (o RandomStringArrayOutput) Index(i pulumi.IntInput) RandomStringOutput

func (RandomStringArrayOutput) ToRandomStringArrayOutput added in v3.0.3 

func (o RandomStringArrayOutput) ToRandomStringArrayOutput() RandomStringArrayOutput

func (RandomStringArrayOutput) ToRandomStringArrayOutputWithContext added in v3.0.3 

func (o RandomStringArrayOutput) ToRandomStringArrayOutputWithContext(ctx context.Context) RandomStringArrayOutput

type RandomStringInput 

type RandomStringInput interface {
	pulumi.Input

	ToRandomStringOutput() RandomStringOutput
	ToRandomStringOutputWithContext(ctx context.Context) RandomStringOutput
}

type RandomStringMap added in v3.0.3 

type RandomStringMap map[string]RandomStringInput

func (RandomStringMap) ElementType added in v3.0.3 

func (RandomStringMap) ElementType() reflect.Type

func (RandomStringMap) ToRandomStringMapOutput added in v3.0.3 

func (i RandomStringMap) ToRandomStringMapOutput() RandomStringMapOutput

func (RandomStringMap) ToRandomStringMapOutputWithContext added in v3.0.3 

func (i RandomStringMap) ToRandomStringMapOutputWithContext(ctx context.Context) RandomStringMapOutput

type RandomStringMapInput added in v3.0.3 

type RandomStringMapInput interface {
	pulumi.Input

	ToRandomStringMapOutput() RandomStringMapOutput
	ToRandomStringMapOutputWithContext(context.Context) RandomStringMapOutput
}

RandomStringMapInput is an input type that accepts RandomStringMap and RandomStringMapOutput values. You can construct a concrete instance of `RandomStringMapInput` via: 

RandomStringMap{ "key": RandomStringArgs{...} }

type RandomStringMapOutput added in v3.0.3 

type RandomStringMapOutput struct{ *pulumi.OutputState }

func (RandomStringMapOutput) ElementType added in v3.0.3 

func (RandomStringMapOutput) ElementType() reflect.Type

func (RandomStringMapOutput) MapIndex added in v3.0.3 

func (o RandomStringMapOutput) MapIndex(k pulumi.StringInput) RandomStringOutput

func (RandomStringMapOutput) ToRandomStringMapOutput added in v3.0.3 

func (o RandomStringMapOutput) ToRandomStringMapOutput() RandomStringMapOutput

func (RandomStringMapOutput) ToRandomStringMapOutputWithContext added in v3.0.3 

func (o RandomStringMapOutput) ToRandomStringMapOutputWithContext(ctx context.Context) RandomStringMapOutput

type RandomStringOutput 

type RandomStringOutput struct {
	*pulumi.OutputState
}

func (RandomStringOutput) ElementType 

func (RandomStringOutput) ElementType() reflect.Type

func (RandomStringOutput) ToRandomStringOutput 

func (o RandomStringOutput) ToRandomStringOutput() RandomStringOutput

func (RandomStringOutput) ToRandomStringOutputWithContext 

func (o RandomStringOutput) ToRandomStringOutputWithContext(ctx context.Context) RandomStringOutput

func (RandomStringOutput) ToRandomStringPtrOutput added in v3.0.3 

func (o RandomStringOutput) ToRandomStringPtrOutput() RandomStringPtrOutput

func (RandomStringOutput) ToRandomStringPtrOutputWithContext added in v3.0.3 

func (o RandomStringOutput) ToRandomStringPtrOutputWithContext(ctx context.Context) RandomStringPtrOutput

type RandomStringPtrInput added in v3.0.3 

type RandomStringPtrInput interface {
	pulumi.Input

	ToRandomStringPtrOutput() RandomStringPtrOutput
	ToRandomStringPtrOutputWithContext(ctx context.Context) RandomStringPtrOutput
}

type RandomStringPtrOutput added in v3.0.3 

type RandomStringPtrOutput struct {
	*pulumi.OutputState
}

func (RandomStringPtrOutput) ElementType added in v3.0.3 

func (RandomStringPtrOutput) ElementType() reflect.Type

func (RandomStringPtrOutput) ToRandomStringPtrOutput added in v3.0.3 

func (o RandomStringPtrOutput) ToRandomStringPtrOutput() RandomStringPtrOutput

func (RandomStringPtrOutput) ToRandomStringPtrOutputWithContext added in v3.0.3 

func (o RandomStringPtrOutput) ToRandomStringPtrOutputWithContext(ctx context.Context) RandomStringPtrOutput

type RandomStringState 

type RandomStringState struct {
	// Arbitrary map of values that, when changed, will
	// trigger a new id to be generated. See
	// the main provider documentation for more information.
	Keepers pulumi.MapInput
	// The length of the string desired
	Length pulumi.IntPtrInput
	// (default true) Include lowercase alphabet characters
	// in random string.
	Lower pulumi.BoolPtrInput
	// (default 0) Minimum number of lowercase alphabet
	// characters in random string.
	MinLower pulumi.IntPtrInput
	// (default 0) Minimum number of numeric characters
	// in random string.
	MinNumeric pulumi.IntPtrInput
	// (default 0) Minimum number of special characters
	// in random string.
	MinSpecial pulumi.IntPtrInput
	// (default 0) Minimum number of uppercase alphabet
	// characters in random string.
	MinUpper pulumi.IntPtrInput
	// (default true) Include numeric characters in random
	// string.
	Number pulumi.BoolPtrInput
	// Supply your own list of special characters to
	// use for string generation.  This overrides the default character list in the special
	// argument.  The special argument must still be set to true for any overwritten
	// characters to be used in generation.
	OverrideSpecial pulumi.StringPtrInput
	// Random string generated.
	Result pulumi.StringPtrInput
	// (default true) Include special characters in random
	// string. These are `!@#$%&*()-_=+[]{}<>:?`
	Special pulumi.BoolPtrInput
	// (default true) Include uppercase alphabet characters
	// in random string.
	Upper pulumi.BoolPtrInput
}

func (RandomStringState) ElementType 

func (RandomStringState) ElementType() reflect.Type

type RandomUuid 

type RandomUuid struct {
	pulumi.CustomResourceState

	// Arbitrary map of values that, when changed, will
	// trigger a new uuid to be generated. See
	// the main provider documentation for more information.
	Keepers pulumi.MapOutput `pulumi:"keepers"`
	// The generated uuid presented in string format.
	Result pulumi.StringOutput `pulumi:"result"`
}

The resource `RandomUuid` generates random uuid string that is intended to be used as unique identifiers for other resources.

This resource uses the `hashicorp/go-uuid` to generate a UUID-formatted string for use with services needed a unique string identifier.

## Example Usage

The following example shows how to generate a unique name for an Azure Resource Group.

```go package main

import ( 

"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
"github.com/pulumi/pulumi-random/sdk/v3/go/random"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := random.NewRandomUuid(ctx, "testRandomUuid", nil)
		if err != nil {
			return err
		}
		_, err = core.NewResourceGroup(ctx, "testResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("Central US"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Random UUID's can be imported. This can be used to replace a config value with a value interpolated from the random provider without experiencing diffs. Example

```sh 

$ pulumi import random:index/randomUuid:RandomUuid main aabbccdd-eeff-0011-2233-445566778899

```

func GetRandomUuid 

func GetRandomUuid(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *RandomUuidState, opts ...pulumi.ResourceOption) (*RandomUuid, error)

GetRandomUuid gets an existing RandomUuid 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 NewRandomUuid 

func NewRandomUuid(ctx *pulumi.Context,
	name string, args *RandomUuidArgs, opts ...pulumi.ResourceOption) (*RandomUuid, error)

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

func (*RandomUuid) ElementType 

func (*RandomUuid) ElementType() reflect.Type

func (*RandomUuid) ToRandomUuidOutput 

func (i *RandomUuid) ToRandomUuidOutput() RandomUuidOutput

func (*RandomUuid) ToRandomUuidOutputWithContext 

func (i *RandomUuid) ToRandomUuidOutputWithContext(ctx context.Context) RandomUuidOutput

func (*RandomUuid) ToRandomUuidPtrOutput added in v3.0.3 

func (i *RandomUuid) ToRandomUuidPtrOutput() RandomUuidPtrOutput

func (*RandomUuid) ToRandomUuidPtrOutputWithContext added in v3.0.3 

func (i *RandomUuid) ToRandomUuidPtrOutputWithContext(ctx context.Context) RandomUuidPtrOutput

type RandomUuidArgs 

type RandomUuidArgs struct {
	// Arbitrary map of values that, when changed, will
	// trigger a new uuid to be generated. See
	// the main provider documentation for more information.
	Keepers pulumi.MapInput
}

The set of arguments for constructing a RandomUuid resource.

func (RandomUuidArgs) ElementType 

func (RandomUuidArgs) ElementType() reflect.Type

type RandomUuidArray added in v3.0.3 

type RandomUuidArray []RandomUuidInput

func (RandomUuidArray) ElementType added in v3.0.3 

func (RandomUuidArray) ElementType() reflect.Type

func (RandomUuidArray) ToRandomUuidArrayOutput added in v3.0.3 

func (i RandomUuidArray) ToRandomUuidArrayOutput() RandomUuidArrayOutput

func (RandomUuidArray) ToRandomUuidArrayOutputWithContext added in v3.0.3 

func (i RandomUuidArray) ToRandomUuidArrayOutputWithContext(ctx context.Context) RandomUuidArrayOutput

type RandomUuidArrayInput added in v3.0.3 

type RandomUuidArrayInput interface {
	pulumi.Input

	ToRandomUuidArrayOutput() RandomUuidArrayOutput
	ToRandomUuidArrayOutputWithContext(context.Context) RandomUuidArrayOutput
}

RandomUuidArrayInput is an input type that accepts RandomUuidArray and RandomUuidArrayOutput values. You can construct a concrete instance of `RandomUuidArrayInput` via: 

RandomUuidArray{ RandomUuidArgs{...} }

type RandomUuidArrayOutput added in v3.0.3 

type RandomUuidArrayOutput struct{ *pulumi.OutputState }

func (RandomUuidArrayOutput) ElementType added in v3.0.3 

func (RandomUuidArrayOutput) ElementType() reflect.Type

func (RandomUuidArrayOutput) Index added in v3.0.3 

func (o RandomUuidArrayOutput) Index(i pulumi.IntInput) RandomUuidOutput

func (RandomUuidArrayOutput) ToRandomUuidArrayOutput added in v3.0.3 

func (o RandomUuidArrayOutput) ToRandomUuidArrayOutput() RandomUuidArrayOutput

func (RandomUuidArrayOutput) ToRandomUuidArrayOutputWithContext added in v3.0.3 

func (o RandomUuidArrayOutput) ToRandomUuidArrayOutputWithContext(ctx context.Context) RandomUuidArrayOutput

type RandomUuidInput 

type RandomUuidInput interface {
	pulumi.Input

	ToRandomUuidOutput() RandomUuidOutput
	ToRandomUuidOutputWithContext(ctx context.Context) RandomUuidOutput
}

type RandomUuidMap added in v3.0.3 

type RandomUuidMap map[string]RandomUuidInput

func (RandomUuidMap) ElementType added in v3.0.3 

func (RandomUuidMap) ElementType() reflect.Type

func (RandomUuidMap) ToRandomUuidMapOutput added in v3.0.3 

func (i RandomUuidMap) ToRandomUuidMapOutput() RandomUuidMapOutput

func (RandomUuidMap) ToRandomUuidMapOutputWithContext added in v3.0.3 

func (i RandomUuidMap) ToRandomUuidMapOutputWithContext(ctx context.Context) RandomUuidMapOutput

type RandomUuidMapInput added in v3.0.3 

type RandomUuidMapInput interface {
	pulumi.Input

	ToRandomUuidMapOutput() RandomUuidMapOutput
	ToRandomUuidMapOutputWithContext(context.Context) RandomUuidMapOutput
}

RandomUuidMapInput is an input type that accepts RandomUuidMap and RandomUuidMapOutput values. You can construct a concrete instance of `RandomUuidMapInput` via: 

RandomUuidMap{ "key": RandomUuidArgs{...} }

type RandomUuidMapOutput added in v3.0.3 

type RandomUuidMapOutput struct{ *pulumi.OutputState }

func (RandomUuidMapOutput) ElementType added in v3.0.3 

func (RandomUuidMapOutput) ElementType() reflect.Type

func (RandomUuidMapOutput) MapIndex added in v3.0.3 

func (o RandomUuidMapOutput) MapIndex(k pulumi.StringInput) RandomUuidOutput

func (RandomUuidMapOutput) ToRandomUuidMapOutput added in v3.0.3 

func (o RandomUuidMapOutput) ToRandomUuidMapOutput() RandomUuidMapOutput

func (RandomUuidMapOutput) ToRandomUuidMapOutputWithContext added in v3.0.3 

func (o RandomUuidMapOutput) ToRandomUuidMapOutputWithContext(ctx context.Context) RandomUuidMapOutput

type RandomUuidOutput 

type RandomUuidOutput struct {
	*pulumi.OutputState
}

func (RandomUuidOutput) ElementType 

func (RandomUuidOutput) ElementType() reflect.Type

func (RandomUuidOutput) ToRandomUuidOutput 

func (o RandomUuidOutput) ToRandomUuidOutput() RandomUuidOutput

func (RandomUuidOutput) ToRandomUuidOutputWithContext 

func (o RandomUuidOutput) ToRandomUuidOutputWithContext(ctx context.Context) RandomUuidOutput

func (RandomUuidOutput) ToRandomUuidPtrOutput added in v3.0.3 

func (o RandomUuidOutput) ToRandomUuidPtrOutput() RandomUuidPtrOutput

func (RandomUuidOutput) ToRandomUuidPtrOutputWithContext added in v3.0.3 

func (o RandomUuidOutput) ToRandomUuidPtrOutputWithContext(ctx context.Context) RandomUuidPtrOutput

type RandomUuidPtrInput added in v3.0.3 

type RandomUuidPtrInput interface {
	pulumi.Input

	ToRandomUuidPtrOutput() RandomUuidPtrOutput
	ToRandomUuidPtrOutputWithContext(ctx context.Context) RandomUuidPtrOutput
}

type RandomUuidPtrOutput added in v3.0.3 

type RandomUuidPtrOutput struct {
	*pulumi.OutputState
}

func (RandomUuidPtrOutput) ElementType added in v3.0.3 

func (RandomUuidPtrOutput) ElementType() reflect.Type

func (RandomUuidPtrOutput) ToRandomUuidPtrOutput added in v3.0.3 

func (o RandomUuidPtrOutput) ToRandomUuidPtrOutput() RandomUuidPtrOutput

func (RandomUuidPtrOutput) ToRandomUuidPtrOutputWithContext added in v3.0.3 

func (o RandomUuidPtrOutput) ToRandomUuidPtrOutputWithContext(ctx context.Context) RandomUuidPtrOutput

type RandomUuidState 

type RandomUuidState struct {
	// Arbitrary map of values that, when changed, will
	// trigger a new uuid to be generated. See
	// the main provider documentation for more information.
	Keepers pulumi.MapInput
	// The generated uuid presented in string format.
	Result pulumi.StringPtrInput
}

func (RandomUuidState) ElementType 

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