Struct ngrok_api::types::ReservedDomainCreate

pub struct ReservedDomainCreate {
    pub name: String,
    pub region: String,
    pub description: String,
    pub metadata: String,
    pub certificate_id: Option<String>,
    pub certificate_management_policy: Option<ReservedDomainCertPolicy>,
}

Fields

name: String

the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a ‘.’ it will reserve that subdomain on ngrok.io.

region: String

reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)

description: String

human-readable description of what this reserved domain will be used for

metadata: String

arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.

certificate_id: Option<String>

ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy.

certificate_management_policy: Option<ReservedDomainCertPolicy>

configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with certificate_id.

Trait Implementations

impl Clone for ReservedDomainCreate

fn clone(&self) -> ReservedDomainCreate

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ReservedDomainCreate

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ReservedDomainCreate

fn default() -> ReservedDomainCreate

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ReservedDomainCreate

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for ReservedDomainCreate

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.