oci

Documentation

Overview

Package oci implements a steampipe plugin for OCI.

This plugin provides data that Steampipe uses to present foreign tables that represent Oracle Cloud Infrastructure resources.

Index

• Constants
• Variables
• func BuildCompartementRegionList(ctx context.Context, connection *plugin.Connection) []map[string]interface{}
• func BuildCompartementZonalList(ctx context.Context, connection *plugin.Connection) []map[string]interface{}
• func BuildCompartmentList(ctx context.Context, connection *plugin.Connection) []map[string]interface{}
• func BuildRegionList(_ context.Context, connection *plugin.Connection) []map[string]interface{}
• func ConfigInstance() interface{}
• func GetConfig(connection *plugin.Connection) ociConfig
• func Plugin(ctx context.Context) *plugin.Plugin
• type KeyInfo
• type KeyVersionInfo

Constants

const (
	// Constants for Standard Column Descriptions
	ColumnDescriptionAkas        = "Array of globally unique identifier strings (also known as) for the resource."
	ColumnDescriptionTags        = "A map of tags for the resource."
	ColumnDescriptionTitle       = "Title of the resource."
	ColumnDescriptionTenant      = "The OCID of the Tenant in which the resource is located."
	ColumnDescriptionCompartment = "The OCID of the compartment in Tenant in which the resource is located."
	ColumnDescriptionRegion      = "The OCI region in which the resource is located."

	// Other repetitive columns for the provider
	ColumnDescriptionFreefromTags = "Free-form tags for resource. This tags can be applied by any user with permissions on the resource."
	ColumnDescriptionDefinedTags  = "" /* 176-byte string literal not displayed */
	ColumnDescriptionSystemTags   = "System tags for resource. System tags can be viewed by users, but can only be created by the system."
)

Variables

var ConfigSchema = map[string]*schema.Attribute{
	"regions": {
		Type: schema.TypeList,
		Elem: &schema.Attribute{Type: schema.TypeString},
	},
	"auth": {
		Type: schema.TypeString,
	},
	"tenancy_ocid": {
		Type: schema.TypeString,
	},
	"config_file_profile": {
		Type: schema.TypeString,
	},
	"config_path": {
		Type: schema.TypeString,
	},
	"user_ocid": {
		Type: schema.TypeString,
	},
	"fingerprint": {
		Type: schema.TypeString,
	},
	"private_key": {
		Type: schema.TypeString,
	},
	"private_key_path": {
		Type: schema.TypeString,
	},
	"private_key_password": {
		Type: schema.TypeString,
	},
}

Functions

func BuildCompartementRegionList

func BuildCompartementRegionList(ctx context.Context, connection *plugin.Connection) []map[string]interface{}

BuildCompartementRegionList :: return a list of matrix items, one per region-compartment specified in the connection config

func BuildCompartementZonalList

func BuildCompartementZonalList(ctx context.Context, connection *plugin.Connection) []map[string]interface{}

BuildCompartementZonalList :: return a list of matrix items, one per zone-compartment specified in the connection config

func BuildCompartmentList

func BuildCompartmentList(ctx context.Context, connection *plugin.Connection) []map[string]interface{}

BuildCompartmentList :: return a list of matrix items, one per compartment specified in the connection config

func BuildRegionList

func BuildRegionList(_ context.Context, connection *plugin.Connection) []map[string]interface{}

BuildRegionList :: return a list of matrix items, one per region specified in the connection config

func ConfigInstance

func ConfigInstance() interface{}

func GetConfig

func GetConfig(connection *plugin.Connection) ociConfig

GetConfig :: retrieve and cast connection config from query data

func Plugin

func Plugin(ctx context.Context) *plugin.Plugin

Plugin creates this (oci) plugin

Types

type KeyInfo

type KeyInfo struct {
	keymanagement.KeySummary
	ManagementEndpoint string
	VaultName          string
}

type KeyVersionInfo

type KeyVersionInfo struct {
	keymanagement.KeyVersionSummary
	ManagementEndpoint string
	Region             string
}