# coding=utf-8 # *** WARNING: this file was generated by pulumi-language-python. *** # *** Do not edit by hand unless you're certain you know what you are doing! *** import builtins as _builtins import warnings import sys import pulumi import pulumi.runtime from typing import Any, Mapping, Optional, Sequence, Union, overload if sys.version_info >= (3, 11): from typing import NotRequired, TypedDict, TypeAlias else: from typing_extensions import NotRequired, TypedDict, TypeAlias from . import _utilities __all__ = ['EnvironmentArgs', 'Environment'] @pulumi.input_type class EnvironmentArgs: def __init__(__self__, *, project_id: pulumi.Input[_builtins.str], description: Optional[pulumi.Input[_builtins.str]] = None, env: Optional[pulumi.Input[_builtins.str]] = None, name: Optional[pulumi.Input[_builtins.str]] = None): """ The set of arguments for constructing a Environment resource. :param pulumi.Input[_builtins.str] project_id: Project this environment belongs to. :param pulumi.Input[_builtins.str] description: Free-form description. :param pulumi.Input[_builtins.str] env: Environment-wide variables in `KEY=value` format, one per line. These are merged into every service in this environment. :param pulumi.Input[_builtins.str] name: Environment name, for example `staging`. """ pulumi.set(__self__, "project_id", project_id) if description is not None: pulumi.set(__self__, "description", description) if env is not None: pulumi.set(__self__, "env", env) if name is not None: pulumi.set(__self__, "name", name) @_builtins.property @pulumi.getter(name="projectId") def project_id(self) -> pulumi.Input[_builtins.str]: """ Project this environment belongs to. """ return pulumi.get(self, "project_id") @project_id.setter def project_id(self, value: pulumi.Input[_builtins.str]): pulumi.set(self, "project_id", value) @_builtins.property @pulumi.getter def description(self) -> Optional[pulumi.Input[_builtins.str]]: """ Free-form description. """ return pulumi.get(self, "description") @description.setter def description(self, value: Optional[pulumi.Input[_builtins.str]]): pulumi.set(self, "description", value) @_builtins.property @pulumi.getter def env(self) -> Optional[pulumi.Input[_builtins.str]]: """ Environment-wide variables in `KEY=value` format, one per line. These are merged into every service in this environment. """ return pulumi.get(self, "env") @env.setter def env(self, value: Optional[pulumi.Input[_builtins.str]]): pulumi.set(self, "env", value) @_builtins.property @pulumi.getter def name(self) -> Optional[pulumi.Input[_builtins.str]]: """ Environment name, for example `staging`. """ return pulumi.get(self, "name") @name.setter def name(self, value: Optional[pulumi.Input[_builtins.str]]): pulumi.set(self, "name", value) @pulumi.input_type class _EnvironmentState: def __init__(__self__, *, created_at: Optional[pulumi.Input[_builtins.str]] = None, description: Optional[pulumi.Input[_builtins.str]] = None, env: Optional[pulumi.Input[_builtins.str]] = None, is_default: Optional[pulumi.Input[_builtins.bool]] = None, name: Optional[pulumi.Input[_builtins.str]] = None, project_id: Optional[pulumi.Input[_builtins.str]] = None): """ Input properties used for looking up and filtering Environment resources. :param pulumi.Input[_builtins.str] created_at: RFC 3339 timestamp of when the environment was created. :param pulumi.Input[_builtins.str] description: Free-form description. :param pulumi.Input[_builtins.str] env: Environment-wide variables in `KEY=value` format, one per line. These are merged into every service in this environment. :param pulumi.Input[_builtins.bool] is_default: Whether this is the project's default environment. :param pulumi.Input[_builtins.str] name: Environment name, for example `staging`. :param pulumi.Input[_builtins.str] project_id: Project this environment belongs to. """ if created_at is not None: pulumi.set(__self__, "created_at", created_at) if description is not None: pulumi.set(__self__, "description", description) if env is not None: pulumi.set(__self__, "env", env) if is_default is not None: pulumi.set(__self__, "is_default", is_default) if name is not None: pulumi.set(__self__, "name", name) if project_id is not None: pulumi.set(__self__, "project_id", project_id) @_builtins.property @pulumi.getter(name="createdAt") def created_at(self) -> Optional[pulumi.Input[_builtins.str]]: """ RFC 3339 timestamp of when the environment was created. """ return pulumi.get(self, "created_at") @created_at.setter def created_at(self, value: Optional[pulumi.Input[_builtins.str]]): pulumi.set(self, "created_at", value) @_builtins.property @pulumi.getter def description(self) -> Optional[pulumi.Input[_builtins.str]]: """ Free-form description. """ return pulumi.get(self, "description") @description.setter def description(self, value: Optional[pulumi.Input[_builtins.str]]): pulumi.set(self, "description", value) @_builtins.property @pulumi.getter def env(self) -> Optional[pulumi.Input[_builtins.str]]: """ Environment-wide variables in `KEY=value` format, one per line. These are merged into every service in this environment. """ return pulumi.get(self, "env") @env.setter def env(self, value: Optional[pulumi.Input[_builtins.str]]): pulumi.set(self, "env", value) @_builtins.property @pulumi.getter(name="isDefault") def is_default(self) -> Optional[pulumi.Input[_builtins.bool]]: """ Whether this is the project's default environment. """ return pulumi.get(self, "is_default") @is_default.setter def is_default(self, value: Optional[pulumi.Input[_builtins.bool]]): pulumi.set(self, "is_default", value) @_builtins.property @pulumi.getter def name(self) -> Optional[pulumi.Input[_builtins.str]]: """ Environment name, for example `staging`. """ return pulumi.get(self, "name") @name.setter def name(self, value: Optional[pulumi.Input[_builtins.str]]): pulumi.set(self, "name", value) @_builtins.property @pulumi.getter(name="projectId") def project_id(self) -> Optional[pulumi.Input[_builtins.str]]: """ Project this environment belongs to. """ return pulumi.get(self, "project_id") @project_id.setter def project_id(self, value: Optional[pulumi.Input[_builtins.str]]): pulumi.set(self, "project_id", value) @pulumi.type_token("dokploy:index/environment:Environment") class Environment(pulumi.CustomResource): @overload def __init__(__self__, resource_name: str, opts: Optional[pulumi.ResourceOptions] = None, description: Optional[pulumi.Input[_builtins.str]] = None, env: Optional[pulumi.Input[_builtins.str]] = None, name: Optional[pulumi.Input[_builtins.str]] = None, project_id: Optional[pulumi.Input[_builtins.str]] = None, __props__=None): """ Create a Environment resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[_builtins.str] description: Free-form description. :param pulumi.Input[_builtins.str] env: Environment-wide variables in `KEY=value` format, one per line. These are merged into every service in this environment. :param pulumi.Input[_builtins.str] name: Environment name, for example `staging`. :param pulumi.Input[_builtins.str] project_id: Project this environment belongs to. """ ... @overload def __init__(__self__, resource_name: str, args: EnvironmentArgs, opts: Optional[pulumi.ResourceOptions] = None): """ Create a Environment resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param EnvironmentArgs args: The arguments to use to populate this resource's properties. :param pulumi.ResourceOptions opts: Options for the resource. """ ... def __init__(__self__, resource_name: str, *args, **kwargs): resource_args, opts = _utilities.get_resource_args_opts(EnvironmentArgs, pulumi.ResourceOptions, *args, **kwargs) if resource_args is not None: __self__._internal_init(resource_name, opts, **resource_args.__dict__) else: __self__._internal_init(resource_name, *args, **kwargs) def _internal_init(__self__, resource_name: str, opts: Optional[pulumi.ResourceOptions] = None, description: Optional[pulumi.Input[_builtins.str]] = None, env: Optional[pulumi.Input[_builtins.str]] = None, name: Optional[pulumi.Input[_builtins.str]] = None, project_id: Optional[pulumi.Input[_builtins.str]] = None, __props__=None): opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts) if not isinstance(opts, pulumi.ResourceOptions): raise TypeError('Expected resource options to be a ResourceOptions instance') if opts.id is None: if __props__ is not None: raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource') __props__ = EnvironmentArgs.__new__(EnvironmentArgs) __props__.__dict__["description"] = description __props__.__dict__["env"] = env __props__.__dict__["name"] = name if project_id is None and not opts.urn: raise TypeError("Missing required property 'project_id'") __props__.__dict__["project_id"] = project_id __props__.__dict__["created_at"] = None __props__.__dict__["is_default"] = None super(Environment, __self__).__init__( 'dokploy:index/environment:Environment', resource_name, __props__, opts) @staticmethod def get(resource_name: str, id: pulumi.Input[str], opts: Optional[pulumi.ResourceOptions] = None, created_at: Optional[pulumi.Input[_builtins.str]] = None, description: Optional[pulumi.Input[_builtins.str]] = None, env: Optional[pulumi.Input[_builtins.str]] = None, is_default: Optional[pulumi.Input[_builtins.bool]] = None, name: Optional[pulumi.Input[_builtins.str]] = None, project_id: Optional[pulumi.Input[_builtins.str]] = None) -> 'Environment': """ Get an existing Environment resource's state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param pulumi.Input[str] id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[_builtins.str] created_at: RFC 3339 timestamp of when the environment was created. :param pulumi.Input[_builtins.str] description: Free-form description. :param pulumi.Input[_builtins.str] env: Environment-wide variables in `KEY=value` format, one per line. These are merged into every service in this environment. :param pulumi.Input[_builtins.bool] is_default: Whether this is the project's default environment. :param pulumi.Input[_builtins.str] name: Environment name, for example `staging`. :param pulumi.Input[_builtins.str] project_id: Project this environment belongs to. """ opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id)) __props__ = _EnvironmentState.__new__(_EnvironmentState) __props__.__dict__["created_at"] = created_at __props__.__dict__["description"] = description __props__.__dict__["env"] = env __props__.__dict__["is_default"] = is_default __props__.__dict__["name"] = name __props__.__dict__["project_id"] = project_id return Environment(resource_name, opts=opts, __props__=__props__) @_builtins.property @pulumi.getter(name="createdAt") def created_at(self) -> pulumi.Output[_builtins.str]: """ RFC 3339 timestamp of when the environment was created. """ return pulumi.get(self, "created_at") @_builtins.property @pulumi.getter def description(self) -> pulumi.Output[Optional[_builtins.str]]: """ Free-form description. """ return pulumi.get(self, "description") @_builtins.property @pulumi.getter def env(self) -> pulumi.Output[_builtins.str]: """ Environment-wide variables in `KEY=value` format, one per line. These are merged into every service in this environment. """ return pulumi.get(self, "env") @_builtins.property @pulumi.getter(name="isDefault") def is_default(self) -> pulumi.Output[_builtins.bool]: """ Whether this is the project's default environment. """ return pulumi.get(self, "is_default") @_builtins.property @pulumi.getter def name(self) -> pulumi.Output[_builtins.str]: """ Environment name, for example `staging`. """ return pulumi.get(self, "name") @_builtins.property @pulumi.getter(name="projectId") def project_id(self) -> pulumi.Output[_builtins.str]: """ Project this environment belongs to. """ return pulumi.get(self, "project_id")