← All packages

Scaleway

Community

Package contributed by a community member

v0.3.0 published on Tuesday, Jun 7, 2022 by Lee Briggs

Source code

Container

Create a Container Resource

new Container(name: string, args: ContainerArgs, opts?: CustomResourceOptions);

@overload
def Container(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              cpu_limit: Optional[int] = None,
              deploy: Optional[bool] = None,
              description: Optional[str] = None,
              domain_name: Optional[str] = None,
              environment_variables: Optional[Mapping[str, str]] = None,
              max_concurrency: Optional[int] = None,
              max_scale: Optional[int] = None,
              memory_limit: Optional[int] = None,
              min_scale: Optional[int] = None,
              name: Optional[str] = None,
              namespace_id: Optional[str] = None,
              port: Optional[int] = None,
              privacy: Optional[str] = None,
              protocol: Optional[str] = None,
              registry_image: Optional[str] = None,
              status: Optional[str] = None,
              timeout: Optional[int] = None)
@overload
def Container(resource_name: str,
              args: ContainerArgs,
              opts: Optional[ResourceOptions] = None)

func NewContainer(ctx *Context, name string, args ContainerArgs, opts ...ResourceOption) (*Container, error)

public Container(string name, ContainerArgs args, CustomResourceOptions? opts = null)

public Container(String name, ContainerArgs args)
public Container(String name, ContainerArgs args, CustomResourceOptions options)

type: scaleway:Container
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ContainerArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args ContainerArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ContainerArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ContainerArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ContainerArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Container Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Container resource accepts the following input properties:

NamespaceId string: The container namespace associated
CpuLimit int: The amount of vCPU computing resources to allocate to each container. Defaults to 70.
Deploy bool: This allows you to control your production environment
Description string: The container description
DomainName string: The container domain name.
EnvironmentVariables Dictionary<string, string>: The environment variables to be injected into your container at runtime.
MaxConcurrency int: The maximum the number of simultaneous requests your container can handle at the same time. Defaults to 50.
MaxScale int: The maximum of number of instances this container can scale to. Default to 20.
MemoryLimit int: The memory computing resources in MB to allocate to each container. Defaults to 128.
MinScale int: The minimum of running container instances continuously. Defaults to 0.
Name string: The container name
Port int: The port to expose the container. Defaults to 8080
Privacy string: The privacy type define the way to authenticate to your container
Protocol string: The communication protocol http1 or h2c. Defaults to http1.
RegistryImage string: The scaleway registry image address
Status string: The container status
Timeout int: The maximum amount of time in seconds during which your container can process a request before we stop it. Defaults to 300s.

NamespaceId string: The container namespace associated
CpuLimit int: The amount of vCPU computing resources to allocate to each container. Defaults to 70.
Deploy bool: This allows you to control your production environment
Description string: The container description
DomainName string: The container domain name.
EnvironmentVariables map[string]string: The environment variables to be injected into your container at runtime.
MaxConcurrency int: The maximum the number of simultaneous requests your container can handle at the same time. Defaults to 50.
MaxScale int: The maximum of number of instances this container can scale to. Default to 20.
MemoryLimit int: The memory computing resources in MB to allocate to each container. Defaults to 128.
MinScale int: The minimum of running container instances continuously. Defaults to 0.
Name string: The container name
Port int: The port to expose the container. Defaults to 8080
Privacy string: The privacy type define the way to authenticate to your container
Protocol string: The communication protocol http1 or h2c. Defaults to http1.
RegistryImage string: The scaleway registry image address
Status string: The container status
Timeout int: The maximum amount of time in seconds during which your container can process a request before we stop it. Defaults to 300s.

namespaceId String: The container namespace associated
cpuLimit Integer: The amount of vCPU computing resources to allocate to each container. Defaults to 70.
deploy Boolean: This allows you to control your production environment
description String: The container description
domainName String: The container domain name.
environmentVariables Map<String,String>: The environment variables to be injected into your container at runtime.
maxConcurrency Integer: The maximum the number of simultaneous requests your container can handle at the same time. Defaults to 50.
maxScale Integer: The maximum of number of instances this container can scale to. Default to 20.
memoryLimit Integer: The memory computing resources in MB to allocate to each container. Defaults to 128.
minScale Integer: The minimum of running container instances continuously. Defaults to 0.
name String: The container name
port Integer: The port to expose the container. Defaults to 8080
privacy String: The privacy type define the way to authenticate to your container
protocol String: The communication protocol http1 or h2c. Defaults to http1.
registryImage String: The scaleway registry image address
status String: The container status
timeout Integer: The maximum amount of time in seconds during which your container can process a request before we stop it. Defaults to 300s.

namespaceId string: The container namespace associated
cpuLimit number: The amount of vCPU computing resources to allocate to each container. Defaults to 70.
deploy boolean: This allows you to control your production environment
description string: The container description
domainName string: The container domain name.
environmentVariables {[key: string]: string}: The environment variables to be injected into your container at runtime.
maxConcurrency number: The maximum the number of simultaneous requests your container can handle at the same time. Defaults to 50.
maxScale number: The maximum of number of instances this container can scale to. Default to 20.
memoryLimit number: The memory computing resources in MB to allocate to each container. Defaults to 128.
minScale number: The minimum of running container instances continuously. Defaults to 0.
name string: The container name
port number: The port to expose the container. Defaults to 8080
privacy string: The privacy type define the way to authenticate to your container
protocol string: The communication protocol http1 or h2c. Defaults to http1.
registryImage string: The scaleway registry image address
status string: The container status
timeout number: The maximum amount of time in seconds during which your container can process a request before we stop it. Defaults to 300s.

namespace_id str: The container namespace associated
cpu_limit int: The amount of vCPU computing resources to allocate to each container. Defaults to 70.
deploy bool: This allows you to control your production environment
description str: The container description
domain_name str: The container domain name.
environment_variables Mapping[str, str]: The environment variables to be injected into your container at runtime.
max_concurrency int: The maximum the number of simultaneous requests your container can handle at the same time. Defaults to 50.
max_scale int: The maximum of number of instances this container can scale to. Default to 20.
memory_limit int: The memory computing resources in MB to allocate to each container. Defaults to 128.
min_scale int: The minimum of running container instances continuously. Defaults to 0.
name str: The container name
port int: The port to expose the container. Defaults to 8080
privacy str: The privacy type define the way to authenticate to your container
protocol str: The communication protocol http1 or h2c. Defaults to http1.
registry_image str: The scaleway registry image address
status str: The container status
timeout int: The maximum amount of time in seconds during which your container can process a request before we stop it. Defaults to 300s.

namespaceId String: The container namespace associated
cpuLimit Number: The amount of vCPU computing resources to allocate to each container. Defaults to 70.
deploy Boolean: This allows you to control your production environment
description String: The container description
domainName String: The container domain name.
environmentVariables Map<String>: The environment variables to be injected into your container at runtime.
maxConcurrency Number: The maximum the number of simultaneous requests your container can handle at the same time. Defaults to 50.
maxScale Number: The maximum of number of instances this container can scale to. Default to 20.
memoryLimit Number: The memory computing resources in MB to allocate to each container. Defaults to 128.
minScale Number: The minimum of running container instances continuously. Defaults to 0.
name String: The container name
port Number: The port to expose the container. Defaults to 8080
privacy String: The privacy type define the way to authenticate to your container
protocol String: The communication protocol http1 or h2c. Defaults to http1.
registryImage String: The scaleway registry image address
status String: The container status
timeout Number: The maximum amount of time in seconds during which your container can process a request before we stop it. Defaults to 300s.

Outputs

All input properties are implicitly available as output properties. Additionally, the Container resource produces the following output properties:

CronStatus string: The cron status
ErrorMessage string: The error description
Id string: The provider-assigned unique ID for this managed resource.
Region string: The region of the resource

CronStatus string: The cron status
ErrorMessage string: The error description
Id string: The provider-assigned unique ID for this managed resource.
Region string: The region of the resource

cronStatus String: The cron status
errorMessage String: The error description
id String: The provider-assigned unique ID for this managed resource.
region String: The region of the resource

cronStatus string: The cron status
errorMessage string: The error description
id string: The provider-assigned unique ID for this managed resource.
region string: The region of the resource

