oci

package
v1.16.0 Latest Latest
Warning

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

 Go to latest Published: Nov 2, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Provider 

type Provider struct {
	pulumi.ProviderResourceState

	// (Optional) The type of auth to use. Options are 'ApiKey', 'SecurityToken' and 'InstancePrincipal' and
	// 'ResourcePrincipal'. 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 private_key or a private_key_path 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 private_key or a private_key_path 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) ToOutput added in v1.11.0 

func (i *Provider) ToOutput(ctx context.Context) pulumix.Output[*Provider]

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' and 'InstancePrincipal' and
	// 'ResourcePrincipal'. 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
	// (Optional) List of defined tags keys that Terraform should ignore when planning creates and updates to the associated
	// remote object
	IgnoreDefinedTags pulumi.StringArrayInput
	// (Optional) A PEM formatted RSA private key for the user. A private_key or a private_key_path 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 private_key or a private_key_path 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 `disable_auto_retries` 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 added in v0.4.0 

func (o ProviderOutput) Auth() pulumi.StringPtrOutput

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

func (ProviderOutput) ConfigFileProfile added in v0.4.0 

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 added in v0.4.0 

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 added in v0.4.0 

func (o ProviderOutput) PrivateKey() pulumi.StringPtrOutput

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

func (ProviderOutput) PrivateKeyPassword added in v0.4.0 

func (o ProviderOutput) PrivateKeyPassword() pulumi.StringPtrOutput

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

func (ProviderOutput) PrivateKeyPath added in v0.4.0 

func (o ProviderOutput) PrivateKeyPath() pulumi.StringPtrOutput

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

func (ProviderOutput) Region added in v0.4.0 

func (o ProviderOutput) Region() pulumi.StringPtrOutput

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

func (ProviderOutput) TenancyOcid added in v0.4.0 

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) ToOutput added in v1.11.0 

func (o ProviderOutput) ToOutput(ctx context.Context) pulumix.Output[*Provider]

func (ProviderOutput) ToProviderOutput 

func (o ProviderOutput) ToProviderOutput() ProviderOutput

func (ProviderOutput) ToProviderOutputWithContext 

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

func (ProviderOutput) UserOcid added in v0.4.0 

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.

Source Files

View all Source files

Directories

Path Synopsis

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.