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_headers=None, custom_rules=None, description=None, enable_branch_auto_deletion=None, environment_variables=None, iam_service_role=None, oauth_token=None, platform=None, repository=None, tags=None)
Bases:
CfnResource
A CloudFormation
AWS::Amplify::App
.The AWS::Amplify::App resource specifies Apps in Amplify Hosting. An App is a collection of branches.
- CloudformationResource:
AWS::Amplify::App
- Link:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_amplify as amplify cfn_app = amplify.CfnApp(self, "MyCfnApp", name="name", # the properties below are optional access_token="accessToken", auto_branch_creation_config=amplify.CfnApp.AutoBranchCreationConfigProperty( auto_branch_creation_patterns=["autoBranchCreationPatterns"], basic_auth_config=amplify.CfnApp.BasicAuthConfigProperty( enable_basic_auth=False, password="password", username="username" ), build_spec="buildSpec", enable_auto_branch_creation=False, enable_auto_build=False, enable_performance_mode=False, enable_pull_request_preview=False, environment_variables=[amplify.CfnApp.EnvironmentVariableProperty( name="name", value="value" )], framework="framework", pull_request_environment_name="pullRequestEnvironmentName", stage="stage" ), basic_auth_config=amplify.CfnApp.BasicAuthConfigProperty( enable_basic_auth=False, password="password", username="username" ), build_spec="buildSpec", custom_headers="customHeaders", custom_rules=[amplify.CfnApp.CustomRuleProperty( source="source", target="target", # the properties below are optional condition="condition", status="status" )], description="description", enable_branch_auto_deletion=False, environment_variables=[amplify.CfnApp.EnvironmentVariableProperty( name="name", value="value" )], iam_service_role="iamServiceRole", oauth_token="oauthToken", platform="platform", repository="repository", tags=[CfnTag( key="key", value="value" )] )
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
) – The name for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+access_token (
Optional
[str
]) – The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored. UseAccessToken
for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, useOauthToken
. You must specify eitherAccessToken
orOauthToken
when you create a new app. Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide . Length Constraints: Minimum length of 1. Maximum length of 255.auto_branch_creation_config (
Union
[IResolvable
,AutoBranchCreationConfigProperty
,Dict
[str
,Any
],None
]) – Sets the configuration for your automatic branch creation.basic_auth_config (
Union
[IResolvable
,BasicAuthConfigProperty
,Dict
[str
,Any
],None
]) – The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the formatuser:password
.build_spec (
Optional
[str
]) – The build specification (build spec) for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 25000. Pattern: (?s).+custom_headers (
Optional
[str
]) – The custom HTTP headers for an Amplify app. Length Constraints: Minimum length of 0. Maximum length of 25000. Pattern: (?s).*custom_rules (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,CustomRuleProperty
,Dict
[str
,Any
]]],None
]) – The custom rewrite and redirect rules for an Amplify app.description (
Optional
[str
]) – The description for an Amplify app. Length Constraints: Maximum length of 1000. Pattern: (?s).*enable_branch_auto_deletion (
Union
[bool
,IResolvable
,None
]) – Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.environment_variables (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,EnvironmentVariableProperty
,Dict
[str
,Any
]]],None
]) – The environment variables map for an Amplify app.iam_service_role (
Optional
[str
]) – The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app. Length Constraints: Minimum length of 0. Maximum length of 1000. Pattern: (?s).*oauth_token (
Optional
[str
]) –The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored. Use
OauthToken
for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, useAccessToken
. You must specify eitherOauthToken
orAccessToken
when you create a new app. Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide . Length Constraints: Maximum length of 1000. Pattern: (?s).*platform (
Optional
[str
]) – The platform for the Amplify app. For a static app, set the platform type toWEB
. For a dynamic server-side rendered (SSR) app, set the platform type toWEB_COMPUTE
. For an app requiring Amplify Hosting’s original SSR support only, set the platform type toWEB_DYNAMIC
.repository (
Optional
[str
]) – The repository for an Amplify app. Pattern: (?s).*tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – The tag for an Amplify app.
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:
- Return type:
None
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.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
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:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
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 (
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.
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
).- Parameters:
policy (
Optional
[RemovalPolicy
])apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
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:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
)- See:
- Return type:
Any
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.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- 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
The personal access token for a GitHub repository for an Amplify app.
The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.
Use
AccessToken
for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, useOauthToken
.You must specify either
AccessToken
orOauthToken
when you create a new app.Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .
Length Constraints: Minimum length of 1. Maximum length of 255.
- attr_app_id
Unique Id for the Amplify App.
- CloudformationAttribute:
AppId
- attr_app_name
Name for the Amplify App.
- CloudformationAttribute:
AppName
- attr_arn
ARN for the Amplify App.
- CloudformationAttribute:
Arn
- attr_default_domain
Default domain for the Amplify App.
- CloudformationAttribute:
DefaultDomain
- auto_branch_creation_config
Sets the configuration for your automatic branch creation.
- basic_auth_config
The credentials for basic authorization for an Amplify app.
You must base64-encode the authorization credentials and provide them in the format
user:password
.
- build_spec
The build specification (build spec) for an Amplify app.
Length Constraints: Minimum length of 1. Maximum length of 25000.
Pattern: (?s).+
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- 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.
- custom_headers
The custom HTTP headers for an Amplify app.
Length Constraints: Minimum length of 0. Maximum length of 25000.
Pattern: (?s).*
- custom_rules
The custom rewrite and redirect rules for an Amplify app.
- description
The description for an Amplify app.
Length Constraints: Maximum length of 1000.
Pattern: (?s).*
- enable_branch_auto_deletion
Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.
- environment_variables
The environment variables map for an Amplify app.
- iam_service_role
The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern: (?s).*
- 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)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- name
The name for an Amplify app.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: (?s).+
- node
The construct tree node associated with this construct.
- oauth_token
The OAuth token for a third-party source control system for an Amplify app.
The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored.
Use
OauthToken
for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, useAccessToken
.You must specify either
OauthToken
orAccessToken
when you create a new app.Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .
Length Constraints: Maximum length of 1000.
Pattern: (?s).*
- platform
The platform for the Amplify app.
For a static app, set the platform type to
WEB
. For a dynamic server-side rendered (SSR) app, set the platform type toWEB_COMPUTE
. For an app requiring Amplify Hosting’s original SSR support only, set the platform type toWEB_DYNAMIC
.
- 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 })
.
- repository
The repository for an Amplify app.
Pattern: (?s).*
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- tags
The tag for an Amplify app.
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, framework=None, pull_request_environment_name=None, stage=None)
Bases:
object
Use the AutoBranchCreationConfig property type to automatically create branches that match a certain pattern.
- Parameters:
auto_branch_creation_patterns (
Optional
[Sequence
[str
]]) – Automated branch creation glob patterns for the Amplify app.basic_auth_config (
Union
[IResolvable
,BasicAuthConfigProperty
,Dict
[str
,Any
],None
]) – Sets password protection for your auto created branch.build_spec (
Optional
[str
]) – The build specification (build spec) for the autocreated branch. Length Constraints: Minimum length of 1. Maximum length of 25000.enable_auto_branch_creation (
Union
[bool
,IResolvable
,None
]) – Enables automated branch creation for the Amplify app.enable_auto_build (
Union
[bool
,IResolvable
,None
]) – Enables auto building for the auto created branch.enable_performance_mode (
Union
[bool
,IResolvable
,None
]) – Enables performance mode for the branch. Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.enable_pull_request_preview (
Union
[bool
,IResolvable
,None
]) – Sets whether pull request previews are enabled for each branch that Amplify Hosting automatically creates for your app. Amplify creates previews by deploying your app to a unique URL whenever a pull request is opened for the branch. Development and QA teams can use this preview to test the pull request before it’s merged into a production or integration branch. To provide backend support for your preview, Amplify Hosting automatically provisions a temporary backend environment that it deletes when the pull request is closed. If you want to specify a dedicated backend environment for your previews, use thePullRequestEnvironmentName
property. For more information, see Web Previews in the AWS Amplify Hosting User Guide .environment_variables (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,EnvironmentVariableProperty
,Dict
[str
,Any
]]],None
]) – Environment variables for the auto created branch.framework (
Optional
[str
]) – The framework for the autocreated branch.pull_request_environment_name (
Optional
[str
]) – If pull request previews are enabled, you can use this property to specify a dedicated backend environment for your previews. For example, you could specify an environment namedprod
,test
, ordev
that you initialized with the Amplify CLI. To enable pull request previews, set theEnablePullRequestPreview
property totrue
. If you don’t specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify deletes this environment when the pull request is closed. For more information about creating backend environments, see Feature Branch Deployments and Team Workflows in the AWS Amplify Hosting User Guide . Length Constraints: Maximum length of 20. Pattern: (?s).*stage (
Optional
[str
]) – Stage for the auto created branch.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_amplify as amplify auto_branch_creation_config_property = amplify.CfnApp.AutoBranchCreationConfigProperty( auto_branch_creation_patterns=["autoBranchCreationPatterns"], basic_auth_config=amplify.CfnApp.BasicAuthConfigProperty( enable_basic_auth=False, password="password", username="username" ), build_spec="buildSpec", enable_auto_branch_creation=False, enable_auto_build=False, enable_performance_mode=False, enable_pull_request_preview=False, environment_variables=[amplify.CfnApp.EnvironmentVariableProperty( name="name", value="value" )], framework="framework", pull_request_environment_name="pullRequestEnvironmentName", stage="stage" )
Attributes
- auto_branch_creation_patterns
Automated branch creation glob patterns for the Amplify app.
- basic_auth_config
Sets password protection for your auto created branch.
- build_spec
The build specification (build spec) for the autocreated branch.
Length Constraints: Minimum length of 1. Maximum length of 25000.
- enable_auto_branch_creation
Enables automated branch creation for the Amplify app.
- enable_auto_build
Enables auto building for the auto created branch.
- enable_performance_mode
Enables performance mode for the branch.
Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
- enable_pull_request_preview
Sets whether pull request previews are enabled for each branch that Amplify Hosting automatically creates for your app.
Amplify creates previews by deploying your app to a unique URL whenever a pull request is opened for the branch. Development and QA teams can use this preview to test the pull request before it’s merged into a production or integration branch.
To provide backend support for your preview, Amplify Hosting automatically provisions a temporary backend environment that it deletes when the pull request is closed. If you want to specify a dedicated backend environment for your previews, use the
PullRequestEnvironmentName
property.For more information, see Web Previews in the AWS Amplify Hosting User Guide .
- environment_variables
Environment variables for the auto created branch.
- framework
The framework for the autocreated branch.
- pull_request_environment_name
If pull request previews are enabled, you can use this property to specify a dedicated backend environment for your previews.
For example, you could specify an environment named
prod
,test
, ordev
that you initialized with the Amplify CLI.To enable pull request previews, set the
EnablePullRequestPreview
property totrue
.If you don’t specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify deletes this environment when the pull request is closed.
For more information about creating backend environments, see Feature Branch Deployments and Team Workflows in the AWS Amplify Hosting User Guide .
Length Constraints: Maximum length of 20.
Pattern: (?s).*
- stage
Stage for the auto created branch.
BasicAuthConfigProperty
- class CfnApp.BasicAuthConfigProperty(*, enable_basic_auth=None, password=None, username=None)
Bases:
object
Use the BasicAuthConfig property type to set password protection at an app level to all your branches.
- Parameters:
enable_basic_auth (
Union
[bool
,IResolvable
,None
]) – Enables basic authorization for the Amplify app’s branches.password (
Optional
[str
]) – The password for basic authorization. Length Constraints: Minimum length of 1. Maximum length of 255.username (
Optional
[str
]) – The user name for basic authorization. Length Constraints: Minimum length of 1. Maximum length of 255.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_amplify as amplify basic_auth_config_property = amplify.CfnApp.BasicAuthConfigProperty( enable_basic_auth=False, password="password", username="username" )
Attributes
- enable_basic_auth
Enables basic authorization for the Amplify app’s branches.
- password
The password for basic authorization.
Length Constraints: Minimum length of 1. Maximum length of 255.
- username
The user name for basic authorization.
Length Constraints: Minimum length of 1. Maximum length of 255.
CustomRuleProperty
- class CfnApp.CustomRuleProperty(*, source, target, condition=None, status=None)
Bases:
object
The CustomRule property type allows you to specify redirects, rewrites, and reverse proxies.
Redirects enable a web app to reroute navigation from one URL to another.
- Parameters:
source (
str
) – The source pattern for a URL rewrite or redirect rule. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: (?s).+target (
str
) – The target pattern for a URL rewrite or redirect rule. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: (?s).+condition (
Optional
[str
]) – The condition for a URL rewrite or redirect rule, such as a country code. Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: (?s).*status (
Optional
[str
]) – The status code for a URL rewrite or redirect rule. - 200 - Represents a 200 rewrite rule. - 301 - Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL. - 302 - Represents a 302 temporary redirect rule. - 404 - Represents a 404 redirect rule. - 404-200 - Represents a 404 rewrite rule. Length Constraints: Minimum length of 3. Maximum length of 7. Pattern: .{3,7}
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_amplify as amplify custom_rule_property = amplify.CfnApp.CustomRuleProperty( source="source", target="target", # the properties below are optional condition="condition", status="status" )
Attributes
- condition
The condition for a URL rewrite or redirect rule, such as a country code.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: (?s).*
- source
The source pattern for a URL rewrite or redirect rule.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: (?s).+
- status
The status code for a URL rewrite or redirect rule.
200 - Represents a 200 rewrite rule.
301 - Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.
302 - Represents a 302 temporary redirect rule.
404 - Represents a 404 redirect rule.
404-200 - Represents a 404 rewrite rule.
Length Constraints: Minimum length of 3. Maximum length of 7.
Pattern: .{3,7}
- target
The target pattern for a URL rewrite or redirect rule.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: (?s).+
EnvironmentVariableProperty
- class CfnApp.EnvironmentVariableProperty(*, name, value)
Bases:
object
Environment variables are key-value pairs that are available at build time.
Set environment variables for all branches in your app.
- Parameters:
name (
str
) – The environment variable name. Length Constraints: Maximum length of 255. Pattern: (?s).*value (
str
) – The environment variable value. Length Constraints: Maximum length of 5500. Pattern: (?s).*
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_amplify as amplify environment_variable_property = amplify.CfnApp.EnvironmentVariableProperty( name="name", value="value" )
Attributes
- name
The environment variable name.
Length Constraints: Maximum length of 255.
Pattern: (?s).*
- value
The environment variable value.
Length Constraints: Maximum length of 5500.
Pattern: (?s).*