github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/pinpoint/apnsSandboxChannel.go

// Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***

package pinpoint

import (
	"context"
	"reflect"

	"errors"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/internal"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

// Provides a Pinpoint APNs Sandbox Channel resource.
//
// > **Note:** All arguments, including certificates and tokens, will be stored in the raw state as plain-text.
// ## Example Usage
//
// <!--Start PulumiCodeChooser -->
// ```go
// package main
//
// import (
//
//	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/pinpoint"
//	"github.com/pulumi/pulumi-std/sdk/go/std"
//	"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
//			}
//			invokeFile, err := std.File(ctx, &std.FileArgs{
//				Input: "./certificate.pem",
//			}, nil)
//			if err != nil {
//				return err
//			}
//			invokeFile1, err := std.File(ctx, &std.FileArgs{
//				Input: "./private_key.key",
//			}, nil)
//			if err != nil {
//				return err
//			}
//			_, err = pinpoint.NewApnsSandboxChannel(ctx, "apns_sandbox", &pinpoint.ApnsSandboxChannelArgs{
//				ApplicationId: app.ApplicationId,
//				Certificate:   invokeFile.Result,
//				PrivateKey:    invokeFile1.Result,
//			})
//			if err != nil {
//				return err
//			}
//			return nil
//		})
//	}
//
// ```
// <!--End PulumiCodeChooser -->
//
// ## Import
//
// Using `pulumi import`, import Pinpoint APNs Sandbox Channel using the `application-id`. For example:
//
// ```sh
// $ pulumi import aws:pinpoint/apnsSandboxChannel:ApnsSandboxChannel apns_sandbox application-id
// ```
type ApnsSandboxChannel struct {
	pulumi.CustomResourceState

	// The application ID.
	ApplicationId pulumi.StringOutput `pulumi:"applicationId"`
	// The ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app.
	BundleId pulumi.StringPtrOutput `pulumi:"bundleId"`
	// The pem encoded TLS Certificate from Apple.
	Certificate pulumi.StringPtrOutput `pulumi:"certificate"`
	// The default authentication method used for APNs Sandbox.
	// __NOTE__: Amazon Pinpoint uses this default for every APNs push notification that you send using the console.
	// You can override the default when you send a message programmatically using the Amazon Pinpoint API, the AWS CLI, or an AWS SDK.
	// If your default authentication type fails, Amazon Pinpoint doesn't attempt to use the other authentication type.
	//
	// One of the following sets of credentials is also required.
	//
	// If you choose to use __Certificate credentials__ you will have to provide:
	DefaultAuthenticationMethod pulumi.StringPtrOutput `pulumi:"defaultAuthenticationMethod"`
	// Whether the channel is enabled or disabled. Defaults to `true`.
	Enabled pulumi.BoolPtrOutput `pulumi:"enabled"`
	// The Certificate Private Key file (ie. `.key` file).
	//
	// If you choose to use __Key credentials__ you will have to provide:
	PrivateKey pulumi.StringPtrOutput `pulumi:"privateKey"`
	// The ID assigned to your Apple developer account team. This value is provided on the Membership page.
	TeamId pulumi.StringPtrOutput `pulumi:"teamId"`
	// The `.p8` file that you download from your Apple developer account when you create an authentication key.
	TokenKey pulumi.StringPtrOutput `pulumi:"tokenKey"`
	// The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.
	TokenKeyId pulumi.StringPtrOutput `pulumi:"tokenKeyId"`
}

// NewApnsSandboxChannel registers a new resource with the given unique name, arguments, and options.
func NewApnsSandboxChannel(ctx *pulumi.Context,
	name string, args *ApnsSandboxChannelArgs, opts ...pulumi.ResourceOption) (*ApnsSandboxChannel, error) {
	if args == nil {
		return nil, errors.New("missing one or more required arguments")
	}

	if args.ApplicationId == nil {
		return nil, errors.New("invalid value for required argument 'ApplicationId'")
	}
	if args.BundleId != nil {
		args.BundleId = pulumi.ToSecret(args.BundleId).(pulumi.StringPtrInput)
	}
	if args.Certificate != nil {
		args.Certificate = pulumi.ToSecret(args.Certificate).(pulumi.StringPtrInput)
	}
	if args.PrivateKey != nil {
		args.PrivateKey = pulumi.ToSecret(args.PrivateKey).(pulumi.StringPtrInput)
	}
	if args.TeamId != nil {
		args.TeamId = pulumi.ToSecret(args.TeamId).(pulumi.StringPtrInput)
	}
	if args.TokenKey != nil {
		args.TokenKey = pulumi.ToSecret(args.TokenKey).(pulumi.StringPtrInput)
	}
	if args.TokenKeyId != nil {
		args.TokenKeyId = pulumi.ToSecret(args.TokenKeyId).(pulumi.StringPtrInput)
	}
	secrets := pulumi.AdditionalSecretOutputs([]string{
		"bundleId",
		"certificate",
		"privateKey",
		"teamId",
		"tokenKey",
		"tokenKeyId",
	})
	opts = append(opts, secrets)
	opts = internal.PkgResourceDefaultOpts(opts)
	var resource ApnsSandboxChannel
	err := ctx.RegisterResource("aws:pinpoint/apnsSandboxChannel:ApnsSandboxChannel", name, args, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// GetApnsSandboxChannel gets an existing ApnsSandboxChannel 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 GetApnsSandboxChannel(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ApnsSandboxChannelState, opts ...pulumi.ResourceOption) (*ApnsSandboxChannel, error) {
	var resource ApnsSandboxChannel
	err := ctx.ReadResource("aws:pinpoint/apnsSandboxChannel:ApnsSandboxChannel", name, id, state, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// Input properties used for looking up and filtering ApnsSandboxChannel resources.
type apnsSandboxChannelState struct {
	// The application ID.
	ApplicationId *string `pulumi:"applicationId"`
	// The ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app.
	BundleId *string `pulumi:"bundleId"`
	// The pem encoded TLS Certificate from Apple.
	Certificate *string `pulumi:"certificate"`
	// The default authentication method used for APNs Sandbox.
	// __NOTE__: Amazon Pinpoint uses this default for every APNs push notification that you send using the console.
	// You can override the default when you send a message programmatically using the Amazon Pinpoint API, the AWS CLI, or an AWS SDK.
	// If your default authentication type fails, Amazon Pinpoint doesn't attempt to use the other authentication type.
	//
	// One of the following sets of credentials is also required.
	//
	// If you choose to use __Certificate credentials__ you will have to provide:
	DefaultAuthenticationMethod *string `pulumi:"defaultAuthenticationMethod"`
	// Whether the channel is enabled or disabled. Defaults to `true`.
	Enabled *bool `pulumi:"enabled"`
	// The Certificate Private Key file (ie. `.key` file).
	//
	// If you choose to use __Key credentials__ you will have to provide:
	PrivateKey *string `pulumi:"privateKey"`
	// The ID assigned to your Apple developer account team. This value is provided on the Membership page.
	TeamId *string `pulumi:"teamId"`
	// The `.p8` file that you download from your Apple developer account when you create an authentication key.
	TokenKey *string `pulumi:"tokenKey"`
	// The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.
	TokenKeyId *string `pulumi:"tokenKeyId"`
}

type ApnsSandboxChannelState struct {
	// The application ID.
	ApplicationId pulumi.StringPtrInput
	// The ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app.
	BundleId pulumi.StringPtrInput
	// The pem encoded TLS Certificate from Apple.
	Certificate pulumi.StringPtrInput
	// The default authentication method used for APNs Sandbox.
	// __NOTE__: Amazon Pinpoint uses this default for every APNs push notification that you send using the console.
	// You can override the default when you send a message programmatically using the Amazon Pinpoint API, the AWS CLI, or an AWS SDK.
	// If your default authentication type fails, Amazon Pinpoint doesn't attempt to use the other authentication type.
	//
	// One of the following sets of credentials is also required.
	//
	// If you choose to use __Certificate credentials__ you will have to provide:
	DefaultAuthenticationMethod pulumi.StringPtrInput
	// Whether the channel is enabled or disabled. Defaults to `true`.
	Enabled pulumi.BoolPtrInput
	// The Certificate Private Key file (ie. `.key` file).
	//
	// If you choose to use __Key credentials__ you will have to provide:
	PrivateKey pulumi.StringPtrInput
	// The ID assigned to your Apple developer account team. This value is provided on the Membership page.
	TeamId pulumi.StringPtrInput
	// The `.p8` file that you download from your Apple developer account when you create an authentication key.
	TokenKey pulumi.StringPtrInput
	// The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.
	TokenKeyId pulumi.StringPtrInput
}

func (ApnsSandboxChannelState) ElementType() reflect.Type {
	return reflect.TypeOf((*apnsSandboxChannelState)(nil)).Elem()
}

type apnsSandboxChannelArgs struct {
	// The application ID.
	ApplicationId string `pulumi:"applicationId"`
	// The ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app.
	BundleId *string `pulumi:"bundleId"`
	// The pem encoded TLS Certificate from Apple.
	Certificate *string `pulumi:"certificate"`
	// The default authentication method used for APNs Sandbox.
	// __NOTE__: Amazon Pinpoint uses this default for every APNs push notification that you send using the console.
	// You can override the default when you send a message programmatically using the Amazon Pinpoint API, the AWS CLI, or an AWS SDK.
	// If your default authentication type fails, Amazon Pinpoint doesn't attempt to use the other authentication type.
	//
	// One of the following sets of credentials is also required.
	//
	// If you choose to use __Certificate credentials__ you will have to provide:
	DefaultAuthenticationMethod *string `pulumi:"defaultAuthenticationMethod"`
	// Whether the channel is enabled or disabled. Defaults to `true`.
	Enabled *bool `pulumi:"enabled"`
	// The Certificate Private Key file (ie. `.key` file).
	//
	// If you choose to use __Key credentials__ you will have to provide:
	PrivateKey *string `pulumi:"privateKey"`
	// The ID assigned to your Apple developer account team. This value is provided on the Membership page.
	TeamId *string `pulumi:"teamId"`
	// The `.p8` file that you download from your Apple developer account when you create an authentication key.
	TokenKey *string `pulumi:"tokenKey"`
	// The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.
	TokenKeyId *string `pulumi:"tokenKeyId"`
}

// The set of arguments for constructing a ApnsSandboxChannel resource.
type ApnsSandboxChannelArgs struct {
	// The application ID.
	ApplicationId pulumi.StringInput
	// The ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app.
	BundleId pulumi.StringPtrInput
	// The pem encoded TLS Certificate from Apple.
	Certificate pulumi.StringPtrInput
	// The default authentication method used for APNs Sandbox.
	// __NOTE__: Amazon Pinpoint uses this default for every APNs push notification that you send using the console.
	// You can override the default when you send a message programmatically using the Amazon Pinpoint API, the AWS CLI, or an AWS SDK.
	// If your default authentication type fails, Amazon Pinpoint doesn't attempt to use the other authentication type.
	//
	// One of the following sets of credentials is also required.
	//
	// If you choose to use __Certificate credentials__ you will have to provide:
	DefaultAuthenticationMethod pulumi.StringPtrInput
	// Whether the channel is enabled or disabled. Defaults to `true`.
	Enabled pulumi.BoolPtrInput
	// The Certificate Private Key file (ie. `.key` file).
	//
	// If you choose to use __Key credentials__ you will have to provide:
	PrivateKey pulumi.StringPtrInput
	// The ID assigned to your Apple developer account team. This value is provided on the Membership page.
	TeamId pulumi.StringPtrInput
	// The `.p8` file that you download from your Apple developer account when you create an authentication key.
	TokenKey pulumi.StringPtrInput
	// The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.
	TokenKeyId pulumi.StringPtrInput
}

func (ApnsSandboxChannelArgs) ElementType() reflect.Type {
	return reflect.TypeOf((*apnsSandboxChannelArgs)(nil)).Elem()
}

type ApnsSandboxChannelInput interface {
	pulumi.Input

	ToApnsSandboxChannelOutput() ApnsSandboxChannelOutput
	ToApnsSandboxChannelOutputWithContext(ctx context.Context) ApnsSandboxChannelOutput
}

func (*ApnsSandboxChannel) ElementType() reflect.Type {
	return reflect.TypeOf((**ApnsSandboxChannel)(nil)).Elem()
}

func (i *ApnsSandboxChannel) ToApnsSandboxChannelOutput() ApnsSandboxChannelOutput {
	return i.ToApnsSandboxChannelOutputWithContext(context.Background())
}

func (i *ApnsSandboxChannel) ToApnsSandboxChannelOutputWithContext(ctx context.Context) ApnsSandboxChannelOutput {
	return pulumi.ToOutputWithContext(ctx, i).(ApnsSandboxChannelOutput)
}

// ApnsSandboxChannelArrayInput is an input type that accepts ApnsSandboxChannelArray and ApnsSandboxChannelArrayOutput values.
// You can construct a concrete instance of `ApnsSandboxChannelArrayInput` via:
//
//	ApnsSandboxChannelArray{ ApnsSandboxChannelArgs{...} }
type ApnsSandboxChannelArrayInput interface {
	pulumi.Input

	ToApnsSandboxChannelArrayOutput() ApnsSandboxChannelArrayOutput
	ToApnsSandboxChannelArrayOutputWithContext(context.Context) ApnsSandboxChannelArrayOutput
}

type ApnsSandboxChannelArray []ApnsSandboxChannelInput

func (ApnsSandboxChannelArray) ElementType() reflect.Type {
	return reflect.TypeOf((*[]*ApnsSandboxChannel)(nil)).Elem()
}

func (i ApnsSandboxChannelArray) ToApnsSandboxChannelArrayOutput() ApnsSandboxChannelArrayOutput {
	return i.ToApnsSandboxChannelArrayOutputWithContext(context.Background())
}

func (i ApnsSandboxChannelArray) ToApnsSandboxChannelArrayOutputWithContext(ctx context.Context) ApnsSandboxChannelArrayOutput {
	return pulumi.ToOutputWithContext(ctx, i).(ApnsSandboxChannelArrayOutput)
}

// ApnsSandboxChannelMapInput is an input type that accepts ApnsSandboxChannelMap and ApnsSandboxChannelMapOutput values.
// You can construct a concrete instance of `ApnsSandboxChannelMapInput` via:
//
//	ApnsSandboxChannelMap{ "key": ApnsSandboxChannelArgs{...} }
type ApnsSandboxChannelMapInput interface {
	pulumi.Input

	ToApnsSandboxChannelMapOutput() ApnsSandboxChannelMapOutput
	ToApnsSandboxChannelMapOutputWithContext(context.Context) ApnsSandboxChannelMapOutput
}

type ApnsSandboxChannelMap map[string]ApnsSandboxChannelInput

func (ApnsSandboxChannelMap) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]*ApnsSandboxChannel)(nil)).Elem()
}

