pulumi/_index.md at master

30 KiB

Raw Permalink Blame History

title: "ExampleServer" title_tag: "example.ExampleServer" meta_desc: "Documentation for the example.ExampleServer resource with examples, input properties, output properties, lookup functions, and supporting types." layout: api no_edit_this_page: true

Create ExampleServer Resource

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

Constructor syntax

new ExampleServer(name: string, args?: ExampleServerArgs, opts?: CustomResourceOptions);

@overload
def ExampleServer(resource_name: str,
                  args: Optional[ExampleServerArgs] = None,
                  opts: Optional[ResourceOptions] = None)

@overload
def ExampleServer(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  properties_collection: Optional[Sequence[Union[ServerPropertiesForReplicaArgs, ServerPropertiesForRestoreArgs]]] = None)

func NewExampleServer(ctx *Context, name string, args *ExampleServerArgs, opts ...ResourceOption) (*ExampleServer, error)

public ExampleServer(string name, ExampleServerArgs? args = null, CustomResourceOptions? opts = null)

public ExampleServer(String name, ExampleServerArgs args)
public ExampleServer(String name, ExampleServerArgs args, CustomResourceOptions options)

type: example:ExampleServer
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 ExampleServerArgs: 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 ExampleServerArgs: 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 ExampleServerArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ExampleServerArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ExampleServerArgs: 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 exampleServerResource = new Example.ExampleServer("exampleServerResource", new()
{
    PropertiesCollection = new[]
    {
        new Example.Inputs.ServerPropertiesForReplicaArgs
        {
            CreateMode = "Replica",
            Version = "string",
        },
    },
});

example, err := example.NewExampleServer(ctx, "exampleServerResource", &example.ExampleServerArgs{
	PropertiesCollection: pulumi.Array{
		example.ServerPropertiesForReplica{
			CreateMode: "Replica",
			Version:    "string",
		},
	},
})

var exampleServerResource = new ExampleServer("exampleServerResource", ExampleServerArgs.builder()
    .propertiesCollection(ServerPropertiesForReplicaArgs.builder()
        .createMode("Replica")
        .version("string")
        .build())
    .build());

example_server_resource = example.ExampleServer("exampleServerResource", properties_collection=[{
    "create_mode": "Replica",
    "version": "string",
}])

const exampleServerResource = new example.ExampleServer("exampleServerResource", {propertiesCollection: [{
    createMode: "Replica",
    version: "string",
}]});

type: example:ExampleServer
properties:
    propertiesCollection:
        - createMode: Replica
          version: string

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

PropertiesCollection List<Union<ServerPropertiesForReplica, ServerPropertiesForRestoreArgs>>

PropertiesCollection []interface{}

propertiesCollection List<Either<ServerPropertiesForReplica,ServerPropertiesForRestoreArgs>>

propertiesCollection (ServerPropertiesForReplica | ServerPropertiesForRestoreArgs)[]

properties_collection Sequence[Union[ServerPropertiesForReplicaArgs, ServerPropertiesForRestoreArgs]]

propertiesCollection List<Property Map | Property Map>

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
Name string