1. Packages
  2. Zitadel
  3. API Docs
  4. SmsProviderTwilio
zitadel v0.1.8 published on Thursday, May 30, 2024 by pulumiverse

zitadel.SmsProviderTwilio

Explore with Pulumi AI

zitadel logo
zitadel v0.1.8 published on Thursday, May 30, 2024 by pulumiverse

    Resource representing the SMS provider Twilio configuration of an instance.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Zitadel = Pulumiverse.Zitadel;
    
    return await Deployment.RunAsync(() => 
    {
        var @default = new Zitadel.SmsProviderTwilio("default", new()
        {
            SenderNumber = "019920892",
            Sid = "sid",
            Token = "twilio_token",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-zitadel/sdk/go/zitadel"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := zitadel.NewSmsProviderTwilio(ctx, "default", &zitadel.SmsProviderTwilioArgs{
    			SenderNumber: pulumi.String("019920892"),
    			Sid:          pulumi.String("sid"),
    			Token:        pulumi.String("twilio_token"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.zitadel.SmsProviderTwilio;
    import com.pulumi.zitadel.SmsProviderTwilioArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var default_ = new SmsProviderTwilio("default", SmsProviderTwilioArgs.builder()        
                .senderNumber("019920892")
                .sid("sid")
                .token("twilio_token")
                .build());
    
        }
    }
    
    import pulumi
    import pulumiverse_zitadel as zitadel
    
    default = zitadel.SmsProviderTwilio("default",
        sender_number="019920892",
        sid="sid",
        token="twilio_token")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as zitadel from "@pulumiverse/zitadel";
    
    const _default = new zitadel.SmsProviderTwilio("default", {
        senderNumber: "019920892",
        sid: "sid",
        token: "twilio_token",
    });
    
    resources:
      default:
        type: zitadel:SmsProviderTwilio
        properties:
          senderNumber: '019920892'
          sid: sid
          token: twilio_token
    

    Create SmsProviderTwilio Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SmsProviderTwilio(name: string, args: SmsProviderTwilioArgs, opts?: CustomResourceOptions);
    @overload
    def SmsProviderTwilio(resource_name: str,
                          args: SmsProviderTwilioArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def SmsProviderTwilio(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          sender_number: Optional[str] = None,
                          sid: Optional[str] = None,
                          token: Optional[str] = None)
    func NewSmsProviderTwilio(ctx *Context, name string, args SmsProviderTwilioArgs, opts ...ResourceOption) (*SmsProviderTwilio, error)
    public SmsProviderTwilio(string name, SmsProviderTwilioArgs args, CustomResourceOptions? opts = null)
    public SmsProviderTwilio(String name, SmsProviderTwilioArgs args)
    public SmsProviderTwilio(String name, SmsProviderTwilioArgs args, CustomResourceOptions options)
    
    type: zitadel:SmsProviderTwilio
    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 SmsProviderTwilioArgs
    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 SmsProviderTwilioArgs
    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 SmsProviderTwilioArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SmsProviderTwilioArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SmsProviderTwilioArgs
    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 smsProviderTwilioResource = new Zitadel.SmsProviderTwilio("smsProviderTwilioResource", new()
    {
        SenderNumber = "string",
        Sid = "string",
        Token = "string",
    });
    
    example, err := zitadel.NewSmsProviderTwilio(ctx, "smsProviderTwilioResource", &zitadel.SmsProviderTwilioArgs{
    	SenderNumber: pulumi.String("string"),
    	Sid:          pulumi.String("string"),
    	Token:        pulumi.String("string"),
    })
    
    var smsProviderTwilioResource = new SmsProviderTwilio("smsProviderTwilioResource", SmsProviderTwilioArgs.builder()
        .senderNumber("string")
        .sid("string")
        .token("string")
        .build());
    
    sms_provider_twilio_resource = zitadel.SmsProviderTwilio("smsProviderTwilioResource",
        sender_number="string",
        sid="string",
        token="string")
    
    const smsProviderTwilioResource = new zitadel.SmsProviderTwilio("smsProviderTwilioResource", {
        senderNumber: "string",
        sid: "string",
        token: "string",
    });
    
    type: zitadel:SmsProviderTwilio
    properties:
        senderNumber: string
        sid: string
        token: string
    

    SmsProviderTwilio Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The SmsProviderTwilio resource accepts the following input properties:

    SenderNumber string
    Sender number which is used to send the SMS.
    Sid string
    SID used to communicate with Twilio.
    Token string
    Token used to communicate with Twilio.
    SenderNumber string
    Sender number which is used to send the SMS.
    Sid string
    SID used to communicate with Twilio.
    Token string
    Token used to communicate with Twilio.
    senderNumber String
    Sender number which is used to send the SMS.
    sid String
    SID used to communicate with Twilio.
    token String
    Token used to communicate with Twilio.
    senderNumber string
    Sender number which is used to send the SMS.
    sid string
    SID used to communicate with Twilio.
    token string
    Token used to communicate with Twilio.
    sender_number str
    Sender number which is used to send the SMS.
    sid str
    SID used to communicate with Twilio.
    token str
    Token used to communicate with Twilio.
    senderNumber String
    Sender number which is used to send the SMS.
    sid String
    SID used to communicate with Twilio.
    token String
    Token used to communicate with Twilio.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SmsProviderTwilio 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 SmsProviderTwilio Resource

    Get an existing SmsProviderTwilio 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?: SmsProviderTwilioState, opts?: CustomResourceOptions): SmsProviderTwilio
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            sender_number: Optional[str] = None,
            sid: Optional[str] = None,
            token: Optional[str] = None) -> SmsProviderTwilio
    func GetSmsProviderTwilio(ctx *Context, name string, id IDInput, state *SmsProviderTwilioState, opts ...ResourceOption) (*SmsProviderTwilio, error)
    public static SmsProviderTwilio Get(string name, Input<string> id, SmsProviderTwilioState? state, CustomResourceOptions? opts = null)
    public static SmsProviderTwilio get(String name, Output<String> id, SmsProviderTwilioState 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.
    The following state arguments are supported:
    SenderNumber string
    Sender number which is used to send the SMS.
    Sid string
    SID used to communicate with Twilio.
    Token string
    Token used to communicate with Twilio.
    SenderNumber string
    Sender number which is used to send the SMS.
    Sid string
    SID used to communicate with Twilio.
    Token string
    Token used to communicate with Twilio.
    senderNumber String
    Sender number which is used to send the SMS.
    sid String
    SID used to communicate with Twilio.
    token String
    Token used to communicate with Twilio.
    senderNumber string
    Sender number which is used to send the SMS.
    sid string
    SID used to communicate with Twilio.
    token string
    Token used to communicate with Twilio.
    sender_number str
    Sender number which is used to send the SMS.
    sid str
    SID used to communicate with Twilio.
    token str
    Token used to communicate with Twilio.
    senderNumber String
    Sender number which is used to send the SMS.
    sid String
    SID used to communicate with Twilio.
    token String
    Token used to communicate with Twilio.

    Import

    terraform The resource can be imported using the ID format <id[:token]>, e.g.

     $ pulumi import zitadel:index/smsProviderTwilio:SmsProviderTwilio imported '123456789012345678:12345678901234567890123456abcdef'
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    zitadel pulumiverse/pulumi-zitadel
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the zitadel Terraform Provider.
    zitadel logo
    zitadel v0.1.8 published on Thursday, May 30, 2024 by pulumiverse