func (i ApnsSandboxChannelMap) ToApnsSandboxChannelMapOutput() ApnsSandboxChannelMapOutput {
	return i.ToApnsSandboxChannelMapOutputWithContext(context.Background())
}

func (i ApnsSandboxChannelMap) ToApnsSandboxChannelMapOutputWithContext(ctx context.Context) ApnsSandboxChannelMapOutput {
	return pulumi.ToOutputWithContext(ctx, i).(ApnsSandboxChannelMapOutput)
}

type ApnsSandboxChannelOutput struct{ *pulumi.OutputState }

func (ApnsSandboxChannelOutput) ElementType() reflect.Type {
	return reflect.TypeOf((**ApnsSandboxChannel)(nil)).Elem()
}

func (o ApnsSandboxChannelOutput) ToApnsSandboxChannelOutput() ApnsSandboxChannelOutput {
	return o
}

func (o ApnsSandboxChannelOutput) ToApnsSandboxChannelOutputWithContext(ctx context.Context) ApnsSandboxChannelOutput {
	return o
}

// The application ID.
func (o ApnsSandboxChannelOutput) ApplicationId() pulumi.StringOutput {
	return o.ApplyT(func(v *ApnsSandboxChannel) pulumi.StringOutput { return v.ApplicationId }).(pulumi.StringOutput)
}

// The ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app.
func (o ApnsSandboxChannelOutput) BundleId() pulumi.StringPtrOutput {
	return o.ApplyT(func(v *ApnsSandboxChannel) pulumi.StringPtrOutput { return v.BundleId }).(pulumi.StringPtrOutput)
}

// The pem encoded TLS Certificate from Apple.
func (o ApnsSandboxChannelOutput) Certificate() pulumi.StringPtrOutput {
	return o.ApplyT(func(v *ApnsSandboxChannel) pulumi.StringPtrOutput { return v.Certificate }).(pulumi.StringPtrOutput)
}

// The default authentication method used for APNs Sandbox.
// __NOTE__: Amazon Pinpoint uses this default for every APNs push notification that you send using the console.
// You can override the default when you send a message programmatically using the Amazon Pinpoint API, the AWS CLI, or an AWS SDK.
// If your default authentication type fails, Amazon Pinpoint doesn't attempt to use the other authentication type.
//
// One of the following sets of credentials is also required.
//
// If you choose to use __Certificate credentials__ you will have to provide:
func (o ApnsSandboxChannelOutput) DefaultAuthenticationMethod() pulumi.StringPtrOutput {
	return o.ApplyT(func(v *ApnsSandboxChannel) pulumi.StringPtrOutput { return v.DefaultAuthenticationMethod }).(pulumi.StringPtrOutput)
}

// Whether the channel is enabled or disabled. Defaults to `true`.
func (o ApnsSandboxChannelOutput) Enabled() pulumi.BoolPtrOutput {
	return o.ApplyT(func(v *ApnsSandboxChannel) pulumi.BoolPtrOutput { return v.Enabled }).(pulumi.BoolPtrOutput)
}

// The Certificate Private Key file (ie. `.key` file).
//
// If you choose to use __Key credentials__ you will have to provide:
func (o ApnsSandboxChannelOutput) PrivateKey() pulumi.StringPtrOutput {
	return o.ApplyT(func(v *ApnsSandboxChannel) pulumi.StringPtrOutput { return v.PrivateKey }).(pulumi.StringPtrOutput)
}

// The ID assigned to your Apple developer account team. This value is provided on the Membership page.
func (o ApnsSandboxChannelOutput) TeamId() pulumi.StringPtrOutput {
	return o.ApplyT(func(v *ApnsSandboxChannel) pulumi.StringPtrOutput { return v.TeamId }).(pulumi.StringPtrOutput)
}

// The `.p8` file that you download from your Apple developer account when you create an authentication key.
func (o ApnsSandboxChannelOutput) TokenKey() pulumi.StringPtrOutput {
	return o.ApplyT(func(v *ApnsSandboxChannel) pulumi.StringPtrOutput { return v.TokenKey }).(pulumi.StringPtrOutput)
}