cron_status str: The cron status
error_message str: The error description
id str: The provider-assigned unique ID for this managed resource.
region str: The region of the resource

cronStatus String: The cron status
errorMessage String: The error description
id String: The provider-assigned unique ID for this managed resource.
region String: The region of the resource

Look up an Existing Container Resource

Get an existing Container resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ContainerState, opts?: CustomResourceOptions): Container

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cpu_limit: Optional[int] = None,
        cron_status: Optional[str] = None,
        deploy: Optional[bool] = None,
        description: Optional[str] = None,
        domain_name: Optional[str] = None,
        environment_variables: Optional[Mapping[str, str]] = None,
        error_message: Optional[str] = None,
        max_concurrency: Optional[int] = None,
        max_scale: Optional[int] = None,
        memory_limit: Optional[int] = None,
        min_scale: Optional[int] = None,
        name: Optional[str] = None,
        namespace_id: Optional[str] = None,
        port: Optional[int] = None,
        privacy: Optional[str] = None,
        protocol: Optional[str] = None,
        region: Optional[str] = None,
        registry_image: Optional[str] = None,
        status: Optional[str] = None,
        timeout: Optional[int] = None) -> Container

func GetContainer(ctx *Context, name string, id IDInput, state *ContainerState, opts ...ResourceOption) (*Container, error)

public static Container Get(string name, Input<string> id, ContainerState? state, CustomResourceOptions? opts = null)

