com.pulumi.snowflake.ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs 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.snowflake;
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.List;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs extends com.pulumi.resources.ResourceArgs {
public static final ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs Empty = new ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs();
/**
* Specifies a comment for the integration.
*
*/
@Import(name="comment")
private @Nullable Output comment;
/**
* @return Specifies a comment for the integration.
*
*/
public Optional> comment() {
return Optional.ofNullable(this.comment);
}
/**
* Specifies whether this security integration is enabled or disabled.
*
*/
@Import(name="enabled", required=true)
private Output enabled;
/**
* @return Specifies whether this security integration is enabled or disabled.
*
*/
public Output enabled() {
return this.enabled;
}
/**
* Specifies the identifier (i.e. name) for the integration. This value must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
*
*/
@Import(name="name")
private @Nullable Output name;
/**
* @return Specifies the identifier (i.e. name) for the integration. This value must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
*
*/
public Optional> name() {
return Optional.ofNullable(this.name);
}
/**
* Specifies the default lifetime of the OAuth access token (in seconds) issued by an OAuth server.
*
*/
@Import(name="oauthAccessTokenValidity")
private @Nullable Output oauthAccessTokenValidity;
/**
* @return Specifies the default lifetime of the OAuth access token (in seconds) issued by an OAuth server.
*
*/
public Optional> oauthAccessTokenValidity() {
return Optional.ofNullable(this.oauthAccessTokenValidity);
}
/**
* Specifies a list of scopes to use when making a request from the OAuth by a role with USAGE on the integration during the OAuth client credentials flow.
*
*/
@Import(name="oauthAllowedScopes")
private @Nullable Output> oauthAllowedScopes;
/**
* @return Specifies a list of scopes to use when making a request from the OAuth by a role with USAGE on the integration during the OAuth client credentials flow.
*
*/
public Optional>> oauthAllowedScopes() {
return Optional.ofNullable(this.oauthAllowedScopes);
}
/**
* Specifies the URL for authenticating to the external service. If removed from the config, the resource is recreated.
*
*/
@Import(name="oauthAuthorizationEndpoint")
private @Nullable Output oauthAuthorizationEndpoint;
/**
* @return Specifies the URL for authenticating to the external service. If removed from the config, the resource is recreated.
*
*/
public Optional> oauthAuthorizationEndpoint() {
return Optional.ofNullable(this.oauthAuthorizationEndpoint);
}
/**
* Specifies that POST is used as the authentication method to the external service. If removed from the config, the resource is recreated. Valid values are (case-insensitive): `CLIENT_SECRET_POST`.
*
*/
@Import(name="oauthClientAuthMethod")
private @Nullable Output oauthClientAuthMethod;
/**
* @return Specifies that POST is used as the authentication method to the external service. If removed from the config, the resource is recreated. Valid values are (case-insensitive): `CLIENT_SECRET_POST`.
*
*/
public Optional> oauthClientAuthMethod() {
return Optional.ofNullable(this.oauthClientAuthMethod);
}
/**
* Specifies the client ID for the OAuth application in the external service.
*
*/
@Import(name="oauthClientId", required=true)
private Output oauthClientId;
/**
* @return Specifies the client ID for the OAuth application in the external service.
*
*/
public Output oauthClientId() {
return this.oauthClientId;
}
@Import(name="oauthClientSecret", required=true)
private Output oauthClientSecret;
public Output oauthClientSecret() {
return this.oauthClientSecret;
}
/**
* Specifies the value to determine the validity of the refresh token obtained from the OAuth server.
*
*/
@Import(name="oauthRefreshTokenValidity")
private @Nullable Output oauthRefreshTokenValidity;
/**
* @return Specifies the value to determine the validity of the refresh token obtained from the OAuth server.
*
*/
public Optional> oauthRefreshTokenValidity() {
return Optional.ofNullable(this.oauthRefreshTokenValidity);
}
/**
* Specifies the token endpoint used by the client to obtain an access token by presenting its authorization grant or refresh token. The token endpoint is used with every authorization grant except for the implicit grant type (since an access token is issued directly). If removed from the config, the resource is recreated.
*
*/
@Import(name="oauthTokenEndpoint")
private @Nullable Output oauthTokenEndpoint;
/**
* @return Specifies the token endpoint used by the client to obtain an access token by presenting its authorization grant or refresh token. The token endpoint is used with every authorization grant except for the implicit grant type (since an access token is issued directly). If removed from the config, the resource is recreated.
*
*/
public Optional> oauthTokenEndpoint() {
return Optional.ofNullable(this.oauthTokenEndpoint);
}
private ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs() {}
private ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs(ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs $) {
this.comment = $.comment;
this.enabled = $.enabled;
this.name = $.name;
this.oauthAccessTokenValidity = $.oauthAccessTokenValidity;
this.oauthAllowedScopes = $.oauthAllowedScopes;
this.oauthAuthorizationEndpoint = $.oauthAuthorizationEndpoint;
this.oauthClientAuthMethod = $.oauthClientAuthMethod;
this.oauthClientId = $.oauthClientId;
this.oauthClientSecret = $.oauthClientSecret;
this.oauthRefreshTokenValidity = $.oauthRefreshTokenValidity;
this.oauthTokenEndpoint = $.oauthTokenEndpoint;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs defaults) {
return new Builder(defaults);
}
public static final class Builder {
private ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs $;
public Builder() {
$ = new ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs();
}
public Builder(ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs defaults) {
$ = new ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs(Objects.requireNonNull(defaults));
}
/**
* @param comment Specifies a comment for the integration.
*
* @return builder
*
*/
public Builder comment(@Nullable Output comment) {
$.comment = comment;
return this;
}
/**
* @param comment Specifies a comment for the integration.
*
* @return builder
*
*/
public Builder comment(String comment) {
return comment(Output.of(comment));
}
/**
* @param enabled Specifies whether this security integration is enabled or disabled.
*
* @return builder
*
*/
public Builder enabled(Output enabled) {
$.enabled = enabled;
return this;
}
/**
* @param enabled Specifies whether this security integration is enabled or disabled.
*
* @return builder
*
*/
public Builder enabled(Boolean enabled) {
return enabled(Output.of(enabled));
}
/**
* @param name Specifies the identifier (i.e. name) for the integration. This value must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
*
* @return builder
*
*/
public Builder name(@Nullable Output name) {
$.name = name;
return this;
}
/**
* @param name Specifies the identifier (i.e. name) for the integration. This value must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `"`.
*
* @return builder
*
*/
public Builder name(String name) {
return name(Output.of(name));
}
/**
* @param oauthAccessTokenValidity Specifies the default lifetime of the OAuth access token (in seconds) issued by an OAuth server.
*
* @return builder
*
*/
public Builder oauthAccessTokenValidity(@Nullable Output oauthAccessTokenValidity) {
$.oauthAccessTokenValidity = oauthAccessTokenValidity;
return this;
}
/**
* @param oauthAccessTokenValidity Specifies the default lifetime of the OAuth access token (in seconds) issued by an OAuth server.
*
* @return builder
*
*/
public Builder oauthAccessTokenValidity(Integer oauthAccessTokenValidity) {
return oauthAccessTokenValidity(Output.of(oauthAccessTokenValidity));
}
/**
* @param oauthAllowedScopes Specifies a list of scopes to use when making a request from the OAuth by a role with USAGE on the integration during the OAuth client credentials flow.
*
* @return builder
*
*/
public Builder oauthAllowedScopes(@Nullable Output> oauthAllowedScopes) {
$.oauthAllowedScopes = oauthAllowedScopes;
return this;
}
/**
* @param oauthAllowedScopes Specifies a list of scopes to use when making a request from the OAuth by a role with USAGE on the integration during the OAuth client credentials flow.
*
* @return builder
*
*/
public Builder oauthAllowedScopes(List oauthAllowedScopes) {
return oauthAllowedScopes(Output.of(oauthAllowedScopes));
}
/**
* @param oauthAllowedScopes Specifies a list of scopes to use when making a request from the OAuth by a role with USAGE on the integration during the OAuth client credentials flow.
*
* @return builder
*
*/
public Builder oauthAllowedScopes(String... oauthAllowedScopes) {
return oauthAllowedScopes(List.of(oauthAllowedScopes));
}
/**
* @param oauthAuthorizationEndpoint Specifies the URL for authenticating to the external service. If removed from the config, the resource is recreated.
*
* @return builder
*
*/
public Builder oauthAuthorizationEndpoint(@Nullable Output oauthAuthorizationEndpoint) {
$.oauthAuthorizationEndpoint = oauthAuthorizationEndpoint;
return this;
}
/**
* @param oauthAuthorizationEndpoint Specifies the URL for authenticating to the external service. If removed from the config, the resource is recreated.
*
* @return builder
*
*/
public Builder oauthAuthorizationEndpoint(String oauthAuthorizationEndpoint) {
return oauthAuthorizationEndpoint(Output.of(oauthAuthorizationEndpoint));
}
/**
* @param oauthClientAuthMethod Specifies that POST is used as the authentication method to the external service. If removed from the config, the resource is recreated. Valid values are (case-insensitive): `CLIENT_SECRET_POST`.
*
* @return builder
*
*/
public Builder oauthClientAuthMethod(@Nullable Output oauthClientAuthMethod) {
$.oauthClientAuthMethod = oauthClientAuthMethod;
return this;
}
/**
* @param oauthClientAuthMethod Specifies that POST is used as the authentication method to the external service. If removed from the config, the resource is recreated. Valid values are (case-insensitive): `CLIENT_SECRET_POST`.
*
* @return builder
*
*/
public Builder oauthClientAuthMethod(String oauthClientAuthMethod) {
return oauthClientAuthMethod(Output.of(oauthClientAuthMethod));
}
/**
* @param oauthClientId Specifies the client ID for the OAuth application in the external service.
*
* @return builder
*
*/
public Builder oauthClientId(Output oauthClientId) {
$.oauthClientId = oauthClientId;
return this;
}
/**
* @param oauthClientId Specifies the client ID for the OAuth application in the external service.
*
* @return builder
*
*/
public Builder oauthClientId(String oauthClientId) {
return oauthClientId(Output.of(oauthClientId));
}
public Builder oauthClientSecret(Output oauthClientSecret) {
$.oauthClientSecret = oauthClientSecret;
return this;
}
public Builder oauthClientSecret(String oauthClientSecret) {
return oauthClientSecret(Output.of(oauthClientSecret));
}
/**
* @param oauthRefreshTokenValidity Specifies the value to determine the validity of the refresh token obtained from the OAuth server.
*
* @return builder
*
*/
public Builder oauthRefreshTokenValidity(@Nullable Output oauthRefreshTokenValidity) {
$.oauthRefreshTokenValidity = oauthRefreshTokenValidity;
return this;
}
/**
* @param oauthRefreshTokenValidity Specifies the value to determine the validity of the refresh token obtained from the OAuth server.
*
* @return builder
*
*/
public Builder oauthRefreshTokenValidity(Integer oauthRefreshTokenValidity) {
return oauthRefreshTokenValidity(Output.of(oauthRefreshTokenValidity));
}
/**
* @param oauthTokenEndpoint Specifies the token endpoint used by the client to obtain an access token by presenting its authorization grant or refresh token. The token endpoint is used with every authorization grant except for the implicit grant type (since an access token is issued directly). If removed from the config, the resource is recreated.
*
* @return builder
*
*/
public Builder oauthTokenEndpoint(@Nullable Output oauthTokenEndpoint) {
$.oauthTokenEndpoint = oauthTokenEndpoint;
return this;
}
/**
* @param oauthTokenEndpoint Specifies the token endpoint used by the client to obtain an access token by presenting its authorization grant or refresh token. The token endpoint is used with every authorization grant except for the implicit grant type (since an access token is issued directly). If removed from the config, the resource is recreated.
*
* @return builder
*
*/
public Builder oauthTokenEndpoint(String oauthTokenEndpoint) {
return oauthTokenEndpoint(Output.of(oauthTokenEndpoint));
}
public ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs build() {
if ($.enabled == null) {
throw new MissingRequiredPropertyException("ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs", "enabled");
}
if ($.oauthClientId == null) {
throw new MissingRequiredPropertyException("ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs", "oauthClientId");
}
if ($.oauthClientSecret == null) {
throw new MissingRequiredPropertyException("ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs", "oauthClientSecret");
}
return $;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy