AwsEfs

Service-level AWS EFS component.

Remarks

The component creates one encrypted EFS file system, one mount target for each mountTargets key, and optional application-scoped access points. It never creates a default-VPC mount target or security group.

Naming:

• Root type ${namespace}:aws:AwsEfs uses the literal capability efs and args.name, yielding ${env}-${projectHash}-efs-${sanitised args.name}.
• Under parent type ${namespace}:aws:AwsEfs, aws-native:efs:FileSystem safely uses [args.name], yielding ${env}-${projectHash}-${sanitised args.name}.
• Under parent type ${namespace}:aws:AwsEfs, aws-native:efs:MountTarget safely uses the keyed tuple [args.name, args.mountTargets.<key>], yielding ${env}-${projectHash}-${sanitised args.name}-${sanitised args.mountTargets.<key>}. All keys are preflighted for normalised collisions before resource registration.
• Under parent type ${namespace}:aws:AwsEfs, aws-native:efs:AccessPoint safely uses the keyed tuple [args.name, args.accessPoints.<key>], yielding ${env}-${projectHash}-${sanitised args.name}-${sanitised args.accessPoints.<key>}. All keys are preflighted for normalised collisions before resource registration.
• The file-system and access-point Name tags use stackAndPurpose: ${env}-${projectHash}-${purpose}. EFS has no provider name input; mount targets have no provider-owned name. The file-system Name tag uses args.name; each access-point Name tag uses args.accessPoints.<key>.name. Both call buildAwsNameFromLiteralCamelCasePurpose(...) with camel-case casing and a 243-character purpose cap, reserving the 13-character ${env}-${projectHash}- prefix within AWS's 256-character tag-value limit.

Example

const efs = new AwsEfs({
  name: 'sharedFiles',
  mountTargets: {
    euw1a: { subnet: 'subnet-123', securityGroups: ['sg-123'] },
  },
});

Constructors

new AwsEfs( args: AwsEfsArgs, options?: ComponentResourceOptions, ): AwsEfs

Parameters

• args (AwsEfsArgs)
• options (ComponentResourceOptions, optional)

Returns

AwsEfs

Hierarchy

• ComponentResource
• AwsEfs

Properties

accessPointArns: Record<string, pulumi.Output<string>>

Access-point ARNs keyed by args.accessPoints.

accessPointIds: Record<string, pulumi.Output<string>>

Access-point IDs keyed by args.accessPoints.

accessPoints: Record<string, awsNative.efs.AccessPoint>

Access points keyed by args.accessPoints.

fileSystem: FileSystem

Underlying encrypted EFS file system.

fileSystemArn: Output<string>

EFS file-system ARN.

fileSystemId: Output<string>

EFS file-system ID.

mountTargetIds: Record<string, pulumi.Output<string>>

Mount-target IDs keyed by args.mountTargets.

mountTargets: Record<string, awsNative.efs.MountTarget>

Mount targets keyed by args.mountTargets.

urn: Output<string>

Inherited from urn

The stable logical URN used to distinctly address a resource, both before and after deployments.

Methods

getData(): Promise<any>

Inherited from getData

Retrieves the data produces by initialize. The data is immediately available in a derived class's constructor after the super(...) call to ComponentResource.

Returns

• Promise<any>

getProvider(moduleMember: string): ProviderResource | undefined

Inherited from getProvider

Returns the provider for the given module member, if one exists.

Parameters

• moduleMember (string)

Returns

• ProviderResource | undefined

initialize( args: Inputs, opts?: ComponentResourceOptions, name?: string, type?: string, ): Promise<any>

Inherited from initialize

Can be overridden by a subclass to asynchronously initialize data for this component automatically when constructed. The data will be available immediately for subclass constructors to use. To access the data use getData.

Parameters

• args (Inputs)
• opts (ComponentResourceOptions, optional)
• name (string, optional)
• type (string, optional)

Returns

• Promise<any>

registerOutputs( outputs?: Inputs | Promise<Inputs> | Output<Inputs>, ): void

Inherited from registerOutputs

Registers synthetic outputs that a component has initialized, usually by allocating other child sub-resources and propagating their resulting property values.

Component resources can call this at the end of their constructor to indicate that they are done creating child resources. This is not strictly necessary as this will automatically be called after the initialize method completes.

Parameters

• outputs (Inputs | Promise<Inputs> | Output<Inputs>, optional)

Returns

• void

Static Methods

isInstance(obj: any): obj is ComponentResource<any>

Inherited from isInstance

Returns true if the given object is a CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

Parameters

• obj (any)

Returns

• obj is ComponentResource<any>