com.pulumi.aws.ec2.VpcIpamScope 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.ec2;
import com.pulumi.aws.Utilities;
import com.pulumi.aws.ec2.VpcIpamScopeArgs;
import com.pulumi.aws.ec2.inputs.VpcIpamScopeState;
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.Integer;
import java.lang.String;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Creates a scope for AWS IPAM.
*
* ## Example Usage
*
* Basic usage:
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.aws.AwsFunctions;
* import com.pulumi.aws.inputs.GetRegionArgs;
* import com.pulumi.aws.ec2.VpcIpam;
* import com.pulumi.aws.ec2.VpcIpamArgs;
* import com.pulumi.aws.ec2.inputs.VpcIpamOperatingRegionArgs;
* import com.pulumi.aws.ec2.VpcIpamScope;
* import com.pulumi.aws.ec2.VpcIpamScopeArgs;
* 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) {
* final var current = AwsFunctions.getRegion();
*
* var example = new VpcIpam("example", VpcIpamArgs.builder()
* .operatingRegions(VpcIpamOperatingRegionArgs.builder()
* .regionName(current.applyValue(getRegionResult -> getRegionResult.name()))
* .build())
* .build());
*
* var exampleVpcIpamScope = new VpcIpamScope("exampleVpcIpamScope", VpcIpamScopeArgs.builder()
* .ipamId(example.id())
* .description("Another Scope")
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ## Import
*
* Using `pulumi import`, import IPAMs using the `scope_id`. For example:
*
* ```sh
* $ pulumi import aws:ec2/vpcIpamScope:VpcIpamScope example ipam-scope-0513c69f283d11dfb
* ```
*
*/
@ResourceType(type="aws:ec2/vpcIpamScope:VpcIpamScope")
public class VpcIpamScope extends com.pulumi.resources.CustomResource {
/**
* The Amazon Resource Name (ARN) of the scope.
*
*/
@Export(name="arn", refs={String.class}, tree="[0]")
private Output arn;
/**
* @return The Amazon Resource Name (ARN) of the scope.
*
*/
public Output arn() {
return this.arn;
}
/**
* A description for the scope you're creating.
*
*/
@Export(name="description", refs={String.class}, tree="[0]")
private Output description;
/**
* @return A description for the scope you're creating.
*
*/
public Output> description() {
return Codegen.optional(this.description);
}
/**
* The ARN of the IPAM for which you're creating this scope.
*
*/
@Export(name="ipamArn", refs={String.class}, tree="[0]")
private Output ipamArn;
/**
* @return The ARN of the IPAM for which you're creating this scope.
*
*/
public Output ipamArn() {
return this.ipamArn;
}
/**
* The ID of the IPAM for which you're creating this scope.
*
*/
@Export(name="ipamId", refs={String.class}, tree="[0]")
private Output ipamId;
/**
* @return The ID of the IPAM for which you're creating this scope.
*
*/
public Output ipamId() {
return this.ipamId;
}
@Export(name="ipamScopeType", refs={String.class}, tree="[0]")
private Output ipamScopeType;
public Output ipamScopeType() {
return this.ipamScopeType;
}
/**
* Defines if the scope is the default scope or not.
*
*/
@Export(name="isDefault", refs={Boolean.class}, tree="[0]")
private Output isDefault;
/**
* @return Defines if the scope is the default scope or not.
*
*/
public Output isDefault() {
return this.isDefault;
}
/**
* The number of pools in the scope.
*
*/
@Export(name="poolCount", refs={Integer.class}, tree="[0]")
private Output poolCount;
/**
* @return The number of pools in the scope.
*
*/
public Output poolCount() {
return this.poolCount;
}
/**
* Key-value mapping 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 mapping 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);
}
/**
* @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;
public Output> tagsAll() {
return this.tagsAll;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public VpcIpamScope(java.lang.String name) {
this(name, VpcIpamScopeArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public VpcIpamScope(java.lang.String name, VpcIpamScopeArgs 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 VpcIpamScope(java.lang.String name, VpcIpamScopeArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:ec2/vpcIpamScope:VpcIpamScope", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private VpcIpamScope(java.lang.String name, Output id, @Nullable VpcIpamScopeState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:ec2/vpcIpamScope:VpcIpamScope", name, state, makeResourceOptions(options, id), false);
}
private static VpcIpamScopeArgs makeArgs(VpcIpamScopeArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? VpcIpamScopeArgs.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 VpcIpamScope get(java.lang.String name, Output id, @Nullable VpcIpamScopeState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new VpcIpamScope(name, id, state, options);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy