Class: Aws::Amplify::Types::CreateAppRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb

Overview

The request structure used to create apps in Amplify.

See Also:

Constant Summary collapse

SENSITIVE = 
[:oauth_token, :access_token, :basic_auth_credentials, :build_spec]

Instance Attribute Summary collapse

Instance Attribute Details

#access_token ⇒ String

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, use oauthToken.

You must specify either accessToken or oauthToken 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 .

Returns:

  • (String) 


779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 779

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :cache_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#auto_branch_creation_config ⇒ Types::AutoBranchCreationConfig

The automated branch creation configuration for an Amplify app.

Returns:



779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 779

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :cache_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#auto_branch_creation_patterns ⇒ Array<String>

The automated branch creation glob patterns for an Amplify app.

Returns:

  • (Array<String>) 


779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 779

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :cache_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#basic_auth_credentials ⇒ String

The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.

Returns:

  • (String) 


779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 779

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :cache_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#build_spec ⇒ String

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

Returns:

  • (String) 


779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 779

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :cache_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#cache_config ⇒ Types::CacheConfig

The cache configuration for the Amplify app.

Returns:



779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 779

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :cache_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#custom_headers ⇒ String

The custom HTTP headers for an Amplify app.

Returns:

  • (String) 


779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 779

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :cache_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#custom_rules ⇒ Array<Types::CustomRule>

The custom rewrite and redirect rules for an Amplify app.

Returns:



779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 779

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :cache_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#description ⇒ String

The description of the Amplify app.

Returns:

  • (String) 


779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 779

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :cache_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#enable_auto_branch_creation ⇒ Boolean

Enables automated branch creation for an Amplify app.

Returns:

  • (Boolean) 


779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 779

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :cache_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#enable_basic_auth ⇒ Boolean

Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.

Returns:

  • (Boolean) 


779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 779

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :cache_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#enable_branch_auto_build ⇒ Boolean

Enables the auto building of branches for an Amplify app.

Returns:

  • (Boolean) 


779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 779

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :cache_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#enable_branch_auto_deletion ⇒ Boolean

Automatically disconnects a branch in the Amplify console when you delete a branch from your Git repository.

Returns:

  • (Boolean) 


779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 779

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :cache_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#environment_variables ⇒ Hash<String,String>

The environment variables map for an Amplify app.

For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide.

Returns:

  • (Hash<String,String>) 


779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 779

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :cache_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#iam_service_role_arn ⇒ String

The AWS Identity and Access Management (IAM) service role for an Amplify app.

Returns:

  • (String) 


779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 779

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :cache_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#name ⇒ String

The name of the Amplify app.

Returns:

  • (String) 


779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 779

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :cache_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#oauth_token ⇒ String

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, use accessToken.

You must specify either oauthToken or accessToken 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 .

Returns:

  • (String) 


779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 779

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :cache_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#platform ⇒ String

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 to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.

If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to WEB_COMPUTE and set the artifacts baseDirectory to .next in the application's build settings. For an example of the build specification settings, see Amplify build settings for a Next.js 14 SSG application in the Amplify Hosting User Guide.

Returns:

  • (String) 


779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 779

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :cache_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#repository ⇒ String

The Git repository for the Amplify app.

Returns:

  • (String) 


779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 779

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :cache_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tag for an Amplify app.

Returns:

  • (Hash<String,String>) 


779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 779

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :cache_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end