Class: AWSCDK::Transfer::CfnWebAppProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
transfer/cfn_web_app_props.rb

Overview

Properties for defining a CfnWebApp.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(identity_provider_details:, access_endpoint: nil, endpoint_details: nil, tags: nil, web_app_customization: nil, web_app_endpoint_policy: nil, web_app_units: nil) ⇒ CfnWebAppProps

Returns a new instance of CfnWebAppProps.

Parameters:



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'transfer/cfn_web_app_props.rb', line 16

def initialize(identity_provider_details:, access_endpoint: nil, endpoint_details: nil, tags: nil, web_app_customization: nil, web_app_endpoint_policy: nil, web_app_units: nil)
  @identity_provider_details = identity_provider_details.is_a?(Hash) ? ::AWSCDK::Transfer::CfnWebApp::IdentityProviderDetailsProperty.new(**identity_provider_details.transform_keys(&:to_sym)) : identity_provider_details
  Jsii::Type.check_type(@identity_provider_details, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c190cmFuc2Zlci5DZm5XZWJBcHAuSWRlbnRpdHlQcm92aWRlckRldGFpbHNQcm9wZXJ0eSJ9XX19")), "identityProviderDetails")
  @access_endpoint = access_endpoint
  Jsii::Type.check_type(@access_endpoint, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "accessEndpoint") unless @access_endpoint.nil?
  @endpoint_details = endpoint_details.is_a?(Hash) ? ::AWSCDK::Transfer::CfnWebApp::EndpointDetailsProperty.new(**endpoint_details.transform_keys(&:to_sym)) : endpoint_details
  Jsii::Type.check_type(@endpoint_details, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c190cmFuc2Zlci5DZm5XZWJBcHAuRW5kcG9pbnREZXRhaWxzUHJvcGVydHkifV19fQ==")), "endpointDetails") unless @endpoint_details.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @web_app_customization = web_app_customization.is_a?(Hash) ? ::AWSCDK::Transfer::CfnWebApp::WebAppCustomizationProperty.new(**web_app_customization.transform_keys(&:to_sym)) : web_app_customization
  Jsii::Type.check_type(@web_app_customization, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c190cmFuc2Zlci5DZm5XZWJBcHAuV2ViQXBwQ3VzdG9taXphdGlvblByb3BlcnR5In1dfX0=")), "webAppCustomization") unless @web_app_customization.nil?
  @web_app_endpoint_policy = web_app_endpoint_policy
  Jsii::Type.check_type(@web_app_endpoint_policy, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "webAppEndpointPolicy") unless @web_app_endpoint_policy.nil?
  @web_app_units = web_app_units.is_a?(Hash) ? ::AWSCDK::Transfer::CfnWebApp::WebAppUnitsProperty.new(**web_app_units.transform_keys(&:to_sym)) : web_app_units
  Jsii::Type.check_type(@web_app_units, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c190cmFuc2Zlci5DZm5XZWJBcHAuV2ViQXBwVW5pdHNQcm9wZXJ0eSJ9XX19")), "webAppUnits") unless @web_app_units.nil?
end

Instance Attribute Details

#access_endpoint ⇒ String? (readonly)

The AccessEndpoint is the URL that you provide to your users for them to interact with the Transfer Family web app.

You can specify a custom URL or use the default value.

Before you enter a custom URL for this parameter, follow the steps described in Update your access endpoint with a custom URL .

Returns:

  • (String, nil)

See Also:



48
49
50
 
# File 'transfer/cfn_web_app_props.rb', line 48

def access_endpoint
  @access_endpoint
end

#endpoint_details ⇒ AWSCDK::IResolvable, ... (readonly)

Returns:

See Also:



51
52
53
 
# File 'transfer/cfn_web_app_props.rb', line 51

def endpoint_details
  @endpoint_details
end

#identity_provider_details ⇒ AWSCDK::IResolvable, AWSCDK::Transfer::CfnWebApp::IdentityProviderDetailsProperty (readonly)

You can provide a structure that contains the details for the identity provider to use with your web app.

For more details about this parameter, see Configure your identity provider for Transfer Family web apps .

Returns:

See Also:



39
40
41
 
# File 'transfer/cfn_web_app_props.rb', line 39

def identity_provider_details
  @identity_provider_details
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

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

Tags are metadata attached to web apps for any purpose.

Returns:

See Also:



58
59
60
 
# File 'transfer/cfn_web_app_props.rb', line 58

def tags
  @tags
end

#web_app_customization ⇒ AWSCDK::IResolvable, ... (readonly)

A structure that contains the customization fields for the web app.

You can provide a title, logo, and icon to customize the appearance of your web app.

Returns:

See Also:



65
66
67
 
# File 'transfer/cfn_web_app_props.rb', line 65

def web_app_customization
  @web_app_customization
end

#web_app_endpoint_policy ⇒ String? (readonly)

Setting for the type of endpoint policy for the web app. The default value is STANDARD .

If your web app was created in an AWS GovCloud (US) Region , the value of this parameter can be FIPS , which indicates the web app endpoint is FIPS-compliant.

Returns:

  • (String, nil)

See Also:



72
73
74
 
# File 'transfer/cfn_web_app_props.rb', line 72

def web_app_endpoint_policy
  @web_app_endpoint_policy
end

#web_app_units ⇒ AWSCDK::IResolvable, ... (readonly)

A union that contains the value for number of concurrent connections or the user sessions on your web app.

Returns:

See Also:



77
78
79
 
# File 'transfer/cfn_web_app_props.rb', line 77

def web_app_units
  @web_app_units
end

Class Method Details

.jsii_properties ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
 
# File 'transfer/cfn_web_app_props.rb', line 79

def self.jsii_properties
  {
    :identity_provider_details => "identityProviderDetails",
    :access_endpoint => "accessEndpoint",
    :endpoint_details => "endpointDetails",
    :tags => "tags",
    :web_app_customization => "webAppCustomization",
    :web_app_endpoint_policy => "webAppEndpointPolicy",
    :web_app_units => "webAppUnits",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'transfer/cfn_web_app_props.rb', line 91

def to_jsii
  result = {}
  result.merge!({
    "identityProviderDetails" => @identity_provider_details,
    "accessEndpoint" => @access_endpoint,
    "endpointDetails" => @endpoint_details,
    "tags" => @tags,
    "webAppCustomization" => @web_app_customization,
    "webAppEndpointPolicy" => @web_app_endpoint_policy,
    "webAppUnits" => @web_app_units,
  })
  result.compact
end