com.pulumi.aws.resourceexplorer.View Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws Show documentation
Show all versions of aws Show documentation
A Pulumi package for creating and managing Amazon Web Services (AWS) 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.pulumi.aws.resourceexplorer;
import com.pulumi.aws.Utilities;
import com.pulumi.aws.resourceexplorer.ViewArgs;
import com.pulumi.aws.resourceexplorer.inputs.ViewState;
import com.pulumi.aws.resourceexplorer.outputs.ViewFilters;
import com.pulumi.aws.resourceexplorer.outputs.ViewIncludedProperty;
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.Boolean;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Provides a resource to manage a Resource Explorer view.
*
* ## Example Usage
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.aws.resourceexplorer.Index;
* import com.pulumi.aws.resourceexplorer.IndexArgs;
* import com.pulumi.aws.resourceexplorer.View;
* import com.pulumi.aws.resourceexplorer.ViewArgs;
* import com.pulumi.aws.resourceexplorer.inputs.ViewFiltersArgs;
* import com.pulumi.aws.resourceexplorer.inputs.ViewIncludedPropertyArgs;
* import com.pulumi.resources.CustomResourceOptions;
* 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 Index("example", IndexArgs.builder()
* .type("LOCAL")
* .build());
*
* var exampleView = new View("exampleView", ViewArgs.builder()
* .name("exampleview")
* .filters(ViewFiltersArgs.builder()
* .filterString("resourcetype:ec2:instance")
* .build())
* .includedProperties(ViewIncludedPropertyArgs.builder()
* .name("tags")
* .build())
* .build(), CustomResourceOptions.builder()
* .dependsOn(example)
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ## Import
*
* Using `pulumi import`, import Resource Explorer views using the `arn`. For example:
*
* ```sh
* $ pulumi import aws:resourceexplorer/view:View example arn:aws:resource-explorer-2:us-west-2:123456789012:view/exampleview/e0914f6c-6c27-4b47-b5d4-6b28381a2421
* ```
*
*/
@ResourceType(type="aws:resourceexplorer/view:View")
public class View extends com.pulumi.resources.CustomResource {
/**
* Amazon Resource Name (ARN) of the Resource Explorer view.
*
*/
@Export(name="arn", refs={String.class}, tree="[0]")
private Output arn;
/**
* @return Amazon Resource Name (ARN) of the Resource Explorer view.
*
*/
public Output arn() {
return this.arn;
}
/**
* Specifies whether the view is the [_default view_](https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-views-about.html#manage-views-about-default) for the AWS Region. Default: `false`.
*
*/
@Export(name="defaultView", refs={Boolean.class}, tree="[0]")
private Output defaultView;
/**
* @return Specifies whether the view is the [_default view_](https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-views-about.html#manage-views-about-default) for the AWS Region. Default: `false`.
*
*/
public Output defaultView() {
return this.defaultView;
}
/**
* Specifies which resources are included in the results of queries made using this view. See Filters below for more details.
*
*/
@Export(name="filters", refs={ViewFilters.class}, tree="[0]")
private Output filters;
/**
* @return Specifies which resources are included in the results of queries made using this view. See Filters below for more details.
*
*/
public Output> filters() {
return Codegen.optional(this.filters);
}
/**
* Optional fields to be included in search results from this view. See Included Properties below for more details.
*
*/
@Export(name="includedProperties", refs={List.class,ViewIncludedProperty.class}, tree="[0,1]")
private Output> includedProperties;
/**
* @return Optional fields to be included in search results from this view. See Included Properties below for more details.
*
*/
public Output>> includedProperties() {
return Codegen.optional(this.includedProperties);
}
/**
* The name of the view. The name must be no more than 64 characters long, and can include letters, digits, and the dash (-) character. The name must be unique within its AWS Region.
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return The name of the view. The name must be no more than 64 characters long, and can include letters, digits, and the dash (-) character. The name must be unique within its AWS Region.
*
*/
public Output name() {
return this.name;
}
/**
* The root ARN of the account, an organizational unit (OU), or an organization ARN. If left empty, the default is account.
*
*/
@Export(name="scope", refs={String.class}, tree="[0]")
private Output scope;
/**
* @return The root ARN of the account, an organizational unit (OU), or an organization ARN. If left empty, the default is account.
*
*/
public Output scope() {
return this.scope;
}
/**
* Key-value map of resource tags. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
*/
@Export(name="tags", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> tags;
/**
* @return Key-value map of resource tags. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
*/
public Output>> tags() {
return Codegen.optional(this.tags);
}
/**
* A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
* @deprecated
* Please use `tags` instead.
*
*/
@Deprecated /* Please use `tags` instead. */
@Export(name="tagsAll", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> tagsAll;
/**
* @return A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
*/
public Output> tagsAll() {
return this.tagsAll;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public View(java.lang.String name) {
this(name, ViewArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public View(java.lang.String name, @Nullable ViewArgs 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 View(java.lang.String name, @Nullable ViewArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:resourceexplorer/view:View", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private View(java.lang.String name, Output id, @Nullable ViewState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:resourceexplorer/view:View", name, state, makeResourceOptions(options, id), false);
}
private static ViewArgs makeArgs(@Nullable ViewArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? ViewArgs.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 View get(java.lang.String name, Output id, @Nullable ViewState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new View(name, id, state, options);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy