efs

package
v1.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 6, 2019 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Overview

nolint: lll Package efs exports types, functions, subpackages for provisioning efs resources.

> This provider is a derived work of the [Terraform Provider](https://github.com/terraform-providers/terraform-provider-aws) > distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature, > first check the [`pulumi/pulumi-aws` repo](https://github.com/pulumi/pulumi-aws/issues); however, if that doesn't turn up anything, > please consult the source [`terraform-providers/terraform-provider-aws` repo](https://github.com/terraform-providers/terraform-provider-aws/issues).

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type FileSystem 

type FileSystem struct {
	// contains filtered or unexported fields
}

Provides an Elastic File System (EFS) resource.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/efs_file_system.html.markdown.

func GetFileSystem 

func GetFileSystem(ctx *pulumi.Context,
	name string, id pulumi.ID, state *FileSystemState, opts ...pulumi.ResourceOpt) (*FileSystem, error)

GetFileSystem gets an existing FileSystem resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewFileSystem 

func NewFileSystem(ctx *pulumi.Context,
	name string, args *FileSystemArgs, opts ...pulumi.ResourceOpt) (*FileSystem, error)

NewFileSystem registers a new resource with the given unique name, arguments, and options.

func (*FileSystem) Arn added in v0.16.3 

func (r *FileSystem) Arn() *pulumi.StringOutput

Amazon Resource Name of the file system.

func (*FileSystem) CreationToken 

func (r *FileSystem) CreationToken() *pulumi.StringOutput

A unique name (a maximum of 64 characters are allowed) used as reference when creating the Elastic File System to ensure idempotent file system creation. By default generated by this provider. See [Elastic File System] (http://docs.aws.amazon.com/efs/latest/ug/) user guide for more information.

func (*FileSystem) DnsName 

func (r *FileSystem) DnsName() *pulumi.StringOutput

The DNS name for the filesystem per [documented convention](http://docs.aws.amazon.com/efs/latest/ug/mounting-fs-mount-cmd-dns-name.html).

func (*FileSystem) Encrypted 

func (r *FileSystem) Encrypted() *pulumi.BoolOutput

If true, the disk will be encrypted.

func (*FileSystem) ID 

func (r *FileSystem) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*FileSystem) KmsKeyId 

func (r *FileSystem) KmsKeyId() *pulumi.StringOutput

The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.

func (*FileSystem) LifecyclePolicy added in v0.18.27 

func (r *FileSystem) LifecyclePolicy() *pulumi.Output

A file system [lifecycle policy](https://docs.aws.amazon.com/efs/latest/ug/API_LifecyclePolicy.html) object (documented below).

func (*FileSystem) PerformanceMode 

func (r *FileSystem) PerformanceMode() *pulumi.StringOutput

The file system performance mode. Can be either `"generalPurpose"` or `"maxIO"` (Default: `"generalPurpose"`).

func (*FileSystem) ProvisionedThroughputInMibps added in v0.15.1 

func (r *FileSystem) ProvisionedThroughputInMibps() *pulumi.Float64Output

The throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with `throughputMode` set to `provisioned`.

func (*FileSystem) Tags 

func (r *FileSystem) Tags() *pulumi.MapOutput

A mapping of tags to assign to the file system.

func (*FileSystem) ThroughputMode added in v0.15.1 

func (r *FileSystem) ThroughputMode() *pulumi.StringOutput

Throughput mode for the file system. Defaults to `bursting`. Valid values: `bursting`, `provisioned`. When using `provisioned`, also set `provisionedThroughputInMibps`.

func (*FileSystem) URN 

func (r *FileSystem) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type FileSystemArgs 

type FileSystemArgs struct {
	// A unique name (a maximum of 64 characters are allowed)
	// used as reference when creating the Elastic File System to ensure idempotent file
	// system creation. By default generated by this provider. See [Elastic File System]
	// (http://docs.aws.amazon.com/efs/latest/ug/) user guide for more information.
	CreationToken interface{}
	// If true, the disk will be encrypted.
	Encrypted interface{}
	// The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.
	KmsKeyId interface{}
	// A file system [lifecycle policy](https://docs.aws.amazon.com/efs/latest/ug/API_LifecyclePolicy.html) object (documented below).
	LifecyclePolicy interface{}
	// The file system performance mode. Can be either `"generalPurpose"` or `"maxIO"` (Default: `"generalPurpose"`).
	PerformanceMode interface{}
	// The throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with `throughputMode` set to `provisioned`.
	ProvisionedThroughputInMibps interface{}
	// A mapping of tags to assign to the file system.
	Tags interface{}
	// Throughput mode for the file system. Defaults to `bursting`. Valid values: `bursting`, `provisioned`. When using `provisioned`, also set `provisionedThroughputInMibps`.
	ThroughputMode interface{}
}

The set of arguments for constructing a FileSystem resource.

type FileSystemState 

type FileSystemState struct {
	// Amazon Resource Name of the file system.
	Arn interface{}
	// A unique name (a maximum of 64 characters are allowed)
	// used as reference when creating the Elastic File System to ensure idempotent file
	// system creation. By default generated by this provider. See [Elastic File System]
	// (http://docs.aws.amazon.com/efs/latest/ug/) user guide for more information.
	CreationToken interface{}
	// The DNS name for the filesystem per [documented convention](http://docs.aws.amazon.com/efs/latest/ug/mounting-fs-mount-cmd-dns-name.html).
	DnsName interface{}
	// If true, the disk will be encrypted.
	Encrypted interface{}
	// The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.
	KmsKeyId interface{}
	// A file system [lifecycle policy](https://docs.aws.amazon.com/efs/latest/ug/API_LifecyclePolicy.html) object (documented below).
	LifecyclePolicy interface{}
	// The file system performance mode. Can be either `"generalPurpose"` or `"maxIO"` (Default: `"generalPurpose"`).
	PerformanceMode interface{}
	// The throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with `throughputMode` set to `provisioned`.
	ProvisionedThroughputInMibps interface{}
	// A mapping of tags to assign to the file system.
	Tags interface{}
	// Throughput mode for the file system. Defaults to `bursting`. Valid values: `bursting`, `provisioned`. When using `provisioned`, also set `provisionedThroughputInMibps`.
	ThroughputMode interface{}
}

Input properties used for looking up and filtering FileSystem resources.

type GetFileSystemArgs 

type GetFileSystemArgs struct {
	// Restricts the list to the file system with this creation token.
	CreationToken interface{}
	// The ID that identifies the file system (e.g. fs-ccfc0d65).
	FileSystemId interface{}
	Tags         interface{}
}

A collection of arguments for invoking getFileSystem.

type GetFileSystemResult 

type GetFileSystemResult struct {
	// Amazon Resource Name of the file system.
	Arn           interface{}
	CreationToken interface{}
	// The DNS name for the filesystem per [documented convention](http://docs.aws.amazon.com/efs/latest/ug/mounting-fs-mount-cmd-dns-name.html).
	DnsName interface{}
	// Whether EFS is encrypted.
	Encrypted    interface{}
	FileSystemId interface{}
	// The ARN for the KMS encryption key.
	KmsKeyId interface{}
	// The PerformanceMode of the file system.
	PerformanceMode interface{}
	// The list of tags assigned to the file system.
	Tags interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getFileSystem.

func LookupFileSystem 

func LookupFileSystem(ctx *pulumi.Context, args *GetFileSystemArgs) (*GetFileSystemResult, error)

Provides information about an Elastic File System (EFS).

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/d/efs_file_system.html.markdown.

type GetMountTargetArgs 

type GetMountTargetArgs struct {
	// ID of the mount target that you want to have described
	MountTargetId interface{}
}

A collection of arguments for invoking getMountTarget.

type GetMountTargetResult 

type GetMountTargetResult struct {
	// The DNS name for the given subnet/AZ per [documented convention](http://docs.aws.amazon.com/efs/latest/ug/mounting-fs-mount-cmd-dns-name.html).
	DnsName interface{}
	// Amazon Resource Name of the file system for which the mount target is intended.
	FileSystemArn interface{}
	// ID of the file system for which the mount target is intended.
	FileSystemId interface{}
	// Address at which the file system may be mounted via the mount target.
	IpAddress     interface{}
	MountTargetId interface{}
	// The ID of the network interface that Amazon EFS created when it created the mount target.
	NetworkInterfaceId interface{}
	// List of VPC security group IDs attached to the mount target.
	SecurityGroups interface{}
	// ID of the mount target's subnet.
	SubnetId interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getMountTarget.

func LookupMountTarget 

func LookupMountTarget(ctx *pulumi.Context, args *GetMountTargetArgs) (*GetMountTargetResult, error)

Provides information about an Elastic File System Mount Target (EFS).

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/d/efs_mount_target.html.markdown.

type MountTarget 

type MountTarget struct {
	// contains filtered or unexported fields
}

Provides an Elastic File System (EFS) mount target.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/efs_mount_target.html.markdown.

func GetMountTarget 

func GetMountTarget(ctx *pulumi.Context,
	name string, id pulumi.ID, state *MountTargetState, opts ...pulumi.ResourceOpt) (*MountTarget, error)

GetMountTarget gets an existing MountTarget resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewMountTarget 

func NewMountTarget(ctx *pulumi.Context,
	name string, args *MountTargetArgs, opts ...pulumi.ResourceOpt) (*MountTarget, error)

NewMountTarget registers a new resource with the given unique name, arguments, and options.

func (*MountTarget) DnsName 

func (r *MountTarget) DnsName() *pulumi.StringOutput

The DNS name for the given subnet/AZ per [documented convention](http://docs.aws.amazon.com/efs/latest/ug/mounting-fs-mount-cmd-dns-name.html).

func (*MountTarget) FileSystemArn added in v0.16.3 

func (r *MountTarget) FileSystemArn() *pulumi.StringOutput

Amazon Resource Name of the file system.

func (*MountTarget) FileSystemId 

func (r *MountTarget) FileSystemId() *pulumi.StringOutput

The ID of the file system for which the mount target is intended.

func (*MountTarget) ID 

func (r *MountTarget) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*MountTarget) IpAddress 

func (r *MountTarget) IpAddress() *pulumi.StringOutput

The address (within the address range of the specified subnet) at which the file system may be mounted via the mount target.

func (*MountTarget) NetworkInterfaceId 

func (r *MountTarget) NetworkInterfaceId() *pulumi.StringOutput

The ID of the network interface that Amazon EFS created when it created the mount target.

func (*MountTarget) SecurityGroups 

func (r *MountTarget) SecurityGroups() *pulumi.ArrayOutput

A list of up to 5 VPC security group IDs (that must be for the same VPC as subnet specified) in effect for the mount target.

func (*MountTarget) SubnetId 

func (r *MountTarget) SubnetId() *pulumi.StringOutput

The ID of the subnet to add the mount target in.

func (*MountTarget) URN 

func (r *MountTarget) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type MountTargetArgs 

type MountTargetArgs struct {
	// The ID of the file system for which the mount target is intended.
	FileSystemId interface{}
	// The address (within the address range of the specified subnet) at
	// which the file system may be mounted via the mount target.
	IpAddress interface{}
	// A list of up to 5 VPC security group IDs (that must
	// be for the same VPC as subnet specified) in effect for the mount target.
	SecurityGroups interface{}
	// The ID of the subnet to add the mount target in.
	SubnetId interface{}
}

The set of arguments for constructing a MountTarget resource.

type MountTargetState 

type MountTargetState struct {
	// The DNS name for the given subnet/AZ per [documented convention](http://docs.aws.amazon.com/efs/latest/ug/mounting-fs-mount-cmd-dns-name.html).
	DnsName interface{}
	// Amazon Resource Name of the file system.
	FileSystemArn interface{}
	// The ID of the file system for which the mount target is intended.
	FileSystemId interface{}
	// The address (within the address range of the specified subnet) at
	// which the file system may be mounted via the mount target.
	IpAddress interface{}
	// The ID of the network interface that Amazon EFS created when it created the mount target.
	NetworkInterfaceId interface{}
	// A list of up to 5 VPC security group IDs (that must
	// be for the same VPC as subnet specified) in effect for the mount target.
	SecurityGroups interface{}
	// The ID of the subnet to add the mount target in.
	SubnetId interface{}
}

Input properties used for looking up and filtering MountTarget resources.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.