meraki.organizations.ActionBatches
Explore with Pulumi AI
Example Usage
Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.meraki.organizations.ActionBatches;
import com.pulumi.meraki.organizations.ActionBatchesArgs;
import com.pulumi.meraki.organizations.inputs.ActionBatchesActionArgs;
import com.pulumi.meraki.organizations.inputs.ActionBatchesCallbackArgs;
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 example = new ActionBatches("example", ActionBatchesArgs.builder()
.actions(ActionBatchesActionArgs.builder()
.operation("create")
.resource("/devices/QXXX-XXXX-XXXX/switch/ports/3")
.build())
.callback(ActionBatchesCallbackArgs.builder()
.http_server(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.payload_template(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.shared_secret("secret")
.url("https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031")
.build())
.confirmed(true)
.organizationId("string")
.synchronous(true)
.build());
ctx.export("merakiOrganizationsActionBatchesExample", example);
}
}
resources:
example:
type: meraki:organizations:ActionBatches
properties:
actions:
- operation: create
resource: /devices/QXXX-XXXX-XXXX/switch/ports/3
callback:
http_server:
id: aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vd2ViaG9va3M=
payload_template:
id: wpt_2100
shared_secret: secret
url: https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031
confirmed: true
organizationId: string
synchronous: true
outputs:
merakiOrganizationsActionBatchesExample: ${example}
Create ActionBatches Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ActionBatches(name: string, args: ActionBatchesArgs, opts?: CustomResourceOptions);
@overload
def ActionBatches(resource_name: str,
args: ActionBatchesArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ActionBatches(resource_name: str,
opts: Optional[ResourceOptions] = None,
organization_id: Optional[str] = None,
action_batch_id: Optional[str] = None,
actions: Optional[Sequence[ActionBatchesActionArgs]] = None,
callback: Optional[ActionBatchesCallbackArgs] = None,
confirmed: Optional[bool] = None,
synchronous: Optional[bool] = None)
func NewActionBatches(ctx *Context, name string, args ActionBatchesArgs, opts ...ResourceOption) (*ActionBatches, error)
public ActionBatches(string name, ActionBatchesArgs args, CustomResourceOptions? opts = null)
public ActionBatches(String name, ActionBatchesArgs args)
public ActionBatches(String name, ActionBatchesArgs args, CustomResourceOptions options)
type: meraki:organizations:ActionBatches
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 ActionBatchesArgs
- 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 ActionBatchesArgs
- 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 ActionBatchesArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ActionBatchesArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ActionBatchesArgs
- 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 actionBatchesResource = new Meraki.Organizations.ActionBatches("actionBatchesResource", new()
{
OrganizationId = "string",
ActionBatchId = "string",
Actions = new[]
{
new Meraki.Organizations.Inputs.ActionBatchesActionArgs
{
Body = "string",
Operation = "string",
Resource = "string",
},
},
Callback = new Meraki.Organizations.Inputs.ActionBatchesCallbackArgs
{
HttpServer = new Meraki.Organizations.Inputs.ActionBatchesCallbackHttpServerArgs
{
Id = "string",
},
Id = "string",
PayloadTemplate = new Meraki.Organizations.Inputs.ActionBatchesCallbackPayloadTemplateArgs
{
Id = "string",
},
SharedSecret = "string",
Status = "string",
Url = "string",
},
Confirmed = false,
Synchronous = false,
});
example, err := organizations.NewActionBatches(ctx, "actionBatchesResource", &organizations.ActionBatchesArgs{
OrganizationId: pulumi.String("string"),
ActionBatchId: pulumi.String("string"),
Actions: organizations.ActionBatchesActionArray{
&organizations.ActionBatchesActionArgs{
Body: pulumi.String("string"),
Operation: pulumi.String("string"),
Resource: pulumi.String("string"),
},
},
Callback: &organizations.ActionBatchesCallbackArgs{
HttpServer: &organizations.ActionBatchesCallbackHttpServerArgs{
Id: pulumi.String("string"),
},
Id: pulumi.String("string"),
PayloadTemplate: &organizations.ActionBatchesCallbackPayloadTemplateArgs{
Id: pulumi.String("string"),
},
SharedSecret: pulumi.String("string"),
Status: pulumi.String("string"),
Url: pulumi.String("string"),
},
Confirmed: pulumi.Bool(false),
Synchronous: pulumi.Bool(false),
})
var actionBatchesResource = new ActionBatches("actionBatchesResource", ActionBatchesArgs.builder()
.organizationId("string")
.actionBatchId("string")
.actions(ActionBatchesActionArgs.builder()
.body("string")
.operation("string")
.resource("string")
.build())
.callback(ActionBatchesCallbackArgs.builder()
.httpServer(ActionBatchesCallbackHttpServerArgs.builder()
.id("string")
.build())
.id("string")
.payloadTemplate(ActionBatchesCallbackPayloadTemplateArgs.builder()
.id("string")
.build())
.sharedSecret("string")
.status("string")
.url("string")
.build())
.confirmed(false)
.synchronous(false)
.build());
action_batches_resource = meraki.organizations.ActionBatches("actionBatchesResource",
organization_id="string",
action_batch_id="string",
actions=[{
"body": "string",
"operation": "string",
"resource": "string",
}],
callback={
"http_server": {
"id": "string",
},
"id": "string",
"payload_template": {
"id": "string",
},
"shared_secret": "string",
"status": "string",
"url": "string",
},
confirmed=False,
synchronous=False)
const actionBatchesResource = new meraki.organizations.ActionBatches("actionBatchesResource", {
organizationId: "string",
actionBatchId: "string",
actions: [{
body: "string",
operation: "string",
resource: "string",
}],
callback: {
httpServer: {
id: "string",
},
id: "string",
payloadTemplate: {
id: "string",
},
sharedSecret: "string",
status: "string",
url: "string",
},
confirmed: false,
synchronous: false,
});
type: meraki:organizations:ActionBatches
properties:
actionBatchId: string
actions:
- body: string
operation: string
resource: string
callback:
httpServer:
id: string
id: string
payloadTemplate:
id: string
sharedSecret: string
status: string
url: string
confirmed: false
organizationId: string
synchronous: false
ActionBatches 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 ActionBatches resource accepts the following input properties:
- Organization
Id string - ID of the organization this action batch belongs to
- Action
Batch stringId - actionBatchId path parameter. Action batch ID
- Actions
List<Action
Batches Action> - A set of changes made as part of this action (\n\nmore details\n\n)
- Callback
Action
Batches Callback - Information for callback used to send back results
- Confirmed bool
- Flag describing whether the action should be previewed before executing or not
- Synchronous bool
- Flag describing whether actions should run synchronously or asynchronously
- Organization
Id string - ID of the organization this action batch belongs to
- Action
Batch stringId - actionBatchId path parameter. Action batch ID
- Actions
[]Action
Batches Action Args - A set of changes made as part of this action (\n\nmore details\n\n)
- Callback
Action
Batches Callback Args - Information for callback used to send back results
- Confirmed bool
- Flag describing whether the action should be previewed before executing or not
- Synchronous bool
- Flag describing whether actions should run synchronously or asynchronously
- organization
Id String - ID of the organization this action batch belongs to
- action
Batch StringId - actionBatchId path parameter. Action batch ID
- actions
List<Action
Batches Action> - A set of changes made as part of this action (\n\nmore details\n\n)
- callback
Action
Batches Callback - Information for callback used to send back results
- confirmed Boolean
- Flag describing whether the action should be previewed before executing or not
- synchronous Boolean
- Flag describing whether actions should run synchronously or asynchronously
- organization
Id string - ID of the organization this action batch belongs to
- action
Batch stringId - actionBatchId path parameter. Action batch ID
- actions
Action
Batches Action[] - A set of changes made as part of this action (\n\nmore details\n\n)
- callback
Action
Batches Callback - Information for callback used to send back results
- confirmed boolean
- Flag describing whether the action should be previewed before executing or not
- synchronous boolean
- Flag describing whether actions should run synchronously or asynchronously
- organization_
id str - ID of the organization this action batch belongs to
- action_
batch_ strid - actionBatchId path parameter. Action batch ID
- actions
Sequence[Action
Batches Action Args] - A set of changes made as part of this action (\n\nmore details\n\n)
- callback
Action
Batches Callback Args - Information for callback used to send back results
- confirmed bool
- Flag describing whether the action should be previewed before executing or not
- synchronous bool
- Flag describing whether actions should run synchronously or asynchronously
- organization
Id String - ID of the organization this action batch belongs to
- action
Batch StringId - actionBatchId path parameter. Action batch ID
- actions List<Property Map>
- A set of changes made as part of this action (\n\nmore details\n\n)
- callback Property Map
- Information for callback used to send back results
- confirmed Boolean
- Flag describing whether the action should be previewed before executing or not
- synchronous Boolean
- Flag describing whether actions should run synchronously or asynchronously
Outputs
All input properties are implicitly available as output properties. Additionally, the ActionBatches resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Status
Action
Batches Status - Status of action batch
- Id string
- The provider-assigned unique ID for this managed resource.
- Status
Action
Batches Status - Status of action batch
- id String
- The provider-assigned unique ID for this managed resource.
- status
Action
Batches Status - Status of action batch
- id string
- The provider-assigned unique ID for this managed resource.
- status
Action
Batches Status - Status of action batch
- id str
- The provider-assigned unique ID for this managed resource.
- status
Action
Batches Status - Status of action batch
- id String
- The provider-assigned unique ID for this managed resource.
- status Property Map
- Status of action batch
Look up Existing ActionBatches Resource
Get an existing ActionBatches 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?: ActionBatchesState, opts?: CustomResourceOptions): ActionBatches
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
action_batch_id: Optional[str] = None,
actions: Optional[Sequence[ActionBatchesActionArgs]] = None,
callback: Optional[ActionBatchesCallbackArgs] = None,
confirmed: Optional[bool] = None,
organization_id: Optional[str] = None,
status: Optional[ActionBatchesStatusArgs] = None,
synchronous: Optional[bool] = None) -> ActionBatches
func GetActionBatches(ctx *Context, name string, id IDInput, state *ActionBatchesState, opts ...ResourceOption) (*ActionBatches, error)
public static ActionBatches Get(string name, Input<string> id, ActionBatchesState? state, CustomResourceOptions? opts = null)
public static ActionBatches get(String name, Output<String> id, ActionBatchesState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- Action
Batch stringId - actionBatchId path parameter. Action batch ID
- Actions
List<Action
Batches Action> - A set of changes made as part of this action (\n\nmore details\n\n)
- Callback
Action
Batches Callback - Information for callback used to send back results
- Confirmed bool
- Flag describing whether the action should be previewed before executing or not
- Organization
Id string - ID of the organization this action batch belongs to
- Status
Action
Batches Status - Status of action batch
- Synchronous bool
- Flag describing whether actions should run synchronously or asynchronously
- Action
Batch stringId - actionBatchId path parameter. Action batch ID
- Actions
[]Action
Batches Action Args - A set of changes made as part of this action (\n\nmore details\n\n)
- Callback
Action
Batches Callback Args - Information for callback used to send back results
- Confirmed bool
- Flag describing whether the action should be previewed before executing or not
- Organization
Id string - ID of the organization this action batch belongs to
- Status
Action
Batches Status Args - Status of action batch
- Synchronous bool
- Flag describing whether actions should run synchronously or asynchronously
- action
Batch StringId - actionBatchId path parameter. Action batch ID
- actions
List<Action
Batches Action> - A set of changes made as part of this action (\n\nmore details\n\n)
- callback
Action
Batches Callback - Information for callback used to send back results
- confirmed Boolean
- Flag describing whether the action should be previewed before executing or not
- organization
Id String - ID of the organization this action batch belongs to
- status
Action
Batches Status - Status of action batch
- synchronous Boolean
- Flag describing whether actions should run synchronously or asynchronously
- action
Batch stringId - actionBatchId path parameter. Action batch ID
- actions
Action
Batches Action[] - A set of changes made as part of this action (\n\nmore details\n\n)
- callback
Action
Batches Callback - Information for callback used to send back results
- confirmed boolean
- Flag describing whether the action should be previewed before executing or not
- organization
Id string - ID of the organization this action batch belongs to
- status
Action
Batches Status - Status of action batch
- synchronous boolean
- Flag describing whether actions should run synchronously or asynchronously
- action_
batch_ strid - actionBatchId path parameter. Action batch ID
- actions
Sequence[Action
Batches Action Args] - A set of changes made as part of this action (\n\nmore details\n\n)
- callback
Action
Batches Callback Args - Information for callback used to send back results
- confirmed bool
- Flag describing whether the action should be previewed before executing or not
- organization_
id str - ID of the organization this action batch belongs to
- status
Action
Batches Status Args - Status of action batch
- synchronous bool
- Flag describing whether actions should run synchronously or asynchronously
- action
Batch StringId - actionBatchId path parameter. Action batch ID
- actions List<Property Map>
- A set of changes made as part of this action (\n\nmore details\n\n)
- callback Property Map
- Information for callback used to send back results
- confirmed Boolean
- Flag describing whether the action should be previewed before executing or not
- organization
Id String - ID of the organization this action batch belongs to
- status Property Map
- Status of action batch
- synchronous Boolean
- Flag describing whether actions should run synchronously or asynchronously
Supporting Types
ActionBatchesAction, ActionBatchesActionArgs
ActionBatchesCallback, ActionBatchesCallbackArgs
- Http
Server ActionBatches Callback Http Server - The webhook receiver used for the callback webhook.
- Id string
- The ID of the callback. To check the status of the callback, use this ID in a request to /webhooks/callbacks/statuses/{id}
- Payload
Template ActionBatches Callback Payload Template - The payload template of the webhook used for the callback
- string
- A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
- Status string
- The status of the callback
- Url string
- The callback URL for the webhook target. This was either provided in the original request or comes from a configured webhook receiver
- Http
Server ActionBatches Callback Http Server - The webhook receiver used for the callback webhook.
- Id string
- The ID of the callback. To check the status of the callback, use this ID in a request to /webhooks/callbacks/statuses/{id}
- Payload
Template ActionBatches Callback Payload Template - The payload template of the webhook used for the callback
- string
- A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
- Status string
- The status of the callback
- Url string
- The callback URL for the webhook target. This was either provided in the original request or comes from a configured webhook receiver
- http
Server ActionBatches Callback Http Server - The webhook receiver used for the callback webhook.
- id String
- The ID of the callback. To check the status of the callback, use this ID in a request to /webhooks/callbacks/statuses/{id}
- payload
Template ActionBatches Callback Payload Template - The payload template of the webhook used for the callback
- String
- A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
- status String
- The status of the callback
- url String
- The callback URL for the webhook target. This was either provided in the original request or comes from a configured webhook receiver
- http
Server ActionBatches Callback Http Server - The webhook receiver used for the callback webhook.
- id string
- The ID of the callback. To check the status of the callback, use this ID in a request to /webhooks/callbacks/statuses/{id}
- payload
Template ActionBatches Callback Payload Template - The payload template of the webhook used for the callback
- string
- A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
- status string
- The status of the callback
- url string
- The callback URL for the webhook target. This was either provided in the original request or comes from a configured webhook receiver
- http_
server ActionBatches Callback Http Server - The webhook receiver used for the callback webhook.
- id str
- The ID of the callback. To check the status of the callback, use this ID in a request to /webhooks/callbacks/statuses/{id}
- payload_
template ActionBatches Callback Payload Template - The payload template of the webhook used for the callback
- str
- A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
- status str
- The status of the callback
- url str
- The callback URL for the webhook target. This was either provided in the original request or comes from a configured webhook receiver
- http
Server Property Map - The webhook receiver used for the callback webhook.
- id String
- The ID of the callback. To check the status of the callback, use this ID in a request to /webhooks/callbacks/statuses/{id}
- payload
Template Property Map - The payload template of the webhook used for the callback
- String
- A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
- status String
- The status of the callback
- url String
- The callback URL for the webhook target. This was either provided in the original request or comes from a configured webhook receiver
ActionBatchesCallbackHttpServer, ActionBatchesCallbackHttpServerArgs
- Id string
- The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.
- Id string
- The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.
- id String
- The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.
- id string
- The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.
- id str
- The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.
- id String
- The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.
ActionBatchesCallbackPayloadTemplate, ActionBatchesCallbackPayloadTemplateArgs
- Id string
- The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.
- Id string
- The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.
- id String
- The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.
- id string
- The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.
- id str
- The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.
- id String
- The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.
ActionBatchesStatus, ActionBatchesStatusArgs
- Completed bool
- Flag describing whether all actions in the action batch have completed
- Created
Resources List<ActionBatches Status Created Resource> - Resources created as a result of this action batch
- Errors List<string>
- List of errors encountered when running actions in the action batch
- Failed bool
- Flag describing whether any actions in the action batch failed
- Completed bool
- Flag describing whether all actions in the action batch have completed
- Created
Resources []ActionBatches Status Created Resource - Resources created as a result of this action batch
- Errors []string
- List of errors encountered when running actions in the action batch
- Failed bool
- Flag describing whether any actions in the action batch failed
- completed Boolean
- Flag describing whether all actions in the action batch have completed
- created
Resources List<ActionBatches Status Created Resource> - Resources created as a result of this action batch
- errors List<String>
- List of errors encountered when running actions in the action batch
- failed Boolean
- Flag describing whether any actions in the action batch failed
- completed boolean
- Flag describing whether all actions in the action batch have completed
- created
Resources ActionBatches Status Created Resource[] - Resources created as a result of this action batch
- errors string[]
- List of errors encountered when running actions in the action batch
- failed boolean
- Flag describing whether any actions in the action batch failed
- completed bool
- Flag describing whether all actions in the action batch have completed
- created_
resources Sequence[ActionBatches Status Created Resource] - Resources created as a result of this action batch
- errors Sequence[str]
- List of errors encountered when running actions in the action batch
- failed bool
- Flag describing whether any actions in the action batch failed
- completed Boolean
- Flag describing whether all actions in the action batch have completed
- created
Resources List<Property Map> - Resources created as a result of this action batch
- errors List<String>
- List of errors encountered when running actions in the action batch
- failed Boolean
- Flag describing whether any actions in the action batch failed
ActionBatchesStatusCreatedResource, ActionBatchesStatusCreatedResourceArgs
Import
$ pulumi import meraki:organizations/actionBatches:ActionBatches example "action_batch_id,organization_id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- meraki pulumi/pulumi-meraki
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
meraki
Terraform Provider.