1. Packages
  2. Spectrocloud Provider
  3. API Docs
  4. Macros
spectrocloud 0.23.4 published on Monday, Apr 14, 2025 by spectrocloud

spectrocloud.Macros

Explore with Pulumi AI

A resource for creating and managing service output variables and macros.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as spectrocloud from "@pulumi/spectrocloud";

const projectMacro = new spectrocloud.Macros("projectMacro", {
    macros: {
        project_macro_1: "val1",
        project_macro_2: "val2",
    },
    project: "Default",
});
const tenantMacro = new spectrocloud.Macros("tenantMacro", {macros: {
    tenant_macro_1: "tenant_val2",
}});
Copy
import pulumi
import pulumi_spectrocloud as spectrocloud

project_macro = spectrocloud.Macros("projectMacro",
    macros={
        "project_macro_1": "val1",
        "project_macro_2": "val2",
    },
    project="Default")
tenant_macro = spectrocloud.Macros("tenantMacro", macros={
    "tenant_macro_1": "tenant_val2",
})
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/spectrocloud/spectrocloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := spectrocloud.NewMacros(ctx, "projectMacro", &spectrocloud.MacrosArgs{
			Macros: pulumi.StringMap{
				"project_macro_1": pulumi.String("val1"),
				"project_macro_2": pulumi.String("val2"),
			},
			Project: pulumi.String("Default"),
		})
		if err != nil {
			return err
		}
		_, err = spectrocloud.NewMacros(ctx, "tenantMacro", &spectrocloud.MacrosArgs{
			Macros: pulumi.StringMap{
				"tenant_macro_1": pulumi.String("tenant_val2"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Spectrocloud = Pulumi.Spectrocloud;

return await Deployment.RunAsync(() => 
{
    var projectMacro = new Spectrocloud.Macros("projectMacro", new()
    {
        Macros = 
        {
            { "project_macro_1", "val1" },
            { "project_macro_2", "val2" },
        },
        Project = "Default",
    });

    var tenantMacro = new Spectrocloud.Macros("tenantMacro", new()
    {
        Macros = 
        {
            { "tenant_macro_1", "tenant_val2" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.spectrocloud.Macros;
import com.pulumi.spectrocloud.MacrosArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var projectMacro = new Macros("projectMacro", MacrosArgs.builder()
            .macros(Map.ofEntries(
                Map.entry("project_macro_1", "val1"),
                Map.entry("project_macro_2", "val2")
            ))
            .project("Default")
            .build());

        var tenantMacro = new Macros("tenantMacro", MacrosArgs.builder()
            .macros(Map.of("tenant_macro_1", "tenant_val2"))
            .build());

    }
}
Copy
resources:
  projectMacro:
    type: spectrocloud:Macros
    properties:
      macros:
        project_macro_1: val1
        project_macro_2: val2
      project: Default
  tenantMacro:
    type: spectrocloud:Macros
    properties:
      macros:
        tenant_macro_1: tenant_val2
Copy

Create Macros Resource

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

Constructor syntax

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

@overload
def Macros(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           macros: Optional[Mapping[str, str]] = None,
           macros_id: Optional[str] = None,
           project: Optional[str] = None,
           timeouts: Optional[MacrosTimeoutsArgs] = None)
func NewMacros(ctx *Context, name string, args MacrosArgs, opts ...ResourceOption) (*Macros, error)
public Macros(string name, MacrosArgs args, CustomResourceOptions? opts = null)
public Macros(String name, MacrosArgs args)
public Macros(String name, MacrosArgs args, CustomResourceOptions options)
type: spectrocloud:Macros
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. MacrosArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. MacrosArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. MacrosArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. MacrosArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. MacrosArgs
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 macrosResource = new Spectrocloud.Macros("macrosResource", new()
{
    Macros = 
    {
        { "string", "string" },
    },
    MacrosId = "string",
    Project = "string",
    Timeouts = new Spectrocloud.Inputs.MacrosTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});
Copy
example, err := spectrocloud.NewMacros(ctx, "macrosResource", &spectrocloud.MacrosArgs{
Macros: pulumi.StringMap{
"string": pulumi.String("string"),
},
MacrosId: pulumi.String("string"),
Project: pulumi.String("string"),
Timeouts: &.MacrosTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
Update: pulumi.String("string"),
},
})
Copy
var macrosResource = new Macros("macrosResource", MacrosArgs.builder()
    .macros(Map.of("string", "string"))
    .macrosId("string")
    .project("string")
    .timeouts(MacrosTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());
Copy
macros_resource = spectrocloud.Macros("macrosResource",
    macros={
        "string": "string",
    },
    macros_id="string",
    project="string",
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })
Copy
const macrosResource = new spectrocloud.Macros("macrosResource", {
    macros: {
        string: "string",
    },
    macrosId: "string",
    project: "string",
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});
Copy
type: spectrocloud:Macros
properties:
    macros:
        string: string
    macrosId: string
    project: string
    timeouts:
        create: string
        delete: string
        update: string
Copy

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

Macros This property is required. Dictionary<string, string>
The key-value mapping includes the macro name and its corresponding value, representing either a macro or a service variable output.
MacrosId string
The ID of this resource.
Project string
The Spectro Cloud project name.
Timeouts MacrosTimeouts
Macros This property is required. map[string]string
The key-value mapping includes the macro name and its corresponding value, representing either a macro or a service variable output.
MacrosId string
The ID of this resource.
Project string
The Spectro Cloud project name.
Timeouts MacrosTimeoutsArgs
macros This property is required. Map<String,String>
The key-value mapping includes the macro name and its corresponding value, representing either a macro or a service variable output.
macrosId String
The ID of this resource.
project String
The Spectro Cloud project name.
timeouts MacrosTimeouts
macros This property is required. {[key: string]: string}
The key-value mapping includes the macro name and its corresponding value, representing either a macro or a service variable output.
macrosId string
The ID of this resource.
project string
The Spectro Cloud project name.
timeouts MacrosTimeouts
macros This property is required. Mapping[str, str]
The key-value mapping includes the macro name and its corresponding value, representing either a macro or a service variable output.
macros_id str
The ID of this resource.
project str
The Spectro Cloud project name.
timeouts MacrosTimeoutsArgs
macros This property is required. Map<String>
The key-value mapping includes the macro name and its corresponding value, representing either a macro or a service variable output.
macrosId String
The ID of this resource.
project String
The Spectro Cloud project name.
timeouts Property Map

Outputs

All input properties are implicitly available as output properties. Additionally, the Macros 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.

Look up Existing Macros Resource

Get an existing Macros resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: MacrosState, opts?: CustomResourceOptions): Macros
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        macros: Optional[Mapping[str, str]] = None,
        macros_id: Optional[str] = None,
        project: Optional[str] = None,
        timeouts: Optional[MacrosTimeoutsArgs] = None) -> Macros
func GetMacros(ctx *Context, name string, id IDInput, state *MacrosState, opts ...ResourceOption) (*Macros, error)
public static Macros Get(string name, Input<string> id, MacrosState? state, CustomResourceOptions? opts = null)
public static Macros get(String name, Output<String> id, MacrosState state, CustomResourceOptions options)
resources:  _:    type: spectrocloud:Macros    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Macros Dictionary<string, string>
The key-value mapping includes the macro name and its corresponding value, representing either a macro or a service variable output.
MacrosId string
The ID of this resource.
Project string
The Spectro Cloud project name.
Timeouts MacrosTimeouts
Macros map[string]string
The key-value mapping includes the macro name and its corresponding value, representing either a macro or a service variable output.
MacrosId string
The ID of this resource.
Project string
The Spectro Cloud project name.
Timeouts MacrosTimeoutsArgs
macros Map<String,String>
The key-value mapping includes the macro name and its corresponding value, representing either a macro or a service variable output.
macrosId String
The ID of this resource.
project String
The Spectro Cloud project name.
timeouts MacrosTimeouts
macros {[key: string]: string}
The key-value mapping includes the macro name and its corresponding value, representing either a macro or a service variable output.
macrosId string
The ID of this resource.
project string
The Spectro Cloud project name.
timeouts MacrosTimeouts
macros Mapping[str, str]
The key-value mapping includes the macro name and its corresponding value, representing either a macro or a service variable output.
macros_id str
The ID of this resource.
project str
The Spectro Cloud project name.
timeouts MacrosTimeoutsArgs
macros Map<String>
The key-value mapping includes the macro name and its corresponding value, representing either a macro or a service variable output.
macrosId String
The ID of this resource.
project String
The Spectro Cloud project name.
timeouts Property Map

Supporting Types

MacrosTimeouts
, MacrosTimeoutsArgs

Create string
Delete string
Update string
Create string
Delete string
Update string
create String
delete String
update String
create string
delete string
update string
create str
delete str
update str
create String
delete String
update String

Package Details

Repository
spectrocloud spectrocloud/terraform-provider-spectrocloud
License
Notes
This Pulumi package is based on the spectrocloud Terraform Provider.