public static Container get(String name, Output<String> id, ContainerState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

CpuLimit int: The amount of vCPU computing resources to allocate to each container. Defaults to 70.
CronStatus string: The cron status
Deploy bool: This allows you to control your production environment
Description string: The container description
DomainName string: The container domain name.
EnvironmentVariables Dictionary<string, string>: The environment variables to be injected into your container at runtime.
ErrorMessage string: The error description
MaxConcurrency int: The maximum the number of simultaneous requests your container can handle at the same time. Defaults to 50.
MaxScale int: The maximum of number of instances this container can scale to. Default to 20.
MemoryLimit int: The memory computing resources in MB to allocate to each container. Defaults to 128.
MinScale int: The minimum of running container instances continuously. Defaults to 0.
Name string: The container name
NamespaceId string: The container namespace associated
Port int: The port to expose the container. Defaults to 8080
Privacy string: The privacy type define the way to authenticate to your container
Protocol string: The communication protocol http1 or h2c. Defaults to http1.
Region string: The region of the resource
RegistryImage string: The scaleway registry image address
Status string: The container status
Timeout int: The maximum amount of time in seconds during which your container can process a request before we stop it. Defaults to 300s.

CpuLimit int: The amount of vCPU computing resources to allocate to each container. Defaults to 70.
CronStatus string: The cron status
Deploy bool: This allows you to control your production environment
Description string: The container description
DomainName string: The container domain name.
EnvironmentVariables map[string]string: The environment variables to be injected into your container at runtime.
ErrorMessage string: The error description
MaxConcurrency int: The maximum the number of simultaneous requests your container can handle at the same time. Defaults to 50.
MaxScale int: The maximum of number of instances this container can scale to. Default to 20.
MemoryLimit int: The memory computing resources in MB to allocate to each container. Defaults to 128.
MinScale int: The minimum of running container instances continuously. Defaults to 0.
Name string: The container name
NamespaceId string: The container namespace associated
Port int: The port to expose the container. Defaults to 8080
Privacy string: The privacy type define the way to authenticate to your container
Protocol string: The communication protocol http1 or h2c. Defaults to http1.
Region string: The region of the resource
RegistryImage string: The scaleway registry image address
Status string: The container status
Timeout int: The maximum amount of time in seconds during which your container can process a request before we stop it. Defaults to 300s.

cpuLimit Integer: The amount of vCPU computing resources to allocate to each container. Defaults to 70.
cronStatus String: The cron status
deploy Boolean: This allows you to control your production environment
description String: The container description
domainName String: The container domain name.
environmentVariables Map<String,String>: The environment variables to be injected into your container at runtime.
errorMessage String: The error description
maxConcurrency Integer: The maximum the number of simultaneous requests your container can handle at the same time. Defaults to 50.
maxScale Integer: The maximum of number of instances this container can scale to. Default to 20.
memoryLimit Integer: The memory computing resources in MB to allocate to each container. Defaults to 128.
minScale Integer: The minimum of running container instances continuously. Defaults to 0.
name String: The container name
namespaceId String: The container namespace associated
port Integer: The port to expose the container. Defaults to 8080
privacy String: The privacy type define the way to authenticate to your container
protocol String: The communication protocol http1 or h2c. Defaults to http1.
region String: The region of the resource
registryImage String: The scaleway registry image address
status String: The container status
timeout Integer: The maximum amount of time in seconds during which your container can process a request before we stop it. Defaults to 300s.

cpuLimit number: The amount of vCPU computing resources to allocate to each container. Defaults to 70.
cronStatus string: The cron status
deploy boolean: This allows you to control your production environment
description string: The container description
domainName string: The container domain name.
environmentVariables {[key: string]: string}: The environment variables to be injected into your container at runtime.
errorMessage string: The error description
maxConcurrency number: The maximum the number of simultaneous requests your container can handle at the same time. Defaults to 50.
maxScale number: The maximum of number of instances this container can scale to. Default to 20.
memoryLimit number: The memory computing resources in MB to allocate to each container. Defaults to 128.
minScale number: The minimum of running container instances continuously. Defaults to 0.
name string: The container name
namespaceId string: The container namespace associated
port number: The port to expose the container. Defaults to 8080
privacy string: The privacy type define the way to authenticate to your container
protocol string: The communication protocol http1 or h2c. Defaults to http1.
region string: The region of the resource
registryImage string: The scaleway registry image address
status string: The container status
timeout number: The maximum amount of time in seconds during which your container can process a request before we stop it. Defaults to 300s.

cpu_limit int: The amount of vCPU computing resources to allocate to each container. Defaults to 70.
cron_status str: The cron status
deploy bool: This allows you to control your production environment
description str: The container description
domain_name str: The container domain name.
environment_variables Mapping[str, str]: The environment variables to be injected into your container at runtime.
error_message str: The error description
max_concurrency int: The maximum the number of simultaneous requests your container can handle at the same time. Defaults to 50.
max_scale int: The maximum of number of instances this container can scale to. Default to 20.
memory_limit int: The memory computing resources in MB to allocate to each container. Defaults to 128.
min_scale int: The minimum of running container instances continuously. Defaults to 0.
name str: The container name
namespace_id str: The container namespace associated
port int: The port to expose the container. Defaults to 8080
privacy str: The privacy type define the way to authenticate to your container
protocol str: The communication protocol http1 or h2c. Defaults to http1.
region str: The region of the resource
registry_image str: The scaleway registry image address
status str: The container status
timeout int: The maximum amount of time in seconds during which your container can process a request before we stop it. Defaults to 300s.

cpuLimit Number: The amount of vCPU computing resources to allocate to each container. Defaults to 70.
cronStatus String: The cron status
deploy Boolean: This allows you to control your production environment
description String: The container description
domainName String: The container domain name.
environmentVariables Map<String>: The environment variables to be injected into your container at runtime.
errorMessage String: The error description
maxConcurrency Number: The maximum the number of simultaneous requests your container can handle at the same time. Defaults to 50.
maxScale Number: The maximum of number of instances this container can scale to. Default to 20.
memoryLimit Number: The memory computing resources in MB to allocate to each container. Defaults to 128.
minScale Number: The minimum of running container instances continuously. Defaults to 0.
name String: The container name
namespaceId String: The container namespace associated
port Number: The port to expose the container. Defaults to 8080
privacy String: The privacy type define the way to authenticate to your container
protocol String: The communication protocol http1 or h2c. Defaults to http1.
region String: The region of the resource
registryImage String: The scaleway registry image address
status String: The container status
timeout Number: The maximum amount of time in seconds during which your container can process a request before we stop it. Defaults to 300s.

Package Details

Repository: https://github.com/jaxxstorm/pulumi-scaleway
License: Apache-2.0
Notes: This Pulumi package is based on the scaleway Terraform Provider.