Pulumi Service v0.7.2, May 25 23

pulumiservice.DeploymentSettings

Explore with Pulumi AI

Deployment settings configure Pulumi Deployments for a stack.

Import

Deployment settings can be imported using the id, which for deployment settings is {org}/{project}/{stack} e.g.,

 $ pulumi import pulumiservice:index:DeploymentSettings my_settings my-org/my-project/my-stack

Create DeploymentSettings Resource

new DeploymentSettings(name: string, args: DeploymentSettingsArgs, opts?: CustomResourceOptions);

@overload
def DeploymentSettings(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       executor_context: Optional[DeploymentSettingsExecutorContextArgs] = None,
                       github: Optional[DeploymentSettingsGithubArgs] = None,
                       operation_context: Optional[DeploymentSettingsOperationContextArgs] = None,
                       organization: Optional[str] = None,
                       project: Optional[str] = None,
                       source_context: Optional[DeploymentSettingsSourceContextArgs] = None,
                       stack: Optional[str] = None)
@overload
def DeploymentSettings(resource_name: str,
                       args: DeploymentSettingsArgs,
                       opts: Optional[ResourceOptions] = None)

func NewDeploymentSettings(ctx *Context, name string, args DeploymentSettingsArgs, opts ...ResourceOption) (*DeploymentSettings, error)

public DeploymentSettings(string name, DeploymentSettingsArgs args, CustomResourceOptions? opts = null)

public DeploymentSettings(String name, DeploymentSettingsArgs args)
public DeploymentSettings(String name, DeploymentSettingsArgs args, CustomResourceOptions options)

type: pulumiservice:DeploymentSettings
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DeploymentSettingsArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args DeploymentSettingsArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args DeploymentSettingsArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DeploymentSettingsArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DeploymentSettingsArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

DeploymentSettings Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The DeploymentSettings resource accepts the following input properties:

Organization string: Organization name.
Project string: Project name.
SourceContext Pulumi.PulumiService.Inputs.DeploymentSettingsSourceContextArgs: Settings related to the source of the deployment.
Stack string: Stack name.
ExecutorContext Pulumi.PulumiService.Inputs.DeploymentSettingsExecutorContextArgs: Settings related to the deployment executor.
Github Pulumi.PulumiService.Inputs.DeploymentSettingsGithubArgs: GitHub settings for the deployment.
OperationContext Pulumi.PulumiService.Inputs.DeploymentSettingsOperationContextArgs: Settings related to the Pulumi operation environment during the deployment.

Organization string: Organization name.
Project string: Project name.
SourceContext DeploymentSettingsSourceContextArgs: Settings related to the source of the deployment.
Stack string: Stack name.
ExecutorContext DeploymentSettingsExecutorContextArgs: Settings related to the deployment executor.
Github DeploymentSettingsGithubArgs: GitHub settings for the deployment.
OperationContext DeploymentSettingsOperationContextArgs: Settings related to the Pulumi operation environment during the deployment.

organization String: Organization name.
project String: Project name.
sourceContext DeploymentSettingsSourceContextArgs: Settings related to the source of the deployment.
stack String: Stack name.
executorContext DeploymentSettingsExecutorContextArgs: Settings related to the deployment executor.
github DeploymentSettingsGithubArgs: GitHub settings for the deployment.
operationContext DeploymentSettingsOperationContextArgs: Settings related to the Pulumi operation environment during the deployment.

organization string: Organization name.
project string: Project name.
sourceContext DeploymentSettingsSourceContextArgs: Settings related to the source of the deployment.
stack string: Stack name.
executorContext DeploymentSettingsExecutorContextArgs: Settings related to the deployment executor.
github DeploymentSettingsGithubArgs: GitHub settings for the deployment.
operationContext DeploymentSettingsOperationContextArgs: Settings related to the Pulumi operation environment during the deployment.

organization str: Organization name.
project str: Project name.
source_context DeploymentSettingsSourceContextArgs: Settings related to the source of the deployment.
stack str: Stack name.
executor_context DeploymentSettingsExecutorContextArgs: Settings related to the deployment executor.
github DeploymentSettingsGithubArgs: GitHub settings for the deployment.
operation_context DeploymentSettingsOperationContextArgs: Settings related to the Pulumi operation environment during the deployment.

organization String: Organization name.
project String: Project name.
sourceContext Property Map: Settings related to the source of the deployment.
stack String: Stack name.
executorContext Property Map: Settings related to the deployment executor.
github Property Map: GitHub settings for the deployment.
operationContext Property Map: Settings related to the Pulumi operation environment during the deployment.

