Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. ACI
  3. API Docs
  4. apic
  5. Rest
ACI v0.0.6 published on Thursday, Aug 31, 2023 by Cisco
netascode/pulumi-aci

aci.apic.Rest

Explore with Pulumi AI

ACI v0.0.6 published on Thursday, Aug 31, 2023 by Cisco
netascode/pulumi-aci

Manages ACI Model Objects via REST API calls. This resource can only manage a single API object.

Create Rest Resource

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

Constructor syntax

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

@overload
def Rest(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         class_name: Optional[str] = None,
         dn: Optional[str] = None,
         children: Optional[Sequence[ChildArgs]] = None,
         content: Optional[Mapping[str, str]] = None)
func NewRest(ctx *Context, name string, args RestArgs, opts ...ResourceOption) (*Rest, error)
public Rest(string name, RestArgs args, CustomResourceOptions? opts = null)
public Rest(String name, RestArgs args)
public Rest(String name, RestArgs args, CustomResourceOptions options)

type: aci:apic:Rest
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. RestArgs
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. RestArgs
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. RestArgs
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. RestArgs
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. RestArgs
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 restResource = new Aci.Apic.Rest("restResource", new()
{
    Class_name = "string",
    Dn = "string",
    Children = new[]
    {
        new Aci.Apic.Inputs.ChildArgs
        {
            Class_name = "string",
            Rn = "string",
            Content = 
            {
                { "string", "string" },
            },
        },
    },
    Content = 
    {
        { "string", "string" },
    },
});
Copy
example, err := apic.NewRest(ctx, "restResource", &apic.RestArgs{
	Class_name: pulumi.String("string"),
	Dn:         pulumi.String("string"),
	Children: apic.ChildArray{
		&apic.ChildArgs{
			Class_name: pulumi.String("string"),
			Rn:         pulumi.String("string"),
			Content: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
		},
	},
	Content: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var restResource = new Rest("restResource", RestArgs.builder()
    .class_name("string")
    .dn("string")
    .children(ChildArgs.builder()
        .class_name("string")
        .rn("string")
        .content(Map.of("string", "string"))
        .build())
    .content(Map.of("string", "string"))
    .build());
Copy
rest_resource = aci.apic.Rest("restResource",
    class_name="string",
    dn="string",
    children=[{
        "class_name": "string",
        "rn": "string",
        "content": {
            "string": "string",
        },
    }],
    content={
        "string": "string",
    })
Copy
const restResource = new aci.apic.Rest("restResource", {
    class_name: "string",
    dn: "string",
    children: [{
        class_name: "string",
        rn: "string",
        content: {
            string: "string",
        },
    }],
    content: {
        string: "string",
    },
});
Copy
type: aci:apic:Rest
properties:
    children:
        - class_name: string
          content:
            string: string
          rn: string
    class_name: string
    content:
        string: string
    dn: string
Copy

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

Class_name This property is required. string
Which class object is being created. (Make sure there is no colon in the classname)
Dn This property is required. string
Distinguished name of object being managed including its relative name, e.g. uni/tn-EXAMPLE_TENANT.
Children List<Child>
List of child objects to be created. Each child object must have a unique relative name.
Content Dictionary<string, string>
Map of key-value pairs those needed to be passed to the Model object as parameters. Make sure the key name matches the name with the object parameter in ACI.
Class_name This property is required. string
Which class object is being created. (Make sure there is no colon in the classname)
Dn This property is required. string
Distinguished name of object being managed including its relative name, e.g. uni/tn-EXAMPLE_TENANT.
Children []ChildArgs
List of child objects to be created. Each child object must have a unique relative name.
Content map[string]string
Map of key-value pairs those needed to be passed to the Model object as parameters. Make sure the key name matches the name with the object parameter in ACI.
class_name This property is required. String
Which class object is being created. (Make sure there is no colon in the classname)
dn This property is required. String
Distinguished name of object being managed including its relative name, e.g. uni/tn-EXAMPLE_TENANT.
children List<Child>
List of child objects to be created. Each child object must have a unique relative name.
content Map<String,String>
Map of key-value pairs those needed to be passed to the Model object as parameters. Make sure the key name matches the name with the object parameter in ACI.
class_name This property is required. string
Which class object is being created. (Make sure there is no colon in the classname)
dn This property is required. string
Distinguished name of object being managed including its relative name, e.g. uni/tn-EXAMPLE_TENANT.
children Child[]
List of child objects to be created. Each child object must have a unique relative name.
content {[key: string]: string}
Map of key-value pairs those needed to be passed to the Model object as parameters. Make sure the key name matches the name with the object parameter in ACI.
class_name This property is required. str
Which class object is being created. (Make sure there is no colon in the classname)
dn This property is required. str
Distinguished name of object being managed including its relative name, e.g. uni/tn-EXAMPLE_TENANT.
children Sequence[ChildArgs]
List of child objects to be created. Each child object must have a unique relative name.
content Mapping[str, str]
Map of key-value pairs those needed to be passed to the Model object as parameters. Make sure the key name matches the name with the object parameter in ACI.
class_name This property is required. String
Which class object is being created. (Make sure there is no colon in the classname)
dn This property is required. String
Distinguished name of object being managed including its relative name, e.g. uni/tn-EXAMPLE_TENANT.
children List<Property Map>
List of child objects to be created. Each child object must have a unique relative name.
content Map<String>
Map of key-value pairs those needed to be passed to the Model object as parameters. Make sure the key name matches the name with the object parameter in ACI.

Outputs

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

Child
, ChildArgs

Class_name This property is required. string
Which class object is being created. (Make sure there is no colon in the classname)
Rn This property is required. string
Relative name of child object.
Content Dictionary<string, string>
Map of key-value pairs those needed to be passed to the Model object as parameters. Make sure the key name matches the name with the object parameter in ACI.
Class_name This property is required. string
Which class object is being created. (Make sure there is no colon in the classname)
Rn This property is required. string
Relative name of child object.
Content map[string]string
Map of key-value pairs those needed to be passed to the Model object as parameters. Make sure the key name matches the name with the object parameter in ACI.
class_name This property is required. String
Which class object is being created. (Make sure there is no colon in the classname)
rn This property is required. String
Relative name of child object.
content Map<String,String>
Map of key-value pairs those needed to be passed to the Model object as parameters. Make sure the key name matches the name with the object parameter in ACI.
class_name This property is required. string
Which class object is being created. (Make sure there is no colon in the classname)
rn This property is required. string
Relative name of child object.
content {[key: string]: string}
Map of key-value pairs those needed to be passed to the Model object as parameters. Make sure the key name matches the name with the object parameter in ACI.
class_name This property is required. str
Which class object is being created. (Make sure there is no colon in the classname)
rn This property is required. str
Relative name of child object.
content Mapping[str, str]
Map of key-value pairs those needed to be passed to the Model object as parameters. Make sure the key name matches the name with the object parameter in ACI.
class_name This property is required. String
Which class object is being created. (Make sure there is no colon in the classname)
rn This property is required. String
Relative name of child object.
content Map<String>
Map of key-value pairs those needed to be passed to the Model object as parameters. Make sure the key name matches the name with the object parameter in ACI.

Package Details

Repository
aci netascode/pulumi-aci
License
MPL-2.0
ACI v0.0.6 published on Thursday, Aug 31, 2023 by Cisco
netascode/pulumi-aci