sms

package
v0.1.8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 26, 2024 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PkgVersion

func PkgVersion() (semver.Version, error)

PkgVersion uses reflection to determine the version of the current package. If a version cannot be determined, v1 will be assumed. The second return value is always nil.

Types

type Sign

type Sign struct {
	pulumi.CustomResourceState

	// Power of attorney, which should be submitted if SignPurpose is for use by others. You should Base64-encode the image first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter. Note: this field will take effect only when SignPurpose is 1 (for user by others).
	CommissionImage pulumi.StringPtrOutput `pulumi:"commissionImage"`
	// DocumentType is used for enterprise authentication, or website, app authentication, etc. DocumentType: 0, 1, 2, 3, 4, 5, 6, 7, 8.
	DocumentType pulumi.IntOutput `pulumi:"documentType"`
	// Whether it is Global SMS: 0: Mainland China SMS; 1: Global SMS.
	International pulumi.IntOutput `pulumi:"international"`
	// You should Base64-encode the image of the identity certificate corresponding to the signature first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter.
	ProofImage pulumi.StringOutput `pulumi:"proofImage"`
	// Signature application remarks.
	Remark pulumi.StringPtrOutput `pulumi:"remark"`
	// Sms sign name, unique.
	SignName pulumi.StringOutput `pulumi:"signName"`
	// Signature purpose: 0: for personal use; 1: for others.
	SignPurpose pulumi.IntOutput `pulumi:"signPurpose"`
	// Sms sign type: 0, 1, 2, 3, 4, 5, 6.
	SignType pulumi.IntOutput `pulumi:"signType"`
}

Provides a resource to create a sms sign

## Example Usage ### Create a sms sign instance

```go package main

import (

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/tencentcloudstack/pulumi-tencentcloud/sdk/go/tencentcloud/Sms"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Sms.NewSign(ctx, "example", &Sms.SignArgs{
			DocumentType:  pulumi.Int(4),
			International: pulumi.Int(0),
			ProofImage:    pulumi.String("your_proof_image"),
			SignName:      pulumi.String("tf_example_sms_sign"),
			SignPurpose:   pulumi.Int(0),
			SignType:      pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetSign

func GetSign(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *SignState, opts ...pulumi.ResourceOption) (*Sign, error)

GetSign gets an existing Sign resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewSign

func NewSign(ctx *pulumi.Context,
	name string, args *SignArgs, opts ...pulumi.ResourceOption) (*Sign, error)

NewSign registers a new resource with the given unique name, arguments, and options.

func (*Sign) ElementType

func (*Sign) ElementType() reflect.Type

func (*Sign) ToSignOutput

func (i *Sign) ToSignOutput() SignOutput

func (*Sign) ToSignOutputWithContext

func (i *Sign) ToSignOutputWithContext(ctx context.Context) SignOutput

type SignArgs

type SignArgs struct {
	// Power of attorney, which should be submitted if SignPurpose is for use by others. You should Base64-encode the image first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter. Note: this field will take effect only when SignPurpose is 1 (for user by others).
	CommissionImage pulumi.StringPtrInput
	// DocumentType is used for enterprise authentication, or website, app authentication, etc. DocumentType: 0, 1, 2, 3, 4, 5, 6, 7, 8.
	DocumentType pulumi.IntInput
	// Whether it is Global SMS: 0: Mainland China SMS; 1: Global SMS.
	International pulumi.IntInput
	// You should Base64-encode the image of the identity certificate corresponding to the signature first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter.
	ProofImage pulumi.StringInput
	// Signature application remarks.
	Remark pulumi.StringPtrInput
	// Sms sign name, unique.
	SignName pulumi.StringInput
	// Signature purpose: 0: for personal use; 1: for others.
	SignPurpose pulumi.IntInput
	// Sms sign type: 0, 1, 2, 3, 4, 5, 6.
	SignType pulumi.IntInput
}

The set of arguments for constructing a Sign resource.

func (SignArgs) ElementType

func (SignArgs) ElementType() reflect.Type

type SignArray

type SignArray []SignInput

func (SignArray) ElementType

func (SignArray) ElementType() reflect.Type

func (SignArray) ToSignArrayOutput

func (i SignArray) ToSignArrayOutput() SignArrayOutput

func (SignArray) ToSignArrayOutputWithContext

func (i SignArray) ToSignArrayOutputWithContext(ctx context.Context) SignArrayOutput

type SignArrayInput

type SignArrayInput interface {
	pulumi.Input

	ToSignArrayOutput() SignArrayOutput
	ToSignArrayOutputWithContext(context.Context) SignArrayOutput
}

SignArrayInput is an input type that accepts SignArray and SignArrayOutput values. You can construct a concrete instance of `SignArrayInput` via:

SignArray{ SignArgs{...} }

type SignArrayOutput

type SignArrayOutput struct{ *pulumi.OutputState }

func (SignArrayOutput) ElementType

func (SignArrayOutput) ElementType() reflect.Type

func (SignArrayOutput) Index

func (SignArrayOutput) ToSignArrayOutput

func (o SignArrayOutput) ToSignArrayOutput() SignArrayOutput

func (SignArrayOutput) ToSignArrayOutputWithContext

func (o SignArrayOutput) ToSignArrayOutputWithContext(ctx context.Context) SignArrayOutput

type SignInput

type SignInput interface {
	pulumi.Input

	ToSignOutput() SignOutput
	ToSignOutputWithContext(ctx context.Context) SignOutput
}

type SignMap

type SignMap map[string]SignInput

func (SignMap) ElementType

func (SignMap) ElementType() reflect.Type

func (SignMap) ToSignMapOutput

func (i SignMap) ToSignMapOutput() SignMapOutput

func (SignMap) ToSignMapOutputWithContext

func (i SignMap) ToSignMapOutputWithContext(ctx context.Context) SignMapOutput

type SignMapInput

type SignMapInput interface {
	pulumi.Input

	ToSignMapOutput() SignMapOutput
	ToSignMapOutputWithContext(context.Context) SignMapOutput
}

SignMapInput is an input type that accepts SignMap and SignMapOutput values. You can construct a concrete instance of `SignMapInput` via:

SignMap{ "key": SignArgs{...} }

type SignMapOutput

type SignMapOutput struct{ *pulumi.OutputState }

func (SignMapOutput) ElementType

func (SignMapOutput) ElementType() reflect.Type

func (SignMapOutput) MapIndex

func (SignMapOutput) ToSignMapOutput

func (o SignMapOutput) ToSignMapOutput() SignMapOutput

func (SignMapOutput) ToSignMapOutputWithContext

func (o SignMapOutput) ToSignMapOutputWithContext(ctx context.Context) SignMapOutput

type SignOutput

type SignOutput struct{ *pulumi.OutputState }

func (SignOutput) CommissionImage

func (o SignOutput) CommissionImage() pulumi.StringPtrOutput

Power of attorney, which should be submitted if SignPurpose is for use by others. You should Base64-encode the image first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter. Note: this field will take effect only when SignPurpose is 1 (for user by others).

func (SignOutput) DocumentType

func (o SignOutput) DocumentType() pulumi.IntOutput

DocumentType is used for enterprise authentication, or website, app authentication, etc. DocumentType: 0, 1, 2, 3, 4, 5, 6, 7, 8.

func (SignOutput) ElementType

func (SignOutput) ElementType() reflect.Type

func (SignOutput) International

func (o SignOutput) International() pulumi.IntOutput

Whether it is Global SMS: 0: Mainland China SMS; 1: Global SMS.

func (SignOutput) ProofImage

func (o SignOutput) ProofImage() pulumi.StringOutput

You should Base64-encode the image of the identity certificate corresponding to the signature first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter.

func (SignOutput) Remark

func (o SignOutput) Remark() pulumi.StringPtrOutput

Signature application remarks.

func (SignOutput) SignName

func (o SignOutput) SignName() pulumi.StringOutput

Sms sign name, unique.

func (SignOutput) SignPurpose

func (o SignOutput) SignPurpose() pulumi.IntOutput

Signature purpose: 0: for personal use; 1: for others.

func (SignOutput) SignType

func (o SignOutput) SignType() pulumi.IntOutput

Sms sign type: 0, 1, 2, 3, 4, 5, 6.

func (SignOutput) ToSignOutput

func (o SignOutput) ToSignOutput() SignOutput

func (SignOutput) ToSignOutputWithContext

func (o SignOutput) ToSignOutputWithContext(ctx context.Context) SignOutput

type SignState

type SignState struct {
	// Power of attorney, which should be submitted if SignPurpose is for use by others. You should Base64-encode the image first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter. Note: this field will take effect only when SignPurpose is 1 (for user by others).
	CommissionImage pulumi.StringPtrInput
	// DocumentType is used for enterprise authentication, or website, app authentication, etc. DocumentType: 0, 1, 2, 3, 4, 5, 6, 7, 8.
	DocumentType pulumi.IntPtrInput
	// Whether it is Global SMS: 0: Mainland China SMS; 1: Global SMS.
	International pulumi.IntPtrInput
	// You should Base64-encode the image of the identity certificate corresponding to the signature first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter.
	ProofImage pulumi.StringPtrInput
	// Signature application remarks.
	Remark pulumi.StringPtrInput
	// Sms sign name, unique.
	SignName pulumi.StringPtrInput
	// Signature purpose: 0: for personal use; 1: for others.
	SignPurpose pulumi.IntPtrInput
	// Sms sign type: 0, 1, 2, 3, 4, 5, 6.
	SignType pulumi.IntPtrInput
}

func (SignState) ElementType

func (SignState) ElementType() reflect.Type

type Template

type Template struct {
	pulumi.CustomResourceState

	// Whether it is Global SMS: 0: Mainland China SMS; 1: Global SMS.
	International pulumi.IntOutput `pulumi:"international"`
	// Template remarks, such as reason for application and use case.
	Remark pulumi.StringOutput `pulumi:"remark"`
	// SMS type. 0: regular SMS, 1: marketing SMS.
	SmsType pulumi.IntOutput `pulumi:"smsType"`
	// Message Template Content.
	TemplateContent pulumi.StringOutput `pulumi:"templateContent"`
	// Message Template name, which must be unique.
	TemplateName pulumi.StringOutput `pulumi:"templateName"`
}

Provides a resource to create a sms template

## Example Usage ### Create a sms template

```go package main

