1. Packages
  2. Docker
  3. API Docs
  4. ServiceConfig
Docker v4.5.5 published on Thursday, Jul 25, 2024 by Pulumi

docker.ServiceConfig

Explore with Pulumi AI

docker logo
Docker v4.5.5 published on Thursday, Jul 25, 2024 by Pulumi

    Import

    Example

    Assuming you created a config as follows

    #!/bin/bash

    printf ‘{“a”:“b”}’ | docker config create foo -

    prints the id

    08c26c477474478d971139f750984775a7f019dbe8a2e7f09d66a187c009e66d

    you provide the definition for the resource as follows

    terraform

    resource “docker_config” “foo” {

    name = “foo”

    data = base64encode("{"a": "b"}")

    }

    then the import command is as follows

    #!/bin/bash

    $ pulumi import docker:index/serviceConfig:ServiceConfig foo 08c26c477474478d971139f750984775a7f019dbe8a2e7f09d66a187c009e66d
    

    Create ServiceConfig Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ServiceConfig(name: string, args: ServiceConfigArgs, opts?: CustomResourceOptions);
    @overload
    def ServiceConfig(resource_name: str,
                      args: ServiceConfigArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def ServiceConfig(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      data: Optional[str] = None,
                      name: Optional[str] = None)
    func NewServiceConfig(ctx *Context, name string, args ServiceConfigArgs, opts ...ResourceOption) (*ServiceConfig, error)
    public ServiceConfig(string name, ServiceConfigArgs args, CustomResourceOptions? opts = null)
    public ServiceConfig(String name, ServiceConfigArgs args)
    public ServiceConfig(String name, ServiceConfigArgs args, CustomResourceOptions options)
    
    type: docker:ServiceConfig
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ServiceConfigArgs
    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 ServiceConfigArgs
    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 ServiceConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServiceConfigArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var serviceConfigResource = new Docker.ServiceConfig("serviceConfigResource", new()
    {
        Data = "string",
        Name = "string",
    });
    
    example, err := docker.NewServiceConfig(ctx, "serviceConfigResource", &docker.ServiceConfigArgs{
    	Data: pulumi.String("string"),
    	Name: pulumi.String("string"),
    })
    
    var serviceConfigResource = new ServiceConfig("serviceConfigResource", ServiceConfigArgs.builder()
        .data("string")
        .name("string")
        .build());
    
    service_config_resource = docker.ServiceConfig("serviceConfigResource",
        data="string",
        name="string")
    
    const serviceConfigResource = new docker.ServiceConfig("serviceConfigResource", {
        data: "string",
        name: "string",
    });
    
    type: docker:ServiceConfig
    properties:
        data: string
        name: string
    

    ServiceConfig 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 ServiceConfig resource accepts the following input properties:

    Data string
    Base64-url-safe-encoded config data
    Name string
    User-defined name of the config
    Data string
    Base64-url-safe-encoded config data
    Name string
    User-defined name of the config
    data String
    Base64-url-safe-encoded config data
    name String
    User-defined name of the config
    data string
    Base64-url-safe-encoded config data
    name string
    User-defined name of the config
    data str
    Base64-url-safe-encoded config data
    name str
    User-defined name of the config
    data String
    Base64-url-safe-encoded config data
    name String
    User-defined name of the config

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ServiceConfig Resource

    Get an existing ServiceConfig 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?: ServiceConfigState, opts?: CustomResourceOptions): ServiceConfig
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            data: Optional[str] = None,
            name: Optional[str] = None) -> ServiceConfig
    func GetServiceConfig(ctx *Context, name string, id IDInput, state *ServiceConfigState, opts ...ResourceOption) (*ServiceConfig, error)
    public static ServiceConfig Get(string name, Input<string> id, ServiceConfigState? state, CustomResourceOptions? opts = null)
    public static ServiceConfig get(String name, Output<String> id, ServiceConfigState 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:
    Data string
    Base64-url-safe-encoded config data
    Name string
    User-defined name of the config
    Data string
    Base64-url-safe-encoded config data
    Name string
    User-defined name of the config
    data String
    Base64-url-safe-encoded config data
    name String
    User-defined name of the config
    data string
    Base64-url-safe-encoded config data
    name string
    User-defined name of the config
    data str
    Base64-url-safe-encoded config data
    name str
    User-defined name of the config
    data String
    Base64-url-safe-encoded config data
    name String
    User-defined name of the config

    Package Details

    Repository
    Docker pulumi/pulumi-docker
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the docker Terraform Provider.
    docker logo
    Docker v4.5.5 published on Thursday, Jul 25, 2024 by Pulumi