Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Provider
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

oci.Provider

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

    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 for more information.

    Create Provider Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);
    @overload
def Provider(resource_name: str,
             args: Optional[ProviderArgs] = None,
             opts: Optional[ResourceOptions] = None)

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             auth: Optional[str] = None,
             config_file_profile: Optional[str] = None,
             disable_auto_retries: Optional[bool] = None,
             fingerprint: Optional[str] = None,
             ignore_defined_tags: Optional[Sequence[str]] = None,
             private_key: Optional[str] = None,
             private_key_password: Optional[str] = None,
             private_key_path: Optional[str] = None,
             realm_specific_service_endpoint_template_enabled: Optional[bool] = None,
             region: Optional[str] = None,
             retry_duration_seconds: Optional[int] = None,
             tenancy_ocid: Optional[str] = None,
             user_ocid: Optional[str] = None)
    func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
    public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
    public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)

    type: pulumi:providers:oci
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Provider Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Provider resource accepts the following input properties:

    Auth string
    (Optional) The type of auth to use. Options are 'ApiKey', 'SecurityToken', 'InstancePrincipal', 'ResourcePrincipal' and 'OKEWorkloadIdentity'. By default, 'ApiKey' will be used.
    ConfigFileProfile string
    (Optional) The profile name to be used from config file, if not set it will be DEFAULT.
    DisableAutoRetries bool
    (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.
    Fingerprint string
    (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.
    IgnoreDefinedTags List<string>
    PrivateKey string
    (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.
    PrivateKeyPassword string
    (Optional) The password used to secure the private key.
    PrivateKeyPath string
    (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.
    RealmSpecificServiceEndpointTemplateEnabled bool
    (Optional) flags to enable realm specific service endpoint.
    Region string
    (Required) The region for API connections (e.g. us-ashburn-1).
    RetryDurationSeconds int
    (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.
    TenancyOcid string
    (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.
    UserOcid string
    (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.
    Auth string
    (Optional) The type of auth to use. Options are 'ApiKey', 'SecurityToken', 'InstancePrincipal', 'ResourcePrincipal' and 'OKEWorkloadIdentity'. By default, 'ApiKey' will be used.
    ConfigFileProfile string
    (Optional) The profile name to be used from config file, if not set it will be DEFAULT.
    DisableAutoRetries bool
    (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.
    Fingerprint string
    (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.
    IgnoreDefinedTags []string
    PrivateKey string
    (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.
    PrivateKeyPassword string
    (Optional) The password used to secure the private key.
    PrivateKeyPath string
    (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.
    RealmSpecificServiceEndpointTemplateEnabled bool
    (Optional) flags to enable realm specific service endpoint.
    Region string
    (Required) The region for API connections (e.g. us-ashburn-1).
    RetryDurationSeconds int
    (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.
    TenancyOcid string
    (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.
    UserOcid string
    (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.
    auth String
    (Optional) The type of auth to use. Options are 'ApiKey', 'SecurityToken', 'InstancePrincipal', 'ResourcePrincipal' and 'OKEWorkloadIdentity'. By default, 'ApiKey' will be used.
    configFileProfile String
    (Optional) The profile name to be used from config file, if not set it will be DEFAULT.
    disableAutoRetries Boolean
    (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.
    fingerprint String
    (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.
    ignoreDefinedTags List<String>
    privateKey String
    (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.
    privateKeyPassword String
    (Optional) The password used to secure the private key.
    privateKeyPath String
    (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.
    realmSpecificServiceEndpointTemplateEnabled Boolean
    (Optional) flags to enable realm specific service endpoint.
    region String
    (Required) The region for API connections (e.g. us-ashburn-1).
    retryDurationSeconds Integer
    (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.
    tenancyOcid String
    (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.
    userOcid String
    (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.
    auth string
    (Optional) The type of auth to use. Options are 'ApiKey', 'SecurityToken', 'InstancePrincipal', 'ResourcePrincipal' and 'OKEWorkloadIdentity'. By default, 'ApiKey' will be used.
    configFileProfile string
    (Optional) The profile name to be used from config file, if not set it will be DEFAULT.
    disableAutoRetries boolean
    (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.
    fingerprint string
    (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.
    ignoreDefinedTags string[]
    privateKey string
    (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.
    privateKeyPassword string
    (Optional) The password used to secure the private key.
    privateKeyPath string
    (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.
    realmSpecificServiceEndpointTemplateEnabled boolean
    (Optional) flags to enable realm specific service endpoint.
    region string
    (Required) The region for API connections (e.g. us-ashburn-1).
    retryDurationSeconds number
    (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.
    tenancyOcid string
    (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.
    userOcid string
    (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.
    auth str
    (Optional) The type of auth to use. Options are 'ApiKey', 'SecurityToken', 'InstancePrincipal', 'ResourcePrincipal' and 'OKEWorkloadIdentity'. By default, 'ApiKey' will be used.
    config_file_profile str
    (Optional) The profile name to be used from config file, if not set it will be DEFAULT.
    disable_auto_retries bool
    (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.
    fingerprint str
    (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.
    ignore_defined_tags Sequence[str]
    private_key str
    (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.
    private_key_password str
    (Optional) The password used to secure the private key.
    private_key_path str
    (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.
    realm_specific_service_endpoint_template_enabled bool
    (Optional) flags to enable realm specific service endpoint.
    region str
    (Required) The region for API connections (e.g. us-ashburn-1).
    retry_duration_seconds int
    (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.
    tenancy_ocid str
    (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.
    user_ocid str
    (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.
    auth String
    (Optional) The type of auth to use. Options are 'ApiKey', 'SecurityToken', 'InstancePrincipal', 'ResourcePrincipal' and 'OKEWorkloadIdentity'. By default, 'ApiKey' will be used.
    configFileProfile String
    (Optional) The profile name to be used from config file, if not set it will be DEFAULT.
    disableAutoRetries Boolean
    (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.
    fingerprint String
    (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.
    ignoreDefinedTags List<String>
    privateKey String
    (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.
    privateKeyPassword String
    (Optional) The password used to secure the private key.
    privateKeyPath String
    (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.
    realmSpecificServiceEndpointTemplateEnabled Boolean
    (Optional) flags to enable realm specific service endpoint.
    region String
    (Required) The region for API connections (e.g. us-ashburn-1).
    retryDurationSeconds Number
    (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.
    tenancyOcid String
    (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.
    userOcid String
    (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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Provider resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-oci