Outputs

All input properties are implicitly available as output properties. Additionally, the DeploymentSettings resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Supporting Types

AWSOIDCConfiguration

RoleARN string: The ARN of the role to assume using the OIDC token.
SessionName string: The name of the assume-role session.
Duration string: Duration of the assume-role session in “XhYmZs” format
PolicyARNs List<string>: Optional set of IAM policy ARNs that further restrict the assume-role session

RoleARN string: The ARN of the role to assume using the OIDC token.
SessionName string: The name of the assume-role session.
Duration string: Duration of the assume-role session in “XhYmZs” format
PolicyARNs []string: Optional set of IAM policy ARNs that further restrict the assume-role session

roleARN String: The ARN of the role to assume using the OIDC token.
sessionName String: The name of the assume-role session.
duration String: Duration of the assume-role session in “XhYmZs” format
policyARNs List<String>: Optional set of IAM policy ARNs that further restrict the assume-role session

roleARN string: The ARN of the role to assume using the OIDC token.
sessionName string: The name of the assume-role session.
duration string: Duration of the assume-role session in “XhYmZs” format
policyARNs string[]: Optional set of IAM policy ARNs that further restrict the assume-role session

role_arn str: The ARN of the role to assume using the OIDC token.
session_name str: The name of the assume-role session.
duration str: Duration of the assume-role session in “XhYmZs” format
policy_arns Sequence[str]: Optional set of IAM policy ARNs that further restrict the assume-role session

roleARN String: The ARN of the role to assume using the OIDC token.
sessionName String: The name of the assume-role session.
duration String: Duration of the assume-role session in “XhYmZs” format
policyARNs List<String>: Optional set of IAM policy ARNs that further restrict the assume-role session

AzureOIDCConfiguration

ClientId string: The client ID of the federated workload identity.
SubscriptionId string: The subscription ID of the federated workload identity.
TenantId string: The tenant ID of the federated workload identity.

ClientId string: The client ID of the federated workload identity.
SubscriptionId string: The subscription ID of the federated workload identity.
TenantId string: The tenant ID of the federated workload identity.

clientId String: The client ID of the federated workload identity.
subscriptionId String: The subscription ID of the federated workload identity.
tenantId String: The tenant ID of the federated workload identity.

clientId string: The client ID of the federated workload identity.
subscriptionId string: The subscription ID of the federated workload identity.
tenantId string: The tenant ID of the federated workload identity.

client_id str: The client ID of the federated workload identity.
subscription_id str: The subscription ID of the federated workload identity.
tenant_id str: The tenant ID of the federated workload identity.

clientId String: The client ID of the federated workload identity.
subscriptionId String: The subscription ID of the federated workload identity.
tenantId String: The tenant ID of the federated workload identity.

DeploymentSettingsExecutorContext

ExecutorImage string: Allows overriding the default executor image with a custom image. E.g. 'pulumi/pulumi-nodejs:latest'

ExecutorImage string: Allows overriding the default executor image with a custom image. E.g. 'pulumi/pulumi-nodejs:latest'

executorImage String: Allows overriding the default executor image with a custom image. E.g. 'pulumi/pulumi-nodejs:latest'

executorImage string: Allows overriding the default executor image with a custom image. E.g. 'pulumi/pulumi-nodejs:latest'

executor_image str: Allows overriding the default executor image with a custom image. E.g. 'pulumi/pulumi-nodejs:latest'

executorImage String: Allows overriding the default executor image with a custom image. E.g. 'pulumi/pulumi-nodejs:latest'

DeploymentSettingsGitAuthBasicAuth

Password string: Password for git basic authentication.
Username string: User name for git basic authentication.

Password string: Password for git basic authentication.
Username string: User name for git basic authentication.

password String: Password for git basic authentication.
username String: User name for git basic authentication.

password string: Password for git basic authentication.
username string: User name for git basic authentication.

password str: Password for git basic authentication.
username str: User name for git basic authentication.

password String: Password for git basic authentication.
username String: User name for git basic authentication.

DeploymentSettingsGitAuthSSHAuth

SshPrivateKey string: SSH private key.
Password string: Optional password for SSH authentication.

SshPrivateKey string: SSH private key.
Password string: Optional password for SSH authentication.

sshPrivateKey String: SSH private key.
password String: Optional password for SSH authentication.

sshPrivateKey string: SSH private key.
password string: Optional password for SSH authentication.

ssh_private_key str: SSH private key.
password str: Optional password for SSH authentication.

sshPrivateKey String: SSH private key.
password String: Optional password for SSH authentication.

DeploymentSettingsGitSource

Branch string: The branch to deploy. One of either branch or commit must be specified.
Commit string: The commit to deploy. One of either branch or commit must be specified.
GitAuth Pulumi.PulumiService.Inputs.DeploymentSettingsGitSourceGitAuth: Git authentication configuration for this deployment. Should not be specified if there are gitHub settings for this deployment.
RepoDir string: The directory within the repository where the Pulumi.yaml is located.
RepoUrl string: The repository URL to use for git settings. Should not be specified if there are gitHub settings for this deployment.

Branch string: The branch to deploy. One of either branch or commit must be specified.
Commit string: The commit to deploy. One of either branch or commit must be specified.
GitAuth DeploymentSettingsGitSourceGitAuth: Git authentication configuration for this deployment. Should not be specified if there are gitHub settings for this deployment.
RepoDir string: The directory within the repository where the Pulumi.yaml is located.
RepoUrl string: The repository URL to use for git settings. Should not be specified if there are gitHub settings for this deployment.

branch String: The branch to deploy. One of either branch or commit must be specified.
commit String: The commit to deploy. One of either branch or commit must be specified.
gitAuth DeploymentSettingsGitSourceGitAuth: Git authentication configuration for this deployment. Should not be specified if there are gitHub settings for this deployment.
repoDir String: The directory within the repository where the Pulumi.yaml is located.
repoUrl String: The repository URL to use for git settings. Should not be specified if there are gitHub settings for this deployment.

branch string: The branch to deploy. One of either branch or commit must be specified.
commit string: The commit to deploy. One of either branch or commit must be specified.
gitAuth DeploymentSettingsGitSourceGitAuth: Git authentication configuration for this deployment. Should not be specified if there are gitHub settings for this deployment.
repoDir string: The directory within the repository where the Pulumi.yaml is located.
repoUrl string: The repository URL to use for git settings. Should not be specified if there are gitHub settings for this deployment.

branch str: The branch to deploy. One of either branch or commit must be specified.
commit str: The commit to deploy. One of either branch or commit must be specified.
git_auth DeploymentSettingsGitSourceGitAuth: Git authentication configuration for this deployment. Should not be specified if there are gitHub settings for this deployment.
repo_dir str: The directory within the repository where the Pulumi.yaml is located.
repo_url str: The repository URL to use for git settings. Should not be specified if there are gitHub settings for this deployment.

branch String: The branch to deploy. One of either branch or commit must be specified.
commit String: The commit to deploy. One of either branch or commit must be specified.
gitAuth Property Map: Git authentication configuration for this deployment. Should not be specified if there are gitHub settings for this deployment.
repoDir String: The directory within the repository where the Pulumi.yaml is located.
repoUrl String: The repository URL to use for git settings. Should not be specified if there are gitHub settings for this deployment.

DeploymentSettingsGitSourceGitAuth

BasicAuth Pulumi.PulumiService.Inputs.DeploymentSettingsGitAuthBasicAuth: Basic auth for git authentication. Only one of personalAccessToken, sshAuth, or basicAuth must be defined.
SshAuth Pulumi.PulumiService.Inputs.DeploymentSettingsGitAuthSSHAuth: SSH auth for git authentication. Only one of personalAccessToken, sshAuth, or basicAuth must be defined.

BasicAuth DeploymentSettingsGitAuthBasicAuth: Basic auth for git authentication. Only one of personalAccessToken, sshAuth, or basicAuth must be defined.
SshAuth DeploymentSettingsGitAuthSSHAuth: SSH auth for git authentication. Only one of personalAccessToken, sshAuth, or basicAuth must be defined.

basicAuth DeploymentSettingsGitAuthBasicAuth: Basic auth for git authentication. Only one of personalAccessToken, sshAuth, or basicAuth must be defined.
sshAuth DeploymentSettingsGitAuthSSHAuth: SSH auth for git authentication. Only one of personalAccessToken, sshAuth, or basicAuth must be defined.

basicAuth DeploymentSettingsGitAuthBasicAuth: Basic auth for git authentication. Only one of personalAccessToken, sshAuth, or basicAuth must be defined.
sshAuth DeploymentSettingsGitAuthSSHAuth: SSH auth for git authentication. Only one of personalAccessToken, sshAuth, or basicAuth must be defined.

basic_auth DeploymentSettingsGitAuthBasicAuth: Basic auth for git authentication. Only one of personalAccessToken, sshAuth, or basicAuth must be defined.
ssh_auth DeploymentSettingsGitAuthSSHAuth: SSH auth for git authentication. Only one of personalAccessToken, sshAuth, or basicAuth must be defined.

