com.pulumi.meraki.organizations.BrandingPolicies Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of meraki Show documentation
Show all versions of meraki Show documentation
A Pulumi package for creating and managing Cisco Meraki resources
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.meraki.organizations;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import com.pulumi.meraki.Utilities;
import com.pulumi.meraki.organizations.BrandingPoliciesArgs;
import com.pulumi.meraki.organizations.inputs.BrandingPoliciesState;
import com.pulumi.meraki.organizations.outputs.BrandingPoliciesAdminSettings;
import com.pulumi.meraki.organizations.outputs.BrandingPoliciesCustomLogo;
import com.pulumi.meraki.organizations.outputs.BrandingPoliciesHelpSettings;
import java.lang.Boolean;
import java.lang.String;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* ## Example Usage
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.meraki.organizations.BrandingPolicies;
* import com.pulumi.meraki.organizations.BrandingPoliciesArgs;
* import com.pulumi.meraki.organizations.inputs.BrandingPoliciesAdminSettingsArgs;
* import com.pulumi.meraki.organizations.inputs.BrandingPoliciesCustomLogoArgs;
* import com.pulumi.meraki.organizations.inputs.BrandingPoliciesCustomLogoImageArgs;
* import com.pulumi.meraki.organizations.inputs.BrandingPoliciesHelpSettingsArgs;
* import java.util.List;
* import java.util.ArrayList;
* 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 example = new BrandingPolicies("example", BrandingPoliciesArgs.builder()
* .adminSettings(BrandingPoliciesAdminSettingsArgs.builder()
* .applies_to("All admins of networks...")
* .values(
* "N_1234",
* "L_5678")
* .build())
* .customLogo(BrandingPoliciesCustomLogoArgs.builder()
* .enabled(true)
* .image(BrandingPoliciesCustomLogoImageArgs.builder()
* .contents("Hyperg26C8F4h8CvcoUqpA==")
* .format("jpg")
* .build())
* .build())
* .enabled(true)
* .helpSettings(BrandingPoliciesHelpSettingsArgs.builder()
* .api_docs_subtab("default or inherit")
* .cases_subtab("hide")
* .cisco_meraki_product_documentation("show")
* .community_subtab("show")
* .data_protection_requests_subtab("default or inherit")
* .firewall_info_subtab("hide")
* .get_help_subtab("default or inherit")
* .get_help_subtab_knowledge_base_search("Some custom HTML content
")
* .hardware_replacements_subtab("hide")
* .help_tab("show")
* .help_widget("hide")
* .new_features_subtab("show")
* .sm_forums("hide")
* .support_contact_info("show")
* .universal_search_knowledge_base_search("hide")
* .build())
* .name("My Branding Policy")
* .organizationId("string")
* .build());
*
* ctx.export("merakiOrganizationsBrandingPoliciesExample", example);
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ## Import
*
* ```sh
* $ pulumi import meraki:organizations/brandingPolicies:BrandingPolicies example "branding_policy_id,organization_id"
* ```
*
*/
@ResourceType(type="meraki:organizations/brandingPolicies:BrandingPolicies")
public class BrandingPolicies extends com.pulumi.resources.CustomResource {
/**
* Settings for describing which kinds of admins this policy applies to.
*
*/
@Export(name="adminSettings", refs={BrandingPoliciesAdminSettings.class}, tree="[0]")
private Output adminSettings;
/**
* @return Settings for describing which kinds of admins this policy applies to.
*
*/
public Output adminSettings() {
return this.adminSettings;
}
/**
* brandingPolicyId path parameter. Branding policy ID
*
*/
@Export(name="brandingPolicyId", refs={String.class}, tree="[0]")
private Output brandingPolicyId;
/**
* @return brandingPolicyId path parameter. Branding policy ID
*
*/
public Output> brandingPolicyId() {
return Codegen.optional(this.brandingPolicyId);
}
/**
* Properties describing the custom logo attached to the branding policy.
*
*/
@Export(name="customLogo", refs={BrandingPoliciesCustomLogo.class}, tree="[0]")
private Output customLogo;
/**
* @return Properties describing the custom logo attached to the branding policy.
*
*/
public Output customLogo() {
return this.customLogo;
}
/**
* Boolean indicating whether this policy is enabled.
*
*/
@Export(name="enabled", refs={Boolean.class}, tree="[0]")
private Output enabled;
/**
* @return Boolean indicating whether this policy is enabled.
*
*/
public Output enabled() {
return this.enabled;
}
/**
* Settings for describing the modifications to various Help page features. Each property in this object accepts one of
* 'default or inherit' (do not modify functionality), 'hide' (remove the section from Dashboard), or 'show' (always show
* the section on Dashboard). Some properties in this object also accept custom HTML used to replace the section on
* Dashboard; see the documentation for each property to see the allowed values.
*
*/
@Export(name="helpSettings", refs={BrandingPoliciesHelpSettings.class}, tree="[0]")
private Output helpSettings;
/**
* @return Settings for describing the modifications to various Help page features. Each property in this object accepts one of
* 'default or inherit' (do not modify functionality), 'hide' (remove the section from Dashboard), or 'show' (always show
* the section on Dashboard). Some properties in this object also accept custom HTML used to replace the section on
* Dashboard; see the documentation for each property to see the allowed values.
*
*/
public Output helpSettings() {
return this.helpSettings;
}
/**
* Name of the Dashboard branding policy.
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return Name of the Dashboard branding policy.
*
*/
public Output name() {
return this.name;
}
/**
* organizationId path parameter. Organization ID
*
*/
@Export(name="organizationId", refs={String.class}, tree="[0]")
private Output organizationId;
/**
* @return organizationId path parameter. Organization ID
*
*/
public Output organizationId() {
return this.organizationId;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public BrandingPolicies(java.lang.String name) {
this(name, BrandingPoliciesArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public BrandingPolicies(java.lang.String name, BrandingPoliciesArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public BrandingPolicies(java.lang.String name, BrandingPoliciesArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("meraki:organizations/brandingPolicies:BrandingPolicies", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private BrandingPolicies(java.lang.String name, Output id, @Nullable BrandingPoliciesState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("meraki:organizations/brandingPolicies:BrandingPolicies", name, state, makeResourceOptions(options, id), false);
}
private static BrandingPoliciesArgs makeArgs(BrandingPoliciesArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? BrandingPoliciesArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static BrandingPolicies get(java.lang.String name, Output id, @Nullable BrandingPoliciesState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new BrandingPolicies(name, id, state, options);
}
}