Class: AWSCDK::Amplify::CfnApp

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSAmplify::IAppRef
Defined in:
amplify/cfn_app.rb

Overview

The AWS::Amplify::App resource specifies Apps in Amplify Hosting.

An App is a collection of branches.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnApp

Create a new AWS::Amplify::App.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::Amplify::CfnAppProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'amplify/cfn_app.rb', line 20

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Amplify::CfnAppProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYW1wbGlmeS5DZm5BcHBQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_app(resource) ⇒ String

Parameters:

Returns:

  • (String) 


94
95
96
97
 
# File 'amplify/cfn_app.rb', line 94

def self.arn_for_app(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hbXBsaWZ5LklBcHBSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_amplify.CfnApp", "arnForApp", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


201
202
203
 
# File 'amplify/cfn_app.rb', line 201

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

.is_cfn_app(x) ⇒ Boolean

Checks whether the given object is a CfnApp.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


103
104
105
106
 
# File 'amplify/cfn_app.rb', line 103

def self.is_cfn_app(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_amplify.CfnApp", "isCfnApp", [x])
end

.jsii_overridable_methods ⇒ Object 



28
29
30
31
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
86
87
88
89
90
 
# File 'amplify/cfn_app.rb', line 28

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 },
    :app_ref => { kind: :property, name: "appRef", is_optional: false },
    :attr_app_id => { kind: :property, name: "attrAppId", is_optional: false },
    :attr_app_name => { kind: :property, name: "attrAppName", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_default_domain => { kind: :property, name: "attrDefaultDomain", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :access_token => { kind: :property, name: "accessToken", is_optional: true },
    :auto_branch_creation_config => { kind: :property, name: "autoBranchCreationConfig", is_optional: true },
    :basic_auth_config => { kind: :property, name: "basicAuthConfig", is_optional: true },
    :build_spec => { kind: :property, name: "buildSpec", is_optional: true },
    :cache_config => { kind: :property, name: "cacheConfig", is_optional: true },
    :compute_role_arn => { kind: :property, name: "computeRoleArn", is_optional: true },
    :custom_headers => { kind: :property, name: "customHeaders", is_optional: true },
    :custom_rules => { kind: :property, name: "customRules", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :enable_branch_auto_deletion => { kind: :property, name: "enableBranchAutoDeletion", is_optional: true },
    :environment_variables => { kind: :property, name: "environmentVariables", is_optional: true },
    :iam_service_role => { kind: :property, name: "iamServiceRole", is_optional: true },
    :job_config => { kind: :property, name: "jobConfig", is_optional: true },
    :oauth_token => { kind: :property, name: "oauthToken", is_optional: true },
    :platform => { kind: :property, name: "platform", is_optional: true },
    :repository => { kind: :property, name: "repository", 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_token ⇒ String?

The personal access token for a GitHub repository for an Amplify app.

Returns:

  • (String, nil) 


262
263
264
 
# File 'amplify/cfn_app.rb', line 262

def access_token()
  jsii_get_property("accessToken")
end

#access_token=(value) ⇒ Object 



266
267
268
269
 
# File 'amplify/cfn_app.rb', line 266

def access_token=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "accessToken") unless value.nil?
  jsii_set_property("accessToken", 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.



504
505
506
507
 
# File 'amplify/cfn_app.rb', line 504

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:



516
517
518
519
 
# File 'amplify/cfn_app.rb', line 516

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:



526
527
528
529
 
# File 'amplify/cfn_app.rb', line 526

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:



537
538
539
540
541
 
# File 'amplify/cfn_app.rb', line 537

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.


594
595
596
597
598
 
# File 'amplify/cfn_app.rb', line 594

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.



604
605
606
607
 
# File 'amplify/cfn_app.rb', line 604

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.



616
617
618
619
620
 
# File 'amplify/cfn_app.rb', line 616

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

#app_ref ⇒ AWSCDK::Interfaces::AWSAmplify::AppReference

A reference to a App resource.

Returns:



208
209
210
 
# File 'amplify/cfn_app.rb', line 208

def app_ref()
  jsii_get_property("appRef")
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:



629
630
631
632
 
# File 'amplify/cfn_app.rb', line 629

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:



651
652
653
654
655
656
 
# File 'amplify/cfn_app.rb', line 651

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_app_id ⇒ String

Unique Id for the Amplify App.

Returns:

  • (String) 


215
216
217
 
# File 'amplify/cfn_app.rb', line 215

def attr_app_id()
  jsii_get_property("attrAppId")
end

#attr_app_name ⇒ String

Name for the Amplify App.

Returns:

  • (String) 


222
223
224
 
# File 'amplify/cfn_app.rb', line 222

def attr_app_name()
  jsii_get_property("attrAppName")
end

#attr_arn ⇒ String

ARN for the Amplify App.

Returns:

  • (String) 


229
230
231
 
# File 'amplify/cfn_app.rb', line 229

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_default_domain ⇒ String

Default domain for the Amplify App.

Returns:

  • (String) 


236
237
238
 
# File 'amplify/cfn_app.rb', line 236

def attr_default_domain()
  jsii_get_property("attrDefaultDomain")
end

#auto_branch_creation_config ⇒ AWSCDK::IResolvable, ...

Sets the configuration for your automatic branch creation.

Returns:



274
275
276
 
# File 'amplify/cfn_app.rb', line 274

def auto_branch_creation_config()
  jsii_get_property("autoBranchCreationConfig")
end

#auto_branch_creation_config=(value) ⇒ Object 



278
279
280
281
282
 
# File 'amplify/cfn_app.rb', line 278

def auto_branch_creation_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Amplify::CfnApp::AutoBranchCreationConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hbXBsaWZ5LkNmbkFwcC5BdXRvQnJhbmNoQ3JlYXRpb25Db25maWdQcm9wZXJ0eSJ9XX19")), "autoBranchCreationConfig") unless value.nil?
  jsii_set_property("autoBranchCreationConfig", value)
end

#basic_auth_config ⇒ AWSCDK::IResolvable, ...

The credentials for basic authorization for an Amplify app.

Returns:



287
288
289
 
# File 'amplify/cfn_app.rb', line 287

def basic_auth_config()
  jsii_get_property("basicAuthConfig")
end

#basic_auth_config=(value) ⇒ Object 



291
292
293
294
295
 
# File 'amplify/cfn_app.rb', line 291

def basic_auth_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Amplify::CfnApp::BasicAuthConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hbXBsaWZ5LkNmbkFwcC5CYXNpY0F1dGhDb25maWdQcm9wZXJ0eSJ9XX19")), "basicAuthConfig") unless value.nil?
  jsii_set_property("basicAuthConfig", value)
end

#build_spec ⇒ String?

The build specification (build spec) for an Amplify app.

Returns:

  • (String, nil) 


300
301
302
 
# File 'amplify/cfn_app.rb', line 300

def build_spec()
  jsii_get_property("buildSpec")
end

#build_spec=(value) ⇒ Object 



304
305
306
307
 
# File 'amplify/cfn_app.rb', line 304

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

#cache_config ⇒ AWSCDK::IResolvable, ...

The cache configuration for the Amplify app.

Returns:



312
313
314
 
# File 'amplify/cfn_app.rb', line 312

def cache_config()
  jsii_get_property("cacheConfig")
end

#cache_config=(value) ⇒ Object 



316
317
318
319
320
 
# File 'amplify/cfn_app.rb', line 316

def cache_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Amplify::CfnApp::CacheConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hbXBsaWZ5LkNmbkFwcC5DYWNoZUNvbmZpZ1Byb3BlcnR5In1dfX0=")), "cacheConfig") unless value.nil?
  jsii_set_property("cacheConfig", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



154
155
156
 
# File 'amplify/cfn_app.rb', line 154

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


159
160
161
 
# File 'amplify/cfn_app.rb', line 159

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


660
661
662
663
 
# File 'amplify/cfn_app.rb', line 660

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}) 


164
165
166
 
# File 'amplify/cfn_app.rb', line 164

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


171
172
173
 
# File 'amplify/cfn_app.rb', line 171

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#compute_role_arn ⇒ String?

The Amazon Resource Name (ARN) of the IAM role for an SSR app.

Returns:

  • (String, nil) 


325
326
327
 
# File 'amplify/cfn_app.rb', line 325

def compute_role_arn()
  jsii_get_property("computeRoleArn")
end

#compute_role_arn=(value) ⇒ Object 



329
330
331
332
 
# File 'amplify/cfn_app.rb', line 329

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


116
117
118
 
# File 'amplify/cfn_app.rb', line 116

def creation_stack()
  jsii_get_property("creationStack")
end

#custom_headers ⇒ String?

The custom HTTP headers for an Amplify app.

Returns:

  • (String, nil) 


337
338
339
 
# File 'amplify/cfn_app.rb', line 337

def custom_headers()
  jsii_get_property("customHeaders")
end

#custom_headers=(value) ⇒ Object 



341
342
343
344
 
# File 'amplify/cfn_app.rb', line 341

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

#custom_rules ⇒ AWSCDK::IResolvable, ...

The custom rewrite and redirect rules for an Amplify app.

Returns:



349
350
351
 
# File 'amplify/cfn_app.rb', line 349

def custom_rules()
  jsii_get_property("customRules")
end

#custom_rules=(value) ⇒ Object 



353
354
355
356
 
# File 'amplify/cfn_app.rb', line 353

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

#description ⇒ String?

The description of the Amplify app.

Returns:

  • (String, nil) 


361
362
363
 
# File 'amplify/cfn_app.rb', line 361

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



365
366
367
368
 
# File 'amplify/cfn_app.rb', line 365

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

#enable_branch_auto_deletion ⇒ Boolean, ...

Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.

Returns:



373
374
375
 
# File 'amplify/cfn_app.rb', line 373

def enable_branch_auto_deletion()
  jsii_get_property("enableBranchAutoDeletion")
end

#enable_branch_auto_deletion=(value) ⇒ Object 



377
378
379
380
 
# File 'amplify/cfn_app.rb', line 377

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



176
177
178
 
# File 'amplify/cfn_app.rb', line 176

def env()
  jsii_get_property("env")
end

#environment_variables ⇒ AWSCDK::IResolvable, ...

The environment variables for the Amplify app.

Returns:



385
386
387
 
# File 'amplify/cfn_app.rb', line 385

def environment_variables()
  jsii_get_property("environmentVariables")
end

#environment_variables=(value) ⇒ Object 



389
390
391
392
 
# File 'amplify/cfn_app.rb', line 389

def environment_variables=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYW1wbGlmeS5DZm5BcHAuRW52aXJvbm1lbnRWYXJpYWJsZVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "environmentVariables") unless value.nil?
  jsii_set_property("environmentVariables", value)
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:



673
674
675
676
677
 
# File 'amplify/cfn_app.rb', line 673

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:



684
685
686
687
 
# File 'amplify/cfn_app.rb', line 684

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

#iam_service_role ⇒ String?

AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.

Returns:

  • (String, nil) 


397
398
399
 
# File 'amplify/cfn_app.rb', line 397

def iam_service_role()
  jsii_get_property("iamServiceRole")
end

#iam_service_role=(value) ⇒ Object 



401
402
403
404
 
# File 'amplify/cfn_app.rb', line 401

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



754
755
756
757
 
# File 'amplify/cfn_app.rb', line 754

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

#job_config ⇒ AWSCDK::IResolvable, ...

The configuration details that apply to the jobs for an Amplify app.

Returns:



409
410
411
 
# File 'amplify/cfn_app.rb', line 409

def job_config()
  jsii_get_property("jobConfig")
end

#job_config=(value) ⇒ Object 



413
414
415
416
417
 
# File 'amplify/cfn_app.rb', line 413

def job_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Amplify::CfnApp::JobConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hbXBsaWZ5LkNmbkFwcC5Kb2JDb25maWdQcm9wZXJ0eSJ9XX19")), "jobConfig") unless value.nil?
  jsii_set_property("jobConfig", 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) 


128
129
130
 
# File 'amplify/cfn_app.rb', line 128

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

The name of the Amplify app.

Returns:

  • (String) 


250
251
252
 
# File 'amplify/cfn_app.rb', line 250

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



254
255
256
257
 
# File 'amplify/cfn_app.rb', line 254

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


111
112
113
 
# File 'amplify/cfn_app.rb', line 111

def node()
  jsii_get_property("node")
end

#oauth_token ⇒ String?

The OAuth token for a third-party source control system for an Amplify app.

Returns:

  • (String, nil) 


422
423
424
 
# File 'amplify/cfn_app.rb', line 422

def oauth_token()
  jsii_get_property("oauthToken")
end

#oauth_token=(value) ⇒ Object 



426
427
428
429
 
# File 'amplify/cfn_app.rb', line 426

def oauth_token=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "oauthToken") unless value.nil?
  jsii_set_property("oauthToken", value)
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:



695
696
697
 
# File 'amplify/cfn_app.rb', line 695

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:



702
703
704
 
# File 'amplify/cfn_app.rb', line 702

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.



495
496
497
498
 
# File 'amplify/cfn_app.rb', line 495

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

#platform ⇒ String?

The platform for the Amplify app.

Returns:

  • (String, nil) 


434
435
436
 
# File 'amplify/cfn_app.rb', line 434

def platform()
  jsii_get_property("platform")
end

#platform=(value) ⇒ Object 



438
439
440
441
 
# File 'amplify/cfn_app.rb', line 438

def platform=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "platform") unless value.nil?
  jsii_set_property("platform", 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) 


147
148
149
 
# File 'amplify/cfn_app.rb', line 147

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:



713
714
715
716
 
# File 'amplify/cfn_app.rb', line 713

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}) 


720
721
722
723
 
# File 'amplify/cfn_app.rb', line 720

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:



730
731
732
733
734
 
# File 'amplify/cfn_app.rb', line 730

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

#repository ⇒ String?

The Git repository for the Amplify app.

Returns:

  • (String, nil) 


446
447
448
 
# File 'amplify/cfn_app.rb', line 446

def repository()
  jsii_get_property("repository")
end

#repository=(value) ⇒ Object 



450
451
452
453
 
# File 'amplify/cfn_app.rb', line 450

def repository=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "repository") unless value.nil?
  jsii_set_property("repository", 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.



739
740
741
 
# File 'amplify/cfn_app.rb', line 739

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:



137
138
139
 
# File 'amplify/cfn_app.rb', line 137

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



243
244
245
 
# File 'amplify/cfn_app.rb', line 243

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The tag for an Amplify app.

Returns:



458
459
460
 
# File 'amplify/cfn_app.rb', line 458

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



462
463
464
465
466
 
# File 'amplify/cfn_app.rb', line 462

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



471
472
473
 
# File 'amplify/cfn_app.rb', line 471

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}) 


184
185
186
 
# File 'amplify/cfn_app.rb', line 184

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}) 


194
195
196
 
# File 'amplify/cfn_app.rb', line 194

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


745
746
747
748
 
# File 'amplify/cfn_app.rb', line 745

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) 


484
485
486
487
488
489
 
# File 'amplify/cfn_app.rb', line 484

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