aws-native.lightsail.getContainer

Explore with Pulumi AI

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

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi

pulumi/pulumi-aws-native

Using getContainer

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 getContainer(args: GetContainerArgs, opts?: InvokeOptions): Promise<GetContainerResult>
function getContainerOutput(args: GetContainerOutputArgs, opts?: InvokeOptions): Output<GetContainerResult>

def get_container(service_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetContainerResult
def get_container_output(service_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetContainerResult]

func LookupContainer(ctx *Context, args *LookupContainerArgs, opts ...InvokeOption) (*LookupContainerResult, error)
func LookupContainerOutput(ctx *Context, args *LookupContainerOutputArgs, opts ...InvokeOption) LookupContainerResultOutput

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

public static class GetContainer 
{
    public static Task<GetContainerResult> InvokeAsync(GetContainerArgs args, InvokeOptions? opts = null)
    public static Output<GetContainerResult> Invoke(GetContainerInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetContainerResult> getContainer(GetContainerArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:lightsail:getContainer
  arguments:
    # arguments dictionary

The following arguments are supported:

ServiceName string: The name for the container service.

ServiceName string: The name for the container service.

serviceName String: The name for the container service.

serviceName string: The name for the container service.

service_name str: The name for the container service.

serviceName String: The name for the container service.

getContainer Result

The following output properties are available:

ContainerArn string: The Amazon Resource Name (ARN) of the container.
ContainerServiceDeployment Pulumi.AwsNative.Lightsail.Outputs.ContainerServiceDeployment: Describes a container deployment configuration of an Amazon Lightsail container service.
IsDisabled bool: A Boolean value to indicate whether the container service is disabled.
Power string: The power specification for the container service.
PrincipalArn string: The principal ARN of the container service.
PrivateRegistryAccess Pulumi.AwsNative.Lightsail.Outputs.ContainerPrivateRegistryAccess: A Boolean value to indicate whether the container service has access to private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.
PublicDomainNames List<Pulumi.AwsNative.Lightsail.Outputs.ContainerPublicDomainName>: The public domain names to use with the container service, such as example.com and www.example.com.
Scale int: The scale specification for the container service.
Tags List<Pulumi.AwsNative.Outputs.Tag>: An array of key-value pairs to apply to this resource.
Url string: The publicly accessible URL of the container service.

ContainerArn string: The Amazon Resource Name (ARN) of the container.
ContainerServiceDeployment ContainerServiceDeployment: Describes a container deployment configuration of an Amazon Lightsail container service.
IsDisabled bool: A Boolean value to indicate whether the container service is disabled.
Power string: The power specification for the container service.
PrincipalArn string: The principal ARN of the container service.
PrivateRegistryAccess ContainerPrivateRegistryAccess: A Boolean value to indicate whether the container service has access to private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.
PublicDomainNames []ContainerPublicDomainName: The public domain names to use with the container service, such as example.com and www.example.com.
Scale int: The scale specification for the container service.
Tags Tag: An array of key-value pairs to apply to this resource.
Url string: The publicly accessible URL of the container service.

containerArn String: The Amazon Resource Name (ARN) of the container.
containerServiceDeployment ContainerServiceDeployment: Describes a container deployment configuration of an Amazon Lightsail container service.
isDisabled Boolean: A Boolean value to indicate whether the container service is disabled.
power String: The power specification for the container service.
principalArn String: The principal ARN of the container service.
privateRegistryAccess ContainerPrivateRegistryAccess: A Boolean value to indicate whether the container service has access to private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.
publicDomainNames List<ContainerPublicDomainName>: The public domain names to use with the container service, such as example.com and www.example.com.
scale Integer: The scale specification for the container service.
tags List<Tag>: An array of key-value pairs to apply to this resource.
url String: The publicly accessible URL of the container service.

containerArn string: The Amazon Resource Name (ARN) of the container.
containerServiceDeployment ContainerServiceDeployment: Describes a container deployment configuration of an Amazon Lightsail container service.
isDisabled boolean: A Boolean value to indicate whether the container service is disabled.
power string: The power specification for the container service.
principalArn string: The principal ARN of the container service.
privateRegistryAccess ContainerPrivateRegistryAccess: A Boolean value to indicate whether the container service has access to private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.
publicDomainNames ContainerPublicDomainName[]: The public domain names to use with the container service, such as example.com and www.example.com.
scale number: The scale specification for the container service.
tags Tag[]: An array of key-value pairs to apply to this resource.
url string: The publicly accessible URL of the container service.

container_arn str: The Amazon Resource Name (ARN) of the container.
container_service_deployment ContainerServiceDeployment: Describes a container deployment configuration of an Amazon Lightsail container service.
is_disabled bool: A Boolean value to indicate whether the container service is disabled.
power str: The power specification for the container service.
principal_arn str: The principal ARN of the container service.
private_registry_access ContainerPrivateRegistryAccess: A Boolean value to indicate whether the container service has access to private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.
public_domain_names Sequence[ContainerPublicDomainName]: The public domain names to use with the container service, such as example.com and www.example.com.
scale int: The scale specification for the container service.
tags Sequence[root_Tag]: An array of key-value pairs to apply to this resource.
url str: The publicly accessible URL of the container service.

containerArn String: The Amazon Resource Name (ARN) of the container.
containerServiceDeployment Property Map: Describes a container deployment configuration of an Amazon Lightsail container service.
isDisabled Boolean: A Boolean value to indicate whether the container service is disabled.
power String: The power specification for the container service.
principalArn String: The principal ARN of the container service.
privateRegistryAccess Property Map: A Boolean value to indicate whether the container service has access to private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.
publicDomainNames List<Property Map>: The public domain names to use with the container service, such as example.com and www.example.com.
scale Number: The scale specification for the container service.
tags List<Property Map>: An array of key-value pairs to apply to this resource.
url String: The publicly accessible URL of the container service.

Supporting Types

Container

Command List<string>: The launch command for the container.
ContainerName string: The name of the container.
Environment List<Pulumi.AwsNative.Lightsail.Inputs.ContainerEnvironmentVariable>: The environment variables of the container.
Image string: The name of the image used for the container.
Ports List<Pulumi.AwsNative.Lightsail.Inputs.ContainerPortInfo>: The open firewall ports of the container.

Command []string: The launch command for the container.
ContainerName string: The name of the container.
Environment []ContainerEnvironmentVariable: The environment variables of the container.
Image string: The name of the image used for the container.
Ports []ContainerPortInfo: The open firewall ports of the container.

command List<String>: The launch command for the container.
containerName String: The name of the container.
environment List<ContainerEnvironmentVariable>: The environment variables of the container.
image String: The name of the image used for the container.
ports List<ContainerPortInfo>: The open firewall ports of the container.

command string[]: The launch command for the container.
containerName string: The name of the container.
environment ContainerEnvironmentVariable[]: The environment variables of the container.
image string: The name of the image used for the container.
ports ContainerPortInfo[]: The open firewall ports of the container.

command Sequence[str]: The launch command for the container.
container_name str: The name of the container.
environment Sequence[ContainerEnvironmentVariable]: The environment variables of the container.
image str: The name of the image used for the container.
ports Sequence[ContainerPortInfo]: The open firewall ports of the container.

command List<String>: The launch command for the container.
containerName String: The name of the container.
environment List<Property Map>: The environment variables of the container.
image String: The name of the image used for the container.
ports List<Property Map>: The open firewall ports of the container.

ContainerEnvironmentVariable

Value string: The environment variable value.
Variable string: The environment variable key.

Value string: The environment variable value.
Variable string: The environment variable key.

value String: The environment variable value.
variable String: The environment variable key.

value string: The environment variable value.
variable string: The environment variable key.

value str: The environment variable value.
variable str: The environment variable key.

value String: The environment variable value.
variable String: The environment variable key.

ContainerHealthCheckConfig

HealthyThreshold int: The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2.
IntervalSeconds int: The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is 5.
Path string: The path on the container on which to perform the health check. The default value is /.
SuccessCodes string: The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499. You can specify multiple values (for example, 200,202) or a range of values (for example, 200-299).
TimeoutSeconds int: The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is 2.
UnhealthyThreshold int: The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2.

HealthyThreshold int: The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2.
IntervalSeconds int: The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is 5.
Path string: The path on the container on which to perform the health check. The default value is /.
SuccessCodes string: The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499. You can specify multiple values (for example, 200,202) or a range of values (for example, 200-299).
TimeoutSeconds int: The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is 2.
UnhealthyThreshold int: The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2.

healthyThreshold Integer: The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2.
intervalSeconds Integer: The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is 5.
path String: The path on the container on which to perform the health check. The default value is /.
successCodes String: The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499. You can specify multiple values (for example, 200,202) or a range of values (for example, 200-299).
timeoutSeconds Integer: The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is 2.
unhealthyThreshold Integer: The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2.

healthyThreshold number: The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2.
intervalSeconds number: The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is 5.
path string: The path on the container on which to perform the health check. The default value is /.
successCodes string: The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499. You can specify multiple values (for example, 200,202) or a range of values (for example, 200-299).
timeoutSeconds number: The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is 2.
unhealthyThreshold number: The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2.

healthy_threshold int: The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2.
interval_seconds int: The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is 5.
path str: The path on the container on which to perform the health check. The default value is /.
success_codes str: The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499. You can specify multiple values (for example, 200,202) or a range of values (for example, 200-299).
timeout_seconds int: The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is 2.
unhealthy_threshold int: The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2.

healthyThreshold Number: The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2.
intervalSeconds Number: The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is 5.
path String: The path on the container on which to perform the health check. The default value is /.
successCodes String: The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499. You can specify multiple values (for example, 200,202) or a range of values (for example, 200-299).
timeoutSeconds Number: The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is 2.
unhealthyThreshold Number: The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2.