efs

package
v2.2.0 Latest Latest
Warning

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

 Go to latest Published: Apr 28, 2020 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type FileSystem 

type FileSystem struct {
	pulumi.CustomResourceState

	// Amazon Resource Name of the file system.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// 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 pulumi.StringOutput `pulumi:"creationToken"`
	// 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 pulumi.StringOutput `pulumi:"dnsName"`
	// If true, the disk will be encrypted.
	Encrypted pulumi.BoolOutput `pulumi:"encrypted"`
	// The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.
	KmsKeyId pulumi.StringOutput `pulumi:"kmsKeyId"`
	// A file system [lifecycle policy](https://docs.aws.amazon.com/efs/latest/ug/API_LifecyclePolicy.html) object (documented below).
	LifecyclePolicy FileSystemLifecyclePolicyPtrOutput `pulumi:"lifecyclePolicy"`
	// The file system performance mode. Can be either `"generalPurpose"` or `"maxIO"` (Default: `"generalPurpose"`).
	PerformanceMode pulumi.StringOutput `pulumi:"performanceMode"`
	// The throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with `throughputMode` set to `provisioned`.
	ProvisionedThroughputInMibps pulumi.Float64PtrOutput `pulumi:"provisionedThroughputInMibps"`
	// A mapping of tags to assign to the file system.
	Tags pulumi.MapOutput `pulumi:"tags"`
	// Throughput mode for the file system. Defaults to `bursting`. Valid values: `bursting`, `provisioned`. When using `provisioned`, also set `provisionedThroughputInMibps`.
	ThroughputMode pulumi.StringPtrOutput `pulumi:"throughputMode"`
}

Provides an Elastic File System (EFS) resource.

func GetFileSystem 

func GetFileSystem(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *FileSystemState, opts ...pulumi.ResourceOption) (*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.ResourceOption) (*FileSystem, error)

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

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 pulumi.StringPtrInput
	// If true, the disk will be encrypted.
	Encrypted pulumi.BoolPtrInput
	// The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.
	KmsKeyId pulumi.StringPtrInput
	// A file system [lifecycle policy](https://docs.aws.amazon.com/efs/latest/ug/API_LifecyclePolicy.html) object (documented below).
	LifecyclePolicy FileSystemLifecyclePolicyPtrInput
	// The file system performance mode. Can be either `"generalPurpose"` or `"maxIO"` (Default: `"generalPurpose"`).
	PerformanceMode pulumi.StringPtrInput
	// The throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with `throughputMode` set to `provisioned`.
	ProvisionedThroughputInMibps pulumi.Float64PtrInput
	// A mapping of tags to assign to the file system.
	Tags pulumi.MapInput
	// Throughput mode for the file system. Defaults to `bursting`. Valid values: `bursting`, `provisioned`. When using `provisioned`, also set `provisionedThroughputInMibps`.
	ThroughputMode pulumi.StringPtrInput
}

The set of arguments for constructing a FileSystem resource.

func (FileSystemArgs) ElementType 

func (FileSystemArgs) ElementType() reflect.Type

type FileSystemLifecyclePolicy 

type FileSystemLifecyclePolicy struct {
	// Indicates how long it takes to transition files to the IA storage class. Valid values: `AFTER_7_DAYS`, `AFTER_14_DAYS`, `AFTER_30_DAYS`, `AFTER_60_DAYS`, or `AFTER_90_DAYS`.
	TransitionToIa *string `pulumi:"transitionToIa"`
}

type FileSystemLifecyclePolicyArgs 

type FileSystemLifecyclePolicyArgs struct {
	// Indicates how long it takes to transition files to the IA storage class. Valid values: `AFTER_7_DAYS`, `AFTER_14_DAYS`, `AFTER_30_DAYS`, `AFTER_60_DAYS`, or `AFTER_90_DAYS`.
	TransitionToIa pulumi.StringPtrInput `pulumi:"transitionToIa"`
}

func (FileSystemLifecyclePolicyArgs) ElementType 

func (FileSystemLifecyclePolicyArgs) ElementType() reflect.Type

func (FileSystemLifecyclePolicyArgs) ToFileSystemLifecyclePolicyOutput 

func (i FileSystemLifecyclePolicyArgs) ToFileSystemLifecyclePolicyOutput() FileSystemLifecyclePolicyOutput

func (FileSystemLifecyclePolicyArgs) ToFileSystemLifecyclePolicyOutputWithContext 

func (i FileSystemLifecyclePolicyArgs) ToFileSystemLifecyclePolicyOutputWithContext(ctx context.Context) FileSystemLifecyclePolicyOutput

func (FileSystemLifecyclePolicyArgs) ToFileSystemLifecyclePolicyPtrOutput 

func (i FileSystemLifecyclePolicyArgs) ToFileSystemLifecyclePolicyPtrOutput() FileSystemLifecyclePolicyPtrOutput

func (FileSystemLifecyclePolicyArgs) ToFileSystemLifecyclePolicyPtrOutputWithContext 

func (i FileSystemLifecyclePolicyArgs) ToFileSystemLifecyclePolicyPtrOutputWithContext(ctx context.Context) FileSystemLifecyclePolicyPtrOutput

type FileSystemLifecyclePolicyInput 

type FileSystemLifecyclePolicyInput interface {
	pulumi.Input

	ToFileSystemLifecyclePolicyOutput() FileSystemLifecyclePolicyOutput
	ToFileSystemLifecyclePolicyOutputWithContext(context.Context) FileSystemLifecyclePolicyOutput
}

FileSystemLifecyclePolicyInput is an input type that accepts FileSystemLifecyclePolicyArgs and FileSystemLifecyclePolicyOutput values. You can construct a concrete instance of `FileSystemLifecyclePolicyInput` via: 

FileSystemLifecyclePolicyArgs{...}

type FileSystemLifecyclePolicyOutput 

type FileSystemLifecyclePolicyOutput struct{ *pulumi.OutputState }

func (FileSystemLifecyclePolicyOutput) ElementType 

func (FileSystemLifecyclePolicyOutput) ElementType() reflect.Type

func (FileSystemLifecyclePolicyOutput) ToFileSystemLifecyclePolicyOutput 

func (o FileSystemLifecyclePolicyOutput) ToFileSystemLifecyclePolicyOutput() FileSystemLifecyclePolicyOutput

func (FileSystemLifecyclePolicyOutput) ToFileSystemLifecyclePolicyOutputWithContext 

func (o FileSystemLifecyclePolicyOutput) ToFileSystemLifecyclePolicyOutputWithContext(ctx context.Context) FileSystemLifecyclePolicyOutput

func (FileSystemLifecyclePolicyOutput) ToFileSystemLifecyclePolicyPtrOutput 

func (o FileSystemLifecyclePolicyOutput) ToFileSystemLifecyclePolicyPtrOutput() FileSystemLifecyclePolicyPtrOutput

func (FileSystemLifecyclePolicyOutput) ToFileSystemLifecyclePolicyPtrOutputWithContext 

func (o FileSystemLifecyclePolicyOutput) ToFileSystemLifecyclePolicyPtrOutputWithContext(ctx context.Context) FileSystemLifecyclePolicyPtrOutput

func (FileSystemLifecyclePolicyOutput) TransitionToIa 

func (o FileSystemLifecyclePolicyOutput) TransitionToIa() pulumi.StringPtrOutput

Indicates how long it takes to transition files to the IA storage class. Valid values: `AFTER_7_DAYS`, `AFTER_14_DAYS`, `AFTER_30_DAYS`, `AFTER_60_DAYS`, or `AFTER_90_DAYS`.

type FileSystemLifecyclePolicyPtrInput 

type FileSystemLifecyclePolicyPtrInput interface {
	pulumi.Input

	ToFileSystemLifecyclePolicyPtrOutput() FileSystemLifecyclePolicyPtrOutput
	ToFileSystemLifecyclePolicyPtrOutputWithContext(context.Context) FileSystemLifecyclePolicyPtrOutput
}

FileSystemLifecyclePolicyPtrInput is an input type that accepts FileSystemLifecyclePolicyArgs, FileSystemLifecyclePolicyPtr and FileSystemLifecyclePolicyPtrOutput values. You can construct a concrete instance of `FileSystemLifecyclePolicyPtrInput` via: 

		 FileSystemLifecyclePolicyArgs{...}

 or:

		 nil

func FileSystemLifecyclePolicyPtr 

func FileSystemLifecyclePolicyPtr(v *FileSystemLifecyclePolicyArgs) FileSystemLifecyclePolicyPtrInput

type FileSystemLifecyclePolicyPtrOutput 

type FileSystemLifecyclePolicyPtrOutput struct{ *pulumi.OutputState }

func (FileSystemLifecyclePolicyPtrOutput) Elem 

func (o FileSystemLifecyclePolicyPtrOutput) Elem() FileSystemLifecyclePolicyOutput

func (FileSystemLifecyclePolicyPtrOutput) ElementType 

func (FileSystemLifecyclePolicyPtrOutput) ElementType() reflect.Type

func (FileSystemLifecyclePolicyPtrOutput) ToFileSystemLifecyclePolicyPtrOutput 

func (o FileSystemLifecyclePolicyPtrOutput) ToFileSystemLifecyclePolicyPtrOutput() FileSystemLifecyclePolicyPtrOutput

func (FileSystemLifecyclePolicyPtrOutput) ToFileSystemLifecyclePolicyPtrOutputWithContext 

func (o FileSystemLifecyclePolicyPtrOutput) ToFileSystemLifecyclePolicyPtrOutputWithContext(ctx context.Context) FileSystemLifecyclePolicyPtrOutput

func (FileSystemLifecyclePolicyPtrOutput) TransitionToIa 

func (o FileSystemLifecyclePolicyPtrOutput) TransitionToIa() pulumi.StringPtrOutput

Indicates how long it takes to transition files to the IA storage class. Valid values: `AFTER_7_DAYS`, `AFTER_14_DAYS`, `AFTER_30_DAYS`, `AFTER_60_DAYS`, or `AFTER_90_DAYS`.

type FileSystemState 

type FileSystemState struct {
	// Amazon Resource Name of the file system.
	Arn pulumi.StringPtrInput
	// 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 pulumi.StringPtrInput
	// 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 pulumi.StringPtrInput
	// If true, the disk will be encrypted.
	Encrypted pulumi.BoolPtrInput
	// The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.
	KmsKeyId pulumi.StringPtrInput
	// A file system [lifecycle policy](https://docs.aws.amazon.com/efs/latest/ug/API_LifecyclePolicy.html) object (documented below).
	LifecyclePolicy FileSystemLifecyclePolicyPtrInput
	// The file system performance mode. Can be either `"generalPurpose"` or `"maxIO"` (Default: `"generalPurpose"`).
	PerformanceMode pulumi.StringPtrInput
	// The throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with `throughputMode` set to `provisioned`.
	ProvisionedThroughputInMibps pulumi.Float64PtrInput
	// A mapping of tags to assign to the file system.
	Tags pulumi.MapInput
	// Throughput mode for the file system. Defaults to `bursting`. Valid values: `bursting`, `provisioned`. When using `provisioned`, also set `provisionedThroughputInMibps`.
	ThroughputMode pulumi.StringPtrInput
}

func (FileSystemState) ElementType 

func (FileSystemState) ElementType() reflect.Type

type GetFileSystemLifecyclePolicy 

type GetFileSystemLifecyclePolicy struct {
	TransitionToIa string `pulumi:"transitionToIa"`
}

type GetFileSystemLifecyclePolicyArgs 

type GetFileSystemLifecyclePolicyArgs struct {
	TransitionToIa pulumi.StringInput `pulumi:"transitionToIa"`
}

func (GetFileSystemLifecyclePolicyArgs) ElementType 

func (GetFileSystemLifecyclePolicyArgs) ElementType() reflect.Type

func (GetFileSystemLifecyclePolicyArgs) ToGetFileSystemLifecyclePolicyOutput 

func (i GetFileSystemLifecyclePolicyArgs) ToGetFileSystemLifecyclePolicyOutput() GetFileSystemLifecyclePolicyOutput

func (GetFileSystemLifecyclePolicyArgs) ToGetFileSystemLifecyclePolicyOutputWithContext 

func (i GetFileSystemLifecyclePolicyArgs) ToGetFileSystemLifecyclePolicyOutputWithContext(ctx context.Context) GetFileSystemLifecyclePolicyOutput

type GetFileSystemLifecyclePolicyInput 

type GetFileSystemLifecyclePolicyInput interface {
	pulumi.Input

	ToGetFileSystemLifecyclePolicyOutput() GetFileSystemLifecyclePolicyOutput
	ToGetFileSystemLifecyclePolicyOutputWithContext(context.Context) GetFileSystemLifecyclePolicyOutput
}

GetFileSystemLifecyclePolicyInput is an input type that accepts GetFileSystemLifecyclePolicyArgs and GetFileSystemLifecyclePolicyOutput values. You can construct a concrete instance of `GetFileSystemLifecyclePolicyInput` via: 

GetFileSystemLifecyclePolicyArgs{...}

type GetFileSystemLifecyclePolicyOutput 

type GetFileSystemLifecyclePolicyOutput struct{ *pulumi.OutputState }

func (GetFileSystemLifecyclePolicyOutput) ElementType 

func (GetFileSystemLifecyclePolicyOutput) ElementType() reflect.Type

func (GetFileSystemLifecyclePolicyOutput) ToGetFileSystemLifecyclePolicyOutput 

func (o GetFileSystemLifecyclePolicyOutput) ToGetFileSystemLifecyclePolicyOutput() GetFileSystemLifecyclePolicyOutput

func (GetFileSystemLifecyclePolicyOutput) ToGetFileSystemLifecyclePolicyOutputWithContext 

func (o GetFileSystemLifecyclePolicyOutput) ToGetFileSystemLifecyclePolicyOutputWithContext(ctx context.Context) GetFileSystemLifecyclePolicyOutput

func (GetFileSystemLifecyclePolicyOutput) TransitionToIa 

func (o GetFileSystemLifecyclePolicyOutput) TransitionToIa() pulumi.StringOutput

type LookupFileSystemArgs 

type LookupFileSystemArgs struct {
	// Restricts the list to the file system with this creation token.
	CreationToken *string `pulumi:"creationToken"`
	// The ID that identifies the file system (e.g. fs-ccfc0d65).
	FileSystemId *string                `pulumi:"fileSystemId"`
	Tags         map[string]interface{} `pulumi:"tags"`
}

A collection of arguments for invoking getFileSystem.

type LookupFileSystemResult 

type LookupFileSystemResult struct {
	// Amazon Resource Name of the file system.
	Arn           string `pulumi:"arn"`
	CreationToken string `pulumi:"creationToken"`
	// 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 string `pulumi:"dnsName"`
	// Whether EFS is encrypted.
	Encrypted    bool   `pulumi:"encrypted"`
	FileSystemId string `pulumi:"fileSystemId"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The ARN for the KMS encryption key.
	KmsKeyId string `pulumi:"kmsKeyId"`
	// A file system [lifecycle policy](https://docs.aws.amazon.com/efs/latest/ug/API_LifecyclePolicy.html) object.
	LifecyclePolicy GetFileSystemLifecyclePolicy `pulumi:"lifecyclePolicy"`
	// The file system performance mode.
	PerformanceMode string `pulumi:"performanceMode"`
	// The throughput, measured in MiB/s, that you want to provision for the file system.
	// * `tags` -A mapping of tags to assign to the file system.
	ProvisionedThroughputInMibps float64                `pulumi:"provisionedThroughputInMibps"`
	Tags                         map[string]interface{} `pulumi:"tags"`
	// Throughput mode for the file system.
	ThroughputMode string `pulumi:"throughputMode"`
}

A collection of values returned by getFileSystem.

func LookupFileSystem 

func LookupFileSystem(ctx *pulumi.Context, args *LookupFileSystemArgs, opts ...pulumi.InvokeOption) (*LookupFileSystemResult, error)

Provides information about an Elastic File System (EFS).

type LookupMountTargetArgs 

type LookupMountTargetArgs struct {
	// ID of the mount target that you want to have described
	MountTargetId string `pulumi:"mountTargetId"`
}

A collection of arguments for invoking getMountTarget.

type LookupMountTargetResult 

type LookupMountTargetResult 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 string `pulumi:"dnsName"`
	// Amazon Resource Name of the file system for which the mount target is intended.
	FileSystemArn string `pulumi:"fileSystemArn"`
	// ID of the file system for which the mount target is intended.
	FileSystemId string `pulumi:"fileSystemId"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// Address at which the file system may be mounted via the mount target.
	IpAddress     string `pulumi:"ipAddress"`
	MountTargetId string `pulumi:"mountTargetId"`
	// The ID of the network interface that Amazon EFS created when it created the mount target.
	NetworkInterfaceId string `pulumi:"networkInterfaceId"`
	// List of VPC security group IDs attached to the mount target.
	SecurityGroups []string `pulumi:"securityGroups"`
	// ID of the mount target's subnet.
	SubnetId string `pulumi:"subnetId"`
}

A collection of values returned by getMountTarget.

func LookupMountTarget 

func LookupMountTarget(ctx *pulumi.Context, args *LookupMountTargetArgs, opts ...pulumi.InvokeOption) (*LookupMountTargetResult, error)

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

type MountTarget 

type MountTarget struct {
	pulumi.CustomResourceState

	// 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 pulumi.StringOutput `pulumi:"dnsName"`
	// Amazon Resource Name of the file system.
	FileSystemArn pulumi.StringOutput `pulumi:"fileSystemArn"`
	// The ID of the file system for which the mount target is intended.
	FileSystemId pulumi.StringOutput `pulumi:"fileSystemId"`
	// The address (within the address range of the specified subnet) at
	// which the file system may be mounted via the mount target.
	IpAddress pulumi.StringOutput `pulumi:"ipAddress"`
	// The ID of the network interface that Amazon EFS created when it created the mount target.
	NetworkInterfaceId pulumi.StringOutput `pulumi:"networkInterfaceId"`
	// 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 pulumi.StringArrayOutput `pulumi:"securityGroups"`
	// The ID of the subnet to add the mount target in.
	SubnetId pulumi.StringOutput `pulumi:"subnetId"`
}

Provides an Elastic File System (EFS) mount target.

func GetMountTarget 

func GetMountTarget(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *MountTargetState, opts ...pulumi.ResourceOption) (*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.ResourceOption) (*MountTarget, error)

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

type MountTargetArgs 

type MountTargetArgs struct {
	// The ID of the file system for which the mount target is intended.
	FileSystemId pulumi.StringInput
	// The address (within the address range of the specified subnet) at
	// which the file system may be mounted via the mount target.
	IpAddress pulumi.StringPtrInput
	// 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 pulumi.StringArrayInput
	// The ID of the subnet to add the mount target in.
	SubnetId pulumi.StringInput
}

The set of arguments for constructing a MountTarget resource.

func (MountTargetArgs) ElementType 

func (MountTargetArgs) ElementType() reflect.Type

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 pulumi.StringPtrInput
	// Amazon Resource Name of the file system.
	FileSystemArn pulumi.StringPtrInput
	// The ID of the file system for which the mount target is intended.
	FileSystemId pulumi.StringPtrInput
	// The address (within the address range of the specified subnet) at
	// which the file system may be mounted via the mount target.
	IpAddress pulumi.StringPtrInput
	// The ID of the network interface that Amazon EFS created when it created the mount target.
	NetworkInterfaceId pulumi.StringPtrInput
	// 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 pulumi.StringArrayInput
	// The ID of the subnet to add the mount target in.
	SubnetId pulumi.StringPtrInput
}

func (MountTargetState) ElementType 

func (MountTargetState) ElementType() reflect.Type

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.