1. Packages
  2. Ibm Provider
  3. API Docs
  4. IsShare
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.IsShare

Explore with Pulumi AI

Provides a resource for Share. This allows Share to be created, updated and deleted. For more information, about share replication, see Share replication.

NOTE New shares should be created with profile dp2. Old Tiered profiles will be deprecated soon.

Example Usage

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

const example = new ibm.IsShare("example", {
    accessControlMode: "security_group",
    profile: "dp2",
    size: 200,
    zone: "us-south-2",
});
Copy
import pulumi
import pulumi_ibm as ibm

example = ibm.IsShare("example",
    access_control_mode="security_group",
    profile="dp2",
    size=200,
    zone="us-south-2")
Copy
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{
			AccessControlMode: pulumi.String("security_group"),
			Profile:           pulumi.String("dp2"),
			Size:              pulumi.Float64(200),
			Zone:              pulumi.String("us-south-2"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var example = new Ibm.IsShare("example", new()
    {
        AccessControlMode = "security_group",
        Profile = "dp2",
        Size = 200,
        Zone = "us-south-2",
    });

});
Copy
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()
            .accessControlMode("security_group")
            .profile("dp2")
            .size(200)
            .zone("us-south-2")
            .build());

    }
}
Copy
resources:
  example:
    type: ibm:IsShare
    properties:
      accessControlMode: security_group
      profile: dp2
      size: 200
      zone: us-south-2
Copy

Create A Replica Share)

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

const example_1 = new ibm.IsShare("example-1", {
    zone: "us-south-3",
    sourceShare: ibm_is_share.example.id,
    profile: "dp2",
    replicationCronSpec: "0 */5 * * *",
});
Copy
import pulumi
import pulumi_ibm as ibm

example_1 = ibm.IsShare("example-1",
    zone="us-south-3",
    source_share=ibm_is_share["example"]["id"],
    profile="dp2",
    replication_cron_spec="0 */5 * * *")
Copy
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-1", &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
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var example_1 = new Ibm.IsShare("example-1", new()
    {
        Zone = "us-south-3",
        SourceShare = ibm_is_share.Example.Id,
        Profile = "dp2",
        ReplicationCronSpec = "0 */5 * * *",
    });

});
Copy
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_1 = new IsShare("example-1", IsShareArgs.builder()
            .zone("us-south-3")
            .sourceShare(ibm_is_share.example().id())
            .profile("dp2")
            .replicationCronSpec("0 */5 * * *")
            .build());

    }
}
Copy
resources:
  example-1:
    type: ibm:IsShare
    properties:
      zone: us-south-3
      sourceShare: ${ibm_is_share.example.id}
      profile: dp2
      replicationCronSpec: 0 */5 * * *
Copy

Create A File Share With Inline Replica Share)

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

const example_2 = new ibm.IsShare("example-2", {
    profile: "dp2",
    replicaShare: {
        name: "my-replica",
        profile: "dp2",
        replicationCronSpec: "0 */5 * * *",
        zone: "us-south-3",
    },
    size: 220,
    zone: "us-south-1",
});
Copy
import pulumi
import pulumi_ibm as ibm

example_2 = ibm.IsShare("example-2",
    profile="dp2",
    replica_share={
        "name": "my-replica",
        "profile": "dp2",
        "replication_cron_spec": "0 */5 * * *",
        "zone": "us-south-3",
    },
    size=220,
    zone="us-south-1")
Copy
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-2", &ibm.IsShareArgs{
			Profile: pulumi.String("dp2"),
			ReplicaShare: &ibm.IsShareReplicaShareArgs{
				Name:                pulumi.String("my-replica"),
				Profile:             pulumi.String("dp2"),
				ReplicationCronSpec: pulumi.String("0 */5 * * *"),
				Zone:                pulumi.String("us-south-3"),
			},
			Size: pulumi.Float64(220),
			Zone: pulumi.String("us-south-1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var example_2 = new Ibm.IsShare("example-2", new()
    {
        Profile = "dp2",
        ReplicaShare = new Ibm.Inputs.IsShareReplicaShareArgs
        {
            Name = "my-replica",
            Profile = "dp2",
            ReplicationCronSpec = "0 */5 * * *",
            Zone = "us-south-3",
        },
        Size = 220,
        Zone = "us-south-1",
    });

});
Copy
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 com.pulumi.ibm.inputs.IsShareReplicaShareArgs;
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_2 = new IsShare("example-2", IsShareArgs.builder()
            .profile("dp2")
            .replicaShare(IsShareReplicaShareArgs.builder()
                .name("my-replica")
                .profile("dp2")
                .replicationCronSpec("0 */5 * * *")
                .zone("us-south-3")
                .build())
            .size(220)
            .zone("us-south-1")
            .build());

    }
}
Copy
resources:
  example-2:
    type: ibm:IsShare
    properties:
      profile: dp2
      replicaShare:
        name: my-replica
        profile: dp2
        replicationCronSpec: 0 */5 * * *
        zone: us-south-3
      size: 220
      zone: us-south-1
Copy

Create A File Share With Inline Mount Target With A VNI)

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

const exampleIsSubnet = new ibm.IsSubnet("exampleIsSubnet", {
    vpc: ibm_is_vpc.vpc2.id,
    zone: "br-sao-2",
    totalIpv4AddressCount: 16,
});
const exampleIsVirtualNetworkInterface = new ibm.IsVirtualNetworkInterface("exampleIsVirtualNetworkInterface", {subnet: exampleIsSubnet.isSubnetId});
const example_3 = new ibm.IsShare("example-3", {
    zone: "us-south-1",
    size: 220,
    profile: "dp2",
    mountTargets: [{
        name: "my-mount-target",
        virtualNetworkInterfaces: [{
            id: exampleIsVirtualNetworkInterface.isVirtualNetworkInterfaceId,
        }],
    }],
});
Copy
import pulumi
import pulumi_ibm as ibm

example_is_subnet = ibm.IsSubnet("exampleIsSubnet",
    vpc=ibm_is_vpc["vpc2"]["id"],
    zone="br-sao-2",
    total_ipv4_address_count=16)
example_is_virtual_network_interface = ibm.IsVirtualNetworkInterface("exampleIsVirtualNetworkInterface", subnet=example_is_subnet.is_subnet_id)
example_3 = ibm.IsShare("example-3",
    zone="us-south-1",
    size=220,
    profile="dp2",
    mount_targets=[{
        "name": "my-mount-target",
        "virtual_network_interfaces": [{
            "id": example_is_virtual_network_interface.is_virtual_network_interface_id,
        }],
    }])
Copy
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 {
		exampleIsSubnet, err := ibm.NewIsSubnet(ctx, "exampleIsSubnet", &ibm.IsSubnetArgs{
			Vpc:                   pulumi.Any(ibm_is_vpc.Vpc2.Id),
			Zone:                  pulumi.String("br-sao-2"),
			TotalIpv4AddressCount: pulumi.Float64(16),
		})
		if err != nil {
			return err
		}
		exampleIsVirtualNetworkInterface, err := ibm.NewIsVirtualNetworkInterface(ctx, "exampleIsVirtualNetworkInterface", &ibm.IsVirtualNetworkInterfaceArgs{
			Subnet: exampleIsSubnet.IsSubnetId,
		})
		if err != nil {
			return err
		}
		_, err = ibm.NewIsShare(ctx, "example-3", &ibm.IsShareArgs{
			Zone:    pulumi.String("us-south-1"),
			Size:    pulumi.Float64(220),
			Profile: pulumi.String("dp2"),
			MountTargets: ibm.IsShareMountTargetTypeArray{
				&ibm.IsShareMountTargetTypeArgs{
					Name: pulumi.String("my-mount-target"),
					VirtualNetworkInterfaces: ibm.IsShareMountTargetVirtualNetworkInterfaceArray{
						&ibm.IsShareMountTargetVirtualNetworkInterfaceArgs{
							Id: exampleIsVirtualNetworkInterface.IsVirtualNetworkInterfaceId,
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var exampleIsSubnet = new Ibm.IsSubnet("exampleIsSubnet", new()
    {
        Vpc = ibm_is_vpc.Vpc2.Id,
        Zone = "br-sao-2",
        TotalIpv4AddressCount = 16,
    });

    var exampleIsVirtualNetworkInterface = new Ibm.IsVirtualNetworkInterface("exampleIsVirtualNetworkInterface", new()
    {
        Subnet = exampleIsSubnet.IsSubnetId,
    });

    var example_3 = new Ibm.IsShare("example-3", new()
    {
        Zone = "us-south-1",
        Size = 220,
        Profile = "dp2",
        MountTargets = new[]
        {
            new Ibm.Inputs.IsShareMountTargetArgs
            {
                Name = "my-mount-target",
                VirtualNetworkInterfaces = new[]
                {
                    new Ibm.Inputs.IsShareMountTargetVirtualNetworkInterfaceArgs
                    {
                        Id = exampleIsVirtualNetworkInterface.IsVirtualNetworkInterfaceId,
                    },
                },
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IsSubnet;
import com.pulumi.ibm.IsSubnetArgs;
import com.pulumi.ibm.IsVirtualNetworkInterface;
import com.pulumi.ibm.IsVirtualNetworkInterfaceArgs;
import com.pulumi.ibm.IsShare;
import com.pulumi.ibm.IsShareArgs;
import com.pulumi.ibm.inputs.IsShareMountTargetArgs;
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 exampleIsSubnet = new IsSubnet("exampleIsSubnet", IsSubnetArgs.builder()
            .vpc(ibm_is_vpc.vpc2().id())
            .zone("br-sao-2")
            .totalIpv4AddressCount(16)
            .build());

        var exampleIsVirtualNetworkInterface = new IsVirtualNetworkInterface("exampleIsVirtualNetworkInterface", IsVirtualNetworkInterfaceArgs.builder()
            .subnet(exampleIsSubnet.isSubnetId())
            .build());

        var example_3 = new IsShare("example-3", IsShareArgs.builder()
            .zone("us-south-1")
            .size(220)
            .profile("dp2")
            .mountTargets(IsShareMountTargetArgs.builder()
                .name("my-mount-target")
                .virtualNetworkInterfaces(IsShareMountTargetVirtualNetworkInterfaceArgs.builder()
                    .id(exampleIsVirtualNetworkInterface.isVirtualNetworkInterfaceId())
                    .build())
                .build())
            .build());

    }
}
Copy
resources:
  exampleIsSubnet:
    type: ibm:IsSubnet
    properties:
      vpc: ${ibm_is_vpc.vpc2.id}
      zone: br-sao-2
      totalIpv4AddressCount: 16
  exampleIsVirtualNetworkInterface:
    type: ibm:IsVirtualNetworkInterface
    properties:
      subnet: ${exampleIsSubnet.isSubnetId}
  example-3:
    type: ibm:IsShare
    properties:
      zone: us-south-1
      size: 220
      profile: dp2
      mountTargets:
        - name: my-mount-target
          virtualNetworkInterfaces:
            - id: ${exampleIsVirtualNetworkInterface.isVirtualNetworkInterfaceId}
Copy

Create A Cross Regional Replication)

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

const example_3 = new ibm.IsShare("example-3", {
    accessControlMode: "security_group",
    size: 200,
    profile: "dp2",
    zone: "au-syd-2",
}, {
    provider: ibm.syd,
});
const example_4 = new ibm.IsShare("example-4", {
    zone: "us-south-3",
    sourceShareCrn: example_3.crn,
    profile: "dp2",
    replicationCronSpec: "0 */5 * * *",
}, {
    provider: ibm.ussouth,
});
Copy
import pulumi
import pulumi_ibm as ibm

example_3 = ibm.IsShare("example-3",
    access_control_mode="security_group",
    size=200,
    profile="dp2",
    zone="au-syd-2",
    opts = pulumi.ResourceOptions(provider=ibm["syd"]))
example_4 = ibm.IsShare("example-4",
    zone="us-south-3",
    source_share_crn=example_3.crn,
    profile="dp2",
    replication_cron_spec="0 */5 * * *",
    opts = pulumi.ResourceOptions(provider=ibm["ussouth"]))
Copy
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 {
		example_3, err := ibm.NewIsShare(ctx, "example-3", &ibm.IsShareArgs{
			AccessControlMode: pulumi.String("security_group"),
			Size:              pulumi.Float64(200),
			Profile:           pulumi.String("dp2"),
			Zone:              pulumi.String("au-syd-2"),
		}, pulumi.Provider(ibm.Syd))
		if err != nil {
			return err
		}
		_, err = ibm.NewIsShare(ctx, "example-4", &ibm.IsShareArgs{
			Zone:                pulumi.String("us-south-3"),
			SourceShareCrn:      example_3.Crn,
			Profile:             pulumi.String("dp2"),
			ReplicationCronSpec: pulumi.String("0 */5 * * *"),
		}, pulumi.Provider(ibm.Ussouth))
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var example_3 = new Ibm.IsShare("example-3", new()
    {
        AccessControlMode = "security_group",
        Size = 200,
        Profile = "dp2",
        Zone = "au-syd-2",
    }, new CustomResourceOptions
    {
        Provider = ibm.Syd,
    });

    var example_4 = new Ibm.IsShare("example-4", new()
    {
        Zone = "us-south-3",
        SourceShareCrn = example_3.Crn,
        Profile = "dp2",
        ReplicationCronSpec = "0 */5 * * *",
    }, new CustomResourceOptions
    {
        Provider = ibm.Ussouth,
    });

});
Copy
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 com.pulumi.resources.CustomResourceOptions;
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_3 = new IsShare("example-3", IsShareArgs.builder()
            .accessControlMode("security_group")
            .size(200)
            .profile("dp2")
            .zone("au-syd-2")
            .build(), CustomResourceOptions.builder()
                .provider(ibm.syd())
                .build());

        var example_4 = new IsShare("example-4", IsShareArgs.builder()
            .zone("us-south-3")
            .sourceShareCrn(example_3.crn())
            .profile("dp2")
            .replicationCronSpec("0 */5 * * *")
            .build(), CustomResourceOptions.builder()
                .provider(ibm.ussouth())
                .build());

    }
}
Copy
resources:
  example-3:
    type: ibm:IsShare
    properties:
      accessControlMode: security_group
      size: 200
      profile: dp2
      zone: au-syd-2
    options:
      provider: ${ibm.syd}
  example-4:
    type: ibm:IsShare
    properties:
      zone: us-south-3
      sourceShareCrn: ${["example-3"].crn}
      profile: dp2
      replicationCronSpec: 0 */5 * * *
    options:
      provider: ${ibm.ussouth}
Copy

Example share (Create accessor share for an origin share)

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

const example_4 = new ibm.IsShare("example-4", {
    allowedTransitEncryptionModes: [
        "user_managed",
        "none",
    ],
    accessControlMode: "security_group",
    size: 200,
    profile: "dp2",
    zone: "au-syd-2",
});
const example_5 = new ibm.IsShare("example-5", {originShare: {
    crn: example_4.crn,
}});
const example_6 = new ibm.IsShare("example-6", {originShare: {
    id: example_4.isShareId,
}});
Copy
import pulumi
import pulumi_ibm as ibm

example_4 = ibm.IsShare("example-4",
    allowed_transit_encryption_modes=[
        "user_managed",
        "none",
    ],
    access_control_mode="security_group",
    size=200,
    profile="dp2",
    zone="au-syd-2")
example_5 = ibm.IsShare("example-5", origin_share={
    "crn": example_4.crn,
})
example_6 = ibm.IsShare("example-6", origin_share={
    "id": example_4.is_share_id,
})
Copy
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 {
		example_4, err := ibm.NewIsShare(ctx, "example-4", &ibm.IsShareArgs{
			AllowedTransitEncryptionModes: pulumi.StringArray{
				pulumi.String("user_managed"),
				pulumi.String("none"),
			},
			AccessControlMode: pulumi.String("security_group"),
			Size:              pulumi.Float64(200),
			Profile:           pulumi.String("dp2"),
			Zone:              pulumi.String("au-syd-2"),
		})
		if err != nil {
			return err
		}
		_, err = ibm.NewIsShare(ctx, "example-5", &ibm.IsShareArgs{
			OriginShare: &ibm.IsShareOriginShareArgs{
				Crn: example_4.Crn,
			},
		})
		if err != nil {
			return err
		}
		_, err = ibm.NewIsShare(ctx, "example-6", &ibm.IsShareArgs{
			OriginShare: &ibm.IsShareOriginShareArgs{
				Id: example_4.IsShareId,
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var example_4 = new Ibm.IsShare("example-4", new()
    {
        AllowedTransitEncryptionModes = new[]
        {
            "user_managed",
            "none",
        },
        AccessControlMode = "security_group",
        Size = 200,
        Profile = "dp2",
        Zone = "au-syd-2",
    });

    var example_5 = new Ibm.IsShare("example-5", new()
    {
        OriginShare = new Ibm.Inputs.IsShareOriginShareArgs
        {
            Crn = example_4.Crn,
        },
    });

    var example_6 = new Ibm.IsShare("example-6", new()
    {
        OriginShare = new Ibm.Inputs.IsShareOriginShareArgs
        {
            Id = example_4.IsShareId,
        },
    });

});
Copy
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 com.pulumi.ibm.inputs.IsShareOriginShareArgs;
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_4 = new IsShare("example-4", IsShareArgs.builder()
            .allowedTransitEncryptionModes(            
                "user_managed",
                "none")
            .accessControlMode("security_group")
            .size(200)
            .profile("dp2")
            .zone("au-syd-2")
            .build());

        var example_5 = new IsShare("example-5", IsShareArgs.builder()
            .originShare(IsShareOriginShareArgs.builder()
                .crn(example_4.crn())
                .build())
            .build());

        var example_6 = new IsShare("example-6", IsShareArgs.builder()
            .originShare(IsShareOriginShareArgs.builder()
                .id(example_4.isShareId())
                .build())
            .build());

    }
}
Copy
resources:
  example-4:
    type: ibm:IsShare
    properties:
      allowedTransitEncryptionModes:
        - user_managed
        - none
      accessControlMode: security_group
      size: 200
      profile: dp2
      zone: au-syd-2
  example-5:
    type: ibm:IsShare
    properties:
      originShare:
        crn: ${["example-4"].crn}
  example-6:
    type: ibm:IsShare
    properties:
      originShare:
        id: ${["example-4"].isShareId}
Copy

Create IsShare Resource

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

Constructor syntax

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

@overload
def IsShare(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            access_control_mode: Optional[str] = None,
            access_tags: Optional[Sequence[str]] = None,
            allowed_transit_encryption_modes: Optional[Sequence[str]] = None,
            encryption_key: Optional[str] = None,
            initial_owner: Optional[IsShareInitialOwnerArgs] = None,
            iops: Optional[float] = None,
            is_share_id: Optional[str] = None,
            mount_targets: Optional[Sequence[IsShareMountTargetArgs]] = None,
            name: Optional[str] = None,
            origin_share: Optional[IsShareOriginShareArgs] = None,
            profile: Optional[str] = None,
            replica_share: Optional[IsShareReplicaShareArgs] = None,
            replication_cron_spec: Optional[str] = None,
            resource_group: Optional[str] = None,
            size: Optional[float] = None,
            source_share: Optional[str] = None,
            source_share_crn: Optional[str] = None,
            source_snapshot: Optional[IsShareSourceSnapshotArgs] = None,
            tags: Optional[Sequence[str]] = None,
            zone: Optional[str] = None)
func NewIsShare(ctx *Context, name string, args *IsShareArgs, opts ...ResourceOption) (*IsShare, error)
public IsShare(string name, IsShareArgs? args = null, CustomResourceOptions? opts = null)
public IsShare(String name, IsShareArgs args)
public IsShare(String name, IsShareArgs args, CustomResourceOptions options)
type: ibm:IsShare
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 IsShareArgs
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 IsShareArgs
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 IsShareArgs
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 IsShareArgs
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. IsShareArgs
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 isShareResource = new Ibm.IsShare("isShareResource", new()
{
    AccessControlMode = "string",
    AccessTags = new[]
    {
        "string",
    },
    AllowedTransitEncryptionModes = new[]
    {
        "string",
    },
    EncryptionKey = "string",
    InitialOwner = new Ibm.Inputs.IsShareInitialOwnerArgs
    {
        Gid = 0,
        Uid = 0,
    },
    Iops = 0,
    IsShareId = "string",
    MountTargets = new[]
    {
        new Ibm.Inputs.IsShareMountTargetArgs
        {
            Name = "string",
            Href = "string",
            Id = "string",
            ResourceType = "string",
            TransitEncryption = "string",
            VirtualNetworkInterfaces = new[]
            {
                new Ibm.Inputs.IsShareMountTargetVirtualNetworkInterfaceArgs
                {
                    AllowIpSpoofing = false,
                    AutoDelete = false,
                    Crn = "string",
                    EnableInfrastructureNat = false,
                    Href = "string",
                    Id = "string",
                    Name = "string",
                    PrimaryIp = new Ibm.Inputs.IsShareMountTargetVirtualNetworkInterfacePrimaryIpArgs
                    {
                        Address = "string",
                        AutoDelete = false,
                        Href = "string",
                        Name = "string",
                        ReservedIp = "string",
                        ResourceType = "string",
                    },
                    ProtocolStateFilteringMode = "string",
                    ResourceGroup = "string",
                    ResourceType = "string",
                    SecurityGroups = new[]
                    {
                        "string",
                    },
                    Subnet = "string",
                },
            },
            Vpc = "string",
        },
    },
    Name = "string",
    OriginShare = new Ibm.Inputs.IsShareOriginShareArgs
    {
        Crn = "string",
        Deleteds = new[]
        {
            new Ibm.Inputs.IsShareOriginShareDeletedArgs
            {
                MoreInfo = "string",
            },
        },
        Href = "string",
        Id = "string",
        Name = "string",
        Remotes = new[]
        {
            new Ibm.Inputs.IsShareOriginShareRemoteArgs
            {
                Accounts = new[]
                {
                    new Ibm.Inputs.IsShareOriginShareRemoteAccountArgs
                    {
                        Id = "string",
                        ResourceType = "string",
                    },
                },
                Regions = new[]
                {
                    new Ibm.Inputs.IsShareOriginShareRemoteRegionArgs
                    {
                        Href = "string",
                        Name = "string",
                    },
                },
            },
        },
        ResourceType = "string",
    },
    Profile = "string",
    ReplicaShare = new Ibm.Inputs.IsShareReplicaShareArgs
    {
        Name = "string",
        Zone = "string",
        ReplicationCronSpec = "string",
        Profile = "string",
        Id = "string",
        MountTargets = new[]
        {
            new Ibm.Inputs.IsShareReplicaShareMountTargetArgs
            {
                Href = "string",
                Id = "string",
                Name = "string",
                ResourceType = "string",
                TransitEncryption = "string",
                VirtualNetworkInterfaces = new[]
                {
                    new Ibm.Inputs.IsShareReplicaShareMountTargetVirtualNetworkInterfaceArgs
                    {
                        AllowIpSpoofing = false,
                        AutoDelete = false,
                        Crn = "string",
                        EnableInfrastructureNat = false,
                        Href = "string",
                        Id = "string",
                        Name = "string",
                        PrimaryIps = new[]
                        {
                            new Ibm.Inputs.IsShareReplicaShareMountTargetVirtualNetworkInterfacePrimaryIpArgs
                            {
                                Address = "string",
                                AutoDelete = false,
                                Href = "string",
                                Name = "string",
                                ReservedIp = "string",
                                ResourceType = "string",
                            },
                        },
                        ProtocolStateFilteringMode = "string",
                        ResourceGroup = "string",
                        ResourceType = "string",
                        SecurityGroups = new[]
                        {
                            "string",
                        },
                        Subnet = "string",
                    },
                },
                Vpc = "string",
            },
        },
        Iops = 0,
        AccessTags = new[]
        {
            "string",
        },
        Href = "string",
        ReplicationRole = "string",
        ReplicationStatus = "string",
        ReplicationStatusReasons = new[]
        {
            new Ibm.Inputs.IsShareReplicaShareReplicationStatusReasonArgs
            {
                Code = "string",
                Message = "string",
                MoreInfo = "string",
            },
        },
        Tags = new[]
        {
            "string",
        },
        Crn = "string",
    },
    ReplicationCronSpec = "string",
    ResourceGroup = "string",
    Size = 0,
    SourceShare = "string",
    SourceShareCrn = "string",
    SourceSnapshot = new Ibm.Inputs.IsShareSourceSnapshotArgs
    {
        Crn = "string",
        Deleteds = new[]
        {
            new Ibm.Inputs.IsShareSourceSnapshotDeletedArgs
            {
                MoreInfo = "string",
            },
        },
        Href = "string",
        Id = "string",
        Name = "string",
        ResourceType = "string",
    },
    Tags = new[]
    {
        "string",
    },
    Zone = "string",
});
Copy
example, err := ibm.NewIsShare(ctx, "isShareResource", &ibm.IsShareArgs{
AccessControlMode: pulumi.String("string"),
AccessTags: pulumi.StringArray{
pulumi.String("string"),
},
AllowedTransitEncryptionModes: pulumi.StringArray{
pulumi.String("string"),
},
EncryptionKey: pulumi.String("string"),
InitialOwner: &.IsShareInitialOwnerArgs{
Gid: pulumi.Float64(0),
Uid: pulumi.Float64(0),
},
Iops: pulumi.Float64(0),
IsShareId: pulumi.String("string"),
MountTargets: .IsShareMountTargetTypeArray{
&.IsShareMountTargetTypeArgs{
Name: pulumi.String("string"),
Href: pulumi.String("string"),
Id: pulumi.String("string"),
ResourceType: pulumi.String("string"),
TransitEncryption: pulumi.String("string"),
VirtualNetworkInterfaces: .IsShareMountTargetVirtualNetworkInterfaceArray{
&.IsShareMountTargetVirtualNetworkInterfaceArgs{
AllowIpSpoofing: pulumi.Bool(false),
AutoDelete: pulumi.Bool(false),
Crn: pulumi.String("string"),
EnableInfrastructureNat: pulumi.Bool(false),
Href: pulumi.String("string"),
Id: pulumi.String("string"),
Name: pulumi.String("string"),
PrimaryIp: &.IsShareMountTargetVirtualNetworkInterfacePrimaryIpArgs{
Address: pulumi.String("string"),
AutoDelete: pulumi.Bool(false),
Href: pulumi.String("string"),
Name: pulumi.String("string"),
ReservedIp: pulumi.String("string"),
ResourceType: pulumi.String("string"),
},
ProtocolStateFilteringMode: pulumi.String("string"),
ResourceGroup: pulumi.String("string"),
ResourceType: pulumi.String("string"),
SecurityGroups: pulumi.StringArray{
pulumi.String("string"),
},
Subnet: pulumi.String("string"),
},
},
Vpc: pulumi.String("string"),
},
},
Name: pulumi.String("string"),
OriginShare: &.IsShareOriginShareArgs{
Crn: pulumi.String("string"),
Deleteds: .IsShareOriginShareDeletedArray{
&.IsShareOriginShareDeletedArgs{
MoreInfo: pulumi.String("string"),
},
},
Href: pulumi.String("string"),
Id: pulumi.String("string"),
Name: pulumi.String("string"),
Remotes: .IsShareOriginShareRemoteArray{
&.IsShareOriginShareRemoteArgs{
Accounts: .IsShareOriginShareRemoteAccountArray{
&.IsShareOriginShareRemoteAccountArgs{
Id: pulumi.String("string"),
ResourceType: pulumi.String("string"),
},
},
Regions: .IsShareOriginShareRemoteRegionArray{
&.IsShareOriginShareRemoteRegionArgs{
Href: pulumi.String("string"),
Name: pulumi.String("string"),
},
},
},
},
ResourceType: pulumi.String("string"),
},
Profile: pulumi.String("string"),
ReplicaShare: &.IsShareReplicaShareArgs{
Name: pulumi.String("string"),
Zone: pulumi.String("string"),
ReplicationCronSpec: pulumi.String("string"),
Profile: pulumi.String("string"),
Id: pulumi.String("string"),
MountTargets: .IsShareReplicaShareMountTargetArray{
&.IsShareReplicaShareMountTargetArgs{
Href: pulumi.String("string"),
Id: pulumi.String("string"),
Name: pulumi.String("string"),
ResourceType: pulumi.String("string"),
TransitEncryption: pulumi.String("string"),
VirtualNetworkInterfaces: .IsShareReplicaShareMountTargetVirtualNetworkInterfaceArray{
&.IsShareReplicaShareMountTargetVirtualNetworkInterfaceArgs{
AllowIpSpoofing: pulumi.Bool(false),
AutoDelete: pulumi.Bool(false),
Crn: pulumi.String("string"),
EnableInfrastructureNat: pulumi.Bool(false),
Href: pulumi.String("string"),
Id: pulumi.String("string"),
Name: pulumi.String("string"),
PrimaryIps: .IsShareReplicaShareMountTargetVirtualNetworkInterfacePrimaryIpArray{
&.IsShareReplicaShareMountTargetVirtualNetworkInterfacePrimaryIpArgs{
Address: pulumi.String("string"),
AutoDelete: pulumi.Bool(false),
Href: pulumi.String("string"),
Name: pulumi.String("string"),
ReservedIp: pulumi.String("string"),
ResourceType: pulumi.String("string"),
},
},
ProtocolStateFilteringMode: pulumi.String("string"),
ResourceGroup: pulumi.String("string"),
ResourceType: pulumi.String("string"),
SecurityGroups: pulumi.StringArray{
pulumi.String("string"),
},
Subnet: pulumi.String("string"),
},
},
Vpc: pulumi.String("string"),
},
},
Iops: pulumi.Float64(0),
AccessTags: pulumi.StringArray{
pulumi.String("string"),
},
Href: pulumi.String("string"),
ReplicationRole: pulumi.String("string"),
ReplicationStatus: pulumi.String("string"),
ReplicationStatusReasons: .IsShareReplicaShareReplicationStatusReasonArray{
&.IsShareReplicaShareReplicationStatusReasonArgs{
Code: pulumi.String("string"),
Message: pulumi.String("string"),
MoreInfo: pulumi.String("string"),
},
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
Crn: pulumi.String("string"),
},
ReplicationCronSpec: pulumi.String("string"),
ResourceGroup: pulumi.String("string"),
Size: pulumi.Float64(0),
SourceShare: pulumi.String("string"),
SourceShareCrn: pulumi.String("string"),
SourceSnapshot: &.IsShareSourceSnapshotArgs{
Crn: pulumi.String("string"),
Deleteds: .IsShareSourceSnapshotDeletedArray{
&.IsShareSourceSnapshotDeletedArgs{
MoreInfo: pulumi.String("string"),
},
},
Href: pulumi.String("string"),
Id: pulumi.String("string"),
Name: pulumi.String("string"),
ResourceType: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
Zone: pulumi.String("string"),
})
Copy
var isShareResource = new IsShare("isShareResource", IsShareArgs.builder()
    .accessControlMode("string")
    .accessTags("string")
    .allowedTransitEncryptionModes("string")
    .encryptionKey("string")
    .initialOwner(IsShareInitialOwnerArgs.builder()
        .gid(0)
        .uid(0)
        .build())
    .iops(0)
    .isShareId("string")
    .mountTargets(IsShareMountTargetArgs.builder()
        .name("string")
        .href("string")
        .id("string")
        .resourceType("string")
        .transitEncryption("string")
        .virtualNetworkInterfaces(IsShareMountTargetVirtualNetworkInterfaceArgs.builder()
            .allowIpSpoofing(false)
            .autoDelete(false)
            .crn("string")
            .enableInfrastructureNat(false)
            .href("string")
            .id("string")
            .name("string")
            .primaryIp(IsShareMountTargetVirtualNetworkInterfacePrimaryIpArgs.builder()
                .address("string")
                .autoDelete(false)
                .href("string")
                .name("string")
                .reservedIp("string")
                .resourceType("string")
                .build())
            .protocolStateFilteringMode("string")
            .resourceGroup("string")
            .resourceType("string")
            .securityGroups("string")
            .subnet("string")
            .build())
        .vpc("string")
        .build())
    .name("string")
    .originShare(IsShareOriginShareArgs.builder()
        .crn("string")
        .deleteds(IsShareOriginShareDeletedArgs.builder()
            .moreInfo("string")
            .build())
        .href("string")
        .id("string")
        .name("string")
        .remotes(IsShareOriginShareRemoteArgs.builder()
            .accounts(IsShareOriginShareRemoteAccountArgs.builder()
                .id("string")
                .resourceType("string")
                .build())
            .regions(IsShareOriginShareRemoteRegionArgs.builder()
                .href("string")
                .name("string")
                .build())
            .build())
        .resourceType("string")
        .build())
    .profile("string")
    .replicaShare(IsShareReplicaShareArgs.builder()
        .name("string")
        .zone("string")
        .replicationCronSpec("string")
        .profile("string")
        .id("string")
        .mountTargets(IsShareReplicaShareMountTargetArgs.builder()
            .href("string")
            .id("string")
            .name("string")
            .resourceType("string")
            .transitEncryption("string")
            .virtualNetworkInterfaces(IsShareReplicaShareMountTargetVirtualNetworkInterfaceArgs.builder()
                .allowIpSpoofing(false)
                .autoDelete(false)
                .crn("string")
                .enableInfrastructureNat(false)
                .href("string")
                .id("string")
                .name("string")
                .primaryIps(IsShareReplicaShareMountTargetVirtualNetworkInterfacePrimaryIpArgs.builder()
                    .address("string")
                    .autoDelete(false)
                    .href("string")
                    .name("string")
                    .reservedIp("string")
                    .resourceType("string")
                    .build())
                .protocolStateFilteringMode("string")
                .resourceGroup("string")
                .resourceType("string")
                .securityGroups("string")
                .subnet("string")
                .build())
            .vpc("string")
            .build())
        .iops(0)
        .accessTags("string")
        .href("string")
        .replicationRole("string")
        .replicationStatus("string")
        .replicationStatusReasons(IsShareReplicaShareReplicationStatusReasonArgs.builder()
            .code("string")
            .message("string")
            .moreInfo("string")
            .build())
        .tags("string")
        .crn("string")
        .build())
    .replicationCronSpec("string")
    .resourceGroup("string")
    .size(0)
    .sourceShare("string")
    .sourceShareCrn("string")
    .sourceSnapshot(IsShareSourceSnapshotArgs.builder()
        .crn("string")
        .deleteds(IsShareSourceSnapshotDeletedArgs.builder()
            .moreInfo("string")
            .build())
        .href("string")
        .id("string")
        .name("string")
        .resourceType("string")
        .build())
    .tags("string")
    .zone("string")
    .build());
Copy
is_share_resource = ibm.IsShare("isShareResource",
    access_control_mode="string",
    access_tags=["string"],
    allowed_transit_encryption_modes=["string"],
    encryption_key="string",
    initial_owner={
        "gid": 0,
        "uid": 0,
    },
    iops=0,
    is_share_id="string",
    mount_targets=[{
        "name": "string",
        "href": "string",
        "id": "string",
        "resource_type": "string",
        "transit_encryption": "string",
        "virtual_network_interfaces": [{
            "allow_ip_spoofing": False,
            "auto_delete": False,
            "crn": "string",
            "enable_infrastructure_nat": False,
            "href": "string",
            "id": "string",
            "name": "string",
            "primary_ip": {
                "address": "string",
                "auto_delete": False,
                "href": "string",
                "name": "string",
                "reserved_ip": "string",
                "resource_type": "string",
            },
            "protocol_state_filtering_mode": "string",
            "resource_group": "string",
            "resource_type": "string",
            "security_groups": ["string"],
            "subnet": "string",
        }],
        "vpc": "string",
    }],
    name="string",
    origin_share={
        "crn": "string",
        "deleteds": [{
            "more_info": "string",
        }],
        "href": "string",
        "id": "string",
        "name": "string",
        "remotes": [{
            "accounts": [{
                "id": "string",
                "resource_type": "string",
            }],
            "regions": [{
                "href": "string",
                "name": "string",
            }],
        }],
        "resource_type": "string",
    },
    profile="string",
    replica_share={
        "name": "string",
        "zone": "string",
        "replication_cron_spec": "string",
        "profile": "string",
        "id": "string",
        "mount_targets": [{
            "href": "string",
            "id": "string",
            "name": "string",
            "resource_type": "string",
            "transit_encryption": "string",
            "virtual_network_interfaces": [{
                "allow_ip_spoofing": False,
                "auto_delete": False,
                "crn": "string",
                "enable_infrastructure_nat": False,
                "href": "string",
                "id": "string",
                "name": "string",
                "primary_ips": [{
                    "address": "string",
                    "auto_delete": False,
                    "href": "string",
                    "name": "string",
                    "reserved_ip": "string",
                    "resource_type": "string",
                }],
                "protocol_state_filtering_mode": "string",
                "resource_group": "string",
                "resource_type": "string",
                "security_groups": ["string"],
                "subnet": "string",
            }],
            "vpc": "string",
        }],
        "iops": 0,
        "access_tags": ["string"],
        "href": "string",
        "replication_role": "string",
        "replication_status": "string",
        "replication_status_reasons": [{
            "code": "string",
            "message": "string",
            "more_info": "string",
        }],
        "tags": ["string"],
        "crn": "string",
    },
    replication_cron_spec="string",
    resource_group="string",
    size=0,
    source_share="string",
    source_share_crn="string",
    source_snapshot={
        "crn": "string",
        "deleteds": [{
            "more_info": "string",
        }],
        "href": "string",
        "id": "string",
        "name": "string",
        "resource_type": "string",
    },
    tags=["string"],
    zone="string")
Copy
const isShareResource = new ibm.IsShare("isShareResource", {
    accessControlMode: "string",
    accessTags: ["string"],
    allowedTransitEncryptionModes: ["string"],
    encryptionKey: "string",
    initialOwner: {
        gid: 0,
        uid: 0,
    },
    iops: 0,
    isShareId: "string",
    mountTargets: [{
        name: "string",
        href: "string",
        id: "string",
        resourceType: "string",
        transitEncryption: "string",
        virtualNetworkInterfaces: [{
            allowIpSpoofing: false,
            autoDelete: false,
            crn: "string",
            enableInfrastructureNat: false,
            href: "string",
            id: "string",
            name: "string",
            primaryIp: {
                address: "string",
                autoDelete: false,
                href: "string",
                name: "string",
                reservedIp: "string",
                resourceType: "string",
            },
            protocolStateFilteringMode: "string",
            resourceGroup: "string",
            resourceType: "string",
            securityGroups: ["string"],
            subnet: "string",
        }],
        vpc: "string",
    }],
    name: "string",
    originShare: {
        crn: "string",
        deleteds: [{
            moreInfo: "string",
        }],
        href: "string",
        id: "string",
        name: "string",
        remotes: [{
            accounts: [{
                id: "string",
                resourceType: "string",
            }],
            regions: [{
                href: "string",
                name: "string",
            }],
        }],
        resourceType: "string",
    },
    profile: "string",
    replicaShare: {
        name: "string",
        zone: "string",
        replicationCronSpec: "string",
        profile: "string",
        id: "string",
        mountTargets: [{
            href: "string",
            id: "string",
            name: "string",
            resourceType: "string",
            transitEncryption: "string",
            virtualNetworkInterfaces: [{
                allowIpSpoofing: false,
                autoDelete: false,
                crn: "string",
                enableInfrastructureNat: false,
                href: "string",
                id: "string",
                name: "string",
                primaryIps: [{
                    address: "string",
                    autoDelete: false,
                    href: "string",
                    name: "string",
                    reservedIp: "string",
                    resourceType: "string",
                }],
                protocolStateFilteringMode: "string",
                resourceGroup: "string",
                resourceType: "string",
                securityGroups: ["string"],
                subnet: "string",
            }],
            vpc: "string",
        }],
        iops: 0,
        accessTags: ["string"],
        href: "string",
        replicationRole: "string",
        replicationStatus: "string",
        replicationStatusReasons: [{
            code: "string",
            message: "string",
            moreInfo: "string",
        }],
        tags: ["string"],
        crn: "string",
    },
    replicationCronSpec: "string",
    resourceGroup: "string",
    size: 0,
    sourceShare: "string",
    sourceShareCrn: "string",
    sourceSnapshot: {
        crn: "string",
        deleteds: [{
            moreInfo: "string",
        }],
        href: "string",
        id: "string",
        name: "string",
        resourceType: "string",
    },
    tags: ["string"],
    zone: "string",
});
Copy
type: ibm:IsShare
properties:
    accessControlMode: string
    accessTags:
        - string
    allowedTransitEncryptionModes:
        - string
    encryptionKey: string
    initialOwner:
        gid: 0
        uid: 0
    iops: 0
    isShareId: string
    mountTargets:
        - href: string
          id: string
          name: string
          resourceType: string
          transitEncryption: string
          virtualNetworkInterfaces:
            - allowIpSpoofing: false
              autoDelete: false
              crn: string
              enableInfrastructureNat: false
              href: string
              id: string
              name: string
              primaryIp:
                address: string
                autoDelete: false
                href: string
                name: string
                reservedIp: string
                resourceType: string
              protocolStateFilteringMode: string
              resourceGroup: string
              resourceType: string
              securityGroups:
                - string
              subnet: string
          vpc: string
    name: string
    originShare:
        crn: string
        deleteds:
            - moreInfo: string
        href: string
        id: string
        name: string
        remotes:
            - accounts:
                - id: string
                  resourceType: string
              regions:
                - href: string
                  name: string
        resourceType: string
    profile: string
    replicaShare:
        accessTags:
            - string
        crn: string
        href: string
        id: string
        iops: 0
        mountTargets:
            - href: string
              id: string
              name: string
              resourceType: string
              transitEncryption: string
              virtualNetworkInterfaces:
                - allowIpSpoofing: false
                  autoDelete: false
                  crn: string
                  enableInfrastructureNat: false
                  href: string
                  id: string
                  name: string
                  primaryIps:
                    - address: string
                      autoDelete: false
                      href: string
                      name: string
                      reservedIp: string
                      resourceType: string
                  protocolStateFilteringMode: string
                  resourceGroup: string
                  resourceType: string
                  securityGroups:
                    - string
                  subnet: string
              vpc: string
        name: string
        profile: string
        replicationCronSpec: string
        replicationRole: string
        replicationStatus: string
        replicationStatusReasons:
            - code: string
              message: string
              moreInfo: string
        tags:
            - string
        zone: string
    replicationCronSpec: string
    resourceGroup: string
    size: 0
    sourceShare: string
    sourceShareCrn: string
    sourceSnapshot:
        crn: string
        deleteds:
            - moreInfo: string
        href: string
        id: string
        name: string
        resourceType: string
    tags:
        - string
    zone: string
Copy

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

AccessControlMode string
The access control mode for the share. Supported values are security_group and vpc. Default value is security_group
AccessTags List<string>
The list of access management tags to attach to the share. Note For more information, about creating access tags, see working with tags.
AllowedTransitEncryptionModes List<string>
The transit encryption modes allowed for this share.
EncryptionKey string
The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource.
InitialOwner IsShareInitialOwner

The initial owner for the file share.

Nested scheme for initial_owner:

Iops double
The maximum input/output operation performance bandwidth per second for the file share. For more information about the iops range for the given size, refer File Storage for VPC profiles
IsShareId string
(String) The unique identifier for this share snapshot.
MountTargets List<IsShareMountTarget>
Share targets for the file share.
Name string
The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
OriginShare IsShareOriginShare
The origin share this accessor share is referring to. Nested schema for origin_share:
Profile string

The globally unique name for this share profile.

NOTE While updating profile from 'custom' to a tiered profile make sure to remove iops from the configuration.

ReplicaShare IsShareReplicaShare
Configuration for a replica file share to create and associate with this file share.
ReplicationCronSpec string
The cron specification for the file share replication schedule.
ResourceGroup string
The unique identifier for this resource group.
Size double
The size of the file share rounded up to the next gigabyte.
SourceShare string
The ID of the source file share for this replica file share. The specified file share must not already have a replica, and must not be a replica.
SourceShareCrn string
The CRN of the source file share.
SourceSnapshot IsShareSourceSnapshot
The snapshot from which this share was cloned.This property will be present when the share was created from a snapshot.The resources supported by this property mayexpand in thefuture. Nested schema for source_snapshot:
Tags List<string>
The list of user tags to attach to the share.
Zone string
The globally unique name for this zone.
AccessControlMode string
The access control mode for the share. Supported values are security_group and vpc. Default value is security_group
AccessTags []string
The list of access management tags to attach to the share. Note For more information, about creating access tags, see working with tags.
AllowedTransitEncryptionModes []string
The transit encryption modes allowed for this share.
EncryptionKey string
The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource.
InitialOwner IsShareInitialOwnerArgs

The initial owner for the file share.

Nested scheme for initial_owner:

Iops float64
The maximum input/output operation performance bandwidth per second for the file share. For more information about the iops range for the given size, refer File Storage for VPC profiles
IsShareId string
(String) The unique identifier for this share snapshot.
MountTargets []IsShareMountTargetTypeArgs
Share targets for the file share.
Name string
The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
OriginShare IsShareOriginShareArgs
The origin share this accessor share is referring to. Nested schema for origin_share:
Profile string

The globally unique name for this share profile.

NOTE While updating profile from 'custom' to a tiered profile make sure to remove iops from the configuration.

ReplicaShare IsShareReplicaShareArgs
Configuration for a replica file share to create and associate with this file share.
ReplicationCronSpec string
The cron specification for the file share replication schedule.
ResourceGroup string
The unique identifier for this resource group.
Size float64
The size of the file share rounded up to the next gigabyte.
SourceShare string
The ID of the source file share for this replica file share. The specified file share must not already have a replica, and must not be a replica.
SourceShareCrn string
The CRN of the source file share.
SourceSnapshot IsShareSourceSnapshotArgs
The snapshot from which this share was cloned.This property will be present when the share was created from a snapshot.The resources supported by this property mayexpand in thefuture. Nested schema for source_snapshot:
Tags []string
The list of user tags to attach to the share.
Zone string
The globally unique name for this zone.
accessControlMode String
The access control mode for the share. Supported values are security_group and vpc. Default value is security_group
accessTags List<String>
The list of access management tags to attach to the share. Note For more information, about creating access tags, see working with tags.
allowedTransitEncryptionModes List<String>
The transit encryption modes allowed for this share.
encryptionKey String
The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource.
initialOwner IsShareInitialOwner

The initial owner for the file share.

Nested scheme for initial_owner:

iops Double
The maximum input/output operation performance bandwidth per second for the file share. For more information about the iops range for the given size, refer File Storage for VPC profiles
isShareId String
(String) The unique identifier for this share snapshot.
mountTargets List<IsShareMountTarget>
Share targets for the file share.
name String
The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
originShare IsShareOriginShare
The origin share this accessor share is referring to. Nested schema for origin_share:
profile String

The globally unique name for this share profile.

NOTE While updating profile from 'custom' to a tiered profile make sure to remove iops from the configuration.

replicaShare IsShareReplicaShare
Configuration for a replica file share to create and associate with this file share.
replicationCronSpec String
The cron specification for the file share replication schedule.
resourceGroup String
The unique identifier for this resource group.
size Double
The size of the file share rounded up to the next gigabyte.
sourceShare String
The ID of the source file share for this replica file share. The specified file share must not already have a replica, and must not be a replica.
sourceShareCrn String
The CRN of the source file share.
sourceSnapshot IsShareSourceSnapshot
The snapshot from which this share was cloned.This property will be present when the share was created from a snapshot.The resources supported by this property mayexpand in thefuture. Nested schema for source_snapshot:
tags List<String>
The list of user tags to attach to the share.
zone String
The globally unique name for this zone.
accessControlMode string
The access control mode for the share. Supported values are security_group and vpc. Default value is security_group
accessTags string[]
The list of access management tags to attach to the share. Note For more information, about creating access tags, see working with tags.
allowedTransitEncryptionModes string[]
The transit encryption modes allowed for this share.
encryptionKey string
The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource.
initialOwner IsShareInitialOwner

The initial owner for the file share.

Nested scheme for initial_owner:

iops number
The maximum input/output operation performance bandwidth per second for the file share. For more information about the iops range for the given size, refer File Storage for VPC profiles
isShareId string
(String) The unique identifier for this share snapshot.
mountTargets IsShareMountTarget[]
Share targets for the file share.
name string
The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
originShare IsShareOriginShare
The origin share this accessor share is referring to. Nested schema for origin_share:
profile string

The globally unique name for this share profile.

NOTE While updating profile from 'custom' to a tiered profile make sure to remove iops from the configuration.

replicaShare IsShareReplicaShare
Configuration for a replica file share to create and associate with this file share.
replicationCronSpec string
The cron specification for the file share replication schedule.
resourceGroup string
The unique identifier for this resource group.
size number
The size of the file share rounded up to the next gigabyte.
sourceShare string
The ID of the source file share for this replica file share. The specified file share must not already have a replica, and must not be a replica.
sourceShareCrn string
The CRN of the source file share.
sourceSnapshot IsShareSourceSnapshot
The snapshot from which this share was cloned.This property will be present when the share was created from a snapshot.The resources supported by this property mayexpand in thefuture. Nested schema for source_snapshot:
tags string[]
The list of user tags to attach to the share.
zone string
The globally unique name for this zone.
access_control_mode str
The access control mode for the share. Supported values are security_group and vpc. Default value is security_group
access_tags Sequence[str]
The list of access management tags to attach to the share. Note For more information, about creating access tags, see working with tags.
allowed_transit_encryption_modes Sequence[str]
The transit encryption modes allowed for this share.
encryption_key str
The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource.
initial_owner IsShareInitialOwnerArgs

The initial owner for the file share.

Nested scheme for initial_owner:

iops float
The maximum input/output operation performance bandwidth per second for the file share. For more information about the iops range for the given size, refer File Storage for VPC profiles
is_share_id str
(String) The unique identifier for this share snapshot.
mount_targets Sequence[IsShareMountTargetArgs]
Share targets for the file share.
name str
The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
origin_share IsShareOriginShareArgs
The origin share this accessor share is referring to. Nested schema for origin_share:
profile str

The globally unique name for this share profile.

NOTE While updating profile from 'custom' to a tiered profile make sure to remove iops from the configuration.

replica_share IsShareReplicaShareArgs
Configuration for a replica file share to create and associate with this file share.
replication_cron_spec str
The cron specification for the file share replication schedule.
resource_group str
The unique identifier for this resource group.
size float
The size of the file share rounded up to the next gigabyte.
source_share str
The ID of the source file share for this replica file share. The specified file share must not already have a replica, and must not be a replica.
source_share_crn str
The CRN of the source file share.
source_snapshot IsShareSourceSnapshotArgs
The snapshot from which this share was cloned.This property will be present when the share was created from a snapshot.The resources supported by this property mayexpand in thefuture. Nested schema for source_snapshot:
tags Sequence[str]
The list of user tags to attach to the share.
zone str
The globally unique name for this zone.
accessControlMode String
The access control mode for the share. Supported values are security_group and vpc. Default value is security_group
accessTags List<String>
The list of access management tags to attach to the share. Note For more information, about creating access tags, see working with tags.
allowedTransitEncryptionModes List<String>
The transit encryption modes allowed for this share.
encryptionKey String
The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource.
initialOwner Property Map

The initial owner for the file share.

Nested scheme for initial_owner:

iops Number
The maximum input/output operation performance bandwidth per second for the file share. For more information about the iops range for the given size, refer File Storage for VPC profiles
isShareId String
(String) The unique identifier for this share snapshot.
mountTargets List<Property Map>
Share targets for the file share.
name String
The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
originShare Property Map
The origin share this accessor share is referring to. Nested schema for origin_share:
profile String

The globally unique name for this share profile.

NOTE While updating profile from 'custom' to a tiered profile make sure to remove iops from the configuration.

replicaShare Property Map
Configuration for a replica file share to create and associate with this file share.
replicationCronSpec String
The cron specification for the file share replication schedule.
resourceGroup String
The unique identifier for this resource group.
size Number
The size of the file share rounded up to the next gigabyte.
sourceShare String
The ID of the source file share for this replica file share. The specified file share must not already have a replica, and must not be a replica.
sourceShareCrn String
The CRN of the source file share.
sourceSnapshot Property Map
The snapshot from which this share was cloned.This property will be present when the share was created from a snapshot.The resources supported by this property mayexpand in thefuture. Nested schema for source_snapshot:
tags List<String>
The list of user tags to attach to the share.
zone String
The globally unique name for this zone.

Outputs

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

AccessorBindingRole string
(String) The accessor binding role of this file share:- none: This file share is not participating in access with another file share- origin: This file share is the origin for one or more file shares (which may be in other accounts)- accessor: This file share is providing access to another file share (which may be in another account).
AccessorBindings List<IsShareAccessorBinding>
(List) The accessor bindings for this file share. Each accessor binding identifies a resource (possibly in another account) with access to this file share's data. Nested schema for accessor_bindings:
CreatedAt string
(String) The date and time that the file share is created.
Crn string
(String) The CRN for this share snapshot.
Encryption string
(String) The type of encryption used for this file share.
Href string
(String) The URL for this share snapshot.
Id string
The provider-assigned unique ID for this managed resource.
LastSyncAt string
The date and time that the file share was last synchronized to its replica.This property will be present when the replication_role is source.
LatestJobs List<IsShareLatestJob>
(List) The latest job associated with this file share.This property will be absent if no jobs have been created for this file share. Nested latest_job blocks have the following structure:
LatestSyncs List<IsShareLatestSync>
(List) Information about the latest synchronization for this file share. Nested latest_sync blocks have the following structure:
LifecycleReasons List<IsShareLifecycleReason>
The reasons for the current lifecycle_state (if any).
LifecycleState string
(String) The lifecycle state of the file share.
ReplicationRole string
The replication role of the file share.
ReplicationStatus string
"The replication status of the file share.
ReplicationStatusReasons List<IsShareReplicationStatusReason>
The reasons for the current replication status (if any). Nested replication_status_reasons blocks have the following structure:
ResourceType string
(String) The resource type.
SnapshotCount double
(Integer) The total number of snapshots for this share.
SnapshotSize double
(Integer) The total size (in gigabytes) of snapshots used for this file share.
AccessorBindingRole string
(String) The accessor binding role of this file share:- none: This file share is not participating in access with another file share- origin: This file share is the origin for one or more file shares (which may be in other accounts)- accessor: This file share is providing access to another file share (which may be in another account).
AccessorBindings []IsShareAccessorBinding
(List) The accessor bindings for this file share. Each accessor binding identifies a resource (possibly in another account) with access to this file share's data. Nested schema for accessor_bindings:
CreatedAt string
(String) The date and time that the file share is created.
Crn string
(String) The CRN for this share snapshot.
Encryption string
(String) The type of encryption used for this file share.
Href string
(String) The URL for this share snapshot.
Id string
The provider-assigned unique ID for this managed resource.
LastSyncAt string
The date and time that the file share was last synchronized to its replica.This property will be present when the replication_role is source.
LatestJobs []IsShareLatestJob
(List) The latest job associated with this file share.This property will be absent if no jobs have been created for this file share. Nested latest_job blocks have the following structure:
LatestSyncs []IsShareLatestSync
(List) Information about the latest synchronization for this file share. Nested latest_sync blocks have the following structure:
LifecycleReasons []IsShareLifecycleReason
The reasons for the current lifecycle_state (if any).
LifecycleState string
(String) The lifecycle state of the file share.
ReplicationRole string
The replication role of the file share.
ReplicationStatus string
"The replication status of the file share.
ReplicationStatusReasons []IsShareReplicationStatusReason
The reasons for the current replication status (if any). Nested replication_status_reasons blocks have the following structure:
ResourceType string
(String) The resource type.
SnapshotCount float64
(Integer) The total number of snapshots for this share.
SnapshotSize float64
(Integer) The total size (in gigabytes) of snapshots used for this file share.
accessorBindingRole String
(String) The accessor binding role of this file share:- none: This file share is not participating in access with another file share- origin: This file share is the origin for one or more file shares (which may be in other accounts)- accessor: This file share is providing access to another file share (which may be in another account).
accessorBindings List<IsShareAccessorBinding>
(List) The accessor bindings for this file share. Each accessor binding identifies a resource (possibly in another account) with access to this file share's data. Nested schema for accessor_bindings:
createdAt String
(String) The date and time that the file share is created.
crn String
(String) The CRN for this share snapshot.
encryption String
(String) The type of encryption used for this file share.
href String
(String) The URL for this share snapshot.
id String
The provider-assigned unique ID for this managed resource.
lastSyncAt String
The date and time that the file share was last synchronized to its replica.This property will be present when the replication_role is source.
latestJobs List<IsShareLatestJob>
(List) The latest job associated with this file share.This property will be absent if no jobs have been created for this file share. Nested latest_job blocks have the following structure:
latestSyncs List<IsShareLatestSync>
(List) Information about the latest synchronization for this file share. Nested latest_sync blocks have the following structure:
lifecycleReasons List<IsShareLifecycleReason>
The reasons for the current lifecycle_state (if any).
lifecycleState String
(String) The lifecycle state of the file share.
replicationRole String
The replication role of the file share.
replicationStatus String
"The replication status of the file share.
replicationStatusReasons List<IsShareReplicationStatusReason>
The reasons for the current replication status (if any). Nested replication_status_reasons blocks have the following structure:
resourceType String
(String) The resource type.
snapshotCount Double
(Integer) The total number of snapshots for this share.
snapshotSize Double
(Integer) The total size (in gigabytes) of snapshots used for this file share.
accessorBindingRole string
(String) The accessor binding role of this file share:- none: This file share is not participating in access with another file share- origin: This file share is the origin for one or more file shares (which may be in other accounts)- accessor: This file share is providing access to another file share (which may be in another account).
accessorBindings IsShareAccessorBinding[]
(List) The accessor bindings for this file share. Each accessor binding identifies a resource (possibly in another account) with access to this file share's data. Nested schema for accessor_bindings:
createdAt string
(String) The date and time that the file share is created.
crn string
(String) The CRN for this share snapshot.
encryption string
(String) The type of encryption used for this file share.
href string
(String) The URL for this share snapshot.
id string
The provider-assigned unique ID for this managed resource.
lastSyncAt string
The date and time that the file share was last synchronized to its replica.This property will be present when the replication_role is source.
latestJobs IsShareLatestJob[]
(List) The latest job associated with this file share.This property will be absent if no jobs have been created for this file share. Nested latest_job blocks have the following structure:
latestSyncs IsShareLatestSync[]
(List) Information about the latest synchronization for this file share. Nested latest_sync blocks have the following structure:
lifecycleReasons IsShareLifecycleReason[]
The reasons for the current lifecycle_state (if any).
lifecycleState string
(String) The lifecycle state of the file share.
replicationRole string
The replication role of the file share.
replicationStatus string
"The replication status of the file share.
replicationStatusReasons IsShareReplicationStatusReason[]
The reasons for the current replication status (if any). Nested replication_status_reasons blocks have the following structure:
resourceType string
(String) The resource type.
snapshotCount number
(Integer) The total number of snapshots for this share.
snapshotSize number
(Integer) The total size (in gigabytes) of snapshots used for this file share.
accessor_binding_role str
(String) The accessor binding role of this file share:- none: This file share is not participating in access with another file share- origin: This file share is the origin for one or more file shares (which may be in other accounts)- accessor: This file share is providing access to another file share (which may be in another account).
accessor_bindings Sequence[IsShareAccessorBinding]
(List) The accessor bindings for this file share. Each accessor binding identifies a resource (possibly in another account) with access to this file share's data. Nested schema for accessor_bindings:
created_at str
(String) The date and time that the file share is created.
crn str
(String) The CRN for this share snapshot.
encryption str
(String) The type of encryption used for this file share.
href str
(String) The URL for this share snapshot.
id str
The provider-assigned unique ID for this managed resource.
last_sync_at str
The date and time that the file share was last synchronized to its replica.This property will be present when the replication_role is source.
latest_jobs Sequence[IsShareLatestJob]
(List) The latest job associated with this file share.This property will be absent if no jobs have been created for this file share. Nested latest_job blocks have the following structure:
latest_syncs Sequence[IsShareLatestSync]
(List) Information about the latest synchronization for this file share. Nested latest_sync blocks have the following structure:
lifecycle_reasons Sequence[IsShareLifecycleReason]
The reasons for the current lifecycle_state (if any).
lifecycle_state str
(String) The lifecycle state of the file share.
replication_role str
The replication role of the file share.
replication_status str
"The replication status of the file share.
replication_status_reasons Sequence[IsShareReplicationStatusReason]
The reasons for the current replication status (if any). Nested replication_status_reasons blocks have the following structure:
resource_type str
(String) The resource type.
snapshot_count float
(Integer) The total number of snapshots for this share.
snapshot_size float
(Integer) The total size (in gigabytes) of snapshots used for this file share.
accessorBindingRole String
(String) The accessor binding role of this file share:- none: This file share is not participating in access with another file share- origin: This file share is the origin for one or more file shares (which may be in other accounts)- accessor: This file share is providing access to another file share (which may be in another account).
accessorBindings List<Property Map>
(List) The accessor bindings for this file share. Each accessor binding identifies a resource (possibly in another account) with access to this file share's data. Nested schema for accessor_bindings:
createdAt String
(String) The date and time that the file share is created.
crn String
(String) The CRN for this share snapshot.
encryption String
(String) The type of encryption used for this file share.
href String
(String) The URL for this share snapshot.
id String
The provider-assigned unique ID for this managed resource.
lastSyncAt String
The date and time that the file share was last synchronized to its replica.This property will be present when the replication_role is source.
latestJobs List<Property Map>
(List) The latest job associated with this file share.This property will be absent if no jobs have been created for this file share. Nested latest_job blocks have the following structure:
latestSyncs List<Property Map>
(List) Information about the latest synchronization for this file share. Nested latest_sync blocks have the following structure:
lifecycleReasons List<Property Map>
The reasons for the current lifecycle_state (if any).
lifecycleState String
(String) The lifecycle state of the file share.
replicationRole String
The replication role of the file share.
replicationStatus String
"The replication status of the file share.
replicationStatusReasons List<Property Map>
The reasons for the current replication status (if any). Nested replication_status_reasons blocks have the following structure:
resourceType String
(String) The resource type.
snapshotCount Number
(Integer) The total number of snapshots for this share.
snapshotSize Number
(Integer) The total size (in gigabytes) of snapshots used for this file share.

Look up Existing IsShare Resource

Get an existing IsShare 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?: IsShareState, opts?: CustomResourceOptions): IsShare
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_control_mode: Optional[str] = None,
        access_tags: Optional[Sequence[str]] = None,
        accessor_binding_role: Optional[str] = None,
        accessor_bindings: Optional[Sequence[IsShareAccessorBindingArgs]] = None,
        allowed_transit_encryption_modes: Optional[Sequence[str]] = None,
        created_at: Optional[str] = None,
        crn: Optional[str] = None,
        encryption: Optional[str] = None,
        encryption_key: Optional[str] = None,
        href: Optional[str] = None,
        initial_owner: Optional[IsShareInitialOwnerArgs] = None,
        iops: Optional[float] = None,
        is_share_id: Optional[str] = None,
        last_sync_at: Optional[str] = None,
        latest_jobs: Optional[Sequence[IsShareLatestJobArgs]] = None,
        latest_syncs: Optional[Sequence[IsShareLatestSyncArgs]] = None,
        lifecycle_reasons: Optional[Sequence[IsShareLifecycleReasonArgs]] = None,
        lifecycle_state: Optional[str] = None,
        mount_targets: Optional[Sequence[IsShareMountTargetArgs]] = None,
        name: Optional[str] = None,
        origin_share: Optional[IsShareOriginShareArgs] = None,
        profile: Optional[str] = None,
        replica_share: Optional[IsShareReplicaShareArgs] = None,
        replication_cron_spec: Optional[str] = None,
        replication_role: Optional[str] = None,
        replication_status: Optional[str] = None,
        replication_status_reasons: Optional[Sequence[IsShareReplicationStatusReasonArgs]] = None,
        resource_group: Optional[str] = None,
        resource_type: Optional[str] = None,
        size: Optional[float] = None,
        snapshot_count: Optional[float] = None,
        snapshot_size: Optional[float] = None,
        source_share: Optional[str] = None,
        source_share_crn: Optional[str] = None,
        source_snapshot: Optional[IsShareSourceSnapshotArgs] = None,
        tags: Optional[Sequence[str]] = None,
        zone: Optional[str] = None) -> IsShare
func GetIsShare(ctx *Context, name string, id IDInput, state *IsShareState, opts ...ResourceOption) (*IsShare, error)
public static IsShare Get(string name, Input<string> id, IsShareState? state, CustomResourceOptions? opts = null)
public static IsShare get(String name, Output<String> id, IsShareState state, CustomResourceOptions options)
resources:  _:    type: ibm:IsShare    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:
AccessControlMode string
The access control mode for the share. Supported values are security_group and vpc. Default value is security_group
AccessTags List<string>
The list of access management tags to attach to the share. Note For more information, about creating access tags, see working with tags.
AccessorBindingRole string
(String) The accessor binding role of this file share:- none: This file share is not participating in access with another file share- origin: This file share is the origin for one or more file shares (which may be in other accounts)- accessor: This file share is providing access to another file share (which may be in another account).
AccessorBindings List<IsShareAccessorBinding>
(List) The accessor bindings for this file share. Each accessor binding identifies a resource (possibly in another account) with access to this file share's data. Nested schema for accessor_bindings:
AllowedTransitEncryptionModes List<string>
The transit encryption modes allowed for this share.
CreatedAt string
(String) The date and time that the file share is created.
Crn string
(String) The CRN for this share snapshot.
Encryption string
(String) The type of encryption used for this file share.
EncryptionKey string
The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource.
Href string
(String) The URL for this share snapshot.
InitialOwner IsShareInitialOwner

The initial owner for the file share.

Nested scheme for initial_owner:

Iops double
The maximum input/output operation performance bandwidth per second for the file share. For more information about the iops range for the given size, refer File Storage for VPC profiles
IsShareId string
(String) The unique identifier for this share snapshot.
LastSyncAt string
The date and time that the file share was last synchronized to its replica.This property will be present when the replication_role is source.
LatestJobs List<IsShareLatestJob>
(List) The latest job associated with this file share.This property will be absent if no jobs have been created for this file share. Nested latest_job blocks have the following structure:
LatestSyncs List<IsShareLatestSync>
(List) Information about the latest synchronization for this file share. Nested latest_sync blocks have the following structure:
LifecycleReasons List<IsShareLifecycleReason>
The reasons for the current lifecycle_state (if any).
LifecycleState string
(String) The lifecycle state of the file share.
MountTargets List<IsShareMountTarget>
Share targets for the file share.
Name string
The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
OriginShare IsShareOriginShare
The origin share this accessor share is referring to. Nested schema for origin_share:
Profile string

The globally unique name for this share profile.

NOTE While updating profile from 'custom' to a tiered profile make sure to remove iops from the configuration.

ReplicaShare IsShareReplicaShare
Configuration for a replica file share to create and associate with this file share.
ReplicationCronSpec string
The cron specification for the file share replication schedule.
ReplicationRole string
The replication role of the file share.
ReplicationStatus string
"The replication status of the file share.
ReplicationStatusReasons List<IsShareReplicationStatusReason>
The reasons for the current replication status (if any). Nested replication_status_reasons blocks have the following structure:
ResourceGroup string
The unique identifier for this resource group.
ResourceType string
(String) The resource type.
Size double
The size of the file share rounded up to the next gigabyte.
SnapshotCount double
(Integer) The total number of snapshots for this share.
SnapshotSize double
(Integer) The total size (in gigabytes) of snapshots used for this file share.
SourceShare string
The ID of the source file share for this replica file share. The specified file share must not already have a replica, and must not be a replica.
SourceShareCrn string
The CRN of the source file share.
SourceSnapshot IsShareSourceSnapshot
The snapshot from which this share was cloned.This property will be present when the share was created from a snapshot.The resources supported by this property mayexpand in thefuture. Nested schema for source_snapshot:
Tags List<string>
The list of user tags to attach to the share.
Zone string
The globally unique name for this zone.
AccessControlMode string
The access control mode for the share. Supported values are security_group and vpc. Default value is security_group
AccessTags []string
The list of access management tags to attach to the share. Note For more information, about creating access tags, see working with tags.
AccessorBindingRole string
(String) The accessor binding role of this file share:- none: This file share is not participating in access with another file share- origin: This file share is the origin for one or more file shares (which may be in other accounts)- accessor: This file share is providing access to another file share (which may be in another account).
AccessorBindings []IsShareAccessorBindingArgs
(List) The accessor bindings for this file share. Each accessor binding identifies a resource (possibly in another account) with access to this file share's data. Nested schema for accessor_bindings:
AllowedTransitEncryptionModes []string
The transit encryption modes allowed for this share.
CreatedAt string
(String) The date and time that the file share is created.
Crn string
(String) The CRN for this share snapshot.
Encryption string
(String) The type of encryption used for this file share.
EncryptionKey string
The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource.
Href string
(String) The URL for this share snapshot.
InitialOwner IsShareInitialOwnerArgs

The initial owner for the file share.

Nested scheme for initial_owner:

Iops float64
The maximum input/output operation performance bandwidth per second for the file share. For more information about the iops range for the given size, refer File Storage for VPC profiles
IsShareId string
(String) The unique identifier for this share snapshot.
LastSyncAt string
The date and time that the file share was last synchronized to its replica.This property will be present when the replication_role is source.
LatestJobs []IsShareLatestJobArgs
(List) The latest job associated with this file share.This property will be absent if no jobs have been created for this file share. Nested latest_job blocks have the following structure:
LatestSyncs []IsShareLatestSyncArgs
(List) Information about the latest synchronization for this file share. Nested latest_sync blocks have the following structure:
LifecycleReasons []IsShareLifecycleReasonArgs
The reasons for the current lifecycle_state (if any).
LifecycleState string
(String) The lifecycle state of the file share.
MountTargets []IsShareMountTargetTypeArgs
Share targets for the file share.
Name string
The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
OriginShare IsShareOriginShareArgs
The origin share this accessor share is referring to. Nested schema for origin_share:
Profile string

The globally unique name for this share profile.

NOTE While updating profile from 'custom' to a tiered profile make sure to remove iops from the configuration.

ReplicaShare IsShareReplicaShareArgs
Configuration for a replica file share to create and associate with this file share.
ReplicationCronSpec string
The cron specification for the file share replication schedule.
ReplicationRole string
The replication role of the file share.
ReplicationStatus string
"The replication status of the file share.
ReplicationStatusReasons []IsShareReplicationStatusReasonArgs
The reasons for the current replication status (if any). Nested replication_status_reasons blocks have the following structure:
ResourceGroup string
The unique identifier for this resource group.
ResourceType string
(String) The resource type.
Size float64
The size of the file share rounded up to the next gigabyte.
SnapshotCount float64
(Integer) The total number of snapshots for this share.
SnapshotSize float64
(Integer) The total size (in gigabytes) of snapshots used for this file share.
SourceShare string
The ID of the source file share for this replica file share. The specified file share must not already have a replica, and must not be a replica.
SourceShareCrn string
The CRN of the source file share.
SourceSnapshot IsShareSourceSnapshotArgs
The snapshot from which this share was cloned.This property will be present when the share was created from a snapshot.The resources supported by this property mayexpand in thefuture. Nested schema for source_snapshot:
Tags []string
The list of user tags to attach to the share.
Zone string
The globally unique name for this zone.
accessControlMode String
The access control mode for the share. Supported values are security_group and vpc. Default value is security_group
accessTags List<String>
The list of access management tags to attach to the share. Note For more information, about creating access tags, see working with tags.
accessorBindingRole String
(String) The accessor binding role of this file share:- none: This file share is not participating in access with another file share- origin: This file share is the origin for one or more file shares (which may be in other accounts)- accessor: This file share is providing access to another file share (which may be in another account).
accessorBindings List<IsShareAccessorBinding>
(List) The accessor bindings for this file share. Each accessor binding identifies a resource (possibly in another account) with access to this file share's data. Nested schema for accessor_bindings:
allowedTransitEncryptionModes List<String>
The transit encryption modes allowed for this share.
createdAt String
(String) The date and time that the file share is created.
crn String
(String) The CRN for this share snapshot.
encryption String
(String) The type of encryption used for this file share.
encryptionKey String
The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource.
href String
(String) The URL for this share snapshot.
initialOwner IsShareInitialOwner

The initial owner for the file share.

Nested scheme for initial_owner:

iops Double
The maximum input/output operation performance bandwidth per second for the file share. For more information about the iops range for the given size, refer File Storage for VPC profiles
isShareId String
(String) The unique identifier for this share snapshot.
lastSyncAt String
The date and time that the file share was last synchronized to its replica.This property will be present when the replication_role is source.
latestJobs List<IsShareLatestJob>
(List) The latest job associated with this file share.This property will be absent if no jobs have been created for this file share. Nested latest_job blocks have the following structure:
latestSyncs List<IsShareLatestSync>
(List) Information about the latest synchronization for this file share. Nested latest_sync blocks have the following structure:
lifecycleReasons List<IsShareLifecycleReason>
The reasons for the current lifecycle_state (if any).
lifecycleState String
(String) The lifecycle state of the file share.
mountTargets List<IsShareMountTarget>
Share targets for the file share.
name String
The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
originShare IsShareOriginShare
The origin share this accessor share is referring to. Nested schema for origin_share:
profile String

The globally unique name for this share profile.

NOTE While updating profile from 'custom' to a tiered profile make sure to remove iops from the configuration.

replicaShare IsShareReplicaShare
Configuration for a replica file share to create and associate with this file share.
replicationCronSpec String
The cron specification for the file share replication schedule.
replicationRole String
The replication role of the file share.
replicationStatus String
"The replication status of the file share.
replicationStatusReasons List<IsShareReplicationStatusReason>
The reasons for the current replication status (if any). Nested replication_status_reasons blocks have the following structure:
resourceGroup String
The unique identifier for this resource group.
resourceType String
(String) The resource type.
size Double
The size of the file share rounded up to the next gigabyte.
snapshotCount Double
(Integer) The total number of snapshots for this share.
snapshotSize Double
(Integer) The total size (in gigabytes) of snapshots used for this file share.
sourceShare String
The ID of the source file share for this replica file share. The specified file share must not already have a replica, and must not be a replica.
sourceShareCrn String
The CRN of the source file share.
sourceSnapshot IsShareSourceSnapshot
The snapshot from which this share was cloned.This property will be present when the share was created from a snapshot.The resources supported by this property mayexpand in thefuture. Nested schema for source_snapshot:
tags List<String>
The list of user tags to attach to the share.
zone String
The globally unique name for this zone.
accessControlMode string
The access control mode for the share. Supported values are security_group and vpc. Default value is security_group
accessTags string[]
The list of access management tags to attach to the share. Note For more information, about creating access tags, see working with tags.
accessorBindingRole string
(String) The accessor binding role of this file share:- none: This file share is not participating in access with another file share- origin: This file share is the origin for one or more file shares (which may be in other accounts)- accessor: This file share is providing access to another file share (which may be in another account).
accessorBindings IsShareAccessorBinding[]
(List) The accessor bindings for this file share. Each accessor binding identifies a resource (possibly in another account) with access to this file share's data. Nested schema for accessor_bindings:
allowedTransitEncryptionModes string[]
The transit encryption modes allowed for this share.
createdAt string
(String) The date and time that the file share is created.
crn string
(String) The CRN for this share snapshot.
encryption string
(String) The type of encryption used for this file share.
encryptionKey string
The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource.
href string
(String) The URL for this share snapshot.
initialOwner IsShareInitialOwner

The initial owner for the file share.

Nested scheme for initial_owner:

iops number
The maximum input/output operation performance bandwidth per second for the file share. For more information about the iops range for the given size, refer File Storage for VPC profiles
isShareId string
(String) The unique identifier for this share snapshot.
lastSyncAt string
The date and time that the file share was last synchronized to its replica.This property will be present when the replication_role is source.
latestJobs IsShareLatestJob[]
(List) The latest job associated with this file share.This property will be absent if no jobs have been created for this file share. Nested latest_job blocks have the following structure:
latestSyncs IsShareLatestSync[]
(List) Information about the latest synchronization for this file share. Nested latest_sync blocks have the following structure:
lifecycleReasons IsShareLifecycleReason[]
The reasons for the current lifecycle_state (if any).
lifecycleState string
(String) The lifecycle state of the file share.
mountTargets IsShareMountTarget[]
Share targets for the file share.
name string
The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
originShare IsShareOriginShare
The origin share this accessor share is referring to. Nested schema for origin_share:
profile string

The globally unique name for this share profile.

NOTE While updating profile from 'custom' to a tiered profile make sure to remove iops from the configuration.

replicaShare IsShareReplicaShare
Configuration for a replica file share to create and associate with this file share.
replicationCronSpec string
The cron specification for the file share replication schedule.
replicationRole string
The replication role of the file share.
replicationStatus string
"The replication status of the file share.
replicationStatusReasons IsShareReplicationStatusReason[]
The reasons for the current replication status (if any). Nested replication_status_reasons blocks have the following structure:
resourceGroup string
The unique identifier for this resource group.
resourceType string
(String) The resource type.
size number
The size of the file share rounded up to the next gigabyte.
snapshotCount number
(Integer) The total number of snapshots for this share.
snapshotSize number
(Integer) The total size (in gigabytes) of snapshots used for this file share.
sourceShare string
The ID of the source file share for this replica file share. The specified file share must not already have a replica, and must not be a replica.
sourceShareCrn string
The CRN of the source file share.
sourceSnapshot IsShareSourceSnapshot
The snapshot from which this share was cloned.This property will be present when the share was created from a snapshot.The resources supported by this property mayexpand in thefuture. Nested schema for source_snapshot:
tags string[]
The list of user tags to attach to the share.
zone string
The globally unique name for this zone.
access_control_mode str
The access control mode for the share. Supported values are security_group and vpc. Default value is security_group
access_tags Sequence[str]
The list of access management tags to attach to the share. Note For more information, about creating access tags, see working with tags.
accessor_binding_role str
(String) The accessor binding role of this file share:- none: This file share is not participating in access with another file share- origin: This file share is the origin for one or more file shares (which may be in other accounts)- accessor: This file share is providing access to another file share (which may be in another account).
accessor_bindings Sequence[IsShareAccessorBindingArgs]
(List) The accessor bindings for this file share. Each accessor binding identifies a resource (possibly in another account) with access to this file share's data. Nested schema for accessor_bindings:
allowed_transit_encryption_modes Sequence[str]
The transit encryption modes allowed for this share.
created_at str
(String) The date and time that the file share is created.
crn str
(String) The CRN for this share snapshot.
encryption str
(String) The type of encryption used for this file share.
encryption_key str
The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource.
href str
(String) The URL for this share snapshot.
initial_owner IsShareInitialOwnerArgs

The initial owner for the file share.

Nested scheme for initial_owner:

iops float
The maximum input/output operation performance bandwidth per second for the file share. For more information about the iops range for the given size, refer File Storage for VPC profiles
is_share_id str
(String) The unique identifier for this share snapshot.
last_sync_at str
The date and time that the file share was last synchronized to its replica.This property will be present when the replication_role is source.
latest_jobs Sequence[IsShareLatestJobArgs]
(List) The latest job associated with this file share.This property will be absent if no jobs have been created for this file share. Nested latest_job blocks have the following structure:
latest_syncs Sequence[IsShareLatestSyncArgs]
(List) Information about the latest synchronization for this file share. Nested latest_sync blocks have the following structure:
lifecycle_reasons Sequence[IsShareLifecycleReasonArgs]
The reasons for the current lifecycle_state (if any).
lifecycle_state str
(String) The lifecycle state of the file share.
mount_targets Sequence[IsShareMountTargetArgs]
Share targets for the file share.
name str
The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
origin_share IsShareOriginShareArgs
The origin share this accessor share is referring to. Nested schema for origin_share:
profile str

The globally unique name for this share profile.

NOTE While updating profile from 'custom' to a tiered profile make sure to remove iops from the configuration.

replica_share IsShareReplicaShareArgs
Configuration for a replica file share to create and associate with this file share.
replication_cron_spec str
The cron specification for the file share replication schedule.
replication_role str
The replication role of the file share.
replication_status str
"The replication status of the file share.
replication_status_reasons Sequence[IsShareReplicationStatusReasonArgs]
The reasons for the current replication status (if any). Nested replication_status_reasons blocks have the following structure:
resource_group str
The unique identifier for this resource group.
resource_type str
(String) The resource type.
size float
The size of the file share rounded up to the next gigabyte.
snapshot_count float
(Integer) The total number of snapshots for this share.
snapshot_size float
(Integer) The total size (in gigabytes) of snapshots used for this file share.
source_share str
The ID of the source file share for this replica file share. The specified file share must not already have a replica, and must not be a replica.
source_share_crn str
The CRN of the source file share.
source_snapshot IsShareSourceSnapshotArgs
The snapshot from which this share was cloned.This property will be present when the share was created from a snapshot.The resources supported by this property mayexpand in thefuture. Nested schema for source_snapshot:
tags Sequence[str]
The list of user tags to attach to the share.
zone str
The globally unique name for this zone.
accessControlMode String
The access control mode for the share. Supported values are security_group and vpc. Default value is security_group
accessTags List<String>
The list of access management tags to attach to the share. Note For more information, about creating access tags, see working with tags.
accessorBindingRole String
(String) The accessor binding role of this file share:- none: This file share is not participating in access with another file share- origin: This file share is the origin for one or more file shares (which may be in other accounts)- accessor: This file share is providing access to another file share (which may be in another account).
accessorBindings List<Property Map>
(List) The accessor bindings for this file share. Each accessor binding identifies a resource (possibly in another account) with access to this file share's data. Nested schema for accessor_bindings:
allowedTransitEncryptionModes List<String>
The transit encryption modes allowed for this share.
createdAt String
(String) The date and time that the file share is created.
crn String
(String) The CRN for this share snapshot.
encryption String
(String) The type of encryption used for this file share.
encryptionKey String
The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource.
href String
(String) The URL for this share snapshot.
initialOwner Property Map

The initial owner for the file share.

Nested scheme for initial_owner:

iops Number
The maximum input/output operation performance bandwidth per second for the file share. For more information about the iops range for the given size, refer File Storage for VPC profiles
isShareId String
(String) The unique identifier for this share snapshot.
lastSyncAt String
The date and time that the file share was last synchronized to its replica.This property will be present when the replication_role is source.
latestJobs List<Property Map>
(List) The latest job associated with this file share.This property will be absent if no jobs have been created for this file share. Nested latest_job blocks have the following structure:
latestSyncs List<Property Map>
(List) Information about the latest synchronization for this file share. Nested latest_sync blocks have the following structure:
lifecycleReasons List<Property Map>
The reasons for the current lifecycle_state (if any).
lifecycleState String
(String) The lifecycle state of the file share.
mountTargets List<Property Map>
Share targets for the file share.
name String
The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
originShare Property Map
The origin share this accessor share is referring to. Nested schema for origin_share:
profile String

The globally unique name for this share profile.

NOTE While updating profile from 'custom' to a tiered profile make sure to remove iops from the configuration.

replicaShare Property Map
Configuration for a replica file share to create and associate with this file share.
replicationCronSpec String
The cron specification for the file share replication schedule.
replicationRole String
The replication role of the file share.
replicationStatus String
"The replication status of the file share.
replicationStatusReasons List<Property Map>
The reasons for the current replication status (if any). Nested replication_status_reasons blocks have the following structure:
resourceGroup String
The unique identifier for this resource group.
resourceType String
(String) The resource type.
size Number
The size of the file share rounded up to the next gigabyte.
snapshotCount Number
(Integer) The total number of snapshots for this share.
snapshotSize Number
(Integer) The total size (in gigabytes) of snapshots used for this file share.
sourceShare String
The ID of the source file share for this replica file share. The specified file share must not already have a replica, and must not be a replica.
sourceShareCrn String
The CRN of the source file share.
sourceSnapshot Property Map
The snapshot from which this share was cloned.This property will be present when the share was created from a snapshot.The resources supported by this property mayexpand in thefuture. Nested schema for source_snapshot:
tags List<String>
The list of user tags to attach to the share.
zone String
The globally unique name for this zone.

Supporting Types

IsShareAccessorBinding
, IsShareAccessorBindingArgs

Href This property is required. string
(String) The URL for this share snapshot.
Id This property is required. string
(String) The unique identifier for this share snapshot.
ResourceType This property is required. string
(String) The resource type.
Href This property is required. string
(String) The URL for this share snapshot.
Id This property is required. string
(String) The unique identifier for this share snapshot.
ResourceType This property is required. string
(String) The resource type.
href This property is required. String
(String) The URL for this share snapshot.
id This property is required. String
(String) The unique identifier for this share snapshot.
resourceType This property is required. String
(String) The resource type.
href This property is required. string
(String) The URL for this share snapshot.
id This property is required. string
(String) The unique identifier for this share snapshot.
resourceType This property is required. string
(String) The resource type.
href This property is required. str
(String) The URL for this share snapshot.
id This property is required. str
(String) The unique identifier for this share snapshot.
resource_type This property is required. str
(String) The resource type.
href This property is required. String
(String) The URL for this share snapshot.
id This property is required. String
(String) The unique identifier for this share snapshot.
resourceType This property is required. String
(String) The resource type.

IsShareInitialOwner
, IsShareInitialOwnerArgs

Gid double
The initial group identifier for the file share.
Uid double
The initial user identifier for the file share.
Gid float64
The initial group identifier for the file share.
Uid float64
The initial user identifier for the file share.
gid Double
The initial group identifier for the file share.
uid Double
The initial user identifier for the file share.
gid number
The initial group identifier for the file share.
uid number
The initial user identifier for the file share.
gid float
The initial group identifier for the file share.
uid float
The initial user identifier for the file share.
gid Number
The initial group identifier for the file share.
uid Number
The initial user identifier for the file share.

IsShareLatestJob
, IsShareLatestJobArgs

Status This property is required. string
(String) The status of the file share job
StatusReasons This property is required. List<IsShareLatestJobStatusReason>
(List) The reasons for the file share job status (if any). Nested status_reasons blocks have the following structure:
Type This property is required. string
(String) The type of the file share job
Status This property is required. string
(String) The status of the file share job
StatusReasons This property is required. []IsShareLatestJobStatusReason
(List) The reasons for the file share job status (if any). Nested status_reasons blocks have the following structure:
Type This property is required. string
(String) The type of the file share job
status This property is required. String
(String) The status of the file share job
statusReasons This property is required. List<IsShareLatestJobStatusReason>
(List) The reasons for the file share job status (if any). Nested status_reasons blocks have the following structure:
type This property is required. String
(String) The type of the file share job
status This property is required. string
(String) The status of the file share job
statusReasons This property is required. IsShareLatestJobStatusReason[]
(List) The reasons for the file share job status (if any). Nested status_reasons blocks have the following structure:
type This property is required. string
(String) The type of the file share job
status This property is required. str
(String) The status of the file share job
status_reasons This property is required. Sequence[IsShareLatestJobStatusReason]
(List) The reasons for the file share job status (if any). Nested status_reasons blocks have the following structure:
type This property is required. str
(String) The type of the file share job
status This property is required. String
(String) The status of the file share job
statusReasons This property is required. List<Property Map>
(List) The reasons for the file share job status (if any). Nested status_reasons blocks have the following structure:
type This property is required. String
(String) The type of the file share job

IsShareLatestJobStatusReason
, IsShareLatestJobStatusReasonArgs

Code This property is required. string
A snake case string succinctly identifying the status reason.
Message This property is required. string
An explanation of the status reason.
MoreInfo This property is required. string
(Computed, String) Link to documentation about deleted resources.
Code This property is required. string
A snake case string succinctly identifying the status reason.
Message This property is required. string
An explanation of the status reason.
MoreInfo This property is required. string
(Computed, String) Link to documentation about deleted resources.
code This property is required. String
A snake case string succinctly identifying the status reason.
message This property is required. String
An explanation of the status reason.
moreInfo This property is required. String
(Computed, String) Link to documentation about deleted resources.
code This property is required. string
A snake case string succinctly identifying the status reason.
message This property is required. string
An explanation of the status reason.
moreInfo This property is required. string
(Computed, String) Link to documentation about deleted resources.
code This property is required. str
A snake case string succinctly identifying the status reason.
message This property is required. str
An explanation of the status reason.
more_info This property is required. str
(Computed, String) Link to documentation about deleted resources.
code This property is required. String
A snake case string succinctly identifying the status reason.
message This property is required. String
An explanation of the status reason.
moreInfo This property is required. String
(Computed, String) Link to documentation about deleted resources.

IsShareLatestSync
, IsShareLatestSyncArgs

CompletedAt This property is required. string
(String) The completed date and time of last synchronization between the replica share and its source.
DataTransferred This property is required. double
(Integer) The data transferred (in bytes) in the last synchronization between the replica and its source.
StartedAt This property is required. string
(String) The start date and time of last synchronization between the replica share and its source.
CompletedAt This property is required. string
(String) The completed date and time of last synchronization between the replica share and its source.
DataTransferred This property is required. float64
(Integer) The data transferred (in bytes) in the last synchronization between the replica and its source.
StartedAt This property is required. string
(String) The start date and time of last synchronization between the replica share and its source.
completedAt This property is required. String
(String) The completed date and time of last synchronization between the replica share and its source.
dataTransferred This property is required. Double
(Integer) The data transferred (in bytes) in the last synchronization between the replica and its source.
startedAt This property is required. String
(String) The start date and time of last synchronization between the replica share and its source.
completedAt This property is required. string
(String) The completed date and time of last synchronization between the replica share and its source.
dataTransferred This property is required. number
(Integer) The data transferred (in bytes) in the last synchronization between the replica and its source.
startedAt This property is required. string
(String) The start date and time of last synchronization between the replica share and its source.
completed_at This property is required. str
(String) The completed date and time of last synchronization between the replica share and its source.
data_transferred This property is required. float
(Integer) The data transferred (in bytes) in the last synchronization between the replica and its source.
started_at This property is required. str
(String) The start date and time of last synchronization between the replica share and its source.
completedAt This property is required. String
(String) The completed date and time of last synchronization between the replica share and its source.
dataTransferred This property is required. Number
(Integer) The data transferred (in bytes) in the last synchronization between the replica and its source.
startedAt This property is required. String
(String) The start date and time of last synchronization between the replica share and its source.

IsShareLifecycleReason
, IsShareLifecycleReasonArgs

Code This property is required. string
A snake case string succinctly identifying the status reason.
Message This property is required. string
An explanation of the status reason.
MoreInfo This property is required. string
(Computed, String) Link to documentation about deleted resources.
Code This property is required. string
A snake case string succinctly identifying the status reason.
Message This property is required. string
An explanation of the status reason.
MoreInfo This property is required. string
(Computed, String) Link to documentation about deleted resources.
code This property is required. String
A snake case string succinctly identifying the status reason.
message This property is required. String
An explanation of the status reason.
moreInfo This property is required. String
(Computed, String) Link to documentation about deleted resources.
code This property is required. string
A snake case string succinctly identifying the status reason.
message This property is required. string
An explanation of the status reason.
moreInfo This property is required. string
(Computed, String) Link to documentation about deleted resources.
code This property is required. str
A snake case string succinctly identifying the status reason.
message This property is required. str
An explanation of the status reason.
more_info This property is required. str
(Computed, String) Link to documentation about deleted resources.
code This property is required. String
A snake case string succinctly identifying the status reason.
message This property is required. String
An explanation of the status reason.
moreInfo This property is required. String
(Computed, String) Link to documentation about deleted resources.

IsShareMountTarget
, IsShareMountTargetArgs

Name This property is required. string
The user-defined name for this share target. Names must be unique within the share the share target resides in.
Href string
(String) The URL for this share snapshot.
Id string
(String) The unique identifier for this share snapshot.
ResourceType string
(String) The resource type.
TransitEncryption string

The transit encryption mode for this share target. Supported values are none, user_managed. Default is none

Note transit_encryption can only be provided to create mount target for a share with access_control_mode security_group. It is not supported with shares that has access_control_mode vpc Note virtual_network_interface and vpc are mutually exclusive and one of them must be provided.

VirtualNetworkInterfaces List<IsShareMountTargetVirtualNetworkInterface>

The virtual network interface for this share mount target. Required if the share's access_control_mode is security_group.

Nested scheme for virtual_network_interface:

Vpc string
The VPC in which instances can mount the file share using this share target. Required if the share's access_control_mode is vpc.
Name This property is required. string
The user-defined name for this share target. Names must be unique within the share the share target resides in.
Href string
(String) The URL for this share snapshot.
Id string
(String) The unique identifier for this share snapshot.
ResourceType string
(String) The resource type.
TransitEncryption string

The transit encryption mode for this share target. Supported values are none, user_managed. Default is none

Note transit_encryption can only be provided to create mount target for a share with access_control_mode security_group. It is not supported with shares that has access_control_mode vpc Note virtual_network_interface and vpc are mutually exclusive and one of them must be provided.

VirtualNetworkInterfaces []IsShareMountTargetVirtualNetworkInterface

The virtual network interface for this share mount target. Required if the share's access_control_mode is security_group.

Nested scheme for virtual_network_interface:

Vpc string
The VPC in which instances can mount the file share using this share target. Required if the share's access_control_mode is vpc.
name This property is required. String
The user-defined name for this share target. Names must be unique within the share the share target resides in.
href String
(String) The URL for this share snapshot.
id String
(String) The unique identifier for this share snapshot.
resourceType String
(String) The resource type.
transitEncryption String

The transit encryption mode for this share target. Supported values are none, user_managed. Default is none

Note transit_encryption can only be provided to create mount target for a share with access_control_mode security_group. It is not supported with shares that has access_control_mode vpc Note virtual_network_interface and vpc are mutually exclusive and one of them must be provided.

virtualNetworkInterfaces List<IsShareMountTargetVirtualNetworkInterface>

The virtual network interface for this share mount target. Required if the share's access_control_mode is security_group.

Nested scheme for virtual_network_interface:

vpc String
The VPC in which instances can mount the file share using this share target. Required if the share's access_control_mode is vpc.
name This property is required. string
The user-defined name for this share target. Names must be unique within the share the share target resides in.
href string
(String) The URL for this share snapshot.
id string
(String) The unique identifier for this share snapshot.
resourceType string
(String) The resource type.
transitEncryption string

The transit encryption mode for this share target. Supported values are none, user_managed. Default is none

Note transit_encryption can only be provided to create mount target for a share with access_control_mode security_group. It is not supported with shares that has access_control_mode vpc Note virtual_network_interface and vpc are mutually exclusive and one of them must be provided.

virtualNetworkInterfaces IsShareMountTargetVirtualNetworkInterface[]

The virtual network interface for this share mount target. Required if the share's access_control_mode is security_group.

Nested scheme for virtual_network_interface:

vpc string
The VPC in which instances can mount the file share using this share target. Required if the share's access_control_mode is vpc.
name This property is required. str
The user-defined name for this share target. Names must be unique within the share the share target resides in.
href str
(String) The URL for this share snapshot.
id str
(String) The unique identifier for this share snapshot.
resource_type str
(String) The resource type.
transit_encryption str

The transit encryption mode for this share target. Supported values are none, user_managed. Default is none

Note transit_encryption can only be provided to create mount target for a share with access_control_mode security_group. It is not supported with shares that has access_control_mode vpc Note virtual_network_interface and vpc are mutually exclusive and one of them must be provided.

virtual_network_interfaces Sequence[IsShareMountTargetVirtualNetworkInterface]

The virtual network interface for this share mount target. Required if the share's access_control_mode is security_group.

Nested scheme for virtual_network_interface:

vpc str
The VPC in which instances can mount the file share using this share target. Required if the share's access_control_mode is vpc.
name This property is required. String
The user-defined name for this share target. Names must be unique within the share the share target resides in.
href String
(String) The URL for this share snapshot.
id String
(String) The unique identifier for this share snapshot.
resourceType String
(String) The resource type.
transitEncryption String

The transit encryption mode for this share target. Supported values are none, user_managed. Default is none

Note transit_encryption can only be provided to create mount target for a share with access_control_mode security_group. It is not supported with shares that has access_control_mode vpc Note virtual_network_interface and vpc are mutually exclusive and one of them must be provided.

virtualNetworkInterfaces List<Property Map>

The virtual network interface for this share mount target. Required if the share's access_control_mode is security_group.

Nested scheme for virtual_network_interface:

vpc String
The VPC in which instances can mount the file share using this share target. Required if the share's access_control_mode is vpc.

IsShareMountTargetVirtualNetworkInterface
, IsShareMountTargetVirtualNetworkInterfaceArgs

AllowIpSpoofing bool
(Bool) Indicates whether source IP spoofing is allowed on this interface. If false, source IP spoofing is prevented on this interface. If true, source IP spoofing is allowed on this interface.
AutoDelete bool
(Bool) Indicates whether this virtual network interface will be automatically deleted when target is deleted
Crn string
CRN of this VNI
EnableInfrastructureNat bool
(Bool) If true:- The VPC infrastructure performs any needed NAT operations.- floating_ips must not have more than one floating IP.If false:- Packets are passed unchanged to/from the network interface, allowing the workload to perform any needed NAT operations.- allow_ip_spoofing must be false.- If the virtual network interface is attached: - The target resource_type must be bare_metal_server_network_attachment. - The target interface_type must not be hipersocket.
Href string
(String)The URL for this share target.
Id string

The ID for virtual network interface. Mutually exclusive with other virtual_network_interface arguments.

Note id is mutually exclusive with other virtual_network_interface prototype arguments

Name string
Name for this virtual network interface. The name must not be used by another virtual network interface in the VPC. Nested scheme for virtual_network_interface:
PrimaryIp IsShareMountTargetVirtualNetworkInterfacePrimaryIp

The primary IP address to bind to the virtual network interface. May be either a reserved IP identity, or a reserved IP prototype object which will be used to create a new reserved IP.

Nested scheme for primary_ip:

ProtocolStateFilteringMode string

The protocol state filtering mode to use for this virtual network interface.

If auto, protocol state packet filtering is enabled or disabled based on the virtual network interface's target resource type: bare_metal_server_network_attachment: disabled instance_network_attachment: enabled share_mount_target: enabled

ResourceGroup string
The ID of the resource group to use.
ResourceType string
(String) The type of resource referenced.
SecurityGroups List<string>
The security groups to use for this virtual network interface.
Subnet string
The associated subnet.
AllowIpSpoofing bool
(Bool) Indicates whether source IP spoofing is allowed on this interface. If false, source IP spoofing is prevented on this interface. If true, source IP spoofing is allowed on this interface.
AutoDelete bool
(Bool) Indicates whether this virtual network interface will be automatically deleted when target is deleted
Crn string
CRN of this VNI
EnableInfrastructureNat bool
(Bool) If true:- The VPC infrastructure performs any needed NAT operations.- floating_ips must not have more than one floating IP.If false:- Packets are passed unchanged to/from the network interface, allowing the workload to perform any needed NAT operations.- allow_ip_spoofing must be false.- If the virtual network interface is attached: - The target resource_type must be bare_metal_server_network_attachment. - The target interface_type must not be hipersocket.
Href string
(String)The URL for this share target.
Id string

The ID for virtual network interface. Mutually exclusive with other virtual_network_interface arguments.

Note id is mutually exclusive with other virtual_network_interface prototype arguments

Name string
Name for this virtual network interface. The name must not be used by another virtual network interface in the VPC. Nested scheme for virtual_network_interface:
PrimaryIp IsShareMountTargetVirtualNetworkInterfacePrimaryIp

The primary IP address to bind to the virtual network interface. May be either a reserved IP identity, or a reserved IP prototype object which will be used to create a new reserved IP.

Nested scheme for primary_ip:

ProtocolStateFilteringMode string

The protocol state filtering mode to use for this virtual network interface.

If auto, protocol state packet filtering is enabled or disabled based on the virtual network interface's target resource type: bare_metal_server_network_attachment: disabled instance_network_attachment: enabled share_mount_target: enabled

ResourceGroup string
The ID of the resource group to use.
ResourceType string
(String) The type of resource referenced.
SecurityGroups []string
The security groups to use for this virtual network interface.
Subnet string
The associated subnet.
allowIpSpoofing Boolean
(Bool) Indicates whether source IP spoofing is allowed on this interface. If false, source IP spoofing is prevented on this interface. If true, source IP spoofing is allowed on this interface.
autoDelete Boolean
(Bool) Indicates whether this virtual network interface will be automatically deleted when target is deleted
crn String
CRN of this VNI
enableInfrastructureNat Boolean
(Bool) If true:- The VPC infrastructure performs any needed NAT operations.- floating_ips must not have more than one floating IP.If false:- Packets are passed unchanged to/from the network interface, allowing the workload to perform any needed NAT operations.- allow_ip_spoofing must be false.- If the virtual network interface is attached: - The target resource_type must be bare_metal_server_network_attachment. - The target interface_type must not be hipersocket.
href String
(String)The URL for this share target.
id String

The ID for virtual network interface. Mutually exclusive with other virtual_network_interface arguments.

Note id is mutually exclusive with other virtual_network_interface prototype arguments

name String
Name for this virtual network interface. The name must not be used by another virtual network interface in the VPC. Nested scheme for virtual_network_interface:
primaryIp IsShareMountTargetVirtualNetworkInterfacePrimaryIp

The primary IP address to bind to the virtual network interface. May be either a reserved IP identity, or a reserved IP prototype object which will be used to create a new reserved IP.

Nested scheme for primary_ip:

protocolStateFilteringMode String

The protocol state filtering mode to use for this virtual network interface.

If auto, protocol state packet filtering is enabled or disabled based on the virtual network interface's target resource type: bare_metal_server_network_attachment: disabled instance_network_attachment: enabled share_mount_target: enabled

resourceGroup String
The ID of the resource group to use.
resourceType String
(String) The type of resource referenced.
securityGroups List<String>
The security groups to use for this virtual network interface.
subnet String
The associated subnet.
allowIpSpoofing boolean
(Bool) Indicates whether source IP spoofing is allowed on this interface. If false, source IP spoofing is prevented on this interface. If true, source IP spoofing is allowed on this interface.
autoDelete boolean
(Bool) Indicates whether this virtual network interface will be automatically deleted when target is deleted
crn string
CRN of this VNI
enableInfrastructureNat boolean
(Bool) If true:- The VPC infrastructure performs any needed NAT operations.- floating_ips must not have more than one floating IP.If false:- Packets are passed unchanged to/from the network interface, allowing the workload to perform any needed NAT operations.- allow_ip_spoofing must be false.- If the virtual network interface is attached: - The target resource_type must be bare_metal_server_network_attachment. - The target interface_type must not be hipersocket.
href string
(String)The URL for this share target.
id string

The ID for virtual network interface. Mutually exclusive with other virtual_network_interface arguments.

Note id is mutually exclusive with other virtual_network_interface prototype arguments

name string
Name for this virtual network interface. The name must not be used by another virtual network interface in the VPC. Nested scheme for virtual_network_interface:
primaryIp IsShareMountTargetVirtualNetworkInterfacePrimaryIp

The primary IP address to bind to the virtual network interface. May be either a reserved IP identity, or a reserved IP prototype object which will be used to create a new reserved IP.

Nested scheme for primary_ip:

protocolStateFilteringMode string

The protocol state filtering mode to use for this virtual network interface.

If auto, protocol state packet filtering is enabled or disabled based on the virtual network interface's target resource type: bare_metal_server_network_attachment: disabled instance_network_attachment: enabled share_mount_target: enabled

resourceGroup string
The ID of the resource group to use.
resourceType string
(String) The type of resource referenced.
securityGroups string[]
The security groups to use for this virtual network interface.
subnet string
The associated subnet.
allow_ip_spoofing bool
(Bool) Indicates whether source IP spoofing is allowed on this interface. If false, source IP spoofing is prevented on this interface. If true, source IP spoofing is allowed on this interface.
auto_delete bool
(Bool) Indicates whether this virtual network interface will be automatically deleted when target is deleted
crn str
CRN of this VNI
enable_infrastructure_nat bool
(Bool) If true:- The VPC infrastructure performs any needed NAT operations.- floating_ips must not have more than one floating IP.If false:- Packets are passed unchanged to/from the network interface, allowing the workload to perform any needed NAT operations.- allow_ip_spoofing must be false.- If the virtual network interface is attached: - The target resource_type must be bare_metal_server_network_attachment. - The target interface_type must not be hipersocket.
href str
(String)The URL for this share target.
id str

The ID for virtual network interface. Mutually exclusive with other virtual_network_interface arguments.

Note id is mutually exclusive with other virtual_network_interface prototype arguments

name str
Name for this virtual network interface. The name must not be used by another virtual network interface in the VPC. Nested scheme for virtual_network_interface:
primary_ip IsShareMountTargetVirtualNetworkInterfacePrimaryIp

The primary IP address to bind to the virtual network interface. May be either a reserved IP identity, or a reserved IP prototype object which will be used to create a new reserved IP.

Nested scheme for primary_ip:

protocol_state_filtering_mode str

The protocol state filtering mode to use for this virtual network interface.

If auto, protocol state packet filtering is enabled or disabled based on the virtual network interface's target resource type: bare_metal_server_network_attachment: disabled instance_network_attachment: enabled share_mount_target: enabled

resource_group str
The ID of the resource group to use.
resource_type str
(String) The type of resource referenced.
security_groups Sequence[str]
The security groups to use for this virtual network interface.
subnet str
The associated subnet.
allowIpSpoofing Boolean
(Bool) Indicates whether source IP spoofing is allowed on this interface. If false, source IP spoofing is prevented on this interface. If true, source IP spoofing is allowed on this interface.
autoDelete Boolean
(Bool) Indicates whether this virtual network interface will be automatically deleted when target is deleted
crn String
CRN of this VNI
enableInfrastructureNat Boolean
(Bool) If true:- The VPC infrastructure performs any needed NAT operations.- floating_ips must not have more than one floating IP.If false:- Packets are passed unchanged to/from the network interface, allowing the workload to perform any needed NAT operations.- allow_ip_spoofing must be false.- If the virtual network interface is attached: - The target resource_type must be bare_metal_server_network_attachment. - The target interface_type must not be hipersocket.
href String
(String)The URL for this share target.
id String

The ID for virtual network interface. Mutually exclusive with other virtual_network_interface arguments.

Note id is mutually exclusive with other virtual_network_interface prototype arguments

name String
Name for this virtual network interface. The name must not be used by another virtual network interface in the VPC. Nested scheme for virtual_network_interface:
primaryIp Property Map

The primary IP address to bind to the virtual network interface. May be either a reserved IP identity, or a reserved IP prototype object which will be used to create a new reserved IP.

Nested scheme for primary_ip:

protocolStateFilteringMode String

The protocol state filtering mode to use for this virtual network interface.

If auto, protocol state packet filtering is enabled or disabled based on the virtual network interface's target resource type: bare_metal_server_network_attachment: disabled instance_network_attachment: enabled share_mount_target: enabled

resourceGroup String
The ID of the resource group to use.
resourceType String
(String) The type of resource referenced.
securityGroups List<String>
The security groups to use for this virtual network interface.
subnet String
The associated subnet.

IsShareMountTargetVirtualNetworkInterfacePrimaryIp
, IsShareMountTargetVirtualNetworkInterfacePrimaryIpArgs

Address string
The IP address to reserve. If unspecified, an available address on the subnet will automatically be selected.
AutoDelete bool
Indicates whether this reserved IP member will be automatically deleted when either target is deleted, or the reserved IP is unbound. Defaults to true
Href string
(String)The URL for this share target.
Name string
The name for this reserved IP. The name must not be used by another reserved IP in the subnet. Names starting with ibm- are reserved for provider-owned resources, and are not allowed.
ReservedIp string

The unique identifier for this reserved IP.

Note Within primary_ip, reserved_ip is mutually exclusive to auto_delete, address and name

ResourceType string
(String) The type of resource referenced.
Address string
The IP address to reserve. If unspecified, an available address on the subnet will automatically be selected.
AutoDelete bool
Indicates whether this reserved IP member will be automatically deleted when either target is deleted, or the reserved IP is unbound. Defaults to true
Href string
(String)The URL for this share target.
Name string
The name for this reserved IP. The name must not be used by another reserved IP in the subnet. Names starting with ibm- are reserved for provider-owned resources, and are not allowed.
ReservedIp string

The unique identifier for this reserved IP.

Note Within primary_ip, reserved_ip is mutually exclusive to auto_delete, address and name

ResourceType string
(String) The type of resource referenced.
address String
The IP address to reserve. If unspecified, an available address on the subnet will automatically be selected.
autoDelete Boolean
Indicates whether this reserved IP member will be automatically deleted when either target is deleted, or the reserved IP is unbound. Defaults to true
href String
(String)The URL for this share target.
name String
The name for this reserved IP. The name must not be used by another reserved IP in the subnet. Names starting with ibm- are reserved for provider-owned resources, and are not allowed.
reservedIp String

The unique identifier for this reserved IP.

Note Within primary_ip, reserved_ip is mutually exclusive to auto_delete, address and name

resourceType String
(String) The type of resource referenced.
address string
The IP address to reserve. If unspecified, an available address on the subnet will automatically be selected.
autoDelete boolean
Indicates whether this reserved IP member will be automatically deleted when either target is deleted, or the reserved IP is unbound. Defaults to true
href string
(String)The URL for this share target.
name string
The name for this reserved IP. The name must not be used by another reserved IP in the subnet. Names starting with ibm- are reserved for provider-owned resources, and are not allowed.
reservedIp string

The unique identifier for this reserved IP.

Note Within primary_ip, reserved_ip is mutually exclusive to auto_delete, address and name

resourceType string
(String) The type of resource referenced.
address str
The IP address to reserve. If unspecified, an available address on the subnet will automatically be selected.
auto_delete bool
Indicates whether this reserved IP member will be automatically deleted when either target is deleted, or the reserved IP is unbound. Defaults to true
href str
(String)The URL for this share target.
name str
The name for this reserved IP. The name must not be used by another reserved IP in the subnet. Names starting with ibm- are reserved for provider-owned resources, and are not allowed.
reserved_ip str

The unique identifier for this reserved IP.

Note Within primary_ip, reserved_ip is mutually exclusive to auto_delete, address and name

resource_type str
(String) The type of resource referenced.
address String
The IP address to reserve. If unspecified, an available address on the subnet will automatically be selected.
autoDelete Boolean
Indicates whether this reserved IP member will be automatically deleted when either target is deleted, or the reserved IP is unbound. Defaults to true
href String
(String)The URL for this share target.
name String
The name for this reserved IP. The name must not be used by another reserved IP in the subnet. Names starting with ibm- are reserved for provider-owned resources, and are not allowed.
reservedIp String

The unique identifier for this reserved IP.

Note Within primary_ip, reserved_ip is mutually exclusive to auto_delete, address and name

resourceType String
(String) The type of resource referenced.

IsShareOriginShare
, IsShareOriginShareArgs

Crn string
The CRN for this file share.
Deleteds List<IsShareOriginShareDeleted>
( List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
Href string
(String) The URL for this share snapshot.
Id string
The unique identifier for this file share.
Name string
The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
Remotes List<IsShareOriginShareRemote>
(Optional, List) If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable. Nested schema for remote:
ResourceType string
(String) The resource type.
Crn string
The CRN for this file share.
Deleteds []IsShareOriginShareDeleted
( List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
Href string
(String) The URL for this share snapshot.
Id string
The unique identifier for this file share.
Name string
The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
Remotes []IsShareOriginShareRemote
(Optional, List) If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable. Nested schema for remote:
ResourceType string
(String) The resource type.
crn String
The CRN for this file share.
deleteds List<IsShareOriginShareDeleted>
( List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
href String
(String) The URL for this share snapshot.
id String
The unique identifier for this file share.
name String
The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
remotes List<IsShareOriginShareRemote>
(Optional, List) If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable. Nested schema for remote:
resourceType String
(String) The resource type.
crn string
The CRN for this file share.
deleteds IsShareOriginShareDeleted[]
( List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
href string
(String) The URL for this share snapshot.
id string
The unique identifier for this file share.
name string
The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
remotes IsShareOriginShareRemote[]
(Optional, List) If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable. Nested schema for remote:
resourceType string
(String) The resource type.
crn str
The CRN for this file share.
deleteds Sequence[IsShareOriginShareDeleted]
( List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
href str
(String) The URL for this share snapshot.
id str
The unique identifier for this file share.
name str
The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
remotes Sequence[IsShareOriginShareRemote]
(Optional, List) If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable. Nested schema for remote:
resource_type str
(String) The resource type.
crn String
The CRN for this file share.
deleteds List<Property Map>
( List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
href String
(String) The URL for this share snapshot.
id String
The unique identifier for this file share.
name String
The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
remotes List<Property Map>
(Optional, List) If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable. Nested schema for remote:
resourceType String
(String) The resource type.

IsShareOriginShareDeleted
, IsShareOriginShareDeletedArgs

MoreInfo This property is required. string
(Computed, String) Link to documentation about deleted resources.
MoreInfo This property is required. string
(Computed, String) Link to documentation about deleted resources.
moreInfo This property is required. String
(Computed, String) Link to documentation about deleted resources.
moreInfo This property is required. string
(Computed, String) Link to documentation about deleted resources.
more_info This property is required. str
(Computed, String) Link to documentation about deleted resources.
moreInfo This property is required. String
(Computed, String) Link to documentation about deleted resources.

IsShareOriginShareRemote
, IsShareOriginShareRemoteArgs

Accounts This property is required. List<IsShareOriginShareRemoteAccount>
(Optional, List) If present, this property indicates that the referenced resource is remote to thisaccount, and identifies the owning account. Nested schema for account:
Regions This property is required. List<IsShareOriginShareRemoteRegion>
(Optional, List) If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region. Nested schema for region:
Accounts This property is required. []IsShareOriginShareRemoteAccount
(Optional, List) If present, this property indicates that the referenced resource is remote to thisaccount, and identifies the owning account. Nested schema for account:
Regions This property is required. []IsShareOriginShareRemoteRegion
(Optional, List) If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region. Nested schema for region:
accounts This property is required. List<IsShareOriginShareRemoteAccount>
(Optional, List) If present, this property indicates that the referenced resource is remote to thisaccount, and identifies the owning account. Nested schema for account:
regions This property is required. List<IsShareOriginShareRemoteRegion>
(Optional, List) If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region. Nested schema for region:
accounts This property is required. IsShareOriginShareRemoteAccount[]
(Optional, List) If present, this property indicates that the referenced resource is remote to thisaccount, and identifies the owning account. Nested schema for account:
regions This property is required. IsShareOriginShareRemoteRegion[]
(Optional, List) If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region. Nested schema for region:
accounts This property is required. Sequence[IsShareOriginShareRemoteAccount]
(Optional, List) If present, this property indicates that the referenced resource is remote to thisaccount, and identifies the owning account. Nested schema for account:
regions This property is required. Sequence[IsShareOriginShareRemoteRegion]
(Optional, List) If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region. Nested schema for region:
accounts This property is required. List<Property Map>
(Optional, List) If present, this property indicates that the referenced resource is remote to thisaccount, and identifies the owning account. Nested schema for account:
regions This property is required. List<Property Map>
(Optional, List) If present, this property indicates that the referenced resource is remote to thisregion, and identifies the native region. Nested schema for region:

IsShareOriginShareRemoteAccount
, IsShareOriginShareRemoteAccountArgs

Id This property is required. string
(String) The unique identifier for this share snapshot.
ResourceType This property is required. string
(String) The resource type.
Id This property is required. string
(String) The unique identifier for this share snapshot.
ResourceType This property is required. string
(String) The resource type.
id This property is required. String
(String) The unique identifier for this share snapshot.
resourceType This property is required. String
(String) The resource type.
id This property is required. string
(String) The unique identifier for this share snapshot.
resourceType This property is required. string
(String) The resource type.
id This property is required. str
(String) The unique identifier for this share snapshot.
resource_type This property is required. str
(String) The resource type.
id This property is required. String
(String) The unique identifier for this share snapshot.
resourceType This property is required. String
(String) The resource type.

IsShareOriginShareRemoteRegion
, IsShareOriginShareRemoteRegionArgs

Href This property is required. string
(String) The URL for this share snapshot.
Name This property is required. string
The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
Href This property is required. string
(String) The URL for this share snapshot.
Name This property is required. string
The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
href This property is required. String
(String) The URL for this share snapshot.
name This property is required. String
The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
href This property is required. string
(String) The URL for this share snapshot.
name This property is required. string
The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
href This property is required. str
(String) The URL for this share snapshot.
name This property is required. str
The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
href This property is required. String
(String) The URL for this share snapshot.
name This property is required. String
The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.

IsShareReplicaShare
, IsShareReplicaShareArgs

Name This property is required. string
The unique user-defined name for this file share.
Profile This property is required. string
Share profile name.
ReplicationCronSpec This property is required. string
The cron specification for the file share replication schedule.Replication of a share can be scheduled to occur at most once per hour.
Zone This property is required. string
The name of the zone this replica file share will reside in. Must be a different zone in the same region as the source share.
AccessTags List<string>
The list of access management tags to attach to the share. Note For more information, about creating access tags, see working with tags.
Crn string
(String) The CRN for this share snapshot.
Href string
(String) The URL for this share snapshot.
Id string
(String) The unique identifier for this share snapshot.
Iops double
The maximum input/output operation per second (IOPS) for the file share.
MountTargets List<IsShareReplicaShareMountTarget>
List of mount targets
ReplicationRole string
The replication role of the file share.
ReplicationStatus string
"The replication status of the file share.
ReplicationStatusReasons List<IsShareReplicaShareReplicationStatusReason>
The reasons for the current replication status (if any). Nested replication_status_reasons blocks have the following structure:
Tags List<string>
The list of user tags to attach to the share.
Name This property is required. string
The unique user-defined name for this file share.
Profile This property is required. string
Share profile name.
ReplicationCronSpec This property is required. string
The cron specification for the file share replication schedule.Replication of a share can be scheduled to occur at most once per hour.
Zone This property is required. string
The name of the zone this replica file share will reside in. Must be a different zone in the same region as the source share.
AccessTags []string
The list of access management tags to attach to the share. Note For more information, about creating access tags, see working with tags.
Crn string
(String) The CRN for this share snapshot.
Href string
(String) The URL for this share snapshot.
Id string
(String) The unique identifier for this share snapshot.
Iops float64
The maximum input/output operation per second (IOPS) for the file share.
MountTargets []IsShareReplicaShareMountTarget
List of mount targets
ReplicationRole string
The replication role of the file share.
ReplicationStatus string
"The replication status of the file share.
ReplicationStatusReasons []IsShareReplicaShareReplicationStatusReason
The reasons for the current replication status (if any). Nested replication_status_reasons blocks have the following structure:
Tags []string
The list of user tags to attach to the share.
name This property is required. String
The unique user-defined name for this file share.
profile This property is required. String
Share profile name.
replicationCronSpec This property is required. String
The cron specification for the file share replication schedule.Replication of a share can be scheduled to occur at most once per hour.
zone This property is required. String
The name of the zone this replica file share will reside in. Must be a different zone in the same region as the source share.
accessTags List<String>
The list of access management tags to attach to the share. Note For more information, about creating access tags, see working with tags.
crn String
(String) The CRN for this share snapshot.
href String
(String) The URL for this share snapshot.
id String
(String) The unique identifier for this share snapshot.
iops Double
The maximum input/output operation per second (IOPS) for the file share.
mountTargets List<IsShareReplicaShareMountTarget>
List of mount targets
replicationRole String
The replication role of the file share.
replicationStatus String
"The replication status of the file share.
replicationStatusReasons List<IsShareReplicaShareReplicationStatusReason>
The reasons for the current replication status (if any). Nested replication_status_reasons blocks have the following structure:
tags List<String>
The list of user tags to attach to the share.
name This property is required. string
The unique user-defined name for this file share.
profile This property is required. string
Share profile name.
replicationCronSpec This property is required. string
The cron specification for the file share replication schedule.Replication of a share can be scheduled to occur at most once per hour.
zone This property is required. string
The name of the zone this replica file share will reside in. Must be a different zone in the same region as the source share.
accessTags string[]
The list of access management tags to attach to the share. Note For more information, about creating access tags, see working with tags.
crn string
(String) The CRN for this share snapshot.
href string
(String) The URL for this share snapshot.
id string
(String) The unique identifier for this share snapshot.
iops number
The maximum input/output operation per second (IOPS) for the file share.
mountTargets IsShareReplicaShareMountTarget[]
List of mount targets
replicationRole string
The replication role of the file share.
replicationStatus string
"The replication status of the file share.
replicationStatusReasons IsShareReplicaShareReplicationStatusReason[]
The reasons for the current replication status (if any). Nested replication_status_reasons blocks have the following structure:
tags string[]
The list of user tags to attach to the share.
name This property is required. str
The unique user-defined name for this file share.
profile This property is required. str
Share profile name.
replication_cron_spec This property is required. str
The cron specification for the file share replication schedule.Replication of a share can be scheduled to occur at most once per hour.
zone This property is required. str
The name of the zone this replica file share will reside in. Must be a different zone in the same region as the source share.
access_tags Sequence[str]
The list of access management tags to attach to the share. Note For more information, about creating access tags, see working with tags.
crn str
(String) The CRN for this share snapshot.
href str
(String) The URL for this share snapshot.
id str
(String) The unique identifier for this share snapshot.
iops float
The maximum input/output operation per second (IOPS) for the file share.
mount_targets Sequence[IsShareReplicaShareMountTarget]
List of mount targets
replication_role str
The replication role of the file share.
replication_status str
"The replication status of the file share.
replication_status_reasons Sequence[IsShareReplicaShareReplicationStatusReason]
The reasons for the current replication status (if any). Nested replication_status_reasons blocks have the following structure:
tags Sequence[str]
The list of user tags to attach to the share.
name This property is required. String
The unique user-defined name for this file share.
profile This property is required. String
Share profile name.
replicationCronSpec This property is required. String
The cron specification for the file share replication schedule.Replication of a share can be scheduled to occur at most once per hour.
zone This property is required. String
The name of the zone this replica file share will reside in. Must be a different zone in the same region as the source share.
accessTags List<String>
The list of access management tags to attach to the share. Note For more information, about creating access tags, see working with tags.
crn String
(String) The CRN for this share snapshot.
href String
(String) The URL for this share snapshot.
id String
(String) The unique identifier for this share snapshot.
iops Number
The maximum input/output operation per second (IOPS) for the file share.
mountTargets List<Property Map>
List of mount targets
replicationRole String
The replication role of the file share.
replicationStatus String
"The replication status of the file share.
replicationStatusReasons List<Property Map>
The reasons for the current replication status (if any). Nested replication_status_reasons blocks have the following structure:
tags List<String>
The list of user tags to attach to the share.

IsShareReplicaShareMountTarget
, IsShareReplicaShareMountTargetArgs

Href string
(String) The URL for this share snapshot.
Id string
(String) The unique identifier for this share snapshot.
Name string
The user-defined name for this share target. Names must be unique within the share the share target resides in. If unspecified, the name will be a hyphenated list of randomly-selected words.
ResourceType string
(String) The resource type.
TransitEncryption string

The transit encryption mode for this share target. Supported values are none, user_managed. Default is none

Note transit_encryption can only be provided to create mount target for a share with access_control_mode security_group. It is not supported with shares that has access_control_mode vpc Note virtual_network_interface and vpc are mutually exclusive and one of them must be provided.

VirtualNetworkInterfaces List<IsShareReplicaShareMountTargetVirtualNetworkInterface>
The virtual network interface for this share mount target. Required if the share's access_control_mode is security_group. Nested scheme for virtual_network_interface:
Vpc string

The VPC in which instances can mount the file share using this share target. Required if the share's access_control_mode is vpc.

Note virtual_network_interface and vpc are mutually exclusive and one of them must be provided.

Href string
(String) The URL for this share snapshot.
Id string
(String) The unique identifier for this share snapshot.
Name string
The user-defined name for this share target. Names must be unique within the share the share target resides in. If unspecified, the name will be a hyphenated list of randomly-selected words.
ResourceType string
(String) The resource type.
TransitEncryption string

The transit encryption mode for this share target. Supported values are none, user_managed. Default is none

Note transit_encryption can only be provided to create mount target for a share with access_control_mode security_group. It is not supported with shares that has access_control_mode vpc Note virtual_network_interface and vpc are mutually exclusive and one of them must be provided.

VirtualNetworkInterfaces []IsShareReplicaShareMountTargetVirtualNetworkInterface
The virtual network interface for this share mount target. Required if the share's access_control_mode is security_group. Nested scheme for virtual_network_interface:
Vpc string

The VPC in which instances can mount the file share using this share target. Required if the share's access_control_mode is vpc.

Note virtual_network_interface and vpc are mutually exclusive and one of them must be provided.

href String
(String) The URL for this share snapshot.
id String
(String) The unique identifier for this share snapshot.
name String
The user-defined name for this share target. Names must be unique within the share the share target resides in. If unspecified, the name will be a hyphenated list of randomly-selected words.
resourceType String
(String) The resource type.
transitEncryption String

The transit encryption mode for this share target. Supported values are none, user_managed. Default is none

Note transit_encryption can only be provided to create mount target for a share with access_control_mode security_group. It is not supported with shares that has access_control_mode vpc Note virtual_network_interface and vpc are mutually exclusive and one of them must be provided.

virtualNetworkInterfaces List<IsShareReplicaShareMountTargetVirtualNetworkInterface>
The virtual network interface for this share mount target. Required if the share's access_control_mode is security_group. Nested scheme for virtual_network_interface:
vpc String

The VPC in which instances can mount the file share using this share target. Required if the share's access_control_mode is vpc.

Note virtual_network_interface and vpc are mutually exclusive and one of them must be provided.

href string
(String) The URL for this share snapshot.
id string
(String) The unique identifier for this share snapshot.
name string
The user-defined name for this share target. Names must be unique within the share the share target resides in. If unspecified, the name will be a hyphenated list of randomly-selected words.
resourceType string
(String) The resource type.
transitEncryption string

The transit encryption mode for this share target. Supported values are none, user_managed. Default is none

Note transit_encryption can only be provided to create mount target for a share with access_control_mode security_group. It is not supported with shares that has access_control_mode vpc Note virtual_network_interface and vpc are mutually exclusive and one of them must be provided.

virtualNetworkInterfaces IsShareReplicaShareMountTargetVirtualNetworkInterface[]
The virtual network interface for this share mount target. Required if the share's access_control_mode is security_group. Nested scheme for virtual_network_interface:
vpc string

The VPC in which instances can mount the file share using this share target. Required if the share's access_control_mode is vpc.

Note virtual_network_interface and vpc are mutually exclusive and one of them must be provided.

href str
(String) The URL for this share snapshot.
id str
(String) The unique identifier for this share snapshot.
name str
The user-defined name for this share target. Names must be unique within the share the share target resides in. If unspecified, the name will be a hyphenated list of randomly-selected words.
resource_type str
(String) The resource type.
transit_encryption str

The transit encryption mode for this share target. Supported values are none, user_managed. Default is none

Note transit_encryption can only be provided to create mount target for a share with access_control_mode security_group. It is not supported with shares that has access_control_mode vpc Note virtual_network_interface and vpc are mutually exclusive and one of them must be provided.

virtual_network_interfaces Sequence[IsShareReplicaShareMountTargetVirtualNetworkInterface]
The virtual network interface for this share mount target. Required if the share's access_control_mode is security_group. Nested scheme for virtual_network_interface:
vpc str

The VPC in which instances can mount the file share using this share target. Required if the share's access_control_mode is vpc.

Note virtual_network_interface and vpc are mutually exclusive and one of them must be provided.

href String
(String) The URL for this share snapshot.
id String
(String) The unique identifier for this share snapshot.
name String
The user-defined name for this share target. Names must be unique within the share the share target resides in. If unspecified, the name will be a hyphenated list of randomly-selected words.
resourceType String
(String) The resource type.
transitEncryption String

The transit encryption mode for this share target. Supported values are none, user_managed. Default is none

Note transit_encryption can only be provided to create mount target for a share with access_control_mode security_group. It is not supported with shares that has access_control_mode vpc Note virtual_network_interface and vpc are mutually exclusive and one of them must be provided.

virtualNetworkInterfaces List<Property Map>
The virtual network interface for this share mount target. Required if the share's access_control_mode is security_group. Nested scheme for virtual_network_interface:
vpc String

The VPC in which instances can mount the file share using this share target. Required if the share's access_control_mode is vpc.

Note virtual_network_interface and vpc are mutually exclusive and one of them must be provided.

IsShareReplicaShareMountTargetVirtualNetworkInterface
, IsShareReplicaShareMountTargetVirtualNetworkInterfaceArgs

AllowIpSpoofing bool
Indicates whether source IP spoofing is allowed on this interface. If false, source IP spoofing is prevented on this interface. If true, source IP spoofing is allowed on this interface.
AutoDelete bool
Indicates whether this virtual network interface will be automatically deleted when target is deleted
Crn string
(String) The CRN for this share snapshot.
EnableInfrastructureNat bool
If true:- The VPC infrastructure performs any needed NAT operations.- floating_ips must not have more than one floating IP.If false:- Packets are passed unchanged to/from the network interface, allowing the workload to perform any needed NAT operations.- allow_ip_spoofing must be false.- If the virtual network interface is attached: - The target resource_type must be bare_metal_server_network_attachment. - The target interface_type must not be hipersocket.
Href string
(String) The URL for this share snapshot.
Id string

The ID for virtual network interface. Mutually exclusive with other virtual_network_interface arguments.

Note id is mutually exclusive with other virtual_network_interface prototype arguments

Name string
Name for this virtual network interface. The name must not be used by another virtual network interface in the VPC.
PrimaryIps List<IsShareReplicaShareMountTargetVirtualNetworkInterfacePrimaryIp>
The primary IP address to bind to the virtual network interface. May be either a reserved IP identity, or a reserved IP prototype object which will be used to create a new reserved IP. Nested scheme for primary_ip:
ProtocolStateFilteringMode string

The protocol state filtering mode to use for this virtual network interface.

If auto, protocol state packet filtering is enabled or disabled based on the virtual network interface's target resource type: bare_metal_server_network_attachment: disabled instance_network_attachment: enabled share_mount_target: enabled

ResourceGroup string
The ID of the resource group to use.
ResourceType string
(String) The resource type.
SecurityGroups List<string>
The security groups to use for this virtual network interface.
Subnet string

The associated subnet.

Note Within primary_ip, reserved_ip is mutually exclusive to auto_delete, address and name

AllowIpSpoofing bool
Indicates whether source IP spoofing is allowed on this interface. If false, source IP spoofing is prevented on this interface. If true, source IP spoofing is allowed on this interface.
AutoDelete bool
Indicates whether this virtual network interface will be automatically deleted when target is deleted
Crn string
(String) The CRN for this share snapshot.
EnableInfrastructureNat bool
If true:- The VPC infrastructure performs any needed NAT operations.- floating_ips must not have more than one floating IP.If false:- Packets are passed unchanged to/from the network interface, allowing the workload to perform any needed NAT operations.- allow_ip_spoofing must be false.- If the virtual network interface is attached: - The target resource_type must be bare_metal_server_network_attachment. - The target interface_type must not be hipersocket.
Href string
(String) The URL for this share snapshot.
Id string

The ID for virtual network interface. Mutually exclusive with other virtual_network_interface arguments.

Note id is mutually exclusive with other virtual_network_interface prototype arguments

Name string
Name for this virtual network interface. The name must not be used by another virtual network interface in the VPC.
PrimaryIps []IsShareReplicaShareMountTargetVirtualNetworkInterfacePrimaryIp
The primary IP address to bind to the virtual network interface. May be either a reserved IP identity, or a reserved IP prototype object which will be used to create a new reserved IP. Nested scheme for primary_ip:
ProtocolStateFilteringMode string

The protocol state filtering mode to use for this virtual network interface.

If auto, protocol state packet filtering is enabled or disabled based on the virtual network interface's target resource type: bare_metal_server_network_attachment: disabled instance_network_attachment: enabled share_mount_target: enabled

ResourceGroup string
The ID of the resource group to use.
ResourceType string
(String) The resource type.
SecurityGroups []string
The security groups to use for this virtual network interface.
Subnet string

The associated subnet.

Note Within primary_ip, reserved_ip is mutually exclusive to auto_delete, address and name

allowIpSpoofing Boolean
Indicates whether source IP spoofing is allowed on this interface. If false, source IP spoofing is prevented on this interface. If true, source IP spoofing is allowed on this interface.
autoDelete Boolean
Indicates whether this virtual network interface will be automatically deleted when target is deleted
crn String
(String) The CRN for this share snapshot.
enableInfrastructureNat Boolean
If true:- The VPC infrastructure performs any needed NAT operations.- floating_ips must not have more than one floating IP.If false:- Packets are passed unchanged to/from the network interface, allowing the workload to perform any needed NAT operations.- allow_ip_spoofing must be false.- If the virtual network interface is attached: - The target resource_type must be bare_metal_server_network_attachment. - The target interface_type must not be hipersocket.
href String
(String) The URL for this share snapshot.
id String

The ID for virtual network interface. Mutually exclusive with other virtual_network_interface arguments.

Note id is mutually exclusive with other virtual_network_interface prototype arguments

name String
Name for this virtual network interface. The name must not be used by another virtual network interface in the VPC.
primaryIps List<IsShareReplicaShareMountTargetVirtualNetworkInterfacePrimaryIp>
The primary IP address to bind to the virtual network interface. May be either a reserved IP identity, or a reserved IP prototype object which will be used to create a new reserved IP. Nested scheme for primary_ip:
protocolStateFilteringMode String

The protocol state filtering mode to use for this virtual network interface.

If auto, protocol state packet filtering is enabled or disabled based on the virtual network interface's target resource type: bare_metal_server_network_attachment: disabled instance_network_attachment: enabled share_mount_target: enabled

resourceGroup String
The ID of the resource group to use.
resourceType String
(String) The resource type.
securityGroups List<String>
The security groups to use for this virtual network interface.
subnet String

The associated subnet.

Note Within primary_ip, reserved_ip is mutually exclusive to auto_delete, address and name

allowIpSpoofing boolean
Indicates whether source IP spoofing is allowed on this interface. If false, source IP spoofing is prevented on this interface. If true, source IP spoofing is allowed on this interface.
autoDelete boolean
Indicates whether this virtual network interface will be automatically deleted when target is deleted
crn string
(String) The CRN for this share snapshot.
enableInfrastructureNat boolean
If true:- The VPC infrastructure performs any needed NAT operations.- floating_ips must not have more than one floating IP.If false:- Packets are passed unchanged to/from the network interface, allowing the workload to perform any needed NAT operations.- allow_ip_spoofing must be false.- If the virtual network interface is attached: - The target resource_type must be bare_metal_server_network_attachment. - The target interface_type must not be hipersocket.
href string
(String) The URL for this share snapshot.
id string

The ID for virtual network interface. Mutually exclusive with other virtual_network_interface arguments.

Note id is mutually exclusive with other virtual_network_interface prototype arguments

name string
Name for this virtual network interface. The name must not be used by another virtual network interface in the VPC.
primaryIps IsShareReplicaShareMountTargetVirtualNetworkInterfacePrimaryIp[]
The primary IP address to bind to the virtual network interface. May be either a reserved IP identity, or a reserved IP prototype object which will be used to create a new reserved IP. Nested scheme for primary_ip:
protocolStateFilteringMode string

The protocol state filtering mode to use for this virtual network interface.

If auto, protocol state packet filtering is enabled or disabled based on the virtual network interface's target resource type: bare_metal_server_network_attachment: disabled instance_network_attachment: enabled share_mount_target: enabled

resourceGroup string
The ID of the resource group to use.
resourceType string
(String) The resource type.
securityGroups string[]
The security groups to use for this virtual network interface.
subnet string

The associated subnet.

Note Within primary_ip, reserved_ip is mutually exclusive to auto_delete, address and name

allow_ip_spoofing bool
Indicates whether source IP spoofing is allowed on this interface. If false, source IP spoofing is prevented on this interface. If true, source IP spoofing is allowed on this interface.
auto_delete bool
Indicates whether this virtual network interface will be automatically deleted when target is deleted
crn str
(String) The CRN for this share snapshot.
enable_infrastructure_nat bool
If true:- The VPC infrastructure performs any needed NAT operations.- floating_ips must not have more than one floating IP.If false:- Packets are passed unchanged to/from the network interface, allowing the workload to perform any needed NAT operations.- allow_ip_spoofing must be false.- If the virtual network interface is attached: - The target resource_type must be bare_metal_server_network_attachment. - The target interface_type must not be hipersocket.
href str
(String) The URL for this share snapshot.
id str

The ID for virtual network interface. Mutually exclusive with other virtual_network_interface arguments.

Note id is mutually exclusive with other virtual_network_interface prototype arguments

name str
Name for this virtual network interface. The name must not be used by another virtual network interface in the VPC.
primary_ips Sequence[IsShareReplicaShareMountTargetVirtualNetworkInterfacePrimaryIp]
The primary IP address to bind to the virtual network interface. May be either a reserved IP identity, or a reserved IP prototype object which will be used to create a new reserved IP. Nested scheme for primary_ip:
protocol_state_filtering_mode str

The protocol state filtering mode to use for this virtual network interface.

If auto, protocol state packet filtering is enabled or disabled based on the virtual network interface's target resource type: bare_metal_server_network_attachment: disabled instance_network_attachment: enabled share_mount_target: enabled

resource_group str
The ID of the resource group to use.
resource_type str
(String) The resource type.
security_groups Sequence[str]
The security groups to use for this virtual network interface.
subnet str

The associated subnet.

Note Within primary_ip, reserved_ip is mutually exclusive to auto_delete, address and name

allowIpSpoofing Boolean
Indicates whether source IP spoofing is allowed on this interface. If false, source IP spoofing is prevented on this interface. If true, source IP spoofing is allowed on this interface.
autoDelete Boolean
Indicates whether this virtual network interface will be automatically deleted when target is deleted
crn String
(String) The CRN for this share snapshot.
enableInfrastructureNat Boolean
If true:- The VPC infrastructure performs any needed NAT operations.- floating_ips must not have more than one floating IP.If false:- Packets are passed unchanged to/from the network interface, allowing the workload to perform any needed NAT operations.- allow_ip_spoofing must be false.- If the virtual network interface is attached: - The target resource_type must be bare_metal_server_network_attachment. - The target interface_type must not be hipersocket.
href String
(String) The URL for this share snapshot.
id String

The ID for virtual network interface. Mutually exclusive with other virtual_network_interface arguments.

Note id is mutually exclusive with other virtual_network_interface prototype arguments

name String
Name for this virtual network interface. The name must not be used by another virtual network interface in the VPC.
primaryIps List<Property Map>
The primary IP address to bind to the virtual network interface. May be either a reserved IP identity, or a reserved IP prototype object which will be used to create a new reserved IP. Nested scheme for primary_ip:
protocolStateFilteringMode String

The protocol state filtering mode to use for this virtual network interface.

If auto, protocol state packet filtering is enabled or disabled based on the virtual network interface's target resource type: bare_metal_server_network_attachment: disabled instance_network_attachment: enabled share_mount_target: enabled

resourceGroup String
The ID of the resource group to use.
resourceType String
(String) The resource type.
securityGroups List<String>
The security groups to use for this virtual network interface.
subnet String

The associated subnet.

Note Within primary_ip, reserved_ip is mutually exclusive to auto_delete, address and name

IsShareReplicaShareMountTargetVirtualNetworkInterfacePrimaryIp
, IsShareReplicaShareMountTargetVirtualNetworkInterfacePrimaryIpArgs

Address string
The IP address to reserve. If unspecified, an available address on the subnet will automatically be selected.
AutoDelete bool
Indicates whether this reserved IP member will be automatically deleted when either target is deleted, or the reserved IP is unbound. Defaults to true
Href string
(String) The URL for this share snapshot.
Name string
The name for this reserved IP. The name must not be used by another reserved IP in the subnet. Names starting with ibm- are reserved for provider-owned resources, and are not allowed.
ReservedIp string
The unique identifier for this reserved IP
ResourceType string
(String) The resource type.
Address string
The IP address to reserve. If unspecified, an available address on the subnet will automatically be selected.
AutoDelete bool
Indicates whether this reserved IP member will be automatically deleted when either target is deleted, or the reserved IP is unbound. Defaults to true
Href string
(String) The URL for this share snapshot.
Name string
The name for this reserved IP. The name must not be used by another reserved IP in the subnet. Names starting with ibm- are reserved for provider-owned resources, and are not allowed.
ReservedIp string
The unique identifier for this reserved IP
ResourceType string
(String) The resource type.
address String
The IP address to reserve. If unspecified, an available address on the subnet will automatically be selected.
autoDelete Boolean
Indicates whether this reserved IP member will be automatically deleted when either target is deleted, or the reserved IP is unbound. Defaults to true
href String
(String) The URL for this share snapshot.
name String
The name for this reserved IP. The name must not be used by another reserved IP in the subnet. Names starting with ibm- are reserved for provider-owned resources, and are not allowed.
reservedIp String
The unique identifier for this reserved IP
resourceType String
(String) The resource type.
address string
The IP address to reserve. If unspecified, an available address on the subnet will automatically be selected.
autoDelete boolean
Indicates whether this reserved IP member will be automatically deleted when either target is deleted, or the reserved IP is unbound. Defaults to true
href string
(String) The URL for this share snapshot.
name string
The name for this reserved IP. The name must not be used by another reserved IP in the subnet. Names starting with ibm- are reserved for provider-owned resources, and are not allowed.
reservedIp string
The unique identifier for this reserved IP
resourceType string
(String) The resource type.
address str
The IP address to reserve. If unspecified, an available address on the subnet will automatically be selected.
auto_delete bool
Indicates whether this reserved IP member will be automatically deleted when either target is deleted, or the reserved IP is unbound. Defaults to true
href str
(String) The URL for this share snapshot.
name str
The name for this reserved IP. The name must not be used by another reserved IP in the subnet. Names starting with ibm- are reserved for provider-owned resources, and are not allowed.
reserved_ip str
The unique identifier for this reserved IP
resource_type str
(String) The resource type.
address String
The IP address to reserve. If unspecified, an available address on the subnet will automatically be selected.
autoDelete Boolean
Indicates whether this reserved IP member will be automatically deleted when either target is deleted, or the reserved IP is unbound. Defaults to true
href String
(String) The URL for this share snapshot.
name String
The name for this reserved IP. The name must not be used by another reserved IP in the subnet. Names starting with ibm- are reserved for provider-owned resources, and are not allowed.
reservedIp String
The unique identifier for this reserved IP
resourceType String
(String) The resource type.

IsShareReplicaShareReplicationStatusReason
, IsShareReplicaShareReplicationStatusReasonArgs

Code This property is required. string
A snake case string succinctly identifying the status reason.
Message This property is required. string
An explanation of the status reason.
MoreInfo This property is required. string
(Computed, String) Link to documentation about deleted resources.
Code This property is required. string
A snake case string succinctly identifying the status reason.
Message This property is required. string
An explanation of the status reason.
MoreInfo This property is required. string
(Computed, String) Link to documentation about deleted resources.
code This property is required. String
A snake case string succinctly identifying the status reason.
message This property is required. String
An explanation of the status reason.
moreInfo This property is required. String
(Computed, String) Link to documentation about deleted resources.
code This property is required. string
A snake case string succinctly identifying the status reason.
message This property is required. string
An explanation of the status reason.
moreInfo This property is required. string
(Computed, String) Link to documentation about deleted resources.
code This property is required. str
A snake case string succinctly identifying the status reason.
message This property is required. str
An explanation of the status reason.
more_info This property is required. str
(Computed, String) Link to documentation about deleted resources.
code This property is required. String
A snake case string succinctly identifying the status reason.
message This property is required. String
An explanation of the status reason.
moreInfo This property is required. String
(Computed, String) Link to documentation about deleted resources.

IsShareReplicationStatusReason
, IsShareReplicationStatusReasonArgs

Code This property is required. string
A snake case string succinctly identifying the status reason.
Message This property is required. string
An explanation of the status reason.
MoreInfo This property is required. string
(Computed, String) Link to documentation about deleted resources.
Code This property is required. string
A snake case string succinctly identifying the status reason.
Message This property is required. string
An explanation of the status reason.
MoreInfo This property is required. string
(Computed, String) Link to documentation about deleted resources.
code This property is required. String
A snake case string succinctly identifying the status reason.
message This property is required. String
An explanation of the status reason.
moreInfo This property is required. String
(Computed, String) Link to documentation about deleted resources.
code This property is required. string
A snake case string succinctly identifying the status reason.
message This property is required. string
An explanation of the status reason.
moreInfo This property is required. string
(Computed, String) Link to documentation about deleted resources.
code This property is required. str
A snake case string succinctly identifying the status reason.
message This property is required. str
An explanation of the status reason.
more_info This property is required. str
(Computed, String) Link to documentation about deleted resources.
code This property is required. String
A snake case string succinctly identifying the status reason.
message This property is required. String
An explanation of the status reason.
moreInfo This property is required. String
(Computed, String) Link to documentation about deleted resources.

IsShareSourceSnapshot
, IsShareSourceSnapshotArgs

Crn string
The CRN for this share snapshot.
Deleteds List<IsShareSourceSnapshotDeleted>
( List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
Href string
(String) The URL for this share snapshot.
Id string

The unique identifier for this share snapshot.

NOTE crn and id are mutually exclusive for source_snapshot

NOTE source_snapshot is mutually exclusive with zone, source_share_crn, source_share, origin_share

Name string
The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
ResourceType string
(String) The resource type.
Crn string
The CRN for this share snapshot.
Deleteds []IsShareSourceSnapshotDeleted
( List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
Href string
(String) The URL for this share snapshot.
Id string

The unique identifier for this share snapshot.

NOTE crn and id are mutually exclusive for source_snapshot

NOTE source_snapshot is mutually exclusive with zone, source_share_crn, source_share, origin_share

Name string
The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
ResourceType string
(String) The resource type.
crn String
The CRN for this share snapshot.
deleteds List<IsShareSourceSnapshotDeleted>
( List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
href String
(String) The URL for this share snapshot.
id String

The unique identifier for this share snapshot.

NOTE crn and id are mutually exclusive for source_snapshot

NOTE source_snapshot is mutually exclusive with zone, source_share_crn, source_share, origin_share

name String
The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
resourceType String
(String) The resource type.
crn string
The CRN for this share snapshot.
deleteds IsShareSourceSnapshotDeleted[]
( List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
href string
(String) The URL for this share snapshot.
id string

The unique identifier for this share snapshot.

NOTE crn and id are mutually exclusive for source_snapshot

NOTE source_snapshot is mutually exclusive with zone, source_share_crn, source_share, origin_share

name string
The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
resourceType string
(String) The resource type.
crn str
The CRN for this share snapshot.
deleteds Sequence[IsShareSourceSnapshotDeleted]
( List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
href str
(String) The URL for this share snapshot.
id str

The unique identifier for this share snapshot.

NOTE crn and id are mutually exclusive for source_snapshot

NOTE source_snapshot is mutually exclusive with zone, source_share_crn, source_share, origin_share

name str
The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
resource_type str
(String) The resource type.
crn String
The CRN for this share snapshot.
deleteds List<Property Map>
( List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information. Nested schema for deleted:
href String
(String) The URL for this share snapshot.
id String

The unique identifier for this share snapshot.

NOTE crn and id are mutually exclusive for source_snapshot

NOTE source_snapshot is mutually exclusive with zone, source_share_crn, source_share, origin_share

name String
The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
resourceType String
(String) The resource type.

IsShareSourceSnapshotDeleted
, IsShareSourceSnapshotDeletedArgs

MoreInfo This property is required. string
(Computed, String) Link to documentation about deleted resources.
MoreInfo This property is required. string
(Computed, String) Link to documentation about deleted resources.
moreInfo This property is required. String
(Computed, String) Link to documentation about deleted resources.
moreInfo This property is required. string
(Computed, String) Link to documentation about deleted resources.
more_info This property is required. str
(Computed, String) Link to documentation about deleted resources.
moreInfo This property is required. String
(Computed, String) Link to documentation about deleted resources.

Import

The ibm_is_share can be imported using ID.

Syntax

$ pulumi import ibm:index/isShare:IsShare example <id>
Copy

Example

$ pulumi import ibm:index/isShare:IsShare example d7bec597-4726-451f-8a63-e62e6f19c32c
Copy

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

Package Details

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