Class: Aws::Amplify::Types::App

Inherits:

Struct

Object
Struct
Aws::Amplify::Types::App

show all

Defined in:: gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb

Overview

Represents the different branches of a repository for building, deploying, and hosting an Amplify app.

Constant Summary collapse

SENSITIVE =

[:basic_auth_credentials, :build_spec]

Instance Attribute Summary collapse

#app_arn ⇒ String
The Amazon Resource Name (ARN) of the Amplify app.
#app_id ⇒ String
The unique ID of the Amplify app.
#auto_branch_creation_config ⇒ Types::AutoBranchCreationConfig
Describes the automated branch creation configuration for the Amplify app.
#auto_branch_creation_patterns ⇒ Array<String>
Describes the automated branch creation glob patterns for the Amplify app.
#basic_auth_credentials ⇒ String
The basic authorization credentials for branches for the Amplify app.
#build_spec ⇒ String
Describes the content of the build specification (build spec) for the Amplify app.
#cache_config ⇒ Types::CacheConfig
The cache configuration for the Amplify app.
#compute_role_arn ⇒ String
The Amazon Resource Name (ARN) of the IAM role for an SSR app.
#create_time ⇒ Time
A timestamp of when Amplify created the application.
#custom_headers ⇒ String
Describes the custom HTTP headers for the Amplify app.
#custom_rules ⇒ Array<Types::CustomRule>
Describes the custom redirect and rewrite rules for the Amplify app.
#default_domain ⇒ String
The default domain for the Amplify app.
#description ⇒ String
The description for the Amplify app.
#enable_auto_branch_creation ⇒ Boolean
Enables automated branch creation for the Amplify app.
#enable_basic_auth ⇒ Boolean
Enables basic authorization for the Amplify app's branches.
#enable_branch_auto_build ⇒ Boolean
Enables the auto-building of branches for the Amplify app.
#enable_branch_auto_deletion ⇒ Boolean
Automatically disconnect a branch in the Amplify console when you delete a branch from your Git repository.
#environment_variables ⇒ Hash<String,String>
The environment variables for the Amplify app.
#iam_service_role_arn ⇒ String
The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.
#name ⇒ String
The name for the Amplify app.
#platform ⇒ String
The platform for the Amplify app.
#production_branch ⇒ Types::ProductionBranch
Describes the information about a production branch of the Amplify app.
#repository ⇒ String
The Git repository for the Amplify app.
#repository_clone_method ⇒ String
This is for internal use.
#tags ⇒ Hash<String,String>
The tag for the Amplify app.
#update_time ⇒ Time
A timestamp of when Amplify updated the application.
#waf_configuration ⇒ Types::WafConfiguration
Describes the Firewall configuration for the Amplify app.
#webhook_create_time ⇒ Time
A timestamp of when Amplify created the webhook in your Git repository.

Instance Attribute Details

#app_arn ⇒ `String`

The Amazon Resource Name (ARN) of the Amplify app.

Returns:

(String)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 174

class App < Struct.new(
  :app_id,
  :app_arn,
  :name,
  :tags,
  :description,
  :repository,
  :platform,
  :create_time,
  :update_time,
  :compute_role_arn,
  :iam_service_role_arn,
  :environment_variables,
  :default_domain,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository_clone_method,
  :cache_config,
  :webhook_create_time,
  :waf_configuration)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#app_id ⇒ `String`

The unique ID of the Amplify app.

Returns:

(String)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 174

class App < Struct.new(
  :app_id,
  :app_arn,
  :name,
  :tags,
  :description,
  :repository,
  :platform,
  :create_time,
  :update_time,
  :compute_role_arn,
  :iam_service_role_arn,
  :environment_variables,
  :default_domain,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository_clone_method,
  :cache_config,
  :webhook_create_time,
  :waf_configuration)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#auto_branch_creation_config ⇒ `Types::AutoBranchCreationConfig`

Describes the automated branch creation configuration for the Amplify app.

Returns:

(Types::AutoBranchCreationConfig)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 174

class App < Struct.new(
  :app_id,
  :app_arn,
  :name,
  :tags,
  :description,
  :repository,
  :platform,
  :create_time,
  :update_time,
  :compute_role_arn,
  :iam_service_role_arn,
  :environment_variables,
  :default_domain,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository_clone_method,
  :cache_config,
  :webhook_create_time,
  :waf_configuration)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#auto_branch_creation_patterns ⇒ `Array<String>`

Describes the automated branch creation glob patterns for the Amplify app.

Returns:

(Array<String>)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 174

class App < Struct.new(
  :app_id,
  :app_arn,
  :name,
  :tags,
  :description,
  :repository,
  :platform,
  :create_time,
  :update_time,
  :compute_role_arn,
  :iam_service_role_arn,
  :environment_variables,
  :default_domain,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository_clone_method,
  :cache_config,
  :webhook_create_time,
  :waf_configuration)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#basic_auth_credentials ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 174

class App < Struct.new(
  :app_id,
  :app_arn,
  :name,
  :tags,
  :description,
  :repository,
  :platform,
  :create_time,
  :update_time,
  :compute_role_arn,
  :iam_service_role_arn,
  :environment_variables,
  :default_domain,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository_clone_method,
  :cache_config,
  :webhook_create_time,
  :waf_configuration)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#build_spec ⇒ `String`

Describes the content of the build specification (build spec) for the Amplify app.

Returns:

(String)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 174

class App < Struct.new(
  :app_id,
  :app_arn,
  :name,
  :tags,
  :description,
  :repository,
  :platform,
  :create_time,
  :update_time,
  :compute_role_arn,
  :iam_service_role_arn,
  :environment_variables,
  :default_domain,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository_clone_method,
  :cache_config,
  :webhook_create_time,
  :waf_configuration)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#cache_config ⇒ `Types::CacheConfig`

The cache configuration for the Amplify app. If you don't specify the cache configuration type, Amplify uses the default AMPLIFY_MANAGED setting.

Returns:

(Types::CacheConfig)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 174

class App < Struct.new(
  :app_id,
  :app_arn,
  :name,
  :tags,
  :description,
  :repository,
  :platform,
  :create_time,
  :update_time,
  :compute_role_arn,
  :iam_service_role_arn,
  :environment_variables,
  :default_domain,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository_clone_method,
  :cache_config,
  :webhook_create_time,
  :waf_configuration)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#compute_role_arn ⇒ `String`

The Amazon Resource Name (ARN) of the IAM role for an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide.

Returns:

(String)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 174

class App < Struct.new(
  :app_id,
  :app_arn,
  :name,
  :tags,
  :description,
  :repository,
  :platform,
  :create_time,
  :update_time,
  :compute_role_arn,
  :iam_service_role_arn,
  :environment_variables,
  :default_domain,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository_clone_method,
  :cache_config,
  :webhook_create_time,
  :waf_configuration)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#create_time ⇒ `Time`

A timestamp of when Amplify created the application.

Returns:

(Time)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 174

class App < Struct.new(
  :app_id,
  :app_arn,
  :name,
  :tags,
  :description,
  :repository,
  :platform,
  :create_time,
  :update_time,
  :compute_role_arn,
  :iam_service_role_arn,
  :environment_variables,
  :default_domain,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository_clone_method,
  :cache_config,
  :webhook_create_time,
  :waf_configuration)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#custom_headers ⇒ `String`

Describes the custom HTTP headers for the Amplify app.

Returns:

(String)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 174

class App < Struct.new(
  :app_id,
  :app_arn,
  :name,
  :tags,
  :description,
  :repository,
  :platform,
  :create_time,
  :update_time,
  :compute_role_arn,
  :iam_service_role_arn,
  :environment_variables,
  :default_domain,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository_clone_method,
  :cache_config,
  :webhook_create_time,
  :waf_configuration)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#custom_rules ⇒ `Array<Types::CustomRule>`

Describes the custom redirect and rewrite rules for the Amplify app.

Returns:

(Array<Types::CustomRule>)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 174

class App < Struct.new(
  :app_id,
  :app_arn,
  :name,
  :tags,
  :description,
  :repository,
  :platform,
  :create_time,
  :update_time,
  :compute_role_arn,
  :iam_service_role_arn,
  :environment_variables,
  :default_domain,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository_clone_method,
  :cache_config,
  :webhook_create_time,
  :waf_configuration)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#default_domain ⇒ `String`

The default domain for the Amplify app.

Returns:

(String)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 174

class App < Struct.new(
  :app_id,
  :app_arn,
  :name,
  :tags,
  :description,
  :repository,
  :platform,
  :create_time,
  :update_time,
  :compute_role_arn,
  :iam_service_role_arn,
  :environment_variables,
  :default_domain,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository_clone_method,
  :cache_config,
  :webhook_create_time,
  :waf_configuration)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#description ⇒ `String`

The description for the Amplify app.

Returns:

(String)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 174

class App < Struct.new(
  :app_id,
  :app_arn,
  :name,
  :tags,
  :description,
  :repository,
  :platform,
  :create_time,
  :update_time,
  :compute_role_arn,
  :iam_service_role_arn,
  :environment_variables,
  :default_domain,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository_clone_method,
  :cache_config,
  :webhook_create_time,
  :waf_configuration)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#enable_auto_branch_creation ⇒ `Boolean`

Enables automated branch creation for the Amplify app.

Returns:

(Boolean)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 174

class App < Struct.new(
  :app_id,
  :app_arn,
  :name,
  :tags,
  :description,
  :repository,
  :platform,
  :create_time,
  :update_time,
  :compute_role_arn,
  :iam_service_role_arn,
  :environment_variables,
  :default_domain,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository_clone_method,
  :cache_config,
  :webhook_create_time,
  :waf_configuration)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#enable_basic_auth ⇒ `Boolean`

Enables basic authorization for the Amplify app's branches.

Returns:

(Boolean)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 174

class App < Struct.new(
  :app_id,
  :app_arn,
  :name,
  :tags,
  :description,
  :repository,
  :platform,
  :create_time,
  :update_time,
  :compute_role_arn,
  :iam_service_role_arn,
  :environment_variables,
  :default_domain,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository_clone_method,
  :cache_config,
  :webhook_create_time,
  :waf_configuration)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#enable_branch_auto_build ⇒ `Boolean`

Enables the auto-building of branches for the Amplify app.

Returns:

(Boolean)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 174

class App < Struct.new(
  :app_id,
  :app_arn,
  :name,
  :tags,
  :description,
  :repository,
  :platform,
  :create_time,
  :update_time,
  :compute_role_arn,
  :iam_service_role_arn,
  :environment_variables,
  :default_domain,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository_clone_method,
  :cache_config,
  :webhook_create_time,
  :waf_configuration)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#enable_branch_auto_deletion ⇒ `Boolean`

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

Returns:

(Boolean)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 174

class App < Struct.new(
  :app_id,
  :app_arn,
  :name,
  :tags,
  :description,
  :repository,
  :platform,
  :create_time,
  :update_time,
  :compute_role_arn,
  :iam_service_role_arn,
  :environment_variables,
  :default_domain,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository_clone_method,
  :cache_config,
  :webhook_create_time,
  :waf_configuration)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#environment_variables ⇒ `Hash<String,String>`

The environment variables for the 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>)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 174

class App < Struct.new(
  :app_id,
  :app_arn,
  :name,
  :tags,
  :description,
  :repository,
  :platform,
  :create_time,
  :update_time,
  :compute_role_arn,
  :iam_service_role_arn,
  :environment_variables,
  :default_domain,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository_clone_method,
  :cache_config,
  :webhook_create_time,
  :waf_configuration)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#iam_service_role_arn ⇒ `String`

