com.equinix.pulumi.metal.Organization Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of equinix Show documentation
Show all versions of equinix Show documentation
A Pulumi package for creating and managing equinix cloud 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.equinix.pulumi.metal;
import com.equinix.pulumi.Utilities;
import com.equinix.pulumi.metal.OrganizationArgs;
import com.equinix.pulumi.metal.inputs.OrganizationState;
import com.equinix.pulumi.metal.outputs.OrganizationAddress;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.String;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Provides a resource to manage organization resource in Equinix Metal.
*
* ## Example Usage
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.equinix.metal.Organization;
* import com.pulumi.equinix.metal.OrganizationArgs;
* 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 tfOrganization1 = new Organization("tfOrganization1", OrganizationArgs.builder()
* .name("foobar")
* .description("quux")
* .build());
*
* }
* }
* }
*
*
* ## Import
*
* This resource can be imported using an existing organization ID:
*
* ```sh
* $ pulumi import equinix:metal/organization:Organization equinix_metal_organization {existing_organization_id}
* ```
*
*/
@ResourceType(type="equinix:metal/organization:Organization")
public class Organization extends com.pulumi.resources.CustomResource {
/**
* An object that has the address information. See Address below for more details.
*
*/
@Export(name="address", refs={OrganizationAddress.class}, tree="[0]")
private Output* @Nullable */ OrganizationAddress> address;
/**
* @return An object that has the address information. See Address below for more details.
*
*/
public Output> address() {
return Codegen.optional(this.address);
}
/**
* The timestamp for when the organization was created.
*
*/
@Export(name="created", refs={String.class}, tree="[0]")
private Output created;
/**
* @return The timestamp for when the organization was created.
*
*/
public Output created() {
return this.created;
}
/**
* Description string.
*
*/
@Export(name="description", refs={String.class}, tree="[0]")
private Output description;
/**
* @return Description string.
*
*/
public Output description() {
return this.description;
}
/**
* Logo URL.
*
* @deprecated
* The default (empty string) is the only valid value. Support for this field has been removed from the API
*
*/
@Deprecated /* The default (empty string) is the only valid value. Support for this field has been removed from the API */
@Export(name="logo", refs={String.class}, tree="[0]")
private Output logo;
/**
* @return Logo URL.
*
*/
public Output logo() {
return this.logo;
}
/**
* The name of the Organization.
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return The name of the Organization.
*
*/
public Output name() {
return this.name;
}
/**
* Twitter handle.
*
*/
@Export(name="twitter", refs={String.class}, tree="[0]")
private Output twitter;
/**
* @return Twitter handle.
*
*/
public Output twitter() {
return this.twitter;
}
/**
* The timestamp for the last time the organization was updated.
*
*/
@Export(name="updated", refs={String.class}, tree="[0]")
private Output updated;
/**
* @return The timestamp for the last time the organization was updated.
*
*/
public Output updated() {
return this.updated;
}
/**
* Website link.
*
*/
@Export(name="website", refs={String.class}, tree="[0]")
private Output website;
/**
* @return Website link.
*
*/
public Output website() {
return this.website;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public Organization(java.lang.String name) {
this(name, OrganizationArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public Organization(java.lang.String name, @Nullable OrganizationArgs 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 Organization(java.lang.String name, @Nullable OrganizationArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("equinix:metal/organization:Organization", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private Organization(java.lang.String name, Output id, @Nullable OrganizationState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("equinix:metal/organization:Organization", name, state, makeResourceOptions(options, id), false);
}
private static OrganizationArgs makeArgs(@Nullable OrganizationArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? OrganizationArgs.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 Organization get(java.lang.String name, Output id, @Nullable OrganizationState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new Organization(name, id, state, options);
}
}