index library

Classes

AccessToken
Access tokens allow a user to authenticate against the Pulumi Cloud.
AccessTokenArgs
The set of arguments for AccessToken. The set of arguments for AccessToken.
AgentPool
Agent Pool for customer managed deployments.
AgentPoolArgs
The set of arguments for AgentPool. The set of arguments for AgentPool.
ApprovalRule
An approval rule for environment deployments.
ApprovalRuleArgs
The set of arguments for ApprovalRule. The set of arguments for ApprovalRule.
ApprovalRuleConfig
AuthPolicyDefinition
AWSOIDCConfiguration
AzureOIDCConfiguration
BuildAllowPermissionsArgs
Arguments for buildAllowPermissions. Arguments for buildAllowPermissions.
BuildAllowPermissionsResult
Result data returned by buildAllowPermissions.
BuildEnvironmentScopedPermissionsArgs
Arguments for buildEnvironmentScopedPermissions. Arguments for buildEnvironmentScopedPermissions.
BuildEnvironmentScopedPermissionsResult
Result data returned by buildEnvironmentScopedPermissions.
BuildInsightsAccountScopedPermissionsArgs
Arguments for buildInsightsAccountScopedPermissions. Arguments for buildInsightsAccountScopedPermissions.
BuildInsightsAccountScopedPermissionsResult
Result data returned by buildInsightsAccountScopedPermissions.
BuildStackScopedPermissionsArgs
Arguments for buildStackScopedPermissions. Arguments for buildStackScopedPermissions.
BuildStackScopedPermissionsResult
Result data returned by buildStackScopedPermissions.
DeploymentSchedule
A scheduled recurring or single time run of a pulumi command.
DeploymentScheduleArgs
The set of arguments for DeploymentSchedule. The set of arguments for DeploymentSchedule.
DeploymentSettings
Deployment settings configure Pulumi Deployments for a stack.
DeploymentSettingsArgs
The set of arguments for DeploymentSettings. The set of arguments for DeploymentSettings.
DeploymentSettingsCacheOptions
Dependency cache settings for the deployment
DeploymentSettingsExecutorContext
The executor context defines information about the executor where the deployment is executed. If unspecified, the default 'pulumi/pulumi' image is used.
DeploymentSettingsGitAuthBasicAuth
Git source settings for a deployment.
DeploymentSettingsGitAuthSSHAuth
Git source settings for a deployment.
DeploymentSettingsGithub
GitHub settings for the deployment.
DeploymentSettingsGitSource
Git source settings for a deployment.
DeploymentSettingsGitSourceGitAuth
Git source settings for a deployment.
DeploymentSettingsOperationContext
Settings related to the Pulumi operation environment during the deployment.
DeploymentSettingsSourceContext
Settings related to the source of the deployment.
DeploymentSettingsVcs
VCS settings for the deployment, supporting multiple VCS providers.
DriftSchedule
A cron schedule to run drift detection.
DriftScheduleArgs
The set of arguments for DriftSchedule. The set of arguments for DriftSchedule.
EligibleApprover
Environment
An ESC Environment.
EnvironmentArgs
The set of arguments for Environment. The set of arguments for Environment.
EnvironmentIdentifier
EnvironmentRotationSchedule
A scheduled recurring or single time environment rotation.
EnvironmentRotationScheduleArgs
The set of arguments for EnvironmentRotationSchedule. The set of arguments for EnvironmentRotationSchedule.
EnvironmentVersionTag
A tag on a specific revision of an environment.
EnvironmentVersionTagArgs
The set of arguments for EnvironmentVersionTag. The set of arguments for EnvironmentVersionTag.
GCPOIDCConfiguration
GetCurrentUserResult
Result data returned by getCurrentUser.
GetEnvironmentArgs
Arguments for getEnvironment. Arguments for getEnvironment.
GetEnvironmentResult
Result data returned by getEnvironment.
GetInsightsAccountArgs
Arguments for getInsightsAccount. Arguments for getInsightsAccount.
GetInsightsAccountResult
Result data returned by getInsightsAccount.
GetInsightsAccountsArgs
Arguments for getInsightsAccounts. Arguments for getInsightsAccounts.
GetInsightsAccountsResult
Result data returned by getInsightsAccounts.
GetOrganizationMemberArgs
Arguments for getOrganizationMember. Arguments for getOrganizationMember.
GetOrganizationMemberResult
Result data returned by getOrganizationMember.
GetOrganizationMembersArgs
Arguments for getOrganizationMembers. Arguments for getOrganizationMembers.
GetOrganizationMembersResult
Result data returned by getOrganizationMembers.
GetOrganizationRoleScopesArgs
Arguments for getOrganizationRoleScopes. Arguments for getOrganizationRoleScopes.
GetOrganizationRoleScopesResult
Result data returned by getOrganizationRoleScopes.
GetPolicyPackArgs
Arguments for getPolicyPack. Arguments for getPolicyPack.
GetPolicyPackResult
Result data returned by getPolicyPack.
GetPolicyPacksArgs
Arguments for getPolicyPacks. Arguments for getPolicyPacks.
GetPolicyPacksResult
Result data returned by getPolicyPacks.
InsightsAccount
Insights Account for cloud resource scanning and analysis across AWS, Azure, and GCP.
InsightsAccountArgs
The set of arguments for InsightsAccount. The set of arguments for InsightsAccount.
InsightsAccountState
OidcIssuer
Register an OIDC Provider to establish a trust relationship between third-party systems like GitHub Actions and Pulumi Cloud, obviating the need to store a hard-coded Pulumi Cloud token in systems that need to run Pulumi commands or consume Pulumi Cloud APIs. Instead of a hard-coded, static token that must be manually rotated, trusted systems are granted temporary Pulumi Cloud tokens on an as-needed basis, which is more secure than static tokens.
OidcIssuerArgs
The set of arguments for OidcIssuer. The set of arguments for OidcIssuer.
OperationContextOIDC
OperationContextOptions
OrgAccessToken
The Pulumi Cloud allows users to create access tokens scoped to orgs. Org access tokens is a resource to create them and assign them to an org
OrgAccessTokenArgs
The set of arguments for OrgAccessToken. The set of arguments for OrgAccessToken.
OrganizationMember
Manages a user's membership in a Pulumi Cloud organization and their assigned role. The user must already have a Pulumi Cloud account before they can be added. Custom (fine-grained) roles are assigned by setting roleId; built-in roles are assigned by setting role. When both are set, roleId takes precedence.
OrganizationMemberArgs
The set of arguments for OrganizationMember. The set of arguments for OrganizationMember.
OrganizationMemberInfo
OrganizationRole
A custom (fine-grained) role defined on a Pulumi Cloud organization. Custom roles allow precise permission control beyond the built-in admin / member / billing-manager roles. Assign them to members via the OrganizationMember.roleId field or to teams via TeamRoleAssignment.
OrganizationRoleArgs
The set of arguments for OrganizationRole. The set of arguments for OrganizationRole.
PolicyGroup
A Policy Group allows you to apply policy packs to a set of stacks in your organization.
PolicyGroupArgs
The set of arguments for PolicyGroup. The set of arguments for PolicyGroup.
PolicyGroupPolicyPackReference
A reference to a policy pack within a policy group.
PolicyGroupPolicyPackReferenceInput
A reference to a policy pack within a policy group (input).
PolicyGroupStackReference
A reference to a stack within a policy group.
PolicyPack
A Policy Pack published to Pulumi Cloud. The source directory is tarballed and uploaded on Create; changing source content publishes a new version (replace).
PolicyPackArgs
The set of arguments for PolicyPack. The set of arguments for PolicyPack.
PolicyPackComplianceFrameworkInput
PolicyPackPolicyInput
RoleScopeInfo
Stack
A stack is a collection of resources that share a common lifecycle. Stacks are uniquely identified by their name and the project they belong to.
StackArgs
The set of arguments for Stack. The set of arguments for Stack.
StackTag
Stacks have associated metadata in the form of tags. Each tag consists of a name and value.
StackTagArgs
The set of arguments for StackTag. The set of arguments for StackTag.
StackTags
Manages a set of stack tags as a single resource via a tags map, instead of one StackTag per key — useful for YAML programs.
StackTagsArgs
The set of arguments for StackTags. The set of arguments for StackTags.
Team
The Pulumi Cloud offers role-based access control (RBAC) using teams. Teams allow organization admins to assign a set of stack permissions to a group of users.
TeamAccessToken
The Pulumi Cloud allows users to create access tokens scoped to team. Team access tokens is a resource to create them and assign them to a team
TeamAccessTokenArgs
The set of arguments for TeamAccessToken. The set of arguments for TeamAccessToken.
TeamArgs
The set of arguments for Team. The set of arguments for Team.
TeamEnvironmentPermission
A permission for a team to use an environment.
TeamEnvironmentPermissionArgs
The set of arguments for TeamEnvironmentPermission. The set of arguments for TeamEnvironmentPermission.
TeamRoleAssignment
Assigns a custom (fine-grained) role to a Pulumi Cloud team. The Pulumi Cloud API currently supports one role per team; creating a second assignment replaces the first. The team's organization must already have the custom-roles feature enabled.
TeamRoleAssignmentArgs
The set of arguments for TeamRoleAssignment. The set of arguments for TeamRoleAssignment.
TeamStackPermission
Grants a team permissions to the specified stack.
TeamStackPermissionArgs
The set of arguments for TeamStackPermission. The set of arguments for TeamStackPermission.
TemplateSource
A source for Pulumi templates.
TemplateSourceArgs
The set of arguments for TemplateSource. The set of arguments for TemplateSource.
TemplateSourceDestination
TtlSchedule
A scheduled stack destroy run.
TtlScheduleArgs
The set of arguments for TtlSchedule. The set of arguments for TtlSchedule.
Webhook
Pulumi Webhooks allow you to notify external services of events happening within your Pulumi organization or stack. For example, you can trigger a notification whenever a stack is updated. Whenever an event occurs, Pulumi will send an HTTP POST request to all registered webhooks. The webhook can then be used to emit some notification, start running integration tests, or even update additional stacks.
WebhookArgs
The set of arguments for Webhook. The set of arguments for Webhook.

Functions

buildAllowPermissions(BuildAllowPermissionsArgs args, {InvokeOptions? options}) → Future<BuildAllowPermissionsResult>
Builds an OrganizationRole.permissions descriptor that grants the supplied scopes globally — i.e. on every entity of the matching resource type. This is the simplest descriptor: a flat PermissionDescriptorAllow. Use this helper instead of hand-authoring the descriptor literal so the wire-format __type discriminator stays an implementation detail. For grants scoped to a specific entity, see buildEnvironmentScopedPermissions, buildStackScopedPermissions, or buildInsightsAccountScopedPermissions. The result is directly assignable to OrganizationRole.permissions. To grant scopes on more than one entity in a single role, hand-roll a PermissionDescriptorGroup whose entries list pulls the output of each helper. args Arguments passed to this invoke. Arguments for buildAllowPermissions. options Invoke options controlling this call.
buildEnvironmentScopedPermissions(BuildEnvironmentScopedPermissionsArgs args, {InvokeOptions? options}) → Future<BuildEnvironmentScopedPermissionsResult>
Builds an OrganizationRole.permissions descriptor that grants the supplied scopes only on the named environment. Pair with Environment.environmentId (or the getEnvironment data source) to avoid hand-rolling the PermissionDescriptorCondition tree yourself. The result is directly assignable to OrganizationRole.permissions. To grant scopes on more than one entity in a single role, hand-roll a PermissionDescriptorGroup whose entries list pulls the output of each helper. args Arguments passed to this invoke. Arguments for buildEnvironmentScopedPermissions. options Invoke options controlling this call.
buildInsightsAccountScopedPermissions(BuildInsightsAccountScopedPermissionsArgs args, {InvokeOptions? options}) → Future<BuildInsightsAccountScopedPermissionsResult>
Builds an OrganizationRole.permissions descriptor that grants the supplied scopes only on the named insights account. Pair with InsightsAccount.insightsAccountId (or the getInsightsAccount data source). The result is directly assignable to OrganizationRole.permissions. To grant scopes on more than one entity in a single role, hand-roll a PermissionDescriptorGroup whose entries list pulls the output of each helper. args Arguments passed to this invoke. Arguments for buildInsightsAccountScopedPermissions. options Invoke options controlling this call.
buildStackScopedPermissions(BuildStackScopedPermissionsArgs args, {InvokeOptions? options}) → Future<BuildStackScopedPermissionsResult>
Builds an OrganizationRole.permissions descriptor that grants the supplied scopes only on the named stack. The stackId is the stack's opaque Pulumi Cloud identifier — distinct from the organization/project/stack triple. The result is directly assignable to OrganizationRole.permissions. To grant scopes on more than one entity in a single role, hand-roll a PermissionDescriptorGroup whose entries list pulls the output of each helper. args Arguments passed to this invoke. Arguments for buildStackScopedPermissions. options Invoke options controlling this call.
getCurrentUser({InvokeOptions? options}) → Future<GetCurrentUserResult>
Returns the Pulumi Cloud user that the provider's access token belongs to. Useful for seeding a newly-created Team with the creator as a member, since Pulumi Cloud auto-adds the creator. Omitting this user from the team will result in a refresh drift. options Invoke options controlling this call.
getEnvironment(GetEnvironmentArgs args, {InvokeOptions? options}) → Future<GetEnvironmentResult>
Looks up an existing ESC environment by name and returns its UUID. Use this to scope a custom RBAC role to a specific environment — pass the returned UUID into buildEnvironmentScopedPermissions, or use it as the identity field of a hand-rolled PermissionLiteralExpressionEnvironment in OrganizationRole.permissions. Errors when the environment is not found. args Arguments passed to this invoke. Arguments for getEnvironment. options Invoke options controlling this call.
getInsightsAccount(GetInsightsAccountArgs args, {InvokeOptions? options}) → Future<GetInsightsAccountResult>
Get details about a specific Insights account. args Arguments passed to this invoke. Arguments for getInsightsAccount. options Invoke options controlling this call.
getInsightsAccounts(GetInsightsAccountsArgs args, {InvokeOptions? options}) → Future<GetInsightsAccountsResult>
Get a list of all Insights accounts for an organization. args Arguments passed to this invoke. Arguments for getInsightsAccounts. options Invoke options controlling this call.
getOrganizationMember(GetOrganizationMemberArgs args, {InvokeOptions? options}) → Future<GetOrganizationMemberResult>
Looks up a single member of a Pulumi Cloud organization by username (the backing identity-provider login, e.g. GitHub login). Returns an error when the member is not found. args Arguments passed to this invoke. Arguments for getOrganizationMember. options Invoke options controlling this call.
getOrganizationMembers(GetOrganizationMembersArgs args, {InvokeOptions? options}) → Future<GetOrganizationMembersResult>
Lists all members of a Pulumi Cloud organization, including their role assignments. Merges Pulumi Cloud's identity-provider roster (paginated; includes users who haven't signed in to Pulumi yet) with the seat-count roster, deduped by username, so SAML- and non-SAML-provisioned members both appear regardless of which roster they're tracked in. args Arguments passed to this invoke. Arguments for getOrganizationMembers. options Invoke options controlling this call.
getOrganizationRoleScopes(GetOrganizationRoleScopesArgs args, {InvokeOptions? options}) → Future<GetOrganizationRoleScopesResult>
Lists the permission scopes available for custom roles in an organization. Use this to discover valid scope names before setting OrganizationRole.permissions. The catalogue is flattened into a single list with resource type and group context, sorted deterministically. args Arguments passed to this invoke. Arguments for getOrganizationRoleScopes. options Invoke options controlling this call.
getPolicyPack(GetPolicyPackArgs args, {InvokeOptions? options}) → Future<GetPolicyPackResult>
Get details about a specific version of a policy pack. args Arguments passed to this invoke. Arguments for getPolicyPack. options Invoke options controlling this call.
getPolicyPacks(GetPolicyPacksArgs args, {InvokeOptions? options}) → Future<GetPolicyPacksResult>
Get a list of all policy packs for an organization. args Arguments passed to this invoke. Arguments for getPolicyPacks. options Invoke options controlling this call.