gmailsendasalias

README

googleworkspace_gmail_send_as_alias

Refer to the Terraform Registory for docs: googleworkspace_gmail_send_as_alias.

Documentation

Index

• func GmailSendAsAlias_IsConstruct(x interface{}) *bool
• func GmailSendAsAlias_TfResourceType() *string
• func NewGmailSendAsAliasSmtpMsaOutputReference_Override(g GmailSendAsAliasSmtpMsaOutputReference, ...)
• func NewGmailSendAsAlias_Override(g GmailSendAsAlias, scope constructs.Construct, id *string, ...)
• type GmailSendAsAlias
  • func NewGmailSendAsAlias(scope constructs.Construct, id *string, config *GmailSendAsAliasConfig) GmailSendAsAlias
• type GmailSendAsAliasConfig
• type GmailSendAsAliasSmtpMsa
• type GmailSendAsAliasSmtpMsaOutputReference
  • func NewGmailSendAsAliasSmtpMsaOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) GmailSendAsAliasSmtpMsaOutputReference

Functions

func GmailSendAsAlias_IsConstruct

func GmailSendAsAlias_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`.

func GmailSendAsAlias_TfResourceType

func GmailSendAsAlias_TfResourceType() *string

func NewGmailSendAsAliasSmtpMsaOutputReference_Override

func NewGmailSendAsAliasSmtpMsaOutputReference_Override(g GmailSendAsAliasSmtpMsaOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)

func NewGmailSendAsAlias_Override

func NewGmailSendAsAlias_Override(g GmailSendAsAlias, scope constructs.Construct, id *string, config *GmailSendAsAliasConfig)

Create a new {@link https://www.terraform.io/docs/providers/googleworkspace/r/gmail_send_as_alias googleworkspace_gmail_send_as_alias} Resource.

Types

type GmailSendAsAlias

type GmailSendAsAlias interface {
	cdktf.TerraformResource
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	Connection() interface{}
	// Experimental.
	SetConnection(val interface{})
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() *float64
	// Experimental.
	SetCount(val *float64)
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	DisplayName() *string
	SetDisplayName(val *string)
	DisplayNameInput() *string
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	Id() *string
	IsDefault() interface{}
	SetIsDefault(val interface{})
	IsDefaultInput() interface{}
	IsPrimary() cdktf.IResolvable
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	// The tree node.
	Node() constructs.Node
	PrimaryEmail() *string
	SetPrimaryEmail(val *string)
	PrimaryEmailInput() *string
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	// Experimental.
	Provisioners() *[]interface{}
	// Experimental.
	SetProvisioners(val *[]interface{})
	// Experimental.
	RawOverrides() interface{}
	ReplyToAddress() *string
	SetReplyToAddress(val *string)
	ReplyToAddressInput() *string
	SendAsEmail() *string
	SetSendAsEmail(val *string)
	SendAsEmailInput() *string
	Signature() *string
	SetSignature(val *string)
	SignatureInput() *string
	SmtpMsa() GmailSendAsAliasSmtpMsaOutputReference
	SmtpMsaInput() *GmailSendAsAliasSmtpMsa
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	TreatAsAlias() interface{}
	SetTreatAsAlias(val interface{})
	TreatAsAliasInput() interface{}
	VerificationStatus() *string
	// Experimental.
	AddOverride(path *string, value interface{})
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	PutSmtpMsa(value *GmailSendAsAliasSmtpMsa)
	ResetDisplayName()
	ResetIsDefault()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetReplyToAddress()
	ResetSignature()
	ResetSmtpMsa()
	ResetTreatAsAlias()
	SynthesizeAttributes() *map[string]interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToTerraform() interface{}
}

Represents a {@link https://www.terraform.io/docs/providers/googleworkspace/r/gmail_send_as_alias googleworkspace_gmail_send_as_alias}.

func NewGmailSendAsAlias

func NewGmailSendAsAlias(scope constructs.Construct, id *string, config *GmailSendAsAliasConfig) GmailSendAsAlias

Create a new {@link https://www.terraform.io/docs/providers/googleworkspace/r/gmail_send_as_alias googleworkspace_gmail_send_as_alias} Resource.

type GmailSendAsAliasConfig

type GmailSendAsAliasConfig struct {
	// Experimental.
	Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
	// Experimental.
	Count *float64 `field:"optional" json:"count" yaml:"count"`
	// Experimental.
	DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
	// Experimental.
	ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
	// Experimental.
	Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
	// Experimental.
	Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
	// Experimental.
	Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
	// User's primary email address.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/googleworkspace/r/gmail_send_as_alias#primary_email GmailSendAsAlias#primary_email}
	PrimaryEmail *string `field:"required" json:"primaryEmail" yaml:"primaryEmail"`
	// The email address that appears in the 'From:' header for mail sent using this alias.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/googleworkspace/r/gmail_send_as_alias#send_as_email GmailSendAsAlias#send_as_email}
	SendAsEmail *string `field:"required" json:"sendAsEmail" yaml:"sendAsEmail"`
	// A name that appears in the 'From:' header for mail sent using this alias.
	//
	// For custom 'from' addresses, when this is empty, Gmail will populate the 'From:' header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/googleworkspace/r/gmail_send_as_alias#display_name GmailSendAsAlias#display_name}
	DisplayName *string `field:"optional" json:"displayName" yaml:"displayName"`
	// Whether this address is selected as the default 'From:' address in situations such as composing a new message or sending a vacation auto-reply.
	//
	// Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is true. Changing this from false to true for an address will result in this field becoming false for the other previous default address. Toggling an existing alias' default to false is not possible, another alias must be added/imported and toggled to true to remove the default from an existing alias. To avoid drift with Terraform, please change the previous default's config to false AFTER a new default is applied and perform a refresh to synchronize with remote state.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/googleworkspace/r/gmail_send_as_alias#is_default GmailSendAsAlias#is_default}
	IsDefault interface{} `field:"optional" json:"isDefault" yaml:"isDefault"`
	// An optional email address that is included in a 'Reply-To:' header for mail sent using this alias.
	//
	// If this is empty, Gmail will not generate a 'Reply-To:' header.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/googleworkspace/r/gmail_send_as_alias#reply_to_address GmailSendAsAlias#reply_to_address}
	ReplyToAddress *string `field:"optional" json:"replyToAddress" yaml:"replyToAddress"`
	// An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
	//
	// This signature is added to new emails only.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/googleworkspace/r/gmail_send_as_alias#signature GmailSendAsAlias#signature}
	Signature *string `field:"optional" json:"signature" yaml:"signature"`
	// smtp_msa block.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/googleworkspace/r/gmail_send_as_alias#smtp_msa GmailSendAsAlias#smtp_msa}
	SmtpMsa *GmailSendAsAliasSmtpMsa `field:"optional" json:"smtpMsa" yaml:"smtpMsa"`
	// Defaults to `true`.
	//
	// Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom 'from' aliases. See https://support.google.com/a/answer/1710338 for help on making this decision
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/googleworkspace/r/gmail_send_as_alias#treat_as_alias GmailSendAsAlias#treat_as_alias}
	TreatAsAlias interface{} `field:"optional" json:"treatAsAlias" yaml:"treatAsAlias"`
}

type GmailSendAsAliasSmtpMsa

type GmailSendAsAliasSmtpMsa struct {
	// The hostname of the SMTP service.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/googleworkspace/r/gmail_send_as_alias#host GmailSendAsAlias#host}
	Host *string `field:"required" json:"host" yaml:"host"`
	// The port of the SMTP service.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/googleworkspace/r/gmail_send_as_alias#port GmailSendAsAlias#port}
	Port *float64 `field:"required" json:"port" yaml:"port"`
	// The password that will be used for authentication with the SMTP service.
	//
	// This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/googleworkspace/r/gmail_send_as_alias#password GmailSendAsAlias#password}
	Password *string `field:"optional" json:"password" yaml:"password"`
	// Defaults to `securityModeUnspecified`. The protocol that will be used to secure communication with the SMTP service.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/googleworkspace/r/gmail_send_as_alias#security_mode GmailSendAsAlias#security_mode}
	SecurityMode *string `field:"optional" json:"securityMode" yaml:"securityMode"`
	// The username that will be used for authentication with the SMTP service.
	//
	// This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/googleworkspace/r/gmail_send_as_alias#username GmailSendAsAlias#username}
	Username *string `field:"optional" json:"username" yaml:"username"`
}

type GmailSendAsAliasSmtpMsaOutputReference

type GmailSendAsAliasSmtpMsaOutputReference interface {
	cdktf.ComplexObject
	// the index of the complex object in a list.
	// Experimental.
	ComplexObjectIndex() interface{}
	// Experimental.
	SetComplexObjectIndex(val interface{})
	// set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items.
	// Experimental.
	ComplexObjectIsFromSet() *bool
	// Experimental.
	SetComplexObjectIsFromSet(val *bool)
	// The creation stack of this resolvable which will be appended to errors thrown during resolution.
	//
	// If this returns an empty array the stack will not be attached.
	// Experimental.
	CreationStack() *[]*string
	// Experimental.
	Fqn() *string
	Host() *string
	SetHost(val *string)
	HostInput() *string
	InternalValue() *GmailSendAsAliasSmtpMsa
	SetInternalValue(val *GmailSendAsAliasSmtpMsa)
	Password() *string
	SetPassword(val *string)
	PasswordInput() *string
	Port() *float64
	SetPort(val *float64)
	PortInput() *float64
	SecurityMode() *string
	SetSecurityMode(val *string)
	SecurityModeInput() *string
	// Experimental.
	TerraformAttribute() *string
	// Experimental.
	SetTerraformAttribute(val *string)
	// Experimental.
	TerraformResource() cdktf.IInterpolatingParent
	// Experimental.
	SetTerraformResource(val cdktf.IInterpolatingParent)
	Username() *string
	SetUsername(val *string)
	UsernameInput() *string
	// Experimental.
	ComputeFqn() *string
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationAsList() cdktf.IResolvable
	// Experimental.
	InterpolationForAttribute(property *string) cdktf.IResolvable
	ResetPassword()
	ResetSecurityMode()
	ResetUsername()
	// Produce the Token's value at resolution time.
	// Experimental.
	Resolve(_context cdktf.IResolveContext) interface{}
	// Return a string representation of this resolvable object.
	//
	// Returns a reversible string representation.
	// Experimental.
	ToString() *string
}

func NewGmailSendAsAliasSmtpMsaOutputReference

func NewGmailSendAsAliasSmtpMsaOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) GmailSendAsAliasSmtpMsaOutputReference