1. Packages
  2. AWS Native
  3. API Docs
  4. apprunner
  5. getService

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

aws-native.apprunner.getService

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

    The AWS::AppRunner::Service resource specifies an AppRunner Service.

    Using getService

    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 getService(args: GetServiceArgs, opts?: InvokeOptions): Promise<GetServiceResult>
    function getServiceOutput(args: GetServiceOutputArgs, opts?: InvokeOptions): Output<GetServiceResult>
    def get_service(service_arn: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetServiceResult
    def get_service_output(service_arn: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetServiceResult]
    func LookupService(ctx *Context, args *LookupServiceArgs, opts ...InvokeOption) (*LookupServiceResult, error)
    func LookupServiceOutput(ctx *Context, args *LookupServiceOutputArgs, opts ...InvokeOption) LookupServiceResultOutput

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

    public static class GetService 
    {
        public static Task<GetServiceResult> InvokeAsync(GetServiceArgs args, InvokeOptions? opts = null)
        public static Output<GetServiceResult> Invoke(GetServiceInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetServiceResult> getService(GetServiceArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:apprunner:getService
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ServiceArn string
    The Amazon Resource Name (ARN) of the AppRunner Service.
    ServiceArn string
    The Amazon Resource Name (ARN) of the AppRunner Service.
    serviceArn String
    The Amazon Resource Name (ARN) of the AppRunner Service.
    serviceArn string
    The Amazon Resource Name (ARN) of the AppRunner Service.
    service_arn str
    The Amazon Resource Name (ARN) of the AppRunner Service.
    serviceArn String
    The Amazon Resource Name (ARN) of the AppRunner Service.

    getService Result

    The following output properties are available:

    healthCheckConfiguration Property Map
    instanceConfiguration Property Map
    networkConfiguration Property Map
    observabilityConfiguration Property Map
    serviceArn String
    The Amazon Resource Name (ARN) of the AppRunner Service.
    serviceId String
    The AppRunner Service Id
    serviceUrl String
    The Service Url of the AppRunner Service.
    sourceConfiguration Property Map
    status String
    AppRunner Service status.

    Supporting Types

    ServiceAuthenticationConfiguration

    AccessRoleArn string
    Access Role Arn
    ConnectionArn string
    Connection Arn
    AccessRoleArn string
    Access Role Arn
    ConnectionArn string
    Connection Arn
    accessRoleArn String
    Access Role Arn
    connectionArn String
    Connection Arn
    accessRoleArn string
    Access Role Arn
    connectionArn string
    Connection Arn
    access_role_arn str
    Access Role Arn
    connection_arn str
    Connection Arn
    accessRoleArn String
    Access Role Arn
    connectionArn String
    Connection Arn

    ServiceCodeConfiguration

    ServiceCodeConfigurationConfigurationSource

    ServiceCodeConfigurationValues

    Runtime ServiceCodeConfigurationValuesRuntime
    Runtime
    BuildCommand string
    Build Command
    Port string
    Port
    RuntimeEnvironmentSecrets []ServiceKeyValuePair
    The secrets and parameters that get referenced by your service as environment variables
    RuntimeEnvironmentVariables []ServiceKeyValuePair
    StartCommand string
    Start Command
    runtime ServiceCodeConfigurationValuesRuntime
    Runtime
    buildCommand String
    Build Command
    port String
    Port
    runtimeEnvironmentSecrets List<ServiceKeyValuePair>
    The secrets and parameters that get referenced by your service as environment variables
    runtimeEnvironmentVariables List<ServiceKeyValuePair>
    startCommand String
    Start Command
    runtime ServiceCodeConfigurationValuesRuntime
    Runtime
    buildCommand string
    Build Command
    port string
    Port
    runtimeEnvironmentSecrets ServiceKeyValuePair[]
    The secrets and parameters that get referenced by your service as environment variables
    runtimeEnvironmentVariables ServiceKeyValuePair[]
    startCommand string
    Start Command
    runtime ServiceCodeConfigurationValuesRuntime
    Runtime
    build_command str
    Build Command
    port str
    Port
    runtime_environment_secrets Sequence[ServiceKeyValuePair]
    The secrets and parameters that get referenced by your service as environment variables
    runtime_environment_variables Sequence[ServiceKeyValuePair]
    start_command str
    Start Command

    ServiceCodeConfigurationValuesRuntime

    ServiceCodeRepository

    ServiceEgressConfiguration

    EgressType Pulumi.AwsNative.AppRunner.ServiceEgressConfigurationEgressType
    Network egress type.
    VpcConnectorArn string
    The Amazon Resource Name (ARN) of the App Runner VpcConnector.
    EgressType ServiceEgressConfigurationEgressType
    Network egress type.
    VpcConnectorArn string
    The Amazon Resource Name (ARN) of the App Runner VpcConnector.
    egressType ServiceEgressConfigurationEgressType
    Network egress type.
    vpcConnectorArn String
    The Amazon Resource Name (ARN) of the App Runner VpcConnector.
    egressType ServiceEgressConfigurationEgressType
    Network egress type.
    vpcConnectorArn string
    The Amazon Resource Name (ARN) of the App Runner VpcConnector.
    egress_type ServiceEgressConfigurationEgressType
    Network egress type.
    vpc_connector_arn str
    The Amazon Resource Name (ARN) of the App Runner VpcConnector.
    egressType "DEFAULT" | "VPC"
    Network egress type.
    vpcConnectorArn String
    The Amazon Resource Name (ARN) of the App Runner VpcConnector.

    ServiceEgressConfigurationEgressType

    ServiceHealthCheckConfiguration

    HealthyThreshold int
    Health check Healthy Threshold
    Interval int
    Health check Interval
    Path string
    Health check Path
    Protocol Pulumi.AwsNative.AppRunner.ServiceHealthCheckConfigurationProtocol
    Health Check Protocol
    Timeout int
    Health check Timeout
    UnhealthyThreshold int
    Health check Unhealthy Threshold
    HealthyThreshold int
    Health check Healthy Threshold
    Interval int
    Health check Interval
    Path string
    Health check Path
    Protocol ServiceHealthCheckConfigurationProtocol
    Health Check Protocol
    Timeout int
    Health check Timeout
    UnhealthyThreshold int
    Health check Unhealthy Threshold
    healthyThreshold Integer
    Health check Healthy Threshold
    interval Integer
    Health check Interval
    path String
    Health check Path
    protocol ServiceHealthCheckConfigurationProtocol
    Health Check Protocol
    timeout Integer
    Health check Timeout
    unhealthyThreshold Integer
    Health check Unhealthy Threshold
    healthyThreshold number
    Health check Healthy Threshold
    interval number
    Health check Interval
    path string
    Health check Path
    protocol ServiceHealthCheckConfigurationProtocol
    Health Check Protocol
    timeout number
    Health check Timeout
    unhealthyThreshold number
    Health check Unhealthy Threshold
    healthy_threshold int
    Health check Healthy Threshold
    interval int
    Health check Interval
    path str
    Health check Path
    protocol ServiceHealthCheckConfigurationProtocol
    Health Check Protocol
    timeout int
    Health check Timeout
    unhealthy_threshold int
    Health check Unhealthy Threshold
    healthyThreshold Number
    Health check Healthy Threshold
    interval Number
    Health check Interval
    path String
    Health check Path
    protocol "TCP" | "HTTP"
    Health Check Protocol
    timeout Number
    Health check Timeout
    unhealthyThreshold Number
    Health check Unhealthy Threshold

    ServiceHealthCheckConfigurationProtocol

    ServiceImageConfiguration

    Port string
    Port
    RuntimeEnvironmentSecrets []ServiceKeyValuePair
    The secrets and parameters that get referenced by your service as environment variables
    RuntimeEnvironmentVariables []ServiceKeyValuePair
    StartCommand string
    Start Command
    port String
    Port
    runtimeEnvironmentSecrets List<ServiceKeyValuePair>
    The secrets and parameters that get referenced by your service as environment variables
    runtimeEnvironmentVariables List<ServiceKeyValuePair>
    startCommand String
    Start Command
    port string
    Port
    runtimeEnvironmentSecrets ServiceKeyValuePair[]
    The secrets and parameters that get referenced by your service as environment variables
    runtimeEnvironmentVariables ServiceKeyValuePair[]
    startCommand string
    Start Command
    port str
    Port
    runtime_environment_secrets Sequence[ServiceKeyValuePair]
    The secrets and parameters that get referenced by your service as environment variables
    runtime_environment_variables Sequence[ServiceKeyValuePair]
    start_command str
    Start Command
    port String
    Port
    runtimeEnvironmentSecrets List<Property Map>
    The secrets and parameters that get referenced by your service as environment variables
    runtimeEnvironmentVariables List<Property Map>
    startCommand String
    Start Command

    ServiceImageRepository

    ServiceImageRepositoryImageRepositoryType

    ServiceIngressConfiguration

    IsPubliclyAccessible bool
    It's set to true if the Apprunner service is publicly accessible. It's set to false otherwise.
    IsPubliclyAccessible bool
    It's set to true if the Apprunner service is publicly accessible. It's set to false otherwise.
    isPubliclyAccessible Boolean
    It's set to true if the Apprunner service is publicly accessible. It's set to false otherwise.
    isPubliclyAccessible boolean
    It's set to true if the Apprunner service is publicly accessible. It's set to false otherwise.
    is_publicly_accessible bool
    It's set to true if the Apprunner service is publicly accessible. It's set to false otherwise.
    isPubliclyAccessible Boolean
    It's set to true if the Apprunner service is publicly accessible. It's set to false otherwise.

    ServiceInstanceConfiguration

    Cpu string
    CPU
    InstanceRoleArn string
    Instance Role Arn
    Memory string
    Memory
    Cpu string
    CPU
    InstanceRoleArn string
    Instance Role Arn
    Memory string
    Memory
    cpu String
    CPU
    instanceRoleArn String
    Instance Role Arn
    memory String
    Memory
    cpu string
    CPU
    instanceRoleArn string
    Instance Role Arn
    memory string
    Memory
    cpu str
    CPU
    instance_role_arn str
    Instance Role Arn
    memory str
    Memory
    cpu String
    CPU
    instanceRoleArn String
    Instance Role Arn
    memory String
    Memory

    ServiceKeyValuePair

    Name string
    Value string
    Name string
    Value string
    name String
    value String
    name string
    value string
    name str
    value str
    name String
    value String

    ServiceNetworkConfiguration

    ServiceNetworkConfigurationIpAddressType

    ServiceObservabilityConfiguration

    ObservabilityEnabled bool
    Observability enabled
    ObservabilityConfigurationArn string
    The Amazon Resource Name (ARN) of the App Runner ObservabilityConfiguration.
    ObservabilityEnabled bool
    Observability enabled
    ObservabilityConfigurationArn string
    The Amazon Resource Name (ARN) of the App Runner ObservabilityConfiguration.
    observabilityEnabled Boolean
    Observability enabled
    observabilityConfigurationArn String
    The Amazon Resource Name (ARN) of the App Runner ObservabilityConfiguration.
    observabilityEnabled boolean
    Observability enabled
    observabilityConfigurationArn string
    The Amazon Resource Name (ARN) of the App Runner ObservabilityConfiguration.
    observability_enabled bool
    Observability enabled
    observability_configuration_arn str
    The Amazon Resource Name (ARN) of the App Runner ObservabilityConfiguration.
    observabilityEnabled Boolean
    Observability enabled
    observabilityConfigurationArn String
    The Amazon Resource Name (ARN) of the App Runner ObservabilityConfiguration.

    ServiceSourceCodeVersion

    Type Pulumi.AwsNative.AppRunner.ServiceSourceCodeVersionType
    Source Code Version Type
    Value string
    Source Code Version Value
    Type ServiceSourceCodeVersionType
    Source Code Version Type
    Value string
    Source Code Version Value
    type ServiceSourceCodeVersionType
    Source Code Version Type
    value String
    Source Code Version Value
    type ServiceSourceCodeVersionType
    Source Code Version Type
    value string
    Source Code Version Value
    type ServiceSourceCodeVersionType
    Source Code Version Type
    value str
    Source Code Version Value
    type "BRANCH"
    Source Code Version Type
    value String
    Source Code Version Value

    ServiceSourceCodeVersionType

    ServiceSourceConfiguration

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi