Docs Packages
  1. Packages
  2. Pulumi Auto Deploy (preview)
  3. API Docs
  4. AutoDeployer
auto-deploy v0.0.4 published on Monday, Jun 19, 2023 by Pulumi
pulumi/pulumi-auto-deploy

auto-deploy.AutoDeployer

Explore with Pulumi AI

auto-deploy logo
auto-deploy v0.0.4 published on Monday, Jun 19, 2023 by Pulumi
pulumi/pulumi-auto-deploy

    Automatically trigger downstream updates on dependent stacks via Pulumi Deployments. AutoDeployer requires that stacks have Deployment Settings configured.

    Create AutoDeployer Resource

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

    Constructor syntax

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

@overload
def AutoDeployer(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 downstream_refs: Optional[Sequence[str]] = None,
                 organization: Optional[str] = None,
                 project: Optional[str] = None,
                 stack: Optional[str] = None)
    func NewAutoDeployer(ctx *Context, name string, args AutoDeployerArgs, opts ...ResourceOption) (*AutoDeployer, error)
    public AutoDeployer(string name, AutoDeployerArgs args, CustomResourceOptions? opts = null)
    public AutoDeployer(String name, AutoDeployerArgs args)
public AutoDeployer(String name, AutoDeployerArgs args, CustomResourceOptions options)

    type: auto-deploy:AutoDeployer
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 AutoDeployerArgs
    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 AutoDeployerArgs
    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 AutoDeployerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AutoDeployerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AutoDeployerArgs
    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 autoDeployerResource = new AutoDeploy.AutoDeployer("autoDeployerResource", new()
{
    DownstreamRefs = new[]
    {
        "string",
    },
    Organization = "string",
    Project = "string",
    Stack = "string",
});

    example, err := autoDeploy.NewAutoDeployer(ctx, "autoDeployerResource", &autoDeploy.AutoDeployerArgs{
	DownstreamRefs: pulumi.StringArray{
		pulumi.String("string"),
	},
	Organization: pulumi.String("string"),
	Project:      pulumi.String("string"),
	Stack:        pulumi.String("string"),
})

    var autoDeployerResource = new AutoDeployer("autoDeployerResource", AutoDeployerArgs.builder()
    .downstreamRefs("string")
    .organization("string")
    .project("string")
    .stack("string")
    .build());

    auto_deployer_resource = auto_deploy.AutoDeployer("autoDeployerResource",
    downstream_refs=["string"],
    organization="string",
    project="string",
    stack="string")

    const autoDeployerResource = new auto_deploy.AutoDeployer("autoDeployerResource", {
    downstreamRefs: ["string"],
    organization: "string",
    project: "string",
    stack: "string",
});

    type: auto-deploy:AutoDeployer
properties:
    downstreamRefs:
        - string
    organization: string
    project: string
    stack: string

    AutoDeployer 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 AutoDeployer resource accepts the following input properties:

    DownstreamRefs List<string>
    A list of AutoDeployer.DownstreamRef indicating which stacks should automatically be updated via Pulumi Deployments when this stack is successfully updated.
    Organization string
    The organization name for the AutoDeployer stack.
    Project string
    The project name for the AutoDeployer stack.
    Stack string
    The stack name for this AutoDeployer.
    DownstreamRefs []string
    A list of AutoDeployer.DownstreamRef indicating which stacks should automatically be updated via Pulumi Deployments when this stack is successfully updated.
    Organization string
    The organization name for the AutoDeployer stack.
    Project string
    The project name for the AutoDeployer stack.
    Stack string
    The stack name for this AutoDeployer.
    downstreamRefs List<String>
    A list of AutoDeployer.DownstreamRef indicating which stacks should automatically be updated via Pulumi Deployments when this stack is successfully updated.
    organization String
    The organization name for the AutoDeployer stack.
    project String
    The project name for the AutoDeployer stack.
    stack String
    The stack name for this AutoDeployer.
    downstreamRefs string[]
    A list of AutoDeployer.DownstreamRef indicating which stacks should automatically be updated via Pulumi Deployments when this stack is successfully updated.
    organization string
    The organization name for the AutoDeployer stack.
    project string
    The project name for the AutoDeployer stack.
    stack string
    The stack name for this AutoDeployer.
    downstream_refs Sequence[str]
    A list of AutoDeployer.DownstreamRef indicating which stacks should automatically be updated via Pulumi Deployments when this stack is successfully updated.
    organization str
    The organization name for the AutoDeployer stack.
    project str
    The project name for the AutoDeployer stack.
    stack str
    The stack name for this AutoDeployer.
    downstreamRefs List<String>
    A list of AutoDeployer.DownstreamRef indicating which stacks should automatically be updated via Pulumi Deployments when this stack is successfully updated.
    organization String
    The organization name for the AutoDeployer stack.
    project String
    The project name for the AutoDeployer stack.
    stack String
    The stack name for this AutoDeployer.

    Outputs

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

    DownstreamWebhooks List<string>
    A list of webhook URLs configured on this stack to trigger downstream deployments.
    Ref string
    The output reference that can be passed to another AutoDeployer's downstreamRefs list to configure depedent updates.
    DownstreamWebhooks []string
    A list of webhook URLs configured on this stack to trigger downstream deployments.
    Ref string
    The output reference that can be passed to another AutoDeployer's downstreamRefs list to configure depedent updates.
    downstreamWebhooks List<String>
    A list of webhook URLs configured on this stack to trigger downstream deployments.
    ref String
    The output reference that can be passed to another AutoDeployer's downstreamRefs list to configure depedent updates.
    downstreamWebhooks string[]
    A list of webhook URLs configured on this stack to trigger downstream deployments.
    ref string
    The output reference that can be passed to another AutoDeployer's downstreamRefs list to configure depedent updates.
    downstream_webhooks Sequence[str]
    A list of webhook URLs configured on this stack to trigger downstream deployments.
    ref str
    The output reference that can be passed to another AutoDeployer's downstreamRefs list to configure depedent updates.
    downstreamWebhooks List<String>
    A list of webhook URLs configured on this stack to trigger downstream deployments.
    ref String
    The output reference that can be passed to another AutoDeployer's downstreamRefs list to configure depedent updates.

    Package Details

    Repository
    auto-deploy
    License
    auto-deploy logo
    auto-deploy v0.0.4 published on Monday, Jun 19, 2023 by Pulumi
    pulumi/pulumi-auto-deploy