APIKey

Create a APIKey Resource

new APIKey(name: string, args?: APIKeyArgs, opts?: CustomResourceOptions);

def APIKey(resource_name, opts=None, account_manage_account_settings=None, account_manage_apikeys=None, account_manage_payment_methods=None, account_manage_plan=None, account_manage_teams=None, account_manage_users=None, account_view_activity_log=None, account_view_invoices=None, data_manage_datafeeds=None, data_manage_datasources=None, data_push_to_datafeeds=None, dhcp_manage_dhcp=None, dhcp_view_dhcp=None, dns_manage_zones=None, dns_view_zones=None, dns_zones_allow_by_default=None, dns_zones_allows=None, dns_zones_denies=None, ip_whitelist_strict=None, ip_whitelists=None, ipam_manage_ipam=None, ipam_view_ipam=None, monitoring_manage_jobs=None, monitoring_manage_lists=None, monitoring_view_jobs=None, name=None, security_manage_active_directory=None, security_manage_global2fa=None, teams=None, __props__=None);

func NewAPIKey(ctx *Context, name string, args *APIKeyArgs, opts ...ResourceOption) (*APIKey, error)

public APIKey(string name, APIKeyArgs? args = null, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args APIKeyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args APIKeyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args APIKeyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

APIKey Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The APIKey resource accepts the following input properties:

AccountManageAccountSettings bool: Whether the apikey can modify account settings.
AccountManageApikeys bool: Whether the apikey can modify account apikeys.
AccountManagePaymentMethods bool: Whether the apikey can modify account payment methods.
AccountManagePlan bool: Whether the apikey can modify the account plan.
AccountManageTeams bool: Whether the apikey can modify other teams in the account.
AccountManageUsers bool: Whether the apikey can modify account users.
AccountViewActivityLog bool: Whether the apikey can view activity logs.
AccountViewInvoices bool: Whether the apikey can view invoices.
DataManageDatafeeds bool: Whether the apikey can modify data feeds.
DataManageDatasources bool: Whether the apikey can modify data sources.
DataPushToDatafeeds bool: Whether the apikey can publish to data feeds.
DhcpManageDhcp bool: Whether the apikey can manage DHCP. Only relevant for the DDI product.
DhcpViewDhcp bool: Whether the apikey can view DHCP. Only relevant for the DDI product.
DnsManageZones bool: Whether the apikey can modify the accounts zones.
DnsViewZones bool: Whether the apikey can view the accounts zones.
DnsZonesAllowByDefault bool: If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.
DnsZonesAllows List<string>: List of zones that the apikey may access.
DnsZonesDenies List<string>: List of zones that the apikey may not access.
IpWhitelistStrict bool: Sets exclusivity on this IP whitelist.
IpWhitelists List<string>: The IP addresses to whitelist for this key.
IpamManageIpam bool: Whether the apikey can manage IPAM. Only relevant for the DDI product.
IpamViewIpam bool: Whether the apikey can view IPAM. Only relevant for the DDI product.
MonitoringManageJobs bool: Whether the apikey can modify monitoring jobs.
MonitoringManageLists bool: Whether the apikey can modify notification lists.
MonitoringViewJobs bool: Whether the apikey can view monitoring jobs.
Name string: The free form name of the apikey.
SecurityManageActiveDirectory bool: Whether the apikey can manage global active directory. Only relevant for the DDI product.
SecurityManageGlobal2fa bool: Whether the apikey can manage global two factor authentication.
Teams List<string>: The teams that the apikey belongs to.

AccountManageAccountSettings bool: Whether the apikey can modify account settings.
AccountManageApikeys bool: Whether the apikey can modify account apikeys.
AccountManagePaymentMethods bool: Whether the apikey can modify account payment methods.
AccountManagePlan bool: Whether the apikey can modify the account plan.
AccountManageTeams bool: Whether the apikey can modify other teams in the account.
AccountManageUsers bool: Whether the apikey can modify account users.
AccountViewActivityLog bool: Whether the apikey can view activity logs.
AccountViewInvoices bool: Whether the apikey can view invoices.
DataManageDatafeeds bool: Whether the apikey can modify data feeds.
DataManageDatasources bool: Whether the apikey can modify data sources.
DataPushToDatafeeds bool: Whether the apikey can publish to data feeds.
DhcpManageDhcp bool: Whether the apikey can manage DHCP. Only relevant for the DDI product.
DhcpViewDhcp bool: Whether the apikey can view DHCP. Only relevant for the DDI product.
DnsManageZones bool: Whether the apikey can modify the accounts zones.
DnsViewZones bool: Whether the apikey can view the accounts zones.
DnsZonesAllowByDefault bool: If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.
DnsZonesAllows []string: List of zones that the apikey may access.
DnsZonesDenies []string: List of zones that the apikey may not access.
IpWhitelistStrict bool: Sets exclusivity on this IP whitelist.
IpWhitelists []string: The IP addresses to whitelist for this key.
IpamManageIpam bool: Whether the apikey can manage IPAM. Only relevant for the DDI product.
IpamViewIpam bool: Whether the apikey can view IPAM. Only relevant for the DDI product.
MonitoringManageJobs bool: Whether the apikey can modify monitoring jobs.
MonitoringManageLists bool: Whether the apikey can modify notification lists.
MonitoringViewJobs bool: Whether the apikey can view monitoring jobs.
Name string: The free form name of the apikey.
SecurityManageActiveDirectory bool: Whether the apikey can manage global active directory. Only relevant for the DDI product.
SecurityManageGlobal2fa bool: Whether the apikey can manage global two factor authentication.
Teams []string: The teams that the apikey belongs to.

accountManageAccountSettings boolean: Whether the apikey can modify account settings.
accountManageApikeys boolean: Whether the apikey can modify account apikeys.
accountManagePaymentMethods boolean: Whether the apikey can modify account payment methods.
accountManagePlan boolean: Whether the apikey can modify the account plan.
accountManageTeams boolean: Whether the apikey can modify other teams in the account.
accountManageUsers boolean: Whether the apikey can modify account users.
accountViewActivityLog boolean: Whether the apikey can view activity logs.
accountViewInvoices boolean: Whether the apikey can view invoices.
dataManageDatafeeds boolean: Whether the apikey can modify data feeds.
dataManageDatasources boolean: Whether the apikey can modify data sources.
dataPushToDatafeeds boolean: Whether the apikey can publish to data feeds.
dhcpManageDhcp boolean: Whether the apikey can manage DHCP. Only relevant for the DDI product.
dhcpViewDhcp boolean: Whether the apikey can view DHCP. Only relevant for the DDI product.
dnsManageZones boolean: Whether the apikey can modify the accounts zones.
dnsViewZones boolean: Whether the apikey can view the accounts zones.
dnsZonesAllowByDefault boolean: If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.
dnsZonesAllows string[]: List of zones that the apikey may access.
dnsZonesDenies string[]: List of zones that the apikey may not access.
ipWhitelistStrict boolean: Sets exclusivity on this IP whitelist.
ipWhitelists string[]: The IP addresses to whitelist for this key.
ipamManageIpam boolean: Whether the apikey can manage IPAM. Only relevant for the DDI product.
ipamViewIpam boolean: Whether the apikey can view IPAM. Only relevant for the DDI product.
monitoringManageJobs boolean: Whether the apikey can modify monitoring jobs.
monitoringManageLists boolean: Whether the apikey can modify notification lists.
monitoringViewJobs boolean: Whether the apikey can view monitoring jobs.
name string: The free form name of the apikey.
securityManageActiveDirectory boolean: Whether the apikey can manage global active directory. Only relevant for the DDI product.
securityManageGlobal2fa boolean: Whether the apikey can manage global two factor authentication.
teams string[]: The teams that the apikey belongs to.

account_manage_account_settings bool: Whether the apikey can modify account settings.
account_manage_apikeys bool: Whether the apikey can modify account apikeys.
account_manage_payment_methods bool: Whether the apikey can modify account payment methods.
account_manage_plan bool: Whether the apikey can modify the account plan.
account_manage_teams bool: Whether the apikey can modify other teams in the account.
account_manage_users bool: Whether the apikey can modify account users.
account_view_activity_log bool: Whether the apikey can view activity logs.
account_view_invoices bool: Whether the apikey can view invoices.
data_manage_datafeeds bool: Whether the apikey can modify data feeds.
data_manage_datasources bool: Whether the apikey can modify data sources.
data_push_to_datafeeds bool: Whether the apikey can publish to data feeds.
dhcp_manage_dhcp bool: Whether the apikey can manage DHCP. Only relevant for the DDI product.
dhcp_view_dhcp bool: Whether the apikey can view DHCP. Only relevant for the DDI product.
dns_manage_zones bool: Whether the apikey can modify the accounts zones.
dns_view_zones bool: Whether the apikey can view the accounts zones.
dns_zones_allow_by_default bool: If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.
dns_zones_allows List[str]: List of zones that the apikey may access.
dns_zones_denies List[str]: List of zones that the apikey may not access.
ip_whitelist_strict bool: Sets exclusivity on this IP whitelist.
ip_whitelists List[str]: The IP addresses to whitelist for this key.
ipam_manage_ipam bool: Whether the apikey can manage IPAM. Only relevant for the DDI product.
ipam_view_ipam bool: Whether the apikey can view IPAM. Only relevant for the DDI product.
monitoring_manage_jobs bool: Whether the apikey can modify monitoring jobs.
monitoring_manage_lists bool: Whether the apikey can modify notification lists.
monitoring_view_jobs bool: Whether the apikey can view monitoring jobs.
name str: The free form name of the apikey.
security_manage_active_directory bool: Whether the apikey can manage global active directory. Only relevant for the DDI product.
security_manage_global2fa bool: Whether the apikey can manage global two factor authentication.
teams List[str]: The teams that the apikey belongs to.

Outputs

All input properties are implicitly available as output properties. Additionally, the APIKey resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
Key string: The apikeys authentication token.

Id string: The provider-assigned unique ID for this managed resource.
Key string: The apikeys authentication token.

id string: The provider-assigned unique ID for this managed resource.
key string: The apikeys authentication token.

id str: The provider-assigned unique ID for this managed resource.
key str: The apikeys authentication token.

Look up an Existing APIKey Resource

Get an existing APIKey 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?: APIKeyState, opts?: CustomResourceOptions): APIKey

static get(resource_name, id, opts=None, account_manage_account_settings=None, account_manage_apikeys=None, account_manage_payment_methods=None, account_manage_plan=None, account_manage_teams=None, account_manage_users=None, account_view_activity_log=None, account_view_invoices=None, data_manage_datafeeds=None, data_manage_datasources=None, data_push_to_datafeeds=None, dhcp_manage_dhcp=None, dhcp_view_dhcp=None, dns_manage_zones=None, dns_view_zones=None, dns_zones_allow_by_default=None, dns_zones_allows=None, dns_zones_denies=None, ip_whitelist_strict=None, ip_whitelists=None, ipam_manage_ipam=None, ipam_view_ipam=None, key=None, monitoring_manage_jobs=None, monitoring_manage_lists=None, monitoring_view_jobs=None, name=None, security_manage_active_directory=None, security_manage_global2fa=None, teams=None, __props__=None);

func GetAPIKey(ctx *Context, name string, id IDInput, state *APIKeyState, opts ...ResourceOption) (*APIKey, error)

public static APIKey Get(string name, Input<string> id, APIKeyState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

AccountManageAccountSettings bool: Whether the apikey can modify account settings.
AccountManageApikeys bool: Whether the apikey can modify account apikeys.
AccountManagePaymentMethods bool: Whether the apikey can modify account payment methods.
AccountManagePlan bool: Whether the apikey can modify the account plan.
AccountManageTeams bool: Whether the apikey can modify other teams in the account.
AccountManageUsers bool: Whether the apikey can modify account users.
AccountViewActivityLog bool: Whether the apikey can view activity logs.
AccountViewInvoices bool: Whether the apikey can view invoices.
DataManageDatafeeds bool: Whether the apikey can modify data feeds.
DataManageDatasources bool: Whether the apikey can modify data sources.
DataPushToDatafeeds bool: Whether the apikey can publish to data feeds.
DhcpManageDhcp bool: Whether the apikey can manage DHCP. Only relevant for the DDI product.
DhcpViewDhcp bool: Whether the apikey can view DHCP. Only relevant for the DDI product.
DnsManageZones bool: Whether the apikey can modify the accounts zones.
DnsViewZones bool: Whether the apikey can view the accounts zones.
DnsZonesAllowByDefault bool: If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.
DnsZonesAllows List<string>: List of zones that the apikey may access.
DnsZonesDenies List<string>: List of zones that the apikey may not access.
IpWhitelistStrict bool: Sets exclusivity on this IP whitelist.
IpWhitelists List<string>: The IP addresses to whitelist for this key.
IpamManageIpam bool: Whether the apikey can manage IPAM. Only relevant for the DDI product.
IpamViewIpam bool: Whether the apikey can view IPAM. Only relevant for the DDI product.
Key string: The apikeys authentication token.
MonitoringManageJobs bool: Whether the apikey can modify monitoring jobs.
MonitoringManageLists bool: Whether the apikey can modify notification lists.
MonitoringViewJobs bool: Whether the apikey can view monitoring jobs.
Name string: The free form name of the apikey.
SecurityManageActiveDirectory bool: Whether the apikey can manage global active directory. Only relevant for the DDI product.
SecurityManageGlobal2fa bool: Whether the apikey can manage global two factor authentication.
Teams List<string>: The teams that the apikey belongs to.

AccountManageAccountSettings bool: Whether the apikey can modify account settings.
AccountManageApikeys bool: Whether the apikey can modify account apikeys.
AccountManagePaymentMethods bool: Whether the apikey can modify account payment methods.
AccountManagePlan bool: Whether the apikey can modify the account plan.
AccountManageTeams bool: Whether the apikey can modify other teams in the account.
AccountManageUsers bool: Whether the apikey can modify account users.
AccountViewActivityLog bool: Whether the apikey can view activity logs.
AccountViewInvoices bool: Whether the apikey can view invoices.
DataManageDatafeeds bool: Whether the apikey can modify data feeds.
DataManageDatasources bool: Whether the apikey can modify data sources.
DataPushToDatafeeds bool: Whether the apikey can publish to data feeds.
DhcpManageDhcp bool: Whether the apikey can manage DHCP. Only relevant for the DDI product.
DhcpViewDhcp bool: Whether the apikey can view DHCP. Only relevant for the DDI product.
DnsManageZones bool: Whether the apikey can modify the accounts zones.
DnsViewZones bool: Whether the apikey can view the accounts zones.
DnsZonesAllowByDefault bool: If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.
DnsZonesAllows []string: List of zones that the apikey may access.
DnsZonesDenies []string: List of zones that the apikey may not access.
IpWhitelistStrict bool: Sets exclusivity on this IP whitelist.
IpWhitelists []string: The IP addresses to whitelist for this key.
IpamManageIpam bool: Whether the apikey can manage IPAM. Only relevant for the DDI product.
IpamViewIpam bool: Whether the apikey can view IPAM. Only relevant for the DDI product.
Key string: The apikeys authentication token.
MonitoringManageJobs bool: Whether the apikey can modify monitoring jobs.
MonitoringManageLists bool: Whether the apikey can modify notification lists.
MonitoringViewJobs bool: Whether the apikey can view monitoring jobs.
Name string: The free form name of the apikey.
SecurityManageActiveDirectory bool: Whether the apikey can manage global active directory. Only relevant for the DDI product.
SecurityManageGlobal2fa bool: Whether the apikey can manage global two factor authentication.
Teams []string: The teams that the apikey belongs to.

accountManageAccountSettings boolean: Whether the apikey can modify account settings.
accountManageApikeys boolean: Whether the apikey can modify account apikeys.
accountManagePaymentMethods boolean: Whether the apikey can modify account payment methods.
accountManagePlan boolean: Whether the apikey can modify the account plan.
accountManageTeams boolean: Whether the apikey can modify other teams in the account.
accountManageUsers boolean: Whether the apikey can modify account users.
accountViewActivityLog boolean: Whether the apikey can view activity logs.
accountViewInvoices boolean: Whether the apikey can view invoices.
dataManageDatafeeds boolean: Whether the apikey can modify data feeds.
dataManageDatasources boolean: Whether the apikey can modify data sources.
dataPushToDatafeeds boolean: Whether the apikey can publish to data feeds.
dhcpManageDhcp boolean: Whether the apikey can manage DHCP. Only relevant for the DDI product.
dhcpViewDhcp boolean: Whether the apikey can view DHCP. Only relevant for the DDI product.
dnsManageZones boolean: Whether the apikey can modify the accounts zones.
dnsViewZones boolean: Whether the apikey can view the accounts zones.
dnsZonesAllowByDefault boolean: If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.
dnsZonesAllows string[]: List of zones that the apikey may access.
dnsZonesDenies string[]: List of zones that the apikey may not access.
ipWhitelistStrict boolean: Sets exclusivity on this IP whitelist.
ipWhitelists string[]: The IP addresses to whitelist for this key.
ipamManageIpam boolean: Whether the apikey can manage IPAM. Only relevant for the DDI product.
ipamViewIpam boolean: Whether the apikey can view IPAM. Only relevant for the DDI product.
key string: The apikeys authentication token.
monitoringManageJobs boolean: Whether the apikey can modify monitoring jobs.
monitoringManageLists boolean: Whether the apikey can modify notification lists.
monitoringViewJobs boolean: Whether the apikey can view monitoring jobs.
name string: The free form name of the apikey.
securityManageActiveDirectory boolean: Whether the apikey can manage global active directory. Only relevant for the DDI product.
securityManageGlobal2fa boolean: Whether the apikey can manage global two factor authentication.
teams string[]: The teams that the apikey belongs to.

account_manage_account_settings bool: Whether the apikey can modify account settings.
account_manage_apikeys bool: Whether the apikey can modify account apikeys.
account_manage_payment_methods bool: Whether the apikey can modify account payment methods.
account_manage_plan bool: Whether the apikey can modify the account plan.
account_manage_teams bool: Whether the apikey can modify other teams in the account.
account_manage_users bool: Whether the apikey can modify account users.
account_view_activity_log bool: Whether the apikey can view activity logs.
account_view_invoices bool: Whether the apikey can view invoices.
data_manage_datafeeds bool: Whether the apikey can modify data feeds.
data_manage_datasources bool: Whether the apikey can modify data sources.
data_push_to_datafeeds bool: Whether the apikey can publish to data feeds.
dhcp_manage_dhcp bool: Whether the apikey can manage DHCP. Only relevant for the DDI product.
dhcp_view_dhcp bool: Whether the apikey can view DHCP. Only relevant for the DDI product.
dns_manage_zones bool: Whether the apikey can modify the accounts zones.
dns_view_zones bool: Whether the apikey can view the accounts zones.
dns_zones_allow_by_default bool: If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.
dns_zones_allows List[str]: List of zones that the apikey may access.
dns_zones_denies List[str]: List of zones that the apikey may not access.
ip_whitelist_strict bool: Sets exclusivity on this IP whitelist.
ip_whitelists List[str]: The IP addresses to whitelist for this key.
ipam_manage_ipam bool: Whether the apikey can manage IPAM. Only relevant for the DDI product.
ipam_view_ipam bool: Whether the apikey can view IPAM. Only relevant for the DDI product.
key str: The apikeys authentication token.
monitoring_manage_jobs bool: Whether the apikey can modify monitoring jobs.
monitoring_manage_lists bool: Whether the apikey can modify notification lists.
monitoring_view_jobs bool: Whether the apikey can view monitoring jobs.
name str: The free form name of the apikey.
security_manage_active_directory bool: Whether the apikey can manage global active directory. Only relevant for the DDI product.
security_manage_global2fa bool: Whether the apikey can manage global two factor authentication.
teams List[str]: The teams that the apikey belongs to.

Package Details

Repository: https://github.com/pulumi/pulumi-ns1
License: Apache-2.0
Notes: This Pulumi package is based on the ns1 Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud