aiven.getServiceComponent (v4)

Aiven v4.5.2 (4.x), Mar 9 26

Viewing docs for Aiven v4.5.2 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-aiven

Viewing docs for Aiven v4.5.2 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-aiven

Service components can be defined to get the connection info for specific service. Services may support multiple different access routes (VPC peering and public access), have additional components or support various authentication methods. Each of these may be represented by different DNS name or TCP port and the specific component to match can be selected by specifying appropriate filters as shown below.

Using getServiceComponent

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getServiceComponent(args: GetServiceComponentArgs, opts?: InvokeOptions): Promise<GetServiceComponentResult>
function getServiceComponentOutput(args: GetServiceComponentOutputArgs, opts?: InvokeOptions): Output<GetServiceComponentResult>

def get_service_component(component: Optional[str] = None,
                          kafka_authentication_method: Optional[str] = None,
                          project: Optional[str] = None,
                          route: Optional[str] = None,
                          service_name: Optional[str] = None,
                          ssl: Optional[bool] = None,
                          usage: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetServiceComponentResult
def get_service_component_output(component: Optional[pulumi.Input[str]] = None,
                          kafka_authentication_method: Optional[pulumi.Input[str]] = None,
                          project: Optional[pulumi.Input[str]] = None,
                          route: Optional[pulumi.Input[str]] = None,
                          service_name: Optional[pulumi.Input[str]] = None,
                          ssl: Optional[pulumi.Input[bool]] = None,
                          usage: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetServiceComponentResult]

func LookupServiceComponent(ctx *Context, args *LookupServiceComponentArgs, opts ...InvokeOption) (*LookupServiceComponentResult, error)
func LookupServiceComponentOutput(ctx *Context, args *LookupServiceComponentOutputArgs, opts ...InvokeOption) LookupServiceComponentResultOutput

> Note: This function is named LookupServiceComponent in the Go SDK.

public static class GetServiceComponent 
{
    public static Task<GetServiceComponentResult> InvokeAsync(GetServiceComponentArgs args, InvokeOptions? opts = null)
    public static Output<GetServiceComponentResult> Invoke(GetServiceComponentInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetServiceComponentResult> getServiceComponent(GetServiceComponentArgs args, InvokeOptions options)
public static Output<GetServiceComponentResult> getServiceComponent(GetServiceComponentArgs args, InvokeOptions options)

fn::invoke:
  function: aiven:index/getServiceComponent:getServiceComponent
  arguments:
    # arguments dictionary

The following arguments are supported:

Component string: Service component name
Project string: Project name
KafkaAuthenticationMethod string: Kafka authentication method. This is a value specific to the 'kafka' service component
Route string: Network access route
ServiceName string: Service name
Ssl bool: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components that may disable encryption
Usage string: DNS usage name

Component string: Service component name
Project string: Project name
KafkaAuthenticationMethod string: Kafka authentication method. This is a value specific to the 'kafka' service component
Route string: Network access route
ServiceName string: Service name
Ssl bool: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components that may disable encryption
Usage string: DNS usage name

component String: Service component name
project String: Project name
kafkaAuthenticationMethod String: Kafka authentication method. This is a value specific to the 'kafka' service component
route String: Network access route
serviceName String: Service name
ssl Boolean: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components that may disable encryption
usage String: DNS usage name

component string: Service component name
project string: Project name
kafkaAuthenticationMethod string: Kafka authentication method. This is a value specific to the 'kafka' service component
route string: Network access route
serviceName string: Service name
ssl boolean: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components that may disable encryption
usage string: DNS usage name

component str: Service component name
project str: Project name
kafka_authentication_method str: Kafka authentication method. This is a value specific to the 'kafka' service component
route str: Network access route
service_name str: Service name
ssl bool: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components that may disable encryption
usage str: DNS usage name

component String: Service component name
project String: Project name
kafkaAuthenticationMethod String: Kafka authentication method. This is a value specific to the 'kafka' service component
route String: Network access route
serviceName String: Service name
ssl Boolean: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components that may disable encryption
usage String: DNS usage name

getServiceComponent Result

The following output properties are available:

Component string: Service component name
Host string: DNS name for connecting to the service component
Id string: The provider-assigned unique ID for this managed resource.
Port int: Port number for connecting to the service component
Project string: Project name
KafkaAuthenticationMethod string: Kafka authentication method. This is a value specific to the 'kafka' service component
Route string: Network access route
ServiceName string: Service name
Ssl bool: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components that may disable encryption
Usage string: DNS usage name

Component string: Service component name
Host string: DNS name for connecting to the service component
Id string: The provider-assigned unique ID for this managed resource.
Port int: Port number for connecting to the service component
Project string: Project name
KafkaAuthenticationMethod string: Kafka authentication method. This is a value specific to the 'kafka' service component
Route string: Network access route
ServiceName string: Service name
Ssl bool: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components that may disable encryption
Usage string: DNS usage name

component String: Service component name
host String: DNS name for connecting to the service component
id String: The provider-assigned unique ID for this managed resource.
port Integer: Port number for connecting to the service component
project String: Project name
kafkaAuthenticationMethod String: Kafka authentication method. This is a value specific to the 'kafka' service component
route String: Network access route
serviceName String: Service name
ssl Boolean: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components that may disable encryption
usage String: DNS usage name

component string: Service component name
host string: DNS name for connecting to the service component
id string: The provider-assigned unique ID for this managed resource.
port number: Port number for connecting to the service component
project string: Project name
kafkaAuthenticationMethod string: Kafka authentication method. This is a value specific to the 'kafka' service component
route string: Network access route
serviceName string: Service name
ssl boolean: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components that may disable encryption
usage string: DNS usage name

component str: Service component name
host str: DNS name for connecting to the service component
id str: The provider-assigned unique ID for this managed resource.
port int: Port number for connecting to the service component
project str: Project name
kafka_authentication_method str: Kafka authentication method. This is a value specific to the 'kafka' service component
route str: Network access route
service_name str: Service name
ssl bool: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components that may disable encryption
usage str: DNS usage name

component String: Service component name
host String: DNS name for connecting to the service component
id String: The provider-assigned unique ID for this managed resource.
port Number: Port number for connecting to the service component
project String: Project name
kafkaAuthenticationMethod String: Kafka authentication method. This is a value specific to the 'kafka' service component
route String: Network access route
serviceName String: Service name
ssl Boolean: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components that may disable encryption
usage String: DNS usage name

Package Details

Repository: Aiven pulumi/pulumi-aiven
License: Apache-2.0
Notes: This Pulumi package is based on the aiven Terraform Provider.

Viewing docs for Aiven v4.5.2 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-aiven

aiven.getServiceComponent

On this page

On this page

Using getServiceComponent

getServiceComponent Result

Package Details

On this page

On this page