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

cloudngfwaws.Provider

Explore with Pulumi AI

Palo Alto Networks Cloud NGFW for AWS v0.1.1 published on Saturday, Mar 15, 2025 by Pulumi

The provider type for the cloudngfwaws package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

Create Provider Resource

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

Constructor syntax

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

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             access_key: Optional[str] = None,
             account_admin_arn: Optional[str] = None,
             arn: Optional[str] = None,
             gra_arn: Optional[str] = None,
             headers: Optional[Mapping[str, str]] = None,
             host: Optional[str] = None,
             json_config_file: Optional[str] = None,
             lfa_arn: Optional[str] = None,
             loggings: Optional[Sequence[str]] = None,
             lra_arn: Optional[str] = None,
             mp_region: Optional[str] = None,
             mp_region_host: Optional[str] = None,
             profile: Optional[str] = None,
             protocol: Optional[str] = None,
             region: Optional[str] = None,
             resource_timeout: Optional[int] = None,
             secret_key: Optional[str] = None,
             skip_verify_certificate: Optional[bool] = None,
             sync_mode: Optional[bool] = None,
             timeout: Optional[int] = None)
func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)
type: pulumi:providers:cloudngfwaws
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 ProviderArgs
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 ProviderArgs
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 ProviderArgs
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 ProviderArgs
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. ProviderArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

