aws_docdb_cluster_parameter_group

Documentation

Index

• type Args
• type Parameter
• type ParameterAttributes
  • func (p ParameterAttributes) ApplyMethod() terra.StringValue
  • func (p ParameterAttributes) InternalRef() (terra.Reference, error)
  • func (p ParameterAttributes) InternalTokens() (hclwrite.Tokens, error)
  • func (p ParameterAttributes) InternalWithRef(ref terra.Reference) ParameterAttributes
  • func (p ParameterAttributes) Name() terra.StringValue
  • func (p ParameterAttributes) Value() terra.StringValue
• type ParameterState
• type Resource
  • func New(name string, args Args) *Resource
  • func (adcpg *Resource) Attributes() awsDocdbClusterParameterGroupAttributes
  • func (adcpg *Resource) Configuration() interface{}
  • func (adcpg *Resource) DependOn() terra.Reference
  • func (adcpg *Resource) Dependencies() terra.Dependencies
  • func (adcpg *Resource) ImportState(state io.Reader) error
  • func (adcpg *Resource) LifecycleManagement() *terra.Lifecycle
  • func (adcpg *Resource) LocalName() string
  • func (adcpg *Resource) State() (*awsDocdbClusterParameterGroupState, bool)
  • func (adcpg *Resource) StateMust() *awsDocdbClusterParameterGroupState
  • func (adcpg *Resource) Type() string

Types

type Args

type Args struct {
	// Description: string, optional
	Description terra.StringValue `hcl:"description,attr"`
	// Family: string, required
	Family terra.StringValue `hcl:"family,attr" validate:"required"`
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// Name: string, optional
	Name terra.StringValue `hcl:"name,attr"`
	// NamePrefix: string, optional
	NamePrefix terra.StringValue `hcl:"name_prefix,attr"`
	// Tags: map of string, optional
	Tags terra.MapValue[terra.StringValue] `hcl:"tags,attr"`
	// TagsAll: map of string, optional
	TagsAll terra.MapValue[terra.StringValue] `hcl:"tags_all,attr"`
	// Parameter: min=0
	Parameter []Parameter `hcl:"parameter,block" validate:"min=0"`
}

Args contains the configurations for aws_docdb_cluster_parameter_group.

type Parameter

type Parameter struct {
	// ApplyMethod: string, optional
	ApplyMethod terra.StringValue `hcl:"apply_method,attr"`
	// Name: string, required
	Name terra.StringValue `hcl:"name,attr" validate:"required"`
	// Value: string, required
	Value terra.StringValue `hcl:"value,attr" validate:"required"`
}

type ParameterAttributes

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

func (ParameterAttributes) ApplyMethod

func (p ParameterAttributes) ApplyMethod() terra.StringValue

func (ParameterAttributes) InternalRef

func (p ParameterAttributes) InternalRef() (terra.Reference, error)

func (ParameterAttributes) InternalTokens

func (p ParameterAttributes) InternalTokens() (hclwrite.Tokens, error)

func (ParameterAttributes) InternalWithRef

func (p ParameterAttributes) InternalWithRef(ref terra.Reference) ParameterAttributes

func (ParameterAttributes) Name

func (p ParameterAttributes) Name() terra.StringValue

func (ParameterAttributes) Value

func (p ParameterAttributes) Value() terra.StringValue

type ParameterState

type ParameterState struct {
	ApplyMethod string `json:"apply_method"`
	Name        string `json:"name"`
	Value       string `json:"value"`
}

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

func New

func New(name string, args Args) *Resource

New creates a new instance of Resource.

func (*Resource) Attributes

func (adcpg *Resource) Attributes() awsDocdbClusterParameterGroupAttributes

Attributes returns the attributes for Resource.

func (*Resource) Configuration

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

Configuration returns the configuration (args) for Resource.

func (*Resource) DependOn

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

DependOn is used for other resources to depend on Resource.

func (*Resource) Dependencies

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

Dependencies returns the list of resources Resource depends_on.

func (*Resource) ImportState

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

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

func (*Resource) LifecycleManagement

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

LifecycleManagement returns the lifecycle block for Resource.

func (*Resource) LocalName

func (adcpg *Resource) LocalName() string

LocalName returns the local name for Resource.

func (*Resource) State

func (adcpg *Resource) State() (*awsDocdbClusterParameterGroupState, bool)

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

func (*Resource) StateMust

func (adcpg *Resource) StateMust() *awsDocdbClusterParameterGroupState

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

func (*Resource) Type

func (adcpg *Resource) Type() string

Type returns the Terraform object type for Resource.