domainMapping.go

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

package appengine

import (
	"context"
	"reflect"

	"github.com/pkg/errors"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

// A domain serving an App Engine application.
//
// To get more information about DomainMapping, see:
//
// * [API documentation](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.domainMappings)
// * How-to Guides
//     * [Official Documentation](https://cloud.google.com/appengine/docs/standard/python/mapping-custom-domains)
//
// ## Example Usage
// ### App Engine Domain Mapping Basic
//
// ```go
// package main
//
// import (
// 	"github.com/pulumi/pulumi-gcp/sdk/v5/go/gcp/appengine"
// 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
// )
//
// func main() {
// 	pulumi.Run(func(ctx *pulumi.Context) error {
// 		_, err := appengine.NewDomainMapping(ctx, "domainMapping", &appengine.DomainMappingArgs{
// 			DomainName: pulumi.String("verified-domain.com"),
// 			SslSettings: &appengine.DomainMappingSslSettingsArgs{
// 				SslManagementType: pulumi.String("AUTOMATIC"),
// 			},
// 		})
// 		if err != nil {
// 			return err
// 		}
// 		return nil
// 	})
// }
// ```
//
// ## Import
//
// DomainMapping can be imported using any of these accepted formats
//
// ```sh
//  $ pulumi import gcp:appengine/domainMapping:DomainMapping default apps/{{project}}/domainMappings/{{domain_name}}
// ```
//
// ```sh
//  $ pulumi import gcp:appengine/domainMapping:DomainMapping default {{project}}/{{domain_name}}
// ```
//
// ```sh
//  $ pulumi import gcp:appengine/domainMapping:DomainMapping default {{domain_name}}
// ```
type DomainMapping struct {
	pulumi.CustomResourceState

	// Relative name of the domain serving the application. Example: example.com.
	DomainName pulumi.StringOutput `pulumi:"domainName"`
	// Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.
	Name pulumi.StringOutput `pulumi:"name"`
	// Whether the domain creation should override any existing mappings for this domain.
	// By default, overrides are rejected.
	// Default value is `STRICT`.
	// Possible values are `STRICT` and `OVERRIDE`.
	OverrideStrategy pulumi.StringPtrOutput `pulumi:"overrideStrategy"`
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project pulumi.StringOutput `pulumi:"project"`
	// The resource records required to configure this domain mapping. These records must be added to the domain's DNS
	// configuration in order to serve the application via this domain mapping.
	ResourceRecords DomainMappingResourceRecordArrayOutput `pulumi:"resourceRecords"`
	// SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
	// Structure is documented below.
	SslSettings DomainMappingSslSettingsPtrOutput `pulumi:"sslSettings"`
}

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

	if args.DomainName == nil {
		return nil, errors.New("invalid value for required argument 'DomainName'")
	}
	var resource DomainMapping
	err := ctx.RegisterResource("gcp:appengine/domainMapping:DomainMapping", name, args, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// GetDomainMapping gets an existing DomainMapping 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 GetDomainMapping(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DomainMappingState, opts ...pulumi.ResourceOption) (*DomainMapping, error) {
	var resource DomainMapping
	err := ctx.ReadResource("gcp:appengine/domainMapping:DomainMapping", name, id, state, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// Input properties used for looking up and filtering DomainMapping resources.
type domainMappingState struct {
	// Relative name of the domain serving the application. Example: example.com.
	DomainName *string `pulumi:"domainName"`
	// Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.
	Name *string `pulumi:"name"`
	// Whether the domain creation should override any existing mappings for this domain.
	// By default, overrides are rejected.
	// Default value is `STRICT`.
	// Possible values are `STRICT` and `OVERRIDE`.
	OverrideStrategy *string `pulumi:"overrideStrategy"`
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project *string `pulumi:"project"`
	// The resource records required to configure this domain mapping. These records must be added to the domain's DNS
	// configuration in order to serve the application via this domain mapping.
	ResourceRecords []DomainMappingResourceRecord `pulumi:"resourceRecords"`
	// SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
	// Structure is documented below.
	SslSettings *DomainMappingSslSettings `pulumi:"sslSettings"`
}

type DomainMappingState struct {
	// Relative name of the domain serving the application. Example: example.com.
	DomainName pulumi.StringPtrInput
	// Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.
	Name pulumi.StringPtrInput
	// Whether the domain creation should override any existing mappings for this domain.
	// By default, overrides are rejected.
	// Default value is `STRICT`.
	// Possible values are `STRICT` and `OVERRIDE`.
	OverrideStrategy pulumi.StringPtrInput
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project pulumi.StringPtrInput
	// The resource records required to configure this domain mapping. These records must be added to the domain's DNS
	// configuration in order to serve the application via this domain mapping.
	ResourceRecords DomainMappingResourceRecordArrayInput
	// SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
	// Structure is documented below.
	SslSettings DomainMappingSslSettingsPtrInput
}

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

type domainMappingArgs struct {
	// Relative name of the domain serving the application. Example: example.com.
	DomainName string `pulumi:"domainName"`
	// Whether the domain creation should override any existing mappings for this domain.
	// By default, overrides are rejected.
	// Default value is `STRICT`.
	// Possible values are `STRICT` and `OVERRIDE`.
	OverrideStrategy *string `pulumi:"overrideStrategy"`
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project *string `pulumi:"project"`
	// SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
	// Structure is documented below.
	SslSettings *DomainMappingSslSettings `pulumi:"sslSettings"`
}

// The set of arguments for constructing a DomainMapping resource.
type DomainMappingArgs struct {
	// Relative name of the domain serving the application. Example: example.com.
	DomainName pulumi.StringInput
	// Whether the domain creation should override any existing mappings for this domain.
	// By default, overrides are rejected.
	// Default value is `STRICT`.
	// Possible values are `STRICT` and `OVERRIDE`.
	OverrideStrategy pulumi.StringPtrInput
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project pulumi.StringPtrInput
	// SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
	// Structure is documented below.
	SslSettings DomainMappingSslSettingsPtrInput
}

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

type DomainMappingInput interface {
	pulumi.Input

	ToDomainMappingOutput() DomainMappingOutput
	ToDomainMappingOutputWithContext(ctx context.Context) DomainMappingOutput
}

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

func (i *DomainMapping) ToDomainMappingOutput() DomainMappingOutput {
	return i.ToDomainMappingOutputWithContext(context.Background())
}

func (i *DomainMapping) ToDomainMappingOutputWithContext(ctx context.Context) DomainMappingOutput {
	return pulumi.ToOutputWithContext(ctx, i).(DomainMappingOutput)
}

func (i *DomainMapping) ToDomainMappingPtrOutput() DomainMappingPtrOutput {
	return i.ToDomainMappingPtrOutputWithContext(context.Background())
}

func (i *DomainMapping) ToDomainMappingPtrOutputWithContext(ctx context.Context) DomainMappingPtrOutput {
	return pulumi.ToOutputWithContext(ctx, i).(DomainMappingPtrOutput)
}

type DomainMappingPtrInput interface {
	pulumi.Input

	ToDomainMappingPtrOutput() DomainMappingPtrOutput
	ToDomainMappingPtrOutputWithContext(ctx context.Context) DomainMappingPtrOutput
}

type domainMappingPtrType DomainMappingArgs

func (*domainMappingPtrType) ElementType() reflect.Type {
	return reflect.TypeOf((**DomainMapping)(nil))
}

func (i *domainMappingPtrType) ToDomainMappingPtrOutput() DomainMappingPtrOutput {
	return i.ToDomainMappingPtrOutputWithContext(context.Background())
}

func (i *domainMappingPtrType) ToDomainMappingPtrOutputWithContext(ctx context.Context) DomainMappingPtrOutput {
	return pulumi.ToOutputWithContext(ctx, i).(DomainMappingPtrOutput)
}

// DomainMappingArrayInput is an input type that accepts DomainMappingArray and DomainMappingArrayOutput values.
// You can construct a concrete instance of `DomainMappingArrayInput` via:
//
//          DomainMappingArray{ DomainMappingArgs{...} }
type DomainMappingArrayInput interface {
	pulumi.Input

	ToDomainMappingArrayOutput() DomainMappingArrayOutput
	ToDomainMappingArrayOutputWithContext(context.Context) DomainMappingArrayOutput
}

type DomainMappingArray []DomainMappingInput

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

func (i DomainMappingArray) ToDomainMappingArrayOutput() DomainMappingArrayOutput {
	return i.ToDomainMappingArrayOutputWithContext(context.Background())
}

func (i DomainMappingArray) ToDomainMappingArrayOutputWithContext(ctx context.Context) DomainMappingArrayOutput {
	return pulumi.ToOutputWithContext(ctx, i).(DomainMappingArrayOutput)
}

// DomainMappingMapInput is an input type that accepts DomainMappingMap and DomainMappingMapOutput values.
// You can construct a concrete instance of `DomainMappingMapInput` via:
//
//          DomainMappingMap{ "key": DomainMappingArgs{...} }
type DomainMappingMapInput interface {
	pulumi.Input

	ToDomainMappingMapOutput() DomainMappingMapOutput
	ToDomainMappingMapOutputWithContext(context.Context) DomainMappingMapOutput
}

type DomainMappingMap map[string]DomainMappingInput

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

func (i DomainMappingMap) ToDomainMappingMapOutput() DomainMappingMapOutput {
	return i.ToDomainMappingMapOutputWithContext(context.Background())
}

func (i DomainMappingMap) ToDomainMappingMapOutputWithContext(ctx context.Context) DomainMappingMapOutput {
	return pulumi.ToOutputWithContext(ctx, i).(DomainMappingMapOutput)
}

type DomainMappingOutput struct{ *pulumi.OutputState }

func (DomainMappingOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*DomainMapping)(nil))
}

func (o DomainMappingOutput) ToDomainMappingOutput() DomainMappingOutput {
	return o
}

func (o DomainMappingOutput) ToDomainMappingOutputWithContext(ctx context.Context) DomainMappingOutput {
	return o
}

func (o DomainMappingOutput) ToDomainMappingPtrOutput() DomainMappingPtrOutput {
	return o.ToDomainMappingPtrOutputWithContext(context.Background())
}

func (o DomainMappingOutput) ToDomainMappingPtrOutputWithContext(ctx context.Context) DomainMappingPtrOutput {
	return o.ApplyTWithContext(ctx, func(_ context.Context, v DomainMapping) *DomainMapping {
		return &v
	}).(DomainMappingPtrOutput)
}

type DomainMappingPtrOutput struct{ *pulumi.OutputState }

func (DomainMappingPtrOutput) ElementType() reflect.Type {
	return reflect.TypeOf((**DomainMapping)(nil))
}

func (o DomainMappingPtrOutput) ToDomainMappingPtrOutput() DomainMappingPtrOutput {
	return o
}

func (o DomainMappingPtrOutput) ToDomainMappingPtrOutputWithContext(ctx context.Context) DomainMappingPtrOutput {
	return o
}

func (o DomainMappingPtrOutput) Elem() DomainMappingOutput {
	return o.ApplyT(func(v *DomainMapping) DomainMapping {
		if v != nil {
			return *v
		}
		var ret DomainMapping
		return ret
	}).(DomainMappingOutput)
}

type DomainMappingArrayOutput struct{ *pulumi.OutputState }

func (DomainMappingArrayOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*[]DomainMapping)(nil))
}

func (o DomainMappingArrayOutput) ToDomainMappingArrayOutput() DomainMappingArrayOutput {
	return o
}

func (o DomainMappingArrayOutput) ToDomainMappingArrayOutputWithContext(ctx context.Context) DomainMappingArrayOutput {
	return o
}

func (o DomainMappingArrayOutput) Index(i pulumi.IntInput) DomainMappingOutput {
	return pulumi.All(o, i).ApplyT(func(vs []interface{}) DomainMapping {
		return vs[0].([]DomainMapping)[vs[1].(int)]
	}).(DomainMappingOutput)
}

type DomainMappingMapOutput struct{ *pulumi.OutputState }

func (DomainMappingMapOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]DomainMapping)(nil))
}

func (o DomainMappingMapOutput) ToDomainMappingMapOutput() DomainMappingMapOutput {
	return o
}

func (o DomainMappingMapOutput) ToDomainMappingMapOutputWithContext(ctx context.Context) DomainMappingMapOutput {
	return o
}

func (o DomainMappingMapOutput) MapIndex(k pulumi.StringInput) DomainMappingOutput {
	return pulumi.All(o, k).ApplyT(func(vs []interface{}) DomainMapping {
		return vs[0].(map[string]DomainMapping)[vs[1].(string)]
	}).(DomainMappingOutput)
}

func init() {
	pulumi.RegisterOutputType(DomainMappingOutput{})
	pulumi.RegisterOutputType(DomainMappingPtrOutput{})
	pulumi.RegisterOutputType(DomainMappingArrayOutput{})
	pulumi.RegisterOutputType(DomainMappingMapOutput{})
}