formal.PolicyDataLoader
Explore with Pulumi AI
Registering a policy data loader with Formal.
Create PolicyDataLoader Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PolicyDataLoader(name: string, args: PolicyDataLoaderArgs, opts?: CustomResourceOptions);
@overload
def PolicyDataLoader(resource_name: str,
args: PolicyDataLoaderArgs,
opts: Optional[ResourceOptions] = None)
@overload
def PolicyDataLoader(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
key: Optional[str] = None,
status: Optional[str] = None,
worker_code: Optional[str] = None,
worker_runtime: Optional[str] = None,
worker_schedule: Optional[str] = None,
name: Optional[str] = None,
termination_protection: Optional[bool] = None)
func NewPolicyDataLoader(ctx *Context, name string, args PolicyDataLoaderArgs, opts ...ResourceOption) (*PolicyDataLoader, error)
public PolicyDataLoader(string name, PolicyDataLoaderArgs args, CustomResourceOptions? opts = null)
public PolicyDataLoader(String name, PolicyDataLoaderArgs args)
public PolicyDataLoader(String name, PolicyDataLoaderArgs args, CustomResourceOptions options)
type: formal:PolicyDataLoader
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 PolicyDataLoaderArgs
- 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 PolicyDataLoaderArgs
- 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 PolicyDataLoaderArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PolicyDataLoaderArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PolicyDataLoaderArgs
- 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 policyDataLoaderResource = new Pulumi.PolicyDataLoader("policyDataLoaderResource", new()
{
Description = "string",
Key = "string",
Status = "string",
WorkerCode = "string",
WorkerRuntime = "string",
WorkerSchedule = "string",
Name = "string",
TerminationProtection = false,
});
example, err := formal.NewPolicyDataLoader(ctx, "policyDataLoaderResource", &formal.PolicyDataLoaderArgs{
Description: pulumi.String("string"),
Key: pulumi.String("string"),
Status: pulumi.String("string"),
WorkerCode: pulumi.String("string"),
WorkerRuntime: pulumi.String("string"),
WorkerSchedule: pulumi.String("string"),
Name: pulumi.String("string"),
TerminationProtection: pulumi.Bool(false),
})
var policyDataLoaderResource = new PolicyDataLoader("policyDataLoaderResource", PolicyDataLoaderArgs.builder()
.description("string")
.key("string")
.status("string")
.workerCode("string")
.workerRuntime("string")
.workerSchedule("string")
.name("string")
.terminationProtection(false)
.build());
policy_data_loader_resource = formal.PolicyDataLoader("policyDataLoaderResource",
description="string",
key="string",
status="string",
worker_code="string",
worker_runtime="string",
worker_schedule="string",
name="string",
termination_protection=False)
const policyDataLoaderResource = new formal.PolicyDataLoader("policyDataLoaderResource", {
description: "string",
key: "string",
status: "string",
workerCode: "string",
workerRuntime: "string",
workerSchedule: "string",
name: "string",
terminationProtection: false,
});
type: formal:PolicyDataLoader
properties:
description: string
key: string
name: string
status: string
terminationProtection: false
workerCode: string
workerRuntime: string
workerSchedule: string
PolicyDataLoader 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 PolicyDataLoader resource accepts the following input properties:
- Description string
- Policy data loader description.
- Key string
- The key to access the output data of this policy data loader.
- Status string
- Defines the current status of the policy data loader. It can be one of the following: 'draft' or 'active'.
- Worker
Code string - The code that will be executed to fetch and output the data.
- Worker
Runtime string - The execution environment for the code. It can be one of the following: 'python3.11' or 'nodejs18.x'.
- Worker
Schedule string - Second-based 'cron' expression specifying when the data should be fetched. For example, use '*/10 * * * * *' to run the code every 10 seconds.
- Name string
- Friendly name for this policy data loader.
- Termination
Protection bool - If set to true, this policy data loader cannot be deleted.
- Description string
- Policy data loader description.
- Key string
- The key to access the output data of this policy data loader.
- Status string
- Defines the current status of the policy data loader. It can be one of the following: 'draft' or 'active'.
- Worker
Code string - The code that will be executed to fetch and output the data.
- Worker
Runtime string - The execution environment for the code. It can be one of the following: 'python3.11' or 'nodejs18.x'.
- Worker
Schedule string - Second-based 'cron' expression specifying when the data should be fetched. For example, use '*/10 * * * * *' to run the code every 10 seconds.
- Name string
- Friendly name for this policy data loader.
- Termination
Protection bool - If set to true, this policy data loader cannot be deleted.
- description String
- Policy data loader description.
- key String
- The key to access the output data of this policy data loader.
- status String
- Defines the current status of the policy data loader. It can be one of the following: 'draft' or 'active'.
- worker
Code String - The code that will be executed to fetch and output the data.
- worker
Runtime String - The execution environment for the code. It can be one of the following: 'python3.11' or 'nodejs18.x'.
- worker
Schedule String - Second-based 'cron' expression specifying when the data should be fetched. For example, use '*/10 * * * * *' to run the code every 10 seconds.
- name String
- Friendly name for this policy data loader.
- termination
Protection Boolean - If set to true, this policy data loader cannot be deleted.
- description string
- Policy data loader description.
- key string
- The key to access the output data of this policy data loader.
- status string
- Defines the current status of the policy data loader. It can be one of the following: 'draft' or 'active'.
- worker
Code string - The code that will be executed to fetch and output the data.
- worker
Runtime string - The execution environment for the code. It can be one of the following: 'python3.11' or 'nodejs18.x'.
- worker
Schedule string - Second-based 'cron' expression specifying when the data should be fetched. For example, use '*/10 * * * * *' to run the code every 10 seconds.
- name string
- Friendly name for this policy data loader.
- termination
Protection boolean - If set to true, this policy data loader cannot be deleted.
- description str
- Policy data loader description.
- key str
- The key to access the output data of this policy data loader.
- status str
- Defines the current status of the policy data loader. It can be one of the following: 'draft' or 'active'.
- worker_
code str - The code that will be executed to fetch and output the data.
- worker_
runtime str - The execution environment for the code. It can be one of the following: 'python3.11' or 'nodejs18.x'.
- worker_
schedule str - Second-based 'cron' expression specifying when the data should be fetched. For example, use '*/10 * * * * *' to run the code every 10 seconds.
- name str
- Friendly name for this policy data loader.
- termination_
protection bool - If set to true, this policy data loader cannot be deleted.
- description String
- Policy data loader description.
- key String
- The key to access the output data of this policy data loader.
- status String
- Defines the current status of the policy data loader. It can be one of the following: 'draft' or 'active'.
- worker
Code String - The code that will be executed to fetch and output the data.
- worker
Runtime String - The execution environment for the code. It can be one of the following: 'python3.11' or 'nodejs18.x'.
- worker
Schedule String - Second-based 'cron' expression specifying when the data should be fetched. For example, use '*/10 * * * * *' to run the code every 10 seconds.
- name String
- Friendly name for this policy data loader.
- termination
Protection Boolean - If set to true, this policy data loader cannot be deleted.
Outputs
All input properties are implicitly available as output properties. Additionally, the PolicyDataLoader resource produces the following output properties:
- created_
at str - When the policy data loader was created.
- id str
- The provider-assigned unique ID for this managed resource.
- updated_
at str - Last update time.
Look up Existing PolicyDataLoader Resource
Get an existing PolicyDataLoader 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?: PolicyDataLoaderState, opts?: CustomResourceOptions): PolicyDataLoader
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
created_at: Optional[str] = None,
description: Optional[str] = None,
key: Optional[str] = None,
name: Optional[str] = None,
status: Optional[str] = None,
termination_protection: Optional[bool] = None,
updated_at: Optional[str] = None,
worker_code: Optional[str] = None,
worker_runtime: Optional[str] = None,
worker_schedule: Optional[str] = None) -> PolicyDataLoader
func GetPolicyDataLoader(ctx *Context, name string, id IDInput, state *PolicyDataLoaderState, opts ...ResourceOption) (*PolicyDataLoader, error)
public static PolicyDataLoader Get(string name, Input<string> id, PolicyDataLoaderState? state, CustomResourceOptions? opts = null)
public static PolicyDataLoader get(String name, Output<String> id, PolicyDataLoaderState state, CustomResourceOptions options)
resources: _: type: formal:PolicyDataLoader get: id: ${id}
- 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.
- Created
At string - When the policy data loader was created.
- Description string
- Policy data loader description.
- Key string
- The key to access the output data of this policy data loader.
- Name string
- Friendly name for this policy data loader.
- Status string
- Defines the current status of the policy data loader. It can be one of the following: 'draft' or 'active'.
- Termination
Protection bool - If set to true, this policy data loader cannot be deleted.
- Updated
At string - Last update time.
- Worker
Code string - The code that will be executed to fetch and output the data.
- Worker
Runtime string - The execution environment for the code. It can be one of the following: 'python3.11' or 'nodejs18.x'.
- Worker
Schedule string - Second-based 'cron' expression specifying when the data should be fetched. For example, use '*/10 * * * * *' to run the code every 10 seconds.
- Created
At string - When the policy data loader was created.
- Description string
- Policy data loader description.
- Key string
- The key to access the output data of this policy data loader.
- Name string
- Friendly name for this policy data loader.
- Status string
- Defines the current status of the policy data loader. It can be one of the following: 'draft' or 'active'.
- Termination
Protection bool - If set to true, this policy data loader cannot be deleted.
- Updated
At string - Last update time.
- Worker
Code string - The code that will be executed to fetch and output the data.
- Worker
Runtime string - The execution environment for the code. It can be one of the following: 'python3.11' or 'nodejs18.x'.
- Worker
Schedule string - Second-based 'cron' expression specifying when the data should be fetched. For example, use '*/10 * * * * *' to run the code every 10 seconds.
- created
At String - When the policy data loader was created.
- description String
- Policy data loader description.
- key String
- The key to access the output data of this policy data loader.
- name String
- Friendly name for this policy data loader.
- status String
- Defines the current status of the policy data loader. It can be one of the following: 'draft' or 'active'.
- termination
Protection Boolean - If set to true, this policy data loader cannot be deleted.
- updated
At String - Last update time.
- worker
Code String - The code that will be executed to fetch and output the data.
- worker
Runtime String - The execution environment for the code. It can be one of the following: 'python3.11' or 'nodejs18.x'.
- worker
Schedule String - Second-based 'cron' expression specifying when the data should be fetched. For example, use '*/10 * * * * *' to run the code every 10 seconds.
- created
At string - When the policy data loader was created.
- description string
- Policy data loader description.
- key string
- The key to access the output data of this policy data loader.
- name string
- Friendly name for this policy data loader.
- status string
- Defines the current status of the policy data loader. It can be one of the following: 'draft' or 'active'.
- termination
Protection boolean - If set to true, this policy data loader cannot be deleted.
- updated
At string - Last update time.
- worker
Code string - The code that will be executed to fetch and output the data.
- worker
Runtime string - The execution environment for the code. It can be one of the following: 'python3.11' or 'nodejs18.x'.
- worker
Schedule string - Second-based 'cron' expression specifying when the data should be fetched. For example, use '*/10 * * * * *' to run the code every 10 seconds.
- created_
at str - When the policy data loader was created.
- description str
- Policy data loader description.
- key str
- The key to access the output data of this policy data loader.
- name str
- Friendly name for this policy data loader.
- status str
- Defines the current status of the policy data loader. It can be one of the following: 'draft' or 'active'.
- termination_
protection bool - If set to true, this policy data loader cannot be deleted.
- updated_
at str - Last update time.
- worker_
code str - The code that will be executed to fetch and output the data.
- worker_
runtime str - The execution environment for the code. It can be one of the following: 'python3.11' or 'nodejs18.x'.
- worker_
schedule str - Second-based 'cron' expression specifying when the data should be fetched. For example, use '*/10 * * * * *' to run the code every 10 seconds.
- created
At String - When the policy data loader was created.
- description String
- Policy data loader description.
- key String
- The key to access the output data of this policy data loader.
- name String
- Friendly name for this policy data loader.
- status String
- Defines the current status of the policy data loader. It can be one of the following: 'draft' or 'active'.
- termination
Protection Boolean - If set to true, this policy data loader cannot be deleted.
- updated
At String - Last update time.
- worker
Code String - The code that will be executed to fetch and output the data.
- worker
Runtime String - The execution environment for the code. It can be one of the following: 'python3.11' or 'nodejs18.x'.
- worker
Schedule String - Second-based 'cron' expression specifying when the data should be fetched. For example, use '*/10 * * * * *' to run the code every 10 seconds.
Package Details
- Repository
- formal formalco/pulumi-formal
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
formal
Terraform Provider.