provider

package module
v0.0.0-...-09c3740 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 14, 2024 License: MIT Imports: 14 Imported by: 0

Documentation

Index

Constants

View Source 
const Name string = "awsworkmail"

Variables

View Source 
var Version string

Version is initialized by the Go linker to contain the semver of this build.

Functions

func Find 

func Find[T any](predicate func(T) bool) func([]T) (T, bool)

Find returns a function that takes a slice of type T and returns the first element that satisfies the predicate function, along with a boolean indicating if an element was found.

func Map 

func Map[T any, U any](f func(T) U) func([]T) []U

func Provider 

func Provider() p.Provider

Types

type CognitoEmailSender 

type CognitoEmailSender struct{}

Each resource has a controlling struct. Resource behavior is determined by implementing methods on the controlling struct. The `Create` method is mandatory, but other methods are optional. - Check: Remap inputs before they are typed. - Diff: Change how instances of a resource are compared. - Update: Mutate a resource in place. - Read: Get the state of a resource from the backing provider. - Delete: Custom logic when the resource is deleted. - Annotate: Describe fields and set defaults for a resource. - WireDependencies: Control how outputs and secrets flows through values.

func (CognitoEmailSender) Create 

func (CognitoEmailSender) Create(ctx p.Context, name string, input CognitoEmailSenderArgs, preview bool) (string, CognitoEmailSenderState, error)

All resources must implement Create at a minimum.

func (CognitoEmailSender) Delete 

func (CognitoEmailSender) Delete(ctx p.Context, id string, props CognitoEmailSenderState) error

The Delete method will run when the resource is deleted.

func (CognitoEmailSender) Diff 

func (CognitoEmailSender) Diff(ctx p.Context, id string, olds CognitoEmailSenderState, news CognitoEmailSenderArgs) (p.DiffResponse, error)

type CognitoEmailSenderArgs 

type CognitoEmailSenderArgs struct {
	// ID of the cognito user pool that should be updated with the custom email sender.
	UserPoolId string `pulumi:"userPoolId"`
	// Arn of the lambda that is responsible for sending emails
	LambdaArn string `pulumi:"lambdaArn"`
	// Arn of the KMS key that is used to encrypt verification codes sent via email.
	KmsKeyArn string `pulumi:"kmsKeyArn"`
}

Each resource has an input struct, defining what arguments it accepts.

type CognitoEmailSenderState 

type CognitoEmailSenderState struct {
	// It is generally a good idea to embed args in outputs, but it isn't strictly necessary.
	CognitoEmailSenderArgs
}

Each resource has a state, describing the fields that exist on the created resource.

type DefaultDomain 

type DefaultDomain struct{}

Each resource has a controlling struct. Resource behavior is determined by implementing methods on the controlling struct. The `Create` method is mandatory, but other methods are optional. - Check: Remap inputs before they are typed. - Diff: Change how instances of a resource are compared. - Update: Mutate a resource in place. - Read: Get the state of a resource from the backing provider. - Delete: Custom logic when the resource is deleted. - Annotate: Describe fields and set defaults for a resource. - WireDependencies: Control how outputs and secrets flows through values.

func (DefaultDomain) Create 

func (DefaultDomain) Create(ctx p.Context, name string, input DefaultDomainArgs, preview bool) (string, DefaultDomainState, error)

All resources must implement Create at a minimum.

func (DefaultDomain) Delete 

func (DefaultDomain) Delete(ctx p.Context, id string, props DefaultDomainState) error

The Delete method will run when the resource is deleted.

type DefaultDomainArgs 

type DefaultDomainArgs struct {
	// The AWS Region. TODO: This should be passed as a pulumi.Provider
	Region string `pulumi:"region"`
	// The domain name.
	DomainName string `pulumi:"domainName"`
	// The organization the domain should be associated with.
	OrganizationId string `pulumi:"organizationId"`
	// The idempotency token associated with the request.
	ClientToken *string `pulumi:"clientToken,optional"`
}

Each resource has an input struct, defining what arguments it accepts.

type DefaultDomainState 

