Docs Home
Formal v1.0.2 published on Thursday, Aug 14, 2025 by Formal
formal.SidecarResourceLink
Explore with Pulumi AI
Linking a Resource to a Sidecar in Formal.
Create SidecarResourceLink Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SidecarResourceLink(name: string, args: SidecarResourceLinkArgs, opts?: CustomResourceOptions);@overload
def SidecarResourceLink(resource_name: str,
args: SidecarResourceLinkArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SidecarResourceLink(resource_name: str,
opts: Optional[ResourceOptions] = None,
port: Optional[int] = None,
resource_id: Optional[str] = None,
sidecar_id: Optional[str] = None,
termination_protection: Optional[bool] = None)func NewSidecarResourceLink(ctx *Context, name string, args SidecarResourceLinkArgs, opts ...ResourceOption) (*SidecarResourceLink, error)public SidecarResourceLink(string name, SidecarResourceLinkArgs args, CustomResourceOptions? opts = null)
public SidecarResourceLink(String name, SidecarResourceLinkArgs args)
public SidecarResourceLink(String name, SidecarResourceLinkArgs args, CustomResourceOptions options)
type: formal:SidecarResourceLink
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 SidecarResourceLinkArgs
- 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 SidecarResourceLinkArgs
- 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 SidecarResourceLinkArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SidecarResourceLinkArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SidecarResourceLinkArgs
- 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 sidecarResourceLinkResource = new Pulumi.SidecarResourceLink("sidecarResourceLinkResource", new()
{
Port = 0,
ResourceId = "string",
SidecarId = "string",
TerminationProtection = false,
});
example, err := formal.NewSidecarResourceLink(ctx, "sidecarResourceLinkResource", &formal.SidecarResourceLinkArgs{
Port: pulumi.Int(0),
ResourceId: pulumi.String("string"),
SidecarId: pulumi.String("string"),
TerminationProtection: pulumi.Bool(false),
})
var sidecarResourceLinkResource = new SidecarResourceLink("sidecarResourceLinkResource", SidecarResourceLinkArgs.builder()
.port(0)
.resourceId("string")
.sidecarId("string")
.terminationProtection(false)
.build());
sidecar_resource_link_resource = formal.SidecarResourceLink("sidecarResourceLinkResource",
port=0,
resource_id="string",
sidecar_id="string",
termination_protection=False)
const sidecarResourceLinkResource = new formal.SidecarResourceLink("sidecarResourceLinkResource", {
port: 0,
resourceId: "string",
sidecarId: "string",
terminationProtection: false,
});
type: formal:SidecarResourceLink
properties:
port: 0
resourceId: string
sidecarId: string
terminationProtection: false
SidecarResourceLink 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 SidecarResourceLink resource accepts the following input properties:
- Port int
- Port.
- Resource
Id string - Resource ID to be linked.
- Sidecar
Id string - Sidecar ID that should be linked.
- Termination
Protection bool - If set to true, this Sidecar Datastore Link cannot be deleted.
- Port int
- Port.
- Resource
Id string - Resource ID to be linked.
- Sidecar
Id string - Sidecar ID that should be linked.
- Termination
Protection bool - If set to true, this Sidecar Datastore Link cannot be deleted.
- port Integer
- Port.
- resource
Id String - Resource ID to be linked.
- sidecar
Id String - Sidecar ID that should be linked.
- termination
Protection Boolean - If set to true, this Sidecar Datastore Link cannot be deleted.
- port number
- Port.
- resource
Id string - Resource ID to be linked.
- sidecar
Id string - Sidecar ID that should be linked.
- termination
Protection boolean - If set to true, this Sidecar Datastore Link cannot be deleted.
- port int
- Port.
- resource_
id str - Resource ID to be linked.
- sidecar_
id str - Sidecar ID that should be linked.
- termination_
protection bool - If set to true, this Sidecar Datastore Link cannot be deleted.
- port Number
- Port.
- resource
Id String - Resource ID to be linked.
- sidecar
Id String - Sidecar ID that should be linked.
- termination
Protection Boolean - If set to true, this Sidecar Datastore Link cannot be deleted.
Outputs
All input properties are implicitly available as output properties. Additionally, the SidecarResourceLink 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 SidecarResourceLink Resource
Get an existing SidecarResourceLink 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?: SidecarResourceLinkState, opts?: CustomResourceOptions): SidecarResourceLink@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
port: Optional[int] = None,
resource_id: Optional[str] = None,
sidecar_id: Optional[str] = None,
termination_protection: Optional[bool] = None) -> SidecarResourceLinkfunc GetSidecarResourceLink(ctx *Context, name string, id IDInput, state *SidecarResourceLinkState, opts ...ResourceOption) (*SidecarResourceLink, error)public static SidecarResourceLink Get(string name, Input<string> id, SidecarResourceLinkState? state, CustomResourceOptions? opts = null)public static SidecarResourceLink get(String name, Output<String> id, SidecarResourceLinkState state, CustomResourceOptions options)resources: _: type: formal:SidecarResourceLink 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.
- Port int
- Port.
- Resource
Id string - Resource ID to be linked.
- Sidecar
Id string - Sidecar ID that should be linked.
- Termination
Protection bool - If set to true, this Sidecar Datastore Link cannot be deleted.
- Port int
- Port.
- Resource
Id string - Resource ID to be linked.
- Sidecar
Id string - Sidecar ID that should be linked.
- Termination
Protection bool - If set to true, this Sidecar Datastore Link cannot be deleted.
- port Integer
- Port.
- resource
Id String - Resource ID to be linked.
- sidecar
Id String - Sidecar ID that should be linked.
- termination
Protection Boolean - If set to true, this Sidecar Datastore Link cannot be deleted.
- port number
- Port.
- resource
Id string - Resource ID to be linked.
- sidecar
Id string - Sidecar ID that should be linked.
- termination
Protection boolean - If set to true, this Sidecar Datastore Link cannot be deleted.
- port int
- Port.
- resource_
id str - Resource ID to be linked.
- sidecar_
id str - Sidecar ID that should be linked.
- termination_
protection bool - If set to true, this Sidecar Datastore Link cannot be deleted.
- port Number
- Port.
- resource
Id String - Resource ID to be linked.
- sidecar
Id String - Sidecar ID that should be linked.
- termination
Protection Boolean - If set to true, this Sidecar Datastore Link cannot be deleted.
Package Details
- Repository
- formal formalco/pulumi-formal
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
formalTerraform Provider.