CfnApp

class aws_cdk.aws_amplify.CfnApp(scope, id, *, name, access_token=None, auto_branch_creation_config=None, basic_auth_config=None, build_spec=None, custom_rules=None, description=None, enable_branch_auto_deletion=None, environment_variables=None, iam_service_role=None, oauth_token=None, repository=None, tags=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::Amplify::App.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html

CloudformationResource

AWS::Amplify::App

Create a new AWS::Amplify::App.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • name (str) – AWS::Amplify::App.Name.

  • access_token (Optional[str]) – AWS::Amplify::App.AccessToken.

  • auto_branch_creation_config (Union[IResolvable, AutoBranchCreationConfigProperty, None]) – AWS::Amplify::App.AutoBranchCreationConfig.

  • basic_auth_config (Union[IResolvable, BasicAuthConfigProperty, None]) – AWS::Amplify::App.BasicAuthConfig.

  • build_spec (Optional[str]) – AWS::Amplify::App.BuildSpec.

  • custom_rules (Union[IResolvable, List[Union[IResolvable, CustomRuleProperty]], None]) – AWS::Amplify::App.CustomRules.

  • description (Optional[str]) – AWS::Amplify::App.Description.

  • enable_branch_auto_deletion (Union[bool, IResolvable, None]) – AWS::Amplify::App.EnableBranchAutoDeletion.

  • environment_variables (Union[IResolvable, List[Union[IResolvable, EnvironmentVariableProperty]], None]) – AWS::Amplify::App.EnvironmentVariables.

  • iam_service_role (Optional[str]) – AWS::Amplify::App.IAMServiceRole.

  • oauth_token (Optional[str]) – AWS::Amplify::App.OauthToken.

  • repository (Optional[str]) – AWS::Amplify::App.Repository.

  • tags (Optional[List[CfnTag]]) – AWS::Amplify::App.Tags.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

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

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride 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 without compilation. See https://github.com/aws/jsii/issues/826
add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

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

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

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

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

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

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

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

attribute_name (str) – The name of the attribute.

Return type

Reference

inspect(inspector)

(experimental) Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Stability

experimental

Return type

None

override_logical_id(new_logical_id)

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

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Amplify::App'
access_token

AWS::Amplify::App.AccessToken.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-accesstoken

Return type

Optional[str]

attr_app_id

AppId

Type

cloudformationAttribute

Return type

str

attr_app_name

AppName

Type

cloudformationAttribute

Return type

str

attr_arn

Arn

Type

cloudformationAttribute

Return type

str

attr_default_domain

DefaultDomain

Type

cloudformationAttribute

Return type

str

auto_branch_creation_config

AWS::Amplify::App.AutoBranchCreationConfig.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-autobranchcreationconfig

Return type

Union[IResolvable, AutoBranchCreationConfigProperty, None]

basic_auth_config

AWS::Amplify::App.BasicAuthConfig.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-basicauthconfig

Return type

Union[IResolvable, BasicAuthConfigProperty, None]

build_spec

AWS::Amplify::App.BuildSpec.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-buildspec

Return type

Optional[str]

cfn_options

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

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

custom_rules

AWS::Amplify::App.CustomRules.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-customrules

Return type

Union[IResolvable, List[Union[IResolvable, CustomRuleProperty]], None]

description

AWS::Amplify::App.Description.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-description

Return type

Optional[str]

enable_branch_auto_deletion

AWS::Amplify::App.EnableBranchAutoDeletion.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-enablebranchautodeletion

Return type

Union[bool, IResolvable, None]

environment_variables

AWS::Amplify::App.EnvironmentVariables.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-environmentvariables

Return type

Union[IResolvable, List[Union[IResolvable, EnvironmentVariableProperty]], None]

iam_service_role

AWS::Amplify::App.IAMServiceRole.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-iamservicerole

Return type

Optional[str]

logical_id

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 overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

name

AWS::Amplify::App.Name.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-name

Return type

str

node

The construct tree node associated with this construct.

Return type

ConstructNode

oauth_token

AWS::Amplify::App.OauthToken.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-oauthtoken

Return type

Optional[str]

ref

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

Return type

str

repository

AWS::Amplify::App.Repository.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-repository

Return type

Optional[str]

stack

The stack in which this element is defined.

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

Return type

Stack

tags

AWS::Amplify::App.Tags.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-tags

Return type

TagManager

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

AutoBranchCreationConfigProperty

class CfnApp.AutoBranchCreationConfigProperty(*, auto_branch_creation_patterns=None, basic_auth_config=None, build_spec=None, enable_auto_branch_creation=None, enable_auto_build=None, enable_performance_mode=None, enable_pull_request_preview=None, environment_variables=None, pull_request_environment_name=None, stage=None)

Bases: object

Parameters
  • auto_branch_creation_patterns (Optional[List[str]]) – CfnApp.AutoBranchCreationConfigProperty.AutoBranchCreationPatterns.

  • basic_auth_config (Union[IResolvable, BasicAuthConfigProperty, None]) – CfnApp.AutoBranchCreationConfigProperty.BasicAuthConfig.

  • build_spec (Optional[str]) – CfnApp.AutoBranchCreationConfigProperty.BuildSpec.

  • enable_auto_branch_creation (Union[bool, IResolvable, None]) – CfnApp.AutoBranchCreationConfigProperty.EnableAutoBranchCreation.

  • enable_auto_build (Union[bool, IResolvable, None]) – CfnApp.AutoBranchCreationConfigProperty.EnableAutoBuild.

  • enable_performance_mode (Union[bool, IResolvable, None]) – CfnApp.AutoBranchCreationConfigProperty.EnablePerformanceMode.

  • enable_pull_request_preview (Union[bool, IResolvable, None]) – CfnApp.AutoBranchCreationConfigProperty.EnablePullRequestPreview.

  • environment_variables (Union[IResolvable, List[Union[IResolvable, EnvironmentVariableProperty]], None]) – CfnApp.AutoBranchCreationConfigProperty.EnvironmentVariables.

  • pull_request_environment_name (Optional[str]) – CfnApp.AutoBranchCreationConfigProperty.PullRequestEnvironmentName.

  • stage (Optional[str]) – CfnApp.AutoBranchCreationConfigProperty.Stage.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html

Attributes

auto_branch_creation_patterns

CfnApp.AutoBranchCreationConfigProperty.AutoBranchCreationPatterns.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-autobranchcreationpatterns

Return type

Optional[List[str]]

basic_auth_config

CfnApp.AutoBranchCreationConfigProperty.BasicAuthConfig.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-basicauthconfig

Return type

Union[IResolvable, BasicAuthConfigProperty, None]

build_spec

CfnApp.AutoBranchCreationConfigProperty.BuildSpec.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-buildspec

Return type

Optional[str]

enable_auto_branch_creation

CfnApp.AutoBranchCreationConfigProperty.EnableAutoBranchCreation.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-enableautobranchcreation

Return type

Union[bool, IResolvable, None]

enable_auto_build

CfnApp.AutoBranchCreationConfigProperty.EnableAutoBuild.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-enableautobuild

Return type

Union[bool, IResolvable, None]

enable_performance_mode

CfnApp.AutoBranchCreationConfigProperty.EnablePerformanceMode.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-enableperformancemode

Return type

Union[bool, IResolvable, None]

enable_pull_request_preview

CfnApp.AutoBranchCreationConfigProperty.EnablePullRequestPreview.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-enablepullrequestpreview

Return type

Union[bool, IResolvable, None]

environment_variables

CfnApp.AutoBranchCreationConfigProperty.EnvironmentVariables.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-environmentvariables

Return type

Union[IResolvable, List[Union[IResolvable, EnvironmentVariableProperty]], None]

pull_request_environment_name

CfnApp.AutoBranchCreationConfigProperty.PullRequestEnvironmentName.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-pullrequestenvironmentname

Return type

Optional[str]

stage

CfnApp.AutoBranchCreationConfigProperty.Stage.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-stage

Return type

Optional[str]

BasicAuthConfigProperty

class CfnApp.BasicAuthConfigProperty(*, enable_basic_auth=None, password=None, username=None)

Bases: object

Parameters
  • enable_basic_auth (Union[bool, IResolvable, None]) – CfnApp.BasicAuthConfigProperty.EnableBasicAuth.

  • password (Optional[str]) – CfnApp.BasicAuthConfigProperty.Password.

  • username (Optional[str]) – CfnApp.BasicAuthConfigProperty.Username.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-basicauthconfig.html

Attributes

enable_basic_auth

CfnApp.BasicAuthConfigProperty.EnableBasicAuth.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-basicauthconfig.html#cfn-amplify-app-basicauthconfig-enablebasicauth

Return type

Union[bool, IResolvable, None]

password

CfnApp.BasicAuthConfigProperty.Password.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-basicauthconfig.html#cfn-amplify-app-basicauthconfig-password

Return type

Optional[str]

username

CfnApp.BasicAuthConfigProperty.Username.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-basicauthconfig.html#cfn-amplify-app-basicauthconfig-username

Return type

Optional[str]

CustomRuleProperty

class CfnApp.CustomRuleProperty(*, source, target, condition=None, status=None)

Bases: object

Parameters
  • source (str) – CfnApp.CustomRuleProperty.Source.

  • target (str) – CfnApp.CustomRuleProperty.Target.

  • condition (Optional[str]) – CfnApp.CustomRuleProperty.Condition.

  • status (Optional[str]) – CfnApp.CustomRuleProperty.Status.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-customrule.html

Attributes

condition

CfnApp.CustomRuleProperty.Condition.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-customrule.html#cfn-amplify-app-customrule-condition

Return type

Optional[str]

source

CfnApp.CustomRuleProperty.Source.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-customrule.html#cfn-amplify-app-customrule-source

Return type

str

status

CfnApp.CustomRuleProperty.Status.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-customrule.html#cfn-amplify-app-customrule-status

Return type

Optional[str]

target

CfnApp.CustomRuleProperty.Target.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-customrule.html#cfn-amplify-app-customrule-target

Return type

str

EnvironmentVariableProperty

class CfnApp.EnvironmentVariableProperty(*, name, value)

Bases: object

Parameters
  • name (str) – CfnApp.EnvironmentVariableProperty.Name.

  • value (str) – CfnApp.EnvironmentVariableProperty.Value.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-environmentvariable.html

Attributes

name

CfnApp.EnvironmentVariableProperty.Name.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-environmentvariable.html#cfn-amplify-app-environmentvariable-name

Return type

str

value

CfnApp.EnvironmentVariableProperty.Value.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-environmentvariable.html#cfn-amplify-app-environmentvariable-value

Return type

str