getM3Aggregator
# M3 Aggregator Data Source
The M3 Aggregator data source provides information about the existing Aiven M3 Aggregator services.
Example Usage
using Pulumi;
using Aiven = Pulumi.Aiven;
class MyStack : Stack
{
public MyStack()
{
var m3a = Output.Create(Aiven.GetM3Aggregator.InvokeAsync(new Aiven.GetM3AggregatorArgs
{
Project = data.Aiven_project.Foo.Project,
ServiceName = "my-m3a",
}));
}
}
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.LookupM3Aggregator(ctx, &aiven.LookupM3AggregatorArgs{
Project: data.Aiven_project.Foo.Project,
ServiceName: "my-m3a",
}, nil)
if err != nil {
return err
}
return nil
})
}
import pulumi
import pulumi_aiven as aiven
m3a = aiven.get_m3_aggregator(project=data["aiven_project"]["foo"]["project"],
service_name="my-m3a")
import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";
const m3a = aiven.getM3Aggregator({
project: data.aiven_project.foo.project,
serviceName: "my-m3a",
});
Using getM3Aggregator
function getM3Aggregator(args: GetM3AggregatorArgs, opts?: InvokeOptions): Promise<GetM3AggregatorResult>
def get_m3_aggregator(cloud_name: Optional[str] = None, components: Optional[Sequence[GetM3AggregatorComponentArgs]] = None, m3aggregator: Optional[GetM3AggregatorM3aggregatorArgs] = None, m3aggregator_user_config: Optional[GetM3AggregatorM3aggregatorUserConfigArgs] = 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[GetM3AggregatorServiceIntegrationArgs]] = 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, opts: Optional[InvokeOptions] = None) -> GetM3AggregatorResult
func LookupM3Aggregator(ctx *Context, args *LookupM3AggregatorArgs, opts ...InvokeOption) (*LookupM3AggregatorResult, error)
Note: This function is named
LookupM3Aggregator
in the Go SDK.
public static class GetM3Aggregator {
public static Task<GetM3AggregatorResult> InvokeAsync(GetM3AggregatorArgs args, InvokeOptions? opts = null)
}
The following arguments are supported:
- 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.- Components
List<Get
M3Aggregator Component Args> - M3aggregator
Get
M3Aggregator M3aggregator Args M3 Aggregator specific server provided values.
- M3aggregator
User GetConfig M3Aggregator M3aggregator User Config Args defines M3 Aggregator 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
Host string M3 Aggregator hostname.
- Service
Integrations List<GetM3Aggregator Service Integration Args> - Service
Password string Password used for connecting to the M3 Aggregator service, if applicable.
- Service
Port int M3 Aggregator port.
- Service
Type string - Service
Uri string URI for connecting to the M3 Aggregator service.
- Service
Username string Username used for connecting to the M3 Aggregator 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.
- 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.- Components
[]Get
M3Aggregator Component - M3aggregator
Get
M3Aggregator M3aggregator M3 Aggregator specific server provided values.
- M3aggregator
User GetConfig M3Aggregator M3aggregator User Config defines M3 Aggregator 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
Host string M3 Aggregator hostname.
- Service
Integrations []GetM3Aggregator Service Integration - Service
Password string Password used for connecting to the M3 Aggregator service, if applicable.
- Service
Port int M3 Aggregator port.
- Service
Type string - Service
Uri string URI for connecting to the M3 Aggregator service.
- Service
Username string Username used for connecting to the M3 Aggregator 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.
- 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.- components
Get
M3Aggregator Component[] - m3aggregator
Get
M3Aggregator M3aggregator M3 Aggregator specific server provided values.
- m3aggregator
User GetConfig M3Aggregator M3aggregator User Config defines M3 Aggregator 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
Host string M3 Aggregator hostname.
- service
Integrations GetM3Aggregator Service Integration[] - service
Password string Password used for connecting to the M3 Aggregator service, if applicable.
- service
Port number M3 Aggregator port.
- service
Type string - service
Uri string URI for connecting to the M3 Aggregator service.
- service
Username string Username used for connecting to the M3 Aggregator 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.
- 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.- components
Sequence[Get
M3Aggregator Component Args] - m3aggregator
Get
M3Aggregator M3aggregator Args M3 Aggregator specific server provided values.
- m3aggregator_
user_ Getconfig M3Aggregator M3aggregator User Config Args defines M3 Aggregator 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_
host str M3 Aggregator hostname.
- service_
integrations Sequence[GetM3Aggregator Service Integration Args] - service_
password str Password used for connecting to the M3 Aggregator service, if applicable.
- service_
port int M3 Aggregator port.
- service_
type str - service_
uri str URI for connecting to the M3 Aggregator service.
- service_
username str Username used for connecting to the M3 Aggregator 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.
getM3Aggregator Result
The following output properties are available:
- Components
List<Get
M3Aggregator Component> - Id string
The provider-assigned unique ID for this managed resource.
- M3aggregator
Get
M3Aggregator M3aggregator M3 Aggregator specific server provided values.
- Project string
- Service
Host string M3 Aggregator hostname.
- Service
Name string - Service
Password string Password used for connecting to the M3 Aggregator service, if applicable.
- Service
Port int M3 Aggregator port.
- Service
Type string - Service
Uri string URI for connecting to the M3 Aggregator service.
- Service
Username string Username used for connecting to the M3 Aggregator service, if applicable.
- State string
Service state.
- 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.- M3aggregator
User GetConfig M3Aggregator M3aggregator User Config defines M3 Aggregator 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<GetM3Aggregator Service Integration> - 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.
- Components
[]Get
M3Aggregator Component - Id string
The provider-assigned unique ID for this managed resource.
- M3aggregator
Get
M3Aggregator M3aggregator M3 Aggregator specific server provided values.
- Project string
- Service
Host string M3 Aggregator hostname.
- Service
Name string - Service
Password string Password used for connecting to the M3 Aggregator service, if applicable.
- Service
Port int M3 Aggregator port.
- Service
Type string - Service
Uri string URI for connecting to the M3 Aggregator service.
- Service
Username string Username used for connecting to the M3 Aggregator service, if applicable.
- State string
Service state.
- 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.- M3aggregator
User GetConfig M3Aggregator M3aggregator User Config defines M3 Aggregator 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 []GetM3Aggregator Service Integration - 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.
- components
Get
M3Aggregator Component[] - id string
The provider-assigned unique ID for this managed resource.
- m3aggregator
Get
M3Aggregator M3aggregator M3 Aggregator specific server provided values.
- project string
- service
Host string M3 Aggregator hostname.
- service
Name string - service
Password string Password used for connecting to the M3 Aggregator service, if applicable.
- service
Port number M3 Aggregator port.
- service
Type string - service
Uri string URI for connecting to the M3 Aggregator service.
- service
Username string Username used for connecting to the M3 Aggregator service, if applicable.
- state string
Service state.
- 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.- m3aggregator
User GetConfig M3Aggregator M3aggregator User Config defines M3 Aggregator 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 GetM3Aggregator Service Integration[] - 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.
- components
Sequence[Get
M3Aggregator Component] - id str
The provider-assigned unique ID for this managed resource.
- m3aggregator
Get
M3Aggregator M3aggregator M3 Aggregator specific server provided values.
- project str
- service_
host str M3 Aggregator hostname.
- service_
name str - service_
password str Password used for connecting to the M3 Aggregator service, if applicable.
- service_
port int M3 Aggregator port.
- service_
type str - service_
uri str URI for connecting to the M3 Aggregator service.
- service_
username str Username used for connecting to the M3 Aggregator service, if applicable.
- state str
Service state.
- 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.- m3aggregator_
user_ Getconfig M3Aggregator M3aggregator User Config defines M3 Aggregator 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[GetM3Aggregator Service Integration] - 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
GetM3AggregatorComponent
GetM3AggregatorM3aggregatorUserConfig
- Custom
Domain string Serve the web frontend using a custom CNAME pointing to the Aiven DNS name.
- Ip
Filters List<string> Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’
- M3Version string
- M3aggregator
Version string M3 major version
- Custom
Domain string Serve the web frontend using a custom CNAME pointing to the Aiven DNS name.
- Ip
Filters []string Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’
- M3Version string
- M3aggregator
Version string M3 major version
- custom
Domain string Serve the web frontend using a custom CNAME pointing to the Aiven DNS name.
- ip
Filters string[] Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’
- m3Version string
- m3aggregator
Version string M3 major version
- custom_
domain str Serve the web frontend using a custom CNAME pointing to the Aiven DNS name.
- ip_
filters Sequence[str] Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’
- m3_
version str - m3aggregator_
version str M3 major version
GetM3AggregatorServiceIntegration
- 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.