1. Packages
  2. Cyral Provider
  3. API Docs
  4. Provider
cyral 4.16.3 published on Monday, Apr 14, 2025 by cyralinc

cyral.Provider

Explore with Pulumi AI

cyral logo
cyral 4.16.3 published on Monday, Apr 14, 2025 by cyralinc

    The provider type for the cyral 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: ProviderArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Provider(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 client_id: Optional[str] = None,
                 client_secret: Optional[str] = None,
                 control_plane: Optional[str] = None,
                 tls_skip_verify: Optional[bool] = None)
    func NewProvider(ctx *Context, name string, args ProviderArgs, opts ...ResourceOption) (*Provider, error)
    public Provider(string name, ProviderArgs args, CustomResourceOptions? opts = null)
    public Provider(String name, ProviderArgs args)
    public Provider(String name, ProviderArgs args, CustomResourceOptions options)
    
    type: pulumi:providers:cyral
    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:

    ControlPlane string
    Control plane host and API port (ex: tenant.app.cyral.com)
    ClientId string
    Client id used to authenticate against the control plane. Can be ommited and declared using the environment variable CYRAL_TF_CLIENT_ID.
    ClientSecret string
    Client secret used to authenticate against the control plane. Can be ommited and declared using the environment variable CYRAL_TF_CLIENT_SECRET.
    TlsSkipVerify bool
    Specifies if the client will verify the TLS server certificate used by the control plane. If set to true, the client will not verify the server certificate, hence, it will allow insecure connections to be established. This should be set only for testing and is not recommended to be used in production environments. Can be set through the CYRAL_TF_TLS_SKIP_VERIFY environment variable. Defaults to false.
    ControlPlane string
    Control plane host and API port (ex: tenant.app.cyral.com)
    ClientId string
    Client id used to authenticate against the control plane. Can be ommited and declared using the environment variable CYRAL_TF_CLIENT_ID.
    ClientSecret string
    Client secret used to authenticate against the control plane. Can be ommited and declared using the environment variable CYRAL_TF_CLIENT_SECRET.
    TlsSkipVerify bool
    Specifies if the client will verify the TLS server certificate used by the control plane. If set to true, the client will not verify the server certificate, hence, it will allow insecure connections to be established. This should be set only for testing and is not recommended to be used in production environments. Can be set through the CYRAL_TF_TLS_SKIP_VERIFY environment variable. Defaults to false.
    controlPlane String
    Control plane host and API port (ex: tenant.app.cyral.com)
    clientId String
    Client id used to authenticate against the control plane. Can be ommited and declared using the environment variable CYRAL_TF_CLIENT_ID.
    clientSecret String
    Client secret used to authenticate against the control plane. Can be ommited and declared using the environment variable CYRAL_TF_CLIENT_SECRET.
    tlsSkipVerify Boolean
    Specifies if the client will verify the TLS server certificate used by the control plane. If set to true, the client will not verify the server certificate, hence, it will allow insecure connections to be established. This should be set only for testing and is not recommended to be used in production environments. Can be set through the CYRAL_TF_TLS_SKIP_VERIFY environment variable. Defaults to false.
    controlPlane string
    Control plane host and API port (ex: tenant.app.cyral.com)
    clientId string
    Client id used to authenticate against the control plane. Can be ommited and declared using the environment variable CYRAL_TF_CLIENT_ID.
    clientSecret string
    Client secret used to authenticate against the control plane. Can be ommited and declared using the environment variable CYRAL_TF_CLIENT_SECRET.
    tlsSkipVerify boolean
    Specifies if the client will verify the TLS server certificate used by the control plane. If set to true, the client will not verify the server certificate, hence, it will allow insecure connections to be established. This should be set only for testing and is not recommended to be used in production environments. Can be set through the CYRAL_TF_TLS_SKIP_VERIFY environment variable. Defaults to false.
    control_plane str
    Control plane host and API port (ex: tenant.app.cyral.com)
    client_id str
    Client id used to authenticate against the control plane. Can be ommited and declared using the environment variable CYRAL_TF_CLIENT_ID.
    client_secret str
    Client secret used to authenticate against the control plane. Can be ommited and declared using the environment variable CYRAL_TF_CLIENT_SECRET.
    tls_skip_verify bool
    Specifies if the client will verify the TLS server certificate used by the control plane. If set to true, the client will not verify the server certificate, hence, it will allow insecure connections to be established. This should be set only for testing and is not recommended to be used in production environments. Can be set through the CYRAL_TF_TLS_SKIP_VERIFY environment variable. Defaults to false.
    controlPlane String
    Control plane host and API port (ex: tenant.app.cyral.com)
    clientId String
    Client id used to authenticate against the control plane. Can be ommited and declared using the environment variable CYRAL_TF_CLIENT_ID.
    clientSecret String
    Client secret used to authenticate against the control plane. Can be ommited and declared using the environment variable CYRAL_TF_CLIENT_SECRET.
    tlsSkipVerify Boolean
    Specifies if the client will verify the TLS server certificate used by the control plane. If set to true, the client will not verify the server certificate, hence, it will allow insecure connections to be established. This should be set only for testing and is not recommended to be used in production environments. Can be set through the CYRAL_TF_TLS_SKIP_VERIFY environment variable. Defaults to false.

    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
    cyral cyralinc/terraform-provider-cyral
    License
    Notes
    This Pulumi package is based on the cyral Terraform Provider.
    cyral logo
    cyral 4.16.3 published on Monday, Apr 14, 2025 by cyralinc