aws_opensearch_domain_saml_options

Documentation

Index

• type Args
• type Resource
  • func New(name string, args Args) *Resource
  • func (aodso *Resource) Attributes() awsOpensearchDomainSamlOptionsAttributes
  • func (aodso *Resource) Configuration() interface{}
  • func (aodso *Resource) DependOn() terra.Reference
  • func (aodso *Resource) Dependencies() terra.Dependencies
  • func (aodso *Resource) ImportState(state io.Reader) error
  • func (aodso *Resource) LifecycleManagement() *terra.Lifecycle
  • func (aodso *Resource) LocalName() string
  • func (aodso *Resource) State() (*awsOpensearchDomainSamlOptionsState, bool)
  • func (aodso *Resource) StateMust() *awsOpensearchDomainSamlOptionsState
  • func (aodso *Resource) Type() string
• type SamlOptions
• type SamlOptionsAttributes
  • func (so SamlOptionsAttributes) Enabled() terra.BoolValue
  • func (so SamlOptionsAttributes) Idp() terra.ListValue[SamlOptionsIdpAttributes]
  • func (so SamlOptionsAttributes) InternalRef() (terra.Reference, error)
  • func (so SamlOptionsAttributes) InternalTokens() (hclwrite.Tokens, error)
  • func (so SamlOptionsAttributes) InternalWithRef(ref terra.Reference) SamlOptionsAttributes
  • func (so SamlOptionsAttributes) MasterBackendRole() terra.StringValue
  • func (so SamlOptionsAttributes) MasterUserName() terra.StringValue
  • func (so SamlOptionsAttributes) RolesKey() terra.StringValue
  • func (so SamlOptionsAttributes) SessionTimeoutMinutes() terra.NumberValue
  • func (so SamlOptionsAttributes) SubjectKey() terra.StringValue
• type SamlOptionsIdp
• type SamlOptionsIdpAttributes
  • func (i SamlOptionsIdpAttributes) EntityId() terra.StringValue
  • func (i SamlOptionsIdpAttributes) InternalRef() (terra.Reference, error)
  • func (i SamlOptionsIdpAttributes) InternalTokens() (hclwrite.Tokens, error)
  • func (i SamlOptionsIdpAttributes) InternalWithRef(ref terra.Reference) SamlOptionsIdpAttributes
  • func (i SamlOptionsIdpAttributes) MetadataContent() terra.StringValue
• type SamlOptionsIdpState
• type SamlOptionsState
• type Timeouts
• type TimeoutsAttributes
  • func (t TimeoutsAttributes) Delete() terra.StringValue
  • func (t TimeoutsAttributes) InternalRef() (terra.Reference, error)
  • func (t TimeoutsAttributes) InternalTokens() (hclwrite.Tokens, error)
  • func (t TimeoutsAttributes) InternalWithRef(ref terra.Reference) TimeoutsAttributes
  • func (t TimeoutsAttributes) Update() terra.StringValue
• type TimeoutsState

Types

type Args

type Args struct {
	// DomainName: string, required
	DomainName terra.StringValue `hcl:"domain_name,attr" validate:"required"`
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// SamlOptions: optional
	SamlOptions *SamlOptions `hcl:"saml_options,block"`
	// Timeouts: optional
	Timeouts *Timeouts `hcl:"timeouts,block"`
}

Args contains the configurations for aws_opensearch_domain_saml_options.

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_opensearch_domain_saml_options.

func New

func New(name string, args Args) *Resource

New creates a new instance of Resource.

func (*Resource) Attributes

func (aodso *Resource) Attributes() awsOpensearchDomainSamlOptionsAttributes

Attributes returns the attributes for Resource.

func (*Resource) Configuration

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

Configuration returns the configuration (args) for Resource.

func (*Resource) DependOn

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

DependOn is used for other resources to depend on Resource.

func (*Resource) Dependencies

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

Dependencies returns the list of resources Resource depends_on.

func (*Resource) ImportState

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

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

func (*Resource) LifecycleManagement

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

LifecycleManagement returns the lifecycle block for Resource.

func (*Resource) LocalName

func (aodso *Resource) LocalName() string

LocalName returns the local name for Resource.

func (*Resource) State

func (aodso *Resource) State() (*awsOpensearchDomainSamlOptionsState, bool)

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

func (*Resource) StateMust

func (aodso *Resource) StateMust() *awsOpensearchDomainSamlOptionsState

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

func (*Resource) Type

func (aodso *Resource) Type() string

Type returns the Terraform object type for Resource.

type SamlOptions

type SamlOptions struct {
	// Enabled: bool, optional
	Enabled terra.BoolValue `hcl:"enabled,attr"`
	// MasterBackendRole: string, optional
	MasterBackendRole terra.StringValue `hcl:"master_backend_role,attr"`
	// MasterUserName: string, optional
	MasterUserName terra.StringValue `hcl:"master_user_name,attr"`
	// RolesKey: string, optional
	RolesKey terra.StringValue `hcl:"roles_key,attr"`
	// SessionTimeoutMinutes: number, optional
	SessionTimeoutMinutes terra.NumberValue `hcl:"session_timeout_minutes,attr"`
	// SubjectKey: string, optional
	SubjectKey terra.StringValue `hcl:"subject_key,attr"`
	// SamlOptionsIdp: optional
	Idp *SamlOptionsIdp `hcl:"idp,block"`
}

type SamlOptionsAttributes

type SamlOptionsAttributes struct {
	// contains filtered or unexported fields
}

func (SamlOptionsAttributes) Enabled

func (so SamlOptionsAttributes) Enabled() terra.BoolValue

func (SamlOptionsAttributes) Idp

func (so SamlOptionsAttributes) Idp() terra.ListValue[SamlOptionsIdpAttributes]

func (SamlOptionsAttributes) InternalRef

func (so SamlOptionsAttributes) InternalRef() (terra.Reference, error)

func (SamlOptionsAttributes) InternalTokens

func (so SamlOptionsAttributes) InternalTokens() (hclwrite.Tokens, error)

func (SamlOptionsAttributes) InternalWithRef

func (so SamlOptionsAttributes) InternalWithRef(ref terra.Reference) SamlOptionsAttributes

func (SamlOptionsAttributes) MasterBackendRole

func (so SamlOptionsAttributes) MasterBackendRole() terra.StringValue

func (SamlOptionsAttributes) MasterUserName

func (so SamlOptionsAttributes) MasterUserName() terra.StringValue

func (SamlOptionsAttributes) RolesKey

func (so SamlOptionsAttributes) RolesKey() terra.StringValue

func (SamlOptionsAttributes) SessionTimeoutMinutes

func (so SamlOptionsAttributes) SessionTimeoutMinutes() terra.NumberValue

func (SamlOptionsAttributes) SubjectKey

func (so SamlOptionsAttributes) SubjectKey() terra.StringValue

type SamlOptionsIdp

type SamlOptionsIdp struct {
	// EntityId: string, required
	EntityId terra.StringValue `hcl:"entity_id,attr" validate:"required"`
	// MetadataContent: string, required
	MetadataContent terra.StringValue `hcl:"metadata_content,attr" validate:"required"`
}

type SamlOptionsIdpAttributes

type SamlOptionsIdpAttributes struct {
	// contains filtered or unexported fields
}

func (SamlOptionsIdpAttributes) EntityId

func (i SamlOptionsIdpAttributes) EntityId() terra.StringValue

func (SamlOptionsIdpAttributes) InternalRef

func (i SamlOptionsIdpAttributes) InternalRef() (terra.Reference, error)

func (SamlOptionsIdpAttributes) InternalTokens

func (i SamlOptionsIdpAttributes) InternalTokens() (hclwrite.Tokens, error)

func (SamlOptionsIdpAttributes) InternalWithRef

func (i SamlOptionsIdpAttributes) InternalWithRef(ref terra.Reference) SamlOptionsIdpAttributes

func (SamlOptionsIdpAttributes) MetadataContent

func (i SamlOptionsIdpAttributes) MetadataContent() terra.StringValue

type SamlOptionsIdpState

type SamlOptionsIdpState struct {
	EntityId        string `json:"entity_id"`
	MetadataContent string `json:"metadata_content"`
}

type SamlOptionsState

type SamlOptionsState struct {
	Enabled               bool                  `json:"enabled"`
	MasterBackendRole     string                `json:"master_backend_role"`
	MasterUserName        string                `json:"master_user_name"`
	RolesKey              string                `json:"roles_key"`
	SessionTimeoutMinutes float64               `json:"session_timeout_minutes"`
	SubjectKey            string                `json:"subject_key"`
	Idp                   []SamlOptionsIdpState `json:"idp"`
}

type Timeouts

type Timeouts struct {
	// Delete: string, optional
	Delete terra.StringValue `hcl:"delete,attr"`
	// Update: string, optional
	Update terra.StringValue `hcl:"update,attr"`
}

type TimeoutsAttributes

type TimeoutsAttributes struct {
	// contains filtered or unexported fields
}

func (TimeoutsAttributes) Delete

func (t TimeoutsAttributes) Delete() terra.StringValue

func (TimeoutsAttributes) InternalRef

func (t TimeoutsAttributes) InternalRef() (terra.Reference, error)

func (TimeoutsAttributes) InternalTokens

func (t TimeoutsAttributes) InternalTokens() (hclwrite.Tokens, error)

func (TimeoutsAttributes) InternalWithRef

func (t TimeoutsAttributes) InternalWithRef(ref terra.Reference) TimeoutsAttributes

func (TimeoutsAttributes) Update

func (t TimeoutsAttributes) Update() terra.StringValue

type TimeoutsState

type TimeoutsState struct {
	Delete string `json:"delete"`
	Update string `json:"update"`
}