| --- |
| # ---------------------------------------------------------------------------- |
| # |
| # *** AUTO GENERATED CODE *** Type: MMv1 *** |
| # |
| # ---------------------------------------------------------------------------- |
| # |
| # This file is automatically generated by Magic Modules and manual |
| # changes will be clobbered when the file is regenerated. |
| # |
| # Please read more about how to change this file in |
| # .github/CONTRIBUTING.md. |
| # |
| # ---------------------------------------------------------------------------- |
| subcategory: "Firebase" |
| description: |- |
| A Google Cloud Firebase Apple application instance |
| --- |
| |
| # google\_firebase\_apple\_app |
| |
| A Google Cloud Firebase Apple application instance |
| |
| ~> **Warning:** This resource is in beta, and should be used with the terraform-provider-google-beta provider. |
| See [Provider Versions](https://terraform.io/docs/providers/google/guides/provider_versions.html) for more details on beta resources. |
| |
| To get more information about AppleApp, see: |
| |
| * [API documentation](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.iosApps) |
| * How-to Guides |
| * [Official Documentation](https://firebase.google.com/docs/ios/setup) |
| |
| ## Example Usage - Firebase Apple App Basic |
| |
| |
| ```hcl |
| resource "google_firebase_apple_app" "default" { |
| provider = google-beta |
| project = "my-project-name" |
| display_name = "Display Name Basic" |
| bundle_id = "apple.app.12345" |
| } |
| ``` |
| ## Example Usage - Firebase Apple App Full |
| |
| |
| ```hcl |
| resource "google_firebase_apple_app" "full" { |
| provider = google-beta |
| project = "my-project-name" |
| display_name = "Display Name Full" |
| bundle_id = "apple.app.12345" |
| app_store_id = "12345" |
| team_id = "9987654321" |
| api_key_id = google_apikeys_key.apple.uid |
| } |
| |
| resource "google_apikeys_key" "apple" { |
| provider = google-beta |
| |
| name = "api-key" |
| display_name = "Display Name Full" |
| project = "my-project-name" |
| |
| restrictions { |
| ios_key_restrictions { |
| allowed_bundle_ids = ["apple.app.12345"] |
| } |
| } |
| } |
| ``` |
| |
| ## Argument Reference |
| |
| The following arguments are supported: |
| |
| |
| * `display_name` - |
| (Required) |
| The user-assigned display name of the App. |
| |
| * `bundle_id` - |
| (Required) |
| The canonical bundle ID of the Apple app as it would appear in the Apple AppStore. |
| |
| |
| - - - |
| |
| |
| * `app_store_id` - |
| (Optional) |
| The automatically generated Apple ID assigned to the Apple app by Apple in the Apple App Store. |
| |
| * `team_id` - |
| (Optional) |
| The Apple Developer Team ID associated with the App in the App Store. |
| |
| * `api_key_id` - |
| (Optional) |
| The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the AppleApp. |
| If apiKeyId is not set during creation, then Firebase automatically associates an apiKeyId with the AppleApp. |
| This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. |
| |
| * `project` - (Optional) The ID of the project in which the resource belongs. |
| If it is not provided, the provider project is used. |
| |
| * `deletion_policy` - (Optional) (Optional) Set to `ABANDON` to allow the Apple to be untracked from terraform state |
| rather than deleted upon `terraform destroy`. This is useful because the Apple may be |
| serving traffic. Set to `DELETE` to delete the Apple. Defaults to `DELETE`. |
| |
| |
| ## Attributes Reference |
| |
| In addition to the arguments listed above, the following computed attributes are exported: |
| |
| * `id` - an identifier for the resource with format `projects/{{project}}/iosApps/{{app_id}}` |
| |
| * `name` - |
| The fully qualified resource name of the App, for example: |
| projects/projectId/iosApps/appId |
| |
| * `app_id` - |
| The globally unique, Firebase-assigned identifier of the App. |
| This identifier should be treated as an opaque token, as the data format is not specified. |
| |
| |
| ## Timeouts |
| |
| This resource provides the following |
| [Timeouts](https://developer.hashicorp.com/terraform/plugin/sdkv2/resources/retries-and-customizable-timeouts) configuration options: |
| |
| - `create` - Default is 20 minutes. |
| - `update` - Default is 20 minutes. |
| - `delete` - Default is 20 minutes. |
| |
| ## Import |
| |
| |
| AppleApp can be imported using any of these accepted formats: |
| |
| * `{{project}} projects/{{project}}/iosApps/{{app_id}}` |
| * `projects/{{project}}/iosApps/{{app_id}}` |
| * `{{project}}/{{project}}/{{app_id}}` |
| * `iosApps/{{app_id}}` |
| * `{{app_id}}` |
| |
| |
| In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import AppleApp using one of the formats above. For example: |
| |
| ```tf |
| import { |
| id = "{{project}} projects/{{project}}/iosApps/{{app_id}}" |
| to = google_firebase_apple_app.default |
| } |
| ``` |
| |
| When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), AppleApp can be imported using one of the formats above. For example: |
| |
| ``` |
| $ terraform import google_firebase_apple_app.default {{project}} projects/{{project}}/iosApps/{{app_id}} |
| $ terraform import google_firebase_apple_app.default projects/{{project}}/iosApps/{{app_id}} |
| $ terraform import google_firebase_apple_app.default {{project}}/{{project}}/{{app_id}} |
| $ terraform import google_firebase_apple_app.default iosApps/{{app_id}} |
| $ terraform import google_firebase_apple_app.default {{app_id}} |
| ``` |
| |
| ## User Project Overrides |
| |
| This resource supports [User Project Overrides](https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/provider_reference#user_project_override). |