aws.transfer.WebAppCustomization
Resource for managing an AWS Transfer Family Web App Customization.
Example Usage
Create WebAppCustomization Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new WebAppCustomization(name: string, args: WebAppCustomizationArgs, opts?: CustomResourceOptions);@overload
def WebAppCustomization(resource_name: str,
args: WebAppCustomizationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def WebAppCustomization(resource_name: str,
opts: Optional[ResourceOptions] = None,
web_app_id: Optional[str] = None,
favicon_file: Optional[str] = None,
logo_file: Optional[str] = None,
region: Optional[str] = None,
title: Optional[str] = None)func NewWebAppCustomization(ctx *Context, name string, args WebAppCustomizationArgs, opts ...ResourceOption) (*WebAppCustomization, error)public WebAppCustomization(string name, WebAppCustomizationArgs args, CustomResourceOptions? opts = null)
public WebAppCustomization(String name, WebAppCustomizationArgs args)
public WebAppCustomization(String name, WebAppCustomizationArgs args, CustomResourceOptions options)
type: aws:transfer:WebAppCustomization
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 WebAppCustomizationArgs
- 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 WebAppCustomizationArgs
- 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 WebAppCustomizationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args WebAppCustomizationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args WebAppCustomizationArgs
- 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 webAppCustomizationResource = new Aws.Transfer.WebAppCustomization("webAppCustomizationResource", new()
{
WebAppId = "string",
FaviconFile = "string",
LogoFile = "string",
Region = "string",
Title = "string",
});
example, err := transfer.NewWebAppCustomization(ctx, "webAppCustomizationResource", &transfer.WebAppCustomizationArgs{
WebAppId: pulumi.String("string"),
FaviconFile: pulumi.String("string"),
LogoFile: pulumi.String("string"),
Region: pulumi.String("string"),
Title: pulumi.String("string"),
})
var webAppCustomizationResource = new WebAppCustomization("webAppCustomizationResource", WebAppCustomizationArgs.builder()
.webAppId("string")
.faviconFile("string")
.logoFile("string")
.region("string")
.title("string")
.build());
web_app_customization_resource = aws.transfer.WebAppCustomization("webAppCustomizationResource",
web_app_id="string",
favicon_file="string",
logo_file="string",
region="string",
title="string")
const webAppCustomizationResource = new aws.transfer.WebAppCustomization("webAppCustomizationResource", {
webAppId: "string",
faviconFile: "string",
logoFile: "string",
region: "string",
title: "string",
});
type: aws:transfer:WebAppCustomization
properties:
faviconFile: string
logoFile: string
region: string
title: string
webAppId: string
WebAppCustomization 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 WebAppCustomization resource accepts the following input properties:
- Web
App stringId The identifier of the web app to be customized.
The following arguments are optional:
- Favicon
File string - Logo
File string - Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Title string
- Title of the web app. Must be between 1 and 100 characters in length (an empty string is not allowed). To remove the title, omit this argument from your configuration.
- Web
App stringId The identifier of the web app to be customized.
The following arguments are optional:
- Favicon
File string - Logo
File string - Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Title string
- Title of the web app. Must be between 1 and 100 characters in length (an empty string is not allowed). To remove the title, omit this argument from your configuration.
- web
App StringId The identifier of the web app to be customized.
The following arguments are optional:
- favicon
File String - logo
File String - region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- title String
- Title of the web app. Must be between 1 and 100 characters in length (an empty string is not allowed). To remove the title, omit this argument from your configuration.
- web
App stringId The identifier of the web app to be customized.
The following arguments are optional:
- favicon
File string - logo
File string - region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- title string
- Title of the web app. Must be between 1 and 100 characters in length (an empty string is not allowed). To remove the title, omit this argument from your configuration.
- web_
app_ strid The identifier of the web app to be customized.
The following arguments are optional:
- favicon_
file str - logo_
file str - region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- title str
- Title of the web app. Must be between 1 and 100 characters in length (an empty string is not allowed). To remove the title, omit this argument from your configuration.
- web
App StringId The identifier of the web app to be customized.
The following arguments are optional:
- favicon
File String - logo
File String - region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- title String
- Title of the web app. Must be between 1 and 100 characters in length (an empty string is not allowed). To remove the title, omit this argument from your configuration.
Outputs
All input properties are implicitly available as output properties. Additionally, the WebAppCustomization 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 WebAppCustomization Resource
Get an existing WebAppCustomization 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?: WebAppCustomizationState, opts?: CustomResourceOptions): WebAppCustomization@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
favicon_file: Optional[str] = None,
logo_file: Optional[str] = None,
region: Optional[str] = None,
title: Optional[str] = None,
web_app_id: Optional[str] = None) -> WebAppCustomizationfunc GetWebAppCustomization(ctx *Context, name string, id IDInput, state *WebAppCustomizationState, opts ...ResourceOption) (*WebAppCustomization, error)public static WebAppCustomization Get(string name, Input<string> id, WebAppCustomizationState? state, CustomResourceOptions? opts = null)public static WebAppCustomization get(String name, Output<String> id, WebAppCustomizationState state, CustomResourceOptions options)resources: _: type: aws:transfer:WebAppCustomization 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.
- Favicon
File string - Logo
File string - Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Title string
- Title of the web app. Must be between 1 and 100 characters in length (an empty string is not allowed). To remove the title, omit this argument from your configuration.
- Web
App stringId The identifier of the web app to be customized.
The following arguments are optional:
- Favicon
File string - Logo
File string - Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Title string
- Title of the web app. Must be between 1 and 100 characters in length (an empty string is not allowed). To remove the title, omit this argument from your configuration.
- Web
App stringId The identifier of the web app to be customized.
The following arguments are optional:
- favicon
File String - logo
File String - region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- title String
- Title of the web app. Must be between 1 and 100 characters in length (an empty string is not allowed). To remove the title, omit this argument from your configuration.
- web
App StringId The identifier of the web app to be customized.
The following arguments are optional:
- favicon
File string - logo
File string - region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- title string
- Title of the web app. Must be between 1 and 100 characters in length (an empty string is not allowed). To remove the title, omit this argument from your configuration.
- web
App stringId The identifier of the web app to be customized.
The following arguments are optional:
- favicon_
file str - logo_
file str - region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- title str
- Title of the web app. Must be between 1 and 100 characters in length (an empty string is not allowed). To remove the title, omit this argument from your configuration.
- web_
app_ strid The identifier of the web app to be customized.
The following arguments are optional:
- favicon
File String - logo
File String - region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- title String
- Title of the web app. Must be between 1 and 100 characters in length (an empty string is not allowed). To remove the title, omit this argument from your configuration.
- web
App StringId The identifier of the web app to be customized.
The following arguments are optional:
Import
Using pulumi import, import Transfer Family Web App Customization using the web_app_id. For example:
$ pulumi import aws:transfer/webAppCustomization:WebAppCustomization example webapp-12345678901234567890
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.
