1. Packages
  2. String
  3. API Docs
  4. regexp
  5. match
String v1.0.0 published on Friday, Oct 28, 2022 by Pulumi

str.regexp.match

Explore with Pulumi AI

String v1.0.0 published on Friday, Oct 28, 2022 by Pulumi

Match reports whether the string s contains any match of the regular expression pattern.

Using match

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function match(args: MatchArgs, opts?: InvokeOptions): Promise<MatchResult>
function matchOutput(args: MatchOutputArgs, opts?: InvokeOptions): Output<MatchResult>
Copy
def match(pattern: Optional[str] = None,
          string: Optional[str] = None,
          opts: Optional[InvokeOptions] = None) -> MatchResult
def match_output(pattern: Optional[pulumi.Input[str]] = None,
          string: Optional[pulumi.Input[str]] = None,
          opts: Optional[InvokeOptions] = None) -> Output[MatchResult]
Copy
func Match(ctx *Context, args *MatchArgs, opts ...InvokeOption) (*MatchResult, error)
func MatchOutput(ctx *Context, args *MatchOutputArgs, opts ...InvokeOption) MatchResultOutput
Copy

> Note: This function is named Match in the Go SDK.

public static class Match 
{
    public static Task<MatchResult> InvokeAsync(MatchArgs args, InvokeOptions? opts = null)
    public static Output<MatchResult> Invoke(MatchInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<MatchResult> match(MatchArgs args, InvokeOptions options)
public static Output<MatchResult> match(MatchArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: str:regexp:match
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Pattern This property is required. string
String This property is required. string
Pattern This property is required. string
String This property is required. string
pattern This property is required. String
string This property is required. String
pattern This property is required. string
string This property is required. string
pattern This property is required. str
string This property is required. str
pattern This property is required. String
string This property is required. String

match Result

The following output properties are available:

Matches bool
Matches bool
matches Boolean
matches boolean
matches bool
matches Boolean

Package Details

Repository
str pulumi/pulumi-str
License
String v1.0.0 published on Friday, Oct 28, 2022 by Pulumi