azurerm_virtual_hub

Documentation

Index

• type Args
• type DataArgs
• type DataSource
  • func Data(name string, args DataArgs) *DataSource
  • func (avh *DataSource) Attributes() dataAzurermVirtualHubAttributes
  • func (avh *DataSource) Configuration() interface{}
  • func (avh *DataSource) DataSource() string
  • func (avh *DataSource) LocalName() string
• type DataTimeouts
• type DataTimeoutsAttributes
  • func (t DataTimeoutsAttributes) InternalRef() (terra.Reference, error)
  • func (t DataTimeoutsAttributes) InternalTokens() (hclwrite.Tokens, error)
  • func (t DataTimeoutsAttributes) InternalWithRef(ref terra.Reference) DataTimeoutsAttributes
  • func (t DataTimeoutsAttributes) Read() terra.StringValue
• type DataTimeoutsState
• type Resource
  • func New(name string, args Args) *Resource
  • func (avh *Resource) Attributes() azurermVirtualHubAttributes
  • func (avh *Resource) Configuration() interface{}
  • func (avh *Resource) DependOn() terra.Reference
  • func (avh *Resource) Dependencies() terra.Dependencies
  • func (avh *Resource) ImportState(state io.Reader) error
  • func (avh *Resource) LifecycleManagement() *terra.Lifecycle
  • func (avh *Resource) LocalName() string
  • func (avh *Resource) State() (*azurermVirtualHubState, bool)
  • func (avh *Resource) StateMust() *azurermVirtualHubState
  • func (avh *Resource) Type() string
• type Route
• type RouteAttributes
  • func (r RouteAttributes) AddressPrefixes() terra.ListValue[terra.StringValue]
  • func (r RouteAttributes) InternalRef() (terra.Reference, error)
  • func (r RouteAttributes) InternalTokens() (hclwrite.Tokens, error)
  • func (r RouteAttributes) InternalWithRef(ref terra.Reference) RouteAttributes
  • func (r RouteAttributes) NextHopIpAddress() terra.StringValue
• type RouteState
• type Timeouts
• type TimeoutsAttributes
  • func (t TimeoutsAttributes) Create() terra.StringValue
  • 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) Read() terra.StringValue
  • func (t TimeoutsAttributes) Update() terra.StringValue
• type TimeoutsState

Types

type Args

type Args struct {
	// AddressPrefix: string, optional
	AddressPrefix terra.StringValue `hcl:"address_prefix,attr"`
	// HubRoutingPreference: string, optional
	HubRoutingPreference terra.StringValue `hcl:"hub_routing_preference,attr"`
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// Location: string, required
	Location terra.StringValue `hcl:"location,attr" validate:"required"`
	// Name: string, required
	Name terra.StringValue `hcl:"name,attr" validate:"required"`
	// ResourceGroupName: string, required
	ResourceGroupName terra.StringValue `hcl:"resource_group_name,attr" validate:"required"`
	// Sku: string, optional
	Sku terra.StringValue `hcl:"sku,attr"`
	// Tags: map of string, optional
	Tags terra.MapValue[terra.StringValue] `hcl:"tags,attr"`
	// VirtualRouterAutoScaleMinCapacity: number, optional
	VirtualRouterAutoScaleMinCapacity terra.NumberValue `hcl:"virtual_router_auto_scale_min_capacity,attr"`
	// VirtualWanId: string, optional
	VirtualWanId terra.StringValue `hcl:"virtual_wan_id,attr"`
	// Route: min=0
	Route []Route `hcl:"route,block" validate:"min=0"`
	// Timeouts: optional
	Timeouts *Timeouts `hcl:"timeouts,block"`
}

Args contains the configurations for azurerm_virtual_hub.

type DataArgs

type DataArgs struct {
	// 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"`
	// Timeouts: optional
	Timeouts *DataTimeouts `hcl:"timeouts,block"`
}

DataArgs contains the configurations for azurerm_virtual_hub.

type DataSource

type DataSource struct {
	Name string
	Args DataArgs
}

DataSource represents the Terraform data resource azurerm_virtual_hub.

func Data

func Data(name string, args DataArgs) *DataSource

Data creates a new instance of DataSource.

func (*DataSource) Attributes

func (avh *DataSource) Attributes() dataAzurermVirtualHubAttributes

Attributes returns the attributes for DataSource.

func (*DataSource) Configuration

func (avh *DataSource) Configuration() interface{}

Configuration returns the configuration (args) for DataSource.

func (*DataSource) DataSource

func (avh *DataSource) DataSource() string

DataSource returns the Terraform object type for DataSource.

func (*DataSource) LocalName

func (avh *DataSource) LocalName() string

LocalName returns the local name for DataSource.

type DataTimeouts

type DataTimeouts struct {
	// Read: string, optional
	Read terra.StringValue `hcl:"read,attr"`
}

type DataTimeoutsAttributes

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

func (DataTimeoutsAttributes) InternalRef

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

func (DataTimeoutsAttributes) InternalTokens

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

func (DataTimeoutsAttributes) InternalWithRef

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

func (DataTimeoutsAttributes) Read

func (t DataTimeoutsAttributes) Read() terra.StringValue

type DataTimeoutsState

type DataTimeoutsState struct {
	Read string `json:"read"`
}

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

func New

func New(name string, args Args) *Resource

New creates a new instance of Resource.

func (*Resource) Attributes

func (avh *Resource) Attributes() azurermVirtualHubAttributes

Attributes returns the attributes for Resource.

func (*Resource) Configuration

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

Configuration returns the configuration (args) for Resource.

func (*Resource) DependOn

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

DependOn is used for other resources to depend on Resource.

func (*Resource) Dependencies

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

Dependencies returns the list of resources Resource depends_on.

func (*Resource) ImportState

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

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

func (*Resource) LifecycleManagement

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

LifecycleManagement returns the lifecycle block for Resource.

func (*Resource) LocalName

func (avh *Resource) LocalName() string

LocalName returns the local name for Resource.

func (*Resource) State

func (avh *Resource) State() (*azurermVirtualHubState, bool)

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

func (*Resource) StateMust

func (avh *Resource) StateMust() *azurermVirtualHubState

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

func (*Resource) Type

func (avh *Resource) Type() string

Type returns the Terraform object type for Resource.

type Route

type Route struct {
	// AddressPrefixes: list of string, required
	AddressPrefixes terra.ListValue[terra.StringValue] `hcl:"address_prefixes,attr" validate:"required"`
	// NextHopIpAddress: string, required
	NextHopIpAddress terra.StringValue `hcl:"next_hop_ip_address,attr" validate:"required"`
}

type RouteAttributes

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

func (RouteAttributes) AddressPrefixes

func (r RouteAttributes) AddressPrefixes() terra.ListValue[terra.StringValue]

func (RouteAttributes) InternalRef

func (r RouteAttributes) InternalRef() (terra.Reference, error)

func (RouteAttributes) InternalTokens

func (r RouteAttributes) InternalTokens() (hclwrite.Tokens, error)

func (RouteAttributes) InternalWithRef

func (r RouteAttributes) InternalWithRef(ref terra.Reference) RouteAttributes

func (RouteAttributes) NextHopIpAddress

func (r RouteAttributes) NextHopIpAddress() terra.StringValue

type RouteState

type RouteState struct {
	AddressPrefixes  []string `json:"address_prefixes"`
	NextHopIpAddress string   `json:"next_hop_ip_address"`
}

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"`
}