com.pulumi.aws.pinpoint.kotlin.SmsChannelArgs.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
There is a newer version: 6.57.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.aws.pinpoint.kotlin

import com.pulumi.aws.pinpoint.SmsChannelArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName

/**
 * Use the `aws.pinpoint.SmsChannel` resource to manage Pinpoint SMS Channels.
 * ## Example Usage
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 * const app = new aws.pinpoint.App("app", {});
 * const sms = new aws.pinpoint.SmsChannel("sms", {applicationId: app.applicationId});
 * ```
 * ```python
 * import pulumi
 * import pulumi_aws as aws
 * app = aws.pinpoint.App("app")
 * sms = aws.pinpoint.SmsChannel("sms", application_id=app.application_id)
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Aws = Pulumi.Aws;
 * return await Deployment.RunAsync(() =>
 * {
 *     var app = new Aws.Pinpoint.App("app");
 *     var sms = new Aws.Pinpoint.SmsChannel("sms", new()
 *     {
 *         ApplicationId = app.ApplicationId,
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/pinpoint"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		app, err := pinpoint.NewApp(ctx, "app", nil)
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = pinpoint.NewSmsChannel(ctx, "sms", &pinpoint.SmsChannelArgs{
 * 			ApplicationId: app.ApplicationId,
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		return nil
 * 	})
 * }
 * ```
 * ```java
 * package generated_program;
 * import com.pulumi.Context;
 * import com.pulumi.Pulumi;
 * import com.pulumi.core.Output;
 * import com.pulumi.aws.pinpoint.App;
 * import com.pulumi.aws.pinpoint.SmsChannel;
 * import com.pulumi.aws.pinpoint.SmsChannelArgs;
 * 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 app = new App("app");
 *         var sms = new SmsChannel("sms", SmsChannelArgs.builder()
 *             .applicationId(app.applicationId())
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   sms:
 *     type: aws:pinpoint:SmsChannel
 *     properties:
 *       applicationId: ${app.applicationId}
 *   app:
 *     type: aws:pinpoint:App
 * ```
 * 
 * ## Import
 * Using `pulumi import`, import the Pinpoint SMS Channel using the `application_id`. For example:
 * ```sh
 * $ pulumi import aws:pinpoint/smsChannel:SmsChannel sms application-id
 * ```
 * @property applicationId ID of the application.
 * @property enabled Whether the channel is enabled or disabled. By default, it is set to `true`.
 * @property senderId Identifier of the sender for your messages.
 * @property shortCode Short Code registered with the phone provider.
 */
public data class SmsChannelArgs(
    public val applicationId: Output? = null,
    public val enabled: Output? = null,
    public val senderId: Output? = null,
    public val shortCode: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.aws.pinpoint.SmsChannelArgs =
        com.pulumi.aws.pinpoint.SmsChannelArgs.builder()
            .applicationId(applicationId?.applyValue({ args0 -> args0 }))
            .enabled(enabled?.applyValue({ args0 -> args0 }))
            .senderId(senderId?.applyValue({ args0 -> args0 }))
            .shortCode(shortCode?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [SmsChannelArgs].
 */
@PulumiTagMarker
public class SmsChannelArgsBuilder internal constructor() {
    private var applicationId: Output? = null

    private var enabled: Output? = null

    private var senderId: Output? = null

    private var shortCode: Output? = null

    /**
     * @param value ID of the application.
     */
    @JvmName("rbufkgenjtahrkjd")
    public suspend fun applicationId(`value`: Output) {
        this.applicationId = value
    }

    /**
     * @param value Whether the channel is enabled or disabled. By default, it is set to `true`.
     */
    @JvmName("ovhxrrvqmrrcgfjw")
    public suspend fun enabled(`value`: Output) {
        this.enabled = value
    }

    /**
     * @param value Identifier of the sender for your messages.
     */
    @JvmName("isplycaqksbkovnv")
    public suspend fun senderId(`value`: Output) {
        this.senderId = value
    }

    /**
     * @param value Short Code registered with the phone provider.
     */
    @JvmName("avqrfffnmxhjetwc")
    public suspend fun shortCode(`value`: Output) {
        this.shortCode = value
    }

    /**
     * @param value ID of the application.
     */
    @JvmName("lafywirhxshxsgpi")
    public suspend fun applicationId(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.applicationId = mapped
    }

    /**
     * @param value Whether the channel is enabled or disabled. By default, it is set to `true`.
     */
    @JvmName("thpmclknmjqyonsc")
    public suspend fun enabled(`value`: Boolean?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.enabled = mapped
    }

    /**
     * @param value Identifier of the sender for your messages.
     */
    @JvmName("oijcyxskrdaiaivp")
    public suspend fun senderId(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.senderId = mapped
    }

    /**
     * @param value Short Code registered with the phone provider.
     */
    @JvmName("perjwmdviovdpjbf")
    public suspend fun shortCode(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.shortCode = mapped
    }

    internal fun build(): SmsChannelArgs = SmsChannelArgs(
        applicationId = applicationId,
        enabled = enabled,
        senderId = senderId,
        shortCode = shortCode,
    )
}