qdrant-cloud.AccountsDatabaseApiKeyV2
Explore with Pulumi AI
Account Database API Key Resource (v2)
Create AccountsDatabaseApiKeyV2 Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AccountsDatabaseApiKeyV2(name: string, args: AccountsDatabaseApiKeyV2Args, opts?: CustomResourceOptions);
@overload
def AccountsDatabaseApiKeyV2(resource_name: str,
args: AccountsDatabaseApiKeyV2Args,
opts: Optional[ResourceOptions] = None)
@overload
def AccountsDatabaseApiKeyV2(resource_name: str,
opts: Optional[ResourceOptions] = None,
cluster_id: Optional[str] = None,
account_id: Optional[str] = None,
collection_access_rules: Optional[Sequence[AccountsDatabaseApiKeyV2CollectionAccessRuleArgs]] = None,
expires_at: Optional[str] = None,
global_access_rule: Optional[AccountsDatabaseApiKeyV2GlobalAccessRuleArgs] = None,
name: Optional[str] = None)
func NewAccountsDatabaseApiKeyV2(ctx *Context, name string, args AccountsDatabaseApiKeyV2Args, opts ...ResourceOption) (*AccountsDatabaseApiKeyV2, error)
public AccountsDatabaseApiKeyV2(string name, AccountsDatabaseApiKeyV2Args args, CustomResourceOptions? opts = null)
public AccountsDatabaseApiKeyV2(String name, AccountsDatabaseApiKeyV2Args args)
public AccountsDatabaseApiKeyV2(String name, AccountsDatabaseApiKeyV2Args args, CustomResourceOptions options)
type: qdrant-cloud:AccountsDatabaseApiKeyV2
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 AccountsDatabaseApiKeyV2Args
- 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 AccountsDatabaseApiKeyV2Args
- 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 AccountsDatabaseApiKeyV2Args
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AccountsDatabaseApiKeyV2Args
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AccountsDatabaseApiKeyV2Args
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var accountsDatabaseApiKeyV2Resource = new QdrantCloud.AccountsDatabaseApiKeyV2("accountsDatabaseApiKeyV2Resource", new()
{
ClusterId = "string",
AccountId = "string",
CollectionAccessRules = new[]
{
new QdrantCloud.Inputs.AccountsDatabaseApiKeyV2CollectionAccessRuleArgs
{
AccessType = "string",
CollectionName = "string",
Payload =
{
{ "string", "string" },
},
},
},
ExpiresAt = "string",
GlobalAccessRule = new QdrantCloud.Inputs.AccountsDatabaseApiKeyV2GlobalAccessRuleArgs
{
AccessType = "string",
},
Name = "string",
});
example, err := qdrantcloud.NewAccountsDatabaseApiKeyV2(ctx, "accountsDatabaseApiKeyV2Resource", &qdrantcloud.AccountsDatabaseApiKeyV2Args{
ClusterId: pulumi.String("string"),
AccountId: pulumi.String("string"),
CollectionAccessRules: qdrantcloud.AccountsDatabaseApiKeyV2CollectionAccessRuleArray{
&qdrantcloud.AccountsDatabaseApiKeyV2CollectionAccessRuleArgs{
AccessType: pulumi.String("string"),
CollectionName: pulumi.String("string"),
Payload: pulumi.StringMap{
"string": pulumi.String("string"),
},
},
},
ExpiresAt: pulumi.String("string"),
GlobalAccessRule: &qdrantcloud.AccountsDatabaseApiKeyV2GlobalAccessRuleArgs{
AccessType: pulumi.String("string"),
},
Name: pulumi.String("string"),
})
var accountsDatabaseApiKeyV2Resource = new AccountsDatabaseApiKeyV2("accountsDatabaseApiKeyV2Resource", AccountsDatabaseApiKeyV2Args.builder()
.clusterId("string")
.accountId("string")
.collectionAccessRules(AccountsDatabaseApiKeyV2CollectionAccessRuleArgs.builder()
.accessType("string")
.collectionName("string")
.payload(Map.of("string", "string"))
.build())
.expiresAt("string")
.globalAccessRule(AccountsDatabaseApiKeyV2GlobalAccessRuleArgs.builder()
.accessType("string")
.build())
.name("string")
.build());
accounts_database_api_key_v2_resource = qdrant_cloud.AccountsDatabaseApiKeyV2("accountsDatabaseApiKeyV2Resource",
cluster_id="string",
account_id="string",
collection_access_rules=[{
"access_type": "string",
"collection_name": "string",
"payload": {
"string": "string",
},
}],
expires_at="string",
global_access_rule={
"access_type": "string",
},
name="string")
const accountsDatabaseApiKeyV2Resource = new qdrant_cloud.AccountsDatabaseApiKeyV2("accountsDatabaseApiKeyV2Resource", {
clusterId: "string",
accountId: "string",
collectionAccessRules: [{
accessType: "string",
collectionName: "string",
payload: {
string: "string",
},
}],
expiresAt: "string",
globalAccessRule: {
accessType: "string",
},
name: "string",
});
type: qdrant-cloud:AccountsDatabaseApiKeyV2
properties:
accountId: string
clusterId: string
collectionAccessRules:
- accessType: string
collectionName: string
payload:
string: string
expiresAt: string
globalAccessRule:
accessType: string
name: string
AccountsDatabaseApiKeyV2 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 AccountsDatabaseApiKeyV2 resource accepts the following input properties:
- Cluster
Id string - Database API Keys V2 Schema Cluster Identifier for which this Auth Key is attached field
- Account
Id string - Database API Keys V2 Schema Account Identifier field
- Collection
Access List<Pulumi.Rules Qdrant Cloud. Inputs. Accounts Database Api Key V2Collection Access Rule> - A list of rules granting access to specific collections. Cannot be used with
global_access_rule
. - Expires
At string - Database API Keys V2 Schema Timestamp when the Auth Key expires field
- Global
Access Pulumi.Rule Qdrant Cloud. Inputs. Accounts Database Api Key V2Global Access Rule - A rule granting global access to the entire database. Cannot be used with
collection_access_rules
. - Name string
- Database API Keys V2 Schema Auth Key Name field
- Cluster
Id string - Database API Keys V2 Schema Cluster Identifier for which this Auth Key is attached field
- Account
Id string - Database API Keys V2 Schema Account Identifier field
- Collection
Access []AccountsRules Database Api Key V2Collection Access Rule Args - A list of rules granting access to specific collections. Cannot be used with
global_access_rule
. - Expires
At string - Database API Keys V2 Schema Timestamp when the Auth Key expires field
- Global
Access AccountsRule Database Api Key V2Global Access Rule Args - A rule granting global access to the entire database. Cannot be used with
collection_access_rules
. - Name string
- Database API Keys V2 Schema Auth Key Name field
- cluster
Id String - Database API Keys V2 Schema Cluster Identifier for which this Auth Key is attached field
- account
Id String - Database API Keys V2 Schema Account Identifier field
- collection
Access List<AccountsRules Database Api Key V2Collection Access Rule> - A list of rules granting access to specific collections. Cannot be used with
global_access_rule
. - expires
At String - Database API Keys V2 Schema Timestamp when the Auth Key expires field
- global
Access AccountsRule Database Api Key V2Global Access Rule - A rule granting global access to the entire database. Cannot be used with
collection_access_rules
. - name String
- Database API Keys V2 Schema Auth Key Name field
- cluster
Id string - Database API Keys V2 Schema Cluster Identifier for which this Auth Key is attached field
- account
Id string - Database API Keys V2 Schema Account Identifier field
- collection
Access AccountsRules Database Api Key V2Collection Access Rule[] - A list of rules granting access to specific collections. Cannot be used with
global_access_rule
. - expires
At string - Database API Keys V2 Schema Timestamp when the Auth Key expires field
- global
Access AccountsRule Database Api Key V2Global Access Rule - A rule granting global access to the entire database. Cannot be used with
collection_access_rules
. - name string
- Database API Keys V2 Schema Auth Key Name field
- cluster_
id str - Database API Keys V2 Schema Cluster Identifier for which this Auth Key is attached field
- account_
id str - Database API Keys V2 Schema Account Identifier field
- collection_
access_ Sequence[Accountsrules Database Api Key V2Collection Access Rule Args] - A list of rules granting access to specific collections. Cannot be used with
global_access_rule
. - expires_
at str - Database API Keys V2 Schema Timestamp when the Auth Key expires field
- global_
access_ Accountsrule Database Api Key V2Global Access Rule Args - A rule granting global access to the entire database. Cannot be used with
collection_access_rules
. - name str
- Database API Keys V2 Schema Auth Key Name field
- cluster
Id String - Database API Keys V2 Schema Cluster Identifier for which this Auth Key is attached field
- account
Id String - Database API Keys V2 Schema Account Identifier field
- collection
Access List<Property Map>Rules - A list of rules granting access to specific collections. Cannot be used with
global_access_rule
. - expires
At String - Database API Keys V2 Schema Timestamp when the Auth Key expires field
- global
Access Property MapRule - A rule granting global access to the entire database. Cannot be used with
collection_access_rules
. - name String
- Database API Keys V2 Schema Auth Key Name field
Outputs
All input properties are implicitly available as output properties. Additionally, the AccountsDatabaseApiKeyV2 resource produces the following output properties:
- Created
At string - Database API Keys V2 Schema Timestamp when the Auth Key is created field
- Created
By stringEmail - Database API Keys V2 Schema Email of the user who created the key field
- Id string
- The provider-assigned unique ID for this managed resource.
- Key string
- Database API Keys V2 Schema Secret key for this Auth Key field
- Postfix string
- Database API Keys V2 Schema Postfix of the Auth Key field
- Created
At string - Database API Keys V2 Schema Timestamp when the Auth Key is created field
- Created
By stringEmail - Database API Keys V2 Schema Email of the user who created the key field
- Id string
- The provider-assigned unique ID for this managed resource.
- Key string
- Database API Keys V2 Schema Secret key for this Auth Key field
- Postfix string
- Database API Keys V2 Schema Postfix of the Auth Key field
- created
At String - Database API Keys V2 Schema Timestamp when the Auth Key is created field
- created
By StringEmail - Database API Keys V2 Schema Email of the user who created the key field
- id String
- The provider-assigned unique ID for this managed resource.
- key String
- Database API Keys V2 Schema Secret key for this Auth Key field
- postfix String
- Database API Keys V2 Schema Postfix of the Auth Key field
- created
At string - Database API Keys V2 Schema Timestamp when the Auth Key is created field
- created
By stringEmail - Database API Keys V2 Schema Email of the user who created the key field
- id string
- The provider-assigned unique ID for this managed resource.
- key string
- Database API Keys V2 Schema Secret key for this Auth Key field
- postfix string
- Database API Keys V2 Schema Postfix of the Auth Key field
- created_
at str - Database API Keys V2 Schema Timestamp when the Auth Key is created field
- created_
by_ stremail - Database API Keys V2 Schema Email of the user who created the key field
- id str
- The provider-assigned unique ID for this managed resource.
- key str
- Database API Keys V2 Schema Secret key for this Auth Key field
- postfix str
- Database API Keys V2 Schema Postfix of the Auth Key field
- created
At String - Database API Keys V2 Schema Timestamp when the Auth Key is created field
- created
By StringEmail - Database API Keys V2 Schema Email of the user who created the key field
- id String
- The provider-assigned unique ID for this managed resource.
- key String
- Database API Keys V2 Schema Secret key for this Auth Key field
- postfix String
- Database API Keys V2 Schema Postfix of the Auth Key field
Look up Existing AccountsDatabaseApiKeyV2 Resource
Get an existing AccountsDatabaseApiKeyV2 resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: AccountsDatabaseApiKeyV2State, opts?: CustomResourceOptions): AccountsDatabaseApiKeyV2
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
account_id: Optional[str] = None,
cluster_id: Optional[str] = None,
collection_access_rules: Optional[Sequence[AccountsDatabaseApiKeyV2CollectionAccessRuleArgs]] = None,
created_at: Optional[str] = None,
created_by_email: Optional[str] = None,
expires_at: Optional[str] = None,
global_access_rule: Optional[AccountsDatabaseApiKeyV2GlobalAccessRuleArgs] = None,
key: Optional[str] = None,
name: Optional[str] = None,
postfix: Optional[str] = None) -> AccountsDatabaseApiKeyV2
func GetAccountsDatabaseApiKeyV2(ctx *Context, name string, id IDInput, state *AccountsDatabaseApiKeyV2State, opts ...ResourceOption) (*AccountsDatabaseApiKeyV2, error)
public static AccountsDatabaseApiKeyV2 Get(string name, Input<string> id, AccountsDatabaseApiKeyV2State? state, CustomResourceOptions? opts = null)
public static AccountsDatabaseApiKeyV2 get(String name, Output<String> id, AccountsDatabaseApiKeyV2State state, CustomResourceOptions options)
resources: _: type: qdrant-cloud:AccountsDatabaseApiKeyV2 get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Account
Id string - Database API Keys V2 Schema Account Identifier field
- Cluster
Id string - Database API Keys V2 Schema Cluster Identifier for which this Auth Key is attached field
- Collection
Access List<Pulumi.Rules Qdrant Cloud. Inputs. Accounts Database Api Key V2Collection Access Rule> - A list of rules granting access to specific collections. Cannot be used with
global_access_rule
. - Created
At string - Database API Keys V2 Schema Timestamp when the Auth Key is created field
- Created
By stringEmail - Database API Keys V2 Schema Email of the user who created the key field
- Expires
At string - Database API Keys V2 Schema Timestamp when the Auth Key expires field
- Global
Access Pulumi.Rule Qdrant Cloud. Inputs. Accounts Database Api Key V2Global Access Rule - A rule granting global access to the entire database. Cannot be used with
collection_access_rules
. - Key string
- Database API Keys V2 Schema Secret key for this Auth Key field
- Name string
- Database API Keys V2 Schema Auth Key Name field
- Postfix string
- Database API Keys V2 Schema Postfix of the Auth Key field
- Account
Id string - Database API Keys V2 Schema Account Identifier field
- Cluster
Id string - Database API Keys V2 Schema Cluster Identifier for which this Auth Key is attached field
- Collection
Access []AccountsRules Database Api Key V2Collection Access Rule Args - A list of rules granting access to specific collections. Cannot be used with
global_access_rule
. - Created
At string - Database API Keys V2 Schema Timestamp when the Auth Key is created field
- Created
By stringEmail - Database API Keys V2 Schema Email of the user who created the key field
- Expires
At string - Database API Keys V2 Schema Timestamp when the Auth Key expires field
- Global
Access AccountsRule Database Api Key V2Global Access Rule Args - A rule granting global access to the entire database. Cannot be used with
collection_access_rules
. - Key string
- Database API Keys V2 Schema Secret key for this Auth Key field
- Name string
- Database API Keys V2 Schema Auth Key Name field
- Postfix string
- Database API Keys V2 Schema Postfix of the Auth Key field
- account
Id String - Database API Keys V2 Schema Account Identifier field
- cluster
Id String - Database API Keys V2 Schema Cluster Identifier for which this Auth Key is attached field
- collection
Access List<AccountsRules Database Api Key V2Collection Access Rule> - A list of rules granting access to specific collections. Cannot be used with
global_access_rule
. - created
At String - Database API Keys V2 Schema Timestamp when the Auth Key is created field
- created
By StringEmail - Database API Keys V2 Schema Email of the user who created the key field
- expires
At String - Database API Keys V2 Schema Timestamp when the Auth Key expires field
- global
Access AccountsRule Database Api Key V2Global Access Rule - A rule granting global access to the entire database. Cannot be used with
collection_access_rules
. - key String
- Database API Keys V2 Schema Secret key for this Auth Key field
- name String
- Database API Keys V2 Schema Auth Key Name field
- postfix String
- Database API Keys V2 Schema Postfix of the Auth Key field
- account
Id string - Database API Keys V2 Schema Account Identifier field
- cluster
Id string - Database API Keys V2 Schema Cluster Identifier for which this Auth Key is attached field
- collection
Access AccountsRules Database Api Key V2Collection Access Rule[] - A list of rules granting access to specific collections. Cannot be used with
global_access_rule
. - created
At string - Database API Keys V2 Schema Timestamp when the Auth Key is created field
- created
By stringEmail - Database API Keys V2 Schema Email of the user who created the key field
- expires
At string - Database API Keys V2 Schema Timestamp when the Auth Key expires field
- global
Access AccountsRule Database Api Key V2Global Access Rule - A rule granting global access to the entire database. Cannot be used with
collection_access_rules
. - key string
- Database API Keys V2 Schema Secret key for this Auth Key field
- name string
- Database API Keys V2 Schema Auth Key Name field
- postfix string
- Database API Keys V2 Schema Postfix of the Auth Key field
- account_
id str - Database API Keys V2 Schema Account Identifier field
- cluster_
id str - Database API Keys V2 Schema Cluster Identifier for which this Auth Key is attached field
- collection_
access_ Sequence[Accountsrules Database Api Key V2Collection Access Rule Args] - A list of rules granting access to specific collections. Cannot be used with
global_access_rule
. - created_
at str - Database API Keys V2 Schema Timestamp when the Auth Key is created field
- created_
by_ stremail - Database API Keys V2 Schema Email of the user who created the key field
- expires_
at str - Database API Keys V2 Schema Timestamp when the Auth Key expires field
- global_
access_ Accountsrule Database Api Key V2Global Access Rule Args - A rule granting global access to the entire database. Cannot be used with
collection_access_rules
. - key str
- Database API Keys V2 Schema Secret key for this Auth Key field
- name str
- Database API Keys V2 Schema Auth Key Name field
- postfix str
- Database API Keys V2 Schema Postfix of the Auth Key field
- account
Id String - Database API Keys V2 Schema Account Identifier field
- cluster
Id String - Database API Keys V2 Schema Cluster Identifier for which this Auth Key is attached field
- collection
Access List<Property Map>Rules - A list of rules granting access to specific collections. Cannot be used with
global_access_rule
. - created
At String - Database API Keys V2 Schema Timestamp when the Auth Key is created field
- created
By StringEmail - Database API Keys V2 Schema Email of the user who created the key field
- expires
At String - Database API Keys V2 Schema Timestamp when the Auth Key expires field
- global
Access Property MapRule - A rule granting global access to the entire database. Cannot be used with
collection_access_rules
. - key String
- Database API Keys V2 Schema Secret key for this Auth Key field
- name String
- Database API Keys V2 Schema Auth Key Name field
- postfix String
- Database API Keys V2 Schema Postfix of the Auth Key field
Supporting Types
AccountsDatabaseApiKeyV2CollectionAccessRule, AccountsDatabaseApiKeyV2CollectionAccessRuleArgs
- Access
Type string - Access type for the collection. Can be
COLLECTION_ACCESS_RULE_ACCESS_TYPE_READ_ONLY
orCOLLECTION_ACCESS_RULE_ACCESS_TYPE_READ_WRITE
. - Collection
Name string - Name of the collection.
- Payload Dictionary<string, string>
- Payload restrictions.
- Access
Type string - Access type for the collection. Can be
COLLECTION_ACCESS_RULE_ACCESS_TYPE_READ_ONLY
orCOLLECTION_ACCESS_RULE_ACCESS_TYPE_READ_WRITE
. - Collection
Name string - Name of the collection.
- Payload map[string]string
- Payload restrictions.
- access
Type String - Access type for the collection. Can be
COLLECTION_ACCESS_RULE_ACCESS_TYPE_READ_ONLY
orCOLLECTION_ACCESS_RULE_ACCESS_TYPE_READ_WRITE
. - collection
Name String - Name of the collection.
- payload Map<String,String>
- Payload restrictions.
- access
Type string - Access type for the collection. Can be
COLLECTION_ACCESS_RULE_ACCESS_TYPE_READ_ONLY
orCOLLECTION_ACCESS_RULE_ACCESS_TYPE_READ_WRITE
. - collection
Name string - Name of the collection.
- payload {[key: string]: string}
- Payload restrictions.
- access_
type str - Access type for the collection. Can be
COLLECTION_ACCESS_RULE_ACCESS_TYPE_READ_ONLY
orCOLLECTION_ACCESS_RULE_ACCESS_TYPE_READ_WRITE
. - collection_
name str - Name of the collection.
- payload Mapping[str, str]
- Payload restrictions.
- access
Type String - Access type for the collection. Can be
COLLECTION_ACCESS_RULE_ACCESS_TYPE_READ_ONLY
orCOLLECTION_ACCESS_RULE_ACCESS_TYPE_READ_WRITE
. - collection
Name String - Name of the collection.
- payload Map<String>
- Payload restrictions.
AccountsDatabaseApiKeyV2GlobalAccessRule, AccountsDatabaseApiKeyV2GlobalAccessRuleArgs
- Access
Type string - Access type for global access. Can be
GLOBAL_ACCESS_RULE_ACCESS_TYPE_READ_ONLY
orGLOBAL_ACCESS_RULE_ACCESS_TYPE_MANAGE
.
- Access
Type string - Access type for global access. Can be
GLOBAL_ACCESS_RULE_ACCESS_TYPE_READ_ONLY
orGLOBAL_ACCESS_RULE_ACCESS_TYPE_MANAGE
.
- access
Type String - Access type for global access. Can be
GLOBAL_ACCESS_RULE_ACCESS_TYPE_READ_ONLY
orGLOBAL_ACCESS_RULE_ACCESS_TYPE_MANAGE
.
- access
Type string - Access type for global access. Can be
GLOBAL_ACCESS_RULE_ACCESS_TYPE_READ_ONLY
orGLOBAL_ACCESS_RULE_ACCESS_TYPE_MANAGE
.
- access_
type str - Access type for global access. Can be
GLOBAL_ACCESS_RULE_ACCESS_TYPE_READ_ONLY
orGLOBAL_ACCESS_RULE_ACCESS_TYPE_MANAGE
.
- access
Type String - Access type for global access. Can be
GLOBAL_ACCESS_RULE_ACCESS_TYPE_READ_ONLY
orGLOBAL_ACCESS_RULE_ACCESS_TYPE_MANAGE
.
Package Details
- Repository
- qdrant-cloud qdrant/terraform-provider-qdrant-cloud
- License
- Notes
- This Pulumi package is based on the
qdrant-cloud
Terraform Provider.