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

cloudfoundry.IsolationSegmentEntitlement

Explore with Pulumi AI

cloudfoundry logo
cloudfoundry 0.54.0 published on Monday, Apr 14, 2025 by cloudfoundry-community

    Provides a Cloud Foundry resource for managing Cloud Foundry relationships between an isolation segment and an organization.

    NOTE: This resource requires the provider to be authenticated with an account granted admin permissions.

    NOTE: This resource is experimental and subject to breaking changes.

    Example Usage

    The following example entitles the segment public to organizations org1 and org2

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudfoundry from "@pulumi/cloudfoundry";
    
    const _public = new cloudfoundry.IsolationSegmentEntitlement("public", {
        segment: data.cloudfoundry_isolation_segment["public"].id,
        orgs: [
            data.cloudfloundry_org.org1.id,
            data.cloudfloundry_org.org2.id,
        ],
    });
    
    import pulumi
    import pulumi_cloudfoundry as cloudfoundry
    
    public = cloudfoundry.IsolationSegmentEntitlement("public",
        segment=data["cloudfoundry_isolation_segment"]["public"]["id"],
        orgs=[
            data["cloudfloundry_org"]["org1"]["id"],
            data["cloudfloundry_org"]["org2"]["id"],
        ])
    
    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.NewIsolationSegmentEntitlement(ctx, "public", &cloudfoundry.IsolationSegmentEntitlementArgs{
    			Segment: pulumi.Any(data.Cloudfoundry_isolation_segment.Public.Id),
    			Orgs: pulumi.StringArray{
    				data.Cloudfloundry_org.Org1.Id,
    				data.Cloudfloundry_org.Org2.Id,
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Cloudfoundry = Pulumi.Cloudfoundry;
    
    return await Deployment.RunAsync(() => 
    {
        var @public = new Cloudfoundry.IsolationSegmentEntitlement("public", new()
        {
            Segment = data.Cloudfoundry_isolation_segment.Public.Id,
            Orgs = new[]
            {
                data.Cloudfloundry_org.Org1.Id,
                data.Cloudfloundry_org.Org2.Id,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudfoundry.IsolationSegmentEntitlement;
    import com.pulumi.cloudfoundry.IsolationSegmentEntitlementArgs;
    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 IsolationSegmentEntitlement("public", IsolationSegmentEntitlementArgs.builder()
                .segment(data.cloudfoundry_isolation_segment().public().id())
                .orgs(            
                    data.cloudfloundry_org().org1().id(),
                    data.cloudfloundry_org().org2().id())
                .build());
    
        }
    }
    
    resources:
      public:
        type: cloudfoundry:IsolationSegmentEntitlement
        properties:
          segment: ${data.cloudfoundry_isolation_segment.public.id}
          orgs:
            - ${data.cloudfloundry_org.org1.id}
            - ${data.cloudfloundry_org.org2.id}
    

    Create IsolationSegmentEntitlement Resource

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

    Constructor syntax

    new IsolationSegmentEntitlement(name: string, args: IsolationSegmentEntitlementArgs, opts?: CustomResourceOptions);
    @overload
    def IsolationSegmentEntitlement(resource_name: str,
                                    args: IsolationSegmentEntitlementArgs,
                                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def IsolationSegmentEntitlement(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    orgs: Optional[Sequence[str]] = None,
                                    segment: Optional[str] = None,
                                    default: Optional[bool] = None,
                                    isolation_segment_entitlement_id: Optional[str] = None)
    func NewIsolationSegmentEntitlement(ctx *Context, name string, args IsolationSegmentEntitlementArgs, opts ...ResourceOption) (*IsolationSegmentEntitlement, error)
    public IsolationSegmentEntitlement(string name, IsolationSegmentEntitlementArgs args, CustomResourceOptions? opts = null)
    public IsolationSegmentEntitlement(String name, IsolationSegmentEntitlementArgs args)
    public IsolationSegmentEntitlement(String name, IsolationSegmentEntitlementArgs args, CustomResourceOptions options)
    
    type: cloudfoundry:IsolationSegmentEntitlement
    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 IsolationSegmentEntitlementArgs
    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 IsolationSegmentEntitlementArgs
    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 IsolationSegmentEntitlementArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IsolationSegmentEntitlementArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IsolationSegmentEntitlementArgs
    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 isolationSegmentEntitlementResource = new Cloudfoundry.IsolationSegmentEntitlement("isolationSegmentEntitlementResource", new()
    {
        Orgs = new[]
        {
            "string",
        },
        Segment = "string",
        Default = false,
        IsolationSegmentEntitlementId = "string",
    });
    
    example, err := cloudfoundry.NewIsolationSegmentEntitlement(ctx, "isolationSegmentEntitlementResource", &cloudfoundry.IsolationSegmentEntitlementArgs{
    	Orgs: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Segment:                       pulumi.String("string"),
    	Default:                       pulumi.Bool(false),
    	IsolationSegmentEntitlementId: pulumi.String("string"),
    })
    
    var isolationSegmentEntitlementResource = new IsolationSegmentEntitlement("isolationSegmentEntitlementResource", IsolationSegmentEntitlementArgs.builder()
        .orgs("string")
        .segment("string")
        .default_(false)
        .isolationSegmentEntitlementId("string")
        .build());
    
    isolation_segment_entitlement_resource = cloudfoundry.IsolationSegmentEntitlement("isolationSegmentEntitlementResource",
        orgs=["string"],
        segment="string",
        default=False,
        isolation_segment_entitlement_id="string")
    
    const isolationSegmentEntitlementResource = new cloudfoundry.IsolationSegmentEntitlement("isolationSegmentEntitlementResource", {
        orgs: ["string"],
        segment: "string",
        "default": false,
        isolationSegmentEntitlementId: "string",
    });
    
    type: cloudfoundry:IsolationSegmentEntitlement
    properties:
        default: false
        isolationSegmentEntitlementId: string
        orgs:
            - string
        segment: string
    

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

    Orgs List<string>
    List of ID of organizations that are entitled with this segment. An organization must be entitled with the segment in order to bind it to one space.
    Segment string
    The ID of the isolation segment to entitle.
    Default bool
    Set this isolation segment defined as default segment for those organizations. Default to false.
    IsolationSegmentEntitlementId string
    The GUID of the segment
    Orgs []string
    List of ID of organizations that are entitled with this segment. An organization must be entitled with the segment in order to bind it to one space.
    Segment string
    The ID of the isolation segment to entitle.
    Default bool
    Set this isolation segment defined as default segment for those organizations. Default to false.
    IsolationSegmentEntitlementId string
    The GUID of the segment
    orgs List<String>
    List of ID of organizations that are entitled with this segment. An organization must be entitled with the segment in order to bind it to one space.
    segment String
    The ID of the isolation segment to entitle.
    default_ Boolean
    Set this isolation segment defined as default segment for those organizations. Default to false.
    isolationSegmentEntitlementId String
    The GUID of the segment
    orgs string[]
    List of ID of organizations that are entitled with this segment. An organization must be entitled with the segment in order to bind it to one space.
    segment string
    The ID of the isolation segment to entitle.
    default boolean
    Set this isolation segment defined as default segment for those organizations. Default to false.
    isolationSegmentEntitlementId string
    The GUID of the segment
    orgs Sequence[str]
    List of ID of organizations that are entitled with this segment. An organization must be entitled with the segment in order to bind it to one space.
    segment str
    The ID of the isolation segment to entitle.
    default bool
    Set this isolation segment defined as default segment for those organizations. Default to false.
    isolation_segment_entitlement_id str
    The GUID of the segment
    orgs List<String>
    List of ID of organizations that are entitled with this segment. An organization must be entitled with the segment in order to bind it to one space.
    segment String
    The ID of the isolation segment to entitle.
    default Boolean
    Set this isolation segment defined as default segment for those organizations. Default to false.
    isolationSegmentEntitlementId String
    The GUID of the segment

    Outputs

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

    Get an existing IsolationSegmentEntitlement 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?: IsolationSegmentEntitlementState, opts?: CustomResourceOptions): IsolationSegmentEntitlement
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            default: Optional[bool] = None,
            isolation_segment_entitlement_id: Optional[str] = None,
            orgs: Optional[Sequence[str]] = None,
            segment: Optional[str] = None) -> IsolationSegmentEntitlement
    func GetIsolationSegmentEntitlement(ctx *Context, name string, id IDInput, state *IsolationSegmentEntitlementState, opts ...ResourceOption) (*IsolationSegmentEntitlement, error)
    public static IsolationSegmentEntitlement Get(string name, Input<string> id, IsolationSegmentEntitlementState? state, CustomResourceOptions? opts = null)
    public static IsolationSegmentEntitlement get(String name, Output<String> id, IsolationSegmentEntitlementState state, CustomResourceOptions options)
    resources:  _:    type: cloudfoundry:IsolationSegmentEntitlement    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:
    Default bool
    Set this isolation segment defined as default segment for those organizations. Default to false.
    IsolationSegmentEntitlementId string
    The GUID of the segment
    Orgs List<string>
    List of ID of organizations that are entitled with this segment. An organization must be entitled with the segment in order to bind it to one space.
    Segment string
    The ID of the isolation segment to entitle.
    Default bool
    Set this isolation segment defined as default segment for those organizations. Default to false.
    IsolationSegmentEntitlementId string
    The GUID of the segment
    Orgs []string
    List of ID of organizations that are entitled with this segment. An organization must be entitled with the segment in order to bind it to one space.
    Segment string
    The ID of the isolation segment to entitle.
    default_ Boolean
    Set this isolation segment defined as default segment for those organizations. Default to false.
    isolationSegmentEntitlementId String
    The GUID of the segment
    orgs List<String>
    List of ID of organizations that are entitled with this segment. An organization must be entitled with the segment in order to bind it to one space.
    segment String
    The ID of the isolation segment to entitle.
    default boolean
    Set this isolation segment defined as default segment for those organizations. Default to false.
    isolationSegmentEntitlementId string
    The GUID of the segment
    orgs string[]
    List of ID of organizations that are entitled with this segment. An organization must be entitled with the segment in order to bind it to one space.
    segment string
    The ID of the isolation segment to entitle.
    default bool
    Set this isolation segment defined as default segment for those organizations. Default to false.
    isolation_segment_entitlement_id str
    The GUID of the segment
    orgs Sequence[str]
    List of ID of organizations that are entitled with this segment. An organization must be entitled with the segment in order to bind it to one space.
    segment str
    The ID of the isolation segment to entitle.
    default Boolean
    Set this isolation segment defined as default segment for those organizations. Default to false.
    isolationSegmentEntitlementId String
    The GUID of the segment
    orgs List<String>
    List of ID of organizations that are entitled with this segment. An organization must be entitled with the segment in order to bind it to one space.
    segment String
    The ID of the isolation segment to entitle.

    Import

    Import not yet supported.

    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.
    cloudfoundry logo
    cloudfoundry 0.54.0 published on Monday, Apr 14, 2025 by cloudfoundry-community