OntapStorageVirtualMachine class
Manages a FSx Storage Virtual Machine. See the FSx ONTAP User Guide for more information.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const test = new aws.fsx.OntapStorageVirtualMachine("test", {
fileSystemId: testAwsFsxOntapFileSystem.id,
name: "test",
});
import pulumi
import pulumi_aws as aws
test = aws.fsx.OntapStorageVirtualMachine("test",
file_system_id=test_aws_fsx_ontap_file_system["id"],
name="test")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var test = new Aws.Fsx.OntapStorageVirtualMachine("test", new()
{
FileSystemId = testAwsFsxOntapFileSystem.Id,
Name = "test",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/fsx"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := fsx.NewOntapStorageVirtualMachine(ctx, "test", &fsx.OntapStorageVirtualMachineArgs{
FileSystemId: pulumi.Any(testAwsFsxOntapFileSystem.Id),
Name: pulumi.String("test"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_fsx_ontapstoragevirtualmachine" "test" {
file_system_id = testAwsFsxOntapFileSystem.id
name = "test"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.fsx.OntapStorageVirtualMachine;
import com.pulumi.aws.fsx.OntapStorageVirtualMachineArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var test = new OntapStorageVirtualMachine("test", OntapStorageVirtualMachineArgs.builder()
.fileSystemId(testAwsFsxOntapFileSystem.id())
.name("test")
.build());
}
}
resources:
test:
type: aws:fsx:OntapStorageVirtualMachine
properties:
fileSystemId: ${testAwsFsxOntapFileSystem.id}
name: test
Using a Self-Managed Microsoft Active Directory
Additional information for using AWS Directory Service with ONTAP File Systems can be found in the FSx ONTAP Guide.
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const test = new aws.fsx.OntapStorageVirtualMachine("test", {
activeDirectoryConfiguration: {
selfManagedActiveDirectoryConfiguration: {
dnsIps: [
"10.0.0.111",
"10.0.0.222",
],
domainName: "corp.example.com",
password: "avoid-plaintext-passwords",
username: "Admin",
},
netbiosName: "mysvm",
},
fileSystemId: testAwsFsxOntapFileSystem.id,
name: "mysvm",
});
import pulumi
import pulumi_aws as aws
test = aws.fsx.OntapStorageVirtualMachine("test",
active_directory_configuration={
"self_managed_active_directory_configuration": {
"dns_ips": [
"10.0.0.111",
"10.0.0.222",
],
"domain_name": "corp.example.com",
"password": "avoid-plaintext-passwords",
"username": "Admin",
},
"netbios_name": "mysvm",
},
file_system_id=test_aws_fsx_ontap_file_system["id"],
name="mysvm")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var test = new Aws.Fsx.OntapStorageVirtualMachine("test", new()
{
ActiveDirectoryConfiguration = new Aws.Fsx.Inputs.OntapStorageVirtualMachineActiveDirectoryConfigurationArgs
{
SelfManagedActiveDirectoryConfiguration = new Aws.Fsx.Inputs.OntapStorageVirtualMachineActiveDirectoryConfigurationSelfManagedActiveDirectoryConfigurationArgs
{
DnsIps = new[]
{
"10.0.0.111",
"10.0.0.222",
},
DomainName = "corp.example.com",
Password = "avoid-plaintext-passwords",
Username = "Admin",
},
NetbiosName = "mysvm",
},
FileSystemId = testAwsFsxOntapFileSystem.Id,
Name = "mysvm",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/fsx"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := fsx.NewOntapStorageVirtualMachine(ctx, "test", &fsx.OntapStorageVirtualMachineArgs{
ActiveDirectoryConfiguration: &fsx.OntapStorageVirtualMachineActiveDirectoryConfigurationArgs{
SelfManagedActiveDirectoryConfiguration: &fsx.OntapStorageVirtualMachineActiveDirectoryConfigurationSelfManagedActiveDirectoryConfigurationArgs{
DnsIps: pulumi.StringArray{
pulumi.String("10.0.0.111"),
pulumi.String("10.0.0.222"),
},
DomainName: pulumi.String("corp.example.com"),
Password: pulumi.String("avoid-plaintext-passwords"),
Username: pulumi.String("Admin"),
},
NetbiosName: pulumi.String("mysvm"),
},
FileSystemId: pulumi.Any(testAwsFsxOntapFileSystem.Id),
Name: pulumi.String("mysvm"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_fsx_ontapstoragevirtualmachine" "test" {
active_directory_configuration = {
self_managed_active_directory_configuration = {
dns_ips = ["10.0.0.111", "10.0.0.222"]
domain_name = "corp.example.com"
password = "avoid-plaintext-passwords"
username = "Admin"
}
netbios_name = "mysvm"
}
file_system_id = testAwsFsxOntapFileSystem.id
name = "mysvm"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.fsx.OntapStorageVirtualMachine;
import com.pulumi.aws.fsx.OntapStorageVirtualMachineArgs;
import com.pulumi.aws.fsx.inputs.OntapStorageVirtualMachineActiveDirectoryConfigurationArgs;
import com.pulumi.aws.fsx.inputs.OntapStorageVirtualMachineActiveDirectoryConfigurationSelfManagedActiveDirectoryConfigurationArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var test = new OntapStorageVirtualMachine("test", OntapStorageVirtualMachineArgs.builder()
.activeDirectoryConfiguration(OntapStorageVirtualMachineActiveDirectoryConfigurationArgs.builder()
.selfManagedActiveDirectoryConfiguration(OntapStorageVirtualMachineActiveDirectoryConfigurationSelfManagedActiveDirectoryConfigurationArgs.builder()
.dnsIps(
"10.0.0.111",
"10.0.0.222")
.domainName("corp.example.com")
.password("avoid-plaintext-passwords")
.username("Admin")
.build())
.netbiosName("mysvm")
.build())
.fileSystemId(testAwsFsxOntapFileSystem.id())
.name("mysvm")
.build());
}
}
resources:
test:
type: aws:fsx:OntapStorageVirtualMachine
properties:
activeDirectoryConfiguration:
selfManagedActiveDirectoryConfiguration:
dnsIps:
- 10.0.0.111
- 10.0.0.222
domainName: corp.example.com
password: avoid-plaintext-passwords
username: Admin
netbiosName: mysvm
fileSystemId: ${testAwsFsxOntapFileSystem.id}
name: mysvm
Import
Using pulumi import, import FSx Storage Virtual Machine using the id. For example:
$ pulumi import aws:fsx/ontapStorageVirtualMachine:OntapStorageVirtualMachine example svm-12345678abcdef123
Certain resource arguments, like svmAdminPassword and the selfManagedActiveDirectory configuation block password, do not have a FSx API method for reading the information after creation. If these arguments are set in the Pulumi program on an imported resource, Pulumi will always show a difference. To workaround this behavior, either omit the argument from the Pulumi program or use ignoreChanges to hide the difference. For example:
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.fsx.OntapStorageVirtualMachine("example", {svmAdminPassword: "avoid-plaintext-passwords"}, {
ignoreChanges: ["svmAdminPassword"],
});
import pulumi
import pulumi_aws as aws
example = aws.fsx.OntapStorageVirtualMachine("example", svm_admin_password="avoid-plaintext-passwords",
opts = pulumi.ResourceOptions(ignore_changes=["svmAdminPassword"]))
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Fsx.OntapStorageVirtualMachine("example", new()
{
SvmAdminPassword = "avoid-plaintext-passwords",
}, new CustomResourceOptions
{
IgnoreChanges =
{
"svmAdminPassword",
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/fsx"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := fsx.NewOntapStorageVirtualMachine(ctx, "example", &fsx.OntapStorageVirtualMachineArgs{
SvmAdminPassword: pulumi.String("avoid-plaintext-passwords"),
}, pulumi.IgnoreChanges([]string{
"svmAdminPassword",
}))
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_fsx_ontapstoragevirtualmachine" "example" {
lifecycle {
ignore_changes = [svmAdminPassword]
}
svm_admin_password = "avoid-plaintext-passwords"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.fsx.OntapStorageVirtualMachine;
import com.pulumi.aws.fsx.OntapStorageVirtualMachineArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new OntapStorageVirtualMachine("example", OntapStorageVirtualMachineArgs.builder()
.svmAdminPassword("avoid-plaintext-passwords")
.build(), CustomResourceOptions.builder()
.ignoreChanges("svmAdminPassword")
.build());
}
}
resources:
example:
type: aws:fsx:OntapStorageVirtualMachine
properties:
svmAdminPassword: avoid-plaintext-passwords
options:
ignoreChanges:
- svmAdminPassword
Constructors
- OntapStorageVirtualMachine(String name, {OntapStorageVirtualMachineArgs? args, CustomResourceOptions? options})
-
Creates a new OntapStorageVirtualMachine.
nameThe Pulumi resource name.argsArguments used to configure this OntapStorageVirtualMachine. The set of arguments for OntapStorageVirtualMachine.optionsResource options controlling this resource's behavior. - OntapStorageVirtualMachine.reference(String urn)
- Creates a typed reference to an existing OntapStorageVirtualMachine resource.
Properties
-
activeDirectoryConfiguration
↔ Output<
OntapStorageVirtualMachineActiveDirectoryConfiguration?> -
Configuration block that Amazon FSx uses to join the FSx ONTAP Storage Virtual Machine(SVM) to your Microsoft Active Directory (AD) directory. Detailed below.
latefinal
-
arn
↔ Output<
String> -
ARN of the storage virtual machine.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
endpoints
↔ Output<
List< OntapStorageVirtualMachineEndpoint> > -
Endpoints that are used to access data or to manage the storage virtual machine using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See
endpointsbelow.latefinal -
fileSystemId
↔ Output<
String> -
ID of the Amazon FSx ONTAP File System that this SVM will be created on.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
name
↔ Output<
String> -
Name of the SVM. You can use a maximum of 47 alphanumeric characters, plus the underscore (_) special character.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
-
rootVolumeSecurityStyle
↔ Output<
String?> -
Root volume security style. Valid values are
UNIX,NTFS, andMIXED. All volumes created under this SVM will inherit the root security style unless the security style is specified on the volume. Default value isUNIX.latefinal - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
subtype
↔ Output<
String> -
SVM's subtype, e.g.
DEFAULTlatefinal -
svmAdminPassword
↔ Output<
String?> -
Password to use when logging on to the SVM using a secure shell (SSH) connection to the SVM's management endpoint. Doing so enables you to manage the SVM using the NetApp ONTAP CLI or REST API. If you do not specify a password, you can still use the file system's fsxadmin user to manage the SVM.
latefinal
-
Map of tags to assign to the storage virtual machine. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
uuid
↔ Output<
String> -
SVM's UUID (universally unique identifier).
latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {OntapStorageVirtualMachineState? state, CustomResourceOptions? options}) → OntapStorageVirtualMachine -
Gets an existing OntapStorageVirtualMachine resource's state with the given
nameandid.