1. Packages
  2. Neon Provider
  3. API Docs
  4. JwksUrl
neon 0.9.0 published on Tuesday, May 6, 2025 by kislerdm

neon.JwksUrl

Explore with Pulumi AI

neon logo
neon 0.9.0 published on Tuesday, May 6, 2025 by kislerdm

    Project JWKS URL. See details: https://neon.tech/docs/guides/neon-rls-authorize

    ~>WARNING The resource does not support import.

    Create JwksUrl Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new JwksUrl(name: string, args: JwksUrlArgs, opts?: CustomResourceOptions);
    @overload
    def JwksUrl(resource_name: str,
                args: JwksUrlArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def JwksUrl(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                jwks_url: Optional[str] = None,
                project_id: Optional[str] = None,
                provider_name: Optional[str] = None,
                role_names: Optional[Sequence[str]] = None,
                branch_id: Optional[str] = None,
                jwks_url_id: Optional[str] = None,
                jwt_audience: Optional[str] = None)
    func NewJwksUrl(ctx *Context, name string, args JwksUrlArgs, opts ...ResourceOption) (*JwksUrl, error)
    public JwksUrl(string name, JwksUrlArgs args, CustomResourceOptions? opts = null)
    public JwksUrl(String name, JwksUrlArgs args)
    public JwksUrl(String name, JwksUrlArgs args, CustomResourceOptions options)
    
    type: neon:JwksUrl
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args JwksUrlArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args JwksUrlArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args JwksUrlArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args JwksUrlArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args JwksUrlArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var jwksUrlResource = new Neon.JwksUrl("jwksUrlResource", new()
    {
        JwksUrl = "string",
        ProjectId = "string",
        ProviderName = "string",
        RoleNames = new[]
        {
            "string",
        },
        BranchId = "string",
        JwksUrlId = "string",
        JwtAudience = "string",
    });
    
    example, err := neon.NewJwksUrl(ctx, "jwksUrlResource", &neon.JwksUrlArgs{
    	JwksUrl:      pulumi.String("string"),
    	ProjectId:    pulumi.String("string"),
    	ProviderName: pulumi.String("string"),
    	RoleNames: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	BranchId:    pulumi.String("string"),
    	JwksUrlId:   pulumi.String("string"),
    	JwtAudience: pulumi.String("string"),
    })
    
    var jwksUrlResource = new JwksUrl("jwksUrlResource", JwksUrlArgs.builder()
        .jwksUrl("string")
        .projectId("string")
        .providerName("string")
        .roleNames("string")
        .branchId("string")
        .jwksUrlId("string")
        .jwtAudience("string")
        .build());
    
    jwks_url_resource = neon.JwksUrl("jwksUrlResource",
        jwks_url="string",
        project_id="string",
        provider_name="string",
        role_names=["string"],
        branch_id="string",
        jwks_url_id="string",
        jwt_audience="string")
    
    const jwksUrlResource = new neon.JwksUrl("jwksUrlResource", {
        jwksUrl: "string",
        projectId: "string",
        providerName: "string",
        roleNames: ["string"],
        branchId: "string",
        jwksUrlId: "string",
        jwtAudience: "string",
    });
    
    type: neon:JwksUrl
    properties:
        branchId: string
        jwksUrl: string
        jwksUrlId: string
        jwtAudience: string
        projectId: string
        providerName: string
        roleNames:
            - string
    

    JwksUrl Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The JwksUrl resource accepts the following input properties:

    JwksUrl string
    The URL that lists the JWKS.
    ProjectId string
    Project ID.
    ProviderName string
    The name of the authentication provider.
    RoleNames List<string>
    The roles the JWKS should be mapped to.
    BranchId string
    Branch ID.
    JwksUrlId string
    The ID of this resource.
    JwtAudience string
    The name of the required JWT Audience to be used.
    JwksUrl string
    The URL that lists the JWKS.
    ProjectId string
    Project ID.
    ProviderName string
    The name of the authentication provider.
    RoleNames []string
    The roles the JWKS should be mapped to.
    BranchId string
    Branch ID.
    JwksUrlId string
    The ID of this resource.
    JwtAudience string
    The name of the required JWT Audience to be used.
    jwksUrl String
    The URL that lists the JWKS.
    projectId String
    Project ID.
    providerName String
    The name of the authentication provider.
    roleNames List<String>
    The roles the JWKS should be mapped to.
    branchId String
    Branch ID.
    jwksUrlId String
    The ID of this resource.
    jwtAudience String
    The name of the required JWT Audience to be used.
    jwksUrl string
    The URL that lists the JWKS.
    projectId string
    Project ID.
    providerName string
    The name of the authentication provider.
    roleNames string[]
    The roles the JWKS should be mapped to.
    branchId string
    Branch ID.
    jwksUrlId string
    The ID of this resource.
    jwtAudience string
    The name of the required JWT Audience to be used.
    jwks_url str
    The URL that lists the JWKS.
    project_id str
    Project ID.
    provider_name str
    The name of the authentication provider.
    role_names Sequence[str]
    The roles the JWKS should be mapped to.
    branch_id str
    Branch ID.
    jwks_url_id str
    The ID of this resource.
    jwt_audience str
    The name of the required JWT Audience to be used.
    jwksUrl String
    The URL that lists the JWKS.
    projectId String
    Project ID.
    providerName String
    The name of the authentication provider.
    roleNames List<String>
    The roles the JWKS should be mapped to.
    branchId String
    Branch ID.
    jwksUrlId String
    The ID of this resource.
    jwtAudience String
    The name of the required JWT Audience to be used.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the JwksUrl resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing JwksUrl Resource

    Get an existing JwksUrl resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: JwksUrlState, opts?: CustomResourceOptions): JwksUrl
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            branch_id: Optional[str] = None,
            jwks_url: Optional[str] = None,
            jwks_url_id: Optional[str] = None,
            jwt_audience: Optional[str] = None,
            project_id: Optional[str] = None,
            provider_name: Optional[str] = None,
            role_names: Optional[Sequence[str]] = None) -> JwksUrl
    func GetJwksUrl(ctx *Context, name string, id IDInput, state *JwksUrlState, opts ...ResourceOption) (*JwksUrl, error)
    public static JwksUrl Get(string name, Input<string> id, JwksUrlState? state, CustomResourceOptions? opts = null)
    public static JwksUrl get(String name, Output<String> id, JwksUrlState state, CustomResourceOptions options)
    resources:  _:    type: neon:JwksUrl    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    BranchId string
    Branch ID.
    JwksUrl string
    The URL that lists the JWKS.
    JwksUrlId string
    The ID of this resource.
    JwtAudience string
    The name of the required JWT Audience to be used.
    ProjectId string
    Project ID.
    ProviderName string
    The name of the authentication provider.
    RoleNames List<string>
    The roles the JWKS should be mapped to.
    BranchId string
    Branch ID.
    JwksUrl string
    The URL that lists the JWKS.
    JwksUrlId string
    The ID of this resource.
    JwtAudience string
    The name of the required JWT Audience to be used.
    ProjectId string
    Project ID.
    ProviderName string
    The name of the authentication provider.
    RoleNames []string
    The roles the JWKS should be mapped to.
    branchId String
    Branch ID.
    jwksUrl String
    The URL that lists the JWKS.
    jwksUrlId String
    The ID of this resource.
    jwtAudience String
    The name of the required JWT Audience to be used.
    projectId String
    Project ID.
    providerName String
    The name of the authentication provider.
    roleNames List<String>
    The roles the JWKS should be mapped to.
    branchId string
    Branch ID.
    jwksUrl string
    The URL that lists the JWKS.
    jwksUrlId string
    The ID of this resource.
    jwtAudience string
    The name of the required JWT Audience to be used.
    projectId string
    Project ID.
    providerName string
    The name of the authentication provider.
    roleNames string[]
    The roles the JWKS should be mapped to.
    branch_id str
    Branch ID.
    jwks_url str
    The URL that lists the JWKS.
    jwks_url_id str
    The ID of this resource.
    jwt_audience str
    The name of the required JWT Audience to be used.
    project_id str
    Project ID.
    provider_name str
    The name of the authentication provider.
    role_names Sequence[str]
    The roles the JWKS should be mapped to.
    branchId String
    Branch ID.
    jwksUrl String
    The URL that lists the JWKS.
    jwksUrlId String
    The ID of this resource.
    jwtAudience String
    The name of the required JWT Audience to be used.
    projectId String
    Project ID.
    providerName String
    The name of the authentication provider.
    roleNames List<String>
    The roles the JWKS should be mapped to.

    Package Details

    Repository
    neon kislerdm/terraform-provider-neon
    License
    Notes
    This Pulumi package is based on the neon Terraform Provider.
    neon logo
    neon 0.9.0 published on Tuesday, May 6, 2025 by kislerdm