type DefaultDomainState struct {
	// It is generally a good idea to embed args in outputs, but it isn't strictly necessary.
	DefaultDomainArgs

	// Mail domain records.
	Records []DnsRecord `pulumi:"records"`
}

Each resource has a state, describing the fields that exist on the created resource.

type DnsRecord 

type DnsRecord struct {
	Type     string `pulumi:"type"`
	Hostname string `pulumi:"hostname"`
	Value    string `pulumi:"value"`
}

type Organization 

type Organization struct{}

Each resource has a controlling struct. Resource behavior is determined by implementing methods on the controlling struct. The `Create` method is mandatory, but other methods are optional. - Check: Remap inputs before they are typed. - Diff: Change how instances of a resource are compared. - Update: Mutate a resource in place. - Read: Get the state of a resource from the backing provider. - Delete: Custom logic when the resource is deleted. - Annotate: Describe fields and set defaults for a resource. - WireDependencies: Control how outputs and secrets flows through values.

func (Organization) Create 

func (Organization) Create(ctx p.Context, name string, input OrganizationArgs, preview bool) (string, OrganizationState, error)

All resources must implement Create at a minimum.

func (Organization) Delete 

func (Organization) Delete(ctx p.Context, id string, props OrganizationState) error

The Delete method will run when the resource is deleted.

type OrganizationArgs 

type OrganizationArgs struct {
	// The AWS Region. TODO: This should be passed as a pulumi.Provider
	Region string `pulumi:"region"`
	// The organization alias.
	Alias string `pulumi:"alias"`
	// The idempotency token associated with the request.
	ClientToken *string `pulumi:"clientToken,optional"`
	// The AWS Directory Service directory ID.
	DirectoryId *string `pulumi:"directoryId,optional"`
	// The Amazon Resource Name (ARN) of a customer managed key from AWS KMS.
	KmsKeyArn *string `pulumi:"kmsKeyArn,optional"`
	// When true , allows organization interoperability between WorkMail and Microsoft Exchange. If true , you must include a AD Connector directory ID in the request.
	EnableInteroperability *bool `pulumi:"enableInteroperability,optional"`
}

Each resource has an input struct, defining what arguments it accepts.

type OrganizationState 

type OrganizationState struct {
	// It is generally a good idea to embed args in outputs, but it isn't strictly necessary.
	OrganizationArgs

	// The organization id.
	OrganizationId string `pulumi:"organizationId"`
}

Each resource has a state, describing the fields that exist on the created resource.

type Random 

type Random struct{}

Each resource has a controlling struct. Resource behavior is determined by implementing methods on the controlling struct. The `Create` method is mandatory, but other methods are optional. - Check: Remap inputs before they are typed. - Diff: Change how instances of a resource are compared. - Update: Mutate a resource in place. - Read: Get the state of a resource from the backing provider. - Delete: Custom logic when the resource is deleted. - Annotate: Describe fields and set defaults for a resource. - WireDependencies: Control how outputs and secrets flows through values.

func (Random) Create 

func (Random) Create(ctx p.Context, name string, input RandomArgs, preview bool) (string, RandomState, error)

All resources must implement Create at a minimum.

type RandomArgs 

type RandomArgs struct {
	// Fields projected into Pulumi must be public and hava a `pulumi:"..."` tag.
	// The pulumi tag doesn't need to match the field name, but it's generally a
	// good idea.
	Length int `pulumi:"length"`
}

Each resource has an input struct, defining what arguments it accepts.

type RandomState 

type RandomState struct {
	// It is generally a good idea to embed args in outputs, but it isn't strictly necessary.
	RandomArgs
	// Here we define a required output called result.
	Result string `pulumi:"result"`
}

Each resource has a state, describing the fields that exist on the created resource.

type User 

type User struct{}

Each resource has a controlling struct. Resource behavior is determined by implementing methods on the controlling struct. The `Create` method is mandatory, but other methods are optional. - Check: Remap inputs before they are typed. - Diff: Change how instances of a resource are compared. - Update: Mutate a resource in place. - Read: Get the state of a resource from the backing provider. - Delete: Custom logic when the resource is deleted. - Annotate: Describe fields and set defaults for a resource. - WireDependencies: Control how outputs and secrets flows through values.

func (User) Create 

func (User) Create(ctx p.Context, name string, input UserArgs, preview bool) (string, UserState, error)

All resources must implement Create at a minimum.

func (User) Delete 

func (User) Delete(ctx p.Context, id string, props UserState) error

The Delete method will run when the resource is deleted.

func (User) Diff 

func (User) Diff(ctx p.Context, id string, olds UserState, news UserArgs) (p.DiffResponse, error)

type UserArgs 

type UserArgs struct {
	// The AWS Region. TODO: This should be passed as a pulumi.Provider
	Region string `pulumi:"region"`
	// The display name for the new user.
	DisplayName string `pulumi:"displayName"`
	// The name for the new user. WorkMail directory user names have a maximum length
	// of 64. All others have a maximum length of 20.
	Name string `pulumi:"name"`
	// The identifier of the organization for which the user is created. Either
	// organizationId or domain must be specified. When both are specified, organizationId
	// is ignored.
	OrganizationId *string `pulumi:"organizationId,optional"`
	// The mail domain of the organization for which the user is created. Either
	// organizationId or domain must be specified. When both are specified, organizationId
	// is ignored.
	Domain *string `pulumi:"domain,optional"`
	// The first name of the new user.
	FirstName *string `pulumi:"firstName,optional"`
	// If this parameter is enabled, the user will be hidden from the address book.
	HiddenFromGlobalAddressList *bool `pulumi:"hiddenFromGlobalAddressList,optional"`
	// The last name of the new user.
	LastName *string `pulumi:"lastName,optional"`
	// The password for the new user.
	Password *string `pulumi:"password,optional"`
}

Each resource has an input struct, defining what arguments it accepts.

type UserState 

type UserState struct {
	// It is generally a good idea to embed args in outputs, but it isn't strictly necessary.
	UserArgs

	// The user id.
	UserId string `pulumi:"userId"`
	// The organization id.
	OrganizationId string `pulumi:"organizationId"`
}

Each resource has a state, describing the fields that exist on the created resource.

type WorkmailRegistration 

type WorkmailRegistration struct{}

Each resource has a controlling struct. Resource behavior is determined by implementing methods on the controlling struct. The `Create` method is mandatory, but other methods are optional. - Check: Remap inputs before they are typed. - Diff: Change how instances of a resource are compared. - Update: Mutate a resource in place. - Read: Get the state of a resource from the backing provider. - Delete: Custom logic when the resource is deleted. - Annotate: Describe fields and set defaults for a resource. - WireDependencies: Control how outputs and secrets flows through values.

func (WorkmailRegistration) Create 

func (WorkmailRegistration) Create(ctx p.Context, name string, input WorkmailRegistrationArgs, preview bool) (string, WorkmailRegistrationState, error)

All resources must implement Create at a minimum.

func (WorkmailRegistration) Delete 

func (WorkmailRegistration) Delete(ctx p.Context, id string, props WorkmailRegistrationState) error

The Delete method will run when the resource is deleted.

type WorkmailRegistrationArgs 

type WorkmailRegistrationArgs struct {
	// The AWS Region. TODO: This should be passed as a pulumi.Provider
	Region string `pulumi:"region"`
	// The organization id.
	OrganizationId string `pulumi:"organizationId"`
	// The identifier for the user, group, or resource to be updated.
	// The identifier can accept UserId, ResourceId, or GroupId, or Username, Resourcename, or Groupname. The following identity formats are available:
	// Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234
	// Entity name: entity
	// This member is required.
	EntityId string `pulumi:"entityId"`
	// The email prefix for the new user. (prefix@domain.com).
	// The default domain of the organization will be appended automatically.
	EmailPrefix string `pulumi:"emailPrefix"`
}

Each resource has an input struct, defining what arguments it accepts.

type WorkmailRegistrationState 

type WorkmailRegistrationState struct {
	// It is generally a good idea to embed args in outputs, but it isn't strictly necessary.
	WorkmailRegistrationArgs
}

Each resource has a state, describing the fields that exist on the created resource.

Source Files

View all Source files

Directories

Path Synopsis
cmd
pulumi-resource-awsworkmail

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.