import (

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/tencentcloudstack/pulumi-tencentcloud/sdk/go/tencentcloud/Sms"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Sms.NewTemplate(ctx, "template", &Sms.TemplateArgs{
			International:   pulumi.Int(0),
			Remark:          pulumi.String("terraform example"),
			SmsType:         pulumi.Int(0),
			TemplateContent: pulumi.String("example for sms template"),
			TemplateName:    pulumi.String("tf_example_sms_template"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetTemplate

func GetTemplate(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *TemplateState, opts ...pulumi.ResourceOption) (*Template, error)

GetTemplate gets an existing Template resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewTemplate

func NewTemplate(ctx *pulumi.Context,
	name string, args *TemplateArgs, opts ...pulumi.ResourceOption) (*Template, error)

NewTemplate registers a new resource with the given unique name, arguments, and options.

func (*Template) ElementType

func (*Template) ElementType() reflect.Type

func (*Template) ToTemplateOutput

func (i *Template) ToTemplateOutput() TemplateOutput

func (*Template) ToTemplateOutputWithContext

func (i *Template) ToTemplateOutputWithContext(ctx context.Context) TemplateOutput

type TemplateArgs

type TemplateArgs struct {
	// Whether it is Global SMS: 0: Mainland China SMS; 1: Global SMS.
	International pulumi.IntInput
	// Template remarks, such as reason for application and use case.
	Remark pulumi.StringInput
	// SMS type. 0: regular SMS, 1: marketing SMS.
	SmsType pulumi.IntInput
	// Message Template Content.
	TemplateContent pulumi.StringInput
	// Message Template name, which must be unique.
	TemplateName pulumi.StringInput
}

The set of arguments for constructing a Template resource.

func (TemplateArgs) ElementType

func (TemplateArgs) ElementType() reflect.Type

type TemplateArray

type TemplateArray []TemplateInput

func (TemplateArray) ElementType

func (TemplateArray) ElementType() reflect.Type

func (TemplateArray) ToTemplateArrayOutput

func (i TemplateArray) ToTemplateArrayOutput() TemplateArrayOutput

func (TemplateArray) ToTemplateArrayOutputWithContext

func (i TemplateArray) ToTemplateArrayOutputWithContext(ctx context.Context) TemplateArrayOutput

type TemplateArrayInput

type TemplateArrayInput interface {
	pulumi.Input

	ToTemplateArrayOutput() TemplateArrayOutput
	ToTemplateArrayOutputWithContext(context.Context) TemplateArrayOutput
}

TemplateArrayInput is an input type that accepts TemplateArray and TemplateArrayOutput values. You can construct a concrete instance of `TemplateArrayInput` via:

TemplateArray{ TemplateArgs{...} }

type TemplateArrayOutput

type TemplateArrayOutput struct{ *pulumi.OutputState }

func (TemplateArrayOutput) ElementType

func (TemplateArrayOutput) ElementType() reflect.Type

func (TemplateArrayOutput) Index

func (TemplateArrayOutput) ToTemplateArrayOutput

func (o TemplateArrayOutput) ToTemplateArrayOutput() TemplateArrayOutput

func (TemplateArrayOutput) ToTemplateArrayOutputWithContext

func (o TemplateArrayOutput) ToTemplateArrayOutputWithContext(ctx context.Context) TemplateArrayOutput

type TemplateInput

type TemplateInput interface {
	pulumi.Input

	ToTemplateOutput() TemplateOutput
	ToTemplateOutputWithContext(ctx context.Context) TemplateOutput
}

type TemplateMap

type TemplateMap map[string]TemplateInput

func (TemplateMap) ElementType

func (TemplateMap) ElementType() reflect.Type

func (TemplateMap) ToTemplateMapOutput

func (i TemplateMap) ToTemplateMapOutput() TemplateMapOutput

func (TemplateMap) ToTemplateMapOutputWithContext

func (i TemplateMap) ToTemplateMapOutputWithContext(ctx context.Context) TemplateMapOutput

type TemplateMapInput

type TemplateMapInput interface {
	pulumi.Input

	ToTemplateMapOutput() TemplateMapOutput
	ToTemplateMapOutputWithContext(context.Context) TemplateMapOutput
}

TemplateMapInput is an input type that accepts TemplateMap and TemplateMapOutput values. You can construct a concrete instance of `TemplateMapInput` via:

TemplateMap{ "key": TemplateArgs{...} }

type TemplateMapOutput

type TemplateMapOutput struct{ *pulumi.OutputState }

func (TemplateMapOutput) ElementType

func (TemplateMapOutput) ElementType() reflect.Type

func (TemplateMapOutput) MapIndex

func (TemplateMapOutput) ToTemplateMapOutput

func (o TemplateMapOutput) ToTemplateMapOutput() TemplateMapOutput

func (TemplateMapOutput) ToTemplateMapOutputWithContext

func (o TemplateMapOutput) ToTemplateMapOutputWithContext(ctx context.Context) TemplateMapOutput

type TemplateOutput

type TemplateOutput struct{ *pulumi.OutputState }

func (TemplateOutput) ElementType

func (TemplateOutput) ElementType() reflect.Type

func (TemplateOutput) International

func (o TemplateOutput) International() pulumi.IntOutput

Whether it is Global SMS: 0: Mainland China SMS; 1: Global SMS.

func (TemplateOutput) Remark

func (o TemplateOutput) Remark() pulumi.StringOutput

Template remarks, such as reason for application and use case.

func (TemplateOutput) SmsType

func (o TemplateOutput) SmsType() pulumi.IntOutput

SMS type. 0: regular SMS, 1: marketing SMS.

func (TemplateOutput) TemplateContent

func (o TemplateOutput) TemplateContent() pulumi.StringOutput

Message Template Content.

func (TemplateOutput) TemplateName

func (o TemplateOutput) TemplateName() pulumi.StringOutput

Message Template name, which must be unique.

func (TemplateOutput) ToTemplateOutput

func (o TemplateOutput) ToTemplateOutput() TemplateOutput

func (TemplateOutput) ToTemplateOutputWithContext

func (o TemplateOutput) ToTemplateOutputWithContext(ctx context.Context) TemplateOutput

type TemplateState

type TemplateState struct {
	// Whether it is Global SMS: 0: Mainland China SMS; 1: Global SMS.
	International pulumi.IntPtrInput
	// Template remarks, such as reason for application and use case.
	Remark pulumi.StringPtrInput
	// SMS type. 0: regular SMS, 1: marketing SMS.
	SmsType pulumi.IntPtrInput
	// Message Template Content.
	TemplateContent pulumi.StringPtrInput
	// Message Template name, which must be unique.
	TemplateName pulumi.StringPtrInput
}

func (TemplateState) ElementType

func (TemplateState) ElementType() reflect.Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL