Cloudflare
AccessBookmark
Provides a Cloudflare Access Bookmark resource. Access Bookmark applications are not protected behind Access but are displayed in the App Launcher.
Example Usage
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;
class MyStack : Stack
{
public MyStack()
{
var myBookmarkApp = new Cloudflare.AccessBookmark("myBookmarkApp", new Cloudflare.AccessBookmarkArgs
{
AccountId = "1d5fdc9e88c8a8c4518b068cd94331fe",
AppLauncherVisible = true,
Domain = "example.com",
LogoUrl = "https://path-to-logo.com/example.png",
Name = "My Bookmark App",
});
}
}
package main
import (
"github.com/pulumi/pulumi-cloudflare/sdk/v4/go/cloudflare"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cloudflare.NewAccessBookmark(ctx, "myBookmarkApp", &cloudflare.AccessBookmarkArgs{
AccountId: pulumi.String("1d5fdc9e88c8a8c4518b068cd94331fe"),
AppLauncherVisible: pulumi.Bool(true),
Domain: pulumi.String("example.com"),
LogoUrl: pulumi.String("https://path-to-logo.com/example.png"),
Name: pulumi.String("My Bookmark App"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var myBookmarkApp = new AccessBookmark("myBookmarkApp", AccessBookmarkArgs.builder()
.accountId("1d5fdc9e88c8a8c4518b068cd94331fe")
.appLauncherVisible(true)
.domain("example.com")
.logoUrl("https://path-to-logo.com/example.png")
.name("My Bookmark App")
.build());
}
}
import pulumi
import pulumi_cloudflare as cloudflare
my_bookmark_app = cloudflare.AccessBookmark("myBookmarkApp",
account_id="1d5fdc9e88c8a8c4518b068cd94331fe",
app_launcher_visible=True,
domain="example.com",
logo_url="https://path-to-logo.com/example.png",
name="My Bookmark App")
import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";
const myBookmarkApp = new cloudflare.AccessBookmark("my_bookmark_app", {
accountId: "1d5fdc9e88c8a8c4518b068cd94331fe",
appLauncherVisible: true,
domain: "example.com",
logoUrl: "https://path-to-logo.com/example.png",
name: "My Bookmark App",
});
resources:
myBookmarkApp:
type: cloudflare:AccessBookmark
properties:
accountId: 1d5fdc9e88c8a8c4518b068cd94331fe
appLauncherVisible: true
domain: example.com
logoUrl: https://path-to-logo.com/example.png
name: My Bookmark App
Create a AccessBookmark Resource
new AccessBookmark(name: string, args: AccessBookmarkArgs, opts?: CustomResourceOptions);
@overload
def AccessBookmark(resource_name: str,
opts: Optional[ResourceOptions] = None,
account_id: Optional[str] = None,
app_launcher_visible: Optional[bool] = None,
domain: Optional[str] = None,
logo_url: Optional[str] = None,
name: Optional[str] = None,
zone_id: Optional[str] = None)
@overload
def AccessBookmark(resource_name: str,
args: AccessBookmarkArgs,
opts: Optional[ResourceOptions] = None)
func NewAccessBookmark(ctx *Context, name string, args AccessBookmarkArgs, opts ...ResourceOption) (*AccessBookmark, error)
public AccessBookmark(string name, AccessBookmarkArgs args, CustomResourceOptions? opts = null)
public AccessBookmark(String name, AccessBookmarkArgs args)
public AccessBookmark(String name, AccessBookmarkArgs args, CustomResourceOptions options)
type: cloudflare:AccessBookmark
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AccessBookmarkArgs
- 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 AccessBookmarkArgs
- 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 AccessBookmarkArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AccessBookmarkArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AccessBookmarkArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
AccessBookmark 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 AccessBookmark resource accepts the following input properties:
- Domain string
The domain of the bookmark application. Can include subdomains, paths, or both.
- Name string
Name of the bookmark application.
- Account
Id string The account to which the Access bookmark application should be added. Conflicts with
zone_id
.- App
Launcher boolVisible Option to show/hide the bookmark in the app launcher. Defaults to
true
.- Logo
Url string The image URL for the logo shown in the app launcher dashboard.
- Zone
Id string The DNS zone to which the Access bookmark application should be added. Conflicts with
account_id
.
- Domain string
The domain of the bookmark application. Can include subdomains, paths, or both.
- Name string
Name of the bookmark application.
- Account
Id string The account to which the Access bookmark application should be added. Conflicts with
zone_id
.- App
Launcher boolVisible Option to show/hide the bookmark in the app launcher. Defaults to
true
.- Logo
Url string The image URL for the logo shown in the app launcher dashboard.
- Zone
Id string The DNS zone to which the Access bookmark application should be added. Conflicts with
account_id
.
- domain String
The domain of the bookmark application. Can include subdomains, paths, or both.
- name String
Name of the bookmark application.
- account
Id String The account to which the Access bookmark application should be added. Conflicts with
zone_id
.- app
Launcher BooleanVisible Option to show/hide the bookmark in the app launcher. Defaults to
true
.- logo
Url String The image URL for the logo shown in the app launcher dashboard.
- zone
Id String The DNS zone to which the Access bookmark application should be added. Conflicts with
account_id
.
- domain string
The domain of the bookmark application. Can include subdomains, paths, or both.
- name string
Name of the bookmark application.
- account
Id string The account to which the Access bookmark application should be added. Conflicts with
zone_id
.- app
Launcher booleanVisible Option to show/hide the bookmark in the app launcher. Defaults to
true
.- logo
Url string The image URL for the logo shown in the app launcher dashboard.
- zone
Id string The DNS zone to which the Access bookmark application should be added. Conflicts with
account_id
.
- domain str
The domain of the bookmark application. Can include subdomains, paths, or both.
- name str
Name of the bookmark application.
- account_
id str The account to which the Access bookmark application should be added. Conflicts with
zone_id
.- app_
launcher_ boolvisible Option to show/hide the bookmark in the app launcher. Defaults to
true
.- logo_
url str The image URL for the logo shown in the app launcher dashboard.
- zone_
id str The DNS zone to which the Access bookmark application should be added. Conflicts with
account_id
.
- domain String
The domain of the bookmark application. Can include subdomains, paths, or both.
- name String
Name of the bookmark application.
- account
Id String The account to which the Access bookmark application should be added. Conflicts with
zone_id
.- app
Launcher BooleanVisible Option to show/hide the bookmark in the app launcher. Defaults to
true
.- logo
Url String The image URL for the logo shown in the app launcher dashboard.
- zone
Id String The DNS zone to which the Access bookmark application should be added. Conflicts with
account_id
.
Outputs
All input properties are implicitly available as output properties. Additionally, the AccessBookmark resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Id string
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
- id string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Look up an Existing AccessBookmark Resource
Get an existing AccessBookmark 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?: AccessBookmarkState, opts?: CustomResourceOptions): AccessBookmark
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
account_id: Optional[str] = None,
app_launcher_visible: Optional[bool] = None,
domain: Optional[str] = None,
logo_url: Optional[str] = None,
name: Optional[str] = None,
zone_id: Optional[str] = None) -> AccessBookmark
func GetAccessBookmark(ctx *Context, name string, id IDInput, state *AccessBookmarkState, opts ...ResourceOption) (*AccessBookmark, error)
public static AccessBookmark Get(string name, Input<string> id, AccessBookmarkState? state, CustomResourceOptions? opts = null)
public static AccessBookmark get(String name, Output<String> id, AccessBookmarkState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- 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.
- Account
Id string The account to which the Access bookmark application should be added. Conflicts with
zone_id
.- App
Launcher boolVisible Option to show/hide the bookmark in the app launcher. Defaults to
true
.- Domain string
The domain of the bookmark application. Can include subdomains, paths, or both.
- Logo
Url string The image URL for the logo shown in the app launcher dashboard.
- Name string
Name of the bookmark application.
- Zone
Id string The DNS zone to which the Access bookmark application should be added. Conflicts with
account_id
.
- Account
Id string The account to which the Access bookmark application should be added. Conflicts with
zone_id
.- App
Launcher boolVisible Option to show/hide the bookmark in the app launcher. Defaults to
true
.- Domain string
The domain of the bookmark application. Can include subdomains, paths, or both.
- Logo
Url string The image URL for the logo shown in the app launcher dashboard.
- Name string
Name of the bookmark application.
- Zone
Id string The DNS zone to which the Access bookmark application should be added. Conflicts with
account_id
.
- account
Id String The account to which the Access bookmark application should be added. Conflicts with
zone_id
.- app
Launcher BooleanVisible Option to show/hide the bookmark in the app launcher. Defaults to
true
.- domain String
The domain of the bookmark application. Can include subdomains, paths, or both.
- logo
Url String The image URL for the logo shown in the app launcher dashboard.
- name String
Name of the bookmark application.
- zone
Id String The DNS zone to which the Access bookmark application should be added. Conflicts with
account_id
.
- account
Id string The account to which the Access bookmark application should be added. Conflicts with
zone_id
.- app
Launcher booleanVisible Option to show/hide the bookmark in the app launcher. Defaults to
true
.- domain string
The domain of the bookmark application. Can include subdomains, paths, or both.
- logo
Url string The image URL for the logo shown in the app launcher dashboard.
- name string
Name of the bookmark application.
- zone
Id string The DNS zone to which the Access bookmark application should be added. Conflicts with
account_id
.
- account_
id str The account to which the Access bookmark application should be added. Conflicts with
zone_id
.- app_
launcher_ boolvisible Option to show/hide the bookmark in the app launcher. Defaults to
true
.- domain str
The domain of the bookmark application. Can include subdomains, paths, or both.
- logo_
url str The image URL for the logo shown in the app launcher dashboard.
- name str
Name of the bookmark application.
- zone_
id str The DNS zone to which the Access bookmark application should be added. Conflicts with
account_id
.
- account
Id String The account to which the Access bookmark application should be added. Conflicts with
zone_id
.- app
Launcher BooleanVisible Option to show/hide the bookmark in the app launcher. Defaults to
true
.- domain String
The domain of the bookmark application. Can include subdomains, paths, or both.
- logo
Url String The image URL for the logo shown in the app launcher dashboard.
- name String
Name of the bookmark application.
- zone
Id String The DNS zone to which the Access bookmark application should be added. Conflicts with
account_id
.
Import
Access Bookmarks can be imported using a composite ID formed of account ID and bookmark ID.
$ pulumi import cloudflare:index/accessBookmark:AccessBookmark my_bookmark cb029e245cfdd66dc8d2e570d5dd3322/d41d8cd98f00b204e9800998ecf8427e
Package Details
- Repository
- https://github.com/pulumi/pulumi-cloudflare
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
cloudflare
Terraform Provider.