1. Packages
  2. Powerflex Provider
  3. API Docs
  4. ReplicationPair
powerflex 1.8.0 published on Monday, Apr 14, 2025 by dell

powerflex.ReplicationPair

Explore with Pulumi AI

powerflex logo
powerflex 1.8.0 published on Monday, Apr 14, 2025 by dell

    Import

    /*

    Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.

    Licensed under the Mozilla Public License Version 2.0 (the “License”);

    you may not use this file except in compliance with the License.

    You may obtain a copy of the License at

    http://mozilla.org/MPL/2.0/
    

    Unless required by applicable law or agreed to in writing, software

    distributed under the License is distributed on an “AS IS” BASIS,

    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

    See the License for the specific language governing permissions and

    limitations under the License.

    */

    import Replication Pair by its id

    $ pulumi import powerflex:index/replicationPair:ReplicationPair example "<id>"
    
    1. This will import the resource instance with specified ID into your Terraform state.

    2. After successful import, you can run terraform state list to ensure the resource has been imported successfully.

    3. Now, you can fill in the resource block with the appropriate arguments and settings that match the imported resource’s real-world configuration.

    4. Execute pulumi preview to see if your configuration and the imported resource are in sync. Make adjustments if needed.

    5. Finally, execute pulumi up to bring the resource fully under Terraform’s management.

    6. Now, the resource which was not part of terraform became part of Terraform managed infrastructure.

    Create ReplicationPair Resource

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

    Constructor syntax

    new ReplicationPair(name: string, args: ReplicationPairArgs, opts?: CustomResourceOptions);
    @overload
    def ReplicationPair(resource_name: str,
                        args: ReplicationPairArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def ReplicationPair(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        destination_volume_id: Optional[str] = None,
                        replication_consistency_group_id: Optional[str] = None,
                        source_volume_id: Optional[str] = None,
                        name: Optional[str] = None,
                        pause_initial_copy: Optional[bool] = None)
    func NewReplicationPair(ctx *Context, name string, args ReplicationPairArgs, opts ...ResourceOption) (*ReplicationPair, error)
    public ReplicationPair(string name, ReplicationPairArgs args, CustomResourceOptions? opts = null)
    public ReplicationPair(String name, ReplicationPairArgs args)
    public ReplicationPair(String name, ReplicationPairArgs args, CustomResourceOptions options)
    
    type: powerflex:ReplicationPair
    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 ReplicationPairArgs
    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 ReplicationPairArgs
    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 ReplicationPairArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ReplicationPairArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ReplicationPairArgs
    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 replicationPairResource = new Powerflex.ReplicationPair("replicationPairResource", new()
    {
        DestinationVolumeId = "string",
        ReplicationConsistencyGroupId = "string",
        SourceVolumeId = "string",
        Name = "string",
        PauseInitialCopy = false,
    });
    
    example, err := powerflex.NewReplicationPair(ctx, "replicationPairResource", &powerflex.ReplicationPairArgs{
    	DestinationVolumeId:           pulumi.String("string"),
    	ReplicationConsistencyGroupId: pulumi.String("string"),
    	SourceVolumeId:                pulumi.String("string"),
    	Name:                          pulumi.String("string"),
    	PauseInitialCopy:              pulumi.Bool(false),
    })
    
    var replicationPairResource = new ReplicationPair("replicationPairResource", ReplicationPairArgs.builder()
        .destinationVolumeId("string")
        .replicationConsistencyGroupId("string")
        .sourceVolumeId("string")
        .name("string")
        .pauseInitialCopy(false)
        .build());
    
    replication_pair_resource = powerflex.ReplicationPair("replicationPairResource",
        destination_volume_id="string",
        replication_consistency_group_id="string",
        source_volume_id="string",
        name="string",
        pause_initial_copy=False)
    
    const replicationPairResource = new powerflex.ReplicationPair("replicationPairResource", {
        destinationVolumeId: "string",
        replicationConsistencyGroupId: "string",
        sourceVolumeId: "string",
        name: "string",
        pauseInitialCopy: false,
    });
    
    type: powerflex:ReplicationPair
    properties:
        destinationVolumeId: string
        name: string
        pauseInitialCopy: false
        replicationConsistencyGroupId: string
        sourceVolumeId: string
    

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

    DestinationVolumeId string
    Destination Volume ID
    ReplicationConsistencyGroupId string
    Replication Consistency Group ID
    SourceVolumeId string
    Source Volume ID
    Name string
    Replication Pair Name
    PauseInitialCopy bool
    Pause Copy of the replication pair instance.
    DestinationVolumeId string
    Destination Volume ID
    ReplicationConsistencyGroupId string
    Replication Consistency Group ID
    SourceVolumeId string
    Source Volume ID
    Name string
    Replication Pair Name
    PauseInitialCopy bool
    Pause Copy of the replication pair instance.
    destinationVolumeId String
    Destination Volume ID
    replicationConsistencyGroupId String
    Replication Consistency Group ID
    sourceVolumeId String
    Source Volume ID
    name String
    Replication Pair Name
    pauseInitialCopy Boolean
    Pause Copy of the replication pair instance.
    destinationVolumeId string
    Destination Volume ID
    replicationConsistencyGroupId string
    Replication Consistency Group ID
    sourceVolumeId string
    Source Volume ID
    name string
    Replication Pair Name
    pauseInitialCopy boolean
    Pause Copy of the replication pair instance.
    destination_volume_id str
    Destination Volume ID
    replication_consistency_group_id str
    Replication Consistency Group ID
    source_volume_id str
    Source Volume ID
    name str
    Replication Pair Name
    pause_initial_copy bool
    Pause Copy of the replication pair instance.
    destinationVolumeId String
    Destination Volume ID
    replicationConsistencyGroupId String
    Replication Consistency Group ID
    sourceVolumeId String
    Source Volume ID
    name String
    Replication Pair Name
    pauseInitialCopy Boolean
    Pause Copy of the replication pair instance.

    Outputs

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

    CopyType string
    Copy Type for Replication Pairs only value is OnlineCopy
    Id string
    The provider-assigned unique ID for this managed resource.
    InitialCopyPriority double
    Initial Copy Priority of the replication pair instance.
    InitialCopyState string
    Initial Copy State of the replication pair instance.
    LifetimeState string
    Lifetime State of the replication pair instance.
    LocalVolumeId string
    Local Volume ID of the replication pair instance.
    PeerSystemName string
    Peer System Name of the replication pair instance.
    RemoteCapacityInMb double
    Remote Capacity in MB of the replication pair instance.
    RemoteId string
    Remote ID of the replication pair instance.
    RemoteVolumeId string
    Remote Volume ID of the replication pair instance.
    RemoteVolumeName string
    Remote Volume Name of the replication pair instance.
    UserRequestedPauseTransmitInitCopy bool
    User Requested Pause of the replication pair instance.
    CopyType string
    Copy Type for Replication Pairs only value is OnlineCopy
    Id string
    The provider-assigned unique ID for this managed resource.
    InitialCopyPriority float64
    Initial Copy Priority of the replication pair instance.
    InitialCopyState string
    Initial Copy State of the replication pair instance.
    LifetimeState string
    Lifetime State of the replication pair instance.
    LocalVolumeId string
    Local Volume ID of the replication pair instance.
    PeerSystemName string
    Peer System Name of the replication pair instance.
    RemoteCapacityInMb float64
    Remote Capacity in MB of the replication pair instance.
    RemoteId string
    Remote ID of the replication pair instance.
    RemoteVolumeId string
    Remote Volume ID of the replication pair instance.
    RemoteVolumeName string
    Remote Volume Name of the replication pair instance.
    UserRequestedPauseTransmitInitCopy bool
    User Requested Pause of the replication pair instance.
    copyType String
    Copy Type for Replication Pairs only value is OnlineCopy
    id String
    The provider-assigned unique ID for this managed resource.
    initialCopyPriority Double
    Initial Copy Priority of the replication pair instance.
    initialCopyState String
    Initial Copy State of the replication pair instance.
    lifetimeState String
    Lifetime State of the replication pair instance.
    localVolumeId String
    Local Volume ID of the replication pair instance.
    peerSystemName String
    Peer System Name of the replication pair instance.
    remoteCapacityInMb Double
    Remote Capacity in MB of the replication pair instance.
    remoteId String
    Remote ID of the replication pair instance.
    remoteVolumeId String
    Remote Volume ID of the replication pair instance.
    remoteVolumeName String
    Remote Volume Name of the replication pair instance.
    userRequestedPauseTransmitInitCopy Boolean
    User Requested Pause of the replication pair instance.
    copyType string
    Copy Type for Replication Pairs only value is OnlineCopy
    id string
    The provider-assigned unique ID for this managed resource.
    initialCopyPriority number
    Initial Copy Priority of the replication pair instance.
    initialCopyState string
    Initial Copy State of the replication pair instance.
    lifetimeState string
    Lifetime State of the replication pair instance.
    localVolumeId string
    Local Volume ID of the replication pair instance.
    peerSystemName string
    Peer System Name of the replication pair instance.
    remoteCapacityInMb number
    Remote Capacity in MB of the replication pair instance.
    remoteId string
    Remote ID of the replication pair instance.
    remoteVolumeId string
    Remote Volume ID of the replication pair instance.
    remoteVolumeName string
    Remote Volume Name of the replication pair instance.
    userRequestedPauseTransmitInitCopy boolean
    User Requested Pause of the replication pair instance.
    copy_type str
    Copy Type for Replication Pairs only value is OnlineCopy
    id str
    The provider-assigned unique ID for this managed resource.
    initial_copy_priority float
    Initial Copy Priority of the replication pair instance.
    initial_copy_state str
    Initial Copy State of the replication pair instance.
    lifetime_state str
    Lifetime State of the replication pair instance.
    local_volume_id str
    Local Volume ID of the replication pair instance.
    peer_system_name str
    Peer System Name of the replication pair instance.
    remote_capacity_in_mb float
    Remote Capacity in MB of the replication pair instance.
    remote_id str
    Remote ID of the replication pair instance.
    remote_volume_id str
    Remote Volume ID of the replication pair instance.
    remote_volume_name str
    Remote Volume Name of the replication pair instance.
    user_requested_pause_transmit_init_copy bool
    User Requested Pause of the replication pair instance.
    copyType String
    Copy Type for Replication Pairs only value is OnlineCopy
    id String
    The provider-assigned unique ID for this managed resource.
    initialCopyPriority Number
    Initial Copy Priority of the replication pair instance.
    initialCopyState String
    Initial Copy State of the replication pair instance.
    lifetimeState String
    Lifetime State of the replication pair instance.
    localVolumeId String
    Local Volume ID of the replication pair instance.
    peerSystemName String
    Peer System Name of the replication pair instance.
    remoteCapacityInMb Number
    Remote Capacity in MB of the replication pair instance.
    remoteId String
    Remote ID of the replication pair instance.
    remoteVolumeId String
    Remote Volume ID of the replication pair instance.
    remoteVolumeName String
    Remote Volume Name of the replication pair instance.
    userRequestedPauseTransmitInitCopy Boolean
    User Requested Pause of the replication pair instance.

    Look up Existing ReplicationPair Resource

    Get an existing ReplicationPair 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?: ReplicationPairState, opts?: CustomResourceOptions): ReplicationPair
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            copy_type: Optional[str] = None,
            destination_volume_id: Optional[str] = None,
            initial_copy_priority: Optional[float] = None,
            initial_copy_state: Optional[str] = None,
            lifetime_state: Optional[str] = None,
            local_volume_id: Optional[str] = None,
            name: Optional[str] = None,
            pause_initial_copy: Optional[bool] = None,
            peer_system_name: Optional[str] = None,
            remote_capacity_in_mb: Optional[float] = None,
            remote_id: Optional[str] = None,
            remote_volume_id: Optional[str] = None,
            remote_volume_name: Optional[str] = None,
            replication_consistency_group_id: Optional[str] = None,
            source_volume_id: Optional[str] = None,
            user_requested_pause_transmit_init_copy: Optional[bool] = None) -> ReplicationPair
    func GetReplicationPair(ctx *Context, name string, id IDInput, state *ReplicationPairState, opts ...ResourceOption) (*ReplicationPair, error)
    public static ReplicationPair Get(string name, Input<string> id, ReplicationPairState? state, CustomResourceOptions? opts = null)
    public static ReplicationPair get(String name, Output<String> id, ReplicationPairState state, CustomResourceOptions options)
    resources:  _:    type: powerflex:ReplicationPair    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:
    CopyType string
    Copy Type for Replication Pairs only value is OnlineCopy
    DestinationVolumeId string
    Destination Volume ID
    InitialCopyPriority double
    Initial Copy Priority of the replication pair instance.
    InitialCopyState string
    Initial Copy State of the replication pair instance.
    LifetimeState string
    Lifetime State of the replication pair instance.
    LocalVolumeId string
    Local Volume ID of the replication pair instance.
    Name string
    Replication Pair Name
    PauseInitialCopy bool
    Pause Copy of the replication pair instance.
    PeerSystemName string
    Peer System Name of the replication pair instance.
    RemoteCapacityInMb double
    Remote Capacity in MB of the replication pair instance.
    RemoteId string
    Remote ID of the replication pair instance.
    RemoteVolumeId string
    Remote Volume ID of the replication pair instance.
    RemoteVolumeName string
    Remote Volume Name of the replication pair instance.
    ReplicationConsistencyGroupId string
    Replication Consistency Group ID
    SourceVolumeId string
    Source Volume ID
    UserRequestedPauseTransmitInitCopy bool
    User Requested Pause of the replication pair instance.
    CopyType string
    Copy Type for Replication Pairs only value is OnlineCopy
    DestinationVolumeId string
    Destination Volume ID
    InitialCopyPriority float64
    Initial Copy Priority of the replication pair instance.
    InitialCopyState string
    Initial Copy State of the replication pair instance.
    LifetimeState string
    Lifetime State of the replication pair instance.
    LocalVolumeId string
    Local Volume ID of the replication pair instance.
    Name string
    Replication Pair Name
    PauseInitialCopy bool
    Pause Copy of the replication pair instance.
    PeerSystemName string
    Peer System Name of the replication pair instance.
    RemoteCapacityInMb float64
    Remote Capacity in MB of the replication pair instance.
    RemoteId string
    Remote ID of the replication pair instance.
    RemoteVolumeId string
    Remote Volume ID of the replication pair instance.
    RemoteVolumeName string
    Remote Volume Name of the replication pair instance.
    ReplicationConsistencyGroupId string
    Replication Consistency Group ID
    SourceVolumeId string
    Source Volume ID
    UserRequestedPauseTransmitInitCopy bool
    User Requested Pause of the replication pair instance.
    copyType String
    Copy Type for Replication Pairs only value is OnlineCopy
    destinationVolumeId String
    Destination Volume ID
    initialCopyPriority Double
    Initial Copy Priority of the replication pair instance.
    initialCopyState String
    Initial Copy State of the replication pair instance.
    lifetimeState String
    Lifetime State of the replication pair instance.
    localVolumeId String
    Local Volume ID of the replication pair instance.
    name String
    Replication Pair Name
    pauseInitialCopy Boolean
    Pause Copy of the replication pair instance.
    peerSystemName String
    Peer System Name of the replication pair instance.
    remoteCapacityInMb Double
    Remote Capacity in MB of the replication pair instance.
    remoteId String
    Remote ID of the replication pair instance.
    remoteVolumeId String
    Remote Volume ID of the replication pair instance.
    remoteVolumeName String
    Remote Volume Name of the replication pair instance.
    replicationConsistencyGroupId String
    Replication Consistency Group ID
    sourceVolumeId String
    Source Volume ID
    userRequestedPauseTransmitInitCopy Boolean
    User Requested Pause of the replication pair instance.
    copyType string
    Copy Type for Replication Pairs only value is OnlineCopy
    destinationVolumeId string
    Destination Volume ID
    initialCopyPriority number
    Initial Copy Priority of the replication pair instance.
    initialCopyState string
    Initial Copy State of the replication pair instance.
    lifetimeState string
    Lifetime State of the replication pair instance.
    localVolumeId string
    Local Volume ID of the replication pair instance.
    name string
    Replication Pair Name
    pauseInitialCopy boolean
    Pause Copy of the replication pair instance.
    peerSystemName string
    Peer System Name of the replication pair instance.
    remoteCapacityInMb number
    Remote Capacity in MB of the replication pair instance.
    remoteId string
    Remote ID of the replication pair instance.
    remoteVolumeId string
    Remote Volume ID of the replication pair instance.
    remoteVolumeName string
    Remote Volume Name of the replication pair instance.
    replicationConsistencyGroupId string
    Replication Consistency Group ID
    sourceVolumeId string
    Source Volume ID
    userRequestedPauseTransmitInitCopy boolean
    User Requested Pause of the replication pair instance.
    copy_type str
    Copy Type for Replication Pairs only value is OnlineCopy
    destination_volume_id str
    Destination Volume ID
    initial_copy_priority float
    Initial Copy Priority of the replication pair instance.
    initial_copy_state str
    Initial Copy State of the replication pair instance.
    lifetime_state str
    Lifetime State of the replication pair instance.
    local_volume_id str
    Local Volume ID of the replication pair instance.
    name str
    Replication Pair Name
    pause_initial_copy bool
    Pause Copy of the replication pair instance.
    peer_system_name str
    Peer System Name of the replication pair instance.
    remote_capacity_in_mb float
    Remote Capacity in MB of the replication pair instance.
    remote_id str
    Remote ID of the replication pair instance.
    remote_volume_id str
    Remote Volume ID of the replication pair instance.
    remote_volume_name str
    Remote Volume Name of the replication pair instance.
    replication_consistency_group_id str
    Replication Consistency Group ID
    source_volume_id str
    Source Volume ID
    user_requested_pause_transmit_init_copy bool
    User Requested Pause of the replication pair instance.
    copyType String
    Copy Type for Replication Pairs only value is OnlineCopy
    destinationVolumeId String
    Destination Volume ID
    initialCopyPriority Number
    Initial Copy Priority of the replication pair instance.
    initialCopyState String
    Initial Copy State of the replication pair instance.
    lifetimeState String
    Lifetime State of the replication pair instance.
    localVolumeId String
    Local Volume ID of the replication pair instance.
    name String
    Replication Pair Name
    pauseInitialCopy Boolean
    Pause Copy of the replication pair instance.
    peerSystemName String
    Peer System Name of the replication pair instance.
    remoteCapacityInMb Number
    Remote Capacity in MB of the replication pair instance.
    remoteId String
    Remote ID of the replication pair instance.
    remoteVolumeId String
    Remote Volume ID of the replication pair instance.
    remoteVolumeName String
    Remote Volume Name of the replication pair instance.
    replicationConsistencyGroupId String
    Replication Consistency Group ID
    sourceVolumeId String
    Source Volume ID
    userRequestedPauseTransmitInitCopy Boolean
    User Requested Pause of the replication pair instance.

    Package Details

    Repository
    powerflex dell/terraform-provider-powerflex
    License
    Notes
    This Pulumi package is based on the powerflex Terraform Provider.
    powerflex logo
    powerflex 1.8.0 published on Monday, Apr 14, 2025 by dell