openstack.Provider

Explore with Pulumi AI

OpenStack v3.14.0 published on Tuesday, Oct 31, 2023 by Pulumi

The provider type for the openstack 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

new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             allow_reauth: Optional[bool] = None,
             application_credential_id: Optional[str] = None,
             application_credential_name: Optional[str] = None,
             application_credential_secret: Optional[str] = None,
             auth_url: Optional[str] = None,
             cacert_file: Optional[str] = None,
             cert: Optional[str] = None,
             cloud: Optional[str] = None,
             default_domain: Optional[str] = None,
             delayed_auth: Optional[bool] = None,
             disable_no_cache_header: Optional[bool] = None,
             domain_id: Optional[str] = None,
             domain_name: Optional[str] = None,
             enable_logging: Optional[bool] = None,
             endpoint_overrides: Optional[Mapping[str, Any]] = None,
             endpoint_type: Optional[str] = None,
             insecure: Optional[bool] = None,
             key: Optional[str] = None,
             max_retries: Optional[int] = None,
             password: Optional[str] = None,
             project_domain_id: Optional[str] = None,
             project_domain_name: Optional[str] = None,
             region: Optional[str] = None,
             swauth: Optional[bool] = None,
             system_scope: Optional[bool] = None,
             tenant_id: Optional[str] = None,
             tenant_name: Optional[str] = None,
             token: Optional[str] = None,
             use_octavia: Optional[bool] = None,
             user_domain_id: Optional[str] = None,
             user_domain_name: Optional[str] = None,
             user_id: Optional[str] = None,
             user_name: Optional[str] = None)
@overload
def Provider(resource_name: str,
             args: Optional[ProviderArgs] = None,
             opts: Optional[ResourceOptions] = 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:openstack
properties: # The arguments to resource properties.
options: # 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.

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

The Provider resource accepts the following input properties:

AllowReauth bool: If set to false, OpenStack authorization won't be perfomed automatically, if the initial auth token get expired. Defaults to true It can also be sourced from the following environment variable: OS_ALLOW_REAUTH
ApplicationCredentialId string: Application Credential ID to login with.
ApplicationCredentialName string: Application Credential name to login with.
ApplicationCredentialSecret string: Application Credential secret to login with.
AuthUrl string: The Identity authentication URL.
CacertFile string: A Custom CA certificate.
Cert string: A client certificate to authenticate with.
Cloud string: An entry in a clouds.yaml file to use. It can also be sourced from the following environment variable: OS_CLOUD
DefaultDomain string: The name of the Domain ID to scope to if no other domain is specified. Defaults to default (Identity v3).
DelayedAuth bool: If set to false, OpenStack authorization will be perfomed, every time the service provider client is called. Defaults to true. It can also be sourced from the following environment variable: OS_DELAYED_AUTH
DisableNoCacheHeader bool: If set to true, the HTTP Cache-Control: no-cache header will not be added by default to all API requests.
DomainId string: The ID of the Domain to scope to (Identity v3).
DomainName string: The name of the Domain to scope to (Identity v3).
EnableLogging bool: Outputs very verbose logs with all calls made to and responses from OpenStack
EndpointOverrides Dictionary<string, object>: A map of services with an endpoint to override what was from the Keystone catalog
EndpointType string: It can also be sourced from the following environment variable: OS_ENDPOINT_TYPE
Insecure bool: Trust self-signed certificates. It can also be sourced from the following environment variable: OS_INSECURE
Key string: A client private key to authenticate with.
MaxRetries int: How many times HTTP connection should be retried until giving up.
Password string: Password to login with.
ProjectDomainId string: The ID of the domain where the proejct resides (Identity v3).
ProjectDomainName string: The name of the domain where the project resides (Identity v3).
Region string: The OpenStack region to connect to. It can also be sourced from the following environment variable: OS_REGION_NAME
Swauth bool: Use Swift's authentication system instead of Keystone. Only used for interaction with Swift. It can also be sourced from the following environment variable: OS_SWAUTH
SystemScope bool: If set to true, system scoped authorization will be enabled. Defaults to false (Identity v3).
TenantId string: The ID of the Tenant (Identity v2) or Project (Identity v3) to login with.
TenantName string: The name of the Tenant (Identity v2) or Project (Identity v3) to login with.
Token string: Authentication token to use as an alternative to username/password.
UseOctavia bool: If set to true, API requests will go the Load Balancer service (Octavia) instead of the Networking service (Neutron). It can also be sourced from the following environment variable: OS_USE_OCTAVIA
UserDomainId string: The ID of the domain where the user resides (Identity v3).
UserDomainName string: The name of the domain where the user resides (Identity v3).
UserId string: User ID to login with.
UserName string: Username to login with.

AllowReauth bool: If set to false, OpenStack authorization won't be perfomed automatically, if the initial auth token get expired. Defaults to true It can also be sourced from the following environment variable: OS_ALLOW_REAUTH
ApplicationCredentialId string: Application Credential ID to login with.
ApplicationCredentialName string: Application Credential name to login with.
ApplicationCredentialSecret string: Application Credential secret to login with.
AuthUrl string: The Identity authentication URL.
CacertFile string: A Custom CA certificate.
Cert string: A client certificate to authenticate with.
Cloud string: An entry in a clouds.yaml file to use. It can also be sourced from the following environment variable: OS_CLOUD
DefaultDomain string: The name of the Domain ID to scope to if no other domain is specified. Defaults to default (Identity v3).
DelayedAuth bool: If set to false, OpenStack authorization will be perfomed, every time the service provider client is called. Defaults to true. It can also be sourced from the following environment variable: OS_DELAYED_AUTH
DisableNoCacheHeader bool: If set to true, the HTTP Cache-Control: no-cache header will not be added by default to all API requests.
DomainId string: The ID of the Domain to scope to (Identity v3).
DomainName string: The name of the Domain to scope to (Identity v3).
EnableLogging bool: Outputs very verbose logs with all calls made to and responses from OpenStack
EndpointOverrides map[string]interface{}: A map of services with an endpoint to override what was from the Keystone catalog
EndpointType string: It can also be sourced from the following environment variable: OS_ENDPOINT_TYPE
Insecure bool: Trust self-signed certificates. It can also be sourced from the following environment variable: OS_INSECURE
Key string: A client private key to authenticate with.
MaxRetries int: How many times HTTP connection should be retried until giving up.
Password string: Password to login with.
ProjectDomainId string: The ID of the domain where the proejct resides (Identity v3).
ProjectDomainName string: The name of the domain where the project resides (Identity v3).
Region string: The OpenStack region to connect to. It can also be sourced from the following environment variable: OS_REGION_NAME
Swauth bool: Use Swift's authentication system instead of Keystone. Only used for interaction with Swift. It can also be sourced from the following environment variable: OS_SWAUTH
SystemScope bool: If set to true, system scoped authorization will be enabled. Defaults to false (Identity v3).
TenantId string: The ID of the Tenant (Identity v2) or Project (Identity v3) to login with.
TenantName string: The name of the Tenant (Identity v2) or Project (Identity v3) to login with.
Token string: Authentication token to use as an alternative to username/password.
UseOctavia bool: If set to true, API requests will go the Load Balancer service (Octavia) instead of the Networking service (Neutron). It can also be sourced from the following environment variable: OS_USE_OCTAVIA
UserDomainId string: The ID of the domain where the user resides (Identity v3).
UserDomainName string: The name of the domain where the user resides (Identity v3).
UserId string: User ID to login with.
UserName string: Username to login with.

allowReauth Boolean: If set to false, OpenStack authorization won't be perfomed automatically, if the initial auth token get expired. Defaults to true It can also be sourced from the following environment variable: OS_ALLOW_REAUTH
applicationCredentialId String: Application Credential ID to login with.
applicationCredentialName String: Application Credential name to login with.
applicationCredentialSecret String: Application Credential secret to login with.
authUrl String: The Identity authentication URL.
cacertFile String: A Custom CA certificate.
cert String: A client certificate to authenticate with.
cloud String: An entry in a clouds.yaml file to use. It can also be sourced from the following environment variable: OS_CLOUD
defaultDomain String: The name of the Domain ID to scope to if no other domain is specified. Defaults to default (Identity v3).
delayedAuth Boolean: If set to false, OpenStack authorization will be perfomed, every time the service provider client is called. Defaults to true. It can also be sourced from the following environment variable: OS_DELAYED_AUTH
disableNoCacheHeader Boolean: If set to true, the HTTP Cache-Control: no-cache header will not be added by default to all API requests.
domainId String: The ID of the Domain to scope to (Identity v3).
domainName String: The name of the Domain to scope to (Identity v3).
enableLogging Boolean: Outputs very verbose logs with all calls made to and responses from OpenStack
endpointOverrides Map<String,Object>: A map of services with an endpoint to override what was from the Keystone catalog
endpointType String: It can also be sourced from the following environment variable: OS_ENDPOINT_TYPE
insecure Boolean: Trust self-signed certificates. It can also be sourced from the following environment variable: OS_INSECURE
key String: A client private key to authenticate with.
maxRetries Integer: How many times HTTP connection should be retried until giving up.
password String: Password to login with.
projectDomainId String: The ID of the domain where the proejct resides (Identity v3).
projectDomainName String: The name of the domain where the project resides (Identity v3).
region String: The OpenStack region to connect to. It can also be sourced from the following environment variable: OS_REGION_NAME
swauth Boolean: Use Swift's authentication system instead of Keystone. Only used for interaction with Swift. It can also be sourced from the following environment variable: OS_SWAUTH
systemScope Boolean: If set to true, system scoped authorization will be enabled. Defaults to false (Identity v3).
tenantId String: The ID of the Tenant (Identity v2) or Project (Identity v3) to login with.
tenantName String: The name of the Tenant (Identity v2) or Project (Identity v3) to login with.
token String: Authentication token to use as an alternative to username/password.
useOctavia Boolean: If set to true, API requests will go the Load Balancer service (Octavia) instead of the Networking service (Neutron). It can also be sourced from the following environment variable: OS_USE_OCTAVIA
userDomainId String: The ID of the domain where the user resides (Identity v3).
userDomainName String: The name of the domain where the user resides (Identity v3).
userId String: User ID to login with.
userName String: Username to login with.

allowReauth boolean: If set to false, OpenStack authorization won't be perfomed automatically, if the initial auth token get expired. Defaults to true It can also be sourced from the following environment variable: OS_ALLOW_REAUTH
applicationCredentialId string: Application Credential ID to login with.
applicationCredentialName string: Application Credential name to login with.
applicationCredentialSecret string: Application Credential secret to login with.
authUrl string: The Identity authentication URL.
cacertFile string: A Custom CA certificate.
cert string: A client certificate to authenticate with.
cloud string: An entry in a clouds.yaml file to use. It can also be sourced from the following environment variable: OS_CLOUD
defaultDomain string: The name of the Domain ID to scope to if no other domain is specified. Defaults to default (Identity v3).
delayedAuth boolean: If set to false, OpenStack authorization will be perfomed, every time the service provider client is called. Defaults to true. It can also be sourced from the following environment variable: OS_DELAYED_AUTH
disableNoCacheHeader boolean: If set to true, the HTTP Cache-Control: no-cache header will not be added by default to all API requests.
domainId string: The ID of the Domain to scope to (Identity v3).
domainName string: The name of the Domain to scope to (Identity v3).
enableLogging boolean: Outputs very verbose logs with all calls made to and responses from OpenStack
endpointOverrides {[key: string]: any}: A map of services with an endpoint to override what was from the Keystone catalog
endpointType string: It can also be sourced from the following environment variable: OS_ENDPOINT_TYPE
insecure boolean: Trust self-signed certificates. It can also be sourced from the following environment variable: OS_INSECURE
key string: A client private key to authenticate with.
maxRetries number: How many times HTTP connection should be retried until giving up.
password string: Password to login with.
projectDomainId string: The ID of the domain where the proejct resides (Identity v3).
projectDomainName string: The name of the domain where the project resides (Identity v3).
region string: The OpenStack region to connect to. It can also be sourced from the following environment variable: OS_REGION_NAME
swauth boolean: Use Swift's authentication system instead of Keystone. Only used for interaction with Swift. It can also be sourced from the following environment variable: OS_SWAUTH
systemScope boolean: If set to true, system scoped authorization will be enabled. Defaults to false (Identity v3).
tenantId string: The ID of the Tenant (Identity v2) or Project (Identity v3) to login with.
tenantName string: The name of the Tenant (Identity v2) or Project (Identity v3) to login with.
token string: Authentication token to use as an alternative to username/password.
useOctavia boolean: If set to true, API requests will go the Load Balancer service (Octavia) instead of the Networking service (Neutron). It can also be sourced from the following environment variable: OS_USE_OCTAVIA
userDomainId string: The ID of the domain where the user resides (Identity v3).
userDomainName string: The name of the domain where the user resides (Identity v3).
userId string: User ID to login with.
userName string: Username to login with.

allow_reauth bool: If set to false, OpenStack authorization won't be perfomed automatically, if the initial auth token get expired. Defaults to true It can also be sourced from the following environment variable: OS_ALLOW_REAUTH
application_credential_id str: Application Credential ID to login with.
application_credential_name str: Application Credential name to login with.
application_credential_secret str: Application Credential secret to login with.
auth_url str: The Identity authentication URL.
cacert_file str: A Custom CA certificate.
cert str: A client certificate to authenticate with.
cloud str: An entry in a clouds.yaml file to use. It can also be sourced from the following environment variable: OS_CLOUD
default_domain str: The name of the Domain ID to scope to if no other domain is specified. Defaults to default (Identity v3).
delayed_auth bool: If set to false, OpenStack authorization will be perfomed, every time the service provider client is called. Defaults to true. It can also be sourced from the following environment variable: OS_DELAYED_AUTH
disable_no_cache_header bool: If set to true, the HTTP Cache-Control: no-cache header will not be added by default to all API requests.
domain_id str: The ID of the Domain to scope to (Identity v3).
domain_name str: The name of the Domain to scope to (Identity v3).
enable_logging bool: Outputs very verbose logs with all calls made to and responses from OpenStack
endpoint_overrides Mapping[str, Any]: A map of services with an endpoint to override what was from the Keystone catalog
endpoint_type str: It can also be sourced from the following environment variable: OS_ENDPOINT_TYPE
insecure bool: Trust self-signed certificates. It can also be sourced from the following environment variable: OS_INSECURE
key str: A client private key to authenticate with.
max_retries int: How many times HTTP connection should be retried until giving up.
password str: Password to login with.
project_domain_id str: The ID of the domain where the proejct resides (Identity v3).
project_domain_name str: The name of the domain where the project resides (Identity v3).
region str: The OpenStack region to connect to. It can also be sourced from the following environment variable: OS_REGION_NAME
swauth bool: Use Swift's authentication system instead of Keystone. Only used for interaction with Swift. It can also be sourced from the following environment variable: OS_SWAUTH
system_scope bool: If set to true, system scoped authorization will be enabled. Defaults to false (Identity v3).
tenant_id str: The ID of the Tenant (Identity v2) or Project (Identity v3) to login with.
tenant_name str: The name of the Tenant (Identity v2) or Project (Identity v3) to login with.
token str: Authentication token to use as an alternative to username/password.
use_octavia bool: If set to true, API requests will go the Load Balancer service (Octavia) instead of the Networking service (Neutron). It can also be sourced from the following environment variable: OS_USE_OCTAVIA
user_domain_id str: The ID of the domain where the user resides (Identity v3).
user_domain_name str: The name of the domain where the user resides (Identity v3).
user_id str: User ID to login with.
user_name str: Username to login with.

allowReauth Boolean: If set to false, OpenStack authorization won't be perfomed automatically, if the initial auth token get expired. Defaults to true It can also be sourced from the following environment variable: OS_ALLOW_REAUTH
applicationCredentialId String: Application Credential ID to login with.
applicationCredentialName String: Application Credential name to login with.
applicationCredentialSecret String: Application Credential secret to login with.
authUrl String: The Identity authentication URL.
cacertFile String: A Custom CA certificate.
cert String: A client certificate to authenticate with.
cloud String: An entry in a clouds.yaml file to use. It can also be sourced from the following environment variable: OS_CLOUD
defaultDomain String: The name of the Domain ID to scope to if no other domain is specified. Defaults to default (Identity v3).
delayedAuth Boolean: If set to false, OpenStack authorization will be perfomed, every time the service provider client is called. Defaults to true. It can also be sourced from the following environment variable: OS_DELAYED_AUTH
disableNoCacheHeader Boolean: If set to true, the HTTP Cache-Control: no-cache header will not be added by default to all API requests.
domainId String: The ID of the Domain to scope to (Identity v3).
domainName String: The name of the Domain to scope to (Identity v3).
enableLogging Boolean: Outputs very verbose logs with all calls made to and responses from OpenStack
endpointOverrides Map<Any>: A map of services with an endpoint to override what was from the Keystone catalog
endpointType String: It can also be sourced from the following environment variable: OS_ENDPOINT_TYPE
insecure Boolean: Trust self-signed certificates. It can also be sourced from the following environment variable: OS_INSECURE
key String: A client private key to authenticate with.
maxRetries Number: How many times HTTP connection should be retried until giving up.
password String: Password to login with.
projectDomainId String: The ID of the domain where the proejct resides (Identity v3).
projectDomainName String: The name of the domain where the project resides (Identity v3).
region String: The OpenStack region to connect to. It can also be sourced from the following environment variable: OS_REGION_NAME
swauth Boolean: Use Swift's authentication system instead of Keystone. Only used for interaction with Swift. It can also be sourced from the following environment variable: OS_SWAUTH
systemScope Boolean: If set to true, system scoped authorization will be enabled. Defaults to false (Identity v3).
tenantId String: The ID of the Tenant (Identity v2) or Project (Identity v3) to login with.
tenantName String: The name of the Tenant (Identity v2) or Project (Identity v3) to login with.
token String: Authentication token to use as an alternative to username/password.
useOctavia Boolean: If set to true, API requests will go the Load Balancer service (Octavia) instead of the Networking service (Neutron). It can also be sourced from the following environment variable: OS_USE_OCTAVIA
userDomainId String: The ID of the domain where the user resides (Identity v3).
userDomainName String: The name of the domain where the user resides (Identity v3).
userId String: User ID to login with.
userName String: Username to login with.

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: OpenStack pulumi/pulumi-openstack
License: Apache-2.0
Notes: This Pulumi package is based on the openstack Terraform Provider.

OpenStack v3.14.0 published on Tuesday, Oct 31, 2023 by Pulumi

pulumi/pulumi-openstack

openstack.Provider

On this page

On this page

Create Provider Resource

Provider Resource Properties

Inputs

Outputs

Package Details

On this page

On this page