provider

README

provider

Refer to the Terraform Registory for docs: salesforce.

Documentation

Index

• func NewSalesforceProvider_Override(s SalesforceProvider, scope constructs.Construct, id *string, ...)
• func SalesforceProvider_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
• func SalesforceProvider_IsConstruct(x interface{}) *bool
• func SalesforceProvider_IsTerraformElement(x interface{}) *bool
• func SalesforceProvider_IsTerraformProvider(x interface{}) *bool
• func SalesforceProvider_TfResourceType() *string
• type SalesforceProvider
  • func NewSalesforceProvider(scope constructs.Construct, id *string, config *SalesforceProviderConfig) SalesforceProvider
• type SalesforceProviderConfig

Functions

func NewSalesforceProvider_Override

func NewSalesforceProvider_Override(s SalesforceProvider, scope constructs.Construct, id *string, config *SalesforceProviderConfig)

Create a new {@link https://registry.terraform.io/providers/hashicorp/salesforce/0.1.0/docs salesforce} Resource.

func SalesforceProvider_GenerateConfigForImport

func SalesforceProvider_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource

Generates CDKTF code for importing a SalesforceProvider resource upon running "cdktf plan <stack-name>".

func SalesforceProvider_IsConstruct

func SalesforceProvider_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`.

func SalesforceProvider_IsTerraformElement

func SalesforceProvider_IsTerraformElement(x interface{}) *bool

Experimental.

func SalesforceProvider_IsTerraformProvider

func SalesforceProvider_IsTerraformProvider(x interface{}) *bool

Experimental.

func SalesforceProvider_TfResourceType

func SalesforceProvider_TfResourceType() *string

Types

type SalesforceProvider

type SalesforceProvider interface {
	cdktf.TerraformProvider
	Alias() *string
	SetAlias(val *string)
	AliasInput() *string
	ApiVersion() *string
	SetApiVersion(val *string)
	ApiVersionInput() *string
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	ClientId() *string
	SetClientId(val *string)
	ClientIdInput() *string
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	LoginUrl() *string
	SetLoginUrl(val *string)
	LoginUrlInput() *string
	// Experimental.
	MetaAttributes() *map[string]interface{}
	// The tree node.
	Node() constructs.Node
	PrivateKey() *string
	SetPrivateKey(val *string)
	PrivateKeyInput() *string
	// Experimental.
	RawOverrides() interface{}
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformProviderSource() *string
	// Experimental.
	TerraformResourceType() *string
	Username() *string
	SetUsername(val *string)
	UsernameInput() *string
	// Experimental.
	AddOverride(path *string, value interface{})
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	ResetAlias()
	ResetApiVersion()
	ResetClientId()
	ResetLoginUrl()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetPrivateKey()
	ResetUsername()
	SynthesizeAttributes() *map[string]interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToTerraform() interface{}
}

Represents a {@link https://registry.terraform.io/providers/hashicorp/salesforce/0.1.0/docs salesforce}.

func NewSalesforceProvider

func NewSalesforceProvider(scope constructs.Construct, id *string, config *SalesforceProviderConfig) SalesforceProvider

Create a new {@link https://registry.terraform.io/providers/hashicorp/salesforce/0.1.0/docs salesforce} Resource.

type SalesforceProviderConfig

type SalesforceProviderConfig struct {
	// Alias name.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/salesforce/0.1.0/docs#alias SalesforceProvider#alias}
	Alias *string `field:"optional" json:"alias" yaml:"alias"`
	// API version of the salesforce org in the format in the format: MAJOR.MINOR (please omit any leading 'v'). The provider requires at least version 53.0. Can be specified with the environment variable SALESFORCE_API_VERSION.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/salesforce/0.1.0/docs#api_version SalesforceProvider#api_version}
	ApiVersion *string `field:"optional" json:"apiVersion" yaml:"apiVersion"`
	// Client ID of the connected app.
	//
	// Corresponds to Consumer Key in the user interface. Can be specified with the environment variable SALESFORCE_CLIENT_ID.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/salesforce/0.1.0/docs#client_id SalesforceProvider#client_id}
	ClientId *string `field:"optional" json:"clientId" yaml:"clientId"`
	// Directs the authentication request, defaults to the production endpoint https://login.salesforce.com, should be set to https://test.salesforce.com for sandbox organizations. Can be specified with the environment variable SALESFORCE_LOGIN_URL.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/salesforce/0.1.0/docs#login_url SalesforceProvider#login_url}
	LoginUrl *string `field:"optional" json:"loginUrl" yaml:"loginUrl"`
	// Private Key associated to the public certificate that was uploaded to the connected app.
	//
	// This may point to a file location or be set directly. This should not be confused with the Consumer Secret in the user interface. Can be specified with the environment variable SALESFORCE_PRIVATE_KEY.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/salesforce/0.1.0/docs#private_key SalesforceProvider#private_key}
	PrivateKey *string `field:"optional" json:"privateKey" yaml:"privateKey"`
	// Salesforce Username of a System Administrator like user for the provider to authenticate as.
	//
	// Can be specified with the environment variable SALESFORCE_USERNAME.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/salesforce/0.1.0/docs#username SalesforceProvider#username}
	Username *string `field:"optional" json:"username" yaml:"username"`
}