pulumi/tests/testdata/codegen/plain-schema-gh6957/docs/staticpage/_index.md

28 KiB


title: "StaticPage" title_tag: "xyz.StaticPage" meta_desc: "Documentation for the xyz.StaticPage resource with examples, input properties, output properties, lookup functions, and supporting types." layout: api no_edit_this_page: true

Create StaticPage Resource

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

Constructor syntax

new StaticPage(name: string, args: StaticPageArgs, opts?: ComponentResourceOptions);
@overload
def StaticPage(resource_name: str,
               args: StaticPageArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def StaticPage(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               index_content: Optional[str] = None,
               foo: Optional[FooArgs] = None)
func NewStaticPage(ctx *Context, name string, args StaticPageArgs, opts ...ResourceOption) (*StaticPage, error)
public StaticPage(string name, StaticPageArgs args, ComponentResourceOptions? opts = null)
public StaticPage(String name, StaticPageArgs args)
public StaticPage(String name, StaticPageArgs args, ComponentResourceOptions options)
type: xyz:StaticPage
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 StaticPageArgs
The arguments to resource properties.
opts ComponentResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args StaticPageArgs
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 StaticPageArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args StaticPageArgs
The arguments to resource properties.
opts ComponentResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args StaticPageArgs
The arguments to resource properties.
options ComponentResourceOptions
Bag of options to control resource's behavior.

Constructor example

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

var staticPageResource = new Xyz.StaticPage("staticPageResource", new()
{
    IndexContent = "string",
    Foo = new Xyz.Inputs.FooArgs
    {
        A = false,
    },
});
example, err := xyz.NewStaticPage(ctx, "staticPageResource", &xyz.StaticPageArgs{
	IndexContent: pulumi.String("string"),
	Foo: &xyz.FooArgs{
		A: pulumi.Bool(false),
	},
})
var staticPageResource = new StaticPage("staticPageResource", StaticPageArgs.builder()
    .indexContent("string")
    .foo(FooArgs.builder()
        .a(false)
        .build())
    .build());
static_page_resource = xyz.StaticPage("staticPageResource",
    index_content="string",
    foo={
        "a": False,
    })
const staticPageResource = new xyz.StaticPage("staticPageResource", {
    indexContent: "string",
    foo: {
        a: false,
    },
});
type: xyz:StaticPage
properties:
    foo:
        a: false
    indexContent: string

StaticPage 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 StaticPage resource accepts the following input properties:

IndexContent string
The HTML content for index.html.
Foo Foo
IndexContent string
The HTML content for index.html.
Foo FooArgs
indexContent String
The HTML content for index.html.
foo Foo
indexContent string
The HTML content for index.html.
foo Foo
index_content str
The HTML content for index.html.
foo FooArgs
indexContent String
The HTML content for index.html.
foo Property Map

Outputs

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

Bucket Pulumi.Aws.S3.Bucket
The bucket resource. This type is defined in the AWS Classic package.
WebsiteUrl string
The website URL.
Bucket Bucket
The bucket resource. This type is defined in the AWS Classic package.
WebsiteUrl string
The website URL.
bucket Bucket
The bucket resource. This type is defined in the AWS Classic package.
websiteUrl String
The website URL.
bucket pulumiAwss3Bucket
The bucket resource. This type is defined in the AWS Classic package.
websiteUrl string
The website URL.
bucket pulumi_aws.s3.Bucket
The bucket resource. This type is defined in the AWS Classic package.
website_url str
The website URL.
bucket aws:s3:Bucket
The bucket resource. This type is defined in the AWS Classic package.
websiteUrl String
The website URL.

Supporting Types

Foo, FooArgs

A bool
A bool
a Boolean
a boolean
a bool
a Boolean

Package Details

Repository
xyz
License