mirrors
/
pulumi
mirror of https://github.com/pulumi/pulumi.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
pulumi/tests/testdata/codegen/provider-config-schema/docs/provider/_index.md

29 KiB
Raw Permalink Blame History

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

Create Provider Resource

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

Constructor syntax

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

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             favorite_color: Optional[Union[str, Color]] = None,
             secret_sandwiches: Optional[Sequence[_config.SandwichArgs]] = None)
func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)

type: pulumi:providers:configstation
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 ProviderArgs
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 ProviderArgs
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 ProviderArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ProviderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ProviderArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

FavoriteColor string | Configstation.Pulumi.Configstation.Color
this is a relaxed string enum which can also be set via env var It can also be sourced from the following environment variable: FAVE_COLOR
SecretSandwiches List<Configstation.Pulumi.Configstation.Config.Inputs.SandwichArgs>
Super duper secret sandwiches.
FavoriteColor string | Color
this is a relaxed string enum which can also be set via env var It can also be sourced from the following environment variable: FAVE_COLOR
SecretSandwiches SandwichArgs
Super duper secret sandwiches.
favoriteColor String | Color
this is a relaxed string enum which can also be set via env var It can also be sourced from the following environment variable: FAVE_COLOR
secretSandwiches List<SandwichArgs>
Super duper secret sandwiches.
favoriteColor string | Color
this is a relaxed string enum which can also be set via env var It can also be sourced from the following environment variable: FAVE_COLOR
secretSandwiches configSandwichArgs[]
Super duper secret sandwiches.
favorite_color str | Color
this is a relaxed string enum which can also be set via env var It can also be sourced from the following environment variable: FAVE_COLOR
secret_sandwiches Sequence[config.SandwichArgs]
Super duper secret sandwiches.
favoriteColor String | "blue" | "red"
this is a relaxed string enum which can also be set via env var It can also be sourced from the following environment variable: FAVE_COLOR
secretSandwiches List<Property Map>
Super duper secret sandwiches.

Outputs

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

Color, ColorArgs

Blue
blue
Red
red
ColorBlue
blue
ColorRed
red
Blue
blue
Red
red
Blue
blue
Red
red
BLUE
blue
RED
red
"blue"
blue
"red"
red

Sandwich, SandwichArgs

Bread string
Veggies List<string>
Bread string
Veggies []string
bread String
veggies List<String>
bread string
veggies string[]
bread str
veggies Sequence[str]
bread String
veggies List<String>

Package Details

Repository
configstation
License