1. Packages
  2. Palo Alto Networks Cloud NGFW for AWS Provider
  3. API Docs
  4. AccountOnboarding
Palo Alto Networks Cloud NGFW for AWS v0.1.1 published on Saturday, Mar 15, 2025 by Pulumi

cloudngfwaws.AccountOnboarding

Explore with Pulumi AI

Resource for Account Onboarding.

Admin Permission Type

  • Rulestack (for scope="Local")
  • Global Rulestack (for scope="Global")

Create AccountOnboarding Resource

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

Constructor syntax

new AccountOnboarding(name: string, args: AccountOnboardingArgs, opts?: CustomResourceOptions);
@overload
def AccountOnboarding(resource_name: str,
                      args: AccountOnboardingArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def AccountOnboarding(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      account_id: Optional[str] = None,
                      onboarding_status: Optional[str] = None)
func NewAccountOnboarding(ctx *Context, name string, args AccountOnboardingArgs, opts ...ResourceOption) (*AccountOnboarding, error)
public AccountOnboarding(string name, AccountOnboardingArgs args, CustomResourceOptions? opts = null)
public AccountOnboarding(String name, AccountOnboardingArgs args)
public AccountOnboarding(String name, AccountOnboardingArgs args, CustomResourceOptions options)
type: cloudngfwaws:AccountOnboarding
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AccountOnboardingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. AccountOnboardingArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. AccountOnboardingArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AccountOnboardingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AccountOnboardingArgs
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 accountOnboardingResource = new CloudNgfwAws.AccountOnboarding("accountOnboardingResource", new()
{
    AccountId = "string",
    OnboardingStatus = "string",
});
Copy
example, err := cloudngfwaws.NewAccountOnboarding(ctx, "accountOnboardingResource", &cloudngfwaws.AccountOnboardingArgs{
	AccountId:        pulumi.String("string"),
	OnboardingStatus: pulumi.String("string"),
})
Copy
var accountOnboardingResource = new AccountOnboarding("accountOnboardingResource", AccountOnboardingArgs.builder()
    .accountId("string")
    .onboardingStatus("string")
    .build());
Copy
account_onboarding_resource = cloudngfwaws.AccountOnboarding("accountOnboardingResource",
    account_id="string",
    onboarding_status="string")
Copy
const accountOnboardingResource = new cloudngfwaws.AccountOnboarding("accountOnboardingResource", {
    accountId: "string",
    onboardingStatus: "string",
});
Copy
type: cloudngfwaws:AccountOnboarding
properties:
    accountId: string
    onboardingStatus: string
Copy

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

AccountId
This property is required.
Changes to this property will trigger replacement.
string
The account IDs
OnboardingStatus string
Onboarding status of the account
AccountId
This property is required.
Changes to this property will trigger replacement.
string
The account IDs
OnboardingStatus string
Onboarding status of the account
accountId
This property is required.
Changes to this property will trigger replacement.
String
The account IDs
onboardingStatus String
Onboarding status of the account
accountId
This property is required.
Changes to this property will trigger replacement.
string
The account IDs
onboardingStatus string
Onboarding status of the account
account_id
This property is required.
Changes to this property will trigger replacement.
str
The account IDs
onboarding_status str
Onboarding status of the account
accountId
This property is required.
Changes to this property will trigger replacement.
String
The account IDs
onboardingStatus String
Onboarding status of the account

Outputs

All input properties are implicitly available as output properties. Additionally, the AccountOnboarding 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 AccountOnboarding Resource

Get an existing AccountOnboarding 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?: AccountOnboardingState, opts?: CustomResourceOptions): AccountOnboarding
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        onboarding_status: Optional[str] = None) -> AccountOnboarding
func GetAccountOnboarding(ctx *Context, name string, id IDInput, state *AccountOnboardingState, opts ...ResourceOption) (*AccountOnboarding, error)
public static AccountOnboarding Get(string name, Input<string> id, AccountOnboardingState? state, CustomResourceOptions? opts = null)
public static AccountOnboarding get(String name, Output<String> id, AccountOnboardingState state, CustomResourceOptions options)
resources:  _:    type: cloudngfwaws:AccountOnboarding    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AccountId Changes to this property will trigger replacement. string
The account IDs
OnboardingStatus string
Onboarding status of the account
AccountId Changes to this property will trigger replacement. string
The account IDs
OnboardingStatus string
Onboarding status of the account
accountId Changes to this property will trigger replacement. String
The account IDs
onboardingStatus String
Onboarding status of the account
accountId Changes to this property will trigger replacement. string
The account IDs
onboardingStatus string
Onboarding status of the account
account_id Changes to this property will trigger replacement. str
The account IDs
onboarding_status str
Onboarding status of the account
accountId Changes to this property will trigger replacement. String
The account IDs
onboardingStatus String
Onboarding status of the account

Package Details

Repository
cloudngfwaws pulumi/pulumi-cloudngfwaws
License
Apache-2.0
Notes
This Pulumi package is based on the cloudngfwaws Terraform Provider.