Package software.amazon.awscdk.services.ecs

Interface AuthorizationConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AuthorizationConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:16.265Z")
@Stability(Stable)
public interface AuthorizationConfig
extends software.amazon.jsii.JsiiSerializable

The authorization configuration details for the Amazon EFS file system.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ecs.*;
 AuthorizationConfig authorizationConfig = AuthorizationConfig.builder()
         .accessPointId("accessPointId")
         .iam("iam")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	AuthorizationConfig.Builder	A builder for AuthorizationConfig
static final class	AuthorizationConfig.Jsii$Proxy	An implementation for AuthorizationConfig

Method Summary

Modifier and Type	Method	Description
static AuthorizationConfig.Builder	builder()
default String	getAccessPointId()	The access point ID to use.
default String	getIam()	Whether or not to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccessPointId

@Stability(Stable)
@Nullable
default String getAccessPointId()

The access point ID to use.

If an access point is specified, the root directory value will be relative to the directory set for the access point. If specified, transit encryption must be enabled in the EFSVolumeConfiguration.

Default: No id

getIam

@Stability(Stable)
@Nullable
default String getIam()

Whether or not to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system.

If enabled, transit encryption must be enabled in the EFSVolumeConfiguration.

Valid values: ENABLED | DISABLED

Default: If this parameter is omitted, the default value of DISABLED is used.

builder

@Stability(Stable)
static AuthorizationConfig.Builder builder()

Returns:

a AuthorizationConfig.Builder of AuthorizationConfig