AppProfile

App profile is a configuration object describing how Cloud Bigtable should treat traffic from a particular end user application.

Create a AppProfile Resource

new AppProfile(name: string, args: AppProfileArgs, opts?: CustomResourceOptions);

def AppProfile(resource_name, opts=None, app_profile_id=None, description=None, ignore_warnings=None, instance=None, multi_cluster_routing_use_any=None, project=None, single_cluster_routing=None, __props__=None);

func NewAppProfile(ctx *Context, name string, args AppProfileArgs, opts ...ResourceOption) (*AppProfile, error)

public AppProfile(string name, AppProfileArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args AppProfileArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args AppProfileArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AppProfileArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

AppProfile Resource Properties

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

Inputs

The AppProfile resource accepts the following input properties:

AppProfileId string: The unique name of the app profile in the form [_a-zA-Z0-9][-_.a-zA-Z0-9]*.
Description string: Long form description of the use case for this app profile.
IgnoreWarnings bool: If true, ignore safety checks when deleting/updating the app profile.
Instance string: The name of the instance to create the app profile within.
MultiClusterRoutingUseAny bool: If true, read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays. Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes consistency to improve availability.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
SingleClusterRouting AppProfileSingleClusterRoutingArgs: Use a single-cluster routing policy. Structure is documented below.

AppProfileId string: The unique name of the app profile in the form [_a-zA-Z0-9][-_.a-zA-Z0-9]*.
Description string: Long form description of the use case for this app profile.
IgnoreWarnings bool: If true, ignore safety checks when deleting/updating the app profile.
Instance string: The name of the instance to create the app profile within.
MultiClusterRoutingUseAny bool: If true, read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays. Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes consistency to improve availability.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
SingleClusterRouting AppProfileSingleClusterRouting: Use a single-cluster routing policy. Structure is documented below.

appProfileId string: The unique name of the app profile in the form [_a-zA-Z0-9][-_.a-zA-Z0-9]*.
description string: Long form description of the use case for this app profile.
ignoreWarnings boolean: If true, ignore safety checks when deleting/updating the app profile.
instance string: The name of the instance to create the app profile within.
multiClusterRoutingUseAny boolean: If true, read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays. Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes consistency to improve availability.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
singleClusterRouting AppProfileSingleClusterRouting: Use a single-cluster routing policy. Structure is documented below.

app_profile_id str: The unique name of the app profile in the form [_a-zA-Z0-9][-_.a-zA-Z0-9]*.
description str: Long form description of the use case for this app profile.
ignore_warnings bool: If true, ignore safety checks when deleting/updating the app profile.
instance str: The name of the instance to create the app profile within.
multi_cluster_routing_use_any bool: If true, read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays. Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes consistency to improve availability.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
single_cluster_routing Dict[AppProfileSingleClusterRouting]: Use a single-cluster routing policy. Structure is documented below.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
Name string: The unique name of the requested app profile. Values are of the form ‘projects//instances//appProfiles/’.

Id string: The provider-assigned unique ID for this managed resource.
Name string: The unique name of the requested app profile. Values are of the form ‘projects//instances//appProfiles/’.

id string: The provider-assigned unique ID for this managed resource.
name string: The unique name of the requested app profile. Values are of the form ‘projects//instances//appProfiles/’.

id str: The provider-assigned unique ID for this managed resource.
name str: The unique name of the requested app profile. Values are of the form ‘projects//instances//appProfiles/’.

Look up an Existing AppProfile Resource

Get an existing AppProfile resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: AppProfileState, opts?: CustomResourceOptions): AppProfile

static get(resource_name, id, opts=None, app_profile_id=None, description=None, ignore_warnings=None, instance=None, multi_cluster_routing_use_any=None, name=None, project=None, single_cluster_routing=None, __props__=None);

func GetAppProfile(ctx *Context, name string, id IDInput, state *AppProfileState, opts ...ResourceOption) (*AppProfile, error)

public static AppProfile Get(string name, Input<string> id, AppProfileState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AppProfileId string: The unique name of the app profile in the form [_a-zA-Z0-9][-_.a-zA-Z0-9]*.
Description string: Long form description of the use case for this app profile.
IgnoreWarnings bool: If true, ignore safety checks when deleting/updating the app profile.
Instance string: The name of the instance to create the app profile within.
MultiClusterRoutingUseAny bool: If true, read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays. Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes consistency to improve availability.
Name string: The unique name of the requested app profile. Values are of the form ‘projects//instances//appProfiles/’.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
SingleClusterRouting AppProfileSingleClusterRoutingArgs: Use a single-cluster routing policy. Structure is documented below.

AppProfileId string: The unique name of the app profile in the form [_a-zA-Z0-9][-_.a-zA-Z0-9]*.
Description string: Long form description of the use case for this app profile.
IgnoreWarnings bool: If true, ignore safety checks when deleting/updating the app profile.
Instance string: The name of the instance to create the app profile within.
MultiClusterRoutingUseAny bool: If true, read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays. Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes consistency to improve availability.
Name string: The unique name of the requested app profile. Values are of the form ‘projects//instances//appProfiles/’.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
SingleClusterRouting AppProfileSingleClusterRouting: Use a single-cluster routing policy. Structure is documented below.

appProfileId string: The unique name of the app profile in the form [_a-zA-Z0-9][-_.a-zA-Z0-9]*.
description string: Long form description of the use case for this app profile.
ignoreWarnings boolean: If true, ignore safety checks when deleting/updating the app profile.
instance string: The name of the instance to create the app profile within.
multiClusterRoutingUseAny boolean: If true, read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays. Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes consistency to improve availability.
name string: The unique name of the requested app profile. Values are of the form ‘projects//instances//appProfiles/’.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
singleClusterRouting AppProfileSingleClusterRouting: Use a single-cluster routing policy. Structure is documented below.

app_profile_id str: The unique name of the app profile in the form [_a-zA-Z0-9][-_.a-zA-Z0-9]*.
description str: Long form description of the use case for this app profile.
ignore_warnings bool: If true, ignore safety checks when deleting/updating the app profile.
instance str: The name of the instance to create the app profile within.
multi_cluster_routing_use_any bool: If true, read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays. Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes consistency to improve availability.
name str: The unique name of the requested app profile. Values are of the form ‘projects//instances//appProfiles/’.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
single_cluster_routing Dict[AppProfileSingleClusterRouting]: Use a single-cluster routing policy. Structure is documented below.

Supporting Types

AppProfileSingleClusterRouting

See the input and output API doc for this type.

ClusterId string: The cluster to which read/write requests should be routed.
AllowTransactionalWrites bool: If true, CheckAndMutateRow and ReadModifyWriteRow requests are allowed by this app profile. It is unsafe to send these requests to the same table/row/column in multiple clusters.

ClusterId string: The cluster to which read/write requests should be routed.
AllowTransactionalWrites bool: If true, CheckAndMutateRow and ReadModifyWriteRow requests are allowed by this app profile. It is unsafe to send these requests to the same table/row/column in multiple clusters.

clusterId string: The cluster to which read/write requests should be routed.
allowTransactionalWrites boolean: If true, CheckAndMutateRow and ReadModifyWriteRow requests are allowed by this app profile. It is unsafe to send these requests to the same table/row/column in multiple clusters.

cluster_id str: The cluster to which read/write requests should be routed.
allowTransactionalWrites bool: If true, CheckAndMutateRow and ReadModifyWriteRow requests are allowed by this app profile. It is unsafe to send these requests to the same table/row/column in multiple clusters.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud