oci

Documentation

Overview

A Pulumi package for creating and managing Oracle Cloud Infrastructure resources.

Index

• type Provider
  • func NewProvider(ctx *pulumi.Context, name string, args *ProviderArgs, ...) (*Provider, error)
  • func (*Provider) ElementType() reflect.Type
  • func (i *Provider) ToProviderOutput() ProviderOutput
  • func (i *Provider) ToProviderOutputWithContext(ctx context.Context) ProviderOutput
• type ProviderArgs
  • func (ProviderArgs) ElementType() reflect.Type
• type ProviderInput
• type ProviderOutput
  • func (o ProviderOutput) Auth() pulumi.StringPtrOutput
  • func (o ProviderOutput) ConfigFileProfile() pulumi.StringPtrOutput
  • func (ProviderOutput) ElementType() reflect.Type
  • func (o ProviderOutput) Fingerprint() pulumi.StringPtrOutput
  • func (o ProviderOutput) PrivateKey() pulumi.StringPtrOutput
  • func (o ProviderOutput) PrivateKeyPassword() pulumi.StringPtrOutput
  • func (o ProviderOutput) PrivateKeyPath() pulumi.StringPtrOutput
  • func (o ProviderOutput) Region() pulumi.StringPtrOutput
  • func (o ProviderOutput) TenancyOcid() pulumi.StringPtrOutput
  • func (o ProviderOutput) ToProviderOutput() ProviderOutput
  • func (o ProviderOutput) ToProviderOutputWithContext(ctx context.Context) ProviderOutput
  • func (o ProviderOutput) UserOcid() pulumi.StringPtrOutput

Types

type Provider

type Provider struct {
	pulumi.ProviderResourceState

	// (Optional) The type of auth to use. Options are 'ApiKey', 'SecurityToken', 'InstancePrincipal', 'ResourcePrincipal' and
	// 'OKEWorkloadIdentity'. By default, 'ApiKey' will be used.
	Auth pulumi.StringPtrOutput `pulumi:"auth"`
	// (Optional) The profile name to be used from config file, if not set it will be DEFAULT.
	ConfigFileProfile pulumi.StringPtrOutput `pulumi:"configFileProfile"`
	// (Optional) The fingerprint for the user's RSA key. This can be found in user settings in the Oracle Cloud Infrastructure
	// console. Required if auth is set to 'ApiKey', ignored otherwise.
	Fingerprint pulumi.StringPtrOutput `pulumi:"fingerprint"`
	// (Optional) A PEM formatted RSA private key for the user. A privateKey or a privateKeyPath must be provided if auth is
	// set to 'ApiKey', ignored otherwise.
	PrivateKey pulumi.StringPtrOutput `pulumi:"privateKey"`
	// (Optional) The password used to secure the private key.
	PrivateKeyPassword pulumi.StringPtrOutput `pulumi:"privateKeyPassword"`
	// (Optional) The path to the user's PEM formatted private key. A privateKey or a privateKeyPath must be provided if auth
	// is set to 'ApiKey', ignored otherwise.
	PrivateKeyPath pulumi.StringPtrOutput `pulumi:"privateKeyPath"`
	// (Required) The region for API connections (e.g. us-ashburn-1).
	Region pulumi.StringPtrOutput `pulumi:"region"`
	// (Optional) The tenancy OCID for a user. The tenancy OCID can be found at the bottom of user settings in the Oracle Cloud
	// Infrastructure console. Required if auth is set to 'ApiKey', ignored otherwise.
	TenancyOcid pulumi.StringPtrOutput `pulumi:"tenancyOcid"`
	// (Optional) The user OCID. This can be found in user settings in the Oracle Cloud Infrastructure console. Required if
	// auth is set to 'ApiKey', ignored otherwise.
	UserOcid pulumi.StringPtrOutput `pulumi:"userOcid"`
}

The provider type for the oci package. By default, resources use package-wide configuration settings, however an explicit `Provider` instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the [documentation](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.

func NewProvider

func NewProvider(ctx *pulumi.Context,
	name string, args *ProviderArgs, opts ...pulumi.ResourceOption) (*Provider, error)

NewProvider registers a new resource with the given unique name, arguments, and options.

func (*Provider) ElementType

func (*Provider) ElementType() reflect.Type

func (*Provider) ToProviderOutput

func (i *Provider) ToProviderOutput() ProviderOutput

func (*Provider) ToProviderOutputWithContext

func (i *Provider) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

type ProviderArgs

type ProviderArgs struct {
	// (Optional) The type of auth to use. Options are 'ApiKey', 'SecurityToken', 'InstancePrincipal', 'ResourcePrincipal' and
	// 'OKEWorkloadIdentity'. By default, 'ApiKey' will be used.
	Auth pulumi.StringPtrInput
	// (Optional) The profile name to be used from config file, if not set it will be DEFAULT.
	ConfigFileProfile pulumi.StringPtrInput
	// (Optional) Disable automatic retries for retriable errors. Automatic retries were introduced to solve some eventual
	// consistency problems but it also introduced performance issues on destroy operations.
	DisableAutoRetries pulumi.BoolPtrInput
	// (Optional) The fingerprint for the user's RSA key. This can be found in user settings in the Oracle Cloud Infrastructure
	// console. Required if auth is set to 'ApiKey', ignored otherwise.
	Fingerprint       pulumi.StringPtrInput
	IgnoreDefinedTags pulumi.StringArrayInput
	// (Optional) A PEM formatted RSA private key for the user. A privateKey or a privateKeyPath must be provided if auth is
	// set to 'ApiKey', ignored otherwise.
	PrivateKey pulumi.StringPtrInput
	// (Optional) The password used to secure the private key.
	PrivateKeyPassword pulumi.StringPtrInput
	// (Optional) The path to the user's PEM formatted private key. A privateKey or a privateKeyPath must be provided if auth
	// is set to 'ApiKey', ignored otherwise.
	PrivateKeyPath pulumi.StringPtrInput
	// (Optional) flags to enable realm specific service endpoint.
	RealmSpecificServiceEndpointTemplateEnabled pulumi.BoolPtrInput
	// (Required) The region for API connections (e.g. us-ashburn-1).
	Region pulumi.StringPtrInput
	// (Optional) The minimum duration (in seconds) to retry a resource operation in response to an error. The actual retry
	// duration may be longer due to jittering of retry operations. This value is ignored if the `disableAutoRetries` field is
	// set to true.
	RetryDurationSeconds pulumi.IntPtrInput
	// (Optional) The tenancy OCID for a user. The tenancy OCID can be found at the bottom of user settings in the Oracle Cloud
	// Infrastructure console. Required if auth is set to 'ApiKey', ignored otherwise.
	TenancyOcid pulumi.StringPtrInput
	// (Optional) The user OCID. This can be found in user settings in the Oracle Cloud Infrastructure console. Required if
	// auth is set to 'ApiKey', ignored otherwise.
	UserOcid pulumi.StringPtrInput
}

The set of arguments for constructing a Provider resource.

func (ProviderArgs) ElementType

func (ProviderArgs) ElementType() reflect.Type

type ProviderInput

type ProviderInput interface {
	pulumi.Input

	ToProviderOutput() ProviderOutput
	ToProviderOutputWithContext(ctx context.Context) ProviderOutput
}

type ProviderOutput

type ProviderOutput struct{ *pulumi.OutputState }

func (ProviderOutput) Auth

func (o ProviderOutput) Auth() pulumi.StringPtrOutput

(Optional) The type of auth to use. Options are 'ApiKey', 'SecurityToken', 'InstancePrincipal', 'ResourcePrincipal' and 'OKEWorkloadIdentity'. By default, 'ApiKey' will be used.

func (ProviderOutput) ConfigFileProfile

func (o ProviderOutput) ConfigFileProfile() pulumi.StringPtrOutput

(Optional) The profile name to be used from config file, if not set it will be DEFAULT.

func (ProviderOutput) ElementType

func (ProviderOutput) ElementType() reflect.Type

func (ProviderOutput) Fingerprint

func (o ProviderOutput) Fingerprint() pulumi.StringPtrOutput

(Optional) The fingerprint for the user's RSA key. This can be found in user settings in the Oracle Cloud Infrastructure console. Required if auth is set to 'ApiKey', ignored otherwise.

func (ProviderOutput) PrivateKey

func (o ProviderOutput) PrivateKey() pulumi.StringPtrOutput

(Optional) A PEM formatted RSA private key for the user. A privateKey or a privateKeyPath must be provided if auth is set to 'ApiKey', ignored otherwise.

func (ProviderOutput) PrivateKeyPassword

func (o ProviderOutput) PrivateKeyPassword() pulumi.StringPtrOutput

(Optional) The password used to secure the private key.

func (ProviderOutput) PrivateKeyPath

func (o ProviderOutput) PrivateKeyPath() pulumi.StringPtrOutput

(Optional) The path to the user's PEM formatted private key. A privateKey or a privateKeyPath must be provided if auth is set to 'ApiKey', ignored otherwise.

func (ProviderOutput) Region

func (o ProviderOutput) Region() pulumi.StringPtrOutput

(Required) The region for API connections (e.g. us-ashburn-1).

func (ProviderOutput) TenancyOcid

func (o ProviderOutput) TenancyOcid() pulumi.StringPtrOutput

(Optional) The tenancy OCID for a user. The tenancy OCID can be found at the bottom of user settings in the Oracle Cloud Infrastructure console. Required if auth is set to 'ApiKey', ignored otherwise.

func (ProviderOutput) ToProviderOutput

func (o ProviderOutput) ToProviderOutput() ProviderOutput

func (ProviderOutput) ToProviderOutputWithContext

func (o ProviderOutput) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

func (ProviderOutput) UserOcid

func (o ProviderOutput) UserOcid() pulumi.StringPtrOutput

(Optional) The user OCID. This can be found in user settings in the Oracle Cloud Infrastructure console. Required if auth is set to 'ApiKey', ignored otherwise.