Docs Home
Harbor v3.10.15 published on Saturday, Sep 28, 2024 by Pulumiverse
harbor.ConfigEmail
Explore with Pulumi AI
Example Usage
resource "harbor_config_email" "main" {
email_host = "server.acme.com"
email_from = "dont_reply@acme.com"
}
Create ConfigEmail Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ConfigEmail(name: string, args: ConfigEmailArgs, opts?: CustomResourceOptions);@overload
def ConfigEmail(resource_name: str,
args: ConfigEmailArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ConfigEmail(resource_name: str,
opts: Optional[ResourceOptions] = None,
email_from: Optional[str] = None,
email_host: Optional[str] = None,
email_insecure: Optional[bool] = None,
email_password: Optional[str] = None,
email_port: Optional[int] = None,
email_ssl: Optional[bool] = None,
email_username: Optional[str] = None)func NewConfigEmail(ctx *Context, name string, args ConfigEmailArgs, opts ...ResourceOption) (*ConfigEmail, error)public ConfigEmail(string name, ConfigEmailArgs args, CustomResourceOptions? opts = null)
public ConfigEmail(String name, ConfigEmailArgs args)
public ConfigEmail(String name, ConfigEmailArgs args, CustomResourceOptions options)
type: harbor:ConfigEmail
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 ConfigEmailArgs
- 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 ConfigEmailArgs
- 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 ConfigEmailArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ConfigEmailArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ConfigEmailArgs
- 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 configEmailResource = new Harbor.ConfigEmail("configEmailResource", new()
{
EmailFrom = "string",
EmailHost = "string",
EmailInsecure = false,
EmailPassword = "string",
EmailPort = 0,
EmailSsl = false,
EmailUsername = "string",
});
example, err := harbor.NewConfigEmail(ctx, "configEmailResource", &harbor.ConfigEmailArgs{
EmailFrom: pulumi.String("string"),
EmailHost: pulumi.String("string"),
EmailInsecure: pulumi.Bool(false),
EmailPassword: pulumi.String("string"),
EmailPort: pulumi.Int(0),
EmailSsl: pulumi.Bool(false),
EmailUsername: pulumi.String("string"),
})
var configEmailResource = new ConfigEmail("configEmailResource", ConfigEmailArgs.builder()
.emailFrom("string")
.emailHost("string")
.emailInsecure(false)
.emailPassword("string")
.emailPort(0)
.emailSsl(false)
.emailUsername("string")
.build());
config_email_resource = harbor.ConfigEmail("configEmailResource",
email_from="string",
email_host="string",
email_insecure=False,
email_password="string",
email_port=0,
email_ssl=False,
email_username="string")
const configEmailResource = new harbor.ConfigEmail("configEmailResource", {
emailFrom: "string",
emailHost: "string",
emailInsecure: false,
emailPassword: "string",
emailPort: 0,
emailSsl: false,
emailUsername: "string",
});
type: harbor:ConfigEmail
properties:
emailFrom: string
emailHost: string
emailInsecure: false
emailPassword: string
emailPort: 0
emailSsl: false
emailUsername: string
ConfigEmail 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 ConfigEmail resource accepts the following input properties:
- Email
From string - The email from address ie,
dont_reply@acme.com - Email
Host string - The FQDN of the email server
- Email
Insecure bool - Disables validation of email server certificate
Default: false - Email
Password string - The password for the email server
- Email
Port int - The smtp port for the email server
Default: 25 - Email
Ssl bool - Enable SSL for email server connection
- Email
Username string - The username for the email server
- Email
From string - The email from address ie,
dont_reply@acme.com - Email
Host string - The FQDN of the email server
- Email
Insecure bool - Disables validation of email server certificate
Default: false - Email
Password string - The password for the email server
- Email
Port int - The smtp port for the email server
Default: 25 - Email
Ssl bool - Enable SSL for email server connection
- Email
Username string - The username for the email server
- email
From String - The email from address ie,
dont_reply@acme.com - email
Host String - The FQDN of the email server
- email
Insecure Boolean - Disables validation of email server certificate
Default: false - email
Password String - The password for the email server
- email
Port Integer - The smtp port for the email server
Default: 25 - email
Ssl Boolean - Enable SSL for email server connection
- email
Username String - The username for the email server
- email
From string - The email from address ie,
dont_reply@acme.com - email
Host string - The FQDN of the email server
- email
Insecure boolean - Disables validation of email server certificate
Default: false - email
Password string - The password for the email server
- email
Port number - The smtp port for the email server
Default: 25 - email
Ssl boolean - Enable SSL for email server connection
- email
Username string - The username for the email server
- email_
from str - The email from address ie,
dont_reply@acme.com - email_
host str - The FQDN of the email server
- email_
insecure bool - Disables validation of email server certificate
Default: false - email_
password str - The password for the email server
- email_
port int - The smtp port for the email server
Default: 25 - email_
ssl bool - Enable SSL for email server connection
- email_
username str - The username for the email server
- email
From String - The email from address ie,
dont_reply@acme.com - email
Host String - The FQDN of the email server
- email
Insecure Boolean - Disables validation of email server certificate
Default: false - email
Password String - The password for the email server
- email
Port Number - The smtp port for the email server
Default: 25 - email
Ssl Boolean - Enable SSL for email server connection
- email
Username String - The username for the email server
Outputs
All input properties are implicitly available as output properties. Additionally, the ConfigEmail 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.
Look up Existing ConfigEmail Resource
Get an existing ConfigEmail 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?: ConfigEmailState, opts?: CustomResourceOptions): ConfigEmail@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
email_from: Optional[str] = None,
email_host: Optional[str] = None,
email_insecure: Optional[bool] = None,
email_password: Optional[str] = None,
email_port: Optional[int] = None,
email_ssl: Optional[bool] = None,
email_username: Optional[str] = None) -> ConfigEmailfunc GetConfigEmail(ctx *Context, name string, id IDInput, state *ConfigEmailState, opts ...ResourceOption) (*ConfigEmail, error)public static ConfigEmail Get(string name, Input<string> id, ConfigEmailState? state, CustomResourceOptions? opts = null)public static ConfigEmail get(String name, Output<String> id, ConfigEmailState state, CustomResourceOptions options)Resource lookup is not supported in YAML- 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.
- Email
From string - The email from address ie,
dont_reply@acme.com - Email
Host string - The FQDN of the email server
- Email
Insecure bool - Disables validation of email server certificate
Default: false - Email
Password string - The password for the email server
- Email
Port int - The smtp port for the email server
Default: 25 - Email
Ssl bool - Enable SSL for email server connection
- Email
Username string - The username for the email server
- Email
From string - The email from address ie,
dont_reply@acme.com - Email
Host string - The FQDN of the email server
- Email
Insecure bool - Disables validation of email server certificate
Default: false - Email
Password string - The password for the email server
- Email
Port int - The smtp port for the email server
Default: 25 - Email
Ssl bool - Enable SSL for email server connection
- Email
Username string - The username for the email server
- email
From String - The email from address ie,
dont_reply@acme.com - email
Host String - The FQDN of the email server
- email
Insecure Boolean - Disables validation of email server certificate
Default: false - email
Password String - The password for the email server
- email
Port Integer - The smtp port for the email server
Default: 25 - email
Ssl Boolean - Enable SSL for email server connection
- email
Username String - The username for the email server
- email
From string - The email from address ie,
dont_reply@acme.com - email
Host string - The FQDN of the email server
- email
Insecure boolean - Disables validation of email server certificate
Default: false - email
Password string - The password for the email server
- email
Port number - The smtp port for the email server
Default: 25 - email
Ssl boolean - Enable SSL for email server connection
- email
Username string - The username for the email server
- email_
from str - The email from address ie,
dont_reply@acme.com - email_
host str - The FQDN of the email server
- email_
insecure bool - Disables validation of email server certificate
Default: false - email_
password str - The password for the email server
- email_
port int - The smtp port for the email server
Default: 25 - email_
ssl bool - Enable SSL for email server connection
- email_
username str - The username for the email server
- email
From String - The email from address ie,
dont_reply@acme.com - email
Host String - The FQDN of the email server
- email
Insecure Boolean - Disables validation of email server certificate
Default: false - email
Password String - The password for the email server
- email
Port Number - The smtp port for the email server
Default: 25 - email
Ssl Boolean - Enable SSL for email server connection
- email
Username String - The username for the email server
Package Details
- Repository
- harbor pulumiverse/pulumi-harbor
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
harborTerraform Provider.