The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.

Returns:

(String)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 174

class App < Struct.new(
  :app_id,
  :app_arn,
  :name,
  :tags,
  :description,
  :repository,
  :platform,
  :create_time,
  :update_time,
  :compute_role_arn,
  :iam_service_role_arn,
  :environment_variables,
  :default_domain,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository_clone_method,
  :cache_config,
  :webhook_create_time,
  :waf_configuration)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#name ⇒ `String`

The name for the Amplify app.

Returns:

(String)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 174

class App < Struct.new(
  :app_id,
  :app_arn,
  :name,
  :tags,
  :description,
  :repository,
  :platform,
  :create_time,
  :update_time,
  :compute_role_arn,
  :iam_service_role_arn,
  :environment_variables,
  :default_domain,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository_clone_method,
  :cache_config,
  :webhook_create_time,
  :waf_configuration)
  SENSITIVE = [: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 14 or later, you must use the platform type WEB_COMPUTE.

Returns:

(String)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 174

class App < Struct.new(
  :app_id,
  :app_arn,
  :name,
  :tags,
  :description,
  :repository,
  :platform,
  :create_time,
  :update_time,
  :compute_role_arn,
  :iam_service_role_arn,
  :environment_variables,
  :default_domain,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository_clone_method,
  :cache_config,
  :webhook_create_time,
  :waf_configuration)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#production_branch ⇒ `Types::ProductionBranch`

Describes the information about a production branch of the Amplify app.

Returns:

(Types::ProductionBranch)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 174

class App < Struct.new(
  :app_id,
  :app_arn,
  :name,
  :tags,
  :description,
  :repository,
  :platform,
  :create_time,
  :update_time,
  :compute_role_arn,
  :iam_service_role_arn,
  :environment_variables,
  :default_domain,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository_clone_method,
  :cache_config,
  :webhook_create_time,
  :waf_configuration)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#repository ⇒ `String`

The Git repository for the Amplify app.

Returns:

(String)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 174

class App < Struct.new(
  :app_id,
  :app_arn,
  :name,
  :tags,
  :description,
  :repository,
  :platform,
  :create_time,
  :update_time,
  :compute_role_arn,
  :iam_service_role_arn,
  :environment_variables,
  :default_domain,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository_clone_method,
  :cache_config,
  :webhook_create_time,
  :waf_configuration)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#repository_clone_method ⇒ `String`

This is for internal use.

The Amplify service uses this parameter to specify the authentication protocol to use to access the Git repository for an Amplify app. Amplify specifies TOKEN for a GitHub repository, SIGV4 for an Amazon Web Services CodeCommit repository, and SSH for GitLab and Bitbucket repositories.

Returns:

(String)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 174

class App < Struct.new(
  :app_id,
  :app_arn,
  :name,
  :tags,
  :description,
  :repository,
  :platform,
  :create_time,
  :update_time,
  :compute_role_arn,
  :iam_service_role_arn,
  :environment_variables,
  :default_domain,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository_clone_method,
  :cache_config,
  :webhook_create_time,
  :waf_configuration)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#tags ⇒ `Hash<String,String>`

The tag for the Amplify app.

Returns:

(Hash<String,String>)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 174

class App < Struct.new(
  :app_id,
  :app_arn,
  :name,
  :tags,
  :description,
  :repository,
  :platform,
  :create_time,
  :update_time,
  :compute_role_arn,
  :iam_service_role_arn,
  :environment_variables,
  :default_domain,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository_clone_method,
  :cache_config,
  :webhook_create_time,
  :waf_configuration)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#update_time ⇒ `Time`

A timestamp of when Amplify updated the application.

Returns:

(Time)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 174

class App < Struct.new(
  :app_id,
  :app_arn,
  :name,
  :tags,
  :description,
  :repository,
  :platform,
  :create_time,
  :update_time,
  :compute_role_arn,
  :iam_service_role_arn,
  :environment_variables,
  :default_domain,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository_clone_method,
  :cache_config,
  :webhook_create_time,
  :waf_configuration)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#waf_configuration ⇒ `Types::WafConfiguration`

Describes the Firewall configuration for the Amplify app. Firewall support enables you to protect your hosted applications with a direct integration with WAF.

Returns:

(Types::WafConfiguration)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 174

class App < Struct.new(
  :app_id,
  :app_arn,
  :name,
  :tags,
  :description,
  :repository,
  :platform,
  :create_time,
  :update_time,
  :compute_role_arn,
  :iam_service_role_arn,
  :environment_variables,
  :default_domain,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository_clone_method,
  :cache_config,
  :webhook_create_time,
  :waf_configuration)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#webhook_create_time ⇒ `Time`

A timestamp of when Amplify created the webhook in your Git repository.

Returns:

(Time)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 174

class App < Struct.new(
  :app_id,
  :app_arn,
  :name,
  :tags,
  :description,
  :repository,
  :platform,
  :create_time,
  :update_time,
  :compute_role_arn,
  :iam_service_role_arn,
  :environment_variables,
  :default_domain,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :production_branch,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config,
  :repository_clone_method,
  :cache_config,
  :webhook_create_time,
  :waf_configuration)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

Class: Aws::Amplify::Types::App

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#app_arn ⇒ String

#app_id ⇒ String

#auto_branch_creation_config ⇒ Types::AutoBranchCreationConfig

#auto_branch_creation_patterns ⇒ Array<String>

#basic_auth_credentials ⇒ String

#build_spec ⇒ String

#cache_config ⇒ Types::CacheConfig

#compute_role_arn ⇒ String

#create_time ⇒ Time

#custom_headers ⇒ String

#custom_rules ⇒ Array<Types::CustomRule>

#default_domain ⇒ String

#description ⇒ String

#enable_auto_branch_creation ⇒ Boolean

#enable_basic_auth ⇒ Boolean

#enable_branch_auto_build ⇒ Boolean

#enable_branch_auto_deletion ⇒ Boolean

#environment_variables ⇒ Hash<String,String>

#iam_service_role_arn ⇒ String

#name ⇒ String

#platform ⇒ String

#production_branch ⇒ Types::ProductionBranch

#repository ⇒ String

#repository_clone_method ⇒ String

#tags ⇒ Hash<String,String>

#update_time ⇒ Time

#waf_configuration ⇒ Types::WafConfiguration

#webhook_create_time ⇒ Time

#app_arn ⇒ `String`

#app_id ⇒ `String`

#auto_branch_creation_config ⇒ `Types::AutoBranchCreationConfig`

#auto_branch_creation_patterns ⇒ `Array<String>`

#basic_auth_credentials ⇒ `String`

#build_spec ⇒ `String`

#cache_config ⇒ `Types::CacheConfig`

#compute_role_arn ⇒ `String`

#create_time ⇒ `Time`

#custom_headers ⇒ `String`

#custom_rules ⇒ `Array<Types::CustomRule>`

#default_domain ⇒ `String`

#description ⇒ `String`

#enable_auto_branch_creation ⇒ `Boolean`

#enable_basic_auth ⇒ `Boolean`

#enable_branch_auto_build ⇒ `Boolean`

#enable_branch_auto_deletion ⇒ `Boolean`

#environment_variables ⇒ `Hash<String,String>`

#iam_service_role_arn ⇒ `String`

#name ⇒ `String`

#platform ⇒ `String`

#production_branch ⇒ `Types::ProductionBranch`

#repository ⇒ `String`

#repository_clone_method ⇒ `String`

#tags ⇒ `Hash<String,String>`

#update_time ⇒ `Time`

#waf_configuration ⇒ `Types::WafConfiguration`

#webhook_create_time ⇒ `Time`