paths

Documentation

Index

• type ConfigPath
  • func NewConfigPath() *ConfigPath
  • func (p *ConfigPath) Parent() TypePath
  • func (p *ConfigPath) String() string
  • func (p *ConfigPath) UniqueKey() string
• type DataSourceMemberKind
  • func (s DataSourceMemberKind) String() string
• type DataSourceMemberPath
  • func (p *DataSourceMemberPath) Parent() TypePath
  • func (p *DataSourceMemberPath) String() string
  • func (p *DataSourceMemberPath) UniqueKey() string
• type DataSourcePath
  • func NewDataSourcePath(key string, token tokens.ModuleMember) *DataSourcePath
  • func (p *DataSourcePath) Args() *DataSourceMemberPath
  • func (p *DataSourcePath) Key() string
  • func (p *DataSourcePath) Results() *DataSourceMemberPath
  • func (p *DataSourcePath) String() string
  • func (p *DataSourcePath) Token() tokens.ModuleMember
• type ElementPath
  • func NewElementPath(parent TypePath) *ElementPath
  • func (p *ElementPath) Parent() TypePath
  • func (p *ElementPath) String() string
  • func (p *ElementPath) UniqueKey() string
• type PropertyName
  • func (pn PropertyName) String() string
• type PropertyPath
  • func NewProperyPath(parent TypePath, name PropertyName) *PropertyPath
  • func (p *PropertyPath) Parent() TypePath
  • func (p *PropertyPath) String() string
  • func (p *PropertyPath) UniqueKey() string
• type ResourceMemberKind
  • func (s ResourceMemberKind) String() string
• type ResourceMemberPath
  • func (p *ResourceMemberPath) Parent() TypePath
  • func (p *ResourceMemberPath) String() string
  • func (p *ResourceMemberPath) UniqueKey() string
• type ResourcePath
  • func NewResourcePath(terraformResourceKey string, resourceToken tokens.Type, isProvider bool) *ResourcePath
  • func (p *ResourcePath) Inputs() *ResourceMemberPath
  • func (p *ResourcePath) IsProvider() bool
  • func (p *ResourcePath) Key() string
  • func (p *ResourcePath) Outputs() *ResourceMemberPath
  • func (p *ResourcePath) State() *ResourceMemberPath
  • func (p *ResourcePath) String() string
  • func (p *ResourcePath) Token() tokens.Type
• type TypePath
• type TypePathSet
  • func NewTypePathSet() TypePathSet
  • func SingletonTypePathSet(typePath TypePath) TypePathSet
  • func (s TypePathSet) Add(p TypePath)
  • func (s TypePathSet) Paths() []TypePath

Types

type ConfigPath

type ConfigPath struct{}

func NewConfigPath

func NewConfigPath() *ConfigPath

func (*ConfigPath) Parent

func (p *ConfigPath) Parent() TypePath

func (*ConfigPath) String

func (p *ConfigPath) String() string

func (*ConfigPath) UniqueKey

func (p *ConfigPath) UniqueKey() string

type DataSourceMemberKind

type DataSourceMemberKind int

const (
	DataSourceArgs DataSourceMemberKind = iota
	DataSourceResults
)

func (DataSourceMemberKind) String

func (s DataSourceMemberKind) String() string

type DataSourceMemberPath

type DataSourceMemberPath struct {
	DataSourcePath       *DataSourcePath
	DataSourceMemberKind DataSourceMemberKind
}

func (*DataSourceMemberPath) Parent

func (p *DataSourceMemberPath) Parent() TypePath

func (*DataSourceMemberPath) String

func (p *DataSourceMemberPath) String() string

func (*DataSourceMemberPath) UniqueKey

func (p *DataSourceMemberPath) UniqueKey() string

type DataSourcePath

type DataSourcePath struct {
	// contains filtered or unexported fields
}

Identifies a data source uniquely.

func NewDataSourcePath

func NewDataSourcePath(key string, token tokens.ModuleMember) *DataSourcePath

func (*DataSourcePath) Args

func (p *DataSourcePath) Args() *DataSourceMemberPath

func (*DataSourcePath) Key

func (p *DataSourcePath) Key() string

Unique identifier for the DataSource preserved from the shim layer, typically the Terraform name.

func (*DataSourcePath) Results

func (p *DataSourcePath) Results() *DataSourceMemberPath

func (*DataSourcePath) String

func (p *DataSourcePath) String() string

func (*DataSourcePath) Token

func (p *DataSourcePath) Token() tokens.ModuleMember

Pulumi token uniquely identifiying the DataSource.

type ElementPath

type ElementPath struct {
	// contains filtered or unexported fields
}

Represents an element of List or Map or Set type represented by Parent.

func NewElementPath

func NewElementPath(parent TypePath) *ElementPath

func (*ElementPath) Parent

func (p *ElementPath) Parent() TypePath

func (*ElementPath) String

func (p *ElementPath) String() string

func (*ElementPath) UniqueKey

func (p *ElementPath) UniqueKey() string

type PropertyName

type PropertyName struct {
	// The original name from the shim (typically the Terraform name). Example: "bcrypt_hash".
	Key string

	// Possibly inflected Pulumi name, typically but not always equal to Key. Example inflection: "bcryptHash".
	Name tokens.Name
}

Type paths include property names as path fragments.

func (PropertyName) String

func (pn PropertyName) String() string

type PropertyPath

type PropertyPath struct {
	PropertyName PropertyName
	// contains filtered or unexported fields
}

func NewProperyPath

func NewProperyPath(parent TypePath, name PropertyName) *PropertyPath

func (*PropertyPath) Parent

func (p *PropertyPath) Parent() TypePath

func (*PropertyPath) String

func (p *PropertyPath) String() string

func (*PropertyPath) UniqueKey

func (p *PropertyPath) UniqueKey() string

type ResourceMemberKind

type ResourceMemberKind int

const (
	ResourceInputs ResourceMemberKind = iota
	ResourceOutputs
	ResourceState
)

func (ResourceMemberKind) String

func (s ResourceMemberKind) String() string

type ResourceMemberPath

type ResourceMemberPath struct {
	ResourcePath       *ResourcePath
	ResourceMemberKind ResourceMemberKind
}

func (*ResourceMemberPath) Parent

func (p *ResourceMemberPath) Parent() TypePath

func (*ResourceMemberPath) String

func (p *ResourceMemberPath) String() string

func (*ResourceMemberPath) UniqueKey

func (p *ResourceMemberPath) UniqueKey() string

type ResourcePath

type ResourcePath struct {
	// contains filtered or unexported fields
}

Identifies a resource uniquely.

func NewResourcePath

func NewResourcePath(terraformResourceKey string, resourceToken tokens.Type, isProvider bool) *ResourcePath

func (*ResourcePath) Inputs

func (p *ResourcePath) Inputs() *ResourceMemberPath

func (*ResourcePath) IsProvider

func (p *ResourcePath) IsProvider() bool

func (*ResourcePath) Key

func (p *ResourcePath) Key() string

Raw name from shim.ResourceMap, typically the Terraform name uniquely identifying the Resource. Will be empty if IsProvider() is true and the resource is a Provider resource, a Pulumi-only concept.

func (*ResourcePath) Outputs

func (p *ResourcePath) Outputs() *ResourceMemberPath

func (*ResourcePath) State

func (p *ResourcePath) State() *ResourceMemberPath

func (*ResourcePath) String

func (p *ResourcePath) String() string

func (*ResourcePath) Token

func (p *ResourcePath) Token() tokens.Type

Unquely identifies the Resource in Pulumi Schema.

See also: https://www.pulumi.com/docs/guides/pulumi-packages/schema/

type TypePath

type TypePath interface {
	// Parent path, can be nil for root paths.
	Parent() TypePath

	// Useful for comparing paths.
	UniqueKey() string

	// Human friendly representation.
	String() string
}

TypePath values uniquely identify locations within a Pulumi Package Schema that require generating types in a target programming language when a provider SDK for that language is being built. Examples of such types include resources (see ResourcePath), data sources (DataSourcePath), provider configuration (ConfigPath), and nested object types that are used to describe the type of resource properties.

type TypePathSet

type TypePathSet map[string]TypePath

func NewTypePathSet

func NewTypePathSet() TypePathSet

func SingletonTypePathSet

func SingletonTypePathSet(typePath TypePath) TypePathSet

func (TypePathSet) Add

func (s TypePathSet) Add(p TypePath)

func (TypePathSet) Paths

func (s TypePathSet) Paths() []TypePath