1. Packages
  2. AWS Classic
  3. API Docs
  4. pinpoint
  5. AdmChannel

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

aws.pinpoint.AdmChannel

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

    Provides a Pinpoint ADM (Amazon Device Messaging) Channel resource.

    Note: All arguments including the Client ID and Client Secret will be stored in the raw state as plain-text.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const app = new aws.pinpoint.App("app", {});
    const channel = new aws.pinpoint.AdmChannel("channel", {
        applicationId: app.applicationId,
        clientId: "",
        clientSecret: "",
        enabled: true,
    });
    
    import pulumi
    import pulumi_aws as aws
    
    app = aws.pinpoint.App("app")
    channel = aws.pinpoint.AdmChannel("channel",
        application_id=app.application_id,
        client_id="",
        client_secret="",
        enabled=True)
    
    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.NewAdmChannel(ctx, "channel", &pinpoint.AdmChannelArgs{
    			ApplicationId: app.ApplicationId,
    			ClientId:      pulumi.String(""),
    			ClientSecret:  pulumi.String(""),
    			Enabled:       pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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 channel = new Aws.Pinpoint.AdmChannel("channel", new()
        {
            ApplicationId = app.ApplicationId,
            ClientId = "",
            ClientSecret = "",
            Enabled = true,
        });
    
    });
    
    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.AdmChannel;
    import com.pulumi.aws.pinpoint.AdmChannelArgs;
    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 channel = new AdmChannel("channel", AdmChannelArgs.builder()
                .applicationId(app.applicationId())
                .clientId("")
                .clientSecret("")
                .enabled(true)
                .build());
    
        }
    }
    
    resources:
      app:
        type: aws:pinpoint:App
      channel:
        type: aws:pinpoint:AdmChannel
        properties:
          applicationId: ${app.applicationId}
          clientId:
          clientSecret:
          enabled: true
    

    Create AdmChannel Resource

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

    Constructor syntax

    new AdmChannel(name: string, args: AdmChannelArgs, opts?: CustomResourceOptions);
    @overload
    def AdmChannel(resource_name: str,
                   args: AdmChannelArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def AdmChannel(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   application_id: Optional[str] = None,
                   client_id: Optional[str] = None,
                   client_secret: Optional[str] = None,
                   enabled: Optional[bool] = None)
    func NewAdmChannel(ctx *Context, name string, args AdmChannelArgs, opts ...ResourceOption) (*AdmChannel, error)
    public AdmChannel(string name, AdmChannelArgs args, CustomResourceOptions? opts = null)
    public AdmChannel(String name, AdmChannelArgs args)
    public AdmChannel(String name, AdmChannelArgs args, CustomResourceOptions options)
    
    type: aws:pinpoint:AdmChannel
    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 AdmChannelArgs
    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 AdmChannelArgs
    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 AdmChannelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AdmChannelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AdmChannelArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var admChannelResource = new Aws.Pinpoint.AdmChannel("admChannelResource", new()
    {
        ApplicationId = "string",
        ClientId = "string",
        ClientSecret = "string",
        Enabled = false,
    });
    
    example, err := pinpoint.NewAdmChannel(ctx, "admChannelResource", &pinpoint.AdmChannelArgs{
    	ApplicationId: pulumi.String("string"),
    	ClientId:      pulumi.String("string"),
    	ClientSecret:  pulumi.String("string"),
    	Enabled:       pulumi.Bool(false),
    })
    
    var admChannelResource = new AdmChannel("admChannelResource", AdmChannelArgs.builder()
        .applicationId("string")
        .clientId("string")
        .clientSecret("string")
        .enabled(false)
        .build());
    
    adm_channel_resource = aws.pinpoint.AdmChannel("admChannelResource",
        application_id="string",
        client_id="string",
        client_secret="string",
        enabled=False)
    
    const admChannelResource = new aws.pinpoint.AdmChannel("admChannelResource", {
        applicationId: "string",
        clientId: "string",
        clientSecret: "string",
        enabled: false,
    });
    
    type: aws:pinpoint:AdmChannel
    properties:
        applicationId: string
        clientId: string
        clientSecret: string
        enabled: false
    

    AdmChannel 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 AdmChannel resource accepts the following input properties:

    ApplicationId string
    The application ID.
    ClientId string
    Client ID (part of OAuth Credentials) obtained via Amazon Developer Account.
    ClientSecret string
    Client Secret (part of OAuth Credentials) obtained via Amazon Developer Account.
    Enabled bool
    Specifies whether to enable the channel. Defaults to true.
    ApplicationId string
    The application ID.
    ClientId string
    Client ID (part of OAuth Credentials) obtained via Amazon Developer Account.
    ClientSecret string
    Client Secret (part of OAuth Credentials) obtained via Amazon Developer Account.
    Enabled bool
    Specifies whether to enable the channel. Defaults to true.
    applicationId String
    The application ID.
    clientId String
    Client ID (part of OAuth Credentials) obtained via Amazon Developer Account.
    clientSecret String
    Client Secret (part of OAuth Credentials) obtained via Amazon Developer Account.
    enabled Boolean
    Specifies whether to enable the channel. Defaults to true.
    applicationId string
    The application ID.
    clientId string
    Client ID (part of OAuth Credentials) obtained via Amazon Developer Account.
    clientSecret string
    Client Secret (part of OAuth Credentials) obtained via Amazon Developer Account.
    enabled boolean
    Specifies whether to enable the channel. Defaults to true.
    application_id str
    The application ID.
    client_id str
    Client ID (part of OAuth Credentials) obtained via Amazon Developer Account.
    client_secret str
    Client Secret (part of OAuth Credentials) obtained via Amazon Developer Account.
    enabled bool
    Specifies whether to enable the channel. Defaults to true.
    applicationId String
    The application ID.
    clientId String
    Client ID (part of OAuth Credentials) obtained via Amazon Developer Account.
    clientSecret String
    Client Secret (part of OAuth Credentials) obtained via Amazon Developer Account.
    enabled Boolean
    Specifies whether to enable the channel. Defaults to true.

    Outputs

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

    Get an existing AdmChannel 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?: AdmChannelState, opts?: CustomResourceOptions): AdmChannel
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            application_id: Optional[str] = None,
            client_id: Optional[str] = None,
            client_secret: Optional[str] = None,
            enabled: Optional[bool] = None) -> AdmChannel
    func GetAdmChannel(ctx *Context, name string, id IDInput, state *AdmChannelState, opts ...ResourceOption) (*AdmChannel, error)
    public static AdmChannel Get(string name, Input<string> id, AdmChannelState? state, CustomResourceOptions? opts = null)
    public static AdmChannel get(String name, Output<String> id, AdmChannelState 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:
    ApplicationId string
    The application ID.
    ClientId string
    Client ID (part of OAuth Credentials) obtained via Amazon Developer Account.
    ClientSecret string
    Client Secret (part of OAuth Credentials) obtained via Amazon Developer Account.
    Enabled bool
    Specifies whether to enable the channel. Defaults to true.
    ApplicationId string
    The application ID.
    ClientId string
    Client ID (part of OAuth Credentials) obtained via Amazon Developer Account.
    ClientSecret string
    Client Secret (part of OAuth Credentials) obtained via Amazon Developer Account.
    Enabled bool
    Specifies whether to enable the channel. Defaults to true.
    applicationId String
    The application ID.
    clientId String
    Client ID (part of OAuth Credentials) obtained via Amazon Developer Account.
    clientSecret String
    Client Secret (part of OAuth Credentials) obtained via Amazon Developer Account.
    enabled Boolean
    Specifies whether to enable the channel. Defaults to true.
    applicationId string
    The application ID.
    clientId string
    Client ID (part of OAuth Credentials) obtained via Amazon Developer Account.
    clientSecret string
    Client Secret (part of OAuth Credentials) obtained via Amazon Developer Account.
    enabled boolean
    Specifies whether to enable the channel. Defaults to true.
    application_id str
    The application ID.
    client_id str
    Client ID (part of OAuth Credentials) obtained via Amazon Developer Account.
    client_secret str
    Client Secret (part of OAuth Credentials) obtained via Amazon Developer Account.
    enabled bool
    Specifies whether to enable the channel. Defaults to true.
    applicationId String
    The application ID.
    clientId String
    Client ID (part of OAuth Credentials) obtained via Amazon Developer Account.
    clientSecret String
    Client Secret (part of OAuth Credentials) obtained via Amazon Developer Account.
    enabled Boolean
    Specifies whether to enable the channel. Defaults to true.

    Import

    Using pulumi import, import Pinpoint ADM Channel using the application-id. For example:

    $ pulumi import aws:pinpoint/admChannel:AdmChannel channel application-id
    

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

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi