Manages phone notification templates used for SMS and voice communications in Auth0.
Create PhoneNotificationTemplate Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PhoneNotificationTemplate(name: string, args: PhoneNotificationTemplateArgs, opts?: CustomResourceOptions);@overload
def PhoneNotificationTemplate(resource_name: str,
args: PhoneNotificationTemplateArgs,
opts: Optional[ResourceOptions] = None)
@overload
def PhoneNotificationTemplate(resource_name: str,
opts: Optional[ResourceOptions] = None,
type: Optional[str] = None,
content: Optional[PhoneNotificationTemplateContentArgs] = None,
disabled: Optional[bool] = None)func NewPhoneNotificationTemplate(ctx *Context, name string, args PhoneNotificationTemplateArgs, opts ...ResourceOption) (*PhoneNotificationTemplate, error)public PhoneNotificationTemplate(string name, PhoneNotificationTemplateArgs args, CustomResourceOptions? opts = null)
public PhoneNotificationTemplate(String name, PhoneNotificationTemplateArgs args)
public PhoneNotificationTemplate(String name, PhoneNotificationTemplateArgs args, CustomResourceOptions options)
type: auth0:PhoneNotificationTemplate
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 PhoneNotificationTemplateArgs
- 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 PhoneNotificationTemplateArgs
- 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 PhoneNotificationTemplateArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PhoneNotificationTemplateArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PhoneNotificationTemplateArgs
- 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 phoneNotificationTemplateResource = new Auth0.PhoneNotificationTemplate("phoneNotificationTemplateResource", new()
{
Type = "string",
Content = new Auth0.Inputs.PhoneNotificationTemplateContentArgs
{
Body = new Auth0.Inputs.PhoneNotificationTemplateContentBodyArgs
{
Text = "string",
Voice = "string",
},
From = "string",
Syntax = "string",
},
Disabled = false,
});
example, err := auth0.NewPhoneNotificationTemplate(ctx, "phoneNotificationTemplateResource", &auth0.PhoneNotificationTemplateArgs{
Type: pulumi.String("string"),
Content: &auth0.PhoneNotificationTemplateContentArgs{
Body: &auth0.PhoneNotificationTemplateContentBodyArgs{
Text: pulumi.String("string"),
Voice: pulumi.String("string"),
},
From: pulumi.String("string"),
Syntax: pulumi.String("string"),
},
Disabled: pulumi.Bool(false),
})
var phoneNotificationTemplateResource = new PhoneNotificationTemplate("phoneNotificationTemplateResource", PhoneNotificationTemplateArgs.builder()
.type("string")
.content(PhoneNotificationTemplateContentArgs.builder()
.body(PhoneNotificationTemplateContentBodyArgs.builder()
.text("string")
.voice("string")
.build())
.from("string")
.syntax("string")
.build())
.disabled(false)
.build());
phone_notification_template_resource = auth0.PhoneNotificationTemplate("phoneNotificationTemplateResource",
type="string",
content={
"body": {
"text": "string",
"voice": "string",
},
"from_": "string",
"syntax": "string",
},
disabled=False)
const phoneNotificationTemplateResource = new auth0.PhoneNotificationTemplate("phoneNotificationTemplateResource", {
type: "string",
content: {
body: {
text: "string",
voice: "string",
},
from: "string",
syntax: "string",
},
disabled: false,
});
type: auth0:PhoneNotificationTemplate
properties:
content:
body:
text: string
voice: string
from: string
syntax: string
disabled: false
type: string
PhoneNotificationTemplate 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 PhoneNotificationTemplate resource accepts the following input properties:
- Type string
- The type of the phone notification template.
- Content
Phone
Notification Template Content - The content of the phone notification template.
- Disabled bool
- Indicates whether the phone notification template is disabled.
- Type string
- The type of the phone notification template.
- Content
Phone
Notification Template Content Args - The content of the phone notification template.
- Disabled bool
- Indicates whether the phone notification template is disabled.
- type String
- The type of the phone notification template.
- content
Phone
Notification Template Content - The content of the phone notification template.
- disabled Boolean
- Indicates whether the phone notification template is disabled.
- type string
- The type of the phone notification template.
- content
Phone
Notification Template Content - The content of the phone notification template.
- disabled boolean
- Indicates whether the phone notification template is disabled.
- type str
- The type of the phone notification template.
- content
Phone
Notification Template Content Args - The content of the phone notification template.
- disabled bool
- Indicates whether the phone notification template is disabled.
- type String
- The type of the phone notification template.
- content Property Map
- The content of the phone notification template.
- disabled Boolean
- Indicates whether the phone notification template is disabled.
Outputs
All input properties are implicitly available as output properties. Additionally, the PhoneNotificationTemplate resource produces the following output properties:
- Channel string
- The channel of the phone notification template (e.g.,
sms,voice). - Customizable bool
- Indicates whether the phone notification template is customizable.
- Id string
- The provider-assigned unique ID for this managed resource.
- Template
Id string - The ID of the phone notification template.
- Tenant string
- The tenant of the phone notification template.
- Channel string
- The channel of the phone notification template (e.g.,
sms,voice). - Customizable bool
- Indicates whether the phone notification template is customizable.
- Id string
- The provider-assigned unique ID for this managed resource.
- Template
Id string - The ID of the phone notification template.
- Tenant string
- The tenant of the phone notification template.
- channel String
- The channel of the phone notification template (e.g.,
sms,voice). - customizable Boolean
- Indicates whether the phone notification template is customizable.
- id String
- The provider-assigned unique ID for this managed resource.
- template
Id String - The ID of the phone notification template.
- tenant String
- The tenant of the phone notification template.
- channel string
- The channel of the phone notification template (e.g.,
sms,voice). - customizable boolean
- Indicates whether the phone notification template is customizable.
- id string
- The provider-assigned unique ID for this managed resource.
- template
Id string - The ID of the phone notification template.
- tenant string
- The tenant of the phone notification template.
- channel str
- The channel of the phone notification template (e.g.,
sms,voice). - customizable bool
- Indicates whether the phone notification template is customizable.
- id str
- The provider-assigned unique ID for this managed resource.
- template_
id str - The ID of the phone notification template.
- tenant str
- The tenant of the phone notification template.
- channel String
- The channel of the phone notification template (e.g.,
sms,voice). - customizable Boolean
- Indicates whether the phone notification template is customizable.
- id String
- The provider-assigned unique ID for this managed resource.
- template
Id String - The ID of the phone notification template.
- tenant String
- The tenant of the phone notification template.
Look up Existing PhoneNotificationTemplate Resource
Get an existing PhoneNotificationTemplate 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?: PhoneNotificationTemplateState, opts?: CustomResourceOptions): PhoneNotificationTemplate@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
channel: Optional[str] = None,
content: Optional[PhoneNotificationTemplateContentArgs] = None,
customizable: Optional[bool] = None,
disabled: Optional[bool] = None,
template_id: Optional[str] = None,
tenant: Optional[str] = None,
type: Optional[str] = None) -> PhoneNotificationTemplatefunc GetPhoneNotificationTemplate(ctx *Context, name string, id IDInput, state *PhoneNotificationTemplateState, opts ...ResourceOption) (*PhoneNotificationTemplate, error)public static PhoneNotificationTemplate Get(string name, Input<string> id, PhoneNotificationTemplateState? state, CustomResourceOptions? opts = null)public static PhoneNotificationTemplate get(String name, Output<String> id, PhoneNotificationTemplateState state, CustomResourceOptions options)resources: _: type: auth0:PhoneNotificationTemplate 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.
- Channel string
- The channel of the phone notification template (e.g.,
sms,voice). - Content
Phone
Notification Template Content - The content of the phone notification template.
- Customizable bool
- Indicates whether the phone notification template is customizable.
- Disabled bool
- Indicates whether the phone notification template is disabled.
- Template
Id string - The ID of the phone notification template.
- Tenant string
- The tenant of the phone notification template.
- Type string
- The type of the phone notification template.
- Channel string
- The channel of the phone notification template (e.g.,
sms,voice). - Content
Phone
Notification Template Content Args - The content of the phone notification template.
- Customizable bool
- Indicates whether the phone notification template is customizable.
- Disabled bool
- Indicates whether the phone notification template is disabled.
- Template
Id string - The ID of the phone notification template.
- Tenant string
- The tenant of the phone notification template.
- Type string
- The type of the phone notification template.
- channel String
- The channel of the phone notification template (e.g.,
sms,voice). - content
Phone
Notification Template Content - The content of the phone notification template.
- customizable Boolean
- Indicates whether the phone notification template is customizable.
- disabled Boolean
- Indicates whether the phone notification template is disabled.
- template
Id String - The ID of the phone notification template.
- tenant String
- The tenant of the phone notification template.
- type String
- The type of the phone notification template.
- channel string
- The channel of the phone notification template (e.g.,
sms,voice). - content
Phone
Notification Template Content - The content of the phone notification template.
- customizable boolean
- Indicates whether the phone notification template is customizable.
- disabled boolean
- Indicates whether the phone notification template is disabled.
- template
Id string - The ID of the phone notification template.
- tenant string
- The tenant of the phone notification template.
- type string
- The type of the phone notification template.
- channel str
- The channel of the phone notification template (e.g.,
sms,voice). - content
Phone
Notification Template Content Args - The content of the phone notification template.
- customizable bool
- Indicates whether the phone notification template is customizable.
- disabled bool
- Indicates whether the phone notification template is disabled.
- template_
id str - The ID of the phone notification template.
- tenant str
- The tenant of the phone notification template.
- type str
- The type of the phone notification template.
- channel String
- The channel of the phone notification template (e.g.,
sms,voice). - content Property Map
- The content of the phone notification template.
- customizable Boolean
- Indicates whether the phone notification template is customizable.
- disabled Boolean
- Indicates whether the phone notification template is disabled.
- template
Id String - The ID of the phone notification template.
- tenant String
- The tenant of the phone notification template.
- type String
- The type of the phone notification template.
Supporting Types
PhoneNotificationTemplateContent, PhoneNotificationTemplateContentArgs
- Body
Phone
Notification Template Content Body - The body content of the phone notification template.
- From string
- The sender phone number for SMS or voice notifications.
- Syntax string
- The syntax of the phone notification template.
- Body
Phone
Notification Template Content Body - The body content of the phone notification template.
- From string
- The sender phone number for SMS or voice notifications.
- Syntax string
- The syntax of the phone notification template.
- body
Phone
Notification Template Content Body - The body content of the phone notification template.
- from String
- The sender phone number for SMS or voice notifications.
- syntax String
- The syntax of the phone notification template.
- body
Phone
Notification Template Content Body - The body content of the phone notification template.
- from string
- The sender phone number for SMS or voice notifications.
- syntax string
- The syntax of the phone notification template.
- body
Phone
Notification Template Content Body - The body content of the phone notification template.
- from_ str
- The sender phone number for SMS or voice notifications.
- syntax str
- The syntax of the phone notification template.
- body Property Map
- The body content of the phone notification template.
- from String
- The sender phone number for SMS or voice notifications.
- syntax String
- The syntax of the phone notification template.
PhoneNotificationTemplateContentBody, PhoneNotificationTemplateContentBodyArgs
Package Details
- Repository
- Auth0 pulumi/pulumi-auth0
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
auth0Terraform Provider.
