1. Packages
  2. Cloudfoundry Provider
  3. API Docs
  4. IsolationSegment
cloudfoundry 0.54.0 published on Monday, Apr 14, 2025 by cloudfoundry-community

cloudfoundry.IsolationSegment

Explore with Pulumi AI

Example Usage

The following example creates an isolation segment named public_exposure

import * as pulumi from "@pulumi/pulumi";
import * as cloudfoundry from "@pulumi/cloudfoundry";

const _public = new cloudfoundry.IsolationSegment("public", {});
Copy
import pulumi
import pulumi_cloudfoundry as cloudfoundry

public = cloudfoundry.IsolationSegment("public")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/cloudfoundry/cloudfoundry"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudfoundry.NewIsolationSegment(ctx, "public", nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudfoundry = Pulumi.Cloudfoundry;

return await Deployment.RunAsync(() => 
{
    var @public = new Cloudfoundry.IsolationSegment("public");

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudfoundry.IsolationSegment;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var public_ = new IsolationSegment("public");

    }
}
Copy
resources:
  public:
    type: cloudfoundry:IsolationSegment
Copy

Create IsolationSegment Resource

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

Constructor syntax

new IsolationSegment(name: string, args?: IsolationSegmentArgs, opts?: CustomResourceOptions);
@overload
def IsolationSegment(resource_name: str,
                     args: Optional[IsolationSegmentArgs] = None,
                     opts: Optional[ResourceOptions] = None)

@overload
def IsolationSegment(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     annotations: Optional[Mapping[str, str]] = None,
                     isolation_segment_id: Optional[str] = None,
                     labels: Optional[Mapping[str, str]] = None,
                     name: Optional[str] = None)
func NewIsolationSegment(ctx *Context, name string, args *IsolationSegmentArgs, opts ...ResourceOption) (*IsolationSegment, error)
public IsolationSegment(string name, IsolationSegmentArgs? args = null, CustomResourceOptions? opts = null)
public IsolationSegment(String name, IsolationSegmentArgs args)
public IsolationSegment(String name, IsolationSegmentArgs args, CustomResourceOptions options)
type: cloudfoundry:IsolationSegment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args IsolationSegmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args IsolationSegmentArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args IsolationSegmentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args IsolationSegmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. IsolationSegmentArgs
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 isolationSegmentResource = new Cloudfoundry.IsolationSegment("isolationSegmentResource", new()
{
    Annotations = 
    {
        { "string", "string" },
    },
    IsolationSegmentId = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Name = "string",
});
Copy
example, err := cloudfoundry.NewIsolationSegment(ctx, "isolationSegmentResource", &cloudfoundry.IsolationSegmentArgs{
Annotations: pulumi.StringMap{
"string": pulumi.String("string"),
},
IsolationSegmentId: pulumi.String("string"),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
Name: pulumi.String("string"),
})
Copy
var isolationSegmentResource = new IsolationSegment("isolationSegmentResource", IsolationSegmentArgs.builder()
    .annotations(Map.of("string", "string"))
    .isolationSegmentId("string")
    .labels(Map.of("string", "string"))
    .name("string")
    .build());
Copy
isolation_segment_resource = cloudfoundry.IsolationSegment("isolationSegmentResource",
    annotations={
        "string": "string",
    },
    isolation_segment_id="string",
    labels={
        "string": "string",
    },
    name="string")
Copy
const isolationSegmentResource = new cloudfoundry.IsolationSegment("isolationSegmentResource", {
    annotations: {
        string: "string",
    },
    isolationSegmentId: "string",
    labels: {
        string: "string",
    },
    name: "string",
});
Copy
type: cloudfoundry:IsolationSegment
properties:
    annotations:
        string: string
    isolationSegmentId: string
    labels:
        string: string
    name: string
Copy

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

Annotations Dictionary<string, string>
Add annotations as described here. Works only on cloud foundry with api >= v3.63.
IsolationSegmentId string
The GUID of the segment
Labels Dictionary<string, string>
Add labels as described here. Works only on cloud foundry with api >= v3.63.
Name string
Isolation Segment names must be unique across the entire system, and case is ignored when checking for uniqueness. The name must match the value specified in the placement_tags section of the Diego manifest file. If the names do not match, Cloud Foundry fails to place apps in the isolation segment when apps are started or restarted in the space assigned to the isolation segment.
Annotations map[string]string
Add annotations as described here. Works only on cloud foundry with api >= v3.63.
IsolationSegmentId string
The GUID of the segment
Labels map[string]string
Add labels as described here. Works only on cloud foundry with api >= v3.63.
Name string
Isolation Segment names must be unique across the entire system, and case is ignored when checking for uniqueness. The name must match the value specified in the placement_tags section of the Diego manifest file. If the names do not match, Cloud Foundry fails to place apps in the isolation segment when apps are started or restarted in the space assigned to the isolation segment.
annotations Map<String,String>
Add annotations as described here. Works only on cloud foundry with api >= v3.63.
isolationSegmentId String
The GUID of the segment
labels Map<String,String>
Add labels as described here. Works only on cloud foundry with api >= v3.63.
name String
Isolation Segment names must be unique across the entire system, and case is ignored when checking for uniqueness. The name must match the value specified in the placement_tags section of the Diego manifest file. If the names do not match, Cloud Foundry fails to place apps in the isolation segment when apps are started or restarted in the space assigned to the isolation segment.
annotations {[key: string]: string}
Add annotations as described here. Works only on cloud foundry with api >= v3.63.
isolationSegmentId string
The GUID of the segment
labels {[key: string]: string}
Add labels as described here. Works only on cloud foundry with api >= v3.63.
name string
Isolation Segment names must be unique across the entire system, and case is ignored when checking for uniqueness. The name must match the value specified in the placement_tags section of the Diego manifest file. If the names do not match, Cloud Foundry fails to place apps in the isolation segment when apps are started or restarted in the space assigned to the isolation segment.
annotations Mapping[str, str]
Add annotations as described here. Works only on cloud foundry with api >= v3.63.
isolation_segment_id str
The GUID of the segment
labels Mapping[str, str]
Add labels as described here. Works only on cloud foundry with api >= v3.63.
name str
Isolation Segment names must be unique across the entire system, and case is ignored when checking for uniqueness. The name must match the value specified in the placement_tags section of the Diego manifest file. If the names do not match, Cloud Foundry fails to place apps in the isolation segment when apps are started or restarted in the space assigned to the isolation segment.
annotations Map<String>
Add annotations as described here. Works only on cloud foundry with api >= v3.63.
isolationSegmentId String
The GUID of the segment
labels Map<String>
Add labels as described here. Works only on cloud foundry with api >= v3.63.
name String
Isolation Segment names must be unique across the entire system, and case is ignored when checking for uniqueness. The name must match the value specified in the placement_tags section of the Diego manifest file. If the names do not match, Cloud Foundry fails to place apps in the isolation segment when apps are started or restarted in the space assigned to the isolation segment.

Outputs

All input properties are implicitly available as output properties. Additionally, the IsolationSegment 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 IsolationSegment Resource

Get an existing IsolationSegment 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?: IsolationSegmentState, opts?: CustomResourceOptions): IsolationSegment
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        annotations: Optional[Mapping[str, str]] = None,
        isolation_segment_id: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None) -> IsolationSegment
func GetIsolationSegment(ctx *Context, name string, id IDInput, state *IsolationSegmentState, opts ...ResourceOption) (*IsolationSegment, error)
public static IsolationSegment Get(string name, Input<string> id, IsolationSegmentState? state, CustomResourceOptions? opts = null)
public static IsolationSegment get(String name, Output<String> id, IsolationSegmentState state, CustomResourceOptions options)
resources:  _:    type: cloudfoundry:IsolationSegment    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Annotations Dictionary<string, string>
Add annotations as described here. Works only on cloud foundry with api >= v3.63.
IsolationSegmentId string
The GUID of the segment
Labels Dictionary<string, string>
Add labels as described here. Works only on cloud foundry with api >= v3.63.
Name string
Isolation Segment names must be unique across the entire system, and case is ignored when checking for uniqueness. The name must match the value specified in the placement_tags section of the Diego manifest file. If the names do not match, Cloud Foundry fails to place apps in the isolation segment when apps are started or restarted in the space assigned to the isolation segment.
Annotations map[string]string
Add annotations as described here. Works only on cloud foundry with api >= v3.63.
IsolationSegmentId string
The GUID of the segment
Labels map[string]string
Add labels as described here. Works only on cloud foundry with api >= v3.63.
Name string
Isolation Segment names must be unique across the entire system, and case is ignored when checking for uniqueness. The name must match the value specified in the placement_tags section of the Diego manifest file. If the names do not match, Cloud Foundry fails to place apps in the isolation segment when apps are started or restarted in the space assigned to the isolation segment.
annotations Map<String,String>
Add annotations as described here. Works only on cloud foundry with api >= v3.63.
isolationSegmentId String
The GUID of the segment
labels Map<String,String>
Add labels as described here. Works only on cloud foundry with api >= v3.63.
name String
Isolation Segment names must be unique across the entire system, and case is ignored when checking for uniqueness. The name must match the value specified in the placement_tags section of the Diego manifest file. If the names do not match, Cloud Foundry fails to place apps in the isolation segment when apps are started or restarted in the space assigned to the isolation segment.
annotations {[key: string]: string}
Add annotations as described here. Works only on cloud foundry with api >= v3.63.
isolationSegmentId string
The GUID of the segment
labels {[key: string]: string}
Add labels as described here. Works only on cloud foundry with api >= v3.63.
name string
Isolation Segment names must be unique across the entire system, and case is ignored when checking for uniqueness. The name must match the value specified in the placement_tags section of the Diego manifest file. If the names do not match, Cloud Foundry fails to place apps in the isolation segment when apps are started or restarted in the space assigned to the isolation segment.
annotations Mapping[str, str]
Add annotations as described here. Works only on cloud foundry with api >= v3.63.
isolation_segment_id str
The GUID of the segment
labels Mapping[str, str]
Add labels as described here. Works only on cloud foundry with api >= v3.63.
name str
Isolation Segment names must be unique across the entire system, and case is ignored when checking for uniqueness. The name must match the value specified in the placement_tags section of the Diego manifest file. If the names do not match, Cloud Foundry fails to place apps in the isolation segment when apps are started or restarted in the space assigned to the isolation segment.
annotations Map<String>
Add annotations as described here. Works only on cloud foundry with api >= v3.63.
isolationSegmentId String
The GUID of the segment
labels Map<String>
Add labels as described here. Works only on cloud foundry with api >= v3.63.
name String
Isolation Segment names must be unique across the entire system, and case is ignored when checking for uniqueness. The name must match the value specified in the placement_tags section of the Diego manifest file. If the names do not match, Cloud Foundry fails to place apps in the isolation segment when apps are started or restarted in the space assigned to the isolation segment.

Import

An existing segment can be imported using its guid, e.g.

bash

$ pulumi import cloudfoundry:index/isolationSegment:IsolationSegment s1 a-guid
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
cloudfoundry cloudfoundry-community/terraform-provider-cloudfoundry
License
Notes
This Pulumi package is based on the cloudfoundry Terraform Provider.