organizations

Documentation

Index

• type Organization
  • func (Organization) Create(ctx p.Context, name string, input OrganizationArgs, preview bool) (string, OrganizationState, error)
  • func (Organization) Delete(ctx p.Context, name string, state OrganizationState) error
• type OrganizationArgs
• type OrganizationState

Types

type Organization

type Organization struct{}

Each resource has a controlling struct. Resource behavior is determined by implementing methods on the controlling struct. The `Create` method is mandatory, but other methods are optional. - Check: Remap inputs before they are typed. - Diff: Change how instances of a resource are compared. - Update: Mutate a resource in place. - Read: Get the state of a resource from the backing provider. - Delete: Custom logic when the resource is deleted. - Annotate: Describe fields and set defaults for a resource. - WireDependencies: Control how outputs and secrets flows through values.

func (Organization) Create

func (Organization) Create(ctx p.Context, name string, input OrganizationArgs, preview bool) (string, OrganizationState, error)

All resources must implement Create at a minumum.

func (Organization) Delete

func (Organization) Delete(ctx p.Context, name string, state OrganizationState) error

type OrganizationArgs

type OrganizationArgs struct {
	// The name of the organization to create, if not provided one will be generated from the resource name
	Name string `pulumi:"name,optional"`

	Tier string `pulumi:"tier"`
}

Each resource has in input struct, defining what arguments it accepts.

type OrganizationState

type OrganizationState struct {
	// It is generally a good idea to embed args in outputs, but it isn't strictly necessary.
	OrganizationArgs

	OrganizationId   int64  `pulumi:"organization_id"`
	OrganizationSlug string `pulumi:"organization_slug"`
	OrganizationName string `pulumi:"organization_name"`
}

Each resource has a state, describing the fields that exist on the created resource.