com.pulumi.googlenative.apigateway.v1.ApiIamPolicyArgs Maven / Gradle / Ivy
// *** 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.googlenative.apigateway.v1;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.googlenative.apigateway.v1.inputs.ApigatewayAuditConfigArgs;
import com.pulumi.googlenative.apigateway.v1.inputs.ApigatewayBindingArgs;
import java.lang.Integer;
import java.lang.String;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class ApiIamPolicyArgs extends com.pulumi.resources.ResourceArgs {
public static final ApiIamPolicyArgs Empty = new ApiIamPolicyArgs();
@Import(name="apiId", required=true)
private Output apiId;
public Output apiId() {
return this.apiId;
}
/**
* Specifies cloud audit logging configuration for this policy.
*
*/
@Import(name="auditConfigs")
private @Nullable Output> auditConfigs;
/**
* @return Specifies cloud audit logging configuration for this policy.
*
*/
public Optional>> auditConfigs() {
return Optional.ofNullable(this.auditConfigs);
}
/**
* Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
*
*/
@Import(name="bindings")
private @Nullable Output> bindings;
/**
* @return Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
*
*/
public Optional>> bindings() {
return Optional.ofNullable(this.bindings);
}
/**
* `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
*
*/
@Import(name="etag")
private @Nullable Output etag;
/**
* @return `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
*
*/
public Optional> etag() {
return Optional.ofNullable(this.etag);
}
@Import(name="location")
private @Nullable Output location;
public Optional> location() {
return Optional.ofNullable(this.location);
}
@Import(name="project")
private @Nullable Output project;
public Optional> project() {
return Optional.ofNullable(this.project);
}
/**
* OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
*
*/
@Import(name="updateMask")
private @Nullable Output updateMask;
/**
* @return OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
*
*/
public Optional> updateMask() {
return Optional.ofNullable(this.updateMask);
}
/**
* Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
*
*/
@Import(name="version")
private @Nullable Output version;
/**
* @return Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
*
*/
public Optional> version() {
return Optional.ofNullable(this.version);
}
private ApiIamPolicyArgs() {}
private ApiIamPolicyArgs(ApiIamPolicyArgs $) {
this.apiId = $.apiId;
this.auditConfigs = $.auditConfigs;
this.bindings = $.bindings;
this.etag = $.etag;
this.location = $.location;
this.project = $.project;
this.updateMask = $.updateMask;
this.version = $.version;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(ApiIamPolicyArgs defaults) {
return new Builder(defaults);
}
public static final class Builder {
private ApiIamPolicyArgs $;
public Builder() {
$ = new ApiIamPolicyArgs();
}
public Builder(ApiIamPolicyArgs defaults) {
$ = new ApiIamPolicyArgs(Objects.requireNonNull(defaults));
}
public Builder apiId(Output apiId) {
$.apiId = apiId;
return this;
}
public Builder apiId(String apiId) {
return apiId(Output.of(apiId));
}
/**
* @param auditConfigs Specifies cloud audit logging configuration for this policy.
*
* @return builder
*
*/
public Builder auditConfigs(@Nullable Output> auditConfigs) {
$.auditConfigs = auditConfigs;
return this;
}
/**
* @param auditConfigs Specifies cloud audit logging configuration for this policy.
*
* @return builder
*
*/
public Builder auditConfigs(List auditConfigs) {
return auditConfigs(Output.of(auditConfigs));
}
/**
* @param auditConfigs Specifies cloud audit logging configuration for this policy.
*
* @return builder
*
*/
public Builder auditConfigs(ApigatewayAuditConfigArgs... auditConfigs) {
return auditConfigs(List.of(auditConfigs));
}
/**
* @param bindings Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
*
* @return builder
*
*/
public Builder bindings(@Nullable Output> bindings) {
$.bindings = bindings;
return this;
}
/**
* @param bindings Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
*
* @return builder
*
*/
public Builder bindings(List bindings) {
return bindings(Output.of(bindings));
}
/**
* @param bindings Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
*
* @return builder
*
*/
public Builder bindings(ApigatewayBindingArgs... bindings) {
return bindings(List.of(bindings));
}
/**
* @param etag `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
*
* @return builder
*
*/
public Builder etag(@Nullable Output etag) {
$.etag = etag;
return this;
}
/**
* @param etag `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
*
* @return builder
*
*/
public Builder etag(String etag) {
return etag(Output.of(etag));
}
public Builder location(@Nullable Output location) {
$.location = location;
return this;
}
public Builder location(String location) {
return location(Output.of(location));
}
public Builder project(@Nullable Output project) {
$.project = project;
return this;
}
public Builder project(String project) {
return project(Output.of(project));
}
/**
* @param updateMask OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
*
* @return builder
*
*/
public Builder updateMask(@Nullable Output updateMask) {
$.updateMask = updateMask;
return this;
}
/**
* @param updateMask OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
*
* @return builder
*
*/
public Builder updateMask(String updateMask) {
return updateMask(Output.of(updateMask));
}
/**
* @param version Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
*
* @return builder
*
*/
public Builder version(@Nullable Output version) {
$.version = version;
return this;
}
/**
* @param version Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
*
* @return builder
*
*/
public Builder version(Integer version) {
return version(Output.of(version));
}
public ApiIamPolicyArgs build() {
$.apiId = Objects.requireNonNull($.apiId, "expected parameter 'apiId' to be non-null");
return $;
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy