Class: AWSCDK::ECS::CfnTaskDefinition::AuthorizationConfigProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ecs/cfn_task_definition.rb

Overview

The authorization configuration details for the Amazon EFS file system.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(access_point_id: nil, iam: nil) ⇒ AuthorizationConfigProperty

Returns a new instance of AuthorizationConfigProperty.

Parameters:

  • access_point_id (String, nil) (defaults to: nil)

    The Amazon EFS access point ID to use.

  • iam (String, nil) (defaults to: nil)

    Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system.



747
748
749
750
751
752
# File 'ecs/cfn_task_definition.rb', line 747

def initialize(access_point_id: nil, iam: nil)
  @access_point_id = access_point_id
  Jsii::Type.check_type(@access_point_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "accessPointId") unless @access_point_id.nil?
  @iam = iam
  Jsii::Type.check_type(@iam, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "iam") unless @iam.nil?
end

Instance Attribute Details

#access_point_idString? (readonly)

The Amazon EFS access point ID to use.

If an access point is specified, the root directory value specified in the EFSVolumeConfiguration must either be omitted or set to / which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be on in the EFSVolumeConfiguration . For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide .



760
761
762
# File 'ecs/cfn_task_definition.rb', line 760

def access_point_id
  @access_point_id
end

#iamString? (readonly)

Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system.

If it is turned on, transit encryption must be turned on in the EFSVolumeConfiguration . If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS access points in the Amazon Elastic Container Service Developer Guide .



767
768
769
# File 'ecs/cfn_task_definition.rb', line 767

def iam
  @iam
end

Class Method Details

.jsii_propertiesObject



769
770
771
772
773
774
# File 'ecs/cfn_task_definition.rb', line 769

def self.jsii_properties
  {
    :access_point_id => "accessPointId",
    :iam => "iam",
  }
end

Instance Method Details

#to_jsiiObject



776
777
778
779
780
781
782
783
# File 'ecs/cfn_task_definition.rb', line 776

def to_jsii
  result = {}
  result.merge!({
    "accessPointId" => @access_point_id,
    "iam" => @iam,
  })
  result.compact
end