// The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.
func (o ApnsSandboxChannelOutput) TokenKeyId() pulumi.StringPtrOutput {
	return o.ApplyT(func(v *ApnsSandboxChannel) pulumi.StringPtrOutput { return v.TokenKeyId }).(pulumi.StringPtrOutput)
}

type ApnsSandboxChannelArrayOutput struct{ *pulumi.OutputState }

func (ApnsSandboxChannelArrayOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*[]*ApnsSandboxChannel)(nil)).Elem()
}

func (o ApnsSandboxChannelArrayOutput) ToApnsSandboxChannelArrayOutput() ApnsSandboxChannelArrayOutput {
	return o
}

func (o ApnsSandboxChannelArrayOutput) ToApnsSandboxChannelArrayOutputWithContext(ctx context.Context) ApnsSandboxChannelArrayOutput {
	return o
}

func (o ApnsSandboxChannelArrayOutput) Index(i pulumi.IntInput) ApnsSandboxChannelOutput {
	return pulumi.All(o, i).ApplyT(func(vs []interface{}) *ApnsSandboxChannel {
		return vs[0].([]*ApnsSandboxChannel)[vs[1].(int)]
	}).(ApnsSandboxChannelOutput)
}

type ApnsSandboxChannelMapOutput struct{ *pulumi.OutputState }

func (ApnsSandboxChannelMapOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]*ApnsSandboxChannel)(nil)).Elem()
}

func (o ApnsSandboxChannelMapOutput) ToApnsSandboxChannelMapOutput() ApnsSandboxChannelMapOutput {
	return o
}

func (o ApnsSandboxChannelMapOutput) ToApnsSandboxChannelMapOutputWithContext(ctx context.Context) ApnsSandboxChannelMapOutput {
	return o
}

func (o ApnsSandboxChannelMapOutput) MapIndex(k pulumi.StringInput) ApnsSandboxChannelOutput {
	return pulumi.All(o, k).ApplyT(func(vs []interface{}) *ApnsSandboxChannel {
		return vs[0].(map[string]*ApnsSandboxChannel)[vs[1].(string)]
	}).(ApnsSandboxChannelOutput)
}

func init() {
	pulumi.RegisterInputType(reflect.TypeOf((*ApnsSandboxChannelInput)(nil)).Elem(), &ApnsSandboxChannel{})
	pulumi.RegisterInputType(reflect.TypeOf((*ApnsSandboxChannelArrayInput)(nil)).Elem(), ApnsSandboxChannelArray{})
	pulumi.RegisterInputType(reflect.TypeOf((*ApnsSandboxChannelMapInput)(nil)).Elem(), ApnsSandboxChannelMap{})
	pulumi.RegisterOutputType(ApnsSandboxChannelOutput{})
	pulumi.RegisterOutputType(ApnsSandboxChannelArrayOutput{})
	pulumi.RegisterOutputType(ApnsSandboxChannelMapOutput{})
}