Class: AWSCDK::Amplify::CfnBranch

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

Overview

The AWS::Amplify::Branch resource specifies a new branch within an app.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnBranch

Create a new AWS::Amplify::Branch.

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::CfnBranchProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'amplify/cfn_branch.rb', line 18

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

Class Method Details

.arn_for_branch(resource) ⇒ String

Parameters:

Returns:

  • (String) 


88
89
90
91
 
# File 'amplify/cfn_branch.rb', line 88

def self.arn_for_branch(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hbXBsaWZ5LklCcmFuY2hSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_amplify.CfnBranch", "arnForBranch", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


195
196
197
 
# File 'amplify/cfn_branch.rb', line 195

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

.is_cfn_branch(x) ⇒ Boolean

Checks whether the given object is a CfnBranch.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


97
98
99
100
 
# File 'amplify/cfn_branch.rb', line 97

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

.jsii_overridable_methods ⇒ Object 



26
27
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
 
# File 'amplify/cfn_branch.rb', line 26

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 },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_branch_name => { kind: :property, name: "attrBranchName", is_optional: false },
    :branch_ref => { kind: :property, name: "branchRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :app_id => { kind: :property, name: "appId", is_optional: false },
    :branch_name => { kind: :property, name: "branchName", is_optional: false },
    :backend => { kind: :property, name: "backend", is_optional: true },
    :basic_auth_config => { kind: :property, name: "basicAuthConfig", is_optional: true },
    :build_spec => { kind: :property, name: "buildSpec", is_optional: true },
    :compute_role_arn => { kind: :property, name: "computeRoleArn", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :enable_auto_build => { kind: :property, name: "enableAutoBuild", is_optional: true },
    :enable_performance_mode => { kind: :property, name: "enablePerformanceMode", is_optional: true },
    :enable_pull_request_preview => { kind: :property, name: "enablePullRequestPreview", is_optional: true },
    :enable_skew_protection => { kind: :property, name: "enableSkewProtection", is_optional: true },
    :environment_variables => { kind: :property, name: "environmentVariables", is_optional: true },
    :framework => { kind: :property, name: "framework", is_optional: true },
    :pull_request_environment_name => { kind: :property, name: "pullRequestEnvironmentName", is_optional: true },
    :stage => { kind: :property, name: "stage", 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

#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.



460
461
462
463
 
# File 'amplify/cfn_branch.rb', line 460

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:



472
473
474
475
 
# File 'amplify/cfn_branch.rb', line 472

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:



482
483
484
485
 
# File 'amplify/cfn_branch.rb', line 482

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:



493
494
495
496
497
 
# File 'amplify/cfn_branch.rb', line 493

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.


550
551
552
553
554
 
# File 'amplify/cfn_branch.rb', line 550

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.



560
561
562
563
 
# File 'amplify/cfn_branch.rb', line 560

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.



572
573
574
575
576
 
# File 'amplify/cfn_branch.rb', line 572

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

The unique ID for an Amplify app.

Returns:

  • (String) 


230
231
232
 
# File 'amplify/cfn_branch.rb', line 230

def app_id()
  jsii_get_property("appId")
end

#app_id=(value) ⇒ Object 



234
235
236
237
 
# File 'amplify/cfn_branch.rb', line 234

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



585
586
587
588
 
# File 'amplify/cfn_branch.rb', line 585

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:



607
608
609
610
611
612
 
# File 'amplify/cfn_branch.rb', line 607

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

ARN for a branch, part of an Amplify App.

Returns:

  • (String) 


202
203
204
 
# File 'amplify/cfn_branch.rb', line 202

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_branch_name ⇒ String

Name for a branch, part of an Amplify App.

Returns:

  • (String) 


209
210
211
 
# File 'amplify/cfn_branch.rb', line 209

def attr_branch_name()
  jsii_get_property("attrBranchName")
end

#backend ⇒ AWSCDK::IResolvable, ...

The backend for a Branch of an Amplify app.

Use for a backend created from an CloudFormation stack.

Returns:



256
257
258
 
# File 'amplify/cfn_branch.rb', line 256

def backend()
  jsii_get_property("backend")
end

#backend=(value) ⇒ Object 



260
261
262
263
264
 
# File 'amplify/cfn_branch.rb', line 260

def backend=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Amplify::CfnBranch::BackendProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hbXBsaWZ5LkNmbkJyYW5jaC5CYWNrZW5kUHJvcGVydHkifV19fQ==")), "backend") unless value.nil?
  jsii_set_property("backend", value)
end

#basic_auth_config ⇒ AWSCDK::IResolvable, ...

The basic authorization credentials for a branch of an Amplify app.

Returns:



269
270
271
 
# File 'amplify/cfn_branch.rb', line 269

def basic_auth_config()
  jsii_get_property("basicAuthConfig")
end

#basic_auth_config=(value) ⇒ Object 



273
274
275
276
277
 
# File 'amplify/cfn_branch.rb', line 273

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

#branch_name ⇒ String

The name for the branch.

Returns:

  • (String) 


242
243
244
 
# File 'amplify/cfn_branch.rb', line 242

def branch_name()
  jsii_get_property("branchName")
end

#branch_name=(value) ⇒ Object 



246
247
248
249
 
# File 'amplify/cfn_branch.rb', line 246

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

#branch_ref ⇒ AWSCDK::Interfaces::AWSAmplify::BranchReference

A reference to a Branch resource.

Returns:



216
217
218
 
# File 'amplify/cfn_branch.rb', line 216

def branch_ref()
  jsii_get_property("branchRef")
end

#build_spec ⇒ String?

The build specification (build spec) for the branch.

Returns:

  • (String, nil) 


282
283
284
 
# File 'amplify/cfn_branch.rb', line 282

def build_spec()
  jsii_get_property("buildSpec")
end

#build_spec=(value) ⇒ Object 



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

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



148
149
150
 
# File 'amplify/cfn_branch.rb', line 148

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


153
154
155
 
# File 'amplify/cfn_branch.rb', line 153

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


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

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


158
159
160
 
# File 'amplify/cfn_branch.rb', line 158

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


165
166
167
 
# File 'amplify/cfn_branch.rb', line 165

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#compute_role_arn ⇒ String?

The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app.

Returns:

  • (String, nil) 


294
295
296
 
# File 'amplify/cfn_branch.rb', line 294

def compute_role_arn()
  jsii_get_property("computeRoleArn")
end

#compute_role_arn=(value) ⇒ Object 



298
299
300
301
 
# File 'amplify/cfn_branch.rb', line 298

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


110
111
112
 
# File 'amplify/cfn_branch.rb', line 110

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

The description for the branch that is part of an Amplify app.

Returns:

  • (String, nil) 


306
307
308
 
# File 'amplify/cfn_branch.rb', line 306

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



310
311
312
313
 
# File 'amplify/cfn_branch.rb', line 310

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_auto_build ⇒ Boolean, ...

Enables auto building for the branch.

Returns:



318
319
320
 
# File 'amplify/cfn_branch.rb', line 318

def enable_auto_build()
  jsii_get_property("enableAutoBuild")
end

#enable_auto_build=(value) ⇒ Object 



322
323
324
325
 
# File 'amplify/cfn_branch.rb', line 322

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

#enable_performance_mode ⇒ Boolean, ...

Enables performance mode for the branch.

Returns:



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

def enable_performance_mode()
  jsii_get_property("enablePerformanceMode")
end

#enable_performance_mode=(value) ⇒ Object 



334
335
336
337
 
# File 'amplify/cfn_branch.rb', line 334

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

#enable_pull_request_preview ⇒ Boolean, ...

Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch.

Returns:



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

def enable_pull_request_preview()
  jsii_get_property("enablePullRequestPreview")
end

#enable_pull_request_preview=(value) ⇒ Object 



346
347
348
349
 
# File 'amplify/cfn_branch.rb', line 346

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

#enable_skew_protection ⇒ Boolean, ...

Specifies whether the skew protection feature is enabled for the branch.

Returns:



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

def enable_skew_protection()
  jsii_get_property("enableSkewProtection")
end

#enable_skew_protection=(value) ⇒ Object 



358
359
360
361
 
# File 'amplify/cfn_branch.rb', line 358

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



170
171
172
 
# File 'amplify/cfn_branch.rb', line 170

def env()
  jsii_get_property("env")
end

#environment_variables ⇒ AWSCDK::IResolvable, ...

The environment variables for the branch.

Returns:



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

def environment_variables()
  jsii_get_property("environmentVariables")
end

#environment_variables=(value) ⇒ Object 



370
371
372
373
 
# File 'amplify/cfn_branch.rb', line 370

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

#framework ⇒ String?

The framework for the branch.

Returns:

  • (String, nil) 


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

def framework()
  jsii_get_property("framework")
end

#framework=(value) ⇒ Object 



382
383
384
385
 
# File 'amplify/cfn_branch.rb', line 382

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



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

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:



640
641
642
643
 
# File 'amplify/cfn_branch.rb', line 640

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:



710
711
712
713
 
# File 'amplify/cfn_branch.rb', line 710

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
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) 


122
123
124
 
# File 'amplify/cfn_branch.rb', line 122

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


105
106
107
 
# File 'amplify/cfn_branch.rb', line 105

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:



651
652
653
 
# File 'amplify/cfn_branch.rb', line 651

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:



658
659
660
 
# File 'amplify/cfn_branch.rb', line 658

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.



451
452
453
454
 
# File 'amplify/cfn_branch.rb', line 451

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

#pull_request_environment_name ⇒ String?

If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews.

Returns:

  • (String, nil) 


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

def pull_request_environment_name()
  jsii_get_property("pullRequestEnvironmentName")
end

#pull_request_environment_name=(value) ⇒ Object 



394
395
396
397
 
# File 'amplify/cfn_branch.rb', line 394

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


141
142
143
 
# File 'amplify/cfn_branch.rb', line 141

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:



669
670
671
672
 
# File 'amplify/cfn_branch.rb', line 669

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


676
677
678
679
 
# File 'amplify/cfn_branch.rb', line 676

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:



686
687
688
689
690
 
# File 'amplify/cfn_branch.rb', line 686

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

#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.



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

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:



131
132
133
 
# File 'amplify/cfn_branch.rb', line 131

def stack()
  jsii_get_property("stack")
end

#stage ⇒ String?

Describes the current stage for the branch.

Returns:

  • (String, nil) 


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

def stage()
  jsii_get_property("stage")
end

#stage=(value) ⇒ Object 



406
407
408
409
 
# File 'amplify/cfn_branch.rb', line 406

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

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



223
224
225
 
# File 'amplify/cfn_branch.rb', line 223

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The tag for the branch.

Returns:



414
415
416
 
# File 'amplify/cfn_branch.rb', line 414

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



418
419
420
421
422
 
# File 'amplify/cfn_branch.rb', line 418

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



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

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


178
179
180
 
# File 'amplify/cfn_branch.rb', line 178

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


188
189
190
 
# File 'amplify/cfn_branch.rb', line 188

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


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

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) 


440
441
442
443
444
445
 
# File 'amplify/cfn_branch.rb', line 440

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