1. Packages
  2. Google Cloud Native
  3. API Docs
  4. firebase
  5. firebase/v1beta1
  6. IosApp

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.firebase/v1beta1.IosApp

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

    Requests the creation of a new IosApp in the specified FirebaseProject. The result of this call is an Operation which can be used to track the provisioning process. The Operation is automatically deleted after completion, so there is no need to call DeleteOperation. Note - this resource’s API doesn’t support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.

    Create IosApp Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new IosApp(name: string, args?: IosAppArgs, opts?: CustomResourceOptions);
    @overload
    def IosApp(resource_name: str,
               args: Optional[IosAppArgs] = None,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def IosApp(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               api_key_id: Optional[str] = None,
               app_store_id: Optional[str] = None,
               bundle_id: Optional[str] = None,
               display_name: Optional[str] = None,
               etag: Optional[str] = None,
               name: Optional[str] = None,
               project: Optional[str] = None,
               team_id: Optional[str] = None)
    func NewIosApp(ctx *Context, name string, args *IosAppArgs, opts ...ResourceOption) (*IosApp, error)
    public IosApp(string name, IosAppArgs? args = null, CustomResourceOptions? opts = null)
    public IosApp(String name, IosAppArgs args)
    public IosApp(String name, IosAppArgs args, CustomResourceOptions options)
    
    type: google-native:firebase/v1beta1:IosApp
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args IosAppArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args IosAppArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args IosAppArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IosAppArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IosAppArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var iosAppResource = new GoogleNative.Firebase.V1Beta1.IosApp("iosAppResource", new()
    {
        ApiKeyId = "string",
        AppStoreId = "string",
        BundleId = "string",
        DisplayName = "string",
        Etag = "string",
        Name = "string",
        Project = "string",
        TeamId = "string",
    });
    
    example, err := firebase.NewIosApp(ctx, "iosAppResource", &firebase.IosAppArgs{
    ApiKeyId: pulumi.String("string"),
    AppStoreId: pulumi.String("string"),
    BundleId: pulumi.String("string"),
    DisplayName: pulumi.String("string"),
    Etag: pulumi.String("string"),
    Name: pulumi.String("string"),
    Project: pulumi.String("string"),
    TeamId: pulumi.String("string"),
    })
    
    var iosAppResource = new IosApp("iosAppResource", IosAppArgs.builder()        
        .apiKeyId("string")
        .appStoreId("string")
        .bundleId("string")
        .displayName("string")
        .etag("string")
        .name("string")
        .project("string")
        .teamId("string")
        .build());
    
    ios_app_resource = google_native.firebase.v1beta1.IosApp("iosAppResource",
        api_key_id="string",
        app_store_id="string",
        bundle_id="string",
        display_name="string",
        etag="string",
        name="string",
        project="string",
        team_id="string")
    
    const iosAppResource = new google_native.firebase.v1beta1.IosApp("iosAppResource", {
        apiKeyId: "string",
        appStoreId: "string",
        bundleId: "string",
        displayName: "string",
        etag: "string",
        name: "string",
        project: "string",
        teamId: "string",
    });
    
    type: google-native:firebase/v1beta1:IosApp
    properties:
        apiKeyId: string
        appStoreId: string
        bundleId: string
        displayName: string
        etag: string
        name: string
        project: string
        teamId: string
    

    IosApp Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The IosApp resource accepts the following input properties:

    ApiKeyId string
    The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the IosApp. Be aware that this value is the UID of the API key, not the keyString of the API key. The keyString is the value that can be found in the App's configuration artifact. If api_key_id is not set in requests to iosApps.Create, then Firebase automatically associates an api_key_id with the IosApp. This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. In patch requests, api_key_id cannot be set to an empty value, and the new UID must have no restrictions or only have restrictions that are valid for the associated IosApp. We recommend using the Google Cloud Console to manage API keys.
    AppStoreId string
    The automatically generated Apple ID assigned to the iOS app by Apple in the iOS App Store.
    BundleId string
    Immutable. The canonical bundle ID of the iOS app as it would appear in the iOS AppStore.
    DisplayName string
    The user-assigned display name for the IosApp.
    Etag string
    This checksum is computed by the server based on the value of other fields, and it may be sent with update requests to ensure the client has an up-to-date value before proceeding. Learn more about etag in Google's AIP-154 standard. This etag is strongly validated.
    Name string
    The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's ProjectNumber (recommended) or its ProjectId. Learn more about using project identifiers in Google's AIP 2510 standard. Note that the value for PROJECT_IDENTIFIER in any response body will be the ProjectId. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see appId).
    Project string
    TeamId string
    The Apple Developer Team ID associated with the App in the App Store.
    ApiKeyId string
    The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the IosApp. Be aware that this value is the UID of the API key, not the keyString of the API key. The keyString is the value that can be found in the App's configuration artifact. If api_key_id is not set in requests to iosApps.Create, then Firebase automatically associates an api_key_id with the IosApp. This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. In patch requests, api_key_id cannot be set to an empty value, and the new UID must have no restrictions or only have restrictions that are valid for the associated IosApp. We recommend using the Google Cloud Console to manage API keys.
    AppStoreId string
    The automatically generated Apple ID assigned to the iOS app by Apple in the iOS App Store.
    BundleId string
    Immutable. The canonical bundle ID of the iOS app as it would appear in the iOS AppStore.
    DisplayName string
    The user-assigned display name for the IosApp.
    Etag string
    This checksum is computed by the server based on the value of other fields, and it may be sent with update requests to ensure the client has an up-to-date value before proceeding. Learn more about etag in Google's AIP-154 standard. This etag is strongly validated.
    Name string
    The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's ProjectNumber (recommended) or its ProjectId. Learn more about using project identifiers in Google's AIP 2510 standard. Note that the value for PROJECT_IDENTIFIER in any response body will be the ProjectId. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see appId).
    Project string
    TeamId string
    The Apple Developer Team ID associated with the App in the App Store.
    apiKeyId String
    The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the IosApp. Be aware that this value is the UID of the API key, not the keyString of the API key. The keyString is the value that can be found in the App's configuration artifact. If api_key_id is not set in requests to iosApps.Create, then Firebase automatically associates an api_key_id with the IosApp. This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. In patch requests, api_key_id cannot be set to an empty value, and the new UID must have no restrictions or only have restrictions that are valid for the associated IosApp. We recommend using the Google Cloud Console to manage API keys.
    appStoreId String
    The automatically generated Apple ID assigned to the iOS app by Apple in the iOS App Store.
    bundleId String
    Immutable. The canonical bundle ID of the iOS app as it would appear in the iOS AppStore.
    displayName String
    The user-assigned display name for the IosApp.
    etag String
    This checksum is computed by the server based on the value of other fields, and it may be sent with update requests to ensure the client has an up-to-date value before proceeding. Learn more about etag in Google's AIP-154 standard. This etag is strongly validated.
    name String
    The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's ProjectNumber (recommended) or its ProjectId. Learn more about using project identifiers in Google's AIP 2510 standard. Note that the value for PROJECT_IDENTIFIER in any response body will be the ProjectId. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see appId).
    project String
    teamId String
    The Apple Developer Team ID associated with the App in the App Store.
    apiKeyId string
    The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the IosApp. Be aware that this value is the UID of the API key, not the keyString of the API key. The keyString is the value that can be found in the App's configuration artifact. If api_key_id is not set in requests to iosApps.Create, then Firebase automatically associates an api_key_id with the IosApp. This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. In patch requests, api_key_id cannot be set to an empty value, and the new UID must have no restrictions or only have restrictions that are valid for the associated IosApp. We recommend using the Google Cloud Console to manage API keys.
    appStoreId string
    The automatically generated Apple ID assigned to the iOS app by Apple in the iOS App Store.
    bundleId string
    Immutable. The canonical bundle ID of the iOS app as it would appear in the iOS AppStore.
    displayName string
    The user-assigned display name for the IosApp.
    etag string
    This checksum is computed by the server based on the value of other fields, and it may be sent with update requests to ensure the client has an up-to-date value before proceeding. Learn more about etag in Google's AIP-154 standard. This etag is strongly validated.
    name string
    The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's ProjectNumber (recommended) or its ProjectId. Learn more about using project identifiers in Google's AIP 2510 standard. Note that the value for PROJECT_IDENTIFIER in any response body will be the ProjectId. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see appId).
    project string
    teamId string
    The Apple Developer Team ID associated with the App in the App Store.
    api_key_id str
    The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the IosApp. Be aware that this value is the UID of the API key, not the keyString of the API key. The keyString is the value that can be found in the App's configuration artifact. If api_key_id is not set in requests to iosApps.Create, then Firebase automatically associates an api_key_id with the IosApp. This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. In patch requests, api_key_id cannot be set to an empty value, and the new UID must have no restrictions or only have restrictions that are valid for the associated IosApp. We recommend using the Google Cloud Console to manage API keys.
    app_store_id str
    The automatically generated Apple ID assigned to the iOS app by Apple in the iOS App Store.
    bundle_id str
    Immutable. The canonical bundle ID of the iOS app as it would appear in the iOS AppStore.
    display_name str
    The user-assigned display name for the IosApp.
    etag str
    This checksum is computed by the server based on the value of other fields, and it may be sent with update requests to ensure the client has an up-to-date value before proceeding. Learn more about etag in Google's AIP-154 standard. This etag is strongly validated.
    name str
    The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's ProjectNumber (recommended) or its ProjectId. Learn more about using project identifiers in Google's AIP 2510 standard. Note that the value for PROJECT_IDENTIFIER in any response body will be the ProjectId. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see appId).
    project str
    team_id str
    The Apple Developer Team ID associated with the App in the App Store.
    apiKeyId String
    The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the IosApp. Be aware that this value is the UID of the API key, not the keyString of the API key. The keyString is the value that can be found in the App's configuration artifact. If api_key_id is not set in requests to iosApps.Create, then Firebase automatically associates an api_key_id with the IosApp. This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. In patch requests, api_key_id cannot be set to an empty value, and the new UID must have no restrictions or only have restrictions that are valid for the associated IosApp. We recommend using the Google Cloud Console to manage API keys.
    appStoreId String
    The automatically generated Apple ID assigned to the iOS app by Apple in the iOS App Store.
    bundleId String
    Immutable. The canonical bundle ID of the iOS app as it would appear in the iOS AppStore.
    displayName String
    The user-assigned display name for the IosApp.
    etag String
    This checksum is computed by the server based on the value of other fields, and it may be sent with update requests to ensure the client has an up-to-date value before proceeding. Learn more about etag in Google's AIP-154 standard. This etag is strongly validated.
    name String
    The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's ProjectNumber (recommended) or its ProjectId. Learn more about using project identifiers in Google's AIP 2510 standard. Note that the value for PROJECT_IDENTIFIER in any response body will be the ProjectId. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see appId).
    project String
    teamId String
    The Apple Developer Team ID associated with the App in the App Store.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the IosApp resource produces the following output properties:

    AppId string
    Immutable. The globally unique, Firebase-assigned identifier for the IosApp. This identifier should be treated as an opaque token, as the data format is not specified.
    ExpireTime string
    Timestamp of when the App will be considered expired and cannot be undeleted. This value is only provided if the App is in the DELETED state.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The lifecycle state of the App.
    AppId string
    Immutable. The globally unique, Firebase-assigned identifier for the IosApp. This identifier should be treated as an opaque token, as the data format is not specified.
    ExpireTime string
    Timestamp of when the App will be considered expired and cannot be undeleted. This value is only provided if the App is in the DELETED state.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The lifecycle state of the App.
    appId String
    Immutable. The globally unique, Firebase-assigned identifier for the IosApp. This identifier should be treated as an opaque token, as the data format is not specified.
    expireTime String
    Timestamp of when the App will be considered expired and cannot be undeleted. This value is only provided if the App is in the DELETED state.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The lifecycle state of the App.
    appId string
    Immutable. The globally unique, Firebase-assigned identifier for the IosApp. This identifier should be treated as an opaque token, as the data format is not specified.
    expireTime string
    Timestamp of when the App will be considered expired and cannot be undeleted. This value is only provided if the App is in the DELETED state.
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    The lifecycle state of the App.
    app_id str
    Immutable. The globally unique, Firebase-assigned identifier for the IosApp. This identifier should be treated as an opaque token, as the data format is not specified.
    expire_time str
    Timestamp of when the App will be considered expired and cannot be undeleted. This value is only provided if the App is in the DELETED state.
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    The lifecycle state of the App.
    appId String
    Immutable. The globally unique, Firebase-assigned identifier for the IosApp. This identifier should be treated as an opaque token, as the data format is not specified.
    expireTime String
    Timestamp of when the App will be considered expired and cannot be undeleted. This value is only provided if the App is in the DELETED state.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The lifecycle state of the App.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi