konnect.Provider
The provider type for the konnect 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,
konnect_access_token: Optional[str] = None,
personal_access_token: Optional[str] = None,
server_url: Optional[str] = None,
service_access_token: Optional[str] = None,
system_account_access_token: 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:konnect
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:
- Konnect
Access stringToken - The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI to authenticate with..
- Personal
Access stringToken - The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs. You can
generate a Personal Access Token (PAT) from the personal access token page in the Konnect dashboard.. Configurable via
environment variable
KONNECT_TOKEN. - Server
Url string - Server URL (defaults to https://global.api.konghq.com)
- Service
Access stringToken - The Service access token is meant to be used between internal services. .
- System
Account stringAccess Token - The system account access token is meant for automations and integrations that are not directly associated with a human
identity. You can generate a system account Access Token by creating a system account and then obtaining a system
account access token for that account. The access token must be passed in the header of a request, for example:
curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'. Configurable via environment variableKONNECT_SPAT.
- Konnect
Access stringToken - The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI to authenticate with..
- Personal
Access stringToken - The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs. You can
generate a Personal Access Token (PAT) from the personal access token page in the Konnect dashboard.. Configurable via
environment variable
KONNECT_TOKEN. - Server
Url string - Server URL (defaults to https://global.api.konghq.com)
- Service
Access stringToken - The Service access token is meant to be used between internal services. .
- System
Account stringAccess Token - The system account access token is meant for automations and integrations that are not directly associated with a human
identity. You can generate a system account Access Token by creating a system account and then obtaining a system
account access token for that account. The access token must be passed in the header of a request, for example:
curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'. Configurable via environment variableKONNECT_SPAT.
- konnect
Access StringToken - The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI to authenticate with..
- personal
Access StringToken - The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs. You can
generate a Personal Access Token (PAT) from the personal access token page in the Konnect dashboard.. Configurable via
environment variable
KONNECT_TOKEN. - server
Url String - Server URL (defaults to https://global.api.konghq.com)
- service
Access StringToken - The Service access token is meant to be used between internal services. .
- system
Account StringAccess Token - The system account access token is meant for automations and integrations that are not directly associated with a human
identity. You can generate a system account Access Token by creating a system account and then obtaining a system
account access token for that account. The access token must be passed in the header of a request, for example:
curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'. Configurable via environment variableKONNECT_SPAT.
- konnect
Access stringToken - The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI to authenticate with..
- personal
Access stringToken - The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs. You can
generate a Personal Access Token (PAT) from the personal access token page in the Konnect dashboard.. Configurable via
environment variable
KONNECT_TOKEN. - server
Url string - Server URL (defaults to https://global.api.konghq.com)
- service
Access stringToken - The Service access token is meant to be used between internal services. .
- system
Account stringAccess Token - The system account access token is meant for automations and integrations that are not directly associated with a human
identity. You can generate a system account Access Token by creating a system account and then obtaining a system
account access token for that account. The access token must be passed in the header of a request, for example:
curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'. Configurable via environment variableKONNECT_SPAT.
- konnect_
access_ strtoken - The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI to authenticate with..
- personal_
access_ strtoken - The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs. You can
generate a Personal Access Token (PAT) from the personal access token page in the Konnect dashboard.. Configurable via
environment variable
KONNECT_TOKEN. - server_
url str - Server URL (defaults to https://global.api.konghq.com)
- service_
access_ strtoken - The Service access token is meant to be used between internal services. .
- system_
account_ straccess_ token - The system account access token is meant for automations and integrations that are not directly associated with a human
identity. You can generate a system account Access Token by creating a system account and then obtaining a system
account access token for that account. The access token must be passed in the header of a request, for example:
curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'. Configurable via environment variableKONNECT_SPAT.
- konnect
Access StringToken - The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI to authenticate with..
- personal
Access StringToken - The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs. You can
generate a Personal Access Token (PAT) from the personal access token page in the Konnect dashboard.. Configurable via
environment variable
KONNECT_TOKEN. - server
Url String - Server URL (defaults to https://global.api.konghq.com)
- service
Access StringToken - The Service access token is meant to be used between internal services. .
- system
Account StringAccess Token - The system account access token is meant for automations and integrations that are not directly associated with a human
identity. You can generate a system account Access Token by creating a system account and then obtaining a system
account access token for that account. The access token must be passed in the header of a request, for example:
curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'. Configurable via environment variableKONNECT_SPAT.
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
- konnect kong/terraform-provider-konnect
- License
- Notes
- This Pulumi package is based on the
konnectTerraform Provider.