AccessKey string
(Used for the initial sts assume role) AWS access key. Environment variable: CLOUDNGFWAWS_ACCESS_KEY. JSON conf file variable: access-key.
AccountAdminArn string
The ARN allowing account admin permissions. Environment variable: CLOUDNGFWAWS_ACCT_ADMIN_ARN. JSON conf file variable: account-admin-arn.
Arn string
The ARN allowing firewall, rulestack, and global rulestack admin permissions. Global rulestack admin permissions can be enabled only if the AWS account is onboarded by AWS Firewall Manager. Use 'lfa_arn' and 'lra_arn' if you want to enable only firewall and rulestack admin permissions. Environment variable: CLOUDNGFWAWS_ARN. JSON conf file variable: arn.
GraArn string
The ARN allowing global rulestack admin permissions. Global rulestack admin permissions can be enabled only if the AWS account is onboarded by AWS Firewall Manager. 'gra_arn' is preferentially used over the arn param if both are specified. Environment variable: CLOUDNGFWAWS_GRA_ARN. JSON conf file variable: gra-arn.
Headers Dictionary<string, string>
Additional HTTP headers to send with API calls. Environment variable: CLOUDNGFWAWS_HEADERS. JSON conf file variable: headers.
Host string
The hostname of the API (default: api.us-east-1.aws.cloudngfw.paloaltonetworks.com). Environment variable: CLOUDNGFWAWS_HOST. JSON conf file variable: host.
JsonConfigFile string
Retrieve provider configuration from this JSON file.
LfaArn string
The ARN allowing firewall admin permissions. This is preferentially used over the arn param if both are specified. Environment variable: CLOUDNGFWAWS_LFA_ARN. JSON conf file variable: lfa-arn.
Loggings List<string>
The logging options for the provider. Environment variable: CLOUDNGFWAWS_LOGGING. JSON conf file variable: logging.
LraArn string
The ARN allowing rulestack admin permissions. This is preferentially used over the arn param if both are specified. Environment variable: CLOUDNGFWAWS_LRA_ARN. JSON conf file variable: lra-arn.
MpRegion string
AWS management plane region. Environment variable: CLOUDNGFWAWS_MP_REGION. JSON conf file variable: mp_region.
MpRegionHost string
AWS management plane MP region host Environment variable: CLOUDNGFWAWS_MP_REGION_HOST. JSON conf file variable: mp_region_host.
Profile string
(Used for the initial sts assume role) AWS PROFILE. Environment variable: CLOUDNGFWAWS_PROFILE. JSON conf file variable: profile.
Protocol string
The protocol (defaults to https). Environment variable: CLOUDNGFWAWS_PROTOCOL. JSON conf file variable: protocol. Valid values are https or http.
Region string
AWS region. Environment variable: CLOUDNGFWAWS_REGION. JSON conf file variable: region.
ResourceTimeout int
SecretKey string
(Used for the initial sts assume role) AWS secret key. Environment variable: CLOUDNGFWAWS_SECRET_KEY. JSON conf file variable: secret-key.
SkipVerifyCertificate bool
Skip verifying the SSL certificate. Environment variable: CLOUDNGFWAWS_SKIP_VERIFY_CERTIFICATE. JSON conf file variable: skip-verify-certificate.
SyncMode bool
Enable synchronous mode while creating resources Environment variable: CLOUDNGFWAWS_SYNC_MODE. JSON conf file variable: sync_mode.
Timeout int
The timeout for any single API call (default: 30). Environment variable: CLOUDNGFWAWS_TIMEOUT. JSON conf file variable: timeout.
AccessKey string
(Used for the initial sts assume role) AWS access key. Environment variable: CLOUDNGFWAWS_ACCESS_KEY. JSON conf file variable: access-key.
AccountAdminArn string
The ARN allowing account admin permissions. Environment variable: CLOUDNGFWAWS_ACCT_ADMIN_ARN. JSON conf file variable: account-admin-arn.
Arn string
The ARN allowing firewall, rulestack, and global rulestack admin permissions. Global rulestack admin permissions can be enabled only if the AWS account is onboarded by AWS Firewall Manager. Use 'lfa_arn' and 'lra_arn' if you want to enable only firewall and rulestack admin permissions. Environment variable: CLOUDNGFWAWS_ARN. JSON conf file variable: arn.
GraArn string
The ARN allowing global rulestack admin permissions. Global rulestack admin permissions can be enabled only if the AWS account is onboarded by AWS Firewall Manager. 'gra_arn' is preferentially used over the arn param if both are specified. Environment variable: CLOUDNGFWAWS_GRA_ARN. JSON conf file variable: gra-arn.
Headers map[string]string
Additional HTTP headers to send with API calls. Environment variable: CLOUDNGFWAWS_HEADERS. JSON conf file variable: headers.
Host string
The hostname of the API (default: api.us-east-1.aws.cloudngfw.paloaltonetworks.com). Environment variable: CLOUDNGFWAWS_HOST. JSON conf file variable: host.
JsonConfigFile string
Retrieve provider configuration from this JSON file.
LfaArn string
The ARN allowing firewall admin permissions. This is preferentially used over the arn param if both are specified. Environment variable: CLOUDNGFWAWS_LFA_ARN. JSON conf file variable: lfa-arn.
Loggings []string
The logging options for the provider. Environment variable: CLOUDNGFWAWS_LOGGING. JSON conf file variable: logging.
LraArn string
The ARN allowing rulestack admin permissions. This is preferentially used over the arn param if both are specified. Environment variable: CLOUDNGFWAWS_LRA_ARN. JSON conf file variable: lra-arn.
MpRegion string
AWS management plane region. Environment variable: CLOUDNGFWAWS_MP_REGION. JSON conf file variable: mp_region.
MpRegionHost string
AWS management plane MP region host Environment variable: CLOUDNGFWAWS_MP_REGION_HOST. JSON conf file variable: mp_region_host.
Profile string
(Used for the initial sts assume role) AWS PROFILE. Environment variable: CLOUDNGFWAWS_PROFILE. JSON conf file variable: profile.
Protocol string
The protocol (defaults to https). Environment variable: CLOUDNGFWAWS_PROTOCOL. JSON conf file variable: protocol. Valid values are https or http.
Region string
AWS region. Environment variable: CLOUDNGFWAWS_REGION. JSON conf file variable: region.
ResourceTimeout int
SecretKey string
(Used for the initial sts assume role) AWS secret key. Environment variable: CLOUDNGFWAWS_SECRET_KEY. JSON conf file variable: secret-key.
SkipVerifyCertificate bool
Skip verifying the SSL certificate. Environment variable: CLOUDNGFWAWS_SKIP_VERIFY_CERTIFICATE. JSON conf file variable: skip-verify-certificate.
SyncMode bool
Enable synchronous mode while creating resources Environment variable: CLOUDNGFWAWS_SYNC_MODE. JSON conf file variable: sync_mode.
Timeout int
The timeout for any single API call (default: 30). Environment variable: CLOUDNGFWAWS_TIMEOUT. JSON conf file variable: timeout.
accessKey String
(Used for the initial sts assume role) AWS access key. Environment variable: CLOUDNGFWAWS_ACCESS_KEY. JSON conf file variable: access-key.
accountAdminArn String
The ARN allowing account admin permissions. Environment variable: CLOUDNGFWAWS_ACCT_ADMIN_ARN. JSON conf file variable: account-admin-arn.
arn String
The ARN allowing firewall, rulestack, and global rulestack admin permissions. Global rulestack admin permissions can be enabled only if the AWS account is onboarded by AWS Firewall Manager. Use 'lfa_arn' and 'lra_arn' if you want to enable only firewall and rulestack admin permissions. Environment variable: CLOUDNGFWAWS_ARN. JSON conf file variable: arn.
graArn String
The ARN allowing global rulestack admin permissions. Global rulestack admin permissions can be enabled only if the AWS account is onboarded by AWS Firewall Manager. 'gra_arn' is preferentially used over the arn param if both are specified. Environment variable: CLOUDNGFWAWS_GRA_ARN. JSON conf file variable: gra-arn.
headers Map<String,String>
Additional HTTP headers to send with API calls. Environment variable: CLOUDNGFWAWS_HEADERS. JSON conf file variable: headers.
host String
The hostname of the API (default: api.us-east-1.aws.cloudngfw.paloaltonetworks.com). Environment variable: CLOUDNGFWAWS_HOST. JSON conf file variable: host.
jsonConfigFile String
Retrieve provider configuration from this JSON file.
lfaArn String
The ARN allowing firewall admin permissions. This is preferentially used over the arn param if both are specified. Environment variable: CLOUDNGFWAWS_LFA_ARN. JSON conf file variable: lfa-arn.
loggings List<String>
The logging options for the provider. Environment variable: CLOUDNGFWAWS_LOGGING. JSON conf file variable: logging.
lraArn String
The ARN allowing rulestack admin permissions. This is preferentially used over the arn param if both are specified. Environment variable: CLOUDNGFWAWS_LRA_ARN. JSON conf file variable: lra-arn.
mpRegion String
AWS management plane region. Environment variable: CLOUDNGFWAWS_MP_REGION. JSON conf file variable: mp_region.
mpRegionHost String
AWS management plane MP region host Environment variable: CLOUDNGFWAWS_MP_REGION_HOST. JSON conf file variable: mp_region_host.
profile String
(Used for the initial sts assume role) AWS PROFILE. Environment variable: CLOUDNGFWAWS_PROFILE. JSON conf file variable: profile.
protocol String
The protocol (defaults to https). Environment variable: CLOUDNGFWAWS_PROTOCOL. JSON conf file variable: protocol. Valid values are https or http.
region String
AWS region. Environment variable: CLOUDNGFWAWS_REGION. JSON conf file variable: region.
resourceTimeout Integer
secretKey String
(Used for the initial sts assume role) AWS secret key. Environment variable: CLOUDNGFWAWS_SECRET_KEY. JSON conf file variable: secret-key.
skipVerifyCertificate Boolean
Skip verifying the SSL certificate. Environment variable: CLOUDNGFWAWS_SKIP_VERIFY_CERTIFICATE. JSON conf file variable: skip-verify-certificate.
syncMode Boolean
Enable synchronous mode while creating resources Environment variable: CLOUDNGFWAWS_SYNC_MODE. JSON conf file variable: sync_mode.
timeout Integer
The timeout for any single API call (default: 30). Environment variable: CLOUDNGFWAWS_TIMEOUT. JSON conf file variable: timeout.
accessKey string
(Used for the initial sts assume role) AWS access key. Environment variable: CLOUDNGFWAWS_ACCESS_KEY. JSON conf file variable: access-key.
accountAdminArn string
The ARN allowing account admin permissions. Environment variable: CLOUDNGFWAWS_ACCT_ADMIN_ARN. JSON conf file variable: account-admin-arn.
arn string
The ARN allowing firewall, rulestack, and global rulestack admin permissions. Global rulestack admin permissions can be enabled only if the AWS account is onboarded by AWS Firewall Manager. Use 'lfa_arn' and 'lra_arn' if you want to enable only firewall and rulestack admin permissions. Environment variable: CLOUDNGFWAWS_ARN. JSON conf file variable: arn.
graArn string
The ARN allowing global rulestack admin permissions. Global rulestack admin permissions can be enabled only if the AWS account is onboarded by AWS Firewall Manager. 'gra_arn' is preferentially used over the arn param if both are specified. Environment variable: CLOUDNGFWAWS_GRA_ARN. JSON conf file variable: gra-arn.
headers {[key: string]: string}
Additional HTTP headers to send with API calls. Environment variable: CLOUDNGFWAWS_HEADERS. JSON conf file variable: headers.
host string
The hostname of the API (default: api.us-east-1.aws.cloudngfw.paloaltonetworks.com). Environment variable: CLOUDNGFWAWS_HOST. JSON conf file variable: host.
jsonConfigFile string
Retrieve provider configuration from this JSON file.
lfaArn string
The ARN allowing firewall admin permissions. This is preferentially used over the arn param if both are specified. Environment variable: CLOUDNGFWAWS_LFA_ARN. JSON conf file variable: lfa-arn.
loggings string[]
The logging options for the provider. Environment variable: CLOUDNGFWAWS_LOGGING. JSON conf file variable: logging.
lraArn string
The ARN allowing rulestack admin permissions. This is preferentially used over the arn param if both are specified. Environment variable: CLOUDNGFWAWS_LRA_ARN. JSON conf file variable: lra-arn.
mpRegion string
AWS management plane region. Environment variable: CLOUDNGFWAWS_MP_REGION. JSON conf file variable: mp_region.
mpRegionHost string
AWS management plane MP region host Environment variable: CLOUDNGFWAWS_MP_REGION_HOST. JSON conf file variable: mp_region_host.
profile string
(Used for the initial sts assume role) AWS PROFILE. Environment variable: CLOUDNGFWAWS_PROFILE. JSON conf file variable: profile.
protocol string
The protocol (defaults to https). Environment variable: CLOUDNGFWAWS_PROTOCOL. JSON conf file variable: protocol. Valid values are https or http.
region string
AWS region. Environment variable: CLOUDNGFWAWS_REGION. JSON conf file variable: region.
resourceTimeout number
secretKey string
(Used for the initial sts assume role) AWS secret key. Environment variable: CLOUDNGFWAWS_SECRET_KEY. JSON conf file variable: secret-key.
skipVerifyCertificate boolean
Skip verifying the SSL certificate. Environment variable: CLOUDNGFWAWS_SKIP_VERIFY_CERTIFICATE. JSON conf file variable: skip-verify-certificate.
syncMode boolean
Enable synchronous mode while creating resources Environment variable: CLOUDNGFWAWS_SYNC_MODE. JSON conf file variable: sync_mode.
timeout number
The timeout for any single API call (default: 30). Environment variable: CLOUDNGFWAWS_TIMEOUT. JSON conf file variable: timeout.
access_key str
(Used for the initial sts assume role) AWS access key. Environment variable: CLOUDNGFWAWS_ACCESS_KEY. JSON conf file variable: access-key.
account_admin_arn str
The ARN allowing account admin permissions. Environment variable: CLOUDNGFWAWS_ACCT_ADMIN_ARN. JSON conf file variable: account-admin-arn.
arn str
The ARN allowing firewall, rulestack, and global rulestack admin permissions. Global rulestack admin permissions can be enabled only if the AWS account is onboarded by AWS Firewall Manager. Use 'lfa_arn' and 'lra_arn' if you want to enable only firewall and rulestack admin permissions. Environment variable: CLOUDNGFWAWS_ARN. JSON conf file variable: arn.
gra_arn str
The ARN allowing global rulestack admin permissions. Global rulestack admin permissions can be enabled only if the AWS account is onboarded by AWS Firewall Manager. 'gra_arn' is preferentially used over the arn param if both are specified. Environment variable: CLOUDNGFWAWS_GRA_ARN. JSON conf file variable: gra-arn.
headers Mapping[str, str]
Additional HTTP headers to send with API calls. Environment variable: CLOUDNGFWAWS_HEADERS. JSON conf file variable: headers.
host str
The hostname of the API (default: api.us-east-1.aws.cloudngfw.paloaltonetworks.com). Environment variable: CLOUDNGFWAWS_HOST. JSON conf file variable: host.
json_config_file str
Retrieve provider configuration from this JSON file.
lfa_arn str
The ARN allowing firewall admin permissions. This is preferentially used over the arn param if both are specified. Environment variable: CLOUDNGFWAWS_LFA_ARN. JSON conf file variable: lfa-arn.
loggings Sequence[str]
The logging options for the provider. Environment variable: CLOUDNGFWAWS_LOGGING. JSON conf file variable: logging.
lra_arn str
The ARN allowing rulestack admin permissions. This is preferentially used over the arn param if both are specified. Environment variable: CLOUDNGFWAWS_LRA_ARN. JSON conf file variable: lra-arn.
mp_region str
AWS management plane region. Environment variable: CLOUDNGFWAWS_MP_REGION. JSON conf file variable: mp_region.
mp_region_host str
AWS management plane MP region host Environment variable: CLOUDNGFWAWS_MP_REGION_HOST. JSON conf file variable: mp_region_host.
profile str
(Used for the initial sts assume role) AWS PROFILE. Environment variable: CLOUDNGFWAWS_PROFILE. JSON conf file variable: profile.
protocol str
The protocol (defaults to https). Environment variable: CLOUDNGFWAWS_PROTOCOL. JSON conf file variable: protocol. Valid values are https or http.
region str
AWS region. Environment variable: CLOUDNGFWAWS_REGION. JSON conf file variable: region.
resource_timeout int
secret_key str
(Used for the initial sts assume role) AWS secret key. Environment variable: CLOUDNGFWAWS_SECRET_KEY. JSON conf file variable: secret-key.
skip_verify_certificate bool
Skip verifying the SSL certificate. Environment variable: CLOUDNGFWAWS_SKIP_VERIFY_CERTIFICATE. JSON conf file variable: skip-verify-certificate.
sync_mode bool
Enable synchronous mode while creating resources Environment variable: CLOUDNGFWAWS_SYNC_MODE. JSON conf file variable: sync_mode.
timeout int
The timeout for any single API call (default: 30). Environment variable: CLOUDNGFWAWS_TIMEOUT. JSON conf file variable: timeout.
accessKey String
(Used for the initial sts assume role) AWS access key. Environment variable: CLOUDNGFWAWS_ACCESS_KEY. JSON conf file variable: access-key.
accountAdminArn String
The ARN allowing account admin permissions. Environment variable: CLOUDNGFWAWS_ACCT_ADMIN_ARN. JSON conf file variable: account-admin-arn.
arn String
The ARN allowing firewall, rulestack, and global rulestack admin permissions. Global rulestack admin permissions can be enabled only if the AWS account is onboarded by AWS Firewall Manager. Use 'lfa_arn' and 'lra_arn' if you want to enable only firewall and rulestack admin permissions. Environment variable: CLOUDNGFWAWS_ARN. JSON conf file variable: arn.
graArn String
The ARN allowing global rulestack admin permissions. Global rulestack admin permissions can be enabled only if the AWS account is onboarded by AWS Firewall Manager. 'gra_arn' is preferentially used over the arn param if both are specified. Environment variable: CLOUDNGFWAWS_GRA_ARN. JSON conf file variable: gra-arn.
headers Map<String>
Additional HTTP headers to send with API calls. Environment variable: CLOUDNGFWAWS_HEADERS. JSON conf file variable: headers.
host String
The hostname of the API (default: api.us-east-1.aws.cloudngfw.paloaltonetworks.com). Environment variable: CLOUDNGFWAWS_HOST. JSON conf file variable: host.
jsonConfigFile String
Retrieve provider configuration from this JSON file.
lfaArn String
The ARN allowing firewall admin permissions. This is preferentially used over the arn param if both are specified. Environment variable: CLOUDNGFWAWS_LFA_ARN. JSON conf file variable: lfa-arn.
loggings List<String>
The logging options for the provider. Environment variable: CLOUDNGFWAWS_LOGGING. JSON conf file variable: logging.
lraArn String
The ARN allowing rulestack admin permissions. This is preferentially used over the arn param if both are specified. Environment variable: CLOUDNGFWAWS_LRA_ARN. JSON conf file variable: lra-arn.
mpRegion String
AWS management plane region. Environment variable: CLOUDNGFWAWS_MP_REGION. JSON conf file variable: mp_region.
mpRegionHost String
AWS management plane MP region host Environment variable: CLOUDNGFWAWS_MP_REGION_HOST. JSON conf file variable: mp_region_host.
profile String
(Used for the initial sts assume role) AWS PROFILE. Environment variable: CLOUDNGFWAWS_PROFILE. JSON conf file variable: profile.
protocol String
The protocol (defaults to https). Environment variable: CLOUDNGFWAWS_PROTOCOL. JSON conf file variable: protocol. Valid values are https or http.
region String
AWS region. Environment variable: CLOUDNGFWAWS_REGION. JSON conf file variable: region.
resourceTimeout Number
secretKey String
(Used for the initial sts assume role) AWS secret key. Environment variable: CLOUDNGFWAWS_SECRET_KEY. JSON conf file variable: secret-key.
skipVerifyCertificate Boolean
Skip verifying the SSL certificate. Environment variable: CLOUDNGFWAWS_SKIP_VERIFY_CERTIFICATE. JSON conf file variable: skip-verify-certificate.
syncMode Boolean
Enable synchronous mode while creating resources Environment variable: CLOUDNGFWAWS_SYNC_MODE. JSON conf file variable: sync_mode.
timeout Number
The timeout for any single API call (default: 30). Environment variable: CLOUDNGFWAWS_TIMEOUT. JSON conf file variable: timeout.

Outputs

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

Package Details

Repository
cloudngfwaws pulumi/pulumi-cloudngfwaws
License
Apache-2.0
Notes
This Pulumi package is based on the cloudngfwaws Terraform Provider.
Palo Alto Networks Cloud NGFW for AWS v0.1.1 published on Saturday, Mar 15, 2025 by Pulumi