aws_cognito_user

Documentation

Index

• type Args
• type Resource
  • func New(name string, args Args) *Resource
  • func (acu *Resource) Attributes() awsCognitoUserAttributes
  • func (acu *Resource) Configuration() interface{}
  • func (acu *Resource) DependOn() terra.Reference
  • func (acu *Resource) Dependencies() terra.Dependencies
  • func (acu *Resource) ImportState(state io.Reader) error
  • func (acu *Resource) LifecycleManagement() *terra.Lifecycle
  • func (acu *Resource) LocalName() string
  • func (acu *Resource) State() (*awsCognitoUserState, bool)
  • func (acu *Resource) StateMust() *awsCognitoUserState
  • func (acu *Resource) Type() string

Types

type Args

type Args struct {
	// Attributes: map of string, optional
	Attributes terra.MapValue[terra.StringValue] `hcl:"attributes,attr"`
	// ClientMetadata: map of string, optional
	ClientMetadata terra.MapValue[terra.StringValue] `hcl:"client_metadata,attr"`
	// DesiredDeliveryMediums: set of string, optional
	DesiredDeliveryMediums terra.SetValue[terra.StringValue] `hcl:"desired_delivery_mediums,attr"`
	// Enabled: bool, optional
	Enabled terra.BoolValue `hcl:"enabled,attr"`
	// ForceAliasCreation: bool, optional
	ForceAliasCreation terra.BoolValue `hcl:"force_alias_creation,attr"`
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// MessageAction: string, optional
	MessageAction terra.StringValue `hcl:"message_action,attr"`
	// Password: string, optional
	Password terra.StringValue `hcl:"password,attr"`
	// TemporaryPassword: string, optional
	TemporaryPassword terra.StringValue `hcl:"temporary_password,attr"`
	// UserPoolId: string, required
	UserPoolId terra.StringValue `hcl:"user_pool_id,attr" validate:"required"`
	// Username: string, required
	Username terra.StringValue `hcl:"username,attr" validate:"required"`
	// ValidationData: map of string, optional
	ValidationData terra.MapValue[terra.StringValue] `hcl:"validation_data,attr"`
}

Args contains the configurations for aws_cognito_user.

type Resource

type Resource struct {
	Name string
	Args Args

	DependsOn terra.Dependencies
	Lifecycle *terra.Lifecycle
	// contains filtered or unexported fields
}

Resource represents the Terraform resource aws_cognito_user.

func New

func New(name string, args Args) *Resource

New creates a new instance of Resource.

func (*Resource) Attributes

func (acu *Resource) Attributes() awsCognitoUserAttributes

Attributes returns the attributes for Resource.

func (*Resource) Configuration

func (acu *Resource) Configuration() interface{}

Configuration returns the configuration (args) for Resource.

func (*Resource) DependOn

func (acu *Resource) DependOn() terra.Reference

DependOn is used for other resources to depend on Resource.

func (*Resource) Dependencies

func (acu *Resource) Dependencies() terra.Dependencies

Dependencies returns the list of resources Resource depends_on.

func (*Resource) ImportState

func (acu *Resource) ImportState(state io.Reader) error

ImportState imports the given attribute values into Resource's state.

func (*Resource) LifecycleManagement

func (acu *Resource) LifecycleManagement() *terra.Lifecycle

LifecycleManagement returns the lifecycle block for Resource.

func (*Resource) LocalName

func (acu *Resource) LocalName() string

LocalName returns the local name for Resource.

func (*Resource) State

func (acu *Resource) State() (*awsCognitoUserState, bool)

State returns the state and a bool indicating if Resource has state.

func (*Resource) StateMust

func (acu *Resource) StateMust() *awsCognitoUserState

StateMust returns the state for Resource. Panics if the state is nil.

func (*Resource) Type

func (acu *Resource) Type() string

Type returns the Terraform object type for Resource.