azurerm_cosmosdb_mongo_collection

package
v0.0.0-...-4deecce Latest Latest
Warning

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

 Go to latest Published: Apr 16, 2024 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Args 

type Args struct {
	// AccountName: string, required
	AccountName terra.StringValue `hcl:"account_name,attr" validate:"required"`
	// AnalyticalStorageTtl: number, optional
	AnalyticalStorageTtl terra.NumberValue `hcl:"analytical_storage_ttl,attr"`
	// DatabaseName: string, required
	DatabaseName terra.StringValue `hcl:"database_name,attr" validate:"required"`
	// DefaultTtlSeconds: number, optional
	DefaultTtlSeconds terra.NumberValue `hcl:"default_ttl_seconds,attr"`
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// Name: string, required
	Name terra.StringValue `hcl:"name,attr" validate:"required"`
	// ResourceGroupName: string, required
	ResourceGroupName terra.StringValue `hcl:"resource_group_name,attr" validate:"required"`
	// ShardKey: string, optional
	ShardKey terra.StringValue `hcl:"shard_key,attr"`
	// Throughput: number, optional
	Throughput terra.NumberValue `hcl:"throughput,attr"`
	// AutoscaleSettings: optional
	AutoscaleSettings *AutoscaleSettings `hcl:"autoscale_settings,block"`
	// Index: min=0
	Index []Index `hcl:"index,block" validate:"min=0"`
	// Timeouts: optional
	Timeouts *Timeouts `hcl:"timeouts,block"`
}

Args contains the configurations for azurerm_cosmosdb_mongo_collection.

type AutoscaleSettings 

type AutoscaleSettings struct {
	// MaxThroughput: number, optional
	MaxThroughput terra.NumberValue `hcl:"max_throughput,attr"`
}

type AutoscaleSettingsAttributes 

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

func (AutoscaleSettingsAttributes) InternalRef 

func (as AutoscaleSettingsAttributes) InternalRef() (terra.Reference, error)

func (AutoscaleSettingsAttributes) InternalTokens 

func (as AutoscaleSettingsAttributes) InternalTokens() (hclwrite.Tokens, error)

func (AutoscaleSettingsAttributes) InternalWithRef 

func (as AutoscaleSettingsAttributes) InternalWithRef(ref terra.Reference) AutoscaleSettingsAttributes

func (AutoscaleSettingsAttributes) MaxThroughput 

func (as AutoscaleSettingsAttributes) MaxThroughput() terra.NumberValue

type AutoscaleSettingsState 

type AutoscaleSettingsState struct {
	MaxThroughput float64 `json:"max_throughput"`
}

type Index 

type Index struct {
	// Keys: list of string, required
	Keys terra.ListValue[terra.StringValue] `hcl:"keys,attr" validate:"required"`
	// Unique: bool, optional
	Unique terra.BoolValue `hcl:"unique,attr"`
}

type IndexAttributes 

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

func (IndexAttributes) InternalRef 

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

func (IndexAttributes) InternalTokens 

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

func (IndexAttributes) InternalWithRef 

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

func (IndexAttributes) Keys 

func (i IndexAttributes) Keys() terra.ListValue[terra.StringValue]

func (IndexAttributes) Unique 

func (i IndexAttributes) Unique() terra.BoolValue

type IndexState 

type IndexState struct {
	Keys   []string `json:"keys"`
	Unique bool     `json:"unique"`
}

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

func New 

func New(name string, args Args) *Resource

New creates a new instance of Resource.

func (*Resource) Attributes 

func (acmc *Resource) Attributes() azurermCosmosdbMongoCollectionAttributes

Attributes returns the attributes for Resource.

func (*Resource) Configuration 

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

Configuration returns the configuration (args) for Resource.

func (*Resource) DependOn 

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

DependOn is used for other resources to depend on Resource.

func (*Resource) Dependencies 

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

Dependencies returns the list of resources Resource depends_on.

func (*Resource) ImportState 

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

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

func (*Resource) LifecycleManagement 

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

LifecycleManagement returns the lifecycle block for Resource.

func (*Resource) LocalName 

func (acmc *Resource) LocalName() string

LocalName returns the local name for Resource.

func (*Resource) State 

func (acmc *Resource) State() (*azurermCosmosdbMongoCollectionState, bool)

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

func (*Resource) StateMust 

func (acmc *Resource) StateMust() *azurermCosmosdbMongoCollectionState

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

func (*Resource) Type 

func (acmc *Resource) Type() string

Type returns the Terraform object type for Resource.

type SystemIndexesAttributes 

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

func (SystemIndexesAttributes) InternalRef 

func (si SystemIndexesAttributes) InternalRef() (terra.Reference, error)

func (SystemIndexesAttributes) InternalTokens 

func (si SystemIndexesAttributes) InternalTokens() (hclwrite.Tokens, error)

func (SystemIndexesAttributes) InternalWithRef 

func (si SystemIndexesAttributes) InternalWithRef(ref terra.Reference) SystemIndexesAttributes

func (SystemIndexesAttributes) Keys 

func (si SystemIndexesAttributes) Keys() terra.ListValue[terra.StringValue]

func (SystemIndexesAttributes) Unique 

func (si SystemIndexesAttributes) Unique() terra.BoolValue

type SystemIndexesState 

type SystemIndexesState struct {
	Keys   []string `json:"keys"`
	Unique bool     `json:"unique"`
}

type Timeouts 

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

type TimeoutsAttributes 

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

func (TimeoutsAttributes) Create 

func (t TimeoutsAttributes) Create() terra.StringValue

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) Read 

func (t TimeoutsAttributes) Read() terra.StringValue

func (TimeoutsAttributes) Update 

func (t TimeoutsAttributes) Update() terra.StringValue

type TimeoutsState 

type TimeoutsState struct {
	Create string `json:"create"`
	Delete string `json:"delete"`
	Read   string `json:"read"`
	Update string `json:"update"`
}

Source Files

View all Source files

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.