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 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:
- Service
Arn string - The Amazon Resource Name (ARN) of the AppRunner Service.
- Service
Arn string - The Amazon Resource Name (ARN) of the AppRunner Service.
- service
Arn String - The Amazon Resource Name (ARN) of the AppRunner Service.
- service
Arn string - The Amazon Resource Name (ARN) of the AppRunner Service.
- service_
arn str - The Amazon Resource Name (ARN) of the AppRunner Service.
- service
Arn String - The Amazon Resource Name (ARN) of the AppRunner Service.
getService Result
The following output properties are available:
- Health
Check Pulumi.Configuration Aws Native. App Runner. Outputs. Service Health Check Configuration - Instance
Configuration Pulumi.Aws Native. App Runner. Outputs. Service Instance Configuration - Network
Configuration Pulumi.Aws Native. App Runner. Outputs. Service Network Configuration - Observability
Configuration Pulumi.Aws Native. App Runner. Outputs. Service Observability Configuration - Service
Arn string - The Amazon Resource Name (ARN) of the AppRunner Service.
- Service
Id string - The AppRunner Service Id
- Service
Url string - The Service Url of the AppRunner Service.
- Source
Configuration Pulumi.Aws Native. App Runner. Outputs. Service Source Configuration - Status string
- AppRunner Service status.
- Health
Check ServiceConfiguration Health Check Configuration - Instance
Configuration ServiceInstance Configuration - Network
Configuration ServiceNetwork Configuration - Observability
Configuration ServiceObservability Configuration - Service
Arn string - The Amazon Resource Name (ARN) of the AppRunner Service.
- Service
Id string - The AppRunner Service Id
- Service
Url string - The Service Url of the AppRunner Service.
- Source
Configuration ServiceSource Configuration - Status string
- AppRunner Service status.
- health
Check ServiceConfiguration Health Check Configuration - instance
Configuration ServiceInstance Configuration - network
Configuration ServiceNetwork Configuration - observability
Configuration ServiceObservability Configuration - service
Arn String - The Amazon Resource Name (ARN) of the AppRunner Service.
- service
Id String - The AppRunner Service Id
- service
Url String - The Service Url of the AppRunner Service.
- source
Configuration ServiceSource Configuration - status String
- AppRunner Service status.
- health
Check ServiceConfiguration Health Check Configuration - instance
Configuration ServiceInstance Configuration - network
Configuration ServiceNetwork Configuration - observability
Configuration ServiceObservability Configuration - service
Arn string - The Amazon Resource Name (ARN) of the AppRunner Service.
- service
Id string - The AppRunner Service Id
- service
Url string - The Service Url of the AppRunner Service.
- source
Configuration ServiceSource Configuration - status string
- AppRunner Service status.
- health_
check_ Serviceconfiguration Health Check Configuration - instance_
configuration ServiceInstance Configuration - network_
configuration ServiceNetwork Configuration - observability_
configuration ServiceObservability Configuration - service_
arn str - The Amazon Resource Name (ARN) of the AppRunner Service.
- service_
id str - The AppRunner Service Id
- service_
url str - The Service Url of the AppRunner Service.
- source_
configuration ServiceSource Configuration - status str
- AppRunner Service status.
- health
Check Property MapConfiguration - instance
Configuration Property Map - network
Configuration Property Map - observability
Configuration Property Map - service
Arn String - The Amazon Resource Name (ARN) of the AppRunner Service.
- service
Id String - The AppRunner Service Id
- service
Url String - The Service Url of the AppRunner Service.
- source
Configuration Property Map - status String
- AppRunner Service status.
Supporting Types
ServiceAuthenticationConfiguration
- Access
Role stringArn - Access Role Arn
- Connection
Arn string - Connection Arn
- Access
Role stringArn - Access Role Arn
- Connection
Arn string - Connection Arn
- access
Role StringArn - Access Role Arn
- connection
Arn String - Connection Arn
- access
Role stringArn - Access Role Arn
- connection
Arn string - Connection Arn
- access_
role_ strarn - Access Role Arn
- connection_
arn str - Connection Arn
- access
Role StringArn - Access Role Arn
- connection
Arn String - Connection Arn
ServiceCodeConfiguration
- configuration
Source "REPOSITORY" | "API" - Configuration Source
- code
Configuration Property MapValues
ServiceCodeConfigurationConfigurationSource
ServiceCodeConfigurationValues
- Runtime
Pulumi.
Aws Native. App Runner. Service Code Configuration Values Runtime - Runtime
- Build
Command string - Build Command
- Port string
- Port
- Runtime
Environment List<Pulumi.Secrets Aws Native. App Runner. Inputs. Service Key Value Pair> - The secrets and parameters that get referenced by your service as environment variables
- Runtime
Environment List<Pulumi.Variables Aws Native. App Runner. Inputs. Service Key Value Pair> - Start
Command string - Start Command
- Runtime
Service
Code Configuration Values Runtime - Runtime
- Build
Command string - Build Command
- Port string
- Port
- Runtime
Environment []ServiceSecrets Key Value Pair - The secrets and parameters that get referenced by your service as environment variables
- Runtime
Environment []ServiceVariables Key Value Pair - Start
Command string - Start Command
- runtime
Service
Code Configuration Values Runtime - Runtime
- build
Command String - Build Command
- port String
- Port
- runtime
Environment List<ServiceSecrets Key Value Pair> - The secrets and parameters that get referenced by your service as environment variables
- runtime
Environment List<ServiceVariables Key Value Pair> - start
Command String - Start Command
- runtime
Service
Code Configuration Values Runtime - Runtime
- build
Command string - Build Command
- port string
- Port
- runtime
Environment ServiceSecrets Key Value Pair[] - The secrets and parameters that get referenced by your service as environment variables
- runtime
Environment ServiceVariables Key Value Pair[] - start
Command string - Start Command
- runtime
Service
Code Configuration Values Runtime - Runtime
- build_
command str - Build Command
- port str
- Port
- runtime_
environment_ Sequence[Servicesecrets Key Value Pair] - The secrets and parameters that get referenced by your service as environment variables
- runtime_
environment_ Sequence[Servicevariables Key Value Pair] - start_
command str - Start Command
- runtime "PYTHON_3" | "NODEJS_12" | "NODEJS_14" | "CORRETTO_8" | "CORRETTO_11" | "NODEJS_16" | "GO_1" | "DOTNET_6" | "PHP_81" | "RUBY_31" | "PYTHON_311" | "NODEJS_18"
- Runtime
- build
Command String - Build Command
- port String
- Port
- runtime
Environment List<Property Map>Secrets - The secrets and parameters that get referenced by your service as environment variables
- runtime
Environment List<Property Map>Variables - start
Command String - Start Command
ServiceCodeConfigurationValuesRuntime
ServiceCodeRepository
- Repository
Url string - Repository Url
- Source
Code Pulumi.Version Aws Native. App Runner. Inputs. Service Source Code Version - Code
Configuration Pulumi.Aws Native. App Runner. Inputs. Service Code Configuration - Source
Directory string - Source Directory
- Repository
Url string - Repository Url
- Source
Code ServiceVersion Source Code Version - Code
Configuration ServiceCode Configuration - Source
Directory string - Source Directory
- repository
Url String - Repository Url
- source
Code ServiceVersion Source Code Version - code
Configuration ServiceCode Configuration - source
Directory String - Source Directory
- repository
Url string - Repository Url
- source
Code ServiceVersion Source Code Version - code
Configuration ServiceCode Configuration - source
Directory string - Source Directory
- repository_
url str - Repository Url
- source_
code_ Serviceversion Source Code Version - code_
configuration ServiceCode Configuration - source_
directory str - Source Directory
- repository
Url String - Repository Url
- source
Code Property MapVersion - code
Configuration Property Map - source
Directory String - Source Directory
ServiceEgressConfiguration
- Egress
Type Pulumi.Aws Native. App Runner. Service Egress Configuration Egress Type - Network egress type.
- Vpc
Connector stringArn - The Amazon Resource Name (ARN) of the App Runner VpcConnector.
- Egress
Type ServiceEgress Configuration Egress Type - Network egress type.
- Vpc
Connector stringArn - The Amazon Resource Name (ARN) of the App Runner VpcConnector.
- egress
Type ServiceEgress Configuration Egress Type - Network egress type.
- vpc
Connector StringArn - The Amazon Resource Name (ARN) of the App Runner VpcConnector.
- egress
Type ServiceEgress Configuration Egress Type - Network egress type.
- vpc
Connector stringArn - The Amazon Resource Name (ARN) of the App Runner VpcConnector.
- egress_
type ServiceEgress Configuration Egress Type - Network egress type.
- vpc_
connector_ strarn - The Amazon Resource Name (ARN) of the App Runner VpcConnector.
- egress
Type "DEFAULT" | "VPC" - Network egress type.
- vpc
Connector StringArn - The Amazon Resource Name (ARN) of the App Runner VpcConnector.
ServiceEgressConfigurationEgressType
ServiceHealthCheckConfiguration
- Healthy
Threshold int - Health check Healthy Threshold
- Interval int
- Health check Interval
- Path string
- Health check Path
- Protocol
Pulumi.
Aws Native. App Runner. Service Health Check Configuration Protocol - Health Check Protocol
- Timeout int
- Health check Timeout
- Unhealthy
Threshold int - Health check Unhealthy Threshold
- Healthy
Threshold int - Health check Healthy Threshold
- Interval int
- Health check Interval
- Path string
- Health check Path
- Protocol
Service
Health Check Configuration Protocol - Health Check Protocol
- Timeout int
- Health check Timeout
- Unhealthy
Threshold int - Health check Unhealthy Threshold
- healthy
Threshold Integer - Health check Healthy Threshold
- interval Integer
- Health check Interval
- path String
- Health check Path
- protocol
Service
Health Check Configuration Protocol - Health Check Protocol
- timeout Integer
- Health check Timeout
- unhealthy
Threshold Integer - Health check Unhealthy Threshold
- healthy
Threshold number - Health check Healthy Threshold
- interval number
- Health check Interval
- path string
- Health check Path
- protocol
Service
Health Check Configuration Protocol - Health Check Protocol
- timeout number
- Health check Timeout
- unhealthy
Threshold number - Health check Unhealthy Threshold
- healthy_
threshold int - Health check Healthy Threshold
- interval int
- Health check Interval
- path str
- Health check Path
- protocol
Service
Health Check Configuration Protocol - Health Check Protocol
- timeout int
- Health check Timeout
- unhealthy_
threshold int - Health check Unhealthy Threshold
- healthy
Threshold 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
- unhealthy
Threshold Number - Health check Unhealthy Threshold
ServiceHealthCheckConfigurationProtocol
ServiceImageConfiguration
- Port string
- Port
- Runtime
Environment List<Pulumi.Secrets Aws Native. App Runner. Inputs. Service Key Value Pair> - The secrets and parameters that get referenced by your service as environment variables
- Runtime
Environment List<Pulumi.Variables Aws Native. App Runner. Inputs. Service Key Value Pair> - Start
Command string - Start Command
- Port string
- Port
- Runtime
Environment []ServiceSecrets Key Value Pair - The secrets and parameters that get referenced by your service as environment variables
- Runtime
Environment []ServiceVariables Key Value Pair - Start
Command string - Start Command
- port String
- Port
- runtime
Environment List<ServiceSecrets Key Value Pair> - The secrets and parameters that get referenced by your service as environment variables
- runtime
Environment List<ServiceVariables Key Value Pair> - start
Command String - Start Command
- port string
- Port
- runtime
Environment ServiceSecrets Key Value Pair[] - The secrets and parameters that get referenced by your service as environment variables
- runtime
Environment ServiceVariables Key Value Pair[] - start
Command string - Start Command
- port str
- Port
- runtime_
environment_ Sequence[Servicesecrets Key Value Pair] - The secrets and parameters that get referenced by your service as environment variables
- runtime_
environment_ Sequence[Servicevariables Key Value Pair] - start_
command str - Start Command
- port String
- Port
- runtime
Environment List<Property Map>Secrets - The secrets and parameters that get referenced by your service as environment variables
- runtime
Environment List<Property Map>Variables - start
Command String - Start Command
ServiceImageRepository
- Image
Identifier string - Image Identifier
- Image
Repository Pulumi.Type Aws Native. App Runner. Service Image Repository Image Repository Type - Image Repository Type
- Image
Configuration Pulumi.Aws Native. App Runner. Inputs. Service Image Configuration
- Image
Identifier string - Image Identifier
- Image
Repository ServiceType Image Repository Image Repository Type - Image Repository Type
- Image
Configuration ServiceImage Configuration
- image
Identifier String - Image Identifier
- image
Repository ServiceType Image Repository Image Repository Type - Image Repository Type
- image
Configuration ServiceImage Configuration
- image
Identifier string - Image Identifier
- image
Repository ServiceType Image Repository Image Repository Type - Image Repository Type
- image
Configuration ServiceImage Configuration
- image_
identifier str - Image Identifier
- image_
repository_ Servicetype Image Repository Image Repository Type - Image Repository Type
- image_
configuration ServiceImage Configuration
- image
Identifier String - Image Identifier
- image
Repository "ECR" | "ECR_PUBLIC"Type - Image Repository Type
- image
Configuration Property Map
ServiceImageRepositoryImageRepositoryType
ServiceIngressConfiguration
- Is
Publicly boolAccessible - It's set to true if the Apprunner service is publicly accessible. It's set to false otherwise.
- Is
Publicly boolAccessible - It's set to true if the Apprunner service is publicly accessible. It's set to false otherwise.
- is
Publicly BooleanAccessible - It's set to true if the Apprunner service is publicly accessible. It's set to false otherwise.
- is
Publicly booleanAccessible - It's set to true if the Apprunner service is publicly accessible. It's set to false otherwise.
- is_
publicly_ boolaccessible - It's set to true if the Apprunner service is publicly accessible. It's set to false otherwise.
- is
Publicly BooleanAccessible - It's set to true if the Apprunner service is publicly accessible. It's set to false otherwise.
ServiceInstanceConfiguration
- Cpu string
- CPU
- Instance
Role stringArn - Instance Role Arn
- Memory string
- Memory
- Cpu string
- CPU
- Instance
Role stringArn - Instance Role Arn
- Memory string
- Memory
- cpu String
- CPU
- instance
Role StringArn - Instance Role Arn
- memory String
- Memory
- cpu string
- CPU
- instance
Role stringArn - Instance Role Arn
- memory string
- Memory
- cpu str
- CPU
- instance_
role_ strarn - Instance Role Arn
- memory str
- Memory
- cpu String
- CPU
- instance
Role StringArn - Instance Role Arn
- memory String
- Memory
ServiceKeyValuePair
ServiceNetworkConfiguration
- Egress
Configuration ServiceEgress Configuration - Ingress
Configuration ServiceIngress Configuration - Ip
Address ServiceType Network Configuration Ip Address Type - App Runner service endpoint IP address type
- egress
Configuration ServiceEgress Configuration - ingress
Configuration ServiceIngress Configuration - ip
Address ServiceType Network Configuration Ip Address Type - App Runner service endpoint IP address type
- egress
Configuration ServiceEgress Configuration - ingress
Configuration ServiceIngress Configuration - ip
Address ServiceType Network Configuration Ip Address Type - App Runner service endpoint IP address type
- egress_
configuration ServiceEgress Configuration - ingress_
configuration ServiceIngress Configuration - ip_
address_ Servicetype Network Configuration Ip Address Type - App Runner service endpoint IP address type
- egress
Configuration Property Map - ingress
Configuration Property Map - ip
Address "IPV4" | "DUAL_STACK"Type - App Runner service endpoint IP address type
ServiceNetworkConfigurationIpAddressType
ServiceObservabilityConfiguration
- Observability
Enabled bool - Observability enabled
- Observability
Configuration stringArn - The Amazon Resource Name (ARN) of the App Runner ObservabilityConfiguration.
- Observability
Enabled bool - Observability enabled
- Observability
Configuration stringArn - The Amazon Resource Name (ARN) of the App Runner ObservabilityConfiguration.
- observability
Enabled Boolean - Observability enabled
- observability
Configuration StringArn - The Amazon Resource Name (ARN) of the App Runner ObservabilityConfiguration.
- observability
Enabled boolean - Observability enabled
- observability
Configuration stringArn - The Amazon Resource Name (ARN) of the App Runner ObservabilityConfiguration.
- observability_
enabled bool - Observability enabled
- observability_
configuration_ strarn - The Amazon Resource Name (ARN) of the App Runner ObservabilityConfiguration.
- observability
Enabled Boolean - Observability enabled
- observability
Configuration StringArn - The Amazon Resource Name (ARN) of the App Runner ObservabilityConfiguration.
ServiceSourceCodeVersion
- Type
Pulumi.
Aws Native. App Runner. Service Source Code Version Type - Source Code Version Type
- Value string
- Source Code Version Value
- Type
Service
Source Code Version Type - Source Code Version Type
- Value string
- Source Code Version Value
- type
Service
Source Code Version Type - Source Code Version Type
- value String
- Source Code Version Value
- type
Service
Source Code Version Type - Source Code Version Type
- value string
- Source Code Version Value
- type
Service
Source Code Version Type - Source Code Version Type
- value str
- Source Code Version Value
ServiceSourceCodeVersionType
ServiceSourceConfiguration
- authentication
Configuration Property Map - auto
Deployments BooleanEnabled - Auto Deployment enabled
- code
Repository Property Map - image
Repository Property Map
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi