AppleApp class

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 for more details on beta resources.

To get more information about AppleApp, see:

Example Usage

Firebase Apple App Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const _default = new gcp.firebase.AppleApp("default", {
    project: "my-project-name",
    displayName: "Display Name Basic",
    bundleId: "apple.app.12345",
});

import pulumi
import pulumi_gcp as gcp

default = gcp.firebase.AppleApp("default",
    project="my-project-name",
    display_name="Display Name Basic",
    bundle_id="apple.app.12345")

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var @default = new Gcp.Firebase.AppleApp("default", new()
    {
        Project = "my-project-name",
        DisplayName = "Display Name Basic",
        BundleId = "apple.app.12345",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/firebase"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := firebase.NewAppleApp(ctx, "default", &firebase.AppleAppArgs{
			Project:     pulumi.String("my-project-name"),
			DisplayName: pulumi.String("Display Name Basic"),
			BundleId:    pulumi.String("apple.app.12345"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_firebase_appleapp" "default" {
  project      = "my-project-name"
  display_name = "Display Name Basic"
  bundle_id    = "apple.app.12345"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.firebase.AppleApp;
import com.pulumi.gcp.firebase.AppleAppArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var default_ = new AppleApp("default", AppleAppArgs.builder()
            .project("my-project-name")
            .displayName("Display Name Basic")
            .bundleId("apple.app.12345")
            .build());

    }
}

resources:
  default:
    type: gcp:firebase:AppleApp
    properties:
      project: my-project-name
      displayName: Display Name Basic
      bundleId: apple.app.12345

Firebase Apple App Full

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const apple = new gcp.projects.ApiKey("apple", {
    name: "api-key",
    displayName: "Display Name Full",
    project: "my-project-name",
    restrictions: {
        iosKeyRestrictions: {
            allowedBundleIds: ["apple.app.12345"],
        },
    },
});
const full = new gcp.firebase.AppleApp("full", {
    project: "my-project-name",
    displayName: "Display Name Full",
    bundleId: "apple.app.12345",
    appStoreId: "12345",
    teamId: "9987654321",
    apiKeyId: apple.uid,
});

import pulumi
import pulumi_gcp as gcp

apple = gcp.projects.ApiKey("apple",
    name="api-key",
    display_name="Display Name Full",
    project="my-project-name",
    restrictions={
        "ios_key_restrictions": {
            "allowed_bundle_ids": ["apple.app.12345"],
        },
    })
full = gcp.firebase.AppleApp("full",
    project="my-project-name",
    display_name="Display Name Full",
    bundle_id="apple.app.12345",
    app_store_id="12345",
    team_id="9987654321",
    api_key_id=apple.uid)

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var apple = new Gcp.Projects.ApiKey("apple", new()
    {
        Name = "api-key",
        DisplayName = "Display Name Full",
        Project = "my-project-name",
        Restrictions = new Gcp.Projects.Inputs.ApiKeyRestrictionsArgs
        {
            IosKeyRestrictions = new Gcp.Projects.Inputs.ApiKeyRestrictionsIosKeyRestrictionsArgs
            {
                AllowedBundleIds = new[]
                {
                    "apple.app.12345",
                },
            },
        },
    });

    var full = new Gcp.Firebase.AppleApp("full", new()
    {
        Project = "my-project-name",
        DisplayName = "Display Name Full",
        BundleId = "apple.app.12345",
        AppStoreId = "12345",
        TeamId = "9987654321",
        ApiKeyId = apple.Uid,
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/firebase"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/projects"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		apple, err := projects.NewApiKey(ctx, "apple", &projects.ApiKeyArgs{
			Name:        pulumi.String("api-key"),
			DisplayName: pulumi.String("Display Name Full"),
			Project:     pulumi.String("my-project-name"),
			Restrictions: &projects.ApiKeyRestrictionsArgs{
				IosKeyRestrictions: &projects.ApiKeyRestrictionsIosKeyRestrictionsArgs{
					AllowedBundleIds: pulumi.StringArray{
						pulumi.String("apple.app.12345"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = firebase.NewAppleApp(ctx, "full", &firebase.AppleAppArgs{
			Project:     pulumi.String("my-project-name"),
			DisplayName: pulumi.String("Display Name Full"),
			BundleId:    pulumi.String("apple.app.12345"),
			AppStoreId:  pulumi.String("12345"),
			TeamId:      pulumi.String("9987654321"),
			ApiKeyId:    apple.Uid,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_firebase_appleapp" "full" {
  project      = "my-project-name"
  display_name = "Display Name Full"
  bundle_id    = "apple.app.12345"
  app_store_id = "12345"
  team_id      = "9987654321"
  api_key_id   = gcp_projects_apikey.apple.uid
}
resource "gcp_projects_apikey" "apple" {
  name         = "api-key"
  display_name = "Display Name Full"
  project      = "my-project-name"
  restrictions = {
    ios_key_restrictions = {
      allowed_bundle_ids = ["apple.app.12345"]
    }
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.projects.ApiKey;
import com.pulumi.gcp.projects.ApiKeyArgs;
import com.pulumi.gcp.projects.inputs.ApiKeyRestrictionsArgs;
import com.pulumi.gcp.projects.inputs.ApiKeyRestrictionsIosKeyRestrictionsArgs;
import com.pulumi.gcp.firebase.AppleApp;
import com.pulumi.gcp.firebase.AppleAppArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var apple = new ApiKey("apple", ApiKeyArgs.builder()
            .name("api-key")
            .displayName("Display Name Full")
            .project("my-project-name")
            .restrictions(ApiKeyRestrictionsArgs.builder()
                .iosKeyRestrictions(ApiKeyRestrictionsIosKeyRestrictionsArgs.builder()
                    .allowedBundleIds("apple.app.12345")
                    .build())
                .build())
            .build());

        var full = new AppleApp("full", AppleAppArgs.builder()
            .project("my-project-name")
            .displayName("Display Name Full")
            .bundleId("apple.app.12345")
            .appStoreId("12345")
            .teamId("9987654321")
            .apiKeyId(apple.uid())
            .build());

    }
}

resources:
  full:
    type: gcp:firebase:AppleApp
    properties:
      project: my-project-name
      displayName: Display Name Full
      bundleId: apple.app.12345
      appStoreId: '12345'
      teamId: '9987654321'
      apiKeyId: ${apple.uid}
  apple:
    type: gcp:projects:ApiKey
    properties:
      name: api-key
      displayName: Display Name Full
      project: my-project-name
      restrictions:
        iosKeyRestrictions:
          allowedBundleIds:
            - apple.app.12345

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

When using the pulumi import command, 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}}"
$ pulumi import gcp:firebase/appleApp:AppleApp default projects/{{project}}/iosApps/{{app_id}}
$ pulumi import gcp:firebase/appleApp:AppleApp default {{project}}/{{project}}/{{app_id}}
$ pulumi import gcp:firebase/appleApp:AppleApp default iosApps/{{app_id}}
$ pulumi import gcp:firebase/appleApp:AppleApp default {{app_id}}

Constructors

AppleApp(String name, {AppleAppArgs? args, CustomResourceOptions? options}): Creates a new AppleApp. name The Pulumi resource name. args Arguments used to configure this AppleApp. The set of arguments for AppleApp. options Resource options controlling this resource's behavior.
AppleApp.reference(String urn): Creates a typed reference to an existing AppleApp resource.

Properties

apiKeyId ↔ Output<String>: 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.
latefinal
appId ↔ Output<String>: 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.
latefinal
appStoreId ↔ Output<String?>: The automatically generated Apple ID assigned to the Apple app by Apple in the Apple App Store.
latefinal
bundleId ↔ Output<String>: The canonical bundle ID of the Apple app as it would appear in the Apple AppStore.
latefinal
childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
deletionPolicy ↔ Output<String>: Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
latefinal
displayName ↔ Output<String>: The user-assigned display name of the App.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>: The fully qualified resource name of the App, for example: projects/projectId/iosApps/appId
latefinal
project ↔ Output<String>: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
teamId ↔ Output<String?>: The Apple Developer Team ID associated with the App in the App Store.
latefinal
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>: latefinalinherited

Methods

failId(Object error) → void: Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void: Completes all output properties with error.
inherited
failUrn(Object error) → void: Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?: Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String: Returns this resource's logical name.
inherited
getResourceType() → String: Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>: Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void: Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void: Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void: Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>: Serializes resource properties for RPC transmission.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {AppleAppState? state, CustomResourceOptions? options}) → AppleApp: Gets an existing AppleApp resource's state with the given name and id.