Formal v1.0.3, Aug 18 25

Formal v1.0.3 published on Monday, Aug 18, 2025 by Formal

formal.Sidecar

Explore with Pulumi AI

Formal v1.0.3 published on Monday, Aug 18, 2025 by Formal

Create Sidecar Resource

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

Constructor syntax

new Sidecar(name: string, args: SidecarArgs, opts?: CustomResourceOptions);

@overload
def Sidecar(resource_name: str,
            args: SidecarArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Sidecar(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            hostname: Optional[str] = None,
            technology: Optional[str] = None,
            name: Optional[str] = None,
            termination_protection: Optional[bool] = None,
            version: Optional[str] = None)

func NewSidecar(ctx *Context, name string, args SidecarArgs, opts ...ResourceOption) (*Sidecar, error)

public Sidecar(string name, SidecarArgs args, CustomResourceOptions? opts = null)

public Sidecar(String name, SidecarArgs args)
public Sidecar(String name, SidecarArgs args, CustomResourceOptions options)

type: formal:Sidecar
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 SidecarArgs: 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 SidecarArgs: 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 SidecarArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args SidecarArgs: 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 sidecarResource = new Pulumi.Sidecar("sidecarResource", new()
{
    Hostname = "string",
    Technology = "string",
    Name = "string",
    TerminationProtection = false,
    Version = "string",
});

example, err := formal.NewSidecar(ctx, "sidecarResource", &formal.SidecarArgs{
	Hostname:              pulumi.String("string"),
	Technology:            pulumi.String("string"),
	Name:                  pulumi.String("string"),
	TerminationProtection: pulumi.Bool(false),
	Version:               pulumi.String("string"),
})

var sidecarResource = new Sidecar("sidecarResource", SidecarArgs.builder()
    .hostname("string")
    .technology("string")
    .name("string")
    .terminationProtection(false)
    .version("string")
    .build());

sidecar_resource = formal.Sidecar("sidecarResource",
    hostname="string",
    technology="string",
    name="string",
    termination_protection=False,
    version="string")

const sidecarResource = new formal.Sidecar("sidecarResource", {
    hostname: "string",
    technology: "string",
    name: "string",
    terminationProtection: false,
    version: "string",
});

type: formal:Sidecar
properties:
    hostname: string
    name: string
    technology: string
    terminationProtection: false
    version: string

Sidecar Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Sidecar resource accepts the following input properties:

Hostname string: The hostname of the created sidecar.
Technology string: Technology of the Datastore: supported values aresnowflake, postgres, redshift, mysql, mariadb, s3, dynamodb, mongodb, documentdb, http and ssh.
Name string: Friendly name for this Sidecar.
TerminationProtection bool: If set to true, this Sidecar cannot be deleted.
Version string: Version of the Sidecar to deploy for managed.

Hostname string: The hostname of the created sidecar.
Technology string: Technology of the Datastore: supported values aresnowflake, postgres, redshift, mysql, mariadb, s3, dynamodb, mongodb, documentdb, http and ssh.
Name string: Friendly name for this Sidecar.
TerminationProtection bool: If set to true, this Sidecar cannot be deleted.
Version string: Version of the Sidecar to deploy for managed.

hostname String: The hostname of the created sidecar.
technology String: Technology of the Datastore: supported values aresnowflake, postgres, redshift, mysql, mariadb, s3, dynamodb, mongodb, documentdb, http and ssh.
name String: Friendly name for this Sidecar.
terminationProtection Boolean: If set to true, this Sidecar cannot be deleted.
version String: Version of the Sidecar to deploy for managed.

hostname string: The hostname of the created sidecar.
technology string: Technology of the Datastore: supported values aresnowflake, postgres, redshift, mysql, mariadb, s3, dynamodb, mongodb, documentdb, http and ssh.
name string: Friendly name for this Sidecar.
terminationProtection boolean: If set to true, this Sidecar cannot be deleted.
version string: Version of the Sidecar to deploy for managed.

hostname str: The hostname of the created sidecar.
technology str: Technology of the Datastore: supported values aresnowflake, postgres, redshift, mysql, mariadb, s3, dynamodb, mongodb, documentdb, http and ssh.
name str: Friendly name for this Sidecar.
termination_protection bool: If set to true, this Sidecar cannot be deleted.
version str: Version of the Sidecar to deploy for managed.

hostname String: The hostname of the created sidecar.
technology String: Technology of the Datastore: supported values aresnowflake, postgres, redshift, mysql, mariadb, s3, dynamodb, mongodb, documentdb, http and ssh.
name String: Friendly name for this Sidecar.
terminationProtection Boolean: If set to true, this Sidecar cannot be deleted.
version String: Version of the Sidecar to deploy for managed.

Outputs

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

ApiKey string: Api key for the deployed Sidecar.
CreatedAt int: Creation time of the sidecar.
FormalControlPlaneTlsCertificate string: If deployment_type is onprem, this is the Control Plane TLS Certificate to add to the deployed Sidecar.
Id string: The provider-assigned unique ID for this managed resource.

ApiKey string: Api key for the deployed Sidecar.
CreatedAt int: Creation time of the sidecar.
FormalControlPlaneTlsCertificate string: If deployment_type is onprem, this is the Control Plane TLS Certificate to add to the deployed Sidecar.
Id string: The provider-assigned unique ID for this managed resource.

apiKey String: Api key for the deployed Sidecar.
createdAt Integer: Creation time of the sidecar.
formalControlPlaneTlsCertificate String: If deployment_type is onprem, this is the Control Plane TLS Certificate to add to the deployed Sidecar.
id String: The provider-assigned unique ID for this managed resource.

apiKey string: Api key for the deployed Sidecar.
createdAt number: Creation time of the sidecar.
formalControlPlaneTlsCertificate string: If deployment_type is onprem, this is the Control Plane TLS Certificate to add to the deployed Sidecar.
id string: The provider-assigned unique ID for this managed resource.

api_key str: Api key for the deployed Sidecar.
created_at int: Creation time of the sidecar.
formal_control_plane_tls_certificate str: If deployment_type is onprem, this is the Control Plane TLS Certificate to add to the deployed Sidecar.
id str: The provider-assigned unique ID for this managed resource.

apiKey String: Api key for the deployed Sidecar.
createdAt Number: Creation time of the sidecar.
formalControlPlaneTlsCertificate String: If deployment_type is onprem, this is the Control Plane TLS Certificate to add to the deployed Sidecar.
id String: The provider-assigned unique ID for this managed resource.

Look up Existing Sidecar Resource

Get an existing Sidecar 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?: SidecarState, opts?: CustomResourceOptions): Sidecar

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_key: Optional[str] = None,
        created_at: Optional[int] = None,
        formal_control_plane_tls_certificate: Optional[str] = None,
        hostname: Optional[str] = None,
        name: Optional[str] = None,
        technology: Optional[str] = None,
        termination_protection: Optional[bool] = None,
        version: Optional[str] = None) -> Sidecar

func GetSidecar(ctx *Context, name string, id IDInput, state *SidecarState, opts ...ResourceOption) (*Sidecar, error)

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

public static Sidecar get(String name, Output<String> id, SidecarState state, CustomResourceOptions options)

resources:  _:    type: formal:Sidecar    get:      id: ${id}

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:

ApiKey string: Api key for the deployed Sidecar.
CreatedAt int: Creation time of the sidecar.
FormalControlPlaneTlsCertificate string: If deployment_type is onprem, this is the Control Plane TLS Certificate to add to the deployed Sidecar.
Hostname string: The hostname of the created sidecar.
Name string: Friendly name for this Sidecar.
Technology string: Technology of the Datastore: supported values aresnowflake, postgres, redshift, mysql, mariadb, s3, dynamodb, mongodb, documentdb, http and ssh.
TerminationProtection bool: If set to true, this Sidecar cannot be deleted.
Version string: Version of the Sidecar to deploy for managed.

ApiKey string: Api key for the deployed Sidecar.
CreatedAt int: Creation time of the sidecar.
FormalControlPlaneTlsCertificate string: If deployment_type is onprem, this is the Control Plane TLS Certificate to add to the deployed Sidecar.
Hostname string: The hostname of the created sidecar.
Name string: Friendly name for this Sidecar.
Technology string: Technology of the Datastore: supported values aresnowflake, postgres, redshift, mysql, mariadb, s3, dynamodb, mongodb, documentdb, http and ssh.
TerminationProtection bool: If set to true, this Sidecar cannot be deleted.
Version string: Version of the Sidecar to deploy for managed.

apiKey String: Api key for the deployed Sidecar.
createdAt Integer: Creation time of the sidecar.
formalControlPlaneTlsCertificate String: If deployment_type is onprem, this is the Control Plane TLS Certificate to add to the deployed Sidecar.
hostname String: The hostname of the created sidecar.
name String: Friendly name for this Sidecar.
technology String: Technology of the Datastore: supported values aresnowflake, postgres, redshift, mysql, mariadb, s3, dynamodb, mongodb, documentdb, http and ssh.
terminationProtection Boolean: If set to true, this Sidecar cannot be deleted.
version String: Version of the Sidecar to deploy for managed.

apiKey string: Api key for the deployed Sidecar.
createdAt number: Creation time of the sidecar.
formalControlPlaneTlsCertificate string: If deployment_type is onprem, this is the Control Plane TLS Certificate to add to the deployed Sidecar.
hostname string: The hostname of the created sidecar.
name string: Friendly name for this Sidecar.
technology string: Technology of the Datastore: supported values aresnowflake, postgres, redshift, mysql, mariadb, s3, dynamodb, mongodb, documentdb, http and ssh.
terminationProtection boolean: If set to true, this Sidecar cannot be deleted.
version string: Version of the Sidecar to deploy for managed.

api_key str: Api key for the deployed Sidecar.
created_at int: Creation time of the sidecar.
formal_control_plane_tls_certificate str: If deployment_type is onprem, this is the Control Plane TLS Certificate to add to the deployed Sidecar.
hostname str: The hostname of the created sidecar.
name str: Friendly name for this Sidecar.
technology str: Technology of the Datastore: supported values aresnowflake, postgres, redshift, mysql, mariadb, s3, dynamodb, mongodb, documentdb, http and ssh.
termination_protection bool: If set to true, this Sidecar cannot be deleted.
version str: Version of the Sidecar to deploy for managed.

apiKey String: Api key for the deployed Sidecar.
createdAt Number: Creation time of the sidecar.
formalControlPlaneTlsCertificate String: If deployment_type is onprem, this is the Control Plane TLS Certificate to add to the deployed Sidecar.
hostname String: The hostname of the created sidecar.
name String: Friendly name for this Sidecar.
technology String: Technology of the Datastore: supported values aresnowflake, postgres, redshift, mysql, mariadb, s3, dynamodb, mongodb, documentdb, http and ssh.
terminationProtection Boolean: If set to true, this Sidecar cannot be deleted.
version String: Version of the Sidecar to deploy for managed.

Package Details

Repository: formal formalco/pulumi-formal
License: MPL-2.0
Notes: This Pulumi package is based on the formal Terraform Provider.

Formal v1.0.3 published on Monday, Aug 18, 2025 by Formal

formalco/pulumi-formal

formal.Sidecar

On this page

On this page

Create Sidecar Resource

Constructor syntax

Parameters

Constructor example

Sidecar Resource Properties

Inputs

Outputs

Look up Existing Sidecar Resource

Package Details

On this page

On this page