Class: AWSCDK::Transfer::CfnAgreement

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSTransfer::IAgreementRef
Defined in:
transfer/cfn_agreement.rb

Overview

Creates an agreement.

An agreement is a bilateral trading partner agreement, or partnership, between an AWS Transfer Family server and an AS2 process. The agreement defines the file and message transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family combines a server, local profile, partner profile, certificate, and other attributes.

The partner is identified with the PartnerProfileId , and the AS2 process is identified with the LocalProfileId .

Specify either BaseDirectory or CustomDirectories , but not both. Specifying both causes the command to fail.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnAgreement

Create a new AWS::Transfer::Agreement.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::Transfer::CfnAgreementProps) —

    Resource properties.



24
25
26
27
28
29
30
 
# File 'transfer/cfn_agreement.rb', line 24

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Transfer::CfnAgreementProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfdHJhbnNmZXIuQ2ZuQWdyZWVtZW50UHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_agreement(resource) ⇒ String

Parameters:

Returns:

  • (String) 


89
90
91
92
 
# File 'transfer/cfn_agreement.rb', line 89

def self.arn_for_agreement(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c190cmFuc2Zlci5JQWdyZWVtZW50UmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_transfer.CfnAgreement", "arnForAgreement", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


196
197
198
 
# File 'transfer/cfn_agreement.rb', line 196

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_transfer.CfnAgreement", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_agreement(x) ⇒ Boolean

Checks whether the given object is a CfnAgreement.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


98
99
100
101
 
# File 'transfer/cfn_agreement.rb', line 98

def self.is_cfn_agreement(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_transfer.CfnAgreement", "isCfnAgreement", [x])
end

.jsii_overridable_methods ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'transfer/cfn_agreement.rb', line 32

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :agreement_ref => { kind: :property, name: "agreementRef", is_optional: false },
    :attr_agreement_id => { kind: :property, name: "attrAgreementId", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :access_role => { kind: :property, name: "accessRole", is_optional: false },
    :local_profile_id => { kind: :property, name: "localProfileId", is_optional: false },
    :partner_profile_id => { kind: :property, name: "partnerProfileId", is_optional: false },
    :server_id => { kind: :property, name: "serverId", is_optional: false },
    :base_directory => { kind: :property, name: "baseDirectory", is_optional: true },
    :custom_directories => { kind: :property, name: "customDirectories", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :enforce_message_signing => { kind: :property, name: "enforceMessageSigning", is_optional: true },
    :preserve_filename => { kind: :property, name: "preserveFilename", is_optional: true },
    :status => { kind: :property, name: "status", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#access_role ⇒ String

Connectors are used to send files using either the AS2 or SFTP protocol.

Returns:

  • (String) 


231
232
233
 
# File 'transfer/cfn_agreement.rb', line 231

def access_role()
  jsii_get_property("accessRole")
end

#access_role=(value) ⇒ Object 



235
236
237
238
 
# File 'transfer/cfn_agreement.rb', line 235

def access_role=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "accessRole")
  jsii_set_property("accessRole", value)
end

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



398
399
400
401
 
# File 'transfer/cfn_agreement.rb', line 398

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



410
411
412
413
 
# File 'transfer/cfn_agreement.rb', line 410

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



420
421
422
423
 
# File 'transfer/cfn_agreement.rb', line 420

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



431
432
433
434
435
 
# File 'transfer/cfn_agreement.rb', line 431

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


488
489
490
491
492
 
# File 'transfer/cfn_agreement.rb', line 488

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



498
499
500
501
 
# File 'transfer/cfn_agreement.rb', line 498

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



510
511
512
513
514
 
# File 'transfer/cfn_agreement.rb', line 510

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#agreement_ref ⇒ AWSCDK::Interfaces::AWSTransfer::AgreementReference

A reference to a Agreement resource.

Returns:



203
204
205
 
# File 'transfer/cfn_agreement.rb', line 203

def agreement_ref()
  jsii_get_property("agreementRef")
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



523
524
525
526
 
# File 'transfer/cfn_agreement.rb', line 523

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



545
546
547
548
549
550
 
# File 'transfer/cfn_agreement.rb', line 545

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_agreement_id ⇒ String

The unique identifier for the AS2 agreement, returned after the API call succeeds.

Returns:

  • (String) 


210
211
212
 
# File 'transfer/cfn_agreement.rb', line 210

def attr_agreement_id()
  jsii_get_property("attrAgreementId")
end

#attr_arn ⇒ String

Specifies the unique Amazon Resource Name (ARN) for the agreement.

Returns:

  • (String) 


217
218
219
 
# File 'transfer/cfn_agreement.rb', line 217

def attr_arn()
  jsii_get_property("attrArn")
end

#base_directory ⇒ String?

The landing directory (folder) for files that are transferred by using the AS2 protocol.

Returns:

  • (String, nil) 


279
280
281
 
# File 'transfer/cfn_agreement.rb', line 279

def base_directory()
  jsii_get_property("baseDirectory")
end

#base_directory=(value) ⇒ Object 



283
284
285
286
 
# File 'transfer/cfn_agreement.rb', line 283

def base_directory=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "baseDirectory") unless value.nil?
  jsii_set_property("baseDirectory", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



149
150
151
 
# File 'transfer/cfn_agreement.rb', line 149

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


154
155
156
 
# File 'transfer/cfn_agreement.rb', line 154

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


554
555
556
557
 
# File 'transfer/cfn_agreement.rb', line 554

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


159
160
161
 
# File 'transfer/cfn_agreement.rb', line 159

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


166
167
168
 
# File 'transfer/cfn_agreement.rb', line 166

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


111
112
113
 
# File 'transfer/cfn_agreement.rb', line 111

def creation_stack()
  jsii_get_property("creationStack")
end

#custom_directories ⇒ AWSCDK::IResolvable, ...

A CustomDirectoriesType structure.

Returns:



291
292
293
 
# File 'transfer/cfn_agreement.rb', line 291

def custom_directories()
  jsii_get_property("customDirectories")
end

#custom_directories=(value) ⇒ Object 



295
296
297
298
299
 
# File 'transfer/cfn_agreement.rb', line 295

def custom_directories=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Transfer::CfnAgreement::CustomDirectoriesProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c190cmFuc2Zlci5DZm5BZ3JlZW1lbnQuQ3VzdG9tRGlyZWN0b3JpZXNQcm9wZXJ0eSJ9XX19")), "customDirectories") unless value.nil?
  jsii_set_property("customDirectories", value)
end

#description ⇒ String?

The name or short description that's used to identify the agreement.

Returns:

  • (String, nil) 


304
305
306
 
# File 'transfer/cfn_agreement.rb', line 304

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



308
309
310
311
 
# File 'transfer/cfn_agreement.rb', line 308

def description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless value.nil?
  jsii_set_property("description", value)
end

#enforce_message_signing ⇒ String?

Determines whether or not unsigned messages from your trading partners will be accepted.

Returns:

  • (String, nil) 


316
317
318
 
# File 'transfer/cfn_agreement.rb', line 316

def enforce_message_signing()
  jsii_get_property("enforceMessageSigning")
end

#enforce_message_signing=(value) ⇒ Object 



320
321
322
323
 
# File 'transfer/cfn_agreement.rb', line 320

def enforce_message_signing=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "enforceMessageSigning") unless value.nil?
  jsii_set_property("enforceMessageSigning", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



171
172
173
 
# File 'transfer/cfn_agreement.rb', line 171

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



567
568
569
570
571
 
# File 'transfer/cfn_agreement.rb', line 567

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



578
579
580
581
 
# File 'transfer/cfn_agreement.rb', line 578

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



648
649
650
651
 
# File 'transfer/cfn_agreement.rb', line 648

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#local_profile_id ⇒ String

A unique identifier for the AS2 local profile.

Returns:

  • (String) 


243
244
245
 
# File 'transfer/cfn_agreement.rb', line 243

def local_profile_id()
  jsii_get_property("localProfileId")
end

#local_profile_id=(value) ⇒ Object 



247
248
249
250
 
# File 'transfer/cfn_agreement.rb', line 247

def local_profile_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "localProfileId")
  jsii_set_property("localProfileId", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


123
124
125
 
# File 'transfer/cfn_agreement.rb', line 123

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


106
107
108
 
# File 'transfer/cfn_agreement.rb', line 106

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



589
590
591
 
# File 'transfer/cfn_agreement.rb', line 589

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



596
597
598
 
# File 'transfer/cfn_agreement.rb', line 596

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



389
390
391
392
 
# File 'transfer/cfn_agreement.rb', line 389

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#partner_profile_id ⇒ String

A unique identifier for the partner profile used in the agreement.

Returns:

  • (String) 


255
256
257
 
# File 'transfer/cfn_agreement.rb', line 255

def partner_profile_id()
  jsii_get_property("partnerProfileId")
end

#partner_profile_id=(value) ⇒ Object 



259
260
261
262
 
# File 'transfer/cfn_agreement.rb', line 259

def partner_profile_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "partnerProfileId")
  jsii_set_property("partnerProfileId", value)
end

#preserve_filename ⇒ String?

Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.

Returns:

  • (String, nil) 


328
329
330
 
# File 'transfer/cfn_agreement.rb', line 328

def preserve_filename()
  jsii_get_property("preserveFilename")
end

#preserve_filename=(value) ⇒ Object 



332
333
334
335
 
# File 'transfer/cfn_agreement.rb', line 332

def preserve_filename=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "preserveFilename") unless value.nil?
  jsii_set_property("preserveFilename", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


142
143
144
 
# File 'transfer/cfn_agreement.rb', line 142

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



607
608
609
610
 
# File 'transfer/cfn_agreement.rb', line 607

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


614
615
616
617
 
# File 'transfer/cfn_agreement.rb', line 614

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



624
625
626
627
628
 
# File 'transfer/cfn_agreement.rb', line 624

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#server_id ⇒ String

A system-assigned unique identifier for a server instance.

Returns:

  • (String) 


267
268
269
 
# File 'transfer/cfn_agreement.rb', line 267

def server_id()
  jsii_get_property("serverId")
end

#server_id=(value) ⇒ Object 



271
272
273
274
 
# File 'transfer/cfn_agreement.rb', line 271

def server_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serverId")
  jsii_set_property("serverId", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



633
634
635
 
# File 'transfer/cfn_agreement.rb', line 633

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



132
133
134
 
# File 'transfer/cfn_agreement.rb', line 132

def stack()
  jsii_get_property("stack")
end

#status ⇒ String?

The current status of the agreement, either ACTIVE or INACTIVE .

Returns:

  • (String, nil) 


340
341
342
 
# File 'transfer/cfn_agreement.rb', line 340

def status()
  jsii_get_property("status")
end

#status=(value) ⇒ Object 



344
345
346
347
 
# File 'transfer/cfn_agreement.rb', line 344

def status=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "status") unless value.nil?
  jsii_set_property("status", value)
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



224
225
226
 
# File 'transfer/cfn_agreement.rb', line 224

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

Key-value pairs that can be used to group and search for agreements.

Returns:



352
353
354
 
# File 'transfer/cfn_agreement.rb', line 352

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



356
357
358
359
360
 
# File 'transfer/cfn_agreement.rb', line 356

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



365
366
367
 
# File 'transfer/cfn_agreement.rb', line 365

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


179
180
181
 
# File 'transfer/cfn_agreement.rb', line 179

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


189
190
191
 
# File 'transfer/cfn_agreement.rb', line 189

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


639
640
641
642
 
# File 'transfer/cfn_agreement.rb', line 639

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


378
379
380
381
382
383
 
# File 'transfer/cfn_agreement.rb', line 378

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end