ibm.IsShare
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_access_protocols: Optional[Sequence[str]] = None,
allowed_transit_encryption_modes: Optional[Sequence[str]] = None,
bandwidth: Optional[float] = 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 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 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 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 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 String
- The unique name of the resource.
- args 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",
},
AllowedAccessProtocols = new[]
{
"string",
},
AllowedTransitEncryptionModes = new[]
{
"string",
},
Bandwidth = 0,
EncryptionKey = "string",
InitialOwner = new Ibm.Inputs.IsShareInitialOwnerArgs
{
Gid = 0,
Uid = 0,
},
Iops = 0,
IsShareId = "string",
MountTargets = new[]
{
new Ibm.Inputs.IsShareMountTargetArgs
{
Name = "string",
AccessProtocol = "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",
ReplicationCronSpec = "string",
Profile = "string",
Id = "string",
Iops = 0,
MountTargets = new[]
{
new Ibm.Inputs.IsShareReplicaShareMountTargetArgs
{
AccessProtocol = "string",
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",
},
},
AccessTags = new[]
{
"string",
},
Href = "string",
Crn = "string",
ReplicationRole = "string",
ReplicationStatus = "string",
ReplicationStatusReasons = new[]
{
new Ibm.Inputs.IsShareReplicaShareReplicationStatusReasonArgs
{
Code = "string",
Message = "string",
MoreInfo = "string",
},
},
Tags = new[]
{
"string",
},
Zone = "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",
});
example, err := ibm.NewIsShare(ctx, "isShareResource", &ibm.IsShareArgs{
AccessControlMode: pulumi.String("string"),
AccessTags: pulumi.StringArray{
pulumi.String("string"),
},
AllowedAccessProtocols: pulumi.StringArray{
pulumi.String("string"),
},
AllowedTransitEncryptionModes: pulumi.StringArray{
pulumi.String("string"),
},
Bandwidth: pulumi.Float64(0),
EncryptionKey: pulumi.String("string"),
InitialOwner: &ibm.IsShareInitialOwnerArgs{
Gid: pulumi.Float64(0),
Uid: pulumi.Float64(0),
},
Iops: pulumi.Float64(0),
IsShareId: pulumi.String("string"),
MountTargets: ibm.IsShareMountTargetTypeArray{
&ibm.IsShareMountTargetTypeArgs{
Name: pulumi.String("string"),
AccessProtocol: pulumi.String("string"),
Href: pulumi.String("string"),
Id: pulumi.String("string"),
ResourceType: pulumi.String("string"),
TransitEncryption: pulumi.String("string"),
VirtualNetworkInterfaces: ibm.IsShareMountTargetVirtualNetworkInterfaceArray{
&ibm.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: &ibm.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: &ibm.IsShareOriginShareArgs{
Crn: pulumi.String("string"),
Deleteds: ibm.IsShareOriginShareDeletedArray{
&ibm.IsShareOriginShareDeletedArgs{
MoreInfo: pulumi.String("string"),
},
},
Href: pulumi.String("string"),
Id: pulumi.String("string"),
Name: pulumi.String("string"),
Remotes: ibm.IsShareOriginShareRemoteArray{
&ibm.IsShareOriginShareRemoteArgs{
Accounts: ibm.IsShareOriginShareRemoteAccountArray{
&ibm.IsShareOriginShareRemoteAccountArgs{
Id: pulumi.String("string"),
ResourceType: pulumi.String("string"),
},
},
Regions: ibm.IsShareOriginShareRemoteRegionArray{
&ibm.IsShareOriginShareRemoteRegionArgs{
Href: pulumi.String("string"),
Name: pulumi.String("string"),
},
},
},
},
ResourceType: pulumi.String("string"),
},
Profile: pulumi.String("string"),
ReplicaShare: &ibm.IsShareReplicaShareArgs{
Name: pulumi.String("string"),
ReplicationCronSpec: pulumi.String("string"),
Profile: pulumi.String("string"),
Id: pulumi.String("string"),
Iops: pulumi.Float64(0),
MountTargets: ibm.IsShareReplicaShareMountTargetArray{
&ibm.IsShareReplicaShareMountTargetArgs{
AccessProtocol: pulumi.String("string"),
Href: pulumi.String("string"),
Id: pulumi.String("string"),
Name: pulumi.String("string"),
ResourceType: pulumi.String("string"),
TransitEncryption: pulumi.String("string"),
VirtualNetworkInterfaces: ibm.IsShareReplicaShareMountTargetVirtualNetworkInterfaceArray{
&ibm.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: ibm.IsShareReplicaShareMountTargetVirtualNetworkInterfacePrimaryIpArray{
&ibm.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"),
},
},
AccessTags: pulumi.StringArray{
pulumi.String("string"),
},
Href: pulumi.String("string"),
Crn: pulumi.String("string"),
ReplicationRole: pulumi.String("string"),
ReplicationStatus: pulumi.String("string"),
ReplicationStatusReasons: ibm.IsShareReplicaShareReplicationStatusReasonArray{
&ibm.IsShareReplicaShareReplicationStatusReasonArgs{
Code: pulumi.String("string"),
Message: pulumi.String("string"),
MoreInfo: pulumi.String("string"),
},
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
Zone: pulumi.String("string"),
},
ReplicationCronSpec: pulumi.String("string"),
ResourceGroup: pulumi.String("string"),
Size: pulumi.Float64(0),
SourceShare: pulumi.String("string"),
SourceShareCrn: pulumi.String("string"),
SourceSnapshot: &ibm.IsShareSourceSnapshotArgs{
Crn: pulumi.String("string"),
Deleteds: ibm.IsShareSourceSnapshotDeletedArray{
&ibm.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"),
})
var isShareResource = new IsShare("isShareResource", IsShareArgs.builder()
.accessControlMode("string")
.accessTags("string")
.allowedAccessProtocols("string")
.allowedTransitEncryptionModes("string")
.bandwidth(0.0)
.encryptionKey("string")
.initialOwner(IsShareInitialOwnerArgs.builder()
.gid(0.0)
.uid(0.0)
.build())
.iops(0.0)
.isShareId("string")
.mountTargets(IsShareMountTargetArgs.builder()
.name("string")
.accessProtocol("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")
.replicationCronSpec("string")
.profile("string")
.id("string")
.iops(0.0)
.mountTargets(IsShareReplicaShareMountTargetArgs.builder()
.accessProtocol("string")
.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())
.accessTags("string")
.href("string")
.crn("string")
.replicationRole("string")
.replicationStatus("string")
.replicationStatusReasons(IsShareReplicaShareReplicationStatusReasonArgs.builder()
.code("string")
.message("string")
.moreInfo("string")
.build())
.tags("string")
.zone("string")
.build())
.replicationCronSpec("string")
.resourceGroup("string")
.size(0.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());
is_share_resource = ibm.IsShare("isShareResource",
access_control_mode="string",
access_tags=["string"],
allowed_access_protocols=["string"],
allowed_transit_encryption_modes=["string"],
bandwidth=0,
encryption_key="string",
initial_owner={
"gid": 0,
"uid": 0,
},
iops=0,
is_share_id="string",
mount_targets=[{
"name": "string",
"access_protocol": "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",
"replication_cron_spec": "string",
"profile": "string",
"id": "string",
"iops": 0,
"mount_targets": [{
"access_protocol": "string",
"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",
}],
"access_tags": ["string"],
"href": "string",
"crn": "string",
"replication_role": "string",
"replication_status": "string",
"replication_status_reasons": [{
"code": "string",
"message": "string",
"more_info": "string",
}],
"tags": ["string"],
"zone": "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")
const isShareResource = new ibm.IsShare("isShareResource", {
accessControlMode: "string",
accessTags: ["string"],
allowedAccessProtocols: ["string"],
allowedTransitEncryptionModes: ["string"],
bandwidth: 0,
encryptionKey: "string",
initialOwner: {
gid: 0,
uid: 0,
},
iops: 0,
isShareId: "string",
mountTargets: [{
name: "string",
accessProtocol: "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",
replicationCronSpec: "string",
profile: "string",
id: "string",
iops: 0,
mountTargets: [{
accessProtocol: "string",
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",
}],
accessTags: ["string"],
href: "string",
crn: "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",
});
type: ibm:IsShare
properties:
accessControlMode: string
accessTags:
- string
allowedAccessProtocols:
- string
allowedTransitEncryptionModes:
- string
bandwidth: 0
encryptionKey: string
initialOwner:
gid: 0
uid: 0
iops: 0
isShareId: string
mountTargets:
- accessProtocol: string
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:
- accessProtocol: string
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
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:
- Access
Control stringMode - The access control mode for the share:
- List<string>
- List of access management tags
- Allowed
Access List<string>Protocols - The access protocols to allow for this share
- Allowed
Transit List<string>Encryption Modes - Allowed transit encryption modes
- Bandwidth double
- The bandwidth for the file share.
- Encryption
Key string - The CRN of the key to use for encrypting this file share.If no encryption key is provided, the share will not be encrypted.
- Initial
Owner IsShare Initial Owner - The owner assigned to the file share at creation.
- Iops double
- The maximum input/output operation performance bandwidth per second for the file share.
- string
- Mount
Targets List<IsShare Mount Target> - The share targets for this file share.Share targets mounted from a replica must be mounted read-only.
- Name string
- The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
-
Is
Share Origin Share - The origin share this accessor share is referring to.This property will be present when the
accessor_binding_roleisaccessor. - Profile string
- The globally unique name for this share profile.
-
Is
Share Replica Share - Configuration for a replica file share to create and associate with this file share. Ifunspecified, a replica may be
subsequently added by creating a new file share with a
source_sharereferencing this file share. - Replication
Cron stringSpec - The cron specification for the file share replication schedule.Replication of a share can be scheduled to occur at most once per hour.
- Resource
Group string - The unique identifier of the resource group to use. If unspecified, the account's default resourcegroup is used.
- Size double
- The size of the file share rounded up to the next gigabyte.
- 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.
- string
- The CRN 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
Snapshot IsShare Source Snapshot - 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.
- List<string>
- User Tags for the file share
- Zone string
- The globally unique name of the zone this file share will reside in.
- Access
Control stringMode - The access control mode for the share:
- []string
- List of access management tags
- Allowed
Access []stringProtocols - The access protocols to allow for this share
- Allowed
Transit []stringEncryption Modes - Allowed transit encryption modes
- Bandwidth float64
- The bandwidth for the file share.
- Encryption
Key string - The CRN of the key to use for encrypting this file share.If no encryption key is provided, the share will not be encrypted.
- Initial
Owner IsShare Initial Owner Args - The owner assigned to the file share at creation.
- Iops float64
- The maximum input/output operation performance bandwidth per second for the file share.
- string
- Mount
Targets []IsShare Mount Target Type Args - The share targets for this file share.Share targets mounted from a replica must be mounted read-only.
- Name string
- The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
-
Is
Share Origin Share Args - The origin share this accessor share is referring to.This property will be present when the
accessor_binding_roleisaccessor. - Profile string
- The globally unique name for this share profile.
-
Is
Share Replica Share Args - Configuration for a replica file share to create and associate with this file share. Ifunspecified, a replica may be
subsequently added by creating a new file share with a
source_sharereferencing this file share. - Replication
Cron stringSpec - The cron specification for the file share replication schedule.Replication of a share can be scheduled to occur at most once per hour.
- Resource
Group string - The unique identifier of the resource group to use. If unspecified, the account's default resourcegroup is used.
- Size float64
- The size of the file share rounded up to the next gigabyte.
- 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.
- string
- The CRN 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
Snapshot IsShare Source Snapshot Args - 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.
- []string
- User Tags for the file share
- Zone string
- The globally unique name of the zone this file share will reside in.
- access
Control StringMode - The access control mode for the share:
- List<String>
- List of access management tags
- allowed
Access List<String>Protocols - The access protocols to allow for this share
- allowed
Transit List<String>Encryption Modes - Allowed transit encryption modes
- bandwidth Double
- The bandwidth for the file share.
- encryption
Key String - The CRN of the key to use for encrypting this file share.If no encryption key is provided, the share will not be encrypted.
- initial
Owner IsShare Initial Owner - The owner assigned to the file share at creation.
- iops Double
- The maximum input/output operation performance bandwidth per second for the file share.
- String
- mount
Targets List<IsShare Mount Target> - The share targets for this file share.Share targets mounted from a replica must be mounted read-only.
- name String
- The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
-
Is
Share Origin Share - The origin share this accessor share is referring to.This property will be present when the
accessor_binding_roleisaccessor. - profile String
- The globally unique name for this share profile.
-
Is
Share Replica Share - Configuration for a replica file share to create and associate with this file share. Ifunspecified, a replica may be
subsequently added by creating a new file share with a
source_sharereferencing this file share. - replication
Cron StringSpec - The cron specification for the file share replication schedule.Replication of a share can be scheduled to occur at most once per hour.
- resource
Group String - The unique identifier of the resource group to use. If unspecified, the account's default resourcegroup is used.
- size Double
- The size of the file share rounded up to the next gigabyte.
- 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.
- String
- The CRN 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
Snapshot IsShare Source Snapshot - 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.
- List<String>
- User Tags for the file share
- zone String
- The globally unique name of the zone this file share will reside in.
- access
Control stringMode - The access control mode for the share:
- string[]
- List of access management tags
- allowed
Access string[]Protocols - The access protocols to allow for this share
- allowed
Transit string[]Encryption Modes - Allowed transit encryption modes
- bandwidth number
- The bandwidth for the file share.
- encryption
Key string - The CRN of the key to use for encrypting this file share.If no encryption key is provided, the share will not be encrypted.
- initial
Owner IsShare Initial Owner - The owner assigned to the file share at creation.
- iops number
- The maximum input/output operation performance bandwidth per second for the file share.
- string
- mount
Targets IsShare Mount Target[] - The share targets for this file share.Share targets mounted from a replica must be mounted read-only.
- name string
- The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
-
Is
Share Origin Share - The origin share this accessor share is referring to.This property will be present when the
accessor_binding_roleisaccessor. - profile string
- The globally unique name for this share profile.
-
Is
Share Replica Share - Configuration for a replica file share to create and associate with this file share. Ifunspecified, a replica may be
subsequently added by creating a new file share with a
source_sharereferencing this file share. - replication
Cron stringSpec - The cron specification for the file share replication schedule.Replication of a share can be scheduled to occur at most once per hour.
- resource
Group string - The unique identifier of the resource group to use. If unspecified, the account's default resourcegroup is used.
- size number
- The size of the file share rounded up to the next gigabyte.
- 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.
- string
- The CRN 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
Snapshot IsShare Source Snapshot - 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.
- string[]
- User Tags for the file share
- zone string
- The globally unique name of the zone this file share will reside in.
- access_
control_ strmode - The access control mode for the share:
- Sequence[str]
- List of access management tags
- allowed_
access_ Sequence[str]protocols - The access protocols to allow for this share
- allowed_
transit_ Sequence[str]encryption_ modes - Allowed transit encryption modes
- bandwidth float
- The bandwidth for the file share.
- encryption_
key str - The CRN of the key to use for encrypting this file share.If no encryption key is provided, the share will not be encrypted.
- initial_
owner IsShare Initial Owner Args - The owner assigned to the file share at creation.
- iops float
- The maximum input/output operation performance bandwidth per second for the file share.
- str
- mount_
targets Sequence[IsShare Mount Target Args] - The share targets for this file share.Share targets mounted from a replica must be mounted read-only.
- name str
- The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
-
Is
Share Origin Share Args - The origin share this accessor share is referring to.This property will be present when the
accessor_binding_roleisaccessor. - profile str
- The globally unique name for this share profile.
-
Is
Share Replica Share Args - Configuration for a replica file share to create and associate with this file share. Ifunspecified, a replica may be
subsequently added by creating a new file share with a
source_sharereferencing this file share. - replication_
cron_ strspec - The cron specification for the file share replication schedule.Replication of a share can be scheduled to occur at most once per hour.
- resource_
group str - The unique identifier of the resource group to use. If unspecified, the account's default resourcegroup is used.
- size float
- The size of the file share rounded up to the next gigabyte.
- 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.
- str
- The CRN 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_
snapshot IsShare Source Snapshot Args - 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.
- Sequence[str]
- User Tags for the file share
- zone str
- The globally unique name of the zone this file share will reside in.
- access
Control StringMode - The access control mode for the share:
- List<String>
- List of access management tags
- allowed
Access List<String>Protocols - The access protocols to allow for this share
- allowed
Transit List<String>Encryption Modes - Allowed transit encryption modes
- bandwidth Number
- The bandwidth for the file share.
- encryption
Key String - The CRN of the key to use for encrypting this file share.If no encryption key is provided, the share will not be encrypted.
- initial
Owner Property Map - The owner assigned to the file share at creation.
- iops Number
- The maximum input/output operation performance bandwidth per second for the file share.
- String
- mount
Targets List<Property Map> - The share targets for this file share.Share targets mounted from a replica must be mounted read-only.
- name String
- The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
- Property Map
- The origin share this accessor share is referring to.This property will be present when the
accessor_binding_roleisaccessor. - profile String
- The globally unique name for this share profile.
- Property Map
- Configuration for a replica file share to create and associate with this file share. Ifunspecified, a replica may be
subsequently added by creating a new file share with a
source_sharereferencing this file share. - replication
Cron StringSpec - The cron specification for the file share replication schedule.Replication of a share can be scheduled to occur at most once per hour.
- resource
Group String - The unique identifier of the resource group to use. If unspecified, the account's default resourcegroup is used.
- size Number
- The size of the file share rounded up to the next gigabyte.
- 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.
- String
- The CRN 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
Snapshot 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.
- List<String>
- User Tags for the file share
- zone String
- The globally unique name of the zone this file share will reside in.
Outputs
All input properties are implicitly available as output properties. Additionally, the IsShare resource produces the following output properties:
- Accessor
Binding stringRole - 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 List<IsShare Accessor Binding> - 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.
- Availability
Mode string - Availability mode of the share.
- Created
At string - The date and time that the file share is created.
- Crn string
- The CRN for this share.
- Encryption string
- The type of encryption used for this file share.
- Href string
- The URL for this share.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Sync stringAt - The date and time that the file share was last synchronized to its replica.This property will be present when the
replication_roleissource. - Latest
Jobs List<IsShare Latest Job> - The latest job associated with this file share.This property will be absent if no jobs have been created for this file share.
- Latest
Syncs List<IsShare Latest Sync> - Information about the latest synchronization for this file share.
- Lifecycle
Reasons List<IsShare Lifecycle Reason> - The reasons for the current lifecycle_state (if any).
- Lifecycle
State string - The lifecycle state of the file share.
- Replication
Role string - The replication role of the file share.*
none: This share is not participating in replication.*replica: This share is a replication target.*source: This share is a replication source. - Replication
Status string - The replication status of the file share.*
initializing: This share is initializing replication.*active: This share is actively participating in replication.*failover_pending: This share is performing a replication failover.*split_pending: This share is performing a replication split.*none: This share is not participating in replication.*degraded: This share's replication sync is degraded.*sync_pending: This share is performing a replication sync. - Replication
Status List<IsReasons Share Replication Status Reason> - The reasons for the current replication status (if any).The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered.
- Resource
Type string - The type of resource referenced.
- Snapshot
Count double - The total number of snapshots for this share.
- Snapshot
Size double - The total size (in gigabytes) of snapshots used for this file share.
- Storage
Generation double - The storage generation for this share
- Accessor
Binding stringRole - 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 []IsShare Accessor Binding - 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.
- Availability
Mode string - Availability mode of the share.
- Created
At string - The date and time that the file share is created.
- Crn string
- The CRN for this share.
- Encryption string
- The type of encryption used for this file share.
- Href string
- The URL for this share.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Sync stringAt - The date and time that the file share was last synchronized to its replica.This property will be present when the
replication_roleissource. - Latest
Jobs []IsShare Latest Job - The latest job associated with this file share.This property will be absent if no jobs have been created for this file share.
- Latest
Syncs []IsShare Latest Sync - Information about the latest synchronization for this file share.
- Lifecycle
Reasons []IsShare Lifecycle Reason - The reasons for the current lifecycle_state (if any).
- Lifecycle
State string - The lifecycle state of the file share.
- Replication
Role string - The replication role of the file share.*
none: This share is not participating in replication.*replica: This share is a replication target.*source: This share is a replication source. - Replication
Status string - The replication status of the file share.*
initializing: This share is initializing replication.*active: This share is actively participating in replication.*failover_pending: This share is performing a replication failover.*split_pending: This share is performing a replication split.*none: This share is not participating in replication.*degraded: This share's replication sync is degraded.*sync_pending: This share is performing a replication sync. - Replication
Status []IsReasons Share Replication Status Reason - The reasons for the current replication status (if any).The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered.
- Resource
Type string - The type of resource referenced.
- Snapshot
Count float64 - The total number of snapshots for this share.
- Snapshot
Size float64 - The total size (in gigabytes) of snapshots used for this file share.
- Storage
Generation float64 - The storage generation for this share
- accessor
Binding StringRole - 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 List<IsShare Accessor Binding> - 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.
- availability
Mode String - Availability mode of the share.
- created
At String - The date and time that the file share is created.
- crn String
- The CRN for this share.
- encryption String
- The type of encryption used for this file share.
- href String
- The URL for this share.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Sync StringAt - The date and time that the file share was last synchronized to its replica.This property will be present when the
replication_roleissource. - latest
Jobs List<IsShare Latest Job> - The latest job associated with this file share.This property will be absent if no jobs have been created for this file share.
- latest
Syncs List<IsShare Latest Sync> - Information about the latest synchronization for this file share.
- lifecycle
Reasons List<IsShare Lifecycle Reason> - The reasons for the current lifecycle_state (if any).
- lifecycle
State String - The lifecycle state of the file share.
- replication
Role String - The replication role of the file share.*
none: This share is not participating in replication.*replica: This share is a replication target.*source: This share is a replication source. - replication
Status String - The replication status of the file share.*
initializing: This share is initializing replication.*active: This share is actively participating in replication.*failover_pending: This share is performing a replication failover.*split_pending: This share is performing a replication split.*none: This share is not participating in replication.*degraded: This share's replication sync is degraded.*sync_pending: This share is performing a replication sync. - replication
Status List<IsReasons Share Replication Status Reason> - The reasons for the current replication status (if any).The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered.
- resource
Type String - The type of resource referenced.
- snapshot
Count Double - The total number of snapshots for this share.
- snapshot
Size Double - The total size (in gigabytes) of snapshots used for this file share.
- storage
Generation Double - The storage generation for this share
- accessor
Binding stringRole - 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 IsShare Accessor Binding[] - 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.
- availability
Mode string - Availability mode of the share.
- created
At string - The date and time that the file share is created.
- crn string
- The CRN for this share.
- encryption string
- The type of encryption used for this file share.
- href string
- The URL for this share.
- id string
- The provider-assigned unique ID for this managed resource.
- last
Sync stringAt - The date and time that the file share was last synchronized to its replica.This property will be present when the
replication_roleissource. - latest
Jobs IsShare Latest Job[] - The latest job associated with this file share.This property will be absent if no jobs have been created for this file share.
- latest
Syncs IsShare Latest Sync[] - Information about the latest synchronization for this file share.
- lifecycle
Reasons IsShare Lifecycle Reason[] - The reasons for the current lifecycle_state (if any).
- lifecycle
State string - The lifecycle state of the file share.
- replication
Role string - The replication role of the file share.*
none: This share is not participating in replication.*replica: This share is a replication target.*source: This share is a replication source. - replication
Status string - The replication status of the file share.*
initializing: This share is initializing replication.*active: This share is actively participating in replication.*failover_pending: This share is performing a replication failover.*split_pending: This share is performing a replication split.*none: This share is not participating in replication.*degraded: This share's replication sync is degraded.*sync_pending: This share is performing a replication sync. - replication
Status IsReasons Share Replication Status Reason[] - The reasons for the current replication status (if any).The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered.
- resource
Type string - The type of resource referenced.
- snapshot
Count number - The total number of snapshots for this share.
- snapshot
Size number - The total size (in gigabytes) of snapshots used for this file share.
- storage
Generation number - The storage generation for this share
- accessor_
binding_ strrole - 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[IsShare Accessor Binding] - 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.
- availability_
mode str - Availability mode of the share.
- created_
at str - The date and time that the file share is created.
- crn str
- The CRN for this share.
- encryption str
- The type of encryption used for this file share.
- href str
- The URL for this share.
- id str
- The provider-assigned unique ID for this managed resource.
- last_
sync_ strat - The date and time that the file share was last synchronized to its replica.This property will be present when the
replication_roleissource. - latest_
jobs Sequence[IsShare Latest Job] - The latest job associated with this file share.This property will be absent if no jobs have been created for this file share.
- latest_
syncs Sequence[IsShare Latest Sync] - Information about the latest synchronization for this file share.
- lifecycle_
reasons Sequence[IsShare Lifecycle Reason] - The reasons for the current lifecycle_state (if any).
- lifecycle_
state str - The lifecycle state of the file share.
- replication_
role str - The replication role of the file share.*
none: This share is not participating in replication.*replica: This share is a replication target.*source: This share is a replication source. - replication_
status str - The replication status of the file share.*
initializing: This share is initializing replication.*active: This share is actively participating in replication.*failover_pending: This share is performing a replication failover.*split_pending: This share is performing a replication split.*none: This share is not participating in replication.*degraded: This share's replication sync is degraded.*sync_pending: This share is performing a replication sync. - replication_
status_ Sequence[Isreasons Share Replication Status Reason] - The reasons for the current replication status (if any).The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered.
- resource_
type str - The type of resource referenced.
- snapshot_
count float - The total number of snapshots for this share.
- snapshot_
size float - The total size (in gigabytes) of snapshots used for this file share.
- storage_
generation float - The storage generation for this share
- accessor
Binding StringRole - 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 List<Property Map> - 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.
- availability
Mode String - Availability mode of the share.
- created
At String - The date and time that the file share is created.
- crn String
- The CRN for this share.
- encryption String
- The type of encryption used for this file share.
- href String
- The URL for this share.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Sync StringAt - The date and time that the file share was last synchronized to its replica.This property will be present when the
replication_roleissource. - latest
Jobs List<Property Map> - The latest job associated with this file share.This property will be absent if no jobs have been created for this file share.
- latest
Syncs List<Property Map> - Information about the latest synchronization for this file share.
- lifecycle
Reasons List<Property Map> - The reasons for the current lifecycle_state (if any).
- lifecycle
State String - The lifecycle state of the file share.
- replication
Role String - The replication role of the file share.*
none: This share is not participating in replication.*replica: This share is a replication target.*source: This share is a replication source. - replication
Status String - The replication status of the file share.*
initializing: This share is initializing replication.*active: This share is actively participating in replication.*failover_pending: This share is performing a replication failover.*split_pending: This share is performing a replication split.*none: This share is not participating in replication.*degraded: This share's replication sync is degraded.*sync_pending: This share is performing a replication sync. - replication
Status List<Property Map>Reasons - The reasons for the current replication status (if any).The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered.
- resource
Type String - The type of resource referenced.
- snapshot
Count Number - The total number of snapshots for this share.
- snapshot
Size Number - The total size (in gigabytes) of snapshots used for this file share.
- storage
Generation Number - The storage generation for this 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_access_protocols: Optional[Sequence[str]] = None,
allowed_transit_encryption_modes: Optional[Sequence[str]] = None,
availability_mode: Optional[str] = None,
bandwidth: Optional[float] = 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,
storage_generation: Optional[float] = None,
tags: Optional[Sequence[str]] = None,
zone: Optional[str] = None) -> IsSharefunc 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Access
Control stringMode - The access control mode for the share:
- List<string>
- List of access management tags
- Accessor
Binding stringRole - 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 List<IsShare Accessor Binding> - 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.
- Allowed
Access List<string>Protocols - The access protocols to allow for this share
- Allowed
Transit List<string>Encryption Modes - Allowed transit encryption modes
- Availability
Mode string - Availability mode of the share.
- Bandwidth double
- The bandwidth for the file share.
- Created
At string - The date and time that the file share is created.
- Crn string
- The CRN for this share.
- Encryption string
- The type of encryption used for this file share.
- Encryption
Key string - The CRN of the key to use for encrypting this file share.If no encryption key is provided, the share will not be encrypted.
- Href string
- The URL for this share.
- Initial
Owner IsShare Initial Owner - The owner assigned to the file share at creation.
- Iops double
- The maximum input/output operation performance bandwidth per second for the file share.
- string
- Last
Sync stringAt - The date and time that the file share was last synchronized to its replica.This property will be present when the
replication_roleissource. - Latest
Jobs List<IsShare Latest Job> - The latest job associated with this file share.This property will be absent if no jobs have been created for this file share.
- Latest
Syncs List<IsShare Latest Sync> - Information about the latest synchronization for this file share.
- Lifecycle
Reasons List<IsShare Lifecycle Reason> - The reasons for the current lifecycle_state (if any).
- Lifecycle
State string - The lifecycle state of the file share.
- Mount
Targets List<IsShare Mount Target> - The share targets for this file share.Share targets mounted from a replica must be mounted read-only.
- Name string
- The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
-
Is
Share Origin Share - The origin share this accessor share is referring to.This property will be present when the
accessor_binding_roleisaccessor. - Profile string
- The globally unique name for this share profile.
-
Is
Share Replica Share - Configuration for a replica file share to create and associate with this file share. Ifunspecified, a replica may be
subsequently added by creating a new file share with a
source_sharereferencing this file share. - Replication
Cron stringSpec - The cron specification for the file share replication schedule.Replication of a share can be scheduled to occur at most once per hour.
- Replication
Role string - The replication role of the file share.*
none: This share is not participating in replication.*replica: This share is a replication target.*source: This share is a replication source. - Replication
Status string - The replication status of the file share.*
initializing: This share is initializing replication.*active: This share is actively participating in replication.*failover_pending: This share is performing a replication failover.*split_pending: This share is performing a replication split.*none: This share is not participating in replication.*degraded: This share's replication sync is degraded.*sync_pending: This share is performing a replication sync. - Replication
Status List<IsReasons Share Replication Status Reason> - The reasons for the current replication status (if any).The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered.
- Resource
Group string - The unique identifier of the resource group to use. If unspecified, the account's default resourcegroup is used.
- Resource
Type string - The type of resource referenced.
- Size double
- The size of the file share rounded up to the next gigabyte.
- Snapshot
Count double - The total number of snapshots for this share.
- Snapshot
Size double - The total size (in gigabytes) of snapshots used for this file share.
- 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.
- string
- The CRN 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
Snapshot IsShare Source Snapshot - 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.
- Storage
Generation double - The storage generation for this share
- List<string>
- User Tags for the file share
- Zone string
- The globally unique name of the zone this file share will reside in.
- Access
Control stringMode - The access control mode for the share:
- []string
- List of access management tags
- Accessor
Binding stringRole - 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 []IsShare Accessor Binding Args - 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.
- Allowed
Access []stringProtocols - The access protocols to allow for this share
- Allowed
Transit []stringEncryption Modes - Allowed transit encryption modes
- Availability
Mode string - Availability mode of the share.
- Bandwidth float64
- The bandwidth for the file share.
- Created
At string - The date and time that the file share is created.
- Crn string
- The CRN for this share.
- Encryption string
- The type of encryption used for this file share.
- Encryption
Key string - The CRN of the key to use for encrypting this file share.If no encryption key is provided, the share will not be encrypted.
- Href string
- The URL for this share.
- Initial
Owner IsShare Initial Owner Args - The owner assigned to the file share at creation.
- Iops float64
- The maximum input/output operation performance bandwidth per second for the file share.
- string
- Last
Sync stringAt - The date and time that the file share was last synchronized to its replica.This property will be present when the
replication_roleissource. - Latest
Jobs []IsShare Latest Job Args - The latest job associated with this file share.This property will be absent if no jobs have been created for this file share.
- Latest
Syncs []IsShare Latest Sync Args - Information about the latest synchronization for this file share.
- Lifecycle
Reasons []IsShare Lifecycle Reason Args - The reasons for the current lifecycle_state (if any).
- Lifecycle
State string - The lifecycle state of the file share.
- Mount
Targets []IsShare Mount Target Type Args - The share targets for this file share.Share targets mounted from a replica must be mounted read-only.
- Name string
- The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
-
Is
Share Origin Share Args - The origin share this accessor share is referring to.This property will be present when the
accessor_binding_roleisaccessor. - Profile string
- The globally unique name for this share profile.
-
Is
Share Replica Share Args - Configuration for a replica file share to create and associate with this file share. Ifunspecified, a replica may be
subsequently added by creating a new file share with a
source_sharereferencing this file share. - Replication
Cron stringSpec - The cron specification for the file share replication schedule.Replication of a share can be scheduled to occur at most once per hour.
- Replication
Role string - The replication role of the file share.*
none: This share is not participating in replication.*replica: This share is a replication target.*source: This share is a replication source. - Replication
Status string - The replication status of the file share.*
initializing: This share is initializing replication.*active: This share is actively participating in replication.*failover_pending: This share is performing a replication failover.*split_pending: This share is performing a replication split.*none: This share is not participating in replication.*degraded: This share's replication sync is degraded.*sync_pending: This share is performing a replication sync. - Replication
Status []IsReasons Share Replication Status Reason Args - The reasons for the current replication status (if any).The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered.
- Resource
Group string - The unique identifier of the resource group to use. If unspecified, the account's default resourcegroup is used.
- Resource
Type string - The type of resource referenced.
- Size float64
- The size of the file share rounded up to the next gigabyte.
- Snapshot
Count float64 - The total number of snapshots for this share.
- Snapshot
Size float64 - The total size (in gigabytes) of snapshots used for this file share.
- 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.
- string
- The CRN 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
Snapshot IsShare Source Snapshot Args - 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.
- Storage
Generation float64 - The storage generation for this share
- []string
- User Tags for the file share
- Zone string
- The globally unique name of the zone this file share will reside in.
- access
Control StringMode - The access control mode for the share:
- List<String>
- List of access management tags
- accessor
Binding StringRole - 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 List<IsShare Accessor Binding> - 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.
- allowed
Access List<String>Protocols - The access protocols to allow for this share
- allowed
Transit List<String>Encryption Modes - Allowed transit encryption modes
- availability
Mode String - Availability mode of the share.
- bandwidth Double
- The bandwidth for the file share.
- created
At String - The date and time that the file share is created.
- crn String
- The CRN for this share.
- encryption String
- The type of encryption used for this file share.
- encryption
Key String - The CRN of the key to use for encrypting this file share.If no encryption key is provided, the share will not be encrypted.
- href String
- The URL for this share.
- initial
Owner IsShare Initial Owner - The owner assigned to the file share at creation.
- iops Double
- The maximum input/output operation performance bandwidth per second for the file share.
- String
- last
Sync StringAt - The date and time that the file share was last synchronized to its replica.This property will be present when the
replication_roleissource. - latest
Jobs List<IsShare Latest Job> - The latest job associated with this file share.This property will be absent if no jobs have been created for this file share.
- latest
Syncs List<IsShare Latest Sync> - Information about the latest synchronization for this file share.
- lifecycle
Reasons List<IsShare Lifecycle Reason> - The reasons for the current lifecycle_state (if any).
- lifecycle
State String - The lifecycle state of the file share.
- mount
Targets List<IsShare Mount Target> - The share targets for this file share.Share targets mounted from a replica must be mounted read-only.
- name String
- The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
-
Is
Share Origin Share - The origin share this accessor share is referring to.This property will be present when the
accessor_binding_roleisaccessor. - profile String
- The globally unique name for this share profile.
-
Is
Share Replica Share - Configuration for a replica file share to create and associate with this file share. Ifunspecified, a replica may be
subsequently added by creating a new file share with a
source_sharereferencing this file share. - replication
Cron StringSpec - The cron specification for the file share replication schedule.Replication of a share can be scheduled to occur at most once per hour.
- replication
Role String - The replication role of the file share.*
none: This share is not participating in replication.*replica: This share is a replication target.*source: This share is a replication source. - replication
Status String - The replication status of the file share.*
initializing: This share is initializing replication.*active: This share is actively participating in replication.*failover_pending: This share is performing a replication failover.*split_pending: This share is performing a replication split.*none: This share is not participating in replication.*degraded: This share's replication sync is degraded.*sync_pending: This share is performing a replication sync. - replication
Status List<IsReasons Share Replication Status Reason> - The reasons for the current replication status (if any).The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered.
- resource
Group String - The unique identifier of the resource group to use. If unspecified, the account's default resourcegroup is used.
- resource
Type String - The type of resource referenced.
- size Double
- The size of the file share rounded up to the next gigabyte.
- snapshot
Count Double - The total number of snapshots for this share.
- snapshot
Size Double - The total size (in gigabytes) of snapshots used for this file share.
- 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.
- String
- The CRN 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
Snapshot IsShare Source Snapshot - 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.
- storage
Generation Double - The storage generation for this share
- List<String>
- User Tags for the file share
- zone String
- The globally unique name of the zone this file share will reside in.
- access
Control stringMode - The access control mode for the share:
- string[]
- List of access management tags
- accessor
Binding stringRole - 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 IsShare Accessor Binding[] - 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.
- allowed
Access string[]Protocols - The access protocols to allow for this share
- allowed
Transit string[]Encryption Modes - Allowed transit encryption modes
- availability
Mode string - Availability mode of the share.
- bandwidth number
- The bandwidth for the file share.
- created
At string - The date and time that the file share is created.
- crn string
- The CRN for this share.
- encryption string
- The type of encryption used for this file share.
- encryption
Key string - The CRN of the key to use for encrypting this file share.If no encryption key is provided, the share will not be encrypted.
- href string
- The URL for this share.
- initial
Owner IsShare Initial Owner - The owner assigned to the file share at creation.
- iops number
- The maximum input/output operation performance bandwidth per second for the file share.
- string
- last
Sync stringAt - The date and time that the file share was last synchronized to its replica.This property will be present when the
replication_roleissource. - latest
Jobs IsShare Latest Job[] - The latest job associated with this file share.This property will be absent if no jobs have been created for this file share.
- latest
Syncs IsShare Latest Sync[] - Information about the latest synchronization for this file share.
- lifecycle
Reasons IsShare Lifecycle Reason[] - The reasons for the current lifecycle_state (if any).
- lifecycle
State string - The lifecycle state of the file share.
- mount
Targets IsShare Mount Target[] - The share targets for this file share.Share targets mounted from a replica must be mounted read-only.
- name string
- The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
-
Is
Share Origin Share - The origin share this accessor share is referring to.This property will be present when the
accessor_binding_roleisaccessor. - profile string
- The globally unique name for this share profile.
-
Is
Share Replica Share - Configuration for a replica file share to create and associate with this file share. Ifunspecified, a replica may be
subsequently added by creating a new file share with a
source_sharereferencing this file share. - replication
Cron stringSpec - The cron specification for the file share replication schedule.Replication of a share can be scheduled to occur at most once per hour.
- replication
Role string - The replication role of the file share.*
none: This share is not participating in replication.*replica: This share is a replication target.*source: This share is a replication source. - replication
Status string - The replication status of the file share.*
initializing: This share is initializing replication.*active: This share is actively participating in replication.*failover_pending: This share is performing a replication failover.*split_pending: This share is performing a replication split.*none: This share is not participating in replication.*degraded: This share's replication sync is degraded.*sync_pending: This share is performing a replication sync. - replication
Status IsReasons Share Replication Status Reason[] - The reasons for the current replication status (if any).The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered.
- resource
Group string - The unique identifier of the resource group to use. If unspecified, the account's default resourcegroup is used.
- resource
Type string - The type of resource referenced.
- size number
- The size of the file share rounded up to the next gigabyte.
- snapshot
Count number - The total number of snapshots for this share.
- snapshot
Size number - The total size (in gigabytes) of snapshots used for this file share.
- 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.
- string
- The CRN 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
Snapshot IsShare Source Snapshot - 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.
- storage
Generation number - The storage generation for this share
- string[]
- User Tags for the file share
- zone string
- The globally unique name of the zone this file share will reside in.
- access_
control_ strmode - The access control mode for the share:
- Sequence[str]
- List of access management tags
- accessor_
binding_ strrole - 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[IsShare Accessor Binding Args] - 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.
- allowed_
access_ Sequence[str]protocols - The access protocols to allow for this share
- allowed_
transit_ Sequence[str]encryption_ modes - Allowed transit encryption modes
- availability_
mode str - Availability mode of the share.
- bandwidth float
- The bandwidth for the file share.
- created_
at str - The date and time that the file share is created.
- crn str
- The CRN for this share.
- encryption str
- The type of encryption used for this file share.
- encryption_
key str - The CRN of the key to use for encrypting this file share.If no encryption key is provided, the share will not be encrypted.
- href str
- The URL for this share.
- initial_
owner IsShare Initial Owner Args - The owner assigned to the file share at creation.
- iops float
- The maximum input/output operation performance bandwidth per second for the file share.
- str
- last_
sync_ strat - The date and time that the file share was last synchronized to its replica.This property will be present when the
replication_roleissource. - latest_
jobs Sequence[IsShare Latest Job Args] - The latest job associated with this file share.This property will be absent if no jobs have been created for this file share.
- latest_
syncs Sequence[IsShare Latest Sync Args] - Information about the latest synchronization for this file share.
- lifecycle_
reasons Sequence[IsShare Lifecycle Reason Args] - The reasons for the current lifecycle_state (if any).
- lifecycle_
state str - The lifecycle state of the file share.
- mount_
targets Sequence[IsShare Mount Target Args] - The share targets for this file share.Share targets mounted from a replica must be mounted read-only.
- name str
- The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
-
Is
Share Origin Share Args - The origin share this accessor share is referring to.This property will be present when the
accessor_binding_roleisaccessor. - profile str
- The globally unique name for this share profile.
-
Is
Share Replica Share Args - Configuration for a replica file share to create and associate with this file share. Ifunspecified, a replica may be
subsequently added by creating a new file share with a
source_sharereferencing this file share. - replication_
cron_ strspec - The cron specification for the file share replication schedule.Replication of a share can be scheduled to occur at most once per hour.
- replication_
role str - The replication role of the file share.*
none: This share is not participating in replication.*replica: This share is a replication target.*source: This share is a replication source. - replication_
status str - The replication status of the file share.*
initializing: This share is initializing replication.*active: This share is actively participating in replication.*failover_pending: This share is performing a replication failover.*split_pending: This share is performing a replication split.*none: This share is not participating in replication.*degraded: This share's replication sync is degraded.*sync_pending: This share is performing a replication sync. - replication_
status_ Sequence[Isreasons Share Replication Status Reason Args] - The reasons for the current replication status (if any).The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered.
- resource_
group str - The unique identifier of the resource group to use. If unspecified, the account's default resourcegroup is used.
- resource_
type str - The type of resource referenced.
- size float
- The size of the file share rounded up to the next gigabyte.
- snapshot_
count float - The total number of snapshots for this share.
- snapshot_
size float - The total size (in gigabytes) of snapshots used for this file 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.
- str
- The CRN 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_
snapshot IsShare Source Snapshot Args - 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.
- storage_
generation float - The storage generation for this share
- Sequence[str]
- User Tags for the file share
- zone str
- The globally unique name of the zone this file share will reside in.
- access
Control StringMode - The access control mode for the share:
- List<String>
- List of access management tags
- accessor
Binding StringRole - 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 List<Property Map> - 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.
- allowed
Access List<String>Protocols - The access protocols to allow for this share
- allowed
Transit List<String>Encryption Modes - Allowed transit encryption modes
- availability
Mode String - Availability mode of the share.
- bandwidth Number
- The bandwidth for the file share.
- created
At String - The date and time that the file share is created.
- crn String
- The CRN for this share.
- encryption String
- The type of encryption used for this file share.
- encryption
Key String - The CRN of the key to use for encrypting this file share.If no encryption key is provided, the share will not be encrypted.
- href String
- The URL for this share.
- initial
Owner Property Map - The owner assigned to the file share at creation.
- iops Number
- The maximum input/output operation performance bandwidth per second for the file share.
- String
- last
Sync StringAt - The date and time that the file share was last synchronized to its replica.This property will be present when the
replication_roleissource. - latest
Jobs List<Property Map> - The latest job associated with this file share.This property will be absent if no jobs have been created for this file share.
- latest
Syncs List<Property Map> - Information about the latest synchronization for this file share.
- lifecycle
Reasons List<Property Map> - The reasons for the current lifecycle_state (if any).
- lifecycle
State String - The lifecycle state of the file share.
- mount
Targets List<Property Map> - The share targets for this file share.Share targets mounted from a replica must be mounted read-only.
- name String
- The unique user-defined name for this file share. If unspecified, the name will be a hyphenated list of randomly-selected words.
- Property Map
- The origin share this accessor share is referring to.This property will be present when the
accessor_binding_roleisaccessor. - profile String
- The globally unique name for this share profile.
- Property Map
- Configuration for a replica file share to create and associate with this file share. Ifunspecified, a replica may be
subsequently added by creating a new file share with a
source_sharereferencing this file share. - replication
Cron StringSpec - The cron specification for the file share replication schedule.Replication of a share can be scheduled to occur at most once per hour.
- replication
Role String - The replication role of the file share.*
none: This share is not participating in replication.*replica: This share is a replication target.*source: This share is a replication source. - replication
Status String - The replication status of the file share.*
initializing: This share is initializing replication.*active: This share is actively participating in replication.*failover_pending: This share is performing a replication failover.*split_pending: This share is performing a replication split.*none: This share is not participating in replication.*degraded: This share's replication sync is degraded.*sync_pending: This share is performing a replication sync. - replication
Status List<Property Map>Reasons - The reasons for the current replication status (if any).The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered.
- resource
Group String - The unique identifier of the resource group to use. If unspecified, the account's default resourcegroup is used.
- resource
Type String - The type of resource referenced.
- size Number
- The size of the file share rounded up to the next gigabyte.
- snapshot
Count Number - The total number of snapshots for this share.
- snapshot
Size Number - The total size (in gigabytes) of snapshots used for this file share.
- 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.
- String
- The CRN 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
Snapshot 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.
- storage
Generation Number - The storage generation for this share
- List<String>
- User Tags for the file share
- zone String
- The globally unique name of the zone this file share will reside in.
Supporting Types
IsShareAccessorBinding, IsShareAccessorBindingArgs
- Href string
- Id string
- Resource
Type string
- Href string
- Id string
- Resource
Type string
- href String
- id String
- resource
Type String
- href string
- id string
- resource
Type string
- href str
- id str
- resource_
type str
- href String
- id String
- resource
Type String
IsShareInitialOwner, IsShareInitialOwnerArgs
IsShareLatestJob, IsShareLatestJobArgs
- Status string
- Status
Reasons List<IsShare Latest Job Status Reason> - Type string
- Status string
- Status
Reasons []IsShare Latest Job Status Reason - Type string
- status String
- status
Reasons List<IsShare Latest Job Status Reason> - type String
- status string
- status
Reasons IsShare Latest Job Status Reason[] - type string
- status String
- status
Reasons List<Property Map> - type String
IsShareLatestJobStatusReason, IsShareLatestJobStatusReasonArgs
IsShareLatestSync, IsShareLatestSyncArgs
- Completed
At string - Data
Transferred double - Started
At string
- Completed
At string - Data
Transferred float64 - Started
At string
- completed
At String - data
Transferred Double - started
At String
- completed
At string - data
Transferred number - started
At string
- completed_
at str - data_
transferred float - started_
at str
- completed
At String - data
Transferred Number - started
At String
IsShareLifecycleReason, IsShareLifecycleReasonArgs
IsShareMountTarget, IsShareMountTargetArgs
- 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.
- Access
Protocol string - The protocol to use to access the share for this share mount target.
- Href string
- Href of this mount target
- Id string
- ID of this mount target
- Resource
Type string - Resource type of mount target
- Transit
Encryption string - The transit encryption mode.
- Virtual
Network List<IsInterfaces Share Mount Target Virtual Network Interface> - VNI for mount target.
- Vpc string
- The unique identifier of the VPC in which instances can mount the file share using this share target.This property will be removed in a future release.The
subnetproperty should be used instead.
- 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.
- Access
Protocol string - The protocol to use to access the share for this share mount target.
- Href string
- Href of this mount target
- Id string
- ID of this mount target
- Resource
Type string - Resource type of mount target
- Transit
Encryption string - The transit encryption mode.
- Virtual
Network []IsInterfaces Share Mount Target Virtual Network Interface - VNI for mount target.
- Vpc string
- The unique identifier of the VPC in which instances can mount the file share using this share target.This property will be removed in a future release.The
subnetproperty should be used instead.
- 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.
- access
Protocol String - The protocol to use to access the share for this share mount target.
- href String
- Href of this mount target
- id String
- ID of this mount target
- resource
Type String - Resource type of mount target
- transit
Encryption String - The transit encryption mode.
- virtual
Network List<IsInterfaces Share Mount Target Virtual Network Interface> - VNI for mount target.
- vpc String
- The unique identifier of the VPC in which instances can mount the file share using this share target.This property will be removed in a future release.The
subnetproperty should be used instead.
- 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.
- access
Protocol string - The protocol to use to access the share for this share mount target.
- href string
- Href of this mount target
- id string
- ID of this mount target
- resource
Type string - Resource type of mount target
- transit
Encryption string - The transit encryption mode.
- virtual
Network IsInterfaces Share Mount Target Virtual Network Interface[] - VNI for mount target.
- vpc string
- The unique identifier of the VPC in which instances can mount the file share using this share target.This property will be removed in a future release.The
subnetproperty should be used instead.
- 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.
- access_
protocol str - The protocol to use to access the share for this share mount target.
- href str
- Href of this mount target
- id str
- ID of this mount target
- resource_
type str - Resource type of mount target
- transit_
encryption str - The transit encryption mode.
- virtual_
network_ Sequence[Isinterfaces Share Mount Target Virtual Network Interface] - VNI for mount target.
- vpc str
- The unique identifier of the VPC in which instances can mount the file share using this share target.This property will be removed in a future release.The
subnetproperty should be used instead.
- 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.
- access
Protocol String - The protocol to use to access the share for this share mount target.
- href String
- Href of this mount target
- id String
- ID of this mount target
- resource
Type String - Resource type of mount target
- transit
Encryption String - The transit encryption mode.
- virtual
Network List<Property Map>Interfaces - VNI for mount target.
- vpc String
- The unique identifier of the VPC in which instances can mount the file share using this share target.This property will be removed in a future release.The
subnetproperty should be used instead.
IsShareMountTargetVirtualNetworkInterface, IsShareMountTargetVirtualNetworkInterfaceArgs
- Allow
Ip boolSpoofing - (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 string
- CRN of this VNI
- Enable
Infrastructure boolNat - (Bool) If
true:- The VPC infrastructure performs any needed NAT operations.-floating_ipsmust not have more than one floating IP.Iffalse:- Packets are passed unchanged to/from the network interface, allowing the workload to perform any needed NAT operations.-allow_ip_spoofingmust befalse.- If the virtual network interface is attached: - The targetresource_typemust bebare_metal_server_network_attachment. - The targetinterface_typemust not behipersocket. - Href string
- (String)The URL for this share target.
- Id string
The ID for virtual network interface. Mutually exclusive with other
virtual_network_interfacearguments.Note
idis mutually exclusive with othervirtual_network_interfaceprototype 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: - Primary
Ip IsShare Mount Target Virtual Network Interface Primary Ip 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 stringFiltering Mode 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 string - The ID of the resource group to use.
- Resource
Type string - (String) The type of resource referenced.
- Security
Groups List<string> - The security groups to use for this virtual network interface.
- Subnet string
- The associated subnet.
- Allow
Ip boolSpoofing - (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 string
- CRN of this VNI
- Enable
Infrastructure boolNat - (Bool) If
true:- The VPC infrastructure performs any needed NAT operations.-floating_ipsmust not have more than one floating IP.Iffalse:- Packets are passed unchanged to/from the network interface, allowing the workload to perform any needed NAT operations.-allow_ip_spoofingmust befalse.- If the virtual network interface is attached: - The targetresource_typemust bebare_metal_server_network_attachment. - The targetinterface_typemust not behipersocket. - Href string
- (String)The URL for this share target.
- Id string
The ID for virtual network interface. Mutually exclusive with other
virtual_network_interfacearguments.Note
idis mutually exclusive with othervirtual_network_interfaceprototype 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: - Primary
Ip IsShare Mount Target Virtual Network Interface Primary Ip 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 stringFiltering Mode 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 string - The ID of the resource group to use.
- Resource
Type string - (String) The type of resource referenced.
- Security
Groups []string - The security groups to use for this virtual network interface.
- Subnet string
- The associated subnet.
- allow
Ip BooleanSpoofing - (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 Boolean - (Bool) Indicates whether this virtual network interface will be automatically deleted when target is deleted
- crn String
- CRN of this VNI
- enable
Infrastructure BooleanNat - (Bool) If
true:- The VPC infrastructure performs any needed NAT operations.-floating_ipsmust not have more than one floating IP.Iffalse:- Packets are passed unchanged to/from the network interface, allowing the workload to perform any needed NAT operations.-allow_ip_spoofingmust befalse.- If the virtual network interface is attached: - The targetresource_typemust bebare_metal_server_network_attachment. - The targetinterface_typemust not behipersocket. - href String
- (String)The URL for this share target.
- id String
The ID for virtual network interface. Mutually exclusive with other
virtual_network_interfacearguments.Note
idis mutually exclusive with othervirtual_network_interfaceprototype 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: - primary
Ip IsShare Mount Target Virtual Network Interface Primary Ip 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 StringFiltering Mode 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 String - The ID of the resource group to use.
- resource
Type String - (String) The type of resource referenced.
- security
Groups List<String> - The security groups to use for this virtual network interface.
- subnet String
- The associated subnet.
- allow
Ip booleanSpoofing - (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 boolean - (Bool) Indicates whether this virtual network interface will be automatically deleted when target is deleted
- crn string
- CRN of this VNI
- enable
Infrastructure booleanNat - (Bool) If
true:- The VPC infrastructure performs any needed NAT operations.-floating_ipsmust not have more than one floating IP.Iffalse:- Packets are passed unchanged to/from the network interface, allowing the workload to perform any needed NAT operations.-allow_ip_spoofingmust befalse.- If the virtual network interface is attached: - The targetresource_typemust bebare_metal_server_network_attachment. - The targetinterface_typemust not behipersocket. - href string
- (String)The URL for this share target.
- id string
The ID for virtual network interface. Mutually exclusive with other
virtual_network_interfacearguments.Note
idis mutually exclusive with othervirtual_network_interfaceprototype 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: - primary
Ip IsShare Mount Target Virtual Network Interface Primary Ip 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 stringFiltering Mode 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 string - The ID of the resource group to use.
- resource
Type string - (String) The type of resource referenced.
- security
Groups string[] - The security groups to use for this virtual network interface.
- subnet string
- The associated subnet.
- allow_
ip_ boolspoofing - (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_ boolnat - (Bool) If
true:- The VPC infrastructure performs any needed NAT operations.-floating_ipsmust not have more than one floating IP.Iffalse:- Packets are passed unchanged to/from the network interface, allowing the workload to perform any needed NAT operations.-allow_ip_spoofingmust befalse.- If the virtual network interface is attached: - The targetresource_typemust bebare_metal_server_network_attachment. - The targetinterface_typemust not behipersocket. - href str
- (String)The URL for this share target.
- id str
The ID for virtual network interface. Mutually exclusive with other
virtual_network_interfacearguments.Note
idis mutually exclusive with othervirtual_network_interfaceprototype 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 IsShare Mount Target Virtual Network Interface Primary Ip 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_ strfiltering_ mode 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.
- allow
Ip BooleanSpoofing - (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 Boolean - (Bool) Indicates whether this virtual network interface will be automatically deleted when target is deleted
- crn String
- CRN of this VNI
- enable
Infrastructure BooleanNat - (Bool) If
true:- The VPC infrastructure performs any needed NAT operations.-floating_ipsmust not have more than one floating IP.Iffalse:- Packets are passed unchanged to/from the network interface, allowing the workload to perform any needed NAT operations.-allow_ip_spoofingmust befalse.- If the virtual network interface is attached: - The targetresource_typemust bebare_metal_server_network_attachment. - The targetinterface_typemust not behipersocket. - href String
- (String)The URL for this share target.
- id String
The ID for virtual network interface. Mutually exclusive with other
virtual_network_interfacearguments.Note
idis mutually exclusive with othervirtual_network_interfaceprototype 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: - primary
Ip 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:- protocol
State StringFiltering Mode 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 String - The ID of the resource group to use.
- resource
Type String - (String) The type of resource referenced.
- security
Groups 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.
- 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 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.
- Reserved
Ip string The unique identifier for this reserved IP.
Note Within
primary_ip,reserved_ipis mutually exclusive toauto_delete,addressandname- Resource
Type 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.
- 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 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.
- Reserved
Ip string The unique identifier for this reserved IP.
Note Within
primary_ip,reserved_ipis mutually exclusive toauto_delete,addressandname- Resource
Type 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.
- auto
Delete 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.
- reserved
Ip String The unique identifier for this reserved IP.
Note Within
primary_ip,reserved_ipis mutually exclusive toauto_delete,addressandname- resource
Type 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.
- auto
Delete 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.
- reserved
Ip string The unique identifier for this reserved IP.
Note Within
primary_ip,reserved_ipis mutually exclusive toauto_delete,addressandname- resource
Type 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_ipis mutually exclusive toauto_delete,addressandname- 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.
- auto
Delete 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.
- reserved
Ip String The unique identifier for this reserved IP.
Note Within
primary_ip,reserved_ipis mutually exclusive toauto_delete,addressandname- resource
Type String - (String) The type of resource referenced.
IsShareOriginShare, IsShareOriginShareArgs
- Crn string
- The CRN for this file share.
- Deleteds
List<Is
Share Origin Share Deleted> - If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.
- Href string
- The URL for this file share.
- Id string
- The unique identifier for this file share.
- Name string
- The name for this share. The name is unique across all shares in the region.
- Remotes
List<Is
Share Origin Share Remote> - If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable.
- Resource
Type string - The resource type.
- Crn string
- The CRN for this file share.
- Deleteds
[]Is
Share Origin Share Deleted - If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.
- Href string
- The URL for this file share.
- Id string
- The unique identifier for this file share.
- Name string
- The name for this share. The name is unique across all shares in the region.
- Remotes
[]Is
Share Origin Share Remote - If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable.
- Resource
Type string - The resource type.
- crn String
- The CRN for this file share.
- deleteds
List<Is
Share Origin Share Deleted> - If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.
- href String
- The URL for this file share.
- id String
- The unique identifier for this file share.
- name String
- The name for this share. The name is unique across all shares in the region.
- remotes
List<Is
Share Origin Share Remote> - If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable.
- resource
Type String - The resource type.
- crn string
- The CRN for this file share.
- deleteds
Is
Share Origin Share Deleted[] - If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.
- href string
- The URL for this file share.
- id string
- The unique identifier for this file share.
- name string
- The name for this share. The name is unique across all shares in the region.
- remotes
Is
Share Origin Share Remote[] - If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable.
- resource
Type string - The resource type.
- crn str
- The CRN for this file share.
- deleteds
Sequence[Is
Share Origin Share Deleted] - If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.
- href str
- The URL for this file share.
- id str
- The unique identifier for this file share.
- name str
- The name for this share. The name is unique across all shares in the region.
- remotes
Sequence[Is
Share Origin Share Remote] - If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable.
- resource_
type str - The resource type.
- crn String
- The CRN for this file share.
- deleteds List<Property Map>
- If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.
- href String
- The URL for this file share.
- id String
- The unique identifier for this file share.
- name String
- The name for this share. The name is unique across all shares in the region.
- remotes List<Property Map>
- If present, this property indicates that the resource associated with this referenceis remote and therefore may not be directly retrievable.
- resource
Type String - The resource type.
IsShareOriginShareDeleted, IsShareOriginShareDeletedArgs
- More
Info string
- More
Info string
- more
Info String
- more
Info string
- more_
info str
- more
Info String
IsShareOriginShareRemote, IsShareOriginShareRemoteArgs
IsShareOriginShareRemoteAccount, IsShareOriginShareRemoteAccountArgs
- Id string
- Resource
Type string
- Id string
- Resource
Type string
- id String
- resource
Type String
- id string
- resource
Type string
- id str
- resource_
type str
- id String
- resource
Type String
IsShareOriginShareRemoteRegion, IsShareOriginShareRemoteRegionArgs
IsShareReplicaShare, IsShareReplicaShareArgs
- Name string
- The unique user-defined name for this file share.
- Profile string
- Share profile name.
- Replication
Cron stringSpec - The cron specification for the file share replication schedule.Replication of a share can be scheduled to occur at most once per hour.
- List<string>
- List of access management tags for this replica share
- Crn string
- The CRN for this replica share.
- Href string
- The href for this replica share.
- Id string
- The ID of this replica file share.
- Iops double
- The maximum input/output operation per second (IOPS) for the file share.
- Mount
Targets List<IsShare Replica Share Mount Target> - The share targets for this replica file share.Share targets mounted from a replica must be mounted read-only.
- Replication
Role string - The replication role of the file share.
- Replication
Status string - The replication status of the file share.
- Replication
Status List<IsReasons Share Replica Share Replication Status Reason> - The reasons for the current replication status.
- List<string>
- User Tags for the replica share
- Zone 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.
- Name string
- The unique user-defined name for this file share.
- Profile string
- Share profile name.
- Replication
Cron stringSpec - The cron specification for the file share replication schedule.Replication of a share can be scheduled to occur at most once per hour.
- []string
- List of access management tags for this replica share
- Crn string
- The CRN for this replica share.
- Href string
- The href for this replica share.
- Id string
- The ID of this replica file share.
- Iops float64
- The maximum input/output operation per second (IOPS) for the file share.
- Mount
Targets []IsShare Replica Share Mount Target - The share targets for this replica file share.Share targets mounted from a replica must be mounted read-only.
- Replication
Role string - The replication role of the file share.
- Replication
Status string - The replication status of the file share.
- Replication
Status []IsReasons Share Replica Share Replication Status Reason - The reasons for the current replication status.
- []string
- User Tags for the replica share
- Zone 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.
- name String
- The unique user-defined name for this file share.
- profile String
- Share profile name.
- replication
Cron StringSpec - The cron specification for the file share replication schedule.Replication of a share can be scheduled to occur at most once per hour.
- List<String>
- List of access management tags for this replica share
- crn String
- The CRN for this replica share.
- href String
- The href for this replica share.
- id String
- The ID of this replica file share.
- iops Double
- The maximum input/output operation per second (IOPS) for the file share.
- mount
Targets List<IsShare Replica Share Mount Target> - The share targets for this replica file share.Share targets mounted from a replica must be mounted read-only.
- replication
Role String - The replication role of the file share.
- replication
Status String - The replication status of the file share.
- replication
Status List<IsReasons Share Replica Share Replication Status Reason> - The reasons for the current replication status.
- List<String>
- User Tags for the replica share
- zone 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.
- name string
- The unique user-defined name for this file share.
- profile string
- Share profile name.
- replication
Cron stringSpec - The cron specification for the file share replication schedule.Replication of a share can be scheduled to occur at most once per hour.
- string[]
- List of access management tags for this replica share
- crn string
- The CRN for this replica share.
- href string
- The href for this replica share.
- id string
- The ID of this replica file share.
- iops number
- The maximum input/output operation per second (IOPS) for the file share.
- mount
Targets IsShare Replica Share Mount Target[] - The share targets for this replica file share.Share targets mounted from a replica must be mounted read-only.
- replication
Role string - The replication role of the file share.
- replication
Status string - The replication status of the file share.
- replication
Status IsReasons Share Replica Share Replication Status Reason[] - The reasons for the current replication status.
- string[]
- User Tags for the replica share
- zone 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.
- name str
- The unique user-defined name for this file share.
- profile str
- Share profile name.
- replication_
cron_ strspec - The cron specification for the file share replication schedule.Replication of a share can be scheduled to occur at most once per hour.
- Sequence[str]
- List of access management tags for this replica share
- crn str
- The CRN for this replica share.
- href str
- The href for this replica share.
- id str
- The ID of this replica file share.
- iops float
- The maximum input/output operation per second (IOPS) for the file share.
- mount_
targets Sequence[IsShare Replica Share Mount Target] - The share targets for this replica file share.Share targets mounted from a replica must be mounted read-only.
- replication_
role str - The replication role of the file share.
- replication_
status str - The replication status of the file share.
- replication_
status_ Sequence[Isreasons Share Replica Share Replication Status Reason] - The reasons for the current replication status.
- Sequence[str]
- User Tags for the replica share
- zone 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.
- name String
- The unique user-defined name for this file share.
- profile String
- Share profile name.
- replication
Cron StringSpec - The cron specification for the file share replication schedule.Replication of a share can be scheduled to occur at most once per hour.
- List<String>
- List of access management tags for this replica share
- crn String
- The CRN for this replica share.
- href String
- The href for this replica share.
- id String
- The ID of this replica file share.
- iops Number
- The maximum input/output operation per second (IOPS) for the file share.
- mount
Targets List<Property Map> - The share targets for this replica file share.Share targets mounted from a replica must be mounted read-only.
- replication
Role String - The replication role of the file share.
- replication
Status String - The replication status of the file share.
- replication
Status List<Property Map>Reasons - The reasons for the current replication status.
- List<String>
- User Tags for the replica share
- zone 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.
IsShareReplicaShareMountTarget, IsShareReplicaShareMountTargetArgs
- Access
Protocol string - The protocol to use to access the share for this share mount target.
- Href string
- href of mount target
- Id string
- ID of this share target.
- 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.
- Resource
Type string - Resource type of virtual network interface
- Transit
Encryption string - The transit encryption mode.
- Virtual
Network List<IsInterfaces Share Replica Share Mount Target Virtual Network Interface> - VNI for mount target.
- Vpc string
- The ID of the VPC in which instances can mount the file share using this share target.This property will be removed in a future release.The
subnetproperty should be used instead.
- Access
Protocol string - The protocol to use to access the share for this share mount target.
- Href string
- href of mount target
- Id string
- ID of this share target.
- 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.
- Resource
Type string - Resource type of virtual network interface
- Transit
Encryption string - The transit encryption mode.
- Virtual
Network []IsInterfaces Share Replica Share Mount Target Virtual Network Interface - VNI for mount target.
- Vpc string
- The ID of the VPC in which instances can mount the file share using this share target.This property will be removed in a future release.The
subnetproperty should be used instead.
- access
Protocol String - The protocol to use to access the share for this share mount target.
- href String
- href of mount target
- id String
- ID of this share target.
- 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.
- resource
Type String - Resource type of virtual network interface
- transit
Encryption String - The transit encryption mode.
- virtual
Network List<IsInterfaces Share Replica Share Mount Target Virtual Network Interface> - VNI for mount target.
- vpc String
- The ID of the VPC in which instances can mount the file share using this share target.This property will be removed in a future release.The
subnetproperty should be used instead.
- access
Protocol string - The protocol to use to access the share for this share mount target.
- href string
- href of mount target
- id string
- ID of this share target.
- 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.
- resource
Type string - Resource type of virtual network interface
- transit
Encryption string - The transit encryption mode.
- virtual
Network IsInterfaces Share Replica Share Mount Target Virtual Network Interface[] - VNI for mount target.
- vpc string
- The ID of the VPC in which instances can mount the file share using this share target.This property will be removed in a future release.The
subnetproperty should be used instead.
- access_
protocol str - The protocol to use to access the share for this share mount target.
- href str
- href of mount target
- id str
- ID of this share target.
- 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 - Resource type of virtual network interface
- transit_
encryption str - The transit encryption mode.
- virtual_
network_ Sequence[Isinterfaces Share Replica Share Mount Target Virtual Network Interface] - VNI for mount target.
- vpc str
- The ID of the VPC in which instances can mount the file share using this share target.This property will be removed in a future release.The
subnetproperty should be used instead.
- access
Protocol String - The protocol to use to access the share for this share mount target.
- href String
- href of mount target
- id String
- ID of this share target.
- 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.
- resource
Type String - Resource type of virtual network interface
- transit
Encryption String - The transit encryption mode.
- virtual
Network List<Property Map>Interfaces - VNI for mount target.
- vpc String
- The ID of the VPC in which instances can mount the file share using this share target.This property will be removed in a future release.The
subnetproperty should be used instead.
IsShareReplicaShareMountTargetVirtualNetworkInterface, IsShareReplicaShareMountTargetVirtualNetworkInterfaceArgs
- Allow
Ip boolSpoofing - Indicates whether source IP spoofing is allowed on this interface. If
false, source IP spoofing is prevented on this interface. Iftrue, source IP spoofing is allowed on this interface. - Auto
Delete bool - Indicates whether this virtual network interface will be automatically deleted when
targetis deleted. - Crn string
- CRN of virtual network interface
- Enable
Infrastructure boolNat - If
true:- The VPC infrastructure performs any needed NAT operations.-floating_ipsmust not have more than one floating IP.Iffalse:- Packets are passed unchanged to/from the network interface, allowing the workload to perform any needed NAT operations.-allow_ip_spoofingmust befalse.- If the virtual network interface is attached: - The targetresource_typemust bebare_metal_server_network_attachment. - The targetinterface_typemust not behipersocket. - Href string
- href of virtual network interface
- Id string
- ID of this VNI
- Name string
- Name of this VNI
- Primary
Ips List<IsShare Replica Share Mount Target Virtual Network Interface Primary Ip> - VNI for mount target.
- Protocol
State stringFiltering Mode - The protocol state filtering mode used for this virtual network interface.
- Resource
Group string - Resource group id
- Resource
Type string - Resource type of primary ip
- Security
Groups List<string> - The security groups to use for this virtual network interface.
- Subnet string
- The associated subnet. Required if primary_ip is not specified.
- Allow
Ip boolSpoofing - Indicates whether source IP spoofing is allowed on this interface. If
false, source IP spoofing is prevented on this interface. Iftrue, source IP spoofing is allowed on this interface. - Auto
Delete bool - Indicates whether this virtual network interface will be automatically deleted when
targetis deleted. - Crn string
- CRN of virtual network interface
- Enable
Infrastructure boolNat - If
true:- The VPC infrastructure performs any needed NAT operations.-floating_ipsmust not have more than one floating IP.Iffalse:- Packets are passed unchanged to/from the network interface, allowing the workload to perform any needed NAT operations.-allow_ip_spoofingmust befalse.- If the virtual network interface is attached: - The targetresource_typemust bebare_metal_server_network_attachment. - The targetinterface_typemust not behipersocket. - Href string
- href of virtual network interface
- Id string
- ID of this VNI
- Name string
- Name of this VNI
- Primary
Ips []IsShare Replica Share Mount Target Virtual Network Interface Primary Ip - VNI for mount target.
- Protocol
State stringFiltering Mode - The protocol state filtering mode used for this virtual network interface.
- Resource
Group string - Resource group id
- Resource
Type string - Resource type of primary ip
- Security
Groups []string - The security groups to use for this virtual network interface.
- Subnet string
- The associated subnet. Required if primary_ip is not specified.
- allow
Ip BooleanSpoofing - Indicates whether source IP spoofing is allowed on this interface. If
false, source IP spoofing is prevented on this interface. Iftrue, source IP spoofing is allowed on this interface. - auto
Delete Boolean - Indicates whether this virtual network interface will be automatically deleted when
targetis deleted. - crn String
- CRN of virtual network interface
- enable
Infrastructure BooleanNat - If
true:- The VPC infrastructure performs any needed NAT operations.-floating_ipsmust not have more than one floating IP.Iffalse:- Packets are passed unchanged to/from the network interface, allowing the workload to perform any needed NAT operations.-allow_ip_spoofingmust befalse.- If the virtual network interface is attached: - The targetresource_typemust bebare_metal_server_network_attachment. - The targetinterface_typemust not behipersocket. - href String
- href of virtual network interface
- id String
- ID of this VNI
- name String
- Name of this VNI
- primary
Ips List<IsShare Replica Share Mount Target Virtual Network Interface Primary Ip> - VNI for mount target.
- protocol
State StringFiltering Mode - The protocol state filtering mode used for this virtual network interface.
- resource
Group String - Resource group id
- resource
Type String - Resource type of primary ip
- security
Groups List<String> - The security groups to use for this virtual network interface.
- subnet String
- The associated subnet. Required if primary_ip is not specified.
- allow
Ip booleanSpoofing - Indicates whether source IP spoofing is allowed on this interface. If
false, source IP spoofing is prevented on this interface. Iftrue, source IP spoofing is allowed on this interface. - auto
Delete boolean - Indicates whether this virtual network interface will be automatically deleted when
targetis deleted. - crn string
- CRN of virtual network interface
- enable
Infrastructure booleanNat - If
true:- The VPC infrastructure performs any needed NAT operations.-floating_ipsmust not have more than one floating IP.Iffalse:- Packets are passed unchanged to/from the network interface, allowing the workload to perform any needed NAT operations.-allow_ip_spoofingmust befalse.- If the virtual network interface is attached: - The targetresource_typemust bebare_metal_server_network_attachment. - The targetinterface_typemust not behipersocket. - href string
- href of virtual network interface
- id string
- ID of this VNI
- name string
- Name of this VNI
- primary
Ips IsShare Replica Share Mount Target Virtual Network Interface Primary Ip[] - VNI for mount target.
- protocol
State stringFiltering Mode - The protocol state filtering mode used for this virtual network interface.
- resource
Group string - Resource group id
- resource
Type string - Resource type of primary ip
- security
Groups string[] - The security groups to use for this virtual network interface.
- subnet string
- The associated subnet. Required if primary_ip is not specified.
- allow_
ip_ boolspoofing - Indicates whether source IP spoofing is allowed on this interface. If
false, source IP spoofing is prevented on this interface. Iftrue, source IP spoofing is allowed on this interface. - auto_
delete bool - Indicates whether this virtual network interface will be automatically deleted when
targetis deleted. - crn str
- CRN of virtual network interface
- enable_
infrastructure_ boolnat - If
true:- The VPC infrastructure performs any needed NAT operations.-floating_ipsmust not have more than one floating IP.Iffalse:- Packets are passed unchanged to/from the network interface, allowing the workload to perform any needed NAT operations.-allow_ip_spoofingmust befalse.- If the virtual network interface is attached: - The targetresource_typemust bebare_metal_server_network_attachment. - The targetinterface_typemust not behipersocket. - href str
- href of virtual network interface
- id str
- ID of this VNI
- name str
- Name of this VNI
- primary_
ips Sequence[IsShare Replica Share Mount Target Virtual Network Interface Primary Ip] - VNI for mount target.
- protocol_
state_ strfiltering_ mode - The protocol state filtering mode used for this virtual network interface.
- resource_
group str - Resource group id
- resource_
type str - Resource type of primary ip
- security_
groups Sequence[str] - The security groups to use for this virtual network interface.
- subnet str
- The associated subnet. Required if primary_ip is not specified.
- allow
Ip BooleanSpoofing - Indicates whether source IP spoofing is allowed on this interface. If
false, source IP spoofing is prevented on this interface. Iftrue, source IP spoofing is allowed on this interface. - auto
Delete Boolean - Indicates whether this virtual network interface will be automatically deleted when
targetis deleted. - crn String
- CRN of virtual network interface
- enable
Infrastructure BooleanNat - If
true:- The VPC infrastructure performs any needed NAT operations.-floating_ipsmust not have more than one floating IP.Iffalse:- Packets are passed unchanged to/from the network interface, allowing the workload to perform any needed NAT operations.-allow_ip_spoofingmust befalse.- If the virtual network interface is attached: - The targetresource_typemust bebare_metal_server_network_attachment. - The targetinterface_typemust not behipersocket. - href String
- href of virtual network interface
- id String
- ID of this VNI
- name String
- Name of this VNI
- primary
Ips List<Property Map> - VNI for mount target.
- protocol
State StringFiltering Mode - The protocol state filtering mode used for this virtual network interface.
- resource
Group String - Resource group id
- resource
Type String - Resource type of primary ip
- security
Groups List<String> - The security groups to use for this virtual network interface.
- subnet String
- The associated subnet. Required if primary_ip is not specified.
IsShareReplicaShareMountTargetVirtualNetworkInterfacePrimaryIp, IsShareReplicaShareMountTargetVirtualNetworkInterfacePrimaryIpArgs
- Address string
- The IP address to reserve, which must not already be reserved on the subnet.
- Auto
Delete bool - Indicates whether this reserved IP member will be automatically deleted when either target is deleted, or the reserved IP is unbound.
- Href string
- href of primary ip
- Name string
- Name for reserved IP
- Reserved
Ip string - ID of reserved IP
- Resource
Type string - Resource type of primary ip
- Address string
- The IP address to reserve, which must not already be reserved on the subnet.
- Auto
Delete bool - Indicates whether this reserved IP member will be automatically deleted when either target is deleted, or the reserved IP is unbound.
- Href string
- href of primary ip
- Name string
- Name for reserved IP
- Reserved
Ip string - ID of reserved IP
- Resource
Type string - Resource type of primary ip
- address String
- The IP address to reserve, which must not already be reserved on the subnet.
- auto
Delete Boolean - Indicates whether this reserved IP member will be automatically deleted when either target is deleted, or the reserved IP is unbound.
- href String
- href of primary ip
- name String
- Name for reserved IP
- reserved
Ip String - ID of reserved IP
- resource
Type String - Resource type of primary ip
- address string
- The IP address to reserve, which must not already be reserved on the subnet.
- auto
Delete boolean - Indicates whether this reserved IP member will be automatically deleted when either target is deleted, or the reserved IP is unbound.
- href string
- href of primary ip
- name string
- Name for reserved IP
- reserved
Ip string - ID of reserved IP
- resource
Type string - Resource type of primary ip
- address str
- The IP address to reserve, which must not already be reserved on the subnet.
- auto_
delete bool - Indicates whether this reserved IP member will be automatically deleted when either target is deleted, or the reserved IP is unbound.
- href str
- href of primary ip
- name str
- Name for reserved IP
- reserved_
ip str - ID of reserved IP
- resource_
type str - Resource type of primary ip
- address String
- The IP address to reserve, which must not already be reserved on the subnet.
- auto
Delete Boolean - Indicates whether this reserved IP member will be automatically deleted when either target is deleted, or the reserved IP is unbound.
- href String
- href of primary ip
- name String
- Name for reserved IP
- reserved
Ip String - ID of reserved IP
- resource
Type String - Resource type of primary ip
IsShareReplicaShareReplicationStatusReason, IsShareReplicaShareReplicationStatusReasonArgs
IsShareReplicationStatusReason, IsShareReplicationStatusReasonArgs
IsShareSourceSnapshot, IsShareSourceSnapshotArgs
- Crn string
- The CRN for this share snapshot.
- Deleteds
List<Is
Share Source Snapshot Deleted> - If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.
- Href string
- The URL for this share snapshot.
- Id string
- The unique identifier for this share snapshot.
- Name string
- The name for this share snapshot. The name is unique across all snapshots for the file share.
- Resource
Type string - The resource type.
- Crn string
- The CRN for this share snapshot.
- Deleteds
[]Is
Share Source Snapshot Deleted - If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.
- Href string
- The URL for this share snapshot.
- Id string
- The unique identifier for this share snapshot.
- Name string
- The name for this share snapshot. The name is unique across all snapshots for the file share.
- Resource
Type string - The resource type.
- crn String
- The CRN for this share snapshot.
- deleteds
List<Is
Share Source Snapshot Deleted> - If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.
- href String
- The URL for this share snapshot.
- id String
- The unique identifier for this share snapshot.
- name String
- The name for this share snapshot. The name is unique across all snapshots for the file share.
- resource
Type String - The resource type.
- crn string
- The CRN for this share snapshot.
- deleteds
Is
Share Source Snapshot Deleted[] - If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.
- href string
- The URL for this share snapshot.
- id string
- The unique identifier for this share snapshot.
- name string
- The name for this share snapshot. The name is unique across all snapshots for the file share.
- resource
Type string - The resource type.
- crn str
- The CRN for this share snapshot.
- deleteds
Sequence[Is
Share Source Snapshot Deleted] - If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.
- href str
- The URL for this share snapshot.
- id str
- The unique identifier for this share snapshot.
- name str
- The name for this share snapshot. The name is unique across all snapshots for the file share.
- resource_
type str - The resource type.
- crn String
- The CRN for this share snapshot.
- deleteds List<Property Map>
- If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.
- href String
- The URL for this share snapshot.
- id String
- The unique identifier for this share snapshot.
- name String
- The name for this share snapshot. The name is unique across all snapshots for the file share.
- resource
Type String - The resource type.
IsShareSourceSnapshotDeleted, IsShareSourceSnapshotDeletedArgs
- More
Info string
- More
Info string
- more
Info String
- more
Info string
- more_
info str
- more
Info String
Package Details
- Repository
- ibm ibm-cloud/terraform-provider-ibm
- License
- Notes
- This Pulumi package is based on the
ibmTerraform Provider.
