com.pulumi.azure.apimanagement.ProductArgs Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure Show documentation
Show all versions of azure Show documentation
A Pulumi package for creating and managing Microsoft Azure cloud resources, based on the Terraform azurerm provider. We recommend using the [Azure Native provider](https://github.com/pulumi/pulumi-azure-native) to provision Azure infrastructure. Azure Native provides complete coverage of Azure resources and same-day access to new resources and resource updates.
// *** 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.azure.apimanagement;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.Boolean;
import java.lang.Integer;
import java.lang.String;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class ProductArgs extends com.pulumi.resources.ResourceArgs {
public static final ProductArgs Empty = new ProductArgs();
/**
* The name of the API Management Service. Changing this forces a new resource to be created.
*
*/
@Import(name="apiManagementName", required=true)
private Output apiManagementName;
/**
* @return The name of the API Management Service. Changing this forces a new resource to be created.
*
*/
public Output apiManagementName() {
return this.apiManagementName;
}
/**
* Do subscribers need to be approved prior to being able to use the Product?
*
* > **NOTE:** `approval_required` can only be set when `subscription_required` is set to `true`.
*
*/
@Import(name="approvalRequired")
private @Nullable Output approvalRequired;
/**
* @return Do subscribers need to be approved prior to being able to use the Product?
*
* > **NOTE:** `approval_required` can only be set when `subscription_required` is set to `true`.
*
*/
public Optional> approvalRequired() {
return Optional.ofNullable(this.approvalRequired);
}
/**
* A description of this Product, which may include HTML formatting tags.
*
*/
@Import(name="description")
private @Nullable Output description;
/**
* @return A description of this Product, which may include HTML formatting tags.
*
*/
public Optional> description() {
return Optional.ofNullable(this.description);
}
/**
* The Display Name for this API Management Product.
*
*/
@Import(name="displayName", required=true)
private Output displayName;
/**
* @return The Display Name for this API Management Product.
*
*/
public Output displayName() {
return this.displayName;
}
/**
* The Identifier for this Product, which must be unique within the API Management Service. Changing this forces a new resource to be created.
*
*/
@Import(name="productId", required=true)
private Output productId;
/**
* @return The Identifier for this Product, which must be unique within the API Management Service. Changing this forces a new resource to be created.
*
*/
public Output productId() {
return this.productId;
}
/**
* Is this Product Published?
*
*/
@Import(name="published", required=true)
private Output published;
/**
* @return Is this Product Published?
*
*/
public Output published() {
return this.published;
}
/**
* The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created.
*
*/
@Import(name="resourceGroupName", required=true)
private Output resourceGroupName;
/**
* @return The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created.
*
*/
public Output resourceGroupName() {
return this.resourceGroupName;
}
/**
* Is a Subscription required to access API's included in this Product? Defaults to `true`.
*
*/
@Import(name="subscriptionRequired")
private @Nullable Output subscriptionRequired;
/**
* @return Is a Subscription required to access API's included in this Product? Defaults to `true`.
*
*/
public Optional> subscriptionRequired() {
return Optional.ofNullable(this.subscriptionRequired);
}
/**
* The number of subscriptions a user can have to this Product at the same time.
*
* > **NOTE:** `subscriptions_limit` can only be set when `subscription_required` is set to `true`.
*
*/
@Import(name="subscriptionsLimit")
private @Nullable Output subscriptionsLimit;
/**
* @return The number of subscriptions a user can have to this Product at the same time.
*
* > **NOTE:** `subscriptions_limit` can only be set when `subscription_required` is set to `true`.
*
*/
public Optional> subscriptionsLimit() {
return Optional.ofNullable(this.subscriptionsLimit);
}
/**
* The Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.
*
*/
@Import(name="terms")
private @Nullable Output terms;
/**
* @return The Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.
*
*/
public Optional> terms() {
return Optional.ofNullable(this.terms);
}
private ProductArgs() {}
private ProductArgs(ProductArgs $) {
this.apiManagementName = $.apiManagementName;
this.approvalRequired = $.approvalRequired;
this.description = $.description;
this.displayName = $.displayName;
this.productId = $.productId;
this.published = $.published;
this.resourceGroupName = $.resourceGroupName;
this.subscriptionRequired = $.subscriptionRequired;
this.subscriptionsLimit = $.subscriptionsLimit;
this.terms = $.terms;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(ProductArgs defaults) {
return new Builder(defaults);
}
public static final class Builder {
private ProductArgs $;
public Builder() {
$ = new ProductArgs();
}
public Builder(ProductArgs defaults) {
$ = new ProductArgs(Objects.requireNonNull(defaults));
}
/**
* @param apiManagementName The name of the API Management Service. Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder apiManagementName(Output apiManagementName) {
$.apiManagementName = apiManagementName;
return this;
}
/**
* @param apiManagementName The name of the API Management Service. Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder apiManagementName(String apiManagementName) {
return apiManagementName(Output.of(apiManagementName));
}
/**
* @param approvalRequired Do subscribers need to be approved prior to being able to use the Product?
*
* > **NOTE:** `approval_required` can only be set when `subscription_required` is set to `true`.
*
* @return builder
*
*/
public Builder approvalRequired(@Nullable Output approvalRequired) {
$.approvalRequired = approvalRequired;
return this;
}
/**
* @param approvalRequired Do subscribers need to be approved prior to being able to use the Product?
*
* > **NOTE:** `approval_required` can only be set when `subscription_required` is set to `true`.
*
* @return builder
*
*/
public Builder approvalRequired(Boolean approvalRequired) {
return approvalRequired(Output.of(approvalRequired));
}
/**
* @param description A description of this Product, which may include HTML formatting tags.
*
* @return builder
*
*/
public Builder description(@Nullable Output description) {
$.description = description;
return this;
}
/**
* @param description A description of this Product, which may include HTML formatting tags.
*
* @return builder
*
*/
public Builder description(String description) {
return description(Output.of(description));
}
/**
* @param displayName The Display Name for this API Management Product.
*
* @return builder
*
*/
public Builder displayName(Output displayName) {
$.displayName = displayName;
return this;
}
/**
* @param displayName The Display Name for this API Management Product.
*
* @return builder
*
*/
public Builder displayName(String displayName) {
return displayName(Output.of(displayName));
}
/**
* @param productId The Identifier for this Product, which must be unique within the API Management Service. Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder productId(Output productId) {
$.productId = productId;
return this;
}
/**
* @param productId The Identifier for this Product, which must be unique within the API Management Service. Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder productId(String productId) {
return productId(Output.of(productId));
}
/**
* @param published Is this Product Published?
*
* @return builder
*
*/
public Builder published(Output published) {
$.published = published;
return this;
}
/**
* @param published Is this Product Published?
*
* @return builder
*
*/
public Builder published(Boolean published) {
return published(Output.of(published));
}
/**
* @param resourceGroupName The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder resourceGroupName(Output resourceGroupName) {
$.resourceGroupName = resourceGroupName;
return this;
}
/**
* @param resourceGroupName The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder resourceGroupName(String resourceGroupName) {
return resourceGroupName(Output.of(resourceGroupName));
}
/**
* @param subscriptionRequired Is a Subscription required to access API's included in this Product? Defaults to `true`.
*
* @return builder
*
*/
public Builder subscriptionRequired(@Nullable Output subscriptionRequired) {
$.subscriptionRequired = subscriptionRequired;
return this;
}
/**
* @param subscriptionRequired Is a Subscription required to access API's included in this Product? Defaults to `true`.
*
* @return builder
*
*/
public Builder subscriptionRequired(Boolean subscriptionRequired) {
return subscriptionRequired(Output.of(subscriptionRequired));
}
/**
* @param subscriptionsLimit The number of subscriptions a user can have to this Product at the same time.
*
* > **NOTE:** `subscriptions_limit` can only be set when `subscription_required` is set to `true`.
*
* @return builder
*
*/
public Builder subscriptionsLimit(@Nullable Output subscriptionsLimit) {
$.subscriptionsLimit = subscriptionsLimit;
return this;
}
/**
* @param subscriptionsLimit The number of subscriptions a user can have to this Product at the same time.
*
* > **NOTE:** `subscriptions_limit` can only be set when `subscription_required` is set to `true`.
*
* @return builder
*
*/
public Builder subscriptionsLimit(Integer subscriptionsLimit) {
return subscriptionsLimit(Output.of(subscriptionsLimit));
}
/**
* @param terms The Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.
*
* @return builder
*
*/
public Builder terms(@Nullable Output terms) {
$.terms = terms;
return this;
}
/**
* @param terms The Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.
*
* @return builder
*
*/
public Builder terms(String terms) {
return terms(Output.of(terms));
}
public ProductArgs build() {
if ($.apiManagementName == null) {
throw new MissingRequiredPropertyException("ProductArgs", "apiManagementName");
}
if ($.displayName == null) {
throw new MissingRequiredPropertyException("ProductArgs", "displayName");
}
if ($.productId == null) {
throw new MissingRequiredPropertyException("ProductArgs", "productId");
}
if ($.published == null) {
throw new MissingRequiredPropertyException("ProductArgs", "published");
}
if ($.resourceGroupName == null) {
throw new MissingRequiredPropertyException("ProductArgs", "resourceGroupName");
}
return $;
}
}
}