Documentation ¶
Overview ¶
Package client implements a client for the Pulumi Service HTTP/REST API. Important note: This client is not versioned, and not intended for external use at this time.
Index ¶
- Variables
- type Client
- func (pc *Client) ApplyPolicyPack(ctx context.Context, orgName, policyGroup, policyPackName, versionTag string, ...) error
- func (pc *Client) CancelUpdate(ctx context.Context, update UpdateIdentifier) error
- func (pc *Client) CompleteUpdate(ctx context.Context, update UpdateIdentifier, status apitype.UpdateStatus, ...) error
- func (pc *Client) CreateStack(ctx context.Context, stackID StackIdentifier, ...) (apitype.Stack, error)
- func (pc *Client) CreateUpdate(ctx context.Context, kind apitype.UpdateKind, stack StackIdentifier, ...) (UpdateIdentifier, []apitype.RequiredPolicy, error)
- func (pc *Client) DecryptValue(ctx context.Context, stack StackIdentifier, ciphertext []byte) ([]byte, error)
- func (pc *Client) DeleteStack(ctx context.Context, stack StackIdentifier, force bool) (bool, error)
- func (pc *Client) DisablePolicyPack(ctx context.Context, orgName string, policyGroup string, ...) error
- func (pc *Client) DoesProjectExist(ctx context.Context, owner string, projectName string) (bool, error)
- func (pc *Client) DownloadPolicyPack(ctx context.Context, url string) (io.ReadCloser, error)
- func (pc *Client) EncryptValue(ctx context.Context, stack StackIdentifier, plaintext []byte) ([]byte, error)
- func (pc *Client) ExportStackDeployment(ctx context.Context, stack StackIdentifier, version *int) (apitype.UntypedDeployment, error)
- func (pc *Client) GetCLIVersionInfo(ctx context.Context) (semver.Version, semver.Version, error)
- func (pc *Client) GetLatestConfiguration(ctx context.Context, stackID StackIdentifier) (config.Map, error)
- func (pc *Client) GetPolicyPackSchema(ctx context.Context, orgName, policyPackName, versionTag string) (*apitype.GetPolicyPackConfigSchemaResponse, error)
- func (pc *Client) GetPulumiAccountName(ctx context.Context) (string, error)
- func (pc *Client) GetStack(ctx context.Context, stackID StackIdentifier) (apitype.Stack, error)
- func (pc *Client) GetStackUpdates(ctx context.Context, stack StackIdentifier, pageSize int, page int) ([]apitype.UpdateInfo, error)
- func (pc *Client) GetUpdateEvents(ctx context.Context, update UpdateIdentifier, continuationToken *string) (apitype.UpdateResults, error)
- func (pc *Client) ImportStackDeployment(ctx context.Context, stack StackIdentifier, ...) (UpdateIdentifier, error)
- func (pc *Client) InvalidateUpdateCheckpoint(ctx context.Context, update UpdateIdentifier, token string) error
- func (pc *Client) ListPolicyGroups(ctx context.Context, orgName string) (apitype.ListPolicyGroupsResponse, error)
- func (pc *Client) ListPolicyPacks(ctx context.Context, orgName string) (apitype.ListPolicyPacksResponse, error)
- func (pc *Client) ListStacks(ctx context.Context, filter ListStacksFilter) ([]apitype.StackSummary, error)
- func (pc *Client) PatchUpdateCheckpoint(ctx context.Context, update UpdateIdentifier, deployment *apitype.DeploymentV3, ...) error
- func (pc *Client) PublishPolicyPack(ctx context.Context, orgName string, analyzerInfo plugin.AnalyzerInfo, ...) (string, error)
- func (pc *Client) RecordEngineEvents(ctx context.Context, update UpdateIdentifier, batch apitype.EngineEventBatch, ...) error
- func (pc *Client) RemovePolicyPack(ctx context.Context, orgName string, policyPackName string) error
- func (pc *Client) RemovePolicyPackByVersion(ctx context.Context, orgName string, policyPackName string, versionTag string) error
- func (pc *Client) RenameStack(ctx context.Context, currentID, newID StackIdentifier) error
- func (pc *Client) RenewUpdateLease(ctx context.Context, update UpdateIdentifier, token string, ...) (string, error)
- func (pc *Client) StartUpdate(ctx context.Context, update UpdateIdentifier, ...) (int, string, error)
- func (pc *Client) URL() string
- func (pc *Client) UpdateStackTags(ctx context.Context, stack StackIdentifier, ...) error
- type ListStacksFilter
- type StackIdentifier
- type UpdateIdentifier
Constants ¶
This section is empty.
Variables ¶
var ( // ErrNoPreviousDeployment is returned when there isn't a previous deployment. ErrNoPreviousDeployment = errors.New("no previous deployment") )
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides a slim wrapper around the Pulumi HTTP/REST API.
func (*Client) ApplyPolicyPack ¶
func (pc *Client) ApplyPolicyPack(ctx context.Context, orgName, policyGroup, policyPackName, versionTag string, policyPackConfig map[string]*json.RawMessage) error
ApplyPolicyPack enables a `PolicyPack` to the Pulumi organization. If policyGroup is not empty, it will enable the PolicyPack on the default PolicyGroup.
func (*Client) CancelUpdate ¶
func (pc *Client) CancelUpdate(ctx context.Context, update UpdateIdentifier) error
CancelUpdate cancels the indicated update.
func (*Client) CompleteUpdate ¶
func (pc *Client) CompleteUpdate(ctx context.Context, update UpdateIdentifier, status apitype.UpdateStatus, token string) error
CompleteUpdate completes the indicated update with the given status.
func (*Client) CreateStack ¶
func (pc *Client) CreateStack( ctx context.Context, stackID StackIdentifier, tags map[apitype.StackTagName]string) (apitype.Stack, error)
CreateStack creates a stack with the given cloud and stack name in the scope of the indicated project.
func (*Client) CreateUpdate ¶
func (pc *Client) CreateUpdate( ctx context.Context, kind apitype.UpdateKind, stack StackIdentifier, proj *workspace.Project, cfg config.Map, m apitype.UpdateMetadata, opts engine.UpdateOptions, dryRun bool) (UpdateIdentifier, []apitype.RequiredPolicy, error)
CreateUpdate creates a new update for the indicated stack with the given kind and assorted options. If the update requires that the Pulumi program is uploaded, the provided getContents callback will be invoked to fetch the contents of the Pulumi program.
func (*Client) DecryptValue ¶
func (pc *Client) DecryptValue(ctx context.Context, stack StackIdentifier, ciphertext []byte) ([]byte, error)
DecryptValue decrypts a ciphertext value in the context of the indicated stack.
func (*Client) DeleteStack ¶
DeleteStack deletes the indicated stack. If force is true, the stack is deleted even if it contains resources.
func (*Client) DisablePolicyPack ¶
func (pc *Client) DisablePolicyPack(ctx context.Context, orgName string, policyGroup string, policyPackName, versionTag string) error
DisablePolicyPack disables a `PolicyPack` to the Pulumi organization. If policyGroup is not empty, it will disable the PolicyPack on the default PolicyGroup.
func (*Client) DoesProjectExist ¶
func (pc *Client) DoesProjectExist(ctx context.Context, owner string, projectName string) (bool, error)
DoesProjectExist returns true if a project with the given name exists, or false otherwise.
func (*Client) DownloadPolicyPack ¶
DownloadPolicyPack applies a `PolicyPack` to the Pulumi organization.
func (*Client) EncryptValue ¶
func (pc *Client) EncryptValue(ctx context.Context, stack StackIdentifier, plaintext []byte) ([]byte, error)
EncryptValue encrypts a plaintext value in the context of the indicated stack.
func (*Client) ExportStackDeployment ¶
func (pc *Client) ExportStackDeployment( ctx context.Context, stack StackIdentifier, version *int) (apitype.UntypedDeployment, error)
ExportStackDeployment exports the indicated stack's deployment as a raw JSON message. If version is nil, will export the latest version of the stack.
func (*Client) GetCLIVersionInfo ¶
GetCLIVersionInfo asks the service for information about versions of the CLI (the newest version as well as the oldest version before the CLI should warn about an upgrade).
func (*Client) GetLatestConfiguration ¶
func (pc *Client) GetLatestConfiguration(ctx context.Context, stackID StackIdentifier) (config.Map, error)
GetLatestConfiguration returns the configuration for the latest deployment of a given stack.
func (*Client) GetPolicyPackSchema ¶
func (pc *Client) GetPolicyPackSchema(ctx context.Context, orgName, policyPackName, versionTag string) (*apitype.GetPolicyPackConfigSchemaResponse, error)
GetPolicyPackSchema gets Policy Pack config schema.
func (*Client) GetPulumiAccountName ¶
GetPulumiAccountName returns the user implied by the API token associated with this client.
func (*Client) GetStackUpdates ¶
func (pc *Client) GetStackUpdates( ctx context.Context, stack StackIdentifier, pageSize int, page int) ([]apitype.UpdateInfo, error)
GetStackUpdates returns all updates to the indicated stack.
func (*Client) GetUpdateEvents ¶
func (pc *Client) GetUpdateEvents(ctx context.Context, update UpdateIdentifier, continuationToken *string) (apitype.UpdateResults, error)
GetUpdateEvents returns all events, taking an optional continuation token from a previous call.
func (*Client) ImportStackDeployment ¶
func (pc *Client) ImportStackDeployment(ctx context.Context, stack StackIdentifier, deployment *apitype.UntypedDeployment) (UpdateIdentifier, error)
ImportStackDeployment imports a new deployment into the indicated stack.
func (*Client) InvalidateUpdateCheckpoint ¶
func (pc *Client) InvalidateUpdateCheckpoint(ctx context.Context, update UpdateIdentifier, token string) error
InvalidateUpdateCheckpoint invalidates the checkpoint for the indicated update.
func (*Client) ListPolicyGroups ¶
func (pc *Client) ListPolicyGroups(ctx context.Context, orgName string) (apitype.ListPolicyGroupsResponse, error)
ListPolicyGroups lists all `PolicyGroups` the organization has in the Pulumi service.
func (*Client) ListPolicyPacks ¶
func (pc *Client) ListPolicyPacks(ctx context.Context, orgName string) (apitype.ListPolicyPacksResponse, error)
ListPolicyPacks lists all `PolicyPack` the organization has in the Pulumi service.
func (*Client) ListStacks ¶
func (pc *Client) ListStacks( ctx context.Context, filter ListStacksFilter) ([]apitype.StackSummary, error)
ListStacks lists all stacks the current user has access to, optionally filtered by project.
func (*Client) PatchUpdateCheckpoint ¶
func (pc *Client) PatchUpdateCheckpoint(ctx context.Context, update UpdateIdentifier, deployment *apitype.DeploymentV3, token string) error
PatchUpdateCheckpoint patches the checkpoint for the indicated update with the given contents.
func (*Client) PublishPolicyPack ¶
func (pc *Client) PublishPolicyPack(ctx context.Context, orgName string, analyzerInfo plugin.AnalyzerInfo, dirArchive io.Reader) (string, error)
PublishPolicyPack publishes a `PolicyPack` to the Pulumi service. If it successfully publishes the Policy Pack, it returns the version of the pack.
func (*Client) RecordEngineEvents ¶
func (pc *Client) RecordEngineEvents( ctx context.Context, update UpdateIdentifier, batch apitype.EngineEventBatch, token string) error
RecordEngineEvents posts a batch of engine events to the Pulumi service.
func (*Client) RemovePolicyPack ¶
func (pc *Client) RemovePolicyPack(ctx context.Context, orgName string, policyPackName string) error
RemovePolicyPack removes all versions of a `PolicyPack` from the Pulumi organization.
func (*Client) RemovePolicyPackByVersion ¶
func (pc *Client) RemovePolicyPackByVersion(ctx context.Context, orgName string, policyPackName string, versionTag string) error
RemovePolicyPackByVersion removes a specific version of a `PolicyPack` from the Pulumi organization.
func (*Client) RenameStack ¶
func (pc *Client) RenameStack(ctx context.Context, currentID, newID StackIdentifier) error
RenameStack renames the provided stack to have the new identifier.
func (*Client) RenewUpdateLease ¶
func (pc *Client) RenewUpdateLease(ctx context.Context, update UpdateIdentifier, token string, duration time.Duration) (string, error)
RenewUpdateLease renews the indicated update lease for the given duration.
func (*Client) StartUpdate ¶
func (pc *Client) StartUpdate(ctx context.Context, update UpdateIdentifier, tags map[apitype.StackTagName]string) (int, string, error)
StartUpdate starts the indicated update. It returns the new version of the update's target stack and the token used to authenticate operations on the update if any. Replaces the stack's tags with the updated set.
func (*Client) UpdateStackTags ¶
func (pc *Client) UpdateStackTags( ctx context.Context, stack StackIdentifier, tags map[apitype.StackTagName]string) error
UpdateStackTags updates the stacks's tags, replacing all existing tags.
type ListStacksFilter ¶
type ListStacksFilter struct { Project *string Organization *string TagName *string TagValue *string }
ListStacksFilter describes optional filters when listing stacks.
type StackIdentifier ¶
StackIdentifier is the set of data needed to identify a Pulumi Cloud stack.
func (StackIdentifier) String ¶
func (s StackIdentifier) String() string
type UpdateIdentifier ¶
type UpdateIdentifier struct { StackIdentifier UpdateKind apitype.UpdateKind UpdateID string }
UpdateIdentifier is the set of data needed to identify an update to a Pulumi Cloud stack.