1. Packages
  2. Ibm Provider
  3. API Docs
  4. IsShareReplicaOperations
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.IsShareReplicaOperations

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const example = new ibm.IsShare("example", {
        profile: "dp2",
        size: 200,
        zone: "us-south-2",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    example = ibm.IsShare("example",
        profile="dp2",
        size=200,
        zone="us-south-2")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ibm.NewIsShare(ctx, "example", &ibm.IsShareArgs{
    			Profile: pulumi.String("dp2"),
    			Size:    pulumi.Float64(200),
    			Zone:    pulumi.String("us-south-2"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ibm = Pulumi.Ibm;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Ibm.IsShare("example", new()
        {
            Profile = "dp2",
            Size = 200,
            Zone = "us-south-2",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.IsShare;
    import com.pulumi.ibm.IsShareArgs;
    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 example = new IsShare("example", IsShareArgs.builder()
                .profile("dp2")
                .size(200)
                .zone("us-south-2")
                .build());
    
        }
    }
    
    resources:
      example:
        type: ibm:IsShare
        properties:
          profile: dp2
          size: 200
          zone: us-south-2
    

    Create A Replica Share)

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const example1 = new ibm.IsShare("example1", {
        zone: "us-south-3",
        sourceShare: ibm_is_share.example.id,
        profile: "dp2",
        replicationCronSpec: "0 */5 * * *",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    example1 = ibm.IsShare("example1",
        zone="us-south-3",
        source_share=ibm_is_share["example"]["id"],
        profile="dp2",
        replication_cron_spec="0 */5 * * *")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ibm.NewIsShare(ctx, "example1", &ibm.IsShareArgs{
    			Zone:                pulumi.String("us-south-3"),
    			SourceShare:         pulumi.Any(ibm_is_share.Example.Id),
    			Profile:             pulumi.String("dp2"),
    			ReplicationCronSpec: pulumi.String("0 */5 * * *"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ibm = Pulumi.Ibm;
    
    return await Deployment.RunAsync(() => 
    {
        var example1 = new Ibm.IsShare("example1", new()
        {
            Zone = "us-south-3",
            SourceShare = ibm_is_share.Example.Id,
            Profile = "dp2",
            ReplicationCronSpec = "0 */5 * * *",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.IsShare;
    import com.pulumi.ibm.IsShareArgs;
    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 example1 = new IsShare("example1", IsShareArgs.builder()
                .zone("us-south-3")
                .sourceShare(ibm_is_share.example().id())
                .profile("dp2")
                .replicationCronSpec("0 */5 * * *")
                .build());
    
        }
    }
    
    resources:
      example1:
        type: ibm:IsShare
        properties:
          zone: us-south-3
          sourceShare: ${ibm_is_share.example.id}
          profile: dp2
          replicationCronSpec: 0 */5 * * *
    

    Additional Examples

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    // Split source share and replica share
    const test = new ibm.IsShareReplicaOperations("test", {
        shareReplica: ibm_is_share.example1.id,
        splitShare: true,
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    # Split source share and replica share
    test = ibm.IsShareReplicaOperations("test",
        share_replica=ibm_is_share["example1"]["id"],
        split_share=True)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		// Split source share and replica share
    		_, err := ibm.NewIsShareReplicaOperations(ctx, "test", &ibm.IsShareReplicaOperationsArgs{
    			ShareReplica: pulumi.Any(ibm_is_share.Example1.Id),
    			SplitShare:   pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ibm = Pulumi.Ibm;
    
    return await Deployment.RunAsync(() => 
    {
        // Split source share and replica share
        var test = new Ibm.IsShareReplicaOperations("test", new()
        {
            ShareReplica = ibm_is_share.Example1.Id,
            SplitShare = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.IsShareReplicaOperations;
    import com.pulumi.ibm.IsShareReplicaOperationsArgs;
    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) {
            // Split source share and replica share
            var test = new IsShareReplicaOperations("test", IsShareReplicaOperationsArgs.builder()
                .shareReplica(ibm_is_share.example1().id())
                .splitShare(true)
                .build());
    
        }
    }
    
    resources:
      # Split source share and replica share
      test:
        type: ibm:IsShareReplicaOperations
        properties:
          shareReplica: ${ibm_is_share.example1.id}
          splitShare: true
    
    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    // failover to replica share
    const test = new ibm.IsShareReplicaOperations("test", {
        shareReplica: ibm_is_share.example1.id,
        fallbackPolicy: "split",
        timeout: 500,
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    # failover to replica share
    test = ibm.IsShareReplicaOperations("test",
        share_replica=ibm_is_share["example1"]["id"],
        fallback_policy="split",
        timeout=500)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		// failover to replica share
    		_, err := ibm.NewIsShareReplicaOperations(ctx, "test", &ibm.IsShareReplicaOperationsArgs{
    			ShareReplica:   pulumi.Any(ibm_is_share.Example1.Id),
    			FallbackPolicy: pulumi.String("split"),
    			Timeout:        pulumi.Float64(500),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ibm = Pulumi.Ibm;
    
    return await Deployment.RunAsync(() => 
    {
        // failover to replica share
        var test = new Ibm.IsShareReplicaOperations("test", new()
        {
            ShareReplica = ibm_is_share.Example1.Id,
            FallbackPolicy = "split",
            Timeout = 500,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.IsShareReplicaOperations;
    import com.pulumi.ibm.IsShareReplicaOperationsArgs;
    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) {
            // failover to replica share
            var test = new IsShareReplicaOperations("test", IsShareReplicaOperationsArgs.builder()
                .shareReplica(ibm_is_share.example1().id())
                .fallbackPolicy("split")
                .timeout(500)
                .build());
    
        }
    }
    
    resources:
      # failover to replica share
      test:
        type: ibm:IsShareReplicaOperations
        properties:
          shareReplica: ${ibm_is_share.example1.id}
          fallbackPolicy: split
          timeout: 500
    

    Create IsShareReplicaOperations Resource

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

    Constructor syntax

    new IsShareReplicaOperations(name: string, args: IsShareReplicaOperationsArgs, opts?: CustomResourceOptions);
    @overload
    def IsShareReplicaOperations(resource_name: str,
                                 args: IsShareReplicaOperationsArgs,
                                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def IsShareReplicaOperations(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 share_replica: Optional[str] = None,
                                 fallback_policy: Optional[str] = None,
                                 is_share_replica_operations_id: Optional[str] = None,
                                 split_share: Optional[bool] = None,
                                 timeout: Optional[float] = None)
    func NewIsShareReplicaOperations(ctx *Context, name string, args IsShareReplicaOperationsArgs, opts ...ResourceOption) (*IsShareReplicaOperations, error)
    public IsShareReplicaOperations(string name, IsShareReplicaOperationsArgs args, CustomResourceOptions? opts = null)
    public IsShareReplicaOperations(String name, IsShareReplicaOperationsArgs args)
    public IsShareReplicaOperations(String name, IsShareReplicaOperationsArgs args, CustomResourceOptions options)
    
    type: ibm:IsShareReplicaOperations
    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 IsShareReplicaOperationsArgs
    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 IsShareReplicaOperationsArgs
    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 IsShareReplicaOperationsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IsShareReplicaOperationsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IsShareReplicaOperationsArgs
    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 isShareReplicaOperationsResource = new Ibm.IsShareReplicaOperations("isShareReplicaOperationsResource", new()
    {
        ShareReplica = "string",
        FallbackPolicy = "string",
        IsShareReplicaOperationsId = "string",
        SplitShare = false,
        Timeout = 0,
    });
    
    example, err := ibm.NewIsShareReplicaOperations(ctx, "isShareReplicaOperationsResource", &ibm.IsShareReplicaOperationsArgs{
    	ShareReplica:               pulumi.String("string"),
    	FallbackPolicy:             pulumi.String("string"),
    	IsShareReplicaOperationsId: pulumi.String("string"),
    	SplitShare:                 pulumi.Bool(false),
    	Timeout:                    pulumi.Float64(0),
    })
    
    var isShareReplicaOperationsResource = new IsShareReplicaOperations("isShareReplicaOperationsResource", IsShareReplicaOperationsArgs.builder()
        .shareReplica("string")
        .fallbackPolicy("string")
        .isShareReplicaOperationsId("string")
        .splitShare(false)
        .timeout(0)
        .build());
    
    is_share_replica_operations_resource = ibm.IsShareReplicaOperations("isShareReplicaOperationsResource",
        share_replica="string",
        fallback_policy="string",
        is_share_replica_operations_id="string",
        split_share=False,
        timeout=0)
    
    const isShareReplicaOperationsResource = new ibm.IsShareReplicaOperations("isShareReplicaOperationsResource", {
        shareReplica: "string",
        fallbackPolicy: "string",
        isShareReplicaOperationsId: "string",
        splitShare: false,
        timeout: 0,
    });
    
    type: ibm:IsShareReplicaOperations
    properties:
        fallbackPolicy: string
        isShareReplicaOperationsId: string
        shareReplica: string
        splitShare: false
        timeout: 0
    

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

    ShareReplica string
    The file share identifier.
    FallbackPolicy string
    The action to take if the failover request is accepted but cannot be performed or times out. Accepted values are split, fail
    IsShareReplicaOperationsId string
    The unique identifier of the Share.
    SplitShare bool

    If set to true the replication relationship between source share and replica will be removed.

    ~>Note split_share and fallback_policy are mutually exclusive

    Timeout double
    The failover timeout in seconds. Required with fallback_policy
    ShareReplica string
    The file share identifier.
    FallbackPolicy string
    The action to take if the failover request is accepted but cannot be performed or times out. Accepted values are split, fail
    IsShareReplicaOperationsId string
    The unique identifier of the Share.
    SplitShare bool

    If set to true the replication relationship between source share and replica will be removed.

    ~>Note split_share and fallback_policy are mutually exclusive

    Timeout float64
    The failover timeout in seconds. Required with fallback_policy
    shareReplica String
    The file share identifier.
    fallbackPolicy String
    The action to take if the failover request is accepted but cannot be performed or times out. Accepted values are split, fail
    isShareReplicaOperationsId String
    The unique identifier of the Share.
    splitShare Boolean

    If set to true the replication relationship between source share and replica will be removed.

    ~>Note split_share and fallback_policy are mutually exclusive

    timeout Double
    The failover timeout in seconds. Required with fallback_policy
    shareReplica string
    The file share identifier.
    fallbackPolicy string
    The action to take if the failover request is accepted but cannot be performed or times out. Accepted values are split, fail
    isShareReplicaOperationsId string
    The unique identifier of the Share.
    splitShare boolean

    If set to true the replication relationship between source share and replica will be removed.

    ~>Note split_share and fallback_policy are mutually exclusive

    timeout number
    The failover timeout in seconds. Required with fallback_policy
    share_replica str
    The file share identifier.
    fallback_policy str
    The action to take if the failover request is accepted but cannot be performed or times out. Accepted values are split, fail
    is_share_replica_operations_id str
    The unique identifier of the Share.
    split_share bool

    If set to true the replication relationship between source share and replica will be removed.

    ~>Note split_share and fallback_policy are mutually exclusive

    timeout float
    The failover timeout in seconds. Required with fallback_policy
    shareReplica String
    The file share identifier.
    fallbackPolicy String
    The action to take if the failover request is accepted but cannot be performed or times out. Accepted values are split, fail
    isShareReplicaOperationsId String
    The unique identifier of the Share.
    splitShare Boolean

    If set to true the replication relationship between source share and replica will be removed.

    ~>Note split_share and fallback_policy are mutually exclusive

    timeout Number
    The failover timeout in seconds. Required with fallback_policy

    Outputs

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

    Get an existing IsShareReplicaOperations 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?: IsShareReplicaOperationsState, opts?: CustomResourceOptions): IsShareReplicaOperations
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            fallback_policy: Optional[str] = None,
            is_share_replica_operations_id: Optional[str] = None,
            share_replica: Optional[str] = None,
            split_share: Optional[bool] = None,
            timeout: Optional[float] = None) -> IsShareReplicaOperations
    func GetIsShareReplicaOperations(ctx *Context, name string, id IDInput, state *IsShareReplicaOperationsState, opts ...ResourceOption) (*IsShareReplicaOperations, error)
    public static IsShareReplicaOperations Get(string name, Input<string> id, IsShareReplicaOperationsState? state, CustomResourceOptions? opts = null)
    public static IsShareReplicaOperations get(String name, Output<String> id, IsShareReplicaOperationsState state, CustomResourceOptions options)
    resources:  _:    type: ibm:IsShareReplicaOperations    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:
    FallbackPolicy string
    The action to take if the failover request is accepted but cannot be performed or times out. Accepted values are split, fail
    IsShareReplicaOperationsId string
    The unique identifier of the Share.
    ShareReplica string
    The file share identifier.
    SplitShare bool

    If set to true the replication relationship between source share and replica will be removed.

    ~>Note split_share and fallback_policy are mutually exclusive

    Timeout double
    The failover timeout in seconds. Required with fallback_policy
    FallbackPolicy string
    The action to take if the failover request is accepted but cannot be performed or times out. Accepted values are split, fail
    IsShareReplicaOperationsId string
    The unique identifier of the Share.
    ShareReplica string
    The file share identifier.
    SplitShare bool

    If set to true the replication relationship between source share and replica will be removed.

    ~>Note split_share and fallback_policy are mutually exclusive

    Timeout float64
    The failover timeout in seconds. Required with fallback_policy
    fallbackPolicy String
    The action to take if the failover request is accepted but cannot be performed or times out. Accepted values are split, fail
    isShareReplicaOperationsId String
    The unique identifier of the Share.
    shareReplica String
    The file share identifier.
    splitShare Boolean

    If set to true the replication relationship between source share and replica will be removed.

    ~>Note split_share and fallback_policy are mutually exclusive

    timeout Double
    The failover timeout in seconds. Required with fallback_policy
    fallbackPolicy string
    The action to take if the failover request is accepted but cannot be performed or times out. Accepted values are split, fail
    isShareReplicaOperationsId string
    The unique identifier of the Share.
    shareReplica string
    The file share identifier.
    splitShare boolean

    If set to true the replication relationship between source share and replica will be removed.

    ~>Note split_share and fallback_policy are mutually exclusive

    timeout number
    The failover timeout in seconds. Required with fallback_policy
    fallback_policy str
    The action to take if the failover request is accepted but cannot be performed or times out. Accepted values are split, fail
    is_share_replica_operations_id str
    The unique identifier of the Share.
    share_replica str
    The file share identifier.
    split_share bool

    If set to true the replication relationship between source share and replica will be removed.

    ~>Note split_share and fallback_policy are mutually exclusive

    timeout float
    The failover timeout in seconds. Required with fallback_policy
    fallbackPolicy String
    The action to take if the failover request is accepted but cannot be performed or times out. Accepted values are split, fail
    isShareReplicaOperationsId String
    The unique identifier of the Share.
    shareReplica String
    The file share identifier.
    splitShare Boolean

    If set to true the replication relationship between source share and replica will be removed.

    ~>Note split_share and fallback_policy are mutually exclusive

    timeout Number
    The failover timeout in seconds. Required with fallback_policy

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud