Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Pulumi Cloud (Pulumi Service provider)
  3. API Docs
  4. DeploymentSettings
Pulumi Cloud v0.27.1 published on Thursday, Nov 14, 2024 by Pulumi
pulumi/pulumi-pulumiservice

pulumiservice.DeploymentSettings

Explore with Pulumi AI

pulumiservice logo
Pulumi Cloud v0.27.1 published on Thursday, Nov 14, 2024 by Pulumi
pulumi/pulumi-pulumiservice

    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

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DeploymentSettings(name: string, args: DeploymentSettingsArgs, opts?: CustomResourceOptions);
    @overload
def DeploymentSettings(resource_name: str,
                       args: DeploymentSettingsArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def DeploymentSettings(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       organization: Optional[str] = None,
                       project: Optional[str] = None,
                       stack: Optional[str] = None,
                       agent_pool_id: Optional[str] = None,
                       cache_options: Optional[DeploymentSettingsCacheOptionsArgs] = None,
                       executor_context: Optional[DeploymentSettingsExecutorContextArgs] = None,
                       github: Optional[DeploymentSettingsGithubArgs] = None,
                       operation_context: Optional[DeploymentSettingsOperationContextArgs] = None,
                       source_context: Optional[DeploymentSettingsSourceContextArgs] = 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.

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var deploymentSettingsResource = new PulumiService.DeploymentSettings("deploymentSettingsResource", new()
{
    Organization = "string",
    Project = "string",
    Stack = "string",
    AgentPoolId = "string",
    CacheOptions = new PulumiService.Inputs.DeploymentSettingsCacheOptionsArgs
    {
        Enable = false,
    },
    ExecutorContext = new PulumiService.Inputs.DeploymentSettingsExecutorContextArgs
    {
        ExecutorImage = "string",
    },
    Github = new PulumiService.Inputs.DeploymentSettingsGithubArgs
    {
        DeployCommits = false,
        Paths = new[]
        {
            "string",
        },
        PreviewPullRequests = false,
        PullRequestTemplate = false,
        Repository = "string",
    },
    OperationContext = new PulumiService.Inputs.DeploymentSettingsOperationContextArgs
    {
        EnvironmentVariables = 
        {
            { "string", "string" },
        },
        Oidc = new PulumiService.Inputs.OperationContextOIDCArgs
        {
            Aws = new PulumiService.Inputs.AWSOIDCConfigurationArgs
            {
                RoleARN = "string",
                SessionName = "string",
                Duration = "string",
                PolicyARNs = new[]
                {
                    "string",
                },
            },
            Azure = new PulumiService.Inputs.AzureOIDCConfigurationArgs
            {
                ClientId = "string",
                SubscriptionId = "string",
                TenantId = "string",
            },
            Gcp = new PulumiService.Inputs.GCPOIDCConfigurationArgs
            {
                ProjectId = "string",
                ProviderId = "string",
                ServiceAccount = "string",
                WorkloadPoolId = "string",
                Region = "string",
                TokenLifetime = "string",
            },
        },
        Options = new PulumiService.Inputs.OperationContextOptionsArgs
        {
            DeleteAfterDestroy = false,
            Shell = "string",
            SkipInstallDependencies = false,
            SkipIntermediateDeployments = false,
        },
        PreRunCommands = new[]
        {
            "string",
        },
    },
    SourceContext = new PulumiService.Inputs.DeploymentSettingsSourceContextArgs
    {
        Git = new PulumiService.Inputs.DeploymentSettingsGitSourceArgs
        {
            Branch = "string",
            Commit = "string",
            GitAuth = new PulumiService.Inputs.DeploymentSettingsGitSourceGitAuthArgs
            {
                BasicAuth = new PulumiService.Inputs.DeploymentSettingsGitAuthBasicAuthArgs
                {
                    Password = "string",
                    Username = "string",
                },
                SshAuth = new PulumiService.Inputs.DeploymentSettingsGitAuthSSHAuthArgs
                {
                    SshPrivateKey = "string",
                    Password = "string",
                },
            },
            RepoDir = "string",
            RepoUrl = "string",
        },
    },
});

    example, err := pulumiservice.NewDeploymentSettings(ctx, "deploymentSettingsResource", &pulumiservice.DeploymentSettingsArgs{
	Organization: pulumi.String("string"),
	Project:      pulumi.String("string"),
	Stack:        pulumi.String("string"),
	AgentPoolId:  pulumi.String("string"),
	CacheOptions: &pulumiservice.DeploymentSettingsCacheOptionsArgs{
		Enable: pulumi.Bool(false),
	},
	ExecutorContext: &pulumiservice.DeploymentSettingsExecutorContextArgs{
		ExecutorImage: pulumi.String("string"),
	},
	Github: &pulumiservice.DeploymentSettingsGithubArgs{
		DeployCommits: pulumi.Bool(false),
		Paths: pulumi.StringArray{
			pulumi.String("string"),
		},
		PreviewPullRequests: pulumi.Bool(false),
		PullRequestTemplate: pulumi.Bool(false),
		Repository:          pulumi.String("string"),
	},
	OperationContext: &pulumiservice.DeploymentSettingsOperationContextArgs{
		EnvironmentVariables: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		Oidc: &pulumiservice.OperationContextOIDCArgs{
			Aws: &pulumiservice.AWSOIDCConfigurationArgs{
				RoleARN:     pulumi.String("string"),
				SessionName: pulumi.String("string"),
				Duration:    pulumi.String("string"),
				PolicyARNs: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
			Azure: &pulumiservice.AzureOIDCConfigurationArgs{
				ClientId:       pulumi.String("string"),
				SubscriptionId: pulumi.String("string"),
				TenantId:       pulumi.String("string"),
			},
			Gcp: &pulumiservice.GCPOIDCConfigurationArgs{
				ProjectId:      pulumi.String("string"),
				ProviderId:     pulumi.String("string"),
				ServiceAccount: pulumi.String("string"),
				WorkloadPoolId: pulumi.String("string"),
				Region:         pulumi.String("string"),
				TokenLifetime:  pulumi.String("string"),
			},
		},
		Options: &pulumiservice.OperationContextOptionsArgs{
			DeleteAfterDestroy:          pulumi.Bool(false),
			Shell:                       pulumi.String("string"),
			SkipInstallDependencies:     pulumi.Bool(false),
			SkipIntermediateDeployments: pulumi.Bool(false),
		},
		PreRunCommands: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	SourceContext: &pulumiservice.DeploymentSettingsSourceContextArgs{
		Git: &pulumiservice.DeploymentSettingsGitSourceArgs{
			Branch: pulumi.String("string"),
			Commit: pulumi.String("string"),
			GitAuth: &pulumiservice.DeploymentSettingsGitSourceGitAuthArgs{
				BasicAuth: &pulumiservice.DeploymentSettingsGitAuthBasicAuthArgs{
					Password: pulumi.String("string"),
					Username: pulumi.String("string"),
				},
				SshAuth: &pulumiservice.DeploymentSettingsGitAuthSSHAuthArgs{
					SshPrivateKey: pulumi.String("string"),
					Password:      pulumi.String("string"),
				},
			},
			RepoDir: pulumi.String("string"),
			RepoUrl: pulumi.String("string"),
		},
	},
})

    var deploymentSettingsResource = new DeploymentSettings("deploymentSettingsResource", DeploymentSettingsArgs.builder()
    .organization("string")
    .project("string")
    .stack("string")
    .agentPoolId("string")
    .cacheOptions(DeploymentSettingsCacheOptionsArgs.builder()
        .enable(false)
        .build())
    .executorContext(DeploymentSettingsExecutorContextArgs.builder()
        .executorImage("string")
        .build())
    .github(DeploymentSettingsGithubArgs.builder()
        .deployCommits(false)
        .paths("string")
        .previewPullRequests(false)
        .pullRequestTemplate(false)
        .repository("string")
        .build())
    .operationContext(DeploymentSettingsOperationContextArgs.builder()
        .environmentVariables(Map.of("string", "string"))
        .oidc(OperationContextOIDCArgs.builder()
            .aws(AWSOIDCConfigurationArgs.builder()
                .roleARN("string")
                .sessionName("string")
                .duration("string")
                .policyARNs("string")
                .build())
            .azure(AzureOIDCConfigurationArgs.builder()
                .clientId("string")
                .subscriptionId("string")
                .tenantId("string")
                .build())
            .gcp(GCPOIDCConfigurationArgs.builder()
                .projectId("string")
                .providerId("string")
                .serviceAccount("string")
                .workloadPoolId("string")
                .region("string")
                .tokenLifetime("string")
                .build())
            .build())
        .options(OperationContextOptionsArgs.builder()
            .deleteAfterDestroy(false)
            .shell("string")
            .skipInstallDependencies(false)
            .skipIntermediateDeployments(false)
            .build())
        .preRunCommands("string")
        .build())
    .sourceContext(DeploymentSettingsSourceContextArgs.builder()
        .git(DeploymentSettingsGitSourceArgs.builder()
            .branch("string")
            .commit("string")
            .gitAuth(DeploymentSettingsGitSourceGitAuthArgs.builder()
                .basicAuth(DeploymentSettingsGitAuthBasicAuthArgs.builder()
                    .password("string")
                    .username("string")
                    .build())
                .sshAuth(DeploymentSettingsGitAuthSSHAuthArgs.builder()
                    .sshPrivateKey("string")
                    .password("string")
                    .build())
                .build())
            .repoDir("string")
            .repoUrl("string")
            .build())
        .build())
    .build());

    deployment_settings_resource = pulumiservice.DeploymentSettings("deploymentSettingsResource",
    organization="string",
    project="string",
    stack="string",
    agent_pool_id="string",
    cache_options={
        "enable": False,
    },
    executor_context={
        "executor_image": "string",
    },
    github={
        "deploy_commits": False,
        "paths": ["string"],
        "preview_pull_requests": False,
        "pull_request_template": False,
        "repository": "string",
    },
    operation_context={
        "environment_variables": {
            "string": "string",
        },
        "oidc": {
            "aws": {
                "role_arn": "string",
                "session_name": "string",
                "duration": "string",
                "policy_arns": ["string"],
            },
            "azure": {
                "client_id": "string",
                "subscription_id": "string",
                "tenant_id": "string",
            },
            "gcp": {
                "project_id": "string",
                "provider_id": "string",
                "service_account": "string",
                "workload_pool_id": "string",
                "region": "string",
                "token_lifetime": "string",
            },
        },
        "options": {
            "delete_after_destroy": False,
            "shell": "string",
            "skip_install_dependencies": False,
            "skip_intermediate_deployments": False,
        },
        "pre_run_commands": ["string"],
    },
    source_context={
        "git": {
            "branch": "string",
            "commit": "string",
            "git_auth": {
                "basic_auth": {
                    "password": "string",
                    "username": "string",
                },
                "ssh_auth": {
                    "ssh_private_key": "string",
                    "password": "string",
                },
            },
            "repo_dir": "string",
            "repo_url": "string",
        },
    })

    const deploymentSettingsResource = new pulumiservice.DeploymentSettings("deploymentSettingsResource", {
    organization: "string",
    project: "string",
    stack: "string",
    agentPoolId: "string",
    cacheOptions: {
        enable: false,
    },
    executorContext: {
        executorImage: "string",
    },
    github: {
        deployCommits: false,
        paths: ["string"],
        previewPullRequests: false,
        pullRequestTemplate: false,
        repository: "string",
    },
    operationContext: {
        environmentVariables: {
            string: "string",
        },
        oidc: {
            aws: {
                roleARN: "string",
                sessionName: "string",
                duration: "string",
                policyARNs: ["string"],
            },
            azure: {
                clientId: "string",
                subscriptionId: "string",
                tenantId: "string",
            },
            gcp: {
                projectId: "string",
                providerId: "string",
                serviceAccount: "string",
                workloadPoolId: "string",
                region: "string",
                tokenLifetime: "string",
            },
        },
        options: {
            deleteAfterDestroy: false,
            shell: "string",
            skipInstallDependencies: false,
            skipIntermediateDeployments: false,
        },
        preRunCommands: ["string"],
    },
    sourceContext: {
        git: {
            branch: "string",
            commit: "string",
            gitAuth: {
                basicAuth: {
                    password: "string",
                    username: "string",
                },
                sshAuth: {
                    sshPrivateKey: "string",
                    password: "string",
                },
            },
            repoDir: "string",
            repoUrl: "string",
        },
    },
});

    type: pulumiservice:DeploymentSettings
properties:
    agentPoolId: string
    cacheOptions:
        enable: false
    executorContext:
        executorImage: string
    github:
        deployCommits: false
        paths:
            - string
        previewPullRequests: false
        pullRequestTemplate: false
        repository: string
    operationContext:
        environmentVariables:
            string: string
        oidc:
            aws:
                duration: string
                policyARNs:
                    - string
                roleARN: string
                sessionName: string
            azure:
                clientId: string
                subscriptionId: string
                tenantId: string
            gcp:
                projectId: string
                providerId: string
                region: string
                serviceAccount: string
                tokenLifetime: string
                workloadPoolId: string
        options:
            deleteAfterDestroy: false
            shell: string
            skipInstallDependencies: false
            skipIntermediateDeployments: false
        preRunCommands:
            - string
    organization: string
    project: string
    sourceContext:
        git:
            branch: string
            commit: string
            gitAuth:
                basicAuth:
                    password: string
                    username: string
                sshAuth:
                    password: string
                    sshPrivateKey: string
            repoDir: string
            repoUrl: string
    stack: string

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The DeploymentSettings resource accepts the following input properties:

    Organization string
    Organization name.
    Project string
    Project name.
    Stack string
    Stack name.
    AgentPoolId string
    The agent pool identifier to use for the deployment.
    CacheOptions Pulumi.PulumiService.Inputs.DeploymentSettingsCacheOptions
    Dependency cache settings for the deployment
    ExecutorContext Pulumi.PulumiService.Inputs.DeploymentSettingsExecutorContext
    Settings related to the deployment executor.
    Github Pulumi.PulumiService.Inputs.DeploymentSettingsGithub
    GitHub settings for the deployment.
    OperationContext Pulumi.PulumiService.Inputs.DeploymentSettingsOperationContext
    Settings related to the Pulumi operation environment during the deployment.
    SourceContext Pulumi.PulumiService.Inputs.DeploymentSettingsSourceContext
    Settings related to the source of the deployment.
    Organization string
    Organization name.
    Project string
    Project name.
    Stack string
    Stack name.
    AgentPoolId string
    The agent pool identifier to use for the deployment.
    CacheOptions DeploymentSettingsCacheOptionsArgs
    Dependency cache settings for the deployment
    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.
    SourceContext DeploymentSettingsSourceContextArgs
    Settings related to the source of the deployment.
    organization String
    Organization name.
    project String
    Project name.
    stack String
    Stack name.
    agentPoolId String
    The agent pool identifier to use for the deployment.
    cacheOptions DeploymentSettingsCacheOptions
    Dependency cache settings for the deployment
    executorContext DeploymentSettingsExecutorContext
    Settings related to the deployment executor.
    github DeploymentSettingsGithub
    GitHub settings for the deployment.
    operationContext DeploymentSettingsOperationContext
    Settings related to the Pulumi operation environment during the deployment.
    sourceContext DeploymentSettingsSourceContext
    Settings related to the source of the deployment.
    organization string
    Organization name.
    project string
    Project name.
    stack string
    Stack name.
    agentPoolId string
    The agent pool identifier to use for the deployment.
    cacheOptions DeploymentSettingsCacheOptions
    Dependency cache settings for the deployment
    executorContext DeploymentSettingsExecutorContext
    Settings related to the deployment executor.
    github DeploymentSettingsGithub
    GitHub settings for the deployment.
    operationContext DeploymentSettingsOperationContext
    Settings related to the Pulumi operation environment during the deployment.
    sourceContext DeploymentSettingsSourceContext
    Settings related to the source of the deployment.
    organization str
    Organization name.
    project str
    Project name.
    stack str
    Stack name.
    agent_pool_id str
    The agent pool identifier to use for the deployment.
    cache_options DeploymentSettingsCacheOptionsArgs
    Dependency cache settings for the deployment
    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.
    source_context DeploymentSettingsSourceContextArgs
    Settings related to the source of the deployment.
    organization String
    Organization name.
    project String
    Project name.
    stack String
    Stack name.
    agentPoolId String
    The agent pool identifier to use for the deployment.
    cacheOptions Property Map
    Dependency cache settings for the deployment
    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.
    sourceContext Property Map
    Settings related to the source of 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, AWSOIDCConfigurationArgs

    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, AzureOIDCConfigurationArgs

    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.

    DeploymentSettingsCacheOptions, DeploymentSettingsCacheOptionsArgs

    Enable bool
    Enable dependency caching
    Enable bool
    Enable dependency caching
    enable Boolean
    Enable dependency caching
    enable boolean
    Enable dependency caching
    enable bool
    Enable dependency caching
    enable Boolean
    Enable dependency caching

    DeploymentSettingsExecutorContext, DeploymentSettingsExecutorContextArgs

    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, DeploymentSettingsGitAuthBasicAuthArgs

    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, DeploymentSettingsGitAuthSSHAuthArgs

    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, DeploymentSettingsGitSourceArgs

    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, DeploymentSettingsGitSourceGitAuthArgs

    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, DeploymentSettingsGithubArgs

    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.
    PullRequestTemplate bool
    Use this stack as a template for pull request review stacks.
    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.
    PullRequestTemplate bool
    Use this stack as a template for pull request review stacks.
    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.
    pullRequestTemplate Boolean
    Use this stack as a template for pull request review stacks.
    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.
    pullRequestTemplate boolean
    Use this stack as a template for pull request review stacks.
    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.
    pull_request_template bool
    Use this stack as a template for pull request review stacks.
    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.
    pullRequestTemplate Boolean
    Use this stack as a template for pull request review stacks.
    repository String
    The GitHub repository in the format org/repo.

    DeploymentSettingsOperationContext, DeploymentSettingsOperationContextArgs

    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, DeploymentSettingsSourceContextArgs

    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, GCPOIDCConfigurationArgs

    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, OperationContextOIDCArgs

    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, OperationContextOptionsArgs

    DeleteAfterDestroy bool
    Whether the stack should be deleted after it is destroyed.
    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)
    SkipIntermediateDeployments bool
    Skip intermediate deployments (Consolidate multiple deployments of the same type into one deployment)
    DeleteAfterDestroy bool
    Whether the stack should be deleted after it is destroyed.
    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)
    SkipIntermediateDeployments bool
    Skip intermediate deployments (Consolidate multiple deployments of the same type into one deployment)
    deleteAfterDestroy Boolean
    Whether the stack should be deleted after it is destroyed.
    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)
    skipIntermediateDeployments Boolean
    Skip intermediate deployments (Consolidate multiple deployments of the same type into one deployment)
    deleteAfterDestroy boolean
    Whether the stack should be deleted after it is destroyed.
    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)
    skipIntermediateDeployments boolean
    Skip intermediate deployments (Consolidate multiple deployments of the same type into one deployment)
    delete_after_destroy bool
    Whether the stack should be deleted after it is destroyed.
    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)
    skip_intermediate_deployments bool
    Skip intermediate deployments (Consolidate multiple deployments of the same type into one deployment)
    deleteAfterDestroy Boolean
    Whether the stack should be deleted after it is destroyed.
    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)
    skipIntermediateDeployments Boolean
    Skip intermediate deployments (Consolidate multiple deployments of the same type into one deployment)

    Package Details

    Repository
    pulumiservice pulumi/pulumi-pulumiservice
    License
    Apache-2.0
    pulumiservice logo
    Pulumi Cloud v0.27.1 published on Thursday, Nov 14, 2024 by Pulumi
    pulumi/pulumi-pulumiservice