Pulumi Service v0.7.2, May 25 23
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.
- Source
Context Pulumi.Pulumi Service. Inputs. Deployment Settings Source Context Args Settings related to the source of the deployment.
- Stack string
Stack name.
- Executor
Context Pulumi.Pulumi Service. Inputs. Deployment Settings Executor Context Args Settings related to the deployment executor.
- Github
Pulumi.
Pulumi Service. Inputs. Deployment Settings Github Args GitHub settings for the deployment.
- Operation
Context Pulumi.Pulumi Service. Inputs. Deployment Settings Operation Context Args Settings related to the Pulumi operation environment during the deployment.
- Organization string
Organization name.
- Project string
Project name.
- Source
Context DeploymentSettings Source Context Args Settings related to the source of the deployment.
- Stack string
Stack name.
- Executor
Context DeploymentSettings Executor Context Args Settings related to the deployment executor.
- Github
Deployment
Settings Github Args GitHub settings for the deployment.
- Operation
Context DeploymentSettings Operation Context Args Settings related to the Pulumi operation environment during the deployment.
- organization String
Organization name.
- project String
Project name.
- source
Context DeploymentSettings Source Context Args Settings related to the source of the deployment.
- stack String
Stack name.
- executor
Context DeploymentSettings Executor Context Args Settings related to the deployment executor.
- github
Deployment
Settings Github Args GitHub settings for the deployment.
- operation
Context DeploymentSettings Operation Context Args Settings related to the Pulumi operation environment during the deployment.
- organization string
Organization name.
- project string
Project name.
- source
Context DeploymentSettings Source Context Args Settings related to the source of the deployment.
- stack string
Stack name.
- executor
Context DeploymentSettings Executor Context Args Settings related to the deployment executor.
- github
Deployment
Settings Github Args GitHub settings for the deployment.
- operation
Context DeploymentSettings Operation Context Args Settings related to the Pulumi operation environment during the deployment.
- organization str
Organization name.
- project str
Project name.
- source_
context DeploymentSettings Source Context Args Settings related to the source of the deployment.
- stack str
Stack name.
- executor_
context DeploymentSettings Executor Context Args Settings related to the deployment executor.
- github
Deployment
Settings Github Args GitHub settings for the deployment.
- operation_
context DeploymentSettings Operation Context Args Settings related to the Pulumi operation environment during the deployment.
- organization String
Organization name.
- project String
Project name.
- source
Context Property Map Settings related to the source of the deployment.
- stack String
Stack name.
- executor
Context Property Map Settings related to the deployment executor.
- github Property Map
GitHub settings for the deployment.
- operation
Context 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
- Role
ARN string The ARN of the role to assume using the OIDC token.
- Session
Name string The name of the assume-role session.
- Duration string
Duration of the assume-role session in “XhYmZs” format
- Policy
ARNs List<string> Optional set of IAM policy ARNs that further restrict the assume-role session
- Role
ARN string The ARN of the role to assume using the OIDC token.
- Session
Name string The name of the assume-role session.
- Duration string
Duration of the assume-role session in “XhYmZs” format
- Policy
ARNs []string Optional set of IAM policy ARNs that further restrict the assume-role session
- role
ARN String The ARN of the role to assume using the OIDC token.
- session
Name String The name of the assume-role session.
- duration String
Duration of the assume-role session in “XhYmZs” format
- policy
ARNs List<String> Optional set of IAM policy ARNs that further restrict the assume-role session
- role
ARN string The ARN of the role to assume using the OIDC token.
- session
Name string The name of the assume-role session.
- duration string
Duration of the assume-role session in “XhYmZs” format
- policy
ARNs 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
- role
ARN String The ARN of the role to assume using the OIDC token.
- session
Name String The name of the assume-role session.
- duration String
Duration of the assume-role session in “XhYmZs” format
- policy
ARNs List<String> Optional set of IAM policy ARNs that further restrict the assume-role session
AzureOIDCConfiguration
- Client
Id string The client ID of the federated workload identity.
- Subscription
Id string The subscription ID of the federated workload identity.
- Tenant
Id string The tenant ID of the federated workload identity.
- Client
Id string The client ID of the federated workload identity.
- Subscription
Id string The subscription ID of the federated workload identity.
- Tenant
Id string The tenant ID of the federated workload identity.
- client
Id String The client ID of the federated workload identity.
- subscription
Id String The subscription ID of the federated workload identity.
- tenant
Id String The tenant ID of the federated workload identity.
- client
Id string The client ID of the federated workload identity.
- subscription
Id string The subscription ID of the federated workload identity.
- tenant
Id 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.
- client
Id String The client ID of the federated workload identity.
- subscription
Id String The subscription ID of the federated workload identity.
- tenant
Id String The tenant ID of the federated workload identity.
DeploymentSettingsExecutorContext
- Executor
Image string Allows overriding the default executor image with a custom image. E.g. 'pulumi/pulumi-nodejs:latest'
- Executor
Image string Allows overriding the default executor image with a custom image. E.g. 'pulumi/pulumi-nodejs:latest'
- executor
Image String Allows overriding the default executor image with a custom image. E.g. 'pulumi/pulumi-nodejs:latest'
- executor
Image 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'
- executor
Image String Allows overriding the default executor image with a custom image. E.g. 'pulumi/pulumi-nodejs:latest'
DeploymentSettingsGitAuthBasicAuth
DeploymentSettingsGitAuthSSHAuth
- Ssh
Private stringKey SSH private key.
- Password string
Optional password for SSH authentication.
- Ssh
Private stringKey SSH private key.
- Password string
Optional password for SSH authentication.
- ssh
Private StringKey SSH private key.
- password String
Optional password for SSH authentication.
- ssh
Private stringKey SSH private key.
- password string
Optional password for SSH authentication.
- ssh_
private_ strkey SSH private key.
- password str
Optional password for SSH authentication.
- ssh
Private StringKey SSH private key.
- password String
Optional password for SSH authentication.
DeploymentSettingsGitSource
- Branch string
The branch to deploy. One of either
branch
orcommit
must be specified.- Commit string
The commit to deploy. One of either
branch
orcommit
must be specified.- Git
Auth Pulumi.Pulumi Service. Inputs. Deployment Settings Git Source Git Auth Git authentication configuration for this deployment. Should not be specified if there are
gitHub
settings for this deployment.- Repo
Dir string The directory within the repository where the Pulumi.yaml is located.
- Repo
Url 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
orcommit
must be specified.- Commit string
The commit to deploy. One of either
branch
orcommit
must be specified.- Git
Auth DeploymentSettings Git Source Git Auth Git authentication configuration for this deployment. Should not be specified if there are
gitHub
settings for this deployment.- Repo
Dir string The directory within the repository where the Pulumi.yaml is located.
- Repo
Url 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
orcommit
must be specified.- commit String
The commit to deploy. One of either
branch
orcommit
must be specified.- git
Auth DeploymentSettings Git Source Git Auth Git authentication configuration for this deployment. Should not be specified if there are
gitHub
settings for this deployment.- repo
Dir String The directory within the repository where the Pulumi.yaml is located.
- repo
Url 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
orcommit
must be specified.- commit string
The commit to deploy. One of either
branch
orcommit
must be specified.- git
Auth DeploymentSettings Git Source Git Auth Git authentication configuration for this deployment. Should not be specified if there are
gitHub
settings for this deployment.- repo
Dir string The directory within the repository where the Pulumi.yaml is located.
- repo
Url 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
orcommit
must be specified.- commit str
The commit to deploy. One of either
branch
orcommit
must be specified.- git_
auth DeploymentSettings Git Source Git Auth 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
orcommit
must be specified.- commit String
The commit to deploy. One of either
branch
orcommit
must be specified.- git
Auth Property Map Git authentication configuration for this deployment. Should not be specified if there are
gitHub
settings for this deployment.- repo
Dir String The directory within the repository where the Pulumi.yaml is located.
- repo
Url String The repository URL to use for git settings. Should not be specified if there are
gitHub
settings for this deployment.
DeploymentSettingsGitSourceGitAuth
- Basic
Auth Pulumi.Pulumi Service. Inputs. Deployment Settings Git Auth Basic Auth Basic auth for git authentication. Only one of
personalAccessToken
,sshAuth
, orbasicAuth
must be defined.- Ssh
Auth Pulumi.Pulumi Service. Inputs. Deployment Settings Git Auth SSHAuth SSH auth for git authentication. Only one of
personalAccessToken
,sshAuth
, orbasicAuth
must be defined.
- Basic
Auth DeploymentSettings Git Auth Basic Auth Basic auth for git authentication. Only one of
personalAccessToken
,sshAuth
, orbasicAuth
must be defined.- Ssh
Auth DeploymentSettings Git Auth SSHAuth SSH auth for git authentication. Only one of
personalAccessToken
,sshAuth
, orbasicAuth
must be defined.
- basic
Auth DeploymentSettings Git Auth Basic Auth Basic auth for git authentication. Only one of
personalAccessToken
,sshAuth
, orbasicAuth
must be defined.- ssh
Auth DeploymentSettings Git Auth SSHAuth SSH auth for git authentication. Only one of
personalAccessToken
,sshAuth
, orbasicAuth
must be defined.
- basic
Auth DeploymentSettings Git Auth Basic Auth Basic auth for git authentication. Only one of
personalAccessToken
,sshAuth
, orbasicAuth
must be defined.- ssh
Auth DeploymentSettings Git Auth SSHAuth SSH auth for git authentication. Only one of
personalAccessToken
,sshAuth
, orbasicAuth
must be defined.
- basic_
auth DeploymentSettings Git Auth Basic Auth Basic auth for git authentication. Only one of
personalAccessToken
,sshAuth
, orbasicAuth
must be defined.- ssh_
auth DeploymentSettings Git Auth SSHAuth SSH auth for git authentication. Only one of
personalAccessToken
,sshAuth
, orbasicAuth
must be defined.
- basic
Auth Property Map Basic auth for git authentication. Only one of
personalAccessToken
,sshAuth
, orbasicAuth
must be defined.- ssh
Auth Property Map SSH auth for git authentication. Only one of
personalAccessToken
,sshAuth
, orbasicAuth
must be defined.
DeploymentSettingsGithub
- Deploy
Commits bool Trigger a deployment running
pulumi up
on commit.- Paths List<string>
The paths within the repo that deployments should be filtered to.
- Preview
Pull boolRequests 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 []string
The paths within the repo that deployments should be filtered to.
- Preview
Pull boolRequests Trigger a deployment running
pulumi preview
when a PR is opened.- Repository string
The GitHub repository in the format org/repo.
- deploy
Commits Boolean Trigger a deployment running
pulumi up
on commit.- paths List<String>
The paths within the repo that deployments should be filtered to.
- preview
Pull BooleanRequests Trigger a deployment running
pulumi preview
when a PR is opened.- repository String
The GitHub repository in the format org/repo.
- deploy
Commits boolean Trigger a deployment running
pulumi up
on commit.- paths string[]
The paths within the repo that deployments should be filtered to.
- preview
Pull booleanRequests 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_ boolrequests Trigger a deployment running
pulumi preview
when a PR is opened.- repository str
The GitHub repository in the format org/repo.
- deploy
Commits Boolean Trigger a deployment running
pulumi up
on commit.- paths List<String>
The paths within the repo that deployments should be filtered to.
- preview
Pull BooleanRequests Trigger a deployment running
pulumi preview
when a PR is opened.- repository String
The GitHub repository in the format org/repo.
DeploymentSettingsOperationContext
- Environment
Variables Dictionary<string, string> Environment variables to set for the deployment.
- Oidc
Pulumi.
Pulumi Service. Inputs. Operation Context OIDC OIDC configuration to use during the deployment.
- Options
Pulumi.
Pulumi Service. Inputs. Operation Context Options Options to override default behavior during the deployment.
- Pre
Run List<string>Commands Shell commands to run before the Pulumi operation executes.
- Environment
Variables map[string]string Environment variables to set for the deployment.
- Oidc
Operation
Context OIDC OIDC configuration to use during the deployment.
- Options
Operation
Context Options Options to override default behavior during the deployment.
- Pre
Run []stringCommands Shell commands to run before the Pulumi operation executes.
- environment
Variables Map<String,String> Environment variables to set for the deployment.
- oidc
Operation
Context OIDC OIDC configuration to use during the deployment.
- options
Operation
Context Options Options to override default behavior during the deployment.
- pre
Run List<String>Commands Shell commands to run before the Pulumi operation executes.
- environment
Variables {[key: string]: string} Environment variables to set for the deployment.
- oidc
Operation
Context OIDC OIDC configuration to use during the deployment.
- options
Operation
Context Options Options to override default behavior during the deployment.
- pre
Run string[]Commands Shell commands to run before the Pulumi operation executes.
- environment_
variables Mapping[str, str] Environment variables to set for the deployment.
- oidc
Operation
Context OIDC OIDC configuration to use during the deployment.
- options
Operation
Context Options Options to override default behavior during the deployment.
- pre_
run_ Sequence[str]commands Shell commands to run before the Pulumi operation executes.
- environment
Variables 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.
- pre
Run List<String>Commands Shell commands to run before the Pulumi operation executes.
DeploymentSettingsSourceContext
- Git
Pulumi.
Pulumi Service. Inputs. Deployment Settings Git Source Git source settings for a deployment.
- Git
Deployment
Settings Git Source Git source settings for a deployment.
- git
Deployment
Settings Git Source Git source settings for a deployment.
- git
Deployment
Settings Git Source Git source settings for a deployment.
- git
Deployment
Settings Git Source Git source settings for a deployment.
- git Property Map
Git source settings for a deployment.
GCPOIDCConfiguration
- Project
Id string The numerical ID of the GCP project.
- Provider
Id string The ID of the identity provider associated with the workload pool.
- Service
Account string The email address of the service account to use.
- Workload
Pool stringId The ID of the workload pool to use.
- Region string
The region of the GCP project.
- Token
Lifetime string The lifetime of the temporary credentials in “XhYmZs” format.
- Project
Id string The numerical ID of the GCP project.
- Provider
Id string The ID of the identity provider associated with the workload pool.
- Service
Account string The email address of the service account to use.
- Workload
Pool stringId The ID of the workload pool to use.
- Region string
The region of the GCP project.
- Token
Lifetime string The lifetime of the temporary credentials in “XhYmZs” format.
- project
Id String The numerical ID of the GCP project.
- provider
Id String The ID of the identity provider associated with the workload pool.
- service
Account String The email address of the service account to use.
- workload
Pool StringId The ID of the workload pool to use.
- region String
The region of the GCP project.
- token
Lifetime String The lifetime of the temporary credentials in “XhYmZs” format.
- project
Id string The numerical ID of the GCP project.
- provider
Id string The ID of the identity provider associated with the workload pool.
- service
Account string The email address of the service account to use.
- workload
Pool stringId The ID of the workload pool to use.
- region string
The region of the GCP project.
- token
Lifetime 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_ strid 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.
- project
Id String The numerical ID of the GCP project.
- provider
Id String The ID of the identity provider associated with the workload pool.
- service
Account String The email address of the service account to use.
- workload
Pool StringId The ID of the workload pool to use.
- region String
The region of the GCP project.
- token
Lifetime String The lifetime of the temporary credentials in “XhYmZs” format.
OperationContextOIDC
- Aws
Pulumi.
Pulumi Service. Inputs. AWSOIDCConfiguration AWS-specific OIDC configuration.
- Azure
Pulumi.
Pulumi Service. Inputs. Azure OIDCConfiguration Azure-specific OIDC configuration.
- Gcp
Pulumi.
Pulumi Service. Inputs. GCPOIDCConfiguration GCP-specific OIDC configuration.
- Aws AWSOIDCConfiguration
AWS-specific OIDC configuration.
- Azure
Azure
OIDCConfiguration Azure-specific OIDC configuration.
- Gcp GCPOIDCConfiguration
GCP-specific OIDC configuration.
- aws AWSOIDCConfiguration
AWS-specific OIDC configuration.
- azure
Azure
OIDCConfiguration Azure-specific OIDC configuration.
- gcp GCPOIDCConfiguration
GCP-specific OIDC configuration.
- aws AWSOIDCConfiguration
AWS-specific OIDC configuration.
- azure
Azure
OIDCConfiguration Azure-specific OIDC configuration.
- gcp GCPOIDCConfiguration
GCP-specific OIDC configuration.
- aws AWSOIDCConfiguration
AWS-specific OIDC configuration.
- azure
Azure
OIDCConfiguration 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'.
- Skip
Install boolDependencies 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'.
- Skip
Install boolDependencies 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'.
- skip
Install BooleanDependencies 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'.
- skip
Install booleanDependencies 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_ booldependencies 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'.
- skip
Install BooleanDependencies 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