com.pulumi.aws.storagegateway.FileSystemAssociation Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws Show documentation
Show all versions of aws Show documentation
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.aws.storagegateway;
import com.pulumi.aws.Utilities;
import com.pulumi.aws.storagegateway.FileSystemAssociationArgs;
import com.pulumi.aws.storagegateway.inputs.FileSystemAssociationState;
import com.pulumi.aws.storagegateway.outputs.FileSystemAssociationCacheAttributes;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Associate an Amazon FSx file system with the FSx File Gateway. After the association process is complete, the file shares on the Amazon FSx file system are available for access through the gateway. This operation only supports the FSx File Gateway type.
*
* [FSx File Gateway requirements](https://docs.aws.amazon.com/filegateway/latest/filefsxw/Requirements.html).
*
* ## Example Usage
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.aws.storagegateway.FileSystemAssociation;
* import com.pulumi.aws.storagegateway.FileSystemAssociationArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
*
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
*
* public static void stack(Context ctx) {
* var example = new FileSystemAssociation("example", FileSystemAssociationArgs.builder()
* .gatewayArn(exampleAwsStoragegatewayGateway.arn())
* .locationArn(exampleAwsFsxWindowsFileSystem.arn())
* .username("Admin")
* .password("avoid-plaintext-passwords")
* .auditDestinationArn(exampleAwsS3Bucket.arn())
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ## Required Services Example
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.aws.ssm.SsmFunctions;
* import com.pulumi.aws.ssm.inputs.GetParameterArgs;
* import com.pulumi.aws.ec2.Instance;
* import com.pulumi.aws.ec2.InstanceArgs;
* import com.pulumi.aws.storagegateway.Gateway;
* import com.pulumi.aws.storagegateway.GatewayArgs;
* import com.pulumi.aws.storagegateway.inputs.GatewaySmbActiveDirectorySettingsArgs;
* import com.pulumi.aws.fsx.WindowsFileSystem;
* import com.pulumi.aws.fsx.WindowsFileSystemArgs;
* import com.pulumi.aws.storagegateway.FileSystemAssociation;
* import com.pulumi.aws.storagegateway.FileSystemAssociationArgs;
* import com.pulumi.aws.storagegateway.inputs.FileSystemAssociationCacheAttributesArgs;
* import com.pulumi.resources.CustomResourceOptions;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
*
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
*
* public static void stack(Context ctx) {
* final var awsServiceStoragegatewayAmiFILES3Latest = SsmFunctions.getParameter(GetParameterArgs.builder()
* .name("/aws/service/storagegateway/ami/FILE_S3/latest")
* .build());
*
* var test = new Instance("test", InstanceArgs.builder()
* .ami(awsServiceStoragegatewayAmiFILES3Latest.applyValue(getParameterResult -> getParameterResult.value()))
* .associatePublicIpAddress(true)
* .instanceType(available.instanceType())
* .vpcSecurityGroupIds(testAwsSecurityGroup.id())
* .subnetId(testAwsSubnet[0].id())
* .build(), CustomResourceOptions.builder()
* .dependsOn(
* testAwsRoute,
* testAwsVpcDhcpOptionsAssociation)
* .build());
*
* var testGateway = new Gateway("testGateway", GatewayArgs.builder()
* .gatewayIpAddress(test.publicIp())
* .gatewayName("test-sgw")
* .gatewayTimezone("GMT")
* .gatewayType("FILE_FSX_SMB")
* .smbActiveDirectorySettings(GatewaySmbActiveDirectorySettingsArgs.builder()
* .domainName(testAwsDirectoryServiceDirectory.name())
* .password(testAwsDirectoryServiceDirectory.password())
* .username("Admin")
* .build())
* .build());
*
* var testWindowsFileSystem = new WindowsFileSystem("testWindowsFileSystem", WindowsFileSystemArgs.builder()
* .activeDirectoryId(testAwsDirectoryServiceDirectory.id())
* .securityGroupIds(testAwsSecurityGroup.id())
* .skipFinalBackup(true)
* .storageCapacity(32)
* .subnetIds(testAwsSubnet[0].id())
* .throughputCapacity(8)
* .build());
*
* var fsx = new FileSystemAssociation("fsx", FileSystemAssociationArgs.builder()
* .gatewayArn(testGateway.arn())
* .locationArn(testWindowsFileSystem.arn())
* .username("Admin")
* .password(testAwsDirectoryServiceDirectory.password())
* .cacheAttributes(FileSystemAssociationCacheAttributesArgs.builder()
* .cacheStaleTimeoutInSeconds(400)
* .build())
* .auditDestinationArn(testAwsCloudwatchLogGroup.arn())
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ## Import
*
* Using `pulumi import`, import `aws_storagegateway_file_system_association` using the FSx file system association Amazon Resource Name (ARN). For example:
*
* ```sh
* $ pulumi import aws:storagegateway/fileSystemAssociation:FileSystemAssociation example arn:aws:storagegateway:us-east-1:123456789012:fs-association/fsa-0DA347732FDB40125
* ```
*
*/
@ResourceType(type="aws:storagegateway/fileSystemAssociation:FileSystemAssociation")
public class FileSystemAssociation extends com.pulumi.resources.CustomResource {
/**
* Amazon Resource Name (ARN) of the newly created file system association.
*
*/
@Export(name="arn", refs={String.class}, tree="[0]")
private Output arn;
/**
* @return Amazon Resource Name (ARN) of the newly created file system association.
*
*/
public Output arn() {
return this.arn;
}
/**
* The Amazon Resource Name (ARN) of the storage used for the audit logs.
*
*/
@Export(name="auditDestinationArn", refs={String.class}, tree="[0]")
private Output auditDestinationArn;
/**
* @return The Amazon Resource Name (ARN) of the storage used for the audit logs.
*
*/
public Output> auditDestinationArn() {
return Codegen.optional(this.auditDestinationArn);
}
/**
* Refresh cache information. see Cache Attributes for more details.
*
*/
@Export(name="cacheAttributes", refs={FileSystemAssociationCacheAttributes.class}, tree="[0]")
private Output cacheAttributes;
/**
* @return Refresh cache information. see Cache Attributes for more details.
*
*/
public Output> cacheAttributes() {
return Codegen.optional(this.cacheAttributes);
}
/**
* The Amazon Resource Name (ARN) of the gateway.
*
*/
@Export(name="gatewayArn", refs={String.class}, tree="[0]")
private Output gatewayArn;
/**
* @return The Amazon Resource Name (ARN) of the gateway.
*
*/
public Output gatewayArn() {
return this.gatewayArn;
}
/**
* The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway.
*
*/
@Export(name="locationArn", refs={String.class}, tree="[0]")
private Output locationArn;
/**
* @return The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway.
*
*/
public Output locationArn() {
return this.locationArn;
}
/**
* The password of the user credential.
*
*/
@Export(name="password", refs={String.class}, tree="[0]")
private Output password;
/**
* @return The password of the user credential.
*
*/
public Output password() {
return this.password;
}
/**
* Key-value map of resource tags. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
*/
@Export(name="tags", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> tags;
/**
* @return Key-value map of resource tags. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
*/
public Output>> tags() {
return Codegen.optional(this.tags);
}
/**
* A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
* @deprecated
* Please use `tags` instead.
*
*/
@Deprecated /* Please use `tags` instead. */
@Export(name="tagsAll", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> tagsAll;
/**
* @return A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
*/
public Output> tagsAll() {
return this.tagsAll;
}
/**
* The user name of the user credential that has permission to access the root share of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.
*
*/
@Export(name="username", refs={String.class}, tree="[0]")
private Output username;
/**
* @return The user name of the user credential that has permission to access the root share of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.
*
*/
public Output username() {
return this.username;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public FileSystemAssociation(java.lang.String name) {
this(name, FileSystemAssociationArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public FileSystemAssociation(java.lang.String name, FileSystemAssociationArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public FileSystemAssociation(java.lang.String name, FileSystemAssociationArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:storagegateway/fileSystemAssociation:FileSystemAssociation", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private FileSystemAssociation(java.lang.String name, Output id, @Nullable FileSystemAssociationState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:storagegateway/fileSystemAssociation:FileSystemAssociation", name, state, makeResourceOptions(options, id), false);
}
private static FileSystemAssociationArgs makeArgs(FileSystemAssociationArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? FileSystemAssociationArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.additionalSecretOutputs(List.of(
"password"
))
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static FileSystemAssociation get(java.lang.String name, Output id, @Nullable FileSystemAssociationState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new FileSystemAssociation(name, id, state, options);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy