InfluxDb
# InfluxDB Resource
The InfluxDB resource allows the creation and management of Aiven InfluxDB services.
Example Usage
using Pulumi;
using Aiven = Pulumi.Aiven;
class MyStack : Stack
{
public MyStack()
{
var inf1 = new Aiven.InfluxDb("inf1", new Aiven.InfluxDbArgs
{
Project = data.Aiven_project.Pr1.Project,
CloudName = "google-europe-west1",
Plan = "startup-4",
ServiceName = "my-inf1",
MaintenanceWindowDow = "monday",
MaintenanceWindowTime = "10:00:00",
InfluxdbUserConfig = new Aiven.Inputs.InfluxDbInfluxdbUserConfigArgs
{
PublicAccess = new Aiven.Inputs.InfluxDbInfluxdbUserConfigPublicAccessArgs
{
Influxdb = "true",
},
},
});
}
}
package main
import (
"github.com/pulumi/pulumi-aiven/sdk/v3/go/aiven"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := aiven.NewInfluxDb(ctx, "inf1", &aiven.InfluxDbArgs{
Project: pulumi.Any(data.Aiven_project.Pr1.Project),
CloudName: pulumi.String("google-europe-west1"),
Plan: pulumi.String("startup-4"),
ServiceName: pulumi.String("my-inf1"),
MaintenanceWindowDow: pulumi.String("monday"),
MaintenanceWindowTime: pulumi.String("10:00:00"),
InfluxdbUserConfig: &aiven.InfluxDbInfluxdbUserConfigArgs{
PublicAccess: &aiven.InfluxDbInfluxdbUserConfigPublicAccessArgs{
Influxdb: pulumi.String("true"),
},
},
})
if err != nil {
return err
}
return nil
})
}
import pulumi
import pulumi_aiven as aiven
inf1 = aiven.InfluxDb("inf1",
project=data["aiven_project"]["pr1"]["project"],
cloud_name="google-europe-west1",
plan="startup-4",
service_name="my-inf1",
maintenance_window_dow="monday",
maintenance_window_time="10:00:00",
influxdb_user_config=aiven.InfluxDbInfluxdbUserConfigArgs(
public_access=aiven.InfluxDbInfluxdbUserConfigPublicAccessArgs(
influxdb="true",
),
))
import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";
const inf1 = new aiven.InfluxDb("inf1", {
project: data.aiven_project.pr1.project,
cloudName: "google-europe-west1",
plan: "startup-4",
serviceName: "my-inf1",
maintenanceWindowDow: "monday",
maintenanceWindowTime: "10:00:00",
influxdbUserConfig: {
publicAccess: {
influxdb: true,
},
},
});
Create a InfluxDb Resource
new InfluxDb(name: string, args: InfluxDbArgs, opts?: CustomResourceOptions);
def InfluxDb(resource_name: str, opts: Optional[ResourceOptions] = None, cloud_name: Optional[str] = None, influxdb: Optional[InfluxDbInfluxdbArgs] = None, influxdb_user_config: Optional[InfluxDbInfluxdbUserConfigArgs] = None, maintenance_window_dow: Optional[str] = None, maintenance_window_time: Optional[str] = None, plan: Optional[str] = None, project: Optional[str] = None, project_vpc_id: Optional[str] = None, service_integrations: Optional[Sequence[InfluxDbServiceIntegrationArgs]] = None, service_name: Optional[str] = None, termination_protection: Optional[bool] = None)
func NewInfluxDb(ctx *Context, name string, args InfluxDbArgs, opts ...ResourceOption) (*InfluxDb, error)
public InfluxDb(string name, InfluxDbArgs args, CustomResourceOptions? opts = null)
- name string
- The unique name of the resource.
- args InfluxDbArgs
- 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 InfluxDbArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args InfluxDbArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
InfluxDb Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The InfluxDb resource accepts the following input properties:
- Project string
identifies the project the service belongs to. To set up proper dependency between the project and the service, refer to the project as shown in the above example. Project cannot be changed later without destroying and re-creating the service.
- Service
Name string specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- Cloud
Name string defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider’s own support articles, like here for Google and here for AWS.- Influxdb
Influx
Db Influxdb Args influxdb.conf configuration values
- Influxdb
User InfluxConfig Db Influxdb User Config Args defines InfluxDB specific additional configuration options. The following configuration options available:
- Maintenance
Window stringDow day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- Plan string
defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist
,startup-x
,business-x
andpremium-x
wherex
is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The exact options can be seen from the Aiven web console’s Create Service dialog.- Project
Vpc stringId optionally specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- Service
Integrations List<InfluxDb Service Integration Args> Service integrations to specify when creating a service. Not applied after initial service creation
- Termination
Protection bool prevents the service from being deleted. It is recommended to set this to
true
for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
- Project string
identifies the project the service belongs to. To set up proper dependency between the project and the service, refer to the project as shown in the above example. Project cannot be changed later without destroying and re-creating the service.
- Service
Name string specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- Cloud
Name string defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider’s own support articles, like here for Google and here for AWS.- Influxdb
Influx
Db Influxdb influxdb.conf configuration values
- Influxdb
User InfluxConfig Db Influxdb User Config defines InfluxDB specific additional configuration options. The following configuration options available:
- Maintenance
Window stringDow day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- Plan string
defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist
,startup-x
,business-x
andpremium-x
wherex
is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The exact options can be seen from the Aiven web console’s Create Service dialog.- Project
Vpc stringId optionally specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- Service
Integrations []InfluxDb Service Integration Service integrations to specify when creating a service. Not applied after initial service creation
- Termination
Protection bool prevents the service from being deleted. It is recommended to set this to
true
for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
- project string
identifies the project the service belongs to. To set up proper dependency between the project and the service, refer to the project as shown in the above example. Project cannot be changed later without destroying and re-creating the service.
- service
Name string specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- cloud
Name string defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider’s own support articles, like here for Google and here for AWS.- influxdb
Influx
Db Influxdb influxdb.conf configuration values
- influxdb
User InfluxConfig Db Influxdb User Config defines InfluxDB specific additional configuration options. The following configuration options available:
- maintenance
Window stringDow day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.
- maintenance
Window stringTime time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- plan string
defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist
,startup-x
,business-x
andpremium-x
wherex
is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The exact options can be seen from the Aiven web console’s Create Service dialog.- project
Vpc stringId optionally specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- service
Integrations InfluxDb Service Integration[] Service integrations to specify when creating a service. Not applied after initial service creation
- termination
Protection boolean prevents the service from being deleted. It is recommended to set this to
true
for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
- project str
identifies the project the service belongs to. To set up proper dependency between the project and the service, refer to the project as shown in the above example. Project cannot be changed later without destroying and re-creating the service.
- service_
name str specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- cloud_
name str defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider’s own support articles, like here for Google and here for AWS.- influxdb
Influx
Db Influxdb Args influxdb.conf configuration values
- influxdb_
user_ Influxconfig Db Influxdb User Config Args defines InfluxDB specific additional configuration options. The following configuration options available:
- maintenance_
window_ strdow day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.
- maintenance_
window_ strtime time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- plan str
defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist
,startup-x
,business-x
andpremium-x
wherex
is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The exact options can be seen from the Aiven web console’s Create Service dialog.- project_
vpc_ strid optionally specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- service_
integrations Sequence[InfluxDb Service Integration Args] Service integrations to specify when creating a service. Not applied after initial service creation
- termination_
protection bool prevents the service from being deleted. It is recommended to set this to
true
for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
Outputs
All input properties are implicitly available as output properties. Additionally, the InfluxDb resource produces the following output properties:
- Components
List<Influx
Db Component> Service component information objects
- Id string
- The provider-assigned unique ID for this managed resource.
- Service
Host string InfluxDB hostname.
- Service
Password string Password used for connecting to the InfluxDB service, if applicable.
- Service
Port int InfluxDB port.
- Service
Type string Aiven internal service type code
- Service
Uri string URI for connecting to the InfluxDB service.
- Service
Username string Username used for connecting to the InfluxDB service, if applicable.
- State string
Service state.
- Components
[]Influx
Db Component Service component information objects
- Id string
- The provider-assigned unique ID for this managed resource.
- Service
Host string InfluxDB hostname.
- Service
Password string Password used for connecting to the InfluxDB service, if applicable.
- Service
Port int InfluxDB port.
- Service
Type string Aiven internal service type code
- Service
Uri string URI for connecting to the InfluxDB service.
- Service
Username string Username used for connecting to the InfluxDB service, if applicable.
- State string
Service state.
- components
Influx
Db Component[] Service component information objects
- id string
- The provider-assigned unique ID for this managed resource.
- service
Host string InfluxDB hostname.
- service
Password string Password used for connecting to the InfluxDB service, if applicable.
- service
Port number InfluxDB port.
- service
Type string Aiven internal service type code
- service
Uri string URI for connecting to the InfluxDB service.
- service
Username string Username used for connecting to the InfluxDB service, if applicable.
- state string
Service state.
- components
Sequence[Influx
Db Component] Service component information objects
- id str
- The provider-assigned unique ID for this managed resource.
- service_
host str InfluxDB hostname.
- service_
password str Password used for connecting to the InfluxDB service, if applicable.
- service_
port int InfluxDB port.
- service_
type str Aiven internal service type code
- service_
uri str URI for connecting to the InfluxDB service.
- service_
username str Username used for connecting to the InfluxDB service, if applicable.
- state str
Service state.
Look up an Existing InfluxDb Resource
Get an existing InfluxDb 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?: InfluxDbState, opts?: CustomResourceOptions): InfluxDb
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, cloud_name: Optional[str] = None, components: Optional[Sequence[InfluxDbComponentArgs]] = None, influxdb: Optional[InfluxDbInfluxdbArgs] = None, influxdb_user_config: Optional[InfluxDbInfluxdbUserConfigArgs] = None, maintenance_window_dow: Optional[str] = None, maintenance_window_time: Optional[str] = None, plan: Optional[str] = None, project: Optional[str] = None, project_vpc_id: Optional[str] = None, service_host: Optional[str] = None, service_integrations: Optional[Sequence[InfluxDbServiceIntegrationArgs]] = None, service_name: Optional[str] = None, service_password: Optional[str] = None, service_port: Optional[int] = None, service_type: Optional[str] = None, service_uri: Optional[str] = None, service_username: Optional[str] = None, state: Optional[str] = None, termination_protection: Optional[bool] = None) -> InfluxDb
func GetInfluxDb(ctx *Context, name string, id IDInput, state *InfluxDbState, opts ...ResourceOption) (*InfluxDb, error)
public static InfluxDb Get(string name, Input<string> id, InfluxDbState? 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:
- Cloud
Name string defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider’s own support articles, like here for Google and here for AWS.- Components
List<Influx
Db Component Args> Service component information objects
- Influxdb
Influx
Db Influxdb Args influxdb.conf configuration values
- Influxdb
User InfluxConfig Db Influxdb User Config Args defines InfluxDB specific additional configuration options. The following configuration options available:
- Maintenance
Window stringDow day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- Plan string
defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist
,startup-x
,business-x
andpremium-x
wherex
is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The exact options can be seen from the Aiven web console’s Create Service dialog.- Project string
identifies the project the service belongs to. To set up proper dependency between the project and the service, refer to the project as shown in the above example. Project cannot be changed later without destroying and re-creating the service.
- Project
Vpc stringId optionally specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- Service
Host string InfluxDB hostname.
- Service
Integrations List<InfluxDb Service Integration Args> Service integrations to specify when creating a service. Not applied after initial service creation
- Service
Name string specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- Service
Password string Password used for connecting to the InfluxDB service, if applicable.
- Service
Port int InfluxDB port.
- Service
Type string Aiven internal service type code
- Service
Uri string URI for connecting to the InfluxDB service.
- Service
Username string Username used for connecting to the InfluxDB service, if applicable.
- State string
Service state.
- Termination
Protection bool prevents the service from being deleted. It is recommended to set this to
true
for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
- Cloud
Name string defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider’s own support articles, like here for Google and here for AWS.- Components
[]Influx
Db Component Service component information objects
- Influxdb
Influx
Db Influxdb influxdb.conf configuration values
- Influxdb
User InfluxConfig Db Influxdb User Config defines InfluxDB specific additional configuration options. The following configuration options available:
- Maintenance
Window stringDow day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- Plan string
defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist
,startup-x
,business-x
andpremium-x
wherex
is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The exact options can be seen from the Aiven web console’s Create Service dialog.- Project string
identifies the project the service belongs to. To set up proper dependency between the project and the service, refer to the project as shown in the above example. Project cannot be changed later without destroying and re-creating the service.
- Project
Vpc stringId optionally specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- Service
Host string InfluxDB hostname.
- Service
Integrations []InfluxDb Service Integration Service integrations to specify when creating a service. Not applied after initial service creation
- Service
Name string specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- Service
Password string Password used for connecting to the InfluxDB service, if applicable.
- Service
Port int InfluxDB port.
- Service
Type string Aiven internal service type code
- Service
Uri string URI for connecting to the InfluxDB service.
- Service
Username string Username used for connecting to the InfluxDB service, if applicable.
- State string
Service state.
- Termination
Protection bool prevents the service from being deleted. It is recommended to set this to
true
for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
- cloud
Name string defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider’s own support articles, like here for Google and here for AWS.- components
Influx
Db Component[] Service component information objects
- influxdb
Influx
Db Influxdb influxdb.conf configuration values
- influxdb
User InfluxConfig Db Influxdb User Config defines InfluxDB specific additional configuration options. The following configuration options available:
- maintenance
Window stringDow day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.
- maintenance
Window stringTime time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- plan string
defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist
,startup-x
,business-x
andpremium-x
wherex
is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The exact options can be seen from the Aiven web console’s Create Service dialog.- project string
identifies the project the service belongs to. To set up proper dependency between the project and the service, refer to the project as shown in the above example. Project cannot be changed later without destroying and re-creating the service.
- project
Vpc stringId optionally specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- service
Host string InfluxDB hostname.
- service
Integrations InfluxDb Service Integration[] Service integrations to specify when creating a service. Not applied after initial service creation
- service
Name string specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- service
Password string Password used for connecting to the InfluxDB service, if applicable.
- service
Port number InfluxDB port.
- service
Type string Aiven internal service type code
- service
Uri string URI for connecting to the InfluxDB service.
- service
Username string Username used for connecting to the InfluxDB service, if applicable.
- state string
Service state.
- termination
Protection boolean prevents the service from being deleted. It is recommended to set this to
true
for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
- cloud_
name str defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider’s own support articles, like here for Google and here for AWS.- components
Sequence[Influx
Db Component Args] Service component information objects
- influxdb
Influx
Db Influxdb Args influxdb.conf configuration values
- influxdb_
user_ Influxconfig Db Influxdb User Config Args defines InfluxDB specific additional configuration options. The following configuration options available:
- maintenance_
window_ strdow day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.
- maintenance_
window_ strtime time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- plan str
defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist
,startup-x
,business-x
andpremium-x
wherex
is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The exact options can be seen from the Aiven web console’s Create Service dialog.- project str
identifies the project the service belongs to. To set up proper dependency between the project and the service, refer to the project as shown in the above example. Project cannot be changed later without destroying and re-creating the service.
- project_
vpc_ strid optionally specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- service_
host str InfluxDB hostname.
- service_
integrations Sequence[InfluxDb Service Integration Args] Service integrations to specify when creating a service. Not applied after initial service creation
- service_
name str specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- service_
password str Password used for connecting to the InfluxDB service, if applicable.
- service_
port int InfluxDB port.
- service_
type str Aiven internal service type code
- service_
uri str URI for connecting to the InfluxDB service.
- service_
username str Username used for connecting to the InfluxDB service, if applicable.
- state str
Service state.
- termination_
protection bool prevents the service from being deleted. It is recommended to set this to
true
for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
Supporting Types
InfluxDbComponent
InfluxDbInfluxdb
- Database
Name string
- Database
Name string
- database
Name string
- database_
name str
InfluxDbInfluxdbUserConfig
- Custom
Domain string Serve the web frontend using a custom CNAME pointing to the Aiven DNS name
- Influxdb
Influx
Db Influxdb User Config Influxdb Args influxdb.conf configuration values
- Ip
Filters List<string> allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- Private
Access InfluxDb Influxdb User Config Private Access Args Allow access to selected service ports from private networks
- Project
To stringFork From Name of another project to fork a service from. This has effect only when a new service is being created.
- Public
Access InfluxDb Influxdb User Config Public Access Args Allow access to selected service ports from the public Internet
- Recovery
Basebackup stringName Name of the basebackup to restore in forked service
- Service
To stringFork From Name of another service to fork from. This has effect only when a new service is being created.
- Custom
Domain string Serve the web frontend using a custom CNAME pointing to the Aiven DNS name
- Influxdb
Influx
Db Influxdb User Config Influxdb influxdb.conf configuration values
- Ip
Filters []string allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- Private
Access InfluxDb Influxdb User Config Private Access Allow access to selected service ports from private networks
- Project
To stringFork From Name of another project to fork a service from. This has effect only when a new service is being created.
- Public
Access InfluxDb Influxdb User Config Public Access Allow access to selected service ports from the public Internet
- Recovery
Basebackup stringName Name of the basebackup to restore in forked service
- Service
To stringFork From Name of another service to fork from. This has effect only when a new service is being created.
- custom
Domain string Serve the web frontend using a custom CNAME pointing to the Aiven DNS name
- influxdb
Influx
Db Influxdb User Config Influxdb influxdb.conf configuration values
- ip
Filters string[] allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- private
Access InfluxDb Influxdb User Config Private Access Allow access to selected service ports from private networks
- project
To stringFork From Name of another project to fork a service from. This has effect only when a new service is being created.
- public
Access InfluxDb Influxdb User Config Public Access Allow access to selected service ports from the public Internet
- recovery
Basebackup stringName Name of the basebackup to restore in forked service
- service
To stringFork From Name of another service to fork from. This has effect only when a new service is being created.
- custom_
domain str Serve the web frontend using a custom CNAME pointing to the Aiven DNS name
- influxdb
Influx
Db Influxdb User Config Influxdb Args influxdb.conf configuration values
- ip_
filters Sequence[str] allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- private_
access InfluxDb Influxdb User Config Private Access Args Allow access to selected service ports from private networks
- project_
to_ strfork_ from Name of another project to fork a service from. This has effect only when a new service is being created.
- public_
access InfluxDb Influxdb User Config Public Access Args Allow access to selected service ports from the public Internet
- recovery_
basebackup_ strname Name of the basebackup to restore in forked service
- service_
to_ strfork_ from Name of another service to fork from. This has effect only when a new service is being created.
InfluxDbInfluxdbUserConfigInfluxdb
- Log
Queries stringAfter The maximum duration in seconds before a query is logged as a slow query. Setting this to 0 (the default) will never log slow queries.
- Max
Row stringLimit The maximum number of rows returned in a non-chunked query. Setting this to 0 (the default) allows an unlimited number to be returned.
- Max
Select stringBuckets The maximum number of
GROUP BY time()
buckets that can be processed in a query. Setting this to 0 (the default) allows an unlimited number to be processed.- Max
Select stringPoint The maximum number of points that can be processed in a SELECT statement. Setting this to 0 (the default) allows an unlimited number to be processed.
- Query
Timeout string The maximum duration in seconds before a query is killed. Setting this to 0 (the default) will never kill slow queries.
- Log
Queries stringAfter The maximum duration in seconds before a query is logged as a slow query. Setting this to 0 (the default) will never log slow queries.
- Max
Row stringLimit The maximum number of rows returned in a non-chunked query. Setting this to 0 (the default) allows an unlimited number to be returned.
- Max
Select stringBuckets The maximum number of
GROUP BY time()
buckets that can be processed in a query. Setting this to 0 (the default) allows an unlimited number to be processed.- Max
Select stringPoint The maximum number of points that can be processed in a SELECT statement. Setting this to 0 (the default) allows an unlimited number to be processed.
- Query
Timeout string The maximum duration in seconds before a query is killed. Setting this to 0 (the default) will never kill slow queries.
- log
Queries stringAfter The maximum duration in seconds before a query is logged as a slow query. Setting this to 0 (the default) will never log slow queries.
- max
Row stringLimit The maximum number of rows returned in a non-chunked query. Setting this to 0 (the default) allows an unlimited number to be returned.
- max
Select stringBuckets The maximum number of
GROUP BY time()
buckets that can be processed in a query. Setting this to 0 (the default) allows an unlimited number to be processed.- max
Select stringPoint The maximum number of points that can be processed in a SELECT statement. Setting this to 0 (the default) allows an unlimited number to be processed.
- query
Timeout string The maximum duration in seconds before a query is killed. Setting this to 0 (the default) will never kill slow queries.
- log_
queries_ strafter The maximum duration in seconds before a query is logged as a slow query. Setting this to 0 (the default) will never log slow queries.
- max_
row_ strlimit The maximum number of rows returned in a non-chunked query. Setting this to 0 (the default) allows an unlimited number to be returned.
- max_
select_ strbuckets The maximum number of
GROUP BY time()
buckets that can be processed in a query. Setting this to 0 (the default) allows an unlimited number to be processed.- max_
select_ strpoint The maximum number of points that can be processed in a SELECT statement. Setting this to 0 (the default) allows an unlimited number to be processed.
- query_
timeout str The maximum duration in seconds before a query is killed. Setting this to 0 (the default) will never kill slow queries.
InfluxDbInfluxdbUserConfigPrivateAccess
- Influxdb string
influxdb.conf configuration values
- Influxdb string
influxdb.conf configuration values
- influxdb string
influxdb.conf configuration values
- influxdb str
influxdb.conf configuration values
InfluxDbInfluxdbUserConfigPublicAccess
- Influxdb string
influxdb.conf configuration values
- Influxdb string
influxdb.conf configuration values
- influxdb string
influxdb.conf configuration values
- influxdb str
influxdb.conf configuration values
InfluxDbServiceIntegration
- Integration
Type string - Source
Service stringName
- Integration
Type string - Source
Service stringName
- integration
Type string - source
Service stringName
Package Details
- Repository
- https://github.com/pulumi/pulumi-aiven
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aiven
Terraform Provider.