basicAuth Property Map: Basic auth for git authentication. Only one of personalAccessToken, sshAuth, or basicAuth must be defined.
sshAuth Property Map: SSH auth for git authentication. Only one of personalAccessToken, sshAuth, or basicAuth must be defined.

DeploymentSettingsGithub

DeployCommits bool: Trigger a deployment running pulumi up on commit.
Paths List<string>: The paths within the repo that deployments should be filtered to.
PreviewPullRequests bool: Trigger a deployment running pulumi preview when a PR is opened.
Repository string: The GitHub repository in the format org/repo.

DeployCommits bool: Trigger a deployment running pulumi up on commit.
Paths []string: The paths within the repo that deployments should be filtered to.
PreviewPullRequests bool: Trigger a deployment running pulumi preview when a PR is opened.
Repository string: The GitHub repository in the format org/repo.

deployCommits Boolean: Trigger a deployment running pulumi up on commit.
paths List<String>: The paths within the repo that deployments should be filtered to.
previewPullRequests Boolean: Trigger a deployment running pulumi preview when a PR is opened.
repository String: The GitHub repository in the format org/repo.

deployCommits boolean: Trigger a deployment running pulumi up on commit.
paths string[]: The paths within the repo that deployments should be filtered to.
previewPullRequests boolean: Trigger a deployment running pulumi preview when a PR is opened.
repository string: The GitHub repository in the format org/repo.

deploy_commits bool: Trigger a deployment running pulumi up on commit.
paths Sequence[str]: The paths within the repo that deployments should be filtered to.
preview_pull_requests bool: Trigger a deployment running pulumi preview when a PR is opened.
repository str: The GitHub repository in the format org/repo.

deployCommits Boolean: Trigger a deployment running pulumi up on commit.
paths List<String>: The paths within the repo that deployments should be filtered to.
previewPullRequests Boolean: Trigger a deployment running pulumi preview when a PR is opened.
repository String: The GitHub repository in the format org/repo.

DeploymentSettingsOperationContext

EnvironmentVariables Dictionary<string, string>: Environment variables to set for the deployment.
Oidc Pulumi.PulumiService.Inputs.OperationContextOIDC: OIDC configuration to use during the deployment.
Options Pulumi.PulumiService.Inputs.OperationContextOptions: Options to override default behavior during the deployment.
PreRunCommands List<string>: Shell commands to run before the Pulumi operation executes.

EnvironmentVariables map[string]string: Environment variables to set for the deployment.
Oidc OperationContextOIDC: OIDC configuration to use during the deployment.
Options OperationContextOptions: Options to override default behavior during the deployment.
PreRunCommands []string: Shell commands to run before the Pulumi operation executes.

environmentVariables Map<String,String>: Environment variables to set for the deployment.
oidc OperationContextOIDC: OIDC configuration to use during the deployment.
options OperationContextOptions: Options to override default behavior during the deployment.
preRunCommands List<String>: Shell commands to run before the Pulumi operation executes.

environmentVariables {[key: string]: string}: Environment variables to set for the deployment.
oidc OperationContextOIDC: OIDC configuration to use during the deployment.
options OperationContextOptions: Options to override default behavior during the deployment.
preRunCommands string[]: Shell commands to run before the Pulumi operation executes.

environment_variables Mapping[str, str]: Environment variables to set for the deployment.
oidc OperationContextOIDC: OIDC configuration to use during the deployment.
options OperationContextOptions: Options to override default behavior during the deployment.
pre_run_commands Sequence[str]: Shell commands to run before the Pulumi operation executes.

environmentVariables Map<String>: Environment variables to set for the deployment.
oidc Property Map: OIDC configuration to use during the deployment.
options Property Map: Options to override default behavior during the deployment.
preRunCommands List<String>: Shell commands to run before the Pulumi operation executes.

DeploymentSettingsSourceContext

Git Pulumi.PulumiService.Inputs.DeploymentSettingsGitSource: Git source settings for a deployment.

Git DeploymentSettingsGitSource: Git source settings for a deployment.

git DeploymentSettingsGitSource: Git source settings for a deployment.

git DeploymentSettingsGitSource: Git source settings for a deployment.

git DeploymentSettingsGitSource: Git source settings for a deployment.

git Property Map: Git source settings for a deployment.

GCPOIDCConfiguration

ProjectId string: The numerical ID of the GCP project.
ProviderId string: The ID of the identity provider associated with the workload pool.
ServiceAccount string: The email address of the service account to use.
WorkloadPoolId string: The ID of the workload pool to use.
Region string: The region of the GCP project.
TokenLifetime string: The lifetime of the temporary credentials in “XhYmZs” format.

ProjectId string: The numerical ID of the GCP project.
ProviderId string: The ID of the identity provider associated with the workload pool.
ServiceAccount string: The email address of the service account to use.
WorkloadPoolId string: The ID of the workload pool to use.
Region string: The region of the GCP project.
TokenLifetime string: The lifetime of the temporary credentials in “XhYmZs” format.

projectId String: The numerical ID of the GCP project.
providerId String: The ID of the identity provider associated with the workload pool.
serviceAccount String: The email address of the service account to use.
workloadPoolId String: The ID of the workload pool to use.
region String: The region of the GCP project.
tokenLifetime String: The lifetime of the temporary credentials in “XhYmZs” format.

projectId string: The numerical ID of the GCP project.
providerId string: The ID of the identity provider associated with the workload pool.
serviceAccount string: The email address of the service account to use.
workloadPoolId string: The ID of the workload pool to use.
region string: The region of the GCP project.
tokenLifetime string: The lifetime of the temporary credentials in “XhYmZs” format.

project_id str: The numerical ID of the GCP project.
provider_id str: The ID of the identity provider associated with the workload pool.
service_account str: The email address of the service account to use.
workload_pool_id str: The ID of the workload pool to use.
region str: The region of the GCP project.
token_lifetime str: The lifetime of the temporary credentials in “XhYmZs” format.

projectId String: The numerical ID of the GCP project.
providerId String: The ID of the identity provider associated with the workload pool.
serviceAccount String: The email address of the service account to use.
workloadPoolId String: The ID of the workload pool to use.
region String: The region of the GCP project.
tokenLifetime String: The lifetime of the temporary credentials in “XhYmZs” format.

OperationContextOIDC

Aws Pulumi.PulumiService.Inputs.AWSOIDCConfiguration: AWS-specific OIDC configuration.
Azure Pulumi.PulumiService.Inputs.AzureOIDCConfiguration: Azure-specific OIDC configuration.
Gcp Pulumi.PulumiService.Inputs.GCPOIDCConfiguration: GCP-specific OIDC configuration.

Aws AWSOIDCConfiguration: AWS-specific OIDC configuration.
Azure AzureOIDCConfiguration: Azure-specific OIDC configuration.
Gcp GCPOIDCConfiguration: GCP-specific OIDC configuration.

aws AWSOIDCConfiguration: AWS-specific OIDC configuration.
azure AzureOIDCConfiguration: Azure-specific OIDC configuration.
gcp GCPOIDCConfiguration: GCP-specific OIDC configuration.

aws AWSOIDCConfiguration: AWS-specific OIDC configuration.
azure AzureOIDCConfiguration: Azure-specific OIDC configuration.
gcp GCPOIDCConfiguration: GCP-specific OIDC configuration.

aws AWSOIDCConfiguration: AWS-specific OIDC configuration.
azure AzureOIDCConfiguration: Azure-specific OIDC configuration.
gcp GCPOIDCConfiguration: GCP-specific OIDC configuration.

aws Property Map: AWS-specific OIDC configuration.
azure Property Map: Azure-specific OIDC configuration.
gcp Property Map: GCP-specific OIDC configuration.

OperationContextOptions

Shell string: The shell to use to run commands during the deployment. Defaults to 'bash'.
SkipInstallDependencies bool: Skip the default dependency installation step - use this to customize the dependency installation (e.g. if using yarn or poetry)

Shell string: The shell to use to run commands during the deployment. Defaults to 'bash'.
SkipInstallDependencies bool: Skip the default dependency installation step - use this to customize the dependency installation (e.g. if using yarn or poetry)

shell String: The shell to use to run commands during the deployment. Defaults to 'bash'.
skipInstallDependencies Boolean: Skip the default dependency installation step - use this to customize the dependency installation (e.g. if using yarn or poetry)

shell string: The shell to use to run commands during the deployment. Defaults to 'bash'.
skipInstallDependencies boolean: Skip the default dependency installation step - use this to customize the dependency installation (e.g. if using yarn or poetry)

shell str: The shell to use to run commands during the deployment. Defaults to 'bash'.
skip_install_dependencies bool: Skip the default dependency installation step - use this to customize the dependency installation (e.g. if using yarn or poetry)

shell String: The shell to use to run commands during the deployment. Defaults to 'bash'.
skipInstallDependencies Boolean: Skip the default dependency installation step - use this to customize the dependency installation (e.g. if using yarn or poetry)

Package Details

Repository: pulumiservice pulumi/pulumi-pulumiservice
License